bobot 3.6.3 → 3.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2ae39f29dc92093c1e5390c223860530717aed9
-  data.tar.gz: 9e63115deb48163e9ce4cb2d7c67010578785628
+  metadata.gz: 6c99e1858ab5920d04639c1ac7231851463efd12
+  data.tar.gz: 6b11a790f7161b698050b77b2bbeb89f3e6a5c7c
 SHA512:
-  metadata.gz: 7ad33aed1ba080fa845349db124bbfc6d7609cd49a3bfe25e90d54149063da5a7168926be20e2f95a917f2200c2c846d898664f4751f3ef96cde4cbae7f7ce07
-  data.tar.gz: 0c3630df5108f2b73693fa61510b011d6e9f51fbf57c60aba5a7e8e60556eac1a5c36d57c3a0745460b54b8f9b7d33304fc42b6b5c52403c271ed0093bdecade
+  metadata.gz: 427c44cb577011eab720a2fcd4672a187bffbde09041dbc4e6dfd2f9a5dbd662330a97deaed0020b13f64f07b0bd80fa731434cbfc0cc2efe75a5a98f267eeb0
+  data.tar.gz: f01481c7cd962c33c1cf9973b2c33ff91f5af93f42406480dd81e3ed6ba7c261abcaf4c47a406045136ca3b9fb42dddd96f57d6dd5b9ca09ac4a77cf22b2eb29

data/lib/bobot/buttons.rb

@@ -12,11 +12,11 @@ module Bobot
     end
 
     def self.postback(title:, payload:)
-      raise Bobot::FieldFormat.new('title is required.') unless title.present?
-      raise Bobot::FieldFormat.new('title length is limited to 20.', title) if title.size > 20
-      raise Bobot::FieldFormat.new('payload is required.') unless payload.present?
+      raise Bobot::FieldFormat.new('title is required') unless title.present?
+      raise Bobot::FieldFormat.new('title size is limited to 20', "#{title} (#{title.size} chars)") if title.size > 20
+      raise Bobot::FieldFormat.new('payload is required') unless payload.present?
       payload = Bobot::Buttons.encode_payload(payload: payload)
