messenger-ruby 1.1.7 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5eb5b0ef51a79852615cc9b7094eef76ae31768
-  data.tar.gz: f9579f120b2b276be47e7a6ba8304a764fbaa7f8
+  metadata.gz: f1e78c50c9e0bb2e4f5a874b2d5f9eac248fc280
+  data.tar.gz: 5b612f714540edcc18cbf4148d7769e3927f366e
 SHA512:
-  metadata.gz: 20b4de7951674a3a9b4c00f54f7f9a31e6bf454fbcb4bbcdcee20aa867da4905a7f4a18aa5a72717cfdfc35f1d9e7c5ea87099523a9b5c7d4d09f9dd858c3ea7
-  data.tar.gz: f75be9c9e5934dd672bd95ba393dab57306c96f525995dfa39d92d55ff282e35e85d4e2d4b6436df525df9a4ea2ef513d8ef8f52e8977c5fb5f62b06aa924209
+  metadata.gz: 05f2ba4823c440175a20eee95b5776a7a19a643c23cce0f483eade0d6a48ae256e07c4d9d4ecc15edd68f6305aa73dd74863b690c711193056a29e7e5db69e4b
+  data.tar.gz: f2b460829b2583a22eb7b9abeeb67bdb4f15bac9bf9c5c9aa561608a63895c4bb87395c45145437eb35ba3cd98d4830cdc273499391449d34d41fea047c3c9c5

data/README.md

