messenger-ruby 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba7478e7dc69de8c24460b8780d2c7c2c0624495
-  data.tar.gz: 60a772a736040cf834b0cbd08379887d3f3caf01
+  metadata.gz: c0002a8167648af1651c41031ec1b600947c5fd7
+  data.tar.gz: 399edaa10c599c990ce954a737ee81165548d4fa
 SHA512:
-  metadata.gz: 92bc942f56f99fcecea0608cc5e6650df8a0d2b25eac05095163361c1fa08bd78da6dc1a46cb30452b8b79ee811e3d6f4af1f846d210a80bc80607cf468a3436
-  data.tar.gz: a4f6ffe443cd6dd561dcc99c6e17c1ec9c0c07fa0f3019011ee542965c59300f300a1266d4ff0c9ea05c23f3020abc5a7b4c6a06e51e889939607c96faa9aa4f
+  metadata.gz: ff5cc415b65f152f1142bd1ebff07c529e35113b00bcf7b25b5a8f3c8ac29944c0a8f3a924852eccaa91ee383b37a2e2c341b50649d6b22a4738658f540e2821
+  data.tar.gz: d23051ac1715597ae5e51d95881fa9337e932f0bdfdc19e5086631c902a473eeb9798976cf9859297bb5e7ad185776a9c6b8fa2aee565477a75937ddabf11bbf

data/.codeclimate.yml

@@ -0,0 +1,9 @@
+engines:
+  rubocop:
+    enabled: false
+ratings:
+  paths:
+  - lib/**
+  - "**.rb"
+exclude_paths:
+  - spec/**/*

data/.gitignore

@@ -1,2 +1,6 @@
 /Gemfile.lock
 /pkg