-      raise Bobot::FieldFormat.new('payload length is limited to 1000.') if payload.bytesize > 1000
+      raise Bobot::FieldFormat.new('payload size is limited to 1000', "#{payload.size} chars") if payload.size > 1000
       {
         type: 'postback',
         title: title,
@@ -25,10 +25,10 @@ module Bobot
     end
 
     def self.generic_element(title:, subtitle: nil, image_url: nil, default_action_url: nil, buttons: nil)
-      raise Bobot::FieldFormat.new('title is required.') unless title.present?
-      raise Bobot::FieldFormat.new('title length is limited to 80.', title) if title.size > 80
-      raise Bobot::FieldFormat.new('subtitle length is limited to 80.', subtitle) if subtitle.present? && subtitle.size > 80
-      raise Bobot::FieldFormat.new('buttons are limited to 3.') if buttons.present? && buttons.size > 3
+      raise Bobot::FieldFormat.new('title is required') unless title.present?
+      raise Bobot::FieldFormat.new('title size is limited to 80', "#{title} (#{title.size} chars)") if title.size > 80
+      raise Bobot::FieldFormat.new('subtitle size is limited to 80', "#{subtitle} (#{subtitle.size} chars)") if subtitle.present? && subtitle.size > 80
+      raise Bobot::FieldFormat.new('buttons are limited to 3', buttons.size) if buttons.present? && buttons.size > 3
       {
         title: title,
       }.tap do |properties|
@@ -51,11 +51,11 @@ module Bobot
     end
 
     def self.quick_reply_text(title:, payload:, image_url: nil)
-      raise Bobot::FieldFormat.new('title is required.') unless title.present?
-      raise Bobot::FieldFormat.new('title length is limited to 20.', title) if title.size > 20
-      raise Bobot::FieldFormat.new('payload is required.') unless payload.present?
+      raise Bobot::FieldFormat.new('title is required') unless title.present?
+      raise Bobot::FieldFormat.new('title size is limited to 20', "#{title} (#{title.size} chars)") if title.size > 20
+      raise Bobot::FieldFormat.new('payload is required') unless payload.present?
       payload = Bobot::Buttons.encode_payload(payload: payload)
-      raise Bobot::FieldFormat.new('payload length is limited to 1000.') if payload.bytesize > 1000
+      raise Bobot::FieldFormat.new('payload size is limited to 1000', "#{payload.size} chars") if payload.size > 1000
       {
         content_type: 'text',
         title: title,
@@ -72,12 +72,12 @@ module Bobot
     end
 
     def self.share_custom(title:, subtitle:, image_url:, web_url:, button_title:, image_aspect_ratio: "square")
-      raise Bobot::FieldFormat.new('title is required.') unless title.present?
-      raise Bobot::FieldFormat.new('title length is limited to 80.', title) if title.size > 80
-      raise Bobot::FieldFormat.new('subtitle is required.') unless subtitle.present?
-      raise Bobot::FieldFormat.new('subtitle length is limited to 80.', subtitle) if subtitle.size > 80
-      raise Bobot::FieldFormat.new('button_title is required.') unless button_title.present?
-      raise Bobot::FieldFormat.new('button_title length is limited to 20.', button_title) if button_title.size > 20
+      raise Bobot::FieldFormat.new('title is required') unless title.present?
+      raise Bobot::FieldFormat.new('title size is limited to 80', "#{title} (#{title.size} chars)") if title.size > 80
+      raise Bobot::FieldFormat.new('subtitle is required') unless subtitle.present?
+      raise Bobot::FieldFormat.new('subtitle size is limited to 80', "#{subtitle} (#{subtitle.size} chars)") if subtitle.size > 80
+      raise Bobot::FieldFormat.new('button_title is required') unless button_title.present?
+      raise Bobot::FieldFormat.new('button_title size is limited to 20', "#{button_title} (#{button_title.size} chars)") if button_title.size > 20
       {
         type: 'element_share',
         share_contents: {
@@ -111,12 +111,12 @@ module Bobot
     end
 
     def self.default_action_url(url:, options: {})
-      raise Bobot::FieldFormat.new('url is required.') unless url.present?
+      raise Bobot::FieldFormat.new('url is required') unless url.present?
       if options.key?(:messenger_extensions) && options[:messenger_extensions] && !url.include?('https')
-        raise Bobot::FieldFormat.new('must use url HTTPS protocol if messenger_extensions is true.')
+        raise Bobot::FieldFormat.new('must use url HTTPS protocol if messenger_extensions is true.', url)
       end
       if options.key?(:webview_height_ratio) && !%w[compact tall full].include?(options[:webview_height_ratio])
-        raise Bobot::FieldFormat.new('invalid webview_height_ratio, only "compact, tall, full" are permitted.')
+        raise Bobot::FieldFormat.new('invalid webview_height_ratio, only "compact, tall, full" are permitted.', options[:webview_height_ratio])
       end
       {
         type: 'web_url',
@@ -130,14 +130,14 @@ module Bobot
     end
 
     def self.url(title:, url:, options: {})
-      raise Bobot::FieldFormat.new('title is required.') unless title.present?
-      raise Bobot::FieldFormat.new('title length is limited to 20.', title) if title.size > 20
-      raise Bobot::FieldFormat.new('url is required.') unless url.present?
+      raise Bobot::FieldFormat.new('title is required') unless title.present?
+      raise Bobot::FieldFormat.new('title size is limited to 20', "#{title} (#{title.size} chars)") if title.size > 20
+      raise Bobot::FieldFormat.new('url is required') unless url.present?
       if options.key?(:messenger_extensions) && options[:messenger_extensions] && !url.include?('https')
-        raise Bobot::FieldFormat.new('must use url HTTPS protocol if messenger_extensions is true.')
+        raise Bobot::FieldFormat.new('must use url HTTPS protocol if messenger_extensions is true.', url)
       end
       if options.key?(:webview_height_ratio) && !%w[compact tall full].include?(options[:webview_height_ratio])
-        raise Bobot::FieldFormat.new('invalid webview_height_ratio, only "compact, tall, full" are permitted.')
+        raise Bobot::FieldFormat.new('invalid webview_height_ratio, only "compact, tall, full" are permitted.', options[:webview_height_ratio])
       end
       {
         type: 'web_url',
@@ -153,11 +153,11 @@ module Bobot
 
     REGEX_PHONE_NUMBER = /\A(?:\+)(?:\d{1,3}\s*-?)?\(?(?:\d{3})?\)?[- ]?\d{3}[- ]?\d{4}\z/
     def self.call(title:, payload:)
-      raise Bobot::FieldFormat.new('title is required.') unless title.present?
-      raise Bobot::FieldFormat.new('title length is limited to 20.', title) if title.size > 20
-      raise Bobot::FieldFormat.new('payload is required.') unless payload.present?
-      raise Bobot::FieldFormat.new('payload has to be only a string') unless payload.is_a?(String)
-      raise Bobot::FieldFormat.new('payload has to start with a "+" and be a valid phone number') unless REGEX_PHONE_NUMBER =~ payload
+      raise Bobot::FieldFormat.new('title is required') unless title.present?
+      raise Bobot::FieldFormat.new('title size is limited to 20', "#{title} (#{title.size} chars)") if title.size > 20
+      raise Bobot::FieldFormat.new('payload is required') unless payload.present?
+      raise Bobot::FieldFormat.new('payload has to be only a string', payload.class.to_s) unless payload.is_a?(String)
+      raise Bobot::FieldFormat.new('payload has to start with a "+" and be a valid phone number', payload) unless REGEX_PHONE_NUMBER =~ payload
       {
         type: 'phone_number',
         title: title,

data/lib/bobot/configuration.rb

@@ -10,7 +10,7 @@ module Bobot
       elsif rhs.is_a?(Array)
         @domains = rhs
       else
-        raise Bobot::InvalidParameter.new(:domains, "should be a string or an array")
+        raise Bobot::FieldFormat.new("domains should be a string or an array")
       end
     end
   end

data/lib/bobot/events/common.rb

@@ -16,6 +16,15 @@ module Bobot
         @messaging['recipient']
       end
 
+      # If the user responds to your message, the appropriate event
+      # (messages, messaging_postbacks, etc.) will be sent to your webhook,
+      # with a prior_message object appended. The prior_message object
+      # includes the source of the message the user is responding to, as well
+      # as the user_ref used for the original message send.
+      def prior_message
+        @messaging['prior_message']
+      end
+
       def sent_at
         Time.zone.at(@messaging['timestamp'] / 1000)
       end

data/lib/bobot/events/message.rb

@@ -18,7 +18,7 @@ module Bobot
       end
 
       def echo?
-        @messaging['message']['is_echo']
+        @messaging['message']['is_echo'].present?
       end
 
       def attachments

data/lib/bobot/exceptions.rb

@@ -2,15 +2,9 @@ module Bobot
   # Base Facebook Messenger exception.
   class Error < ::StandardError; end
 
-  class InvalidParameter < ::ArgumentError
-    def initialize(name, description = "")
-      super("invalid value of parameter #{name}#{description.present? ? ": '#{description}'" : ''}")
-    end
-  end
-
   class FieldFormat < ::ArgumentError
-    def initialize(description)
-      super("invalid field value with API limits: #{description}")
+    def initialize(description, value = nil)
+      super("#{description}#{value.present? ? " : #{value}'" : ''}")
     end
   end
 

data/lib/bobot/page.rb

@@ -35,7 +35,7 @@ module Bobot
     #####################################
 
     def deliver(payload_template:, to:)
-      raise Bobot::FieldFormat.new('payload_template is required.') unless payload_template.present?
+      raise Bobot::FieldFormat.new('payload_template is required') unless payload_template.present?
       Bobot::Commander.deliver(
         body: {
           recipient: { id: to },
@@ -63,8 +63,8 @@ module Bobot
     end
 
     def send_text(text:, to: nil)
-      raise Bobot::FieldFormat.new('text is required.') unless text.present?
-      raise Bobot::FieldFormat.new('text length is limited to 640.') if text.size > 640
+      raise Bobot::FieldFormat.new('text is required') unless text.present?
+      raise Bobot::FieldFormat.new('text size is limited to 640.', "#{text} (#{text.size} chars)") if text.size > 640
       send(
         payload_message: {
           text: text,
@@ -74,9 +74,9 @@ module Bobot
     end
 
     def send_attachment(url:, type:, to: nil)
-      raise Bobot::FieldFormat.new('url is required.') unless url.present?
-      raise Bobot::FieldFormat.new('type is required.') unless type.present?
-      raise Bobot::FieldFormat.new('type is invalid, only "image, audio, video, file" are permitted.') unless %w[image audio video file].include?(type)
+      raise Bobot::FieldFormat.new('url is required') unless url.present?
+      raise Bobot::FieldFormat.new('type is required') unless type.present?
+      raise Bobot::FieldFormat.new('type is invalid, only "image, audio, video, file" are permitted.', type) unless %w[image audio video file].include?(type)
       send(
         payload_message: {
           attachment: {
@@ -107,10 +107,10 @@ module Bobot
     end
 
     def send_quick_replies(text:, quick_replies:, to: nil)
-      raise Bobot::FieldFormat.new('text is required.') unless text.present?
-      raise Bobot::FieldFormat.new('text length is limited to 640.') if text.size > 640
-      raise Bobot::FieldFormat.new('quick_replies are required.') unless quick_replies.present?
-      raise Bobot::FieldFormat.new('quick_replies are limited to 11.') if quick_replies.size > 11
+      raise Bobot::FieldFormat.new('text is required') unless text.present?
+      raise Bobot::FieldFormat.new('text size is limited to 640.', "#{text} (#{text.size} chars)") if text.size > 640
+      raise Bobot::FieldFormat.new('quick_replies are required') unless quick_replies.present?
+      raise Bobot::FieldFormat.new('quick_replies are limited to 11.', "#{quick_replies.size} quick replies") if quick_replies.size > 11
       send(
         payload_message: {
           text: text,
@@ -121,10 +121,10 @@ module Bobot
     end
 
     def send_buttons(text:, buttons:, to: nil)
-      raise Bobot::FieldFormat.new('text is required.') unless text.present?
-      raise Bobot::FieldFormat.new('text length is limited to 640.') if text.size > 640
-      raise Bobot::FieldFormat.new('buttons are required.') unless buttons.present?
-      raise Bobot::FieldFormat.new('buttons are limited to 3.') if buttons.size > 3
+      raise Bobot::FieldFormat.new('text is required') unless text.present?
+      raise Bobot::FieldFormat.new('text size is limited to 640.', "#{text} (#{text.size} chars)") if text.size > 640
+      raise Bobot::FieldFormat.new('buttons are required') unless buttons.present?
+      raise Bobot::FieldFormat.new('buttons are limited to 3', "#{buttons.size} buttons") if buttons.size > 3
       send(
         payload_message: {
           attachment: {
@@ -141,10 +141,10 @@ module Bobot
     end
 
     def send_generic(elements:, image_aspect_ratio: 'square', to: nil)
-      raise Bobot::FieldFormat.new('elements are required.') if elements.nil?
-      raise Bobot::FieldFormat.new('elements are limited to 10.') if elements.size > 10
-      raise Bobot::FieldFormat.new('image_aspect_ratio is required.') if image_aspect_ratio.nil?
-      raise Bobot::FieldFormat.new('image_aspect_ratio is invalid, only "square, horizontal" are permitted.') unless %w[square horizontal].include?(image_aspect_ratio)
+      raise Bobot::FieldFormat.new('elements are required') if elements.nil?
+      raise Bobot::FieldFormat.new('elements are limited to 10.', "#{elements.size} elements") if elements.size > 10
+      raise Bobot::FieldFormat.new('image_aspect_ratio is required') if image_aspect_ratio.nil?
+      raise Bobot::FieldFormat.new('image_aspect_ratio is invalid, only "square, horizontal" are permitted.', image_aspect_ratio) unless %w[square horizontal].include?(image_aspect_ratio)
       send(
         payload_message: {
           attachment: {
@@ -176,8 +176,8 @@ module Bobot
 
     ## == Subcribe your bot to your page ==
     def subscribe_to_facebook_page!
-      raise Bobot::InvalidParameter.new(:page_id)      unless page_id.present?
-      raise Bobot::InvalidParameter.new(:access_token) unless page_access_token.present?
+      raise Bobot::FieldFormat.new("page_id is required") unless page_id.present?
+      raise Bobot::FieldFormat.new("access_token is required") unless page_access_token.present?
       Bobot::Subscription.set(
         query: {
           page_id: page_id,
@@ -188,8 +188,8 @@ module Bobot
 
     ## == Unsubcribe your bot from your page ==
     def unsubscribe_to_facebook_page!
-      raise Bobot::InvalidParameter.new(:page_id)      unless page_id.present?
-      raise Bobot::InvalidParameter.new(:access_token) unless page_access_token.present?
+      raise Bobot::FieldFormat.new("page_id is required") unless page_id.present?
+      raise Bobot::FieldFormat.new("access_token is required") unless page_access_token.present?
       Bobot::Subscription.unset(
         query: {
           page_id: page_id,
@@ -200,7 +200,7 @@ module Bobot
 
     ## == Set bot description (only displayed on first time). ==
     def set_greeting_text!
-      raise Bobot::InvalidParameter.new(:access_token) unless page_access_token.present?
+      raise Bobot::FieldFormat.new("access_token is required") unless page_access_token.present?
       greeting_texts = []
       if language.nil?
         # Default text
@@ -222,7 +222,7 @@ module Bobot
       if greeting_texts.present?
         greeting_texts.each do |greeting_text|
           if greeting_text[:text].present? && greeting_text[:text].size > 160
-            raise Bobot::FieldFormat.new('greeting text for locale #{greeting_text[:locale]} is limited to 160.', greeting_text[:text]) 
+            raise Bobot::FieldFormat.new('greeting text for locale #{greeting_text[:locale]} is limited to 160.', "#{greeting_text[:text]} (#{greeting_text[:text].size} chars)")
           end
         end
         Bobot::Profile.set(
@@ -233,7 +233,7 @@ module Bobot
     end
 
     def unset_greeting_text!
-      raise Bobot::InvalidParameter.new(:access_token) unless page_access_token.present?
+      raise Bobot::FieldFormat.new("access_token is required") unless page_access_token.present?
       Bobot::Profile.unset(
         body: { fields: %w[greeting] },
         query: { access_token: page_access_token },
@@ -244,8 +244,8 @@ module Bobot
     ## == Some features like Messenger Extensions and Checkbox Plugin require ==
     ## == a page to specify a domain whitelist. ==
     def set_whitelist_domains!
-      raise Bobot::InvalidParameter.new(:access_token) unless page_access_token.present?
-      raise Bobot::InvalidParameter.new(:domains) unless Bobot.config.domains.present?
+      raise Bobot::FieldFormat.new("access_token is required") unless page_access_token.present?
+      raise Bobot::FieldFormat.new("Bobot.config.domains is required") unless Bobot.config.domains.present?
       Bobot::Profile.set(
         body: { whitelisted_domains: Bobot.config.domains },
         query: { access_token: page_access_token },
@@ -253,7 +253,7 @@ module Bobot
     end
 
     def unset_whitelist_domains!
-      raise Bobot::InvalidParameter.new(:access_token) unless page_access_token.present?
+      raise Bobot::FieldFormat.new("access_token is required") unless page_access_token.present?
       Bobot::Profile.unset(
         body: { fields: ["whitelisted_domains"] },
         query: { access_token: page_access_token },
@@ -264,8 +264,8 @@ module Bobot
     ## == the Get Started button. Before doing it you should check to select the ==
     ## == messaging_postbacks field when setting up your webhook. ==
     def set_get_started_button!
-      raise Bobot::InvalidParameter.new(:access_token) unless page_access_token.present?
-      raise Bobot::InvalidParameter.new(:get_started_payload) unless get_started_payload.present?
+      raise Bobot::FieldFormat.new("access_token is required") unless page_access_token.present?
+      raise Bobot::FieldFormat.new("get_started_payload is required") unless get_started_payload.present?
       Bobot::Profile.set(
         body: { get_started: { payload: get_started_payload } },
         query: { access_token: page_access_token },
@@ -273,7 +273,7 @@ module Bobot
     end
 
     def unset_get_started_button!
-      raise Bobot::InvalidParameter.new(:access_token) unless page_access_token.present?
+      raise Bobot::FieldFormat.new("access_token is required") unless page_access_token.present?
       Bobot::Profile.unset(
         body: { fields: %w[persistent_menu get_started] },
         query: { access_token: page_access_token },
@@ -284,7 +284,7 @@ module Bobot
     ## == If you want to have a persistent menu, you have to set get_started ==
     ## == button before. ==
     def set_persistent_menu!
-      raise Bobot::InvalidParameter.new(:access_token) unless page_access_token.present?
+      raise Bobot::FieldFormat.new("access_token is required") unless page_access_token.present?
       persistent_menus = []
       # Default text
       if language.nil?
@@ -322,7 +322,7 @@ module Bobot
       if persistent_menus.present?
         persistent_menus.each do |persistent_menu|
           if persistent_menu[:title].present? && persistent_menu[:title].size > 30
-            raise Bobot::FieldFormat.new('persistent menu text for locale #{persistent_menu[:locale]} is limited to 30.', persistent_menu[:title])
+            raise Bobot::FieldFormat.new('persistent menu text for locale #{persistent_menu[:locale]} is limited to 30.', "#{persistent_menu[:title]} (#{persistent_menu[:title].size} chars)")
           end
         end
         Bobot::Profile.set(
@@ -333,7 +333,7 @@ module Bobot
     end
 
     def unset_persistent_menu!
-      raise Bobot::InvalidParameter.new(:access_token) unless page_access_token.present?
+      raise Bobot::FieldFormat.new("access_token is required") unless page_access_token.present?
       Bobot::Profile.unset(
         body: { fields: ["persistent_menu"] },
         query: { access_token: page_access_token },

data/lib/bobot/version.rb

@@ -1,8 +1,8 @@
 module Bobot
   class Version
     MAJOR = 3
-    MINOR = 6
-    PATCH = 3
+    MINOR = 7
+    PATCH = 2
     PRE = nil
 
     class << self

data/spec/bobot/event/common_spec.rb

@@ -30,6 +30,10 @@ RSpec.describe Bobot::Dummy do
             'url' => 'https://www.example.com/1.jpg'
           }
         }]
+      },
+      'prior_message' => {
+        'source' => 'checkbox_plugin',
+        'identifier' => '903dac41-0976-467f-805e-ed58dc23a783'
       }
     }
   end
@@ -57,6 +61,12 @@ RSpec.describe Bobot::Dummy do
     end
   end
 
+  describe '.prior_message' do
+    it 'returns the message' do
+      expect(subject.prior_message).to eq(payload['prior_message'])
+    end
+  end
+
   describe '.sent_at' do
     it 'returns when the message was sent' do
       expect(subject.sent_at).to eq(Time.zone.at(payload['timestamp'] / 1000))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bobot
 version: !ruby/object:Gem::Version
-  version: 3.6.3
+  version: 3.7.2
 platform: ruby
 authors:
 - Navid EMAD
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-15 00:00:00.000000000 Z
+date: 2018-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n