ruby-vibe 1.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf9b514d655e13e3501fbb1695fd4a9a4f7260e9e6181aa8bb8a6d9bc6dbb07c
-  data.tar.gz: ea095d5ac68aa99ebcc621169ebd678361c60aff722d108250f2aa9e42dd71e1
+  metadata.gz: 57519dce750fc99dbd7a7db5f33af4c72eabd43720519f755a6aae333c20d105
+  data.tar.gz: 8838f746a0985c795d55f07d014f454da069edd0bf373b5efd97e7c920db3012
 SHA512:
-  metadata.gz: 63ba09c61c1af86d97adcb44823f355466cc2225b525defbbf6c4173fafbb28dc2f125e6962e192bb14cd0c48ec90a7e126999fe864f96d5159d87e0ab4c95cc
-  data.tar.gz: ea98f6228c8787a349da508bb0553830a8a0ee9cee76b2ece6ae94344c12709c9e55876437282088f9e346d8fc13dc876ffd282d10134d255384226a18fab3cc
+  metadata.gz: 997f2ab4a4d741945dd20455c8dc6b702b63f4a5d6af8a2577994db90ed25378cfbc5a1b815cdf75e42bffc1cb21f24059762f032c1965037fea7e161ec1f240
+  data.tar.gz: f7c10572bb27cc2fffab50ca7f9883158451adac3065510741193af137d3d09d586269f8ae5c90dcadb2746267c0ee180bd451405364d9cb3b5f1693dc77af89

data/lib/ruby-vibe/bot.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require_relative 'client'
+
+module RubyVibe
+  ##
+  # Set of predefined viber api requests. This class is used directly by user.
+  # Define constants for configuration settings, or add them on initialization.
+  #
+  # @example Set default configuration
+  #   RubyVibe::TOKEN  = 'my_viber_auth_token'
+  #   RubyVibe::NAME   = 'my_viber_nickname'
+  #   RubyVibe::AVATAR = 'avatar_url'
+  #
+  class Bot < RubyVibe::Client
+    ##
+    # @example Initialize new bot with user-defined configuration
+    #  @bot = RubyVibe::Bot.new(token:  'auth_token',
+    #                           name:   'sender_name',
+    #                           avatar: 'https_avatar_url' )
+    #
+    # @param [String] token   **Optional**.  Auth token provided by Viber.
+    # @param [String] name    **Optional**.  Sender name provided by user.
+    # @param [String] avatar  **Optional**.  SSL link to user photo.
+    #
+    # @return [Bot] Bot object to work with.
+    #
+    def initialize(token: nil, name: nil, avatar: nil)
+      token  ||= RubyVibe::TOKEN
+      name   ||= RubyVibe::NAME
+      avatar ||= RubyVibe::AVATAR
+
+      super(token: token, name: name, avatar: avatar)
+    end
+
+    ##
+    # Send message to user.
+    # @see https://developers.viber.com/docs/api/rest-bot-api/#send-message
+    #
+    # @param [Hash] opts
+    #
+    # @option opts [String] message     **Required**. Message text
+    # @option opts [String] receiver    **Required**. Message receiver
+    # @option opts [String] sender_name **Optional**. Sender name || RubyVibe::NAME
+    # @option opts [String] avatar      **Optional**. Avatar url  || RubyVibe::AVATAR
+    # @option opts [String] keyboard    **Optional**. Add keyboard to message
+    # @option opts [String] rich_media  **Optional**. Send rich_media message
+    #
+    # @return [Hash] Response hash defined in RubyVibe::Client
+    #
+    def send_message(opts = {})
+      opts.merge!(type: 'text') unless opts[:type]
+
+      viberize(URL::SEND_MESSAGE, opts)
+    end
+
+    ##
+    # Broadcast message to multiple users.
+    # @see https://developers.viber.com/docs/api/rest-bot-api/#broadcast-message
+    #
+    # @param [Hash] opts Viber API options for broadcast_message request
+    #
+    # @option opts [String] message     **Required**. Message text
+    # @option opts [Array]  receivers   **Required**. Message receivers
+    # @option opts [String] sender_name **Optional**. Sender name || RubyVibe::NAME
+    # @option opts [String] avatar      **Optional**. Avatar url  || RubyVibe::AVATAR
+    # @option opts [String] keyboard    **Optional**. Add keyboard to message
+    # @option opts [String] rich_media  **Optional**. Send rich_media message
+    #
+    # @return [Hash] Response hash defined in RubyVibe::Client
+    #
+    def broadcast_message(opts = {})
+      opts.merge!(type: 'text') unless opts[:type]
+      
+      viberize(URL::BROADCAST_MESSAGE, opts)
+    end
+
+    ##
+    # @see https://developers.viber.com/docs/api/rest-bot-api/#set-webhook
+    #
+    def set_webhook(opts = {})
+      viberize(URL::SET_WEBHOOK, opts)
+    end
+
+    ##
+    # @see https://developers.viber.com/docs/api/rest-bot-api/#get-account-info
+    #
+    def get_account_info
+      viberize(URL::GET_ACCOUNT_INFO, info: true)
+    end
+
+    ##
+    # @see https://developers.viber.com/docs/api/rest-bot-api/#get-user-details
+    #
+    def get_user_details(user_id)
+      viberize(URL::GET_USER_DETAILS, id: user_id, info: true)
+    end
+
+    ##
+    # @see https://developers.viber.com/docs/api/rest-bot-api/#get-online
+    #
+    def get_online(*user_ids)
+      viberize(URL::GET_ONLINE, ids: Array(user_ids), info: true)
+    end
+  end
+end