+/coverage
+
+spec/test_app/config/secrets.yml
+spec/test_app/log/*

data/README.md

@@ -1,11 +1,17 @@
 # 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)
+[![](http://img.shields.io/codeclimate/github/netguru/messenger-ruby.svg?style=flat-square)](https://codeclimate.com/github/netguru/messenger-ruby)
+[![](http://img.shields.io/codeclimate/coverage/github/netguru/messenger-ruby.svg?style=flat-square)](https://codeclimate.com/github/netguru/messenger-ruby)
+
+A simple library for supporting implementation of [Facebook Messenger Bots](https://developers.facebook.com/products/messenger/).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'messenger-ruby'
+gem 'messenger-ruby', git: 'https://github.com/netguru/messenger-ruby.git'
 ```
 
 And then execute:
@@ -18,23 +24,402 @@ Or install it yourself as:
 
 ## Configuration
 
-Create `messenger.rb` initializer in you app directory:
+#### Facebook steps
+
+* [create Facebook page](https://www.facebook.com/pages/create/) (skip if you want to use existing page)
+* [create Facebook app](https://developers.facebook.com/quickstarts/?platform=web) (skip if you want to use existing app)
+* go to [Facebook for Developers](https://developers.facebook.com/apps/) and get `Page Access Token` (step __3. Get Page Access Token__ from [this tutorial](https://developers.facebook.com/docs/messenger-platform/quickstart#steps]))
+
+#### Initializer
+
+Create `messenger.rb` initializer in you app directory and paste `Page Access Token` from previous step:
 
 ```ruby
-# app/config/initializers/messenger.rb
+# YOUR_APP/config/initializers/messenger.rb
 Messenger.configure do |config|
-  config.verify_token      = '...'
-  config.page_access_token = '...'
+  config.verify_token      = '<VERIFY_TOKEN>' #will be used in webhook verifiction
+  config.page_access_token = '<PAGE_ACCESS_TOKEN>'
+end
+```
+
+#### Routes
+
+Add to your `routes.rb`:
+
+```ruby
+# YOUR_APP/config/routes.rb
+mount Messenger::Engine, at: "/messenger"
+
+```
+
+#### Controller
+
+Create `messenger_controller.rb` in your controllers directory - controller has to inherit from `Messenger::MessengerController`:
+
+```ruby
+# YOUR_APP/app/controllers/messenger_controller.rb
+class MessengerController < Messenger::MessengerController
+  def webhook
+    #logic here
+    render nothing: true, status: 200
+  end
 end
 ```
 
+`2XX` status is necessary to not clog your bot.
+
+If you want your controller to be named differently, please update your `routes.rb` with appropriate route for `post /messenger/webhook` request.
+
+#### Bot subscription
+
+Run your application and:
+* complete step __2. Setup Webhook__ from [this tutorial](https://developers.facebook.com/docs/messenger-platform/quickstart#steps) - _if you mounted `Messenger::Engine` at `/messenger` and your application can be found at `https://example.com`, your `Callback URL` will be `https://example.com/messenger/webhook`_
+* visit `/messenger/subscribe` in your app (it's replacement for __[4. Subscribe the App to the Page](https://developers.facebook.com/docs/messenger-platform/quickstart#steps)__ step) - call `subscribe` action anytime you want to refresh subscription of your app
+
 ## Usage
 
-TODO: Write usage instructions here
+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
+
+It's used to build parameters for Facebook API. Requires [component](#components) and `recipient_id`.
+
+Example usage:
+```ruby
+Messenger::Request.new(some_component, recipient_id)
+```
+
+### Messenger::Client
+
+Sends requests to Facebook API. Has two methods:
+* `get_user_profile` - requires id of existing facebook user
+* `send` - requires [Messenger::Request](#messengerrequest) object
+
+Example usage:
+```ruby
+Messenger::Client.get_user_profile(user_id) #=> hash with name, surname and profile picture
+Messenger::Client.send(request) #=> hash with message details or exception if request is incorrect
+```
+
+Please note that unsuccessful `send` will be shown in logs as `Facebook API response from invalid request: ...`
+
+### Elements
+
+Elements can't be used outside of templates.
+
+#### Button
+
+Lives inside [Bubble](#bubble) element or [Button template](#button-template).
+
+Attribute | Allowed values | Required?
+--------- | -------------- | :--------:
+type | `'web_url'`, `'postback'` | &#10004;
+title | String | &#10004;
+value | String | &#10004;
+
+Example usage:
+```ruby
+Messenger::Elements::Button.new(type: 'web_url', title: 'Button', value: 'http://github.com')
+```
+
+#### Bubble
+
+Part of [Generic template](#button-template).
+
+Attribute | Allowed values | Required?
+--------- | -------------- | :--------:
+title | String | &#10004;
+subtitle | String | &#10004;*
+image_url | String  | &#10004;*
+buttons | [`Messenger::Elements::Button`](#button) objects array | &#10004;*
+item_url | String | &#10008;
+
+`*` - at least one of them is required
+
+Example usage:
+```ruby
+Messenger::Elements::Bubble.new(title: 'First', subtitle: 'Bubble')
+
+```
+
+#### Address
+
+Used by [Receipt template](#receipt-template).
+
+Attribute | Allowed values | Required?
+--------- | -------------- | :--------:
+street_1 | String | &#10004;
+street_2 | String | &#10008;
+city | String | &#10004;
+postal_code | String | &#10004;
+state | String | &#10004;
+country | String | &#10004;
+
+Example usage:
+```ruby
+Messenger::Elements::Address.new(
+  street_1: 'Vachel Lindsay Dr',
+  street_2: '',
+  city: 'Springfield',
+  postal_code: '62701',
+  state: 'IL',
+  country:'USA'
+)
+```
+
+#### Adjustment
+
+Used by [Receipt template](#receipt-template).
+
+Attribute | Allowed values | Required?
+--------- | -------------- | :--------:
+name | String | &#10004;
+amount | Integer, greater than 0 | &#10004;
+
+Example usage:
+```ruby
+Messenger::Elements::Adjustment.new(name: 'Adjustment 1', amount: 20)
+```
+
+#### Item
+
+Used by [Receipt template](#receipt-template).
+
+Attribute | Allowed values | Required?
+--------- | -------------- | :--------:
+title | String | &#10004;
+subtilte | String | &#10008;
+quantity | Integer | &#10008;
+price | Decimal | &#10008;
+currency | String, from _ISO 4217 Currency Codes_ | &#10008;
+image_url | String | &#10008;
+
+Example usage:
+```ruby
+Messenger::Elements::Item.new(
+  title: 'Cool Tshirt',
+  subtitle: 'XXL White',
+  quantity: 3,
+  price: 34,
+  currency: 'USD',
+  image_url: 'http://assets.servedby-buysellads.com/p/manage/asset/id/25397'
+)
+```
+
+#### Order
+
+Used by [Receipt template](#receipt-template).
+
+Attribute | Allowed values | Required?
+--------- | -------------- | :--------:
+order_number | String, unique per conversation | &#10004;
+currency | String, from _ISO 4217 Currency Codes_ | &#10004;
+payment_method | String | &#10004;
+timestamp | correct timestamp (String) | &#10008;
+order_url | String | &#10008;
+
+Example usage:
+```ruby
+Messenger::Elements::Order.new(
+  order_number: 'R190581345',
+  currency: 'USD',
+  payment_method: 'Visa',
+  timestamp: '1428444852',
+  order_url: 'http://petersapparel.parseapp.com/order?order_id=123456'
+)
+```
+
+#### Summary
+
+
+Used by [Receipt template](#receipt-template).
+
+Attribute | Allowed values | Required?
+--------- | -------------- | :--------:
+subtotal | Decimal | &#10008;
+shipping_cost | Decimal | &#10008;
+total_tax | Decimal | &#10008;
+total_cost | Decimal | &#10004;
+
+Example usage:
+```ruby
+Messenger::Elements::Summary.new(subtotal: 70, shipping_cost: 20, total_tax: 10, total_cost: 100)
+```
+
+### Components
+
+You can find more info about what can be send in [Messenger Platform Docs](https://developers.facebook.com/docs/messenger-platform/send-api-reference).
+
+#### Text
+
+Attribute | Allowed values | Required?
+--------- | -------------- | :--------:
+text | String | &#10004;
+
+
+Here is complete example on how to send sample text to the user:
+```ruby
+if fb_params.message?
+  Messenger::Client.send(
+    Messenger::Request.new(
+      Messenger::Elements::Text.new(text: 'some text'),
+      fb_params.sender_id
+    )
+  )
+end
+
+#make sure to send 200 at the end
+render nothing: true, status: 200
+```
+
+#### Image
+
+Attribute | Allowed values | Required?
+--------- | -------------- | :--------:
+url | String | &#10004;
+
+
+Sending images is simple as well:
+```ruby
+...
+Messenger::Client.send(
+  Messenger::Request.new(
+    Messenger::Elements::Image.new(url: 'http://lorempixel.com/400/400/cats'),
+    fb_params.sender_id
+  )
+)
+...
+```
+
+#### Generic template
+
+Attribute | Allowed values | Required?
+--------- | -------------- | :--------:
+elements | Array of [Messenger::Elements::Bubble](#bubble) objects | &#10004;
+
+Example usage:
+```ruby
+
+#define bubbles here...
+bubble1 = Messenger::Elements::Bubble.new(
+  title: 'Bubble 1',
+  subtitle: 'Cool Bubble',
+  item_url: 'http://lorempixel.com/400/400/cats',
+  image_url: 'http://lorempixel.com/400/400/cats',
+  buttons: [
+    Messenger::Elements::Button.new(
+      type: 'web_url',
+      title: 'Show Website',
+      value: 'https://petersapparel.parseapp.com'
+    )
+  ]
+)
+
+bubble2 = ...
+
+#lets create Generic template
+generic = Messenger::Templates::Generic.new(
+  elements: [bubble1, bubble2]
+)
+
+#now send Generic template to the user
+Messenger::Client.send(
+  Messenger::Request.new(generic, fb_params.sender_id)
+)
+```
+
+#### Button template
+
+Attribute | Allowed values | Required?
+--------- | -------------- | :--------:
+text | String | &#10004;
+buttons | Array of [Messenger::Elements::Button](#button) objects | &#10004;
+
+Example usage:
+```ruby
+
+#lets create Buttons template
+buttons = Messenger::Templates::Buttons.new(
+  text: 'Some Cool Text',
+  buttons: [
+    Messenger::Elements::Button.new(
+      type: 'web_url',
+      title: 'Show Website',
+      value: 'https://petersapparel.parseapp.com'
+    )
+  ]
+)
+
+#now send Buttons template to the user
+Messenger::Client.send(
+  Messenger::Request.new(buttons, fb_params.sender_id)
+)
+```
+
+#### Receipt template
+
+Attribute | Allowed values | Required?
+--------- | -------------- | :--------:
+recipient_name | String | &#10004;
+order | [Messenger::Elements::Order](#order) object | &#10004;
+elements | Array of [Messenger::Elements::Item](#item) objects | &#10004;
+address | [Messenger::Elements::Address](#address) object | &#10008;
+summary | [Messenger::Elements::Summary](#summary) object | &#10004;
+adjustments | Array of [Messenger::Elements::Adjustment](#adjustment) objects | &#10008;
+
+Example usage:
+```ruby
+#define order element here...
+order = Messenger::Elements::Order.new(
+  order_number: 'R190581345',
+  currency: 'USD',
+  payment_method: 'Visa',
+  timestamp: '1428444852',
+  order_url: 'http://petersapparel.parseapp.com/order?order_id=123456'
+)
+
+#and define all other template elements
+item1 = ...
+item2 = ...
+address = ...
+summary = ...
+adjustment1 = ...
+adjustment2 = ...
+
+#lets create Receipt template
+receipt = Messenger::Templates::Receipt.new(
+  recipient_name: 'Random Recipient',
+  order: order,
+  elements: [item1, item2],
+  address: address,
+  summary: summary,
+  adjustments: [adjustment1, adjustment2]
+)
+
+#now send Receipt template to the user
+Messenger::Client.send(
+  Messenger::Request.new(receipt, fb_params.sender_id)
+)
+
+```
+
+### fb_params
+
+Deserializes params recived from Facebook. Available in MessengerController. Methods:
+
+* `message?`
+* `delivery?`
+* `postback?`
+* `attachments`
+* `text_message`
+* `sender_id`
+* `recipient_id`
+
+_Will be extended soon._
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `rake console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/Rakefile

@@ -4,5 +4,5 @@ require "rspec/core/rake_task"
 task default: :spec
 
 task :console do
-  exec "irb -r messenger -I ./lib"
+  exec "irb -r messenger-ruby -I ./lib"
 end

data/app/controllers/messenger/messenger_controller.rb

@@ -0,0 +1,45 @@
+require 'rest-client'
+
+module Messenger
+  class MessengerController < ActionController::Base
+    def validate
+      if verify_token_valid? && access_token_valid?
+        render json: params["hub.challenge"]
+      elsif !verify_token_valid?
+        render json: 'Invalid verify token'
+      else
+        render json: 'Invalid page access token'
+      end
+    end
+
+    def subscribe
+      render json: activate_bot
+    rescue RestClient::BadRequest
+      render json: 'Invalid page access token'
+    end
+
+    private
+
+    def app_location
+      "https://graph.facebook.com/v2.6/me/subscribed_apps?access_token=#{Messenger.config.page_access_token}"
+    end
+
+    def activate_bot
+      RestClient.post(app_location, nil)
+    end
+
+    def access_token_valid?
+      JSON.parse(RestClient.get(app_location)).key?('data')
+    rescue RestClient::BadRequest
+      return false
+    end
+
+    def verify_token_valid?
+      params["hub.verify_token"] == Messenger.config.verify_token
+    end
+
+    def fb_params
+      Params.new(params)
+    end
+  end
+end

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "messenger"
+require "messenger-ruby"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/circle.yml

@@ -0,0 +1,6 @@
+dependencies:
+  pre:
+    - gem install bundler --pre
+machine:
+  ruby:
+    version: 2.2.0

data/config/routes.rb

@@ -0,0 +1,8 @@
+Messenger::Engine.routes.draw do
+  get  :subscribe, to: "messenger#subscribe"
+  get  :webhook,   to: "messenger#validate"
+end
+
+Rails.application.routes.draw do
+  post 'messenger/webhook', to: "messenger#webhook"
+end

data/lib/messenger-ruby.rb

@@ -0,0 +1,41 @@
+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
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield(config)
+    end
+
+    def reset
+      @config = Configuration.new
+    end
+  end
+end
+
+require "messenger/engine"
+require "messenger/params"

data/lib/messenger/client.rb

@@ -0,0 +1,20 @@
+module Messenger
+  class Client
+    def self.get_user_profile(user_id)
+      RestClient.get(
+        "https://graph.facebook.com/v2.6/#{user_id}?fields=first_name,last_name,profile_pic \
+        &access_token=#{Messenger.config.page_access_token}"
+      )
+    end
+
+    def self.send(data)
+      RestClient.post(
+        "https://graph.facebook.com/v2.6/me/messages?access_token=#{Messenger.config.page_access_token}",
+        data.build.to_json,
+        content_type: :json
+      )
+    rescue RestClient::ExceptionWithResponse => err
+      puts "\nFacebook API response from invalid request:\n#{err.response}\n\n"
+    end
+  end
+end

data/lib/messenger/components/attachment.rb

@@ -0,0 +1,35 @@
+module Messenger
+  module Components
+    class Attachment
+      def initialize
+        raise 'This class is abstract!'
+      end
+
+      def build
+        {
+          attachment: {
+            type: @type,
+            payload: payload
+          }
+        }
+      end
+
+      def all_attributes
+        return instance_values unless defined?(flattened_attributes)
+        instance_values.merge! flattened_attributes
+      end
+
+      def payload
+        all_attributes.select { |attribute, value| allowed_attribute?(attribute) && value.present? }
+      end
+
+      def allowed_attribute?(attribute)
+        self.class::ATTRIBUTES.include?(attribute)
+      end
+
+      def build_elements(elements)
+        elements.map { |element| element.build } if elements.present?
+      end
+    end
+  end
+end

data/lib/messenger/components/element.rb

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

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

@@ -0,0 +1,19 @@
+require 'messenger/components/element'
+
+module Messenger
+  module Elements
+    class Bubble < Components::Element
+      def initialize(title:, subtitle: nil, item_url: nil, image_url: nil, buttons: nil)
+        @title = title
+        @subtitle = subtitle
+        @image_url = image_url
+        @item_url = item_url
+        @buttons = build_buttons(buttons)
+      end
+
+      def build_buttons(buttons)
+        buttons.map { |button| button.build } if buttons.present?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Messenger
+  module Elements
+    class Button
+      def initialize(type:, title:, value:)
+        @type = type
+        @title = title
+        @value = value
+      end
+
+      def build
+        { type: @type, title: @title }.merge! eval(@type.to_s)
+      end
+
+      def web_url
+        { url: @value }
+      end
+
+      def postback
+        { payload: @value }
+      end
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,12 @@
+require 'messenger/components/element'
+
+module Messenger
+  module Elements
+    class Adjustment < Components::Element
+      def initialize(name: nil, amount: nil)
+        @name = name
+        @amount = amount
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+require 'messenger/components/element'
+
+module Messenger
+  module Elements
+    class Item < Components::Element
+      def initialize(title:, subtitle: nil, quantity: nil, price: nil, currency: nil, image_url: nil)
+        @title = title
+        @subtitle = subtitle
+        @quantity = quantity
+        @price = price
+        @currency = currency
+        @image_url = image_url
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+require 'messenger/components/element'
+
+module Messenger
+  module Elements
+    class Order < Components::Element
+      def initialize(order_number:, currency:, payment_method:, timestamp: nil, order_url: nil)
+        @order_number = order_number
+        @currency = currency
+        @payment_method = payment_method
+        @timestamp = timestamp
+        @order_url = order_url
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+require 'messenger/components/element'
+
+module Messenger
+  module Elements
+    class Summary < Components::Element
+      def initialize(subtotal: nil, shipping_cost: nil, total_tax: nil, total_cost:)
+        @subtotal = subtotal
+        @shipping_cost = shipping_cost
+        @total_tax = total_tax
+        @total_cost = total_cost
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Messenger
+  module Elements
+    class Text
+      def initialize(text:)
+        @text = text
+      end
+
+      def build
+        instance_values
+      end
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,36 @@
+require 'messenger/components/attachment'
+
+module Messenger
+  module Templates
+    class Receipt < Components::Attachment
+      ATTRIBUTES = %w(
+        template_type
+        recipient_name
+        order_number
+        currency
+        payment_method
+        timestamp
+        order_url
+        elements
+        address
+        summary
+        adjustments
+      ).freeze
+
+      def initialize(recipient_name:, order:, elements:, address: nil, summary:, adjustments: nil)
+        @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)
+      end
+
+      def flattened_attributes
+        @order.build
+      end
+    end
+  end
+end

data/lib/messenger/engine.rb

@@ -0,0 +1,7 @@
+require 'rails'
+
+module Messenger
+  class Engine < ::Rails::Engine
+    isolate_namespace Messenger
+  end
+end

data/lib/messenger/params.rb

@@ -0,0 +1,43 @@
+module Messenger
+  class Params
+    attr_accessor :params
+
+    def initialize(params)
+      @params = params
+    end
+
+    def message?
+      messaging_entry.key?('message')
+    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']
+    end
+
+    private
+
+    def messaging_entry
+      params['entry'][0]['messaging'][0]
+    end
+  end
+end

data/lib/messenger/request.rb

@@ -0,0 +1,24 @@
+module Messenger
+  class Request
+    def initialize(component, recipient_id)
+      @recipient_id = recipient_id
+      @body = body
+      add_element(component)
+    end
+
+    def build
+      return @body
+    end
+
+    def add_element(element)
+      @body[:message].merge! element.build
+    end
+
+    def body
+      {
+        recipient: { id: @recipient_id },
+        message: {}
+      }
+    end
+  end
+end

data/lib/messenger/version.rb

@@ -1,3 +1,3 @@
 module Messenger
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/messenger-ruby.gemspec

@@ -18,7 +18,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_dependency 'rest-client'
+
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rails"
+  spec.add_development_dependency "codeclimate-test-reporter"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: messenger-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - justynjozwiak
@@ -9,22 +9,36 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-18 00:00:00.000000000 Z
+date: 2016-04-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -53,6 +67,76 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - justyn.jozwiak@netguru.pl
@@ -61,15 +145,37 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
 - Gemfile
 - README.md
 - Rakefile
+- app/controllers/messenger/messenger_controller.rb
 - bin/console
 - bin/setup
-- lib/messenger.rb
+- circle.yml
+- config/routes.rb
+- lib/messenger-ruby.rb
+- lib/messenger/client.rb
+- lib/messenger/components/attachment.rb
+- lib/messenger/components/element.rb
+- lib/messenger/components/elements/bubble.rb
+- lib/messenger/components/elements/button.rb
+- lib/messenger/components/elements/image.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/text.rb
+- lib/messenger/components/templates/buttons.rb
+- lib/messenger/components/templates/generic.rb
+- lib/messenger/components/templates/receipt.rb
 - lib/messenger/configuration.rb
+- lib/messenger/engine.rb
+- lib/messenger/params.rb
+- lib/messenger/request.rb
 - lib/messenger/version.rb
 - messenger-ruby.gemspec
 homepage: https://github.com/netguru/messenger-ruby

data/lib/messenger.rb

@@ -1,20 +0,0 @@
-require "messenger/version"
-require "messenger/configuration"
-
-module Messenger
-  class << self
-    attr_accessor :config
-
-    def config
-      @config ||= Configuration.new
-    end
-
-    def configure
-      yield(config)
-    end
-
-    def reset
-      @config = Configuration.new
-    end
-  end
-end