viberroo 0.0.9 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7469da3b388fff29149846d0bd74dcc4edf1504b8d483b07ca41f76874ad1d0
-  data.tar.gz: f6a35359dda32689c7782f2185eab4dc6fa1adb6819c35b30c2f31eeb641b018
+  metadata.gz: 8d918d24a9f1cacebd5982601ec2e88efaad61517c8a969d7b78dd74205229c5
+  data.tar.gz: 3163feb39d9c4f9e9148bca976dabccf7b8b0fc170268149f21b5e87a9f7adab
 SHA512:
-  metadata.gz: 85fe34b50a9047820618f818786be6620f022f89ccbabfdaae85ba3335bcbee3b4a98eaffab74fc598f4e124b31d97539a4c1d3106eca890bfd3c6a0da020c1e
-  data.tar.gz: 2d20dcab05ac4917167a308bdbd01cf7bca380fe355aea41c1cad599457f844ed0a149ecaff986fb70f4f34bf3751eca06b8d285a47a84f779fe6769305fa22c
+  metadata.gz: 8d9f58550c03b4a8069ffca12e12aa7ee84c9a9e0906c29db088b598b395197793e47cbbe1cbb31d07b4f90f4ffbe0dff43996f8626dfa051add28e56fac4bd6
+  data.tar.gz: eaf3eaf19a685622bed73f97b196dd054333e7502844eb3d74021e215fe3073aec48d033bd8f6fd09f6a51394c63546014010254c4fe9d368e3ced1484bc3c87

data/lib/viberroo.rb

@@ -1,11 +1,20 @@
 require 'json'
 require 'faraday'
+require 'viberroo/configuration'
 require 'viberroo/message'
-require 'viberroo/bot'
 require 'viberroo/input'
-require 'viberroo/response'
+require 'viberroo/callback'
 require 'viberroo/bot'
+require 'logger'
 
 module Viberroo
-  API_URL = 'https://chatapi.viber.com/pa'.freeze
+  module URL
+    API               = 'https://chatapi.viber.com/pa'.freeze
+    WEBHOOK           = "#{API}/set_webhook".freeze
+    MESSAGE           = "#{API}/send_message".freeze
+    BROADCAST_MESSAGE = "#{API}/broadcast_message".freeze
+    GET_ACCOUNT_INFO  = "#{API}/get_account_info".freeze
+    GET_USER_DETAILS  = "#{API}/get_user_details".freeze
+    GET_ONLINE        = "#{API}/get_online".freeze
+  end
 end

data/lib/viberroo/bot.rb

@@ -1,20 +1,94 @@
 module Viberroo
   class Bot
-    include Message
+    def initialize(token: nil, callback: nil)
+      Viberroo.configure
 
-    def initialize(token:, response: {})
-      @webhook_url = "#{API_URL}/set_webhook"
-      @message_url = "#{API_URL}/send_message"
-      @headers = { 'X-Viber-Auth-Token': token, 'Content-Type': 'application/json' }
-      @response = response
+      @headers = {
+        'X-Viber-Auth-Token': token || Viberroo.config.auth_token,
+        'Content-Type': 'application/json'
+      }
+      @callback = callback
     end
 
-    def set_webhook(params)
-      Faraday.post(@webhook_url, params.to_json, @headers)
+    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
+
+    def set_webhook!(url:, event_types: nil, send_name: nil, send_photo: nil)
+      parse set_webhook(url: url, event_types: event_types,
+                        send_name: send_name, send_photo: send_photo)
     end
 
     def remove_webhook