data/lib/ruby-vibe/client.rb

@@ -1,33 +1,129 @@
+# frozen_string_literal: true
+
 require 'rest-client'
 require 'json'
 
-class RubyVibe
+module RubyVibe
+  ##
+  # This class is almost never used directly by user.
+  # Send actual request to viber api and perform type validation
+  # for token, name and avatar (must be strings).
+  #
   class Client
-    
-    attr_accessor :token
+    attr_accessor :token, :name, :avatar
+
+    attr_reader :response, :payload_hash
+
+    alias sender name
 
-    def initialize(auth_token:) 
-      RubyVibe.configure
+    ##
+    # @example Initialize new client
+    #
+    #   @client = Client.new(token: 'token', name: 'name', avatar: 'https_url')
+    #
+    # @param [String] token  **Required**. Viber auth token.
+    # @param [String] name   **Required**. Sender name.
+    # @param [String] avatar **Optional**. Avatar url.
+    #
+    # @raise [Token must be string] Token must be string.
+    # @raise [Name must be string] Name must be string.
+    # @raise [Avatar must use SSL] If defined, avatar must use https connection.
+    #
+    # @return [Object]
+    #
+    def initialize(token: nil, name: nil, avatar: nil)
+      raise 'Token must be string!' unless token.is_a? String
+      raise 'Sender name must be string' unless name.is_a? String
 
-      @token = auth_token || RubyVibe.config.auth_token
+      raise 'Avatar URL must use SSL' if !avatar.empty? && !(avatar.start_with? 'https://')
+
+      @token = token
+      @name = name
+      @avatar = avatar
     end
 
-    def action(url, payload: {}, http_method: :post)
+    private
+
+    ##
+    # Send payload to Viber API.
+    #
+    # @param [String] url **Required**. API url to send payload.
+    # @param [Hash] payload **Optional**. Payload to send with request.
+    # @return [Hash] Bot#response hash with all data.
+    #
+    def action(url, payload: {})
       headers = {
         'User-Agent': "RubyVibe client v#{RubyVibe::VERSION})",
-        'X-Viber-Auth-Token': token 
+        'X-Viber-Auth-Token': @token
       }
 
       response = ::RestClient::Request.execute(
-        method:     http_method, 
-        url:        url,
-        payload:    payload.to_json, 
-        headers:    headers,
-        timeout:    5, 
+        method: :post,
+        url: url,
+        payload: payload.to_json,
+        headers: headers,
+        timeout: 5,
         verify_ssl: ::OpenSSL::SSL::VERIFY_NONE
       )
