fb-messenger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef3e88424f5141101e430387f7ba07a9a25e018e
+  data.tar.gz: 210408a593972d4885fc7eccf1192a6c1e471408
+SHA512:
+  metadata.gz: 639d872286b914e593480788730d67e730d21d01f498878da9378b10717a9502b4c4c1a0bd5d959ffd49b1b20b41fe0b63b0fdd176138714aa009bfbf3ac219e
+  data.tar.gz: 0279a3ba2119cb0a219e325316683fbc96a361489b9ecbfc19efc4e2155a74e3fd3411077ab50eb285c54955e4593b21e5c2c14fed31a87dff3495c73a590ce9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 ccleung
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Fb::Messenger
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/fb/messenger`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fb-messenger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fb-messenger
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/fb-messenger.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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 "fb/messenger"
+
+# 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/fb-messenger.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fb/messenger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fb-messenger"
+  spec.version       = Fb::Messenger::VERSION
+  spec.authors       = ["ccleung"]
+  spec.email         = ["clemsquared@gmail.com"]
+
+  spec.summary       = %q{Send and receive Fb messenger messages.}
+  spec.description   = %q{Send and receive Fb messenger messages.}
+  spec.homepage      = "https://github.com/ccleung/fb-messenger"
+  spec.license       = "MIT"
+
+  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_dependency "rest-client", "~> 1.8"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "factory_girl", "~> 4.7"
+  spec.add_development_dependency "webmock", "~> 2.1"
+end

data/lib/fb/messenger.rb

@@ -0,0 +1,30 @@
+require 'rest-client'
+
+require 'fb/messenger/version'
+require 'fb/messenger/configuration'
+require 'fb/messenger/client'
+require 'fb/messenger/templates/button'
+require 'fb/messenger/templates/generic'
+require 'fb/messenger/templates/generic_item'
+require 'fb/messenger/templates/receipt'
+require 'fb/messenger/templates/receipt_item'
+require 'fb/messenger/events/base'
+require 'fb/messenger/events/message'
+require 'fb/messenger/events/postback'
+require 'fb/messenger/events/delivery'
+require 'fb/messenger/subscribers/base'
+require 'fb/messenger/receiver'
+
+module Fb
+  module Messenger
+    class << self
+      def configure
+        yield config
+      end
+
+      def config
+        @config ||= Fb::Messenger::Configuration.new
+      end
+    end
+  end
+end

data/lib/fb/messenger/client.rb

@@ -0,0 +1,44 @@
+module Fb
+  module Messenger
+    BASE_URL = 'https://graph.facebook.com/v2.6'.freeze
+
+    # fb rest client
+    class Client
+      class << self
+        def send(payload)
+          RestClient.post("#{BASE_URL}/me/messages?access_token=#{Fb::Messenger.config.access_token}",
+                          payload.to_json, content_type: :json, accept: :json)
+        end
+
+        def user_info(user_id)
+          r = RestClient.get("#{BASE_URL}/#{user_id}",
+                             params: { access_token: Fb::Messenger.config.access_token },
+                             accept: :json)
+          JSON.parse(r)
+        end
+
+        def send_message_template(recipient, template)
+          payload = {
+            recipient: {
+              id: recipient
+            },
+            message: template
+          }
+          send(payload)
+        end
+
+        def send_message_text(recipient, text)
+          payload = {
+            recipient: {
+              id: recipient
+            },
+            message: {
+              text: text
+            }
+          }
+          send(payload)
+        end
+      end
+    end
+  end
+end

data/lib/fb/messenger/configuration.rb

@@ -0,0 +1,8 @@
+module Fb
+  module Messenger
+    class Configuration
+      attr_accessor :access_token
+      attr_accessor :verify_token
+    end
+  end
+end

data/lib/fb/messenger/events/base.rb

@@ -0,0 +1,24 @@
+module Fb
+  module Messenger
+    module Event
+      # base event
+      class Base
+        def initialize(event_data)
+          @event_data = event_data
+        end
+
+        def timestamp
+          @event_data[:timestamp]
+        end
+
+        def sender_id
+          @event_data[:sender][:id]
+        end
+
+        def recipient_id
+          @event_data[:recipient][:id]
+        end
+      end
+    end
+  end
+end

data/lib/fb/messenger/events/delivery.rb

@@ -0,0 +1,20 @@
+module Fb
+  module Messenger
+    module Event
+      # Delivery event
+      class Delivery < Base
+        def watermark
+          @event_data[:delivery][:watermark]
+        end
+
+        def mids
+          @event_data[:delivery][:mids]
+        end
+
+        def seq
+          @event_data[:delivery][:seq]
+        end
+      end
+    end
+  end
+end

data/lib/fb/messenger/events/message.rb

@@ -0,0 +1,19 @@
+module Fb
+  module Messenger
+    module Event
+      class Message < Base
+        def text
+          @event_data[:message][:text]
+        end
+
+        def mid
+          @event_data[:message][:mid]
+        end
+
+        def seq
+          @event_data[:message][:seq]
+        end
+      end
+    end
+  end
+end

data/lib/fb/messenger/events/postback.rb

@@ -0,0 +1,12 @@
+module Fb
+  module Messenger
+    module Event
+      # postback event
+      class Postback < Base
+        def payload
+          @event_data[:postback][:payload]
+        end
+      end
+    end
+  end
+end

data/lib/fb/messenger/receiver.rb

@@ -0,0 +1,47 @@
+module Fb
+  module Messenger
+    # handles the incoming fb webhook data
+    class Receiver
+      class << self
+        # expecting params[:entry]
+        def receive(entries, opts = {})
+          entries.each do |entry|
+            entry[:messaging].each do |msg_event|
+              event_type = event_type(msg_event)
+              unless event_type
+                handle_unsupported_event(msg_event)
+                next
+              end
+              event_class = event_type.classify
+              event = "Fb::Messenger::Event::#{event_class}".constantize.new(msg_event)
+              config[event_type].call(event, opts)
+            end
+          end
+        end
+
+        def configure
+          yield self
+        end
+
+        def subscribe(event, subscriber)
+          config[event] = subscriber
+        end
+
+        def config
+          @_config ||= {}
+        end
+
+        def event_type(msg_event)
+          return 'message' if msg_event[:message]
+          return 'postback' if msg_event[:postback]
+          return 'delivery' if msg_event[:delivery]
+        end
+
+        # TODO: log this error better
+        def handle_unsupported_event(msg_event)
+          puts ">>> unsupported event: #{msg_event}"
+        end
+      end
+    end
+  end
+end

data/lib/fb/messenger/subscribers/base.rb

@@ -0,0 +1,12 @@
+module Fb
+  module Messenger
+    module Subscriber
+      # subscribers listen to events
+      # and handle them in a call method
+      class Base
+        def call(event, opts = {})
+        end
+      end
+    end
+  end
+end

data/lib/fb/messenger/templates/button.rb

@@ -0,0 +1,23 @@
+module Fb
+  module Messenger
+    module Template
+      class Button
+        attr_accessor :type, :title, :payload
+
+        def initialize(opts = {})
+          @type = opts[:type]
+          @title = opts[:title]
+          @payload = opts[:payload]
+        end
+
+        def template
+          {
+            type: type,
+            title: title,
+            payload: payload
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module Fb
+  module Messenger
+    module Template
+      # generic template
+      class Generic
+        attr_accessor :generic_items
+
+        def initialize(opts = {})
+          @generic_items = opts[:generic_items] || []
+        end
+
+        def template
+          {
+            attachment: {
+              type: 'template',
+              payload: {
+                template_type: 'generic',
+                elements: generic_items.map(&:template)
+              }
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/fb/messenger/templates/generic_item.rb

@@ -0,0 +1,25 @@
+module Fb
+  module Messenger
+    module Template
+      class GenericItem
+        attr_accessor :title, :subtitle, :image_url, :buttons
+
+        def initialize(opts = {})
+          @title = opts[:title]
+          @subtitle = opts[:subtitle]
+          @image_url = opts[:image_url]
+          @buttons = opts[:buttons] || []
+        end
+
+        def template
+          {
+            title: title,
+            subtitle: subtitle,
+            image_url: image_url,
+            buttons: buttons.map(&:template)
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module Fb
+  module Messenger
+    module Template
+      class Receipt
+        attr_accessor :recipient_name, :order_number, :currency
+        attr_accessor :payment_method, :order_url, :timestamp
+        attr_accessor :total_cost, :receipt_items
+
+        def initialize(opts = {})
+          @recipient_name = opts[:recipient_name]
+          @order_number = opts[:order_number]
+          @currency = opts[:currency]
+          # payment_method field cannot be nil
+          @payment_method = opts[:payment_method] || 'N/A'
+          @order_url = opts[:order_url]
+          @timestamp = opts[:timestamp]
+          @total_cost = opts[:total_cost]
+          @receipt_items = opts[:receipt_items] || []
+        end
+
+        def template
+          {
+            attachment: {
+              type: 'template',
+              payload: {
+                template_type: 'receipt',
+                recipient_name: recipient_name,
+                order_number: order_number,
+                currency: currency,
+                payment_method: payment_method, # required field
+                order_url: order_url,
+                timestamp: timestamp,
+                elements: receipt_items.map(&:template),
+                summary: {
+                  total_cost: total_cost
+                }
+              }
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/fb/messenger/templates/receipt_item.rb

@@ -0,0 +1,30 @@
+module Fb
+  module Messenger
+    module Template
+      class ReceiptItem
+        attr_accessor :title, :subtitle, :quantity
+        attr_accessor :price, :currency, :image_url
+
+        def initialize(opts = {})
+          @title = opts[:title]
+          @subtitle = opts[:subtitle]
+          @quantity = opts[:quantity]
+          @price = opts[:price]
+          @currency = opts[:currency]
+          @image_url = opts[:image_url]
+        end
+
+        def template
+          {
+            title: title,
+            subtitle: subtitle,
+            quantity: quantity,
+            price: price,
+            currency: currency,
+            image_url: image_url
+          }
+        end
+      end
+    end
+  end
+end

data/lib/fb/messenger/version.rb

@@ -0,0 +1,5 @@
+module Fb
+  module Messenger
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: fb-messenger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ccleung
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Send and receive Fb messenger messages.
+email:
+- clemsquared@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fb-messenger.gemspec
+- lib/fb/messenger.rb
+- lib/fb/messenger/client.rb
+- lib/fb/messenger/configuration.rb
+- lib/fb/messenger/events/base.rb
+- lib/fb/messenger/events/delivery.rb
+- lib/fb/messenger/events/message.rb
+- lib/fb/messenger/events/postback.rb
+- lib/fb/messenger/receiver.rb
+- lib/fb/messenger/subscribers/base.rb
+- lib/fb/messenger/templates/button.rb
+- lib/fb/messenger/templates/generic.rb
+- lib/fb/messenger/templates/generic_item.rb
+- lib/fb/messenger/templates/receipt.rb
+- lib/fb/messenger/templates/receipt_item.rb
+- lib/fb/messenger/version.rb
+homepage: https://github.com/ccleung/fb-messenger
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Send and receive Fb messenger messages.
+test_files: []