-      Faraday.post(@webhook_url, { url: '' }.to_json, @headers)
+      request(URL::WEBHOOK, url: '')
+    end
+
+    def remove_webhook!
+      parse remove_webhook
+    end
+
+    def send(message:, keyboard: {})
+      request(URL::MESSAGE,
+              { receiver: @callback&.user_id }.merge(message).merge(keyboard))
+    end
+
+    def send!(message:, keyboard: {})
+      parse self.send(message: message, keyboard: keyboard)
+    end
+
+    def broadcast(message:, to:)
+      request(URL::BROADCAST_MESSAGE, message.merge(broadcast_list: to))
+    end
+
+    def broadcast!(message:, to:)
+      parse broadcast(message: message, to: to)
+    end
+
+    def get_account_info
+      request(URL::GET_ACCOUNT_INFO)
+    end
+
+    def get_account_info!
+      parse get_account_info
+    end
+
+    def get_user_details(id:)
+      request(URL::GET_USER_DETAILS, id: id)
+    end
+
+    def get_user_details!(id:)
+      parse get_user_details(id: id)
+    end
+
+    def get_online(ids:)
+      request(URL::GET_ONLINE, ids: ids)
+    end
+
+    def get_online!(ids:)
+      parse get_online(ids: ids)
+    end
+
+    private
+
+    def request(url, params = {})
+      response = Faraday.post(url, compact(params).to_json, @headers)
+      message = "##{caller_name} -- #{response.body}"
+      Viberroo.config.logger&.info(message)
+
+      response
+    end
+
+    def parse(request)
+      JSON.parse(request.body)
+    end
+
+    def compact(params)
+      params.delete_if { |_, v| v.nil? }
+    end
+
+    def caller_name
+      caller[1][/`.*'/][1..-2]
     end
   end
 end

data/lib/viberroo/callback.rb

@@ -0,0 +1,24 @@
+require 'recursive-open-struct'
+
+module Viberroo
+  class Callback
+    attr_reader :params
+
+    def initialize(params)
+      @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
+end

data/lib/viberroo/configuration.rb

@@ -0,0 +1,23 @@
+module Viberroo
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure
+    self.config ||= Configuration.new
+    yield(config) if block_given?
+  end
+
+  class Configuration
+    attr_accessor :logger, :auth_token
+
+    def initialize
+      @auth_token = nil
+
+      @logger = Logger.new(STDOUT)
+      @logger.formatter = proc do |severity, datetime, _, msg|
+        "[#{datetime}] #{severity} Viberroo::Bot #{msg}\n"
+      end
+    end
+  end
+end

data/lib/viberroo/input.rb

@@ -1,33 +1,31 @@
 module Viberroo
-  module Input
-    class Button
-      def self.reply(params = {})
-        { ActionType: 'reply' }.merge(params)
-      end
+  class Input
+    def self.keyboard(params)
+      { keyboard: { Type: 'keyboard' }.merge(params) }
+    end
 
-      def self.url(params = {})
-        { ActionType: 'open-url' }.merge(params)
-      end
+    def self.reply_button(params)
+      { ActionType: 'reply' }.merge(params)
+    end
 
-      def self.location_picker(params = {})
-        { ActionType: 'location-picker',
-          min_api_version: 3
-        }.merge(params)
-      end
+    def self.url_button(params)
+      { ActionType: 'open-url' }.merge(params)
+    end
 
-      def self.share_phone(params = {})
-        { ActionType: 'share-phone',
-          min_api_version: 3
-        }.merge(params)
-      end
+    def self.location_picker_button(params)
+      { ActionType: 'location-picker',
+        min_api_version: 3
+      }.merge(params)
+    end
 
-      def self.none(params = {})
-        { ActionType: 'none' }.merge(params)
-      end
+    def self.share_phone_button(params)
+      { ActionType: 'share-phone',
+        min_api_version: 3
+      }.merge(params)
     end
 
-    def keyboard(params = {})
-      { Type: 'keyboard' }.merge(params)
+    def self.none_button(params = {})
+      { ActionType: 'none' }.merge(params)
     end
   end
 end

data/lib/viberroo/message.rb

@@ -1,57 +1,39 @@
 module Viberroo
-  module Message
-    # TODO: add list of params that is mandatory for particular message type,
-    # throw exceptions and log errors if not found
-
-    def send_message(params = {})
-      dispatch({ type: :text }.merge(params))
-    end
-
-    def send_rich_media(params = {})
-      dispatch({ type: :rich_media, min_api_version: 2 }.merge(params))
+  class Message
+    def self.plain(params)
+      { type: :text }.merge(params)
     end
 
-    def send_location(params = {})
-      dispatch({ type: :location, min_api_version: 3 }.merge(params))
+    def self.rich(params)
+      { type: :rich_media, min_api_version: 2 }.merge(params)
     end
 
-    def send_picture(params = {})
-      dispatch({ type: :picture }.merge(params))
+    def self.location(params)
+      { type: :location }.merge(params)
     end
 
-    def send_video(params = {})
-      dispatch({ type: :video }.merge(params))
+    def self.picture(params = {})
+      { type: :picture, text: '' }.merge(params)
     end
 
-    def send_file(params = {})
-      dispatch({ type: :file }.merge(params))
+    def self.video(params = {})
+      { type: :video }.merge(params)
     end
 
-    def send_contact(params = {})
-      dispatch({ type: :contact }.merge(params))
+    def self.file(params = {})
+      { type: :file }.merge(params)
     end
 
-    def send_url(params = {})
-      dispatch({ type: :url }.merge(params))
+    def self.contact(params = {})
+      { type: :contact }.merge(params)
     end
 
-    # https://viber.github.io/docs/tools/sticker-ids/
-    def send_sticker(params = {})
-      dispatch({ type: :sticker }.merge(params))
-    end
-
-    private
-
-    def dispatch(params)
-      Faraday.post(
-        @message_url,
-        normalize({ receiver: @response.user_id }.merge(params)),
-        @headers
-      )
+    def self.url(params = {})
+      { type: :url }.merge(params)
     end
 
-    def normalize(params)
-      params.delete_if { |_, v| v.nil? }.to_json
+    def self.sticker(params = {})
+      { type: :sticker }.merge(params)
     end
   end
 end

data/lib/viberroo/version.rb

@@ -1,3 +1,3 @@
 module Viberroo
-  VERSION = '0.0.9'.freeze
+  VERSION = '0.2.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: viberroo
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.2.1
 platform: ruby
 authors:
 - Viktor Habchak
@@ -46,9 +46,10 @@ extra_rdoc_files: []
 files:
 - lib/viberroo.rb
 - lib/viberroo/bot.rb
+- lib/viberroo/callback.rb
+- lib/viberroo/configuration.rb
 - lib/viberroo/input.rb
 - lib/viberroo/message.rb
-- lib/viberroo/response.rb
 - lib/viberroo/version.rb
 homepage: https://github.com/vikdotdev/viberroo
 licenses:
@@ -60,16 +61,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Viber bot for Ruby.

data/lib/viberroo/response.rb

@@ -1,26 +0,0 @@
-require 'recursive-open-struct'
-
-module Viberroo
-  class Response
-    class << self
-      def init(params)
-        @@os = RecursiveOpenStruct.new params.to_h
-        @@os.user_id = user_id
-        @@os
-      end
-
-      private
-
-      def user_id
-        case @@os.event
-        when 'conversation_started', 'subscribed'
-          @@os.user.id
-        when 'unsubscribed', 'delivered', 'seen', 'failed'
-          @@os.user_id
-        when 'message'
-          @@os.sender.id
-        end
-      end
-    end
-  end
-end