-      
-      RubyVibe::Response.parse(response)
+
+      @response = parse(response)
+    end
+
+    ##
+    # Method used by bot to construct viber api request.
+    # Prepare payload and send it to api url.
+    #
+    # @param [String] api_url **Required**. URL corresponding to method name.
+    # @param [Hash] opts **Optional**. Payload corresponding to method options.
+    #
+    def viberize(api_url, opts = {})
+      payload = load_payload(opts)
+      action(api_url, payload: payload)
+    end
+
+    ##
+    # Construct payload to send with request.
+    # If payload contain `info: true`, do not add sender name and avatar url.
+    # Otherwise, add them together with _options hash_ to payload.
+    # Nil values are not imported.
+    #
+    # @param [Hash] opts **Optional**. Data to create payload.
+    # @return [Hash] Client#payload_hash to send with request.
+    #
+    def load_payload(opts = {})
+      @payload_hash = {}
+
+      if opts[:info].nil?
+        @payload_hash[:sender] = {
+          name: opts[:sender_name] || @name,
+          avatar: opts[:sender_avatar] || @avatar
+        }
+      end
+
+      opts.map do |key, value|
+        next if value.nil?
+        next if key == :info
+
+        @payload_hash[key] = value
+      end
+      @payload_hash
+    end
+
+    ##
+    # Construct response hash. Parse viber response and check status code.
+    # If code is not zero (**0**), add `error_message` to response.
+    #
+    def parse(response)
+      success = true
+      error_message = nil
+      hash = JSON.parse(response.body)
+
+      unless hash['status'].to_i.zero?
+        success = false
+        error_message = hash['status_message']
+      end
+
+      Struct.new(:success?, :data, :error_message).new(success, hash, error_message)
     end
   end
-end
+end

data/lib/ruby-vibe/shortcuts.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module RubyVibe
+  ##
+  # Shortcut to initialize Bot and send message.
+  # @see https://developers.viber.com/docs/api/rest-bot-api/#send-message
+  #
+  # @note Configuration constants must be defined to use this class.
+  #
+  # @example Configure constants
+  #   RubyVibe::TOKEN  = 'my_api_token'
+  #   RubyVibe::NAME   = 'my_nickname'
+  #   RubyVibe::AVATAR = 'https_avatar_url'
+  #
+  # @example Send text message
+  #   msg = RubyVibe::SendMessage[text: 'text', sender_name: 'my_nickname']
+  #   pp msg.error_message unless msg.success?
+  #
+  class SendMessage
+    ##
+    # Send message to user.
+    #
+    # @param  [Hash]   opts
+    # @return [Data#response]
+    # @see Bot#send_message
+    #
+    def self.[](opts = {})
+      Bot.new.send_message(opts)
+    end
+  end
+
+  ##
+  # Shortcut to initialize Bot and broadcast message.
+  # @see https://developers.viber.com/docs/api/rest-bot-api/#broadcast-message
+  #
+  # @note Configuration constants must be defined to use shortcut classes
+  #
+  # @example Configure constants
+  #   RubyVibe::TOKEN  = 'my_api_token'
+  #   RubyVibe::NAME   = 'my_nickname'
+  #   RubyVibe::AVATAR = 'https_avatar_url'
+  #
+  class BroadcastMessage
+    ##
+    # @example Broadcast message to multiple users
+    #   msg = RubyVibe::BroadcastMessage[text:   'text',
+    #                                    receivers: %w[user_1 user_2]
+    #                                    ]
+    #   pp msg.error_message unless msg.success?
+    #
+    def self.[](opts = {})
+      Bot.new.broadcast_message(opts)
+    end
+  end
+
+  ##
+  # @see https://developers.viber.com/docs/api/rest-bot-api/#set-webhook
+  #
+  class SetWebhook
+    # @note Configuration constants must be defined to use shortcut classes
+    def self.[](opts = {})
+      Bot.new.set_webhook(opts)
+    end
+  end
+
+  ##
+  # @see https://developers.viber.com/docs/api/rest-bot-api/#get-account-info
+  #
+  class GetAccountInfo
+    # @note Configuration constants must be defined to use shortcut classes
+    def self.[]
+      Bot.new.get_account_info
+    end
+  end
+
+  ##
+  # @see https://developers.viber.com/docs/api/rest-bot-api/#get-user-details
+  #
+  class GetUserDetails
+    # @note Configuration constants must be defined to use shortcut classes
+    def self.[](user_id)
+      Bot.new.get_user_details(user_id)
+    end
+  end
+
+  ##
+  # @see https://developers.viber.com/docs/api/rest-bot-api/#get-online
+  #
+  class GetOnline
+    # @note Configuration constants must be defined to use shortcut classes
+    def self.[](*user_ids)
+      Bot.new.get_online(*user_ids)
+    end
+  end
+end

