messenger_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d88fe123f1849121c7648507e7609f370f00be3
+  data.tar.gz: 87cb3c7f6c730f40ea42a8d74b8f7fb6d5b42124
+SHA512:
+  metadata.gz: 95003a3729846d4301e7c3f899209e37d98c591c0409d87459c026ce14b9fbde88182a96d3256e742e206d18575f9048506647a2dcb5c2a5f225454819b3ba1e
+  data.tar.gz: 1dfbe0db59111d64d0cd788541d1a508af4ac8b79fc493e4c693fecd7b5cb03525a6782c8f40d1b4081301ce2f61075ec3a0c78058aa3335bbccf384ce6c20ef

data/.gitignore

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at aaron@aaroncruz.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Aaron Cruz
+
+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 @@
+# MessengerClient
+
+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/messenger_client`. 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 'messenger_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install messenger_client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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]/messenger_client. 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.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "messenger_client"
+
+# 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_client/button.rb

@@ -0,0 +1,8 @@
+module MessengerClient
+  class Button
+    def initialize(text, data)
+      @text = text
+      @data = data
+    end
+  end
+end

data/lib/messenger_client/button_template.rb

@@ -0,0 +1,27 @@
+module MessengerClient
+  class ButtonTemplate
+    def initialize(text, buttons)
+      @text    = text
+      @buttons = parse_buttons(buttons)
+    end
+
+    def to_json
+      {
+        attachment: {
+          type: "template",
+          payload: {
+            template_type: "button",
+            text:          @text,
+            buttons:       @buttons
+          }
+        }
+      }
+    end
+
+    private
+
+    def parse_buttons(buttons)
+      buttons.map(&:to_json)
+    end
+  end
+end

data/lib/messenger_client/call_button.rb

@@ -0,0 +1,14 @@
+require File.expand_path("../button", __FILE__)
+
+module MessengerClient
+  class CallButton < Button
+    def to_json
+      {
+        type:    "phone_number",
+        title:   @text,
+        payload: @data
+      }
+    end
+  end
+end
+

data/lib/messenger_client/client.rb

@@ -0,0 +1,105 @@
+module MessengerClient
+  class Client
+    URL_TEMPLATE = "https://graph.facebook.com/v2.6/me/messages?access_token=%s"
+
+    def initialize(page_access_token)
+      @page_access_token = page_access_token
+    end
+
+    def setup_menu(buttons)
+      menu = Menu.new(buttons)
+      post(menu.to_json)
+    end
+
+    def get_started(postback="get_started")
+      gs = GetStarted.new(postback)
+      post(gs.to_json)
+    end
+
+    def text(recipient_id:, text:)
+      send(recipient_id, text: text)
+    end
+
+    def qr(recipient_id:, text:, replies:)
+      qr_template = QuickReplies.new(text, replies)
+      send(recipient_id, qr_template.to_json)
+    end
+
+    def button_template(recipient_id:, text:, buttons:)
+      template = ButtonTemplate.new(text, buttons)
+      send(recipient_id, template.to_json)
+    end
+
+    def image(recipient_id:, url:)
+      media = URLImage.new(url)
+      send(recipient_id, media.to_json)
+    end
+
+    def video(recipient_id:, url:)
+      media = URLVideo.new(url)
+      send(recipient_id, media.to_json)
+    end
+
+    def audio(recipient_id:, url:)
+      media = URLAudio.new(url)
+      send(recipient_id, media.to_json)
+    end
+
+    def file(recipient_id:, url:)
+      media = URLFile.new(url)
+      send(recipient_id, media.to_json)
+    end
+
+    def youtube_video(recipient_id:, url:)
+      text(recipient_id: recipient_id, text: url)
+    end
+
+    def location(recipient_id:)
+      loc = MessengerClient::LocationTemplate.new
+      send(recipient_id, loc.to_json)
+    end
+
+    def typing(recipient_id:, seconds:, &blk)
+      send(recipient_id, nil, sender_action: "typing_on", mark_seen: "true")
+      if seconds > 0
+        sleep(seconds)
+        if block_given?
+          blk.call
+        end
+      end
+    end
+
+    def generic_template(recipient_id:, template:)
+    end
+
+    private
+
+    def send(recipient_id, data, opts={})
+      payload = {
+        recipient: {
+          id: recipient_id
+        }
+      }
+      payload.merge!(message: data) unless data.nil?
+      payload.merge!(opts)
+      Typhoeus.post(url, body: json(payload), headers: headers)
+    end
+
+    def post(payload)
+      Typhoeus.post(url, body: json(payload), headers: headers)
+    end
+
+    def url
+      URL_TEMPLATE % @page_access_token
+    end
+
+    def json(payload)
+      JSON.dump(payload)
+    end
+
+    def headers
+      { 'Accept-Encoding' => 'application/json',
+        'Content-Type' => 'application/json' }
+    end
+  end
+end

data/lib/messenger_client/get_started.rb

@@ -0,0 +1,19 @@
+module MessengerClient
+  class GetStarted
+    def initialize(postback="get_started")
+      @postback = postback
+    end
+
+    def to_json
+      {
+        setting_type: "call_to_actions",
+        thread_state: "new_thread",
+        call_to_actions: [
+          {
+            payload: @postback
+          }
+        ]
+      }
+    end
+  end
+end

data/lib/messenger_client/location_template.rb

@@ -0,0 +1,16 @@
+module MessengerClient
+  class LocationTemplate
+    def initialize(text)
+      @text = text
+    end
+
+    def to_json
+      {
+        text: @text,
+        quick_replies: {
+          content_type: "location"
+        }
+      }
+    end
+  end
+end

data/lib/messenger_client/login_button.rb

@@ -0,0 +1,15 @@
+module MessengerClient
+  class LoginButton
+    def initialize(url)
+      @url = url
+    end
+
+    def to_json
+      {
+        type: "account_link",
+        url:  @url
+      }
+    end
+  end
+end
+

data/lib/messenger_client/logout_button.rb

@@ -0,0 +1,13 @@
+module MessengerClient
+  class LogoutButton
+    def initialize
+    end
+
+    def to_json
+      {
+        type: "account_unlink"
+      }
+    end
+  end
+end
+

data/lib/messenger_client/menu.rb

@@ -0,0 +1,24 @@
+module MessengerClient
+  class Menu
+    def initialize(buttons)
+      @text    = text
+      @buttons = parse_buttons(buttons)
+    end
+
+    def to_json
+      {
+        setting_type:    "call_to_actions",
+        thread_state:    "existing_thread",
+        call_to_actions: parse_buttons(@buttons)
+      }
+    end
+
+    private
+
+    def parse_buttons(buttons)
+      buttons.map(&:to_json)
+    end
+  end
+end
+
+

data/lib/messenger_client/payload_button.rb

@@ -0,0 +1,14 @@
+require File.expand_path("../button", __FILE__)
+
+module MessengerClient
+  class PayloadButton < Button
+    def to_json
+      {
+        type:    "postback",
+        title:   @text,
+        payload: @data
+      }
+    end
+  end
+end
+

data/lib/messenger_client/quick_replies.rb

@@ -0,0 +1,22 @@
+module MessengerClient
+  class QuickReplies
+    def initialize(text, quick_replies)
+      @text          = text
+      @quick_replies = parse_qrs(quick_replies)
+    end
+
+    def to_json
+      {
+        text: @text,
+        quick_replies: @quick_replies
+      }
+    end
+
+    private
+
+    def parse_qrs(quick_replies)
+      quick_replies.map(&:to_json)
+    end
+  end
+end
+

data/lib/messenger_client/quick_reply.rb

@@ -0,0 +1,19 @@
+module MessengerClient
+  class QuickReply
+    def initialize(text, payload=nil, image_url=nil)
+      @text      = text
+      @payload   = payload
+      @image_url = image_url
+    end
+
+    def to_json
+      json = {
+        content_type: "text",
+        title:        @text
+      }
+      json.merge!(payload: @payload)     unless @payload.nil?
+      json.merge!(image_url: @image_url) unless @image_url.nil?
+      json
+    end
+  end
+end

data/lib/messenger_client/share_button.rb

@@ -0,0 +1,13 @@
+module MessengerClient
+  class ShareButton
+    def initialize
+    end
+
+    def to_json
+      {
+        type: "element_share"
+      }
+    end
+  end
+end
+

data/lib/messenger_client/url_audio.rb

@@ -0,0 +1,18 @@
+module MessengerClient
+  class URLAudio
+    def initialize(url)
+      @url = url
+    end
+
+    def to_json
+      {
+        attachment: {
+          type: "audio",
+          payload: {
+            url: @url
+          }
+        }
+      }
+    end
+  end
+end

data/lib/messenger_client/url_button.rb

@@ -0,0 +1,14 @@
+require File.expand_path("../button", __FILE__)
+
+module MessengerClient
+  class URLButton < Button
+    def to_json
+      {
+        type:  "web_url",
+        title: @text,
+        url:   @data
+      }
+    end
+  end
+end
+

data/lib/messenger_client/url_file.rb

@@ -0,0 +1,18 @@
+module MessengerClient
+  class URLFile
+    def initialize(url)
+      @url = url
+    end
+
+    def to_json
+      {
+        attachment: {
+          type: "file",
+          payload: {
+            url: @url
+          }
+        }
+      }
+    end
+  end
+end

data/lib/messenger_client/url_image.rb

@@ -0,0 +1,18 @@
+module MessengerClient
+  class URLImage
+    def initialize(url)
+      @url = url
+    end
+
+    def to_json
+      {
+        attachment: {
+          type: "image",
+          payload: {
+            url: @url
+          }
+        }
+      }
+    end
+  end
+end

data/lib/messenger_client/url_video.rb

@@ -0,0 +1,18 @@
+module MessengerClient
+  class URLVideo
+    def initialize(url)
+      @url = url
+    end
+
+    def to_json
+      {
+        attachment: {
+          type: "video",
+          payload: {
+            url: @url
+          }
+        }
+      }
+    end
+  end
+end

data/lib/messenger_client/version.rb

@@ -0,0 +1,3 @@
+module MessengerClient
+  VERSION = "0.1.0"
+end

data/lib/messenger_client.rb

@@ -0,0 +1,43 @@
+require "json"
+require "typhoeus"
+
+require "messenger_client/version"
+
+# Buttons
+require "messenger_client/button"
+require "messenger_client/call_button"
+require "messenger_client/login_button"
+require "messenger_client/logout_button"
+require "messenger_client/payload_button"
+require "messenger_client/share_button"
+require "messenger_client/url_button"
+
+# Quick Replies
+require "messenger_client/quick_replies"
+require "messenger_client/quick_reply"
+
+# Media
+require "messenger_client/url_audio"
+require "messenger_client/url_file"
+require "messenger_client/url_image"
+require "messenger_client/url_video"
+
+# Location
+require "messenger_client/location_template"
+
+# Menu
+require "messenger_client/menu_button"
+require "messenger_client/menu"
+
+# Get Started
+require "messenger_client/get_started"
+
+# Templates
+require "messenger_client/button_template"
+require "messenger_client/generic_template"
+
+# Client
+require "messenger_client/client"
+
+module MessengerClient
+end

data/messenger_client.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'messenger_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "messenger_client"
+  spec.version       = MessengerClient::VERSION
+  spec.authors       = ["Aaron Cruz"]
+  spec.email         = ["aaron@aaroncruz.com"]
+
+  spec.summary       = %q{A client for the Facebook Messenger platform}
+  spec.description   = %q{If you are building a bot on the Messenger platform or just trying to connect with your users or friends there, here's a wonderful HTTP client for you!}
+  spec.homepage      = "https://computercomputer.computer"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  #if spec.respond_to?(:metadata)
+    #spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+    #raise "RubyGems 2.0 or newer is required to protect against " \
+      #"public gem pushes."
+  #end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency "typhoeus", "~> 1.1.0"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: messenger_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Cruz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: If you are building a bot on the Messenger platform or just trying to
+  connect with your users or friends there, here's a wonderful HTTP client for you!
+email:
+- aaron@aaroncruz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/messenger_client.rb
+- lib/messenger_client/button.rb
+- lib/messenger_client/button_template.rb
+- lib/messenger_client/call_button.rb
+- lib/messenger_client/client.rb
+- lib/messenger_client/generic_template.rb
+- lib/messenger_client/get_started.rb
+- lib/messenger_client/location_template.rb
+- lib/messenger_client/login_button.rb
+- lib/messenger_client/logout_button.rb
+- lib/messenger_client/menu.rb
+- lib/messenger_client/menu_button.rb
+- lib/messenger_client/payload_button.rb
+- lib/messenger_client/quick_replies.rb
+- lib/messenger_client/quick_reply.rb
+- lib/messenger_client/share_button.rb
+- lib/messenger_client/url_audio.rb
+- lib/messenger_client/url_button.rb
+- lib/messenger_client/url_file.rb
+- lib/messenger_client/url_image.rb
+- lib/messenger_client/url_video.rb
+- lib/messenger_client/version.rb
+- messenger_client.gemspec
+homepage: https://computercomputer.computer
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A client for the Facebook Messenger platform
+test_files: []