messenger_platform 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e86796baeb41f893bf31bde27c43cb990942670
-  data.tar.gz: b081e35ec9a69a62cbfc557ddb370dcb75340ce9
+  metadata.gz: 834c72b31f17fd2d9f1970632e147c38ad600290
+  data.tar.gz: 766f0d2648a5eeb76911302ae851cf12bac3844a
 SHA512:
-  metadata.gz: e669f2037ead55816d5ea630775d423a786672a449b2c1463c3e470071ef6e47c7aa50ebe8debb581027f3cd81d32e644b45bc91e1597766b75ff83b875c35da
-  data.tar.gz: df5271d3cc819cd0d71baacb540a4cfb4fe1ecc2635c965f304a99c8d36db65f843e0054d0f2d3f06109673dad0df0204f59ef321d8b4cb6d1437677ad4b688c
+  metadata.gz: 70978bccb10ed016c1b0f53384b2163f8dca97509c003aba3efa508c6767b6b8530ce41d1056df2750c752d5c6d72dc76bcb21d754ea4ae45dc41811ad284ebc
+  data.tar.gz: c37a6d80d2d71a06a54c5a929698e3fe1e67adeabd969440140ccd4e359062bb7604ae9ded03c90d71ddab1695f94a7edec435b21e661aa12544420b0734395d

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.swp
+*.swo

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at sugiacupit@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in messenger_platform.gemspec
+gemspec

data/README.md