data/lib/ruby-vibe/url.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+##
+# Viber API urls as constant for corresponding method.
+#
+# @see https://developers.viber.com/docs/api/rest-bot-api
+#
+module URL
+  # viber api url
+  API = 'https://chatapi.viber.com/pa'
+
+  # api url to set webhook
+  SET_WEBHOOK = "#{API}/set_webhook".freeze
+
+  # api url to send message to user
+  SEND_MESSAGE = "#{API}/send_message".freeze
+
+  # api url to get info about your account
+  GET_ACCOUNT_INFO = "#{API}/get_account_info".freeze
+
+  # api url to get info about user (twice per 12h for each ID)
+  GET_USER_DETAILS = "#{API}/get_user_details".freeze
+
+  # api url to broadcast message to multiple users (must be subscribed to bot)
+  BROADCAST_MESSAGE = "#{API}/broadcast_message".freeze
+
+  # api url to check if user(s) is online
+  GET_ONLINE = "#{API}/get_online".freeze
+end

data/lib/ruby-vibe/version.rb

@@ -1,3 +1,9 @@
-class RubyVibe
-  VERSION='1.0.1'.freeze
-end
+# frozen_string_literal: true
+
+##
+# Gem version
+#
+module RubyVibe
+  # version number to change with new update
+  VERSION = '2.0.2'
+end

data/lib/ruby_vibe.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'ruby-vibe/url'
+require_relative 'ruby-vibe/bot'
+require_relative 'ruby-vibe/shortcuts'
+require_relative 'ruby-vibe/version'
+
+##
+# RubyVibe represent a main module for Viber Bot.
+# Multiple classes are used as shortcut classes,
+# calling methods from RubyVibe::Bot class.
+# Actual request to viber api is done by RubyVibe::Client class.
+# Urls for viber API are defined in URL module.
+#
+# @see RubyVibe::Bot
+# @see RubyVibe::Client
+# @see URL
+# @see [File] lib/ruby-vibe/shortcuts.rb
+#
+
+require 'byebug'
+
+module RubyVibe
+  # viber api auth_token to be used if not given by user
+  TOKEN  = ''
+
+  # sender name to be used if not given by user
+  NAME   = ''
+
+  # avatar url to be used if not given by user (require https)
+  AVATAR = ''
+end

metadata

@@ -1,43 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: ruby-vibe
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Adem Dinarevic
 autorequire:
-bindir: bin
+bindir:
+- bin
 cert_chain: []
-date: 2021-07-15 00:00:00.000000000 Z
+date: 2022-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
+        version: 13.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 description: Ruby client for Viber API
 email:
 - ademdinarevic@gmail.com
@@ -45,15 +74,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/ruby-vibe.rb
-- lib/ruby-vibe/calls.rb
-- lib/ruby-vibe/calls/info.rb
-- lib/ruby-vibe/calls/messaging.rb
+- lib/ruby-vibe/bot.rb
 - lib/ruby-vibe/client.rb
-- lib/ruby-vibe/configuration.rb
-- lib/ruby-vibe/response.rb
-- lib/ruby-vibe/urls.rb
+- lib/ruby-vibe/shortcuts.rb
+- lib/ruby-vibe/url.rb
 - lib/ruby-vibe/version.rb
+- lib/ruby_vibe.rb
 homepage: https://github.com/ademdc/ruby-vibe
 licenses:
 - MIT
@@ -66,14 +92,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Ruby client for Viber API

data/lib/ruby-vibe/calls/info.rb

@@ -1,37 +0,0 @@
-class RubyVibe
-  module Calls
-    module Info
-
-      def get_account_data
-        client.action(RubyVibe::URLS::GET_ACCOUNT_INFO)
-      end
-
-      def set_webhook(url, events: [], send_name: true, send_photo: true)
-        payload = {
-          url: url,
-          event_types: events,
-          send_name: send_name,
-          send_photo: send_photo
-        }
-
-        client.action(RubyVibe::URLS::SET_WEBHOOK, payload: payload)
-      end
-
-      def get_user_details(user_id)
-        payload = {
-          id: user_id
-        }
-
-        client.action(RubyVibe::URLS::GET_USER_DETAILS, payload: payload)
-      end
-
-      def get_online(ids=[])
-        payload = {
-          ids: ids
-        }
-        
-        client.action(RubyVibe::URLS::GET_ONLINE, payload: payload)
-      end
-    end
-  end
-end