@@ -1,11 +1,14 @@
 # messenger-ruby
 [![](https://img.shields.io/gem/v/messenger-ruby.svg?style=flat-square)](https://rubygems.org/gems/messenger-ruby)
 [![](https://img.shields.io/circleci/project/netguru/messenger-ruby.svg?style=flat-square)](https://circleci.com/gh/netguru/messenger-ruby)
-[![Code Climate](https://codeclimate.com/repos/571f619474664d1dff007ae0/badges/77203f4d34a36b976a2b/gpa.svg)](https://codeclimate.com/repos/571f619474664d1dff007ae0/feed)
-[![Test Coverage](https://codeclimate.com/repos/571f619474664d1dff007ae0/badges/77203f4d34a36b976a2b/coverage.svg)](https://codeclimate.com/repos/571f619474664d1dff007ae0/coverage)
+[![codebeat badge](https://codebeat.co/badges/9e5fcfd6-dc77-4a0b-a355-0c6cdd6d1f14)](https://codebeat.co/projects/github-com-netguru-messenger-ruby)
 
 A simple library for supporting implementation of [Facebook Messenger Bot](https://developers.facebook.com/products/messenger/) in Ruby on Rails.
 
+## Requirments
+
+ruby 2.1+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -143,6 +146,26 @@ Messenger::Elements::Bubble.new(title: 'First', subtitle: 'Bubble')
 
 ```
 
+#### Quick Reply
+
+Used by [Quick Replies](#quick-replies).
+
+Attribute | Allowed values | Required?
+--------- | -------------- | :--------:
+content_type | 'text' or 'location' | ✔
+title | String | only if content_type is 'text'
+payload | String | only if content_type is 'text'
+image_url | String | ✘
+
+Example usage:
+```ruby
+    Messenger::Elements::QuickReply.new(
+            content_type: 'text',
+            title: 'SomeTitle',
+            payload: "PAYLOAD"
+          )
+```
+
 #### Address
 
 Used by [Receipt template](#receipt-template).
@@ -292,6 +315,57 @@ Messenger::Client.send(
 ...
 ```
 
+#### Sender Actions
+
+Attribute | Allowed values | Required?
+--------- | -------------- | :--------:
+sender_action | 'typing_on', 'typing_off' or 'mark_seen' | ✔
+
+Sending send action:
+```ruby
+...
+Messenger::Client.send(
+    Messenger::Request.new(
+        Messenger::Elements::SenderAction.new(sender_action: 'mark_seen'),
+        fb_params.first_entry.sender_id
+    )
+)
+...
+```
+
+#### Quick Replies
+
+Attribute | Allowed values | Required?
+--------- | -------------- | :--------:
+text | String | attachment or text must be set
+attachment | Attachment object | attachment or text must be set
+quick_reply | Array of [Messenger::Elements::QuickReply](#quick_reply) objects| ✘
+
+Example usage
+```ruby
+
+    #define quick_replies here...
+    quick_replies = Messenger::Templates::QuickReplies.new(
+      text: "Green or Red?",
+      quick_replies: [
+          Messenger::Elements::QuickReply.new(
+            content_type: 'text',
+            title: 'Green',
+            payload: 'GREEN'
+          ),
+          Messenger::Elements::QuickReply.new(
+              content_type: 'text',
+              title: 'Red',
+              payload: "RED"
+          )
+      ]
+    )
+    
+    #now send quick_replies to the user
+    Messenger::Client.send(
+      Messenger::Request.new(quick_replies, fb_params.first_entry.sender_id)
+    )
+```
 #### Generic template
 
 Attribute | Allowed values | Required?
@@ -480,7 +554,8 @@ mid |
 seq |
 sticker_id |
 text |
-attachments | Array of [Messenger::Parameters::Attachment](#attachment) objects
+
+s | Array of [Messenger::Parameters::Attachment](#attachment) objects
 is_echo |
 app_id |
 metadata |

data/app/controllers/messenger/messenger_controller.rb

@@ -39,7 +39,47 @@ module Messenger
     end
 
     def fb_params
-      Params.new(params)
+      safe_params = params.permit(:object,
+                                  entry: [
+                                      :id,
+                                      :time,
+                                      messaging: [
+                                        { sender: :id },
+                                        :timestamp,
+                                        { recipient: :id },
+                                        message:
+                                          [
+                                            :mid,
+                                            :seq,
+                                            { sticker: :id },
+                                            :text,
+                                            { attachments: [
+                                              :type,
+                                              :url,
+                                              { coordinates: :lat },
+                                              { coordinates: :long }
+                                            ] },
+                                            { quick_reply: :payload },
+                                            :is_echo,
+                                            { app: :id },
+                                            :metadata
+                                          ],
+                                        read: [
+                                          :watermark,
+                                          :seq
+                                        ],
+                                        postback: :payload,
+                                        optin: :ref,
+                                        delivery: [
+                                          { mids: [] },
+                                          :watermark,
+                                          :seq
+                                        ],
+                                        account_linking: [
+                                          :status, :authorization_code
+                                        ]
+                                      ]])
+      Params.new(safe_params)
     end
   end
 end

data/lib/messenger-ruby.rb

@@ -26,8 +26,11 @@ require "messenger/components/elements/text"
 require "messenger/components/elements/image"
 require "messenger/components/elements/button"
 require "messenger/components/elements/bubble"
+require "messenger/components/elements/quick_reply"
+require "messenger/components/elements/sender_action"
 
 require "messenger/parameters/attachment"
+require "messenger/parameters/quick_reply"
 require "messenger/parameters/callback"
 require "messenger/parameters/entry"
 require "messenger/parameters/messaging"
@@ -48,6 +51,7 @@ require "messenger/components/elements/receipt/summary"
 require "messenger/components/templates/buttons"
 require "messenger/components/templates/generic"
 require "messenger/components/templates/receipt"
+require "messenger/components/templates/quick_replies"
 
 require "messenger/client"
 require "messenger/request"

data/lib/messenger/components/element.rb

@@ -4,6 +4,10 @@ module Messenger
       def build
         instance_values.delete_if { |_attribute, value| value.nil? }
       end
+
+      def build_elements(elements)
+        elements.map { |element| element.build } if elements.present?
+      end
     end
   end
 end

data/lib/messenger/components/elements/quick_reply.rb

@@ -0,0 +1,24 @@
+require 'messenger/components/element'
+
+module Messenger
+  module Elements
+    class QuickReply
+      include Components::Element
+
+      attr_accessor :content_type, :title, :payload, :image_url
+
+      def initialize(content_type:, title: nil, payload: nil, image_url: nil)
+        @content_type    = content_type
+        @title    = title if text?(content_type)
+        @payload = payload if text?(content_type)
+        @image_url = image_url
+      end
+
+      private
+
+      def text?(value)
+        value == 'text'
+      end
+    end
+  end
+end

data/lib/messenger/components/elements/sender_action.rb

@@ -0,0 +1,15 @@
+module Messenger
+  module Elements
+    class SenderAction
+      attr_accessor :sender_action
+
+      def initialize(sender_action:)
+        @sender_action  = sender_action
+      end
+
+      def build
+        { 'sender_action' => @sender_action }
+      end
+    end
+  end
+end

data/lib/messenger/components/elements/video.rb

@@ -0,0 +1,18 @@
+require 'messenger/components/attachment'
+
+module Messenger
+  module Elements
+    class Video
+      include Components::Attachment
+
+      attr_accessor :url
+
+      ATTRIBUTES = %w(url).freeze
+
+      def initialize(url:)
+        @url  = url
+        @type = 'video'
+      end
+    end
+  end
+end

data/lib/messenger/components/templates/quick_replies.rb

@@ -0,0 +1,18 @@
+require 'messenger/components/attachment'
+
+module Messenger
+  module Templates
+    class QuickReplies
+      include Components::Element
+
+      attr_accessor :text, :quick_replies
+
+      ATTRIBUTES = %w(text quick_replies).freeze
+
+      def initialize(text:, quick_replies:)
+        @text          = text
+        @quick_replies = build_elements(quick_replies)
+      end
+    end
+  end
+end

data/lib/messenger/parameters/callback.rb

@@ -1,7 +1,7 @@
 module Messenger
   module Parameters
     module Callback
-      %w(message delivery optin postback read account_linking).each do |method|
+      %w(message delivery optin postback read account_linking referral).each do |method|
         define_method("#{method}?") do
           type.include?(method)
         end

data/lib/messenger/parameters/entry.rb

@@ -10,7 +10,7 @@ module Messenger
       end
 
       def build_messagings(messagings)
-        messagings.map { |messaging| Messaging.new(messaging.symbolize_keys) }
+        messagings.map { |messaging| Messaging.new(messaging.transform_keys(&:to_sym)) }
       end
     end
   end

data/lib/messenger/parameters/message.rb

@@ -5,19 +5,24 @@ module Messenger
 
       attr_accessor :mid, :seq, :sticker_id, :text, :attachments, :is_echo, :app_id, :metadata
 
-      def initialize(mid:, seq:, sticker_id: nil, text: nil, attachments: nil, is_echo: nil, app_id: nil, metadata: nil)
+      def initialize(mid:, seq:, sticker_id: nil, text: nil, attachments: nil, quick_reply: nil, is_echo: nil, app_id: nil, metadata: nil)
         @mid         = mid
         @seq         = seq
         @sticker_id  = sticker_id if sticker_id.present?
         @text        = text if text.present?
         @attachments = build_attachments(attachments) if attachments.present?
+        @quick_reply = build_quick_reply(quick_reply) if quick_reply.present?
         @is_echo     = is_echo
         @app_id      = app_id
         @metadata    = metadata
       end
 
       def build_attachments(attachments)
-        attachments.map { |attachment| Attachment.new(attachment.symbolize_keys.slice(:type, :payload)) }
+        attachments.map { |attachment| Attachment.new(attachment.transform_keys(&:to_sym).slice(:type, :payload)) }
+      end
+
+      def build_quick_reply(quick_reply)
+        QuickReply.new(quick_reply.transform_keys(&:to_sym))
       end
     end
   end

data/lib/messenger/parameters/messaging.rb

@@ -11,7 +11,7 @@ module Messenger
 
       def set_callback(callbacks)
         type = callbacks.select { |_, v| v.present? }.keys.first
-        @callback = constant(type).new(callbacks[type].symbolize_keys)
+        @callback = constant(type).new(callbacks[type].transform_keys(&:to_sym))
       end
 
       private

data/lib/messenger/parameters/quick_reply.rb

@@ -0,0 +1,11 @@
+module Messenger
+  module Parameters
+    class QuickReply
+      attr_accessor :payload
+
+      def initialize(payload:)
+        @payload = payload
+      end
+    end
+  end
+end

data/lib/messenger/parameters/referral.rb

@@ -0,0 +1,15 @@
+module Messenger
+  module Parameters
+    class Referral
+      include Callback
+
+      attr_accessor :ref, :source, :type
+
+      def initialize(ref:, source:, type:)
+        @ref = ref
+        @source = source
+        @type = type
+      end
+    end
+  end
+end

data/lib/messenger/params.rb

@@ -14,10 +14,12 @@ module Messenger
       entries[0].messagings[0]
     end
 
+    alias_method :first_messaging, :first_entry
+
     private
 
     def build_entries
-      params['entry'].map { |entry| Parameters::Entry.new(entry.symbolize_keys) }
+      params['entry'].map { |entry| Parameters::Entry.new(entry.to_h.transform_keys(&:to_sym)) }
     end
   end
 end

data/lib/messenger/request.rb

@@ -3,7 +3,7 @@ module Messenger
     def initialize(component, recipient_id)
       @recipient_id = recipient_id
       @body = body
-      add_element(component)
+      create_request(component)
     end
 
     def build
@@ -11,14 +11,25 @@ module Messenger
     end
 
     def add_element(element)
-      @body[:message].merge! element.build
+      @body.merge!({ message: element.build })
+    end
+
+    def add_sender_action(action)
+      @body.merge!(action.build)
     end
 
     def body
       {
-        recipient: { id: @recipient_id },
-        message: {}
+        recipient: { id: @recipient_id }
       }
     end
+
+    def create_request(component)
+      if component.is_a? Elements::SenderAction
+        add_sender_action(component)
+      else
+        add_element(component)
+      end
+    end
   end
 end

data/lib/messenger/version.rb

@@ -1,3 +1,3 @@
 module Messenger
-  VERSION = "1.1.7"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: messenger-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 1.2.0
 platform: ruby
 authors:
 - justynjozwiak
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-22 00:00:00.000000000 Z
+date: 2016-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -163,14 +163,18 @@ files:
 - lib/messenger/components/elements/bubble.rb
 - lib/messenger/components/elements/button.rb
 - lib/messenger/components/elements/image.rb
+- lib/messenger/components/elements/quick_reply.rb
 - lib/messenger/components/elements/receipt/address.rb
 - lib/messenger/components/elements/receipt/adjustment.rb
 - lib/messenger/components/elements/receipt/item.rb
 - lib/messenger/components/elements/receipt/order.rb
 - lib/messenger/components/elements/receipt/summary.rb
+- lib/messenger/components/elements/sender_action.rb
 - lib/messenger/components/elements/text.rb
+- lib/messenger/components/elements/video.rb
 - lib/messenger/components/templates/buttons.rb
 - lib/messenger/components/templates/generic.rb
+- lib/messenger/components/templates/quick_replies.rb
 - lib/messenger/components/templates/receipt.rb
 - lib/messenger/configuration.rb
 - lib/messenger/engine.rb
@@ -183,7 +187,9 @@ files:
 - lib/messenger/parameters/messaging.rb
 - lib/messenger/parameters/optin.rb
 - lib/messenger/parameters/postback.rb
+- lib/messenger/parameters/quick_reply.rb
 - lib/messenger/parameters/read.rb
+- lib/messenger/parameters/referral.rb
 - lib/messenger/params.rb
 - lib/messenger/request.rb
 - lib/messenger/version.rb