@@ -0,0 +1,170 @@
+# MessengerPlatform
+
+A Ruby interface to the Facebook Messenger Platform API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'messenger_platform'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install messenger_platform
+
+## Usage
+
+#### Configuration
+
+```ruby
+MessengerPlatform.configure do |config|
+  config.token = 'xxxx' # => messenger token
+  config.page_id = 'xxxx' # => Page ID
+end
+```
+
+#### Welcome
+```ruby
+MessengerPlatform.welcome(nil, 'Hello world') # => nil can be changed by page id
+```
+
+#### Send Message
+
+```ruby
+MessengerPlatform.text(user_id, 'Hello world')
+MessengerPlatform.image(user_id, 'https://xxx.com/xx.png')
+```
+
+#### Payload
+
+There are three types of payload: `button`, `generic`, `receipt`
+
+```ruby
+MessengerPlatform.payload(:button, user_id, 'Hello world', [
+  {
+    "type":"web_url",
+    "url":"https://petersapparel.parseapp.com",
+    "title":"Show Website"
+  },
+  {
+    "type":"postback",
+    "title":"Start Chatting",
+    "payload":"USER_DEFINED_PAYLOAD"
+  }
+])
+
+MessengerPlatform.payload(:generic, user_id, [
+  {
+    "title":"Classic White T-Shirt",
+    "image_url":"http://petersapparel.parseapp.com/img/item100-thumb.png",
+    "subtitle":"Soft white cotton t-shirt is back in style",
+    "buttons":[
+      {
+        "type":"web_url",
+        "url":"https://petersapparel.parseapp.com/view_item?item_id=100",
+        "title":"View Item"
+      },
+      {
+        "type":"web_url",
+        "url":"https://petersapparel.parseapp.com/buy_item?item_id=100",
+        "title":"Buy Item"
+      },
+      {
+        "type":"postback",
+        "title":"Bookmark Item",
+        "payload":"USER_DEFINED_PAYLOAD_FOR_ITEM100"
+      }
+    ]
+  },
+  {
+    "title":"Classic Grey T-Shirt",
+    "image_url":"http://petersapparel.parseapp.com/img/item101-thumb.png",
+    "subtitle":"Soft gray cotton t-shirt is back in style",
+    "buttons":[
+      {
+        "type":"web_url",
+        "url":"https://petersapparel.parseapp.com/view_item?item_id=101",
+        "title":"View Item"
+      },
+      {
+        "type":"web_url",
+        "url":"https://petersapparel.parseapp.com/buy_item?item_id=101",
+        "title":"Buy Item"
+      },
+      {
+        "type":"postback",
+        "title":"Bookmark Item",
+        "payload":"USER_DEFINED_PAYLOAD_FOR_ITEM101"
+      }
+    ]
+  }
+])
+
+MessengerPlatform.payload(:receipt, user_id, {
+  "recipient_name":"Stephane Crozatier",
+  "order_number":"12345678902",
+  "currency":"USD",
+  "payment_method":"Visa 2345",
+  "order_url":"http://petersapparel.parseapp.com/order?order_id=123456",
+  "timestamp":"1428444852",
+  "elements":[
+    {
+      "title":"Classic White T-Shirt",
+      "subtitle":"100% Soft and Luxurious Cotton",
+      "quantity":2,
+      "price":50,
+      "currency":"USD",
+      "image_url":"http://petersapparel.parseapp.com/img/whiteshirt.png"
+    },
+    {
+      "title":"Classic Gray T-Shirt",
+      "subtitle":"100% Soft and Luxurious Cotton",
+      "quantity":1,
+      "price":25,
+      "currency":"USD",
+      "image_url":"http://petersapparel.parseapp.com/img/grayshirt.png"
+    }
+  ],
+  "address":{
+    "street_1":"1 Hacker Way",
+    "street_2":"",
+    "city":"Menlo Park",
+    "postal_code":"94025",
+    "state":"CA",
+    "country":"US"
+  },
+  "summary":{
+    "subtotal":75.00,
+    "shipping_cost":4.95,
+    "total_tax":6.19,
+    "total_cost":56.14
+  },
+  "adjustments":[
+    {
+      "name":"New Customer Discount",
+      "amount":20
+    },
+    {
+      "name":"$10 Off Coupon",
+      "amount":10
+    }
+  ]
+})
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Coffa/messenger_platform. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "messenger_platform"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/messenger_platform.rb

@@ -1,2 +1,27 @@
-module Hola
+require 'messenger_platform/config'
+require 'messenger_platform/api'
+require 'messenger_platform/parser'
+
+module MessengerPlatform
+  extend self
+
+  def configure
+    yield(Config) if block_given?
+  end
+
+  def text(receiver_id, text)
+    Api.call(:text, receiver_id, text)
+  end
+
+  def image(receiver_id, image_url)
+    Api.call(:image, receiver_id, image_url)
+  end
+
+  def welcome(page_id, text)
+    Api.call(:welcome, page_id, text)
+  end
+
+  def payload(template_type, *args)
+    Api.call("payload_#{template_type}", *args)
+  end
 end

data/lib/messenger_platform/api.rb

@@ -0,0 +1,18 @@
+require 'messenger_platform/entities/welcome'
+require 'messenger_platform/entities/message'
+require 'messenger_platform/entities/text'
+require 'messenger_platform/entities/image'
+require 'messenger_platform/entities/payload_button'
+require 'messenger_platform/entities/payload_generic'
+require 'messenger_platform/entities/payload_receipt'
+
+module MessengerPlatform
+  module Api
+    extend self
+
+    def call(name, recipient_id, *args)
+      klass = Entities.const_get(name.to_s.split('_').map(&:capitalize).join(''))
+      klass.new(recipient_id).call(*args)
+    end
+  end
+end

data/lib/messenger_platform/config.rb

@@ -0,0 +1,14 @@
+module MessengerPlatform
+  module Config
+
+    mattr_accessor :page_id
+    mattr_accessor :token
+
+    mattr_accessor :end_point
+    @@end_point = 'https://graph.facebook.com/v2.6'
+
+    mattr_accessor :message_end_point
+    @@message_end_point = 'https://graph.facebook.com/v2.6/me/messages'
+
+  end
+end

data/lib/messenger_platform/entities/image.rb

@@ -0,0 +1,12 @@
+module MessengerPlatform
+  module Entities
+    class Image < Message
+
+      def body_params(image_url)
+        auth_params.merge(message_params(attachment: {
+          type: :image, payload: { url: image_url }
+        }))
+      end
+    end
+  end
+end

data/lib/messenger_platform/entities/message.rb

@@ -0,0 +1,26 @@
+module MessengerPlatform
+  module Entities
+    class Message
+      attr_accessor :recipient_id
+
+      def initialize(recipient_id)
+        @recipient_id = recipient_id
+      end
+
+      def call(*args)
+        Typhoeus.post(Config.message_end_point, body: body_params(*args))
+      end
+
+      def auth_params
+        {
+          access_token: Config.token,
+          recipient: { id: recipient_id }
+        }
+      end
+
+      def message_params(message)
+        { message: message }
+      end
+    end
+  end
+end

data/lib/messenger_platform/entities/payload_button.rb

@@ -0,0 +1,17 @@
+module MessengerPlatform
+  module Entities
+    class PayloadButton < Message
+
+      def body_params(text, button_template)
+        auth_params.merge(message_params(attachment: {
+          type: :template,
+          payload: {
+            template_type: :button,
+            text: text,
+            buttons: button_template
+          }
+        }))
+      end
+    end
+  end
+end

data/lib/messenger_platform/entities/payload_generic.rb

@@ -0,0 +1,18 @@
+module MessengerPlatform
+  module Entities
+    class PayloadGeneric < Message
+
+      def body_params(generic_template)
+        auth_params.merge(message: {
+          attachment: {
+            type: :template,
+            payload: {
+              template_type: :generic,
+              elements: generic_template
+            }
+          }
+        })
+      end
+    end
+  end
+end

data/lib/messenger_platform/entities/payload_receipt.rb

@@ -0,0 +1,17 @@
+module MessengerPlatform
+  module Entities
+    class PayloadReceipt < Message
+
+      def body_params(receipt_template)
+        auth_params.merge(message: {
+          attachment: {
+            type: :template,
+            payload: {
+              template_type: :receipt,
+            }.merge(receipt_template)
+          }
+        })
+      end
+    end
+  end
+end

data/lib/messenger_platform/entities/text.rb

@@ -0,0 +1,10 @@
+module MessengerPlatform
+  module Entities
+    class Text < Message
+
+      def body_params(text)
+        auth_params.merge(message_params(text: text))
+      end
+    end
+  end
+end

data/lib/messenger_platform/entities/welcome.rb

@@ -0,0 +1,22 @@
+module MessengerPlatform
+  module Entities
+    class Welcome
+      attr_accessor :page_id
+
+      def initialize(page_id)
+        @page_id = page_id
+      end
+
+      def call(text)
+        params = {
+          access_token: Config.token,
+          setting_type: 'call_to_actions',
+          thread_state: 'new_thread',
+          call_to_actions: [{ message: { text: text } }]
+        }
+
+        Typhoeus.post("#{Config.end_point}/#{page_id || Config.page_id}/thread_settings", body: params)
+      end
+    end
+  end
+end

data/lib/messenger_platform/parser.rb

@@ -0,0 +1,27 @@
+module MessengerPlatform
+  module Parser
+    extend self
+
+    def execute(args)
+      args['entry']
+        .map { |entry| entry[:messaging] }.flatten
+        .map do |msg|
+          {
+            sender_id: msg[:sender][:id],
+            recipient_id: msg[:recipient][:id]
+          }.merge(filter_type(msg) || {})
+        end
+        .select { |msg| msg[:type].present? }
+    end
+
+    private
+
+    def filter_type(msg)
+      if msg.key? 'message'
+        { type: 'message', text: msg[:message][:text] }
+      elsif msg.key? 'postback'
+        { type: 'payload', text: msg[:postback][:payload] }
+      end
+    end
+  end
+end

data/lib/messenger_platform/version.rb

@@ -0,0 +1,3 @@
+module MessengerPlatform
+  VERSION = "0.0.1"
+end

data/lib/tasks/messenger_platform_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :messenger_platform do
+#   # Task goes here
+# end

data/messenger_platform.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'messenger_platform/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "messenger_platform"
+  spec.version       = MessengerPlatform::VERSION
+  spec.authors       = ["MQuy"]
+  spec.email         = ["sugiacupit@gmail.com"]
+
+  spec.summary       = %q{Write a short summary, because Rubygems requires one.}
+  spec.description   = %q{Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/Coffa/messenger_platform"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency 'typhoeus', '~> 1.0'
+  spec.add_dependency 'faraday', '~> 0.9.2'
+end

metadata

@@ -1,25 +1,117 @@
 --- !ruby/object:Gem::Specification
 name: messenger_platform
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
-- Vu Minh Tan, Truong Minh Quy, Le Minh Duc, Nguyen Thanh Long
+- MQuy
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2016-04-14 00:00:00.000000000 Z
-dependencies: []
-description: A simple hello world gem
-email: mitanac@gmail.com
+date: 2016-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: Write a longer description or delete this line.
+email:
+- sugiacupit@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
 - lib/messenger_platform.rb
-homepage: http://rubygems.org/gems/messenger_platform
-licenses:
-- MIT
+- lib/messenger_platform/api.rb
+- lib/messenger_platform/config.rb
+- lib/messenger_platform/entities/image.rb
+- lib/messenger_platform/entities/message.rb
+- lib/messenger_platform/entities/payload_button.rb
+- lib/messenger_platform/entities/payload_generic.rb
+- lib/messenger_platform/entities/payload_receipt.rb
+- lib/messenger_platform/entities/text.rb
+- lib/messenger_platform/entities/welcome.rb
+- lib/messenger_platform/parser.rb
+- lib/messenger_platform/version.rb
+- lib/tasks/messenger_platform_tasks.rake
+- messenger_platform.gemspec
+homepage: https://github.com/Coffa/messenger_platform
+licenses: []
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -37,9 +129,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: API for Facebook Messenger Platform
+summary: Write a short summary, because Rubygems requires one.
 test_files: []
 has_rdoc: