viberroo 0.0.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78bcb0e32349405f96129347dc9cbca08f1af7b3fc15b0bdc93aef2199c76e1e
-  data.tar.gz: 98d3a81828703929aead8b437bfd3aab024c43491d2d6bf1c087f8fc9f6ff1c1
+  metadata.gz: 6e99b6a05f07fc41a2ae9952fe3d5088b34f55ce541f5624c9257713e29ec0c4
+  data.tar.gz: 432960ff25d67e609e5357b76a4b63c33115aef892016b964847ee6fa980be5c
 SHA512:
-  metadata.gz: d4e6e9eba4b27eb6442800440f8849ec957528753fbcee168dbd1c8e0cb0ad62d4ed51173ad5b5be0aeb567dbab9cd4d4e504ebb38a1bfcbeb55d9267b152228
-  data.tar.gz: 07d4b7a5b117c958fc6af4eef204283b7af93c62fb14de25cc5f76019b9f59a8f5280bd3ec581c3dbed84ca224a4c7f81a63ee60735bdc9ee9784eae1bed3bed
+  metadata.gz: 4f800f461911f603c1a95ca30cfbe5ec0b33b9c1c02df3e681c462a2c1307fd7014074bd95f9478f2ee44c6c061a13c6ecba6533eee35c8d5d074c612425c076
+  data.tar.gz: 78ea9bf73786aa9d36b1c43606b7df8363575237813f4e954bb980a7e3d188602f6db088eab3d05c1a48f3708d2588e2d110d55a42fae18f348efbcaca55649c

data/lib/viberroo.rb

@@ -3,9 +3,17 @@ require 'faraday'
 require 'viberroo/message'
 require 'viberroo/bot'
 require 'viberroo/input'
-require 'viberroo/response'
+require 'viberroo/callback'
 require 'viberroo/bot'
 
 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,83 @@
 module Viberroo
   class Bot
-    include Message
-
-    def initialize(token:, response: {})
-      @webhook_url = "#{API_URL}/set_webhook"
-      @message_url = "#{API_URL}/send_message"
+    def initialize(token:, callback: nil)
       @headers = { 'X-Viber-Auth-Token': token, 'Content-Type': 'application/json' }
-      @response = response
+      @callback = callback
+    end
+
+    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(params)
-      Faraday.post(@webhook_url, params.to_json, @headers)
+    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 = {})
+      Faraday.post(url, compact(params).to_json, @headers)
+    end
+
+    def parse(request)
+      JSON.parse(request.body)
+    end
+
+    def compact(params)
+      params.delete_if { |_, v| v.nil? }
     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/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.8'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: viberroo
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.2.0
 platform: ruby
 authors:
 - Viktor Habchak
@@ -46,9 +46,9 @@ extra_rdoc_files: []
 files:
 - lib/viberroo.rb
 - lib/viberroo/bot.rb
+- lib/viberroo/callback.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,17 +60,17 @@ 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.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Thin Viber REST API wrapper for Ruby.
+summary: Viber bot for Ruby.
 test_files: []

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