data/lib/ruby-vibe/calls/messaging.rb

@@ -1,40 +0,0 @@
-class RubyVibe
-  module Calls
-    module Messaging
-
-      def send_message(receiver:, text:, sender_name: nil, sender_avatar: nil, tracking_data: nil, type: 'text', keyboard: nil)
-        payload = {
-          receiver:receiver,
-          sender:{
-             name:sender_name || RubyVibe.config.sender_name,
-             avatar:sender_avatar || RubyVibe.config.sender_avatar
-          },
-          tracking_data:tracking_data,
-          type:type,
-          text:text
-        }.compact
-
-        payload.merge!({ keyboard: keyboard }) unless keyboard.nil?
-
-        client.action(RubyVibe::URLS::MESSAGE, payload: payload)
-      end
-
-      def broadcast_message(broadcast_list:[], text:, sender_name: nil, sender_avatar: nil, type: 'text', rich_media: nil, keyboard: nil)
-        payload = {
-          sender:{
-             name: sender_name || RubyVibe.config.sender_name,
-             avatar: sender_avatar || RubyVibe.config.sender_avatar
-          },
-         type: type,
-          text: text,
-          broadcast_list: broadcast_list,
-        }
-
-        payload.merge!({ rich_media: rich_media }) unless rich_media.nil?
-        payload.merge!({ keyboard: keyboard }) unless keyboard.nil?
-
-        client.action(RubyVibe::URLS::BROADCAST_MESSAGE, payload: payload)
-      end
-    end
-  end
-end

data/lib/ruby-vibe/calls.rb

@@ -1,9 +0,0 @@
-require 'ruby-vibe/calls/info'
-require 'ruby-vibe/calls/messaging'
-
-class RubyVibe
-  module Calls 
-    include Info
-    include Messaging
-  end
-end

data/lib/ruby-vibe/configuration.rb

@@ -1,21 +0,0 @@
-class RubyVibe
-  class << self
-    # Accessor for global configuration.
-    attr_accessor :config
-  end
-
-  def self.configure
-    self.config ||= Configuration.new
-    yield(config) if block_given?
-  end
-
-  class Configuration
-    attr_accessor :auth_token, :sender_name, :sender_avatar
-
-    def initialize
-      @auth_token    = nil
-      @sender_name   = nil
-      @sender_avatar = 'http://avatar.example.com'
-    end
-  end
-end

data/lib/ruby-vibe/response.rb

@@ -1,30 +0,0 @@
-class RubyVibe
-  class Response 
-    
-    attr_accessor :response
-
-    def initialize(response)
-      @response = response
-    end
-
-    class << self
-      def parse(response)
-        response = new(response)
-        response.parse
-      end
-    end
-
-    def parse
-      success       = true
-      error_message = nil
-      hash          = JSON.parse(response.body)
-
-      unless hash.dig('status').to_i == 0
-        success = false 
-        error_message =  hash.dig('status_message')
-      end
-     
-      Struct.new(:success?, :hash, :error_message).new(success, hash, error_message)
-    end
-  end
-end

data/lib/ruby-vibe/urls.rb

@@ -1,11 +0,0 @@
-class RubyVibe
-  module URLS
-    API               = 'https://chatapi.viber.com/pa'.freeze
-    SET_WEBHOOK       = "#{API}/set_webhook".freeze
-    MESSAGE           = "#{API}/send_message".freeze
-    GET_ACCOUNT_INFO  = "#{API}/get_account_info".freeze
-    GET_USER_DETAILS  = "#{API}/get_user_details".freeze
-    BROADCAST_MESSAGE = "#{API}/broadcast_message".freeze
-    GET_ONLINE        = "#{API}/get_online".freeze
-  end
-end

data/lib/ruby-vibe.rb

@@ -1,17 +0,0 @@
-require 'ruby-vibe/client'
-require 'ruby-vibe/calls'
-require 'ruby-vibe/version'
-require 'ruby-vibe/configuration'
-require 'ruby-vibe/urls'
-require 'ruby-vibe/response'
-
-class RubyVibe
-
-  attr_accessor :client
-  
-  include Calls
-
-  def initialize(auth_token: nil)
-    @client = Client.new(auth_token: auth_token)
-  end
-end