viberroo 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a661824a1b2c538825640dd7d42f65a8ffcf9179dc73867acd446e5f211d9958
-  data.tar.gz: 30f03980c6244cb6cf958b9a5bff4404deb61134163a80729c63c3c9a58754a1
+  metadata.gz: cfdd2b9cf561f8fe620e7e8fd58c646aded156836519095de599f794022c5771
+  data.tar.gz: 394fcb5010e801f8595c2fe33cb5f28d72e95d961a7cf13cb33b8d006dc59a86
 SHA512:
-  metadata.gz: 2bd2f511ac9b539c6d4eb52c5bb6b2df6fc7757484af45c4594a6a5ca4ae5fd33268e3648a405b0f239ee052ad2824fc02d919e80d061dd6954f59ba40fcf222
-  data.tar.gz: 95cd4af8ca90022ddd501b42c3437848b1400a3a71d84793ec08e2df7c018ce3af4bbfa1ca2a26b4cd48485a4e2148ce63b9e9b811503ab55a01ce674a0dbe85
+  metadata.gz: 155014f7f40d8730f9ad41c9193dd739caa33b906587e0ff4ba6ed2fe7e3890841c12eff617ec7951cceaecca1923cbb59f5a6eecb24a9bf7ff3a664a4f582ac
+  data.tar.gz: 7baf397be2823482dc211c0c3392f3c8bedf981da346e06dc9dae91d41e27db0ce7feb5afdf4d151a65e67bdf9d3a003389cc7ee077123d9dc7f371efa0ee4df

data/lib/viberroo/bot.rb

@@ -1,7 +1,10 @@
 require 'net/http'
 require 'uri'
 
+# Namespace for all Viberroo code.
 module Viberroo
+
+  # Used for sending requests to Viber API. Each request sends a http POST request to a particular endpoint, each returns http response.
   class Bot
     def initialize(token: nil, response: nil)
       Viberroo.configure
@@ -13,32 +16,39 @@ module Viberroo
       @response = response
     end
 
+    # Used to set bot webhook.
     def set_webhook(url:, event_types: nil, send_name: nil, send_photo: nil)
       request(URL::WEBHOOK, url: url, event_types: event_types,
               send_name: send_name, send_photo: send_photo)
     end
 
+    # Used to remove bot webhook.
     def remove_webhook
       request(URL::WEBHOOK, url: '')
     end
 
+    # Used to send messages.
     def send(message:, keyboard: {})
       request(URL::MESSAGE,
               { receiver: @response&.user_id }.merge(message).merge(keyboard))
     end
 
+    # Used to broadcast messages.
     def broadcast(message:, to:)
       request(URL::BROADCAST_MESSAGE, message.merge(broadcast_list: to))
     end
 
+    # Used to retrieve account info. These settings can be set in you Viber admin panel.
     def get_account_info
       request(URL::GET_ACCOUNT_INFO)
     end
 
+    # Used to retrieve details of a particular user.
     def get_user_details(id:)
       request(URL::GET_USER_DETAILS, id: id)
     end
 
+    # Used to get online of a list of subscribed users.
     def get_online(ids:)
       request(URL::GET_ONLINE, ids: ids)
     end

data/lib/viberroo/configuration.rb

@@ -1,24 +1,37 @@
 module Viberroo
   class << self
+    # Accessor for global configuration.
     attr_accessor :config
   end
 
+  # Yields the global configuration to a block. Returns existing configuration if one was defined earlier.
+  # @yield [Configuration] global configuration
+  #
+  # @example
+  #     RSpec.configure do |config|
+  #       config.auth_token = 'syEsp8e0'
+  #     end
+  # @see Viberroo::Configuration
   def self.configure
     self.config ||= Configuration.new
     yield(config) if block_given?
   end
 
+  # Stores runtime configuration information.
   class Configuration
     attr_accessor :logger, :auth_token, :parse_response_body
 
     def initialize
+      # Stores Viber API authentication token. Necessary for the bot to send API requests.
       @auth_token = nil
 
+      # Specifies logger.
       @logger = Logger.new(STDOUT)
       @logger.formatter = proc do |severity, datetime, _, msg|
         "[#{datetime}] #{severity} Viberroo::Bot #{msg}\n"
       end
 
+      # Specifies whether to parse request response body.
       @parse_response_body = true
     end
   end

data/lib/viberroo/response.rb

@@ -1,28 +1,6 @@
 require 'recursive-open-struct'
 
 module Viberroo
-  class Response
-    attr_reader :params
-
-    def initialize(params)
-      warn 'DEPRECATION WARNING: Callback class will be renamed to Response in next minor release.'
-      @params = RecursiveOpenStruct.new params.to_h
-    end
-
-    def user_id
-      case @params.event
-      when 'conversation_started', 'subscribed'
-        @params.user.id
-      when 'unsubscribed', 'delivered', 'seen', 'failed'
-        @params.user_id
-      when 'message'
-        @params.sender.id
-      else
-        @params.dig(:user, :id)
-      end
-    end
-  end
-
   class Response
     attr_reader :params
 

data/lib/viberroo/version.rb

@@ -1,3 +1,3 @@
 module Viberroo
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.3.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: viberroo
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Viktor Habchak