messenger-ruby 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: feead98aa43ea87eb475f71c4033414b3bbb4f69
-  data.tar.gz: 98f8fa70169398d144e97ea2783f1842a509da0b
+  metadata.gz: 1ab3e0f695929b9f936dedcf17c24efce50a45f2
+  data.tar.gz: fa08ec9f43a23c204c713dd762bc8f6a7e17bbc5
 SHA512:
-  metadata.gz: 047ccb7e6cd3215d2ca5fd33f9fe0f14fb8580f62be9b2292790c1209e1fb421a03df635b2293fd1eaeb78f8660a9f60098dbc98fc6c84bd8da4d66f7ba53504
-  data.tar.gz: 54001a672501fef069bf8d5e0b889f5656e2ce8600a742daef0f4f64d446a2421a212b19e1af9350f2a6e5629e64c9998d7e4bc2f96045245b9fb5da085c399c
+  metadata.gz: ef2449b292db63aa1bd4c8621146aea6a7398d255011e7f99c247d03e1248e4b7cf3da61ea06cc87e6a398cae1718de240bb6552a5079acf74f311f2ac604764
+  data.tar.gz: 532de1596b26423ab1e64a24d2a76ae82365bc09d65b939182ff0f97904085d2441bab07c173f84e53dd5a3a746a6d55fe26cec6f97b13479fbfb43036d855db

data/README.md

@@ -11,7 +11,7 @@ A simple library for supporting implementation of [Facebook Messenger Bot](https
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'messenger-ruby', git: 'https://github.com/netguru/messenger-ruby.git'
+gem 'messenger-ruby'
 ```
 
 And then execute:
@@ -78,7 +78,7 @@ Run your application and:
 
 ## Usage
 
-To send message you need to create [Messenger::Request](#messengerrequest) with one of the available [components](#components) and pass it to [Messenger::Client](#messengerclient)::send method. You can send message only to users who subscribed to your page (e.g. sent some message before). 
+To send message you need to create [Messenger::Request](#messengerrequest) with one of the available [components](#components) and pass it to [Messenger::Client](#messengerclient)::send method. You can send message only to users who subscribed to your page (e.g. sent some message before).
 
 ### Messenger::Request
 
@@ -259,11 +259,11 @@ text | String | ✔
 
 Here is complete example on how to send sample text to the user:
 ```ruby
-if fb_params.message?
+if fb_params.first_entry.callback.message?
   Messenger::Client.send(
     Messenger::Request.new(
       Messenger::Elements::Text.new(text: 'some text'),
-      fb_params.sender_id
+      fb_params.first_entry.sender_id
     )
   )
 end
@@ -285,7 +285,7 @@ Sending images is simple as well:
 Messenger::Client.send(
   Messenger::Request.new(
     Messenger::Elements::Image.new(url: 'http://lorempixel.com/400/400/cats'),
-    fb_params.sender_id
+    fb_params.first_entry.sender_id
   )
 )
 ...
@@ -324,7 +324,7 @@ generic = Messenger::Templates::Generic.new(
 
 #now send Generic template to the user
 Messenger::Client.send(
-  Messenger::Request.new(generic, fb_params.sender_id)
+  Messenger::Request.new(generic, fb_params.first_entry.sender_id)
 )
 ```
 
@@ -352,7 +352,7 @@ buttons = Messenger::Templates::Buttons.new(
 
 #now send Buttons template to the user
 Messenger::Client.send(
-  Messenger::Request.new(buttons, fb_params.sender_id)
+  Messenger::Request.new(buttons, fb_params.first_entry.sender_id)
 )
 ```
 
@@ -398,24 +398,68 @@ receipt = Messenger::Templates::Receipt.new(
 
 #now send Receipt template to the user
 Messenger::Client.send(
-  Messenger::Request.new(receipt, fb_params.sender_id)
+  Messenger::Request.new(receipt, fb_params.first_entry.sender_id)
 )
 
 ```
 
+### Entries
+
+According to Facebook documentation, there is possibility that you can receive multiple `entries` and multiple `messagings`.
+That's why we made it easy for you to iterate over `entries` and `messagings`, but we've also created `first_entry` method
+that returns first entry in `entry` array, because that is the most common case.
+
+Example usage:
+
+```ruby
+fb_params.entries.each do |entry|
+  entry.messagings.each do |messaging|
+    if messaging.callback.message?
+      Messenger::Client.send(
+        Messenger::Request.new(
+          Messenger::Elements::Text.new(text: "Echo: #{messaging.callback.text}"),
+          messaging.sender_id
+        )
+      )
+    end
+  end
+end
+```
+
+Or with `first_entry` method:
+
+```ruby
+if fb_params.first_entry.callback.message?
+  Messenger::Client.send(
+    Messenger::Request.new(
+      Messenger::Elements::Text.new(text: "Echo: #{fb_params.first_entry.callback.text}"),
+      fb_params.first_entry.sender_id
+    )
+  )
+end
+```
+
 ### fb_params
 
-Deserializes params recived from Facebook. Available in MessengerController. Methods:
+Has control over entries. Especially `callback` attribute of `messaging` instance has following methods:
 
 * `message?`
 * `delivery?`
 * `postback?`
+* `optin?`
 * `attachments`
-* `text_message`
-* `sender_id`
-* `recipient_id`
+* `text`
+
+Example usage:
 
-_Will be extended soon._
+```ruby
+fb_params.first_entry.callback.message?
+fb_params.first_entry.callback.postback?
+fb_params.first_entry.callback.delivery?
+fb_params.first_entry.callback.optin?
+fb_params.first_entry.callback.attachments
+fb_params.first_entry.callback.text
+```
 
 ## Development
 

data/lib/messenger/components/attachment.rb

@@ -1,9 +1,7 @@
 module Messenger
   module Components
-    class Attachment
-      def initialize
-        raise 'This class is abstract!'
-      end
+    module Attachment
+      attr_accessor :type
 
       def build
         {

data/lib/messenger/components/element.rb

@@ -1,10 +1,6 @@
 module Messenger
   module Components
-    class Element
-      def initialize
-        raise 'This class is abstract!'
-      end
-
+    module Element
       def build
         instance_values.delete_if { |_attribute, value| value.nil? }
       end

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

@@ -2,13 +2,17 @@ require 'messenger/components/element'
 
 module Messenger
   module Elements
-    class Bubble < Components::Element
+    class Bubble
+      include Components::Element
+
+      attr_accessor :title, :item_url, :image_url, :buttons
+
       def initialize(title:, subtitle: nil, item_url: nil, image_url: nil, buttons: nil)
-        @title = title
-        @subtitle = subtitle
+        @title     = title
+        @subtitle  = subtitle
         @image_url = image_url
-        @item_url = item_url
-        @buttons = build_buttons(buttons)
+        @item_url  = item_url
+        @buttons   = build_buttons(buttons)
       end
 
       def build_buttons(buttons)

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

@@ -1,8 +1,10 @@
 module Messenger
   module Elements
     class Button
+      attr_accessor :type, :title, :value
+
       def initialize(type:, title:, value:)
-        @type = type
+        @type  = type
         @title = title
         @value = value
       end

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

@@ -2,11 +2,15 @@ require 'messenger/components/attachment'
 
 module Messenger
   module Elements
-    class Image < Components::Attachment
+    class Image
+      include Components::Attachment
+
+      attr_accessor :url
+
       ATTRIBUTES = %w(url).freeze
 
       def initialize(url:)
-        @url = url
+        @url  = url
         @type = 'image'
       end
     end

data/lib/messenger/components/elements/receipt/address.rb

@@ -2,14 +2,18 @@ require 'messenger/components/element'
 
 module Messenger
   module Elements
-    class Address < Components::Element
+    class Address
+      include Components::Element
+
+      attr_accessor :street_1, :street_2, :city, :postal_code, :state, :country
+
       def initialize(street_1:, street_2: nil, city:, postal_code:, state:, country:)
-        @street_1 = street_1
-        @street_2 = street_2
-        @city = city
+        @street_1    = street_1
+        @street_2    = street_2
+        @city        = city
         @postal_code = postal_code
-        @state = state
-        @country = country
+        @state       = state
+        @country     = country
       end
     end
   end

data/lib/messenger/components/elements/receipt/adjustment.rb

@@ -2,9 +2,13 @@ require 'messenger/components/element'
 
 module Messenger
   module Elements
-    class Adjustment < Components::Element
+    class Adjustment
+      include Components::Element
+
+      attr_accessor :name, :amount
+
       def initialize(name: nil, amount: nil)
-        @name = name
+        @name   = name
         @amount = amount
       end
     end

data/lib/messenger/components/elements/receipt/item.rb

@@ -2,13 +2,17 @@ require 'messenger/components/element'
 
 module Messenger
   module Elements
-    class Item < Components::Element
+    class Item
+      include Components::Element
+
+      attr_accessor :title, :subtitle, :quantity, :price, :urrency, :image_url
+
       def initialize(title:, subtitle: nil, quantity: nil, price: nil, currency: nil, image_url: nil)
-        @title = title
-        @subtitle = subtitle
-        @quantity = quantity
-        @price = price
-        @currency = currency
+        @title     = title
+        @subtitle  = subtitle
+        @quantity  = quantity
+        @price     = price
+        @currency  = currency
         @image_url = image_url
       end
     end

data/lib/messenger/components/elements/receipt/order.rb

@@ -2,13 +2,17 @@ require 'messenger/components/element'
 
 module Messenger
   module Elements
-    class Order < Components::Element
+    class Order
+      include Components::Element
+
+      attr_accessor :order_number, :currency, :payment_method, :timestamp, :order_url
+
       def initialize(order_number:, currency:, payment_method:, timestamp: nil, order_url: nil)
-        @order_number = order_number
-        @currency = currency
+        @order_number   = order_number
+        @currency       = currency
         @payment_method = payment_method
-        @timestamp = timestamp
-        @order_url = order_url
+        @timestamp      = timestamp
+        @order_url      = order_url
       end
     end
   end

data/lib/messenger/components/elements/receipt/summary.rb

@@ -2,12 +2,16 @@ require 'messenger/components/element'
 
 module Messenger
   module Elements
-    class Summary < Components::Element
+    class Summary
+      include Components::Element
+
+      attr_accessor :subtotal, :shipping_cost, :total_tax, :total_cost
+
       def initialize(subtotal: nil, shipping_cost: nil, total_tax: nil, total_cost:)
-        @subtotal = subtotal
+        @subtotal      = subtotal
         @shipping_cost = shipping_cost
-        @total_tax = total_tax
-        @total_cost = total_cost
+        @total_tax     = total_tax
+        @total_cost    = total_cost
       end
     end
   end

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

@@ -1,6 +1,8 @@
 module Messenger
   module Elements
     class Text
+      attr_accessor :text
+
       def initialize(text:)
         @text = text
       end

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

@@ -2,14 +2,18 @@ require 'messenger/components/attachment'
 
 module Messenger
   module Templates
-    class Buttons < Components::Attachment
+    class Buttons
+      include Components::Attachment
+
+      attr_accessor :text, :buttons, :template_type
+
       ATTRIBUTES = %w(template_type text buttons).freeze
 
       def initialize(text:, buttons:)
-        @type = 'template'
+        @type          = 'template'
         @template_type = 'button'
-        @text = text
-        @buttons = build_elements(buttons)
+        @text          = text
+        @buttons       = build_elements(buttons)
       end
     end
   end

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

@@ -2,13 +2,17 @@ require 'messenger/components/attachment'
 
 module Messenger
   module Templates
-    class Generic < Components::Attachment
+    class Generic
+      include Components::Attachment
+
+      attr_accessor :template_type, :elements
+
       ATTRIBUTES = %w(template_type elements).freeze
 
       def initialize(elements:)
-        @type = 'template'
+        @type          = 'template'
         @template_type = 'generic'
-        @elements = build_elements(elements)
+        @elements      = build_elements(elements)
       end
     end
   end

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

@@ -2,7 +2,11 @@ require 'messenger/components/attachment'
 
 module Messenger
   module Templates
-    class Receipt < Components::Attachment
+    class Receipt
+      include Components::Attachment
+
+      attr_accessor :template_type, :recipient_name, :order, :elements, :address, :summary, :adjustments
+
       ATTRIBUTES = %w(
         template_type
         recipient_name
@@ -18,14 +22,14 @@ module Messenger
       ).freeze
 
       def initialize(recipient_name:, order:, elements:, address: nil, summary:, adjustments: nil)
-        @type = 'template'
-        @template_type = 'receipt'
+        @type           = 'template'
+        @template_type  = 'receipt'
         @recipient_name = recipient_name
-        @order = order
-        @elements = build_elements(elements)
-        @address = address.build
-        @summary = summary.build
-        @adjustments = build_elements(adjustments)
+        @order          = order
+        @elements       = build_elements(elements)
+        @address        = address.build
+        @summary        = summary.build
+        @adjustments    = build_elements(adjustments)
       end
 
       def flattened_attributes

data/lib/messenger/parameters/attachment.rb

@@ -0,0 +1,12 @@
+module Messenger
+  module Parameters
+    class Attachment
+      attr_accessor :type, :url
+
+      def initialize(type:, payload:)
+        @type = type
+        @url  = payload['url']
+      end
+    end
+  end
+end

data/lib/messenger/parameters/callback.rb

@@ -0,0 +1,15 @@
+module Messenger
+  module Parameters
+    module Callback
+      %w(message delivery optin postback).each do |method|
+        define_method("#{method}?") do
+          type.include?(method)
+        end
+      end
+
+      def type
+        self.class.to_s.downcase
+      end
+    end
+  end
+end

data/lib/messenger/parameters/delivery.rb

@@ -0,0 +1,15 @@
+module Messenger
+  module Parameters
+    class Delivery
+      include Callback
+
+      attr_accessor :mids, :watermark, :seq
+
+      def initialize(mids: nil, watermark:, seq:)
+        @mids      = mids
+        @watermark = watermark
+        @seq       = seq
+      end
+    end
+  end
+end

data/lib/messenger/parameters/entry.rb

@@ -0,0 +1,17 @@
+module Messenger
+  module Parameters
+    class Entry
+      attr_accessor :id, :time, :messagings
+
+      def initialize(id:, time:, messaging: nil)
+        @id         = id
+        @time       = time
+        @messagings = build_messagings(messaging) if messaging.present?
+      end
+
+      def build_messagings(messagings)
+        messagings.map { |messaging| Messaging.new(messaging.symbolize_keys) }
+      end
+    end
+  end
+end

data/lib/messenger/parameters/message.rb

@@ -0,0 +1,20 @@
+module Messenger
+  module Parameters
+    class Message
+      include Callback
+
+      attr_accessor :mid, :seq, :text, :attachments
+
+      def initialize(mid:, seq:, text: nil, attachments: nil)
+        @mid         = mid
+        @seq         = seq
+        @text        = text if text.present?
+        @attachments = build_attachments(attachments) if attachments.present?
+      end
+
+      def build_attachments(attachments)
+        attachments.map { |attachment| Attachment.new(attachment.symbolize_keys) }
+      end
+    end
+  end
+end

data/lib/messenger/parameters/messaging.rb

@@ -0,0 +1,24 @@
+module Messenger
+  module Parameters
+    class Messaging
+      attr_accessor :sender_id, :recipient_id, :callback
+
+      def initialize(sender:, recipient:, timestamp: nil, message: nil, delivery: nil, postback: nil, optin: nil)
+        @sender_id    = sender['id']
+        @recipient_id = recipient['id']
+        @callback     = set_callback(message: message, delivery: delivery, postback: postback, optin: optin)
+      end
+
+      def set_callback(callbacks)
+        type = callbacks.select { |_, v| v.present? }.keys.first
+        @callback = constant(type).new(callbacks[type].symbolize_keys)
+      end
+
+      private
+
+      def constant(symbol)
+        "Messenger::Parameters::#{symbol.to_s.camelize}".constantize
+      end
+    end
+  end
+end

data/lib/messenger/parameters/optin.rb

@@ -0,0 +1,13 @@
+module Messenger
+  module Parameters
+    class Optin
+      include Callback
+
+      attr_accessor :ref
+
+      def initialize(ref:)
+        @ref = ref
+      end
+    end
+  end
+end

data/lib/messenger/parameters/postback.rb

@@ -0,0 +1,13 @@
+module Messenger
+  module Parameters
+    class Postback
+      include Callback
+
+      attr_accessor :payload
+
+      def initialize(payload:)
+        @payload = payload
+      end
+    end
+  end
+end

data/lib/messenger/params.rb

@@ -6,38 +6,26 @@ module Messenger
       @params = params
     end
 
-    def message?
-      messaging_entry.key?('message')
+    def entries
+      @entries_objects ||= build_entries
     end
 
-    def delivery?
-      messaging_entry.key?('delivery')
-    end
-
-    def postback?
-      messaging_entry.key?('postback')
-    end
-
-    def attachments
-      messaging_entry['message']['attachments'].map { |a| a['payload']['url'] }
-    end
-
-    def text_message
-      messaging_entry['message']['text']
-    end
-
-    def sender_id
-      messaging_entry['sender']['id']
-    end
-
-    def recipient_id
-      messaging_entry['recipient']['id']
+    def first_entry
+      entries[0].messagings[0]
     end
 
     private
 
-    def messaging_entry
-      params['entry'][0]['messaging'][0]
+    def build_entries
+      entries_objects = []
+      params['entry'].each do |entry|
+        entries_objects << Messenger::Parameters::Entry.new({
+          "id"=>entry["id"],
+          "time"=>entry["time"],
+          "messaging"=>entry["messaging"]
+        }.symbolize_keys)
+      end
+      entries_objects
     end
   end
 end

data/lib/messenger/version.rb

@@ -1,3 +1,3 @@
 module Messenger
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/lib/messenger-ruby.rb

@@ -1,24 +1,6 @@
 require "messenger/version"
 require "messenger/configuration"
 
-require "messenger/components/elements/text"
-require "messenger/components/elements/image"
-require "messenger/components/elements/button"
-require "messenger/components/elements/bubble"
-
-require "messenger/components/elements/receipt/address"
-require "messenger/components/elements/receipt/adjustment"
-require "messenger/components/elements/receipt/item"
-require "messenger/components/elements/receipt/order"
-require "messenger/components/elements/receipt/summary"
-
-require "messenger/components/templates/buttons"
-require "messenger/components/templates/generic"
-require "messenger/components/templates/receipt"
-
-require "messenger/client"
-require "messenger/request"
-
 module Messenger
   class << self
     attr_accessor :config
@@ -39,3 +21,31 @@ end
 
 require "messenger/engine"
 require "messenger/params"
+
+require "messenger/components/elements/text"
+require "messenger/components/elements/image"
+require "messenger/components/elements/button"
+require "messenger/components/elements/bubble"
+
+require "messenger/parameters/attachment"
+require "messenger/parameters/callback"
+require "messenger/parameters/entry"
+require "messenger/parameters/messaging"
+
+require "messenger/parameters/delivery"
+require "messenger/parameters/message"
+require "messenger/parameters/optin"
+require "messenger/parameters/postback"
+
+require "messenger/components/elements/receipt/address"
+require "messenger/components/elements/receipt/adjustment"
+require "messenger/components/elements/receipt/item"
+require "messenger/components/elements/receipt/order"
+require "messenger/components/elements/receipt/summary"
+
+require "messenger/components/templates/buttons"
+require "messenger/components/templates/generic"
+require "messenger/components/templates/receipt"
+
+require "messenger/client"
+require "messenger/request"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: messenger-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - justynjozwiak
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-22 00:00:00.000000000 Z
+date: 2016-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -174,6 +174,14 @@ files:
 - lib/messenger/components/templates/receipt.rb
 - lib/messenger/configuration.rb
 - lib/messenger/engine.rb
+- lib/messenger/parameters/attachment.rb
+- lib/messenger/parameters/callback.rb
+- lib/messenger/parameters/delivery.rb
+- lib/messenger/parameters/entry.rb
+- lib/messenger/parameters/message.rb
+- lib/messenger/parameters/messaging.rb
+- lib/messenger/parameters/optin.rb
+- lib/messenger/parameters/postback.rb
 - lib/messenger/params.rb
 - lib/messenger/request.rb
 - lib/messenger/version.rb
@@ -198,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A library for supporting implementation of Facebook Messenger Bots.