aboie 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f3c0bb2b00399a19f35ce6bc0050edb6b8cdbe35
+  data.tar.gz: 43fb249ac107f923c68e53386ad608ca2007c8d6
+SHA512:
+  metadata.gz: a0de2cee5e89729cc0db11035f01815616fe2935be244f950c9f13a5aee736439469cf7804b006daaee25e751aed1c98c54c3dcdb7c67b13b05553149dac2189
+  data.tar.gz: a11ce231aad7b0c3a4c96897436e1849f5ffe8a5370720251f037448f442cd388cf7ee7f0c805c36c01f77dacdd033d8dca12afa198e26aee2863c7ed2e6a40c

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/Gemfile

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

data/README.md

@@ -0,0 +1,80 @@
+# Aboie
+
+
+Aboie is a Framework for Facebook Messanger bots built with Ruby.
+
+* Parses incomming message json into the commonly required parts (Sender) and (Message)
+* Easily send text message responses via the Facebook Messanger API (Destination) & (Message)
+* Support for Rich Media messages. (TODO)
+
+
+### Why Aboie
+
+Aboie is a french command when training dogs that means Speak or Bark.
+
+## Getting Started:
+
+This assumes you have read the facebook docs [https://developers.facebook.com/docs/messenger-platform](https://developers.facebook.com/docs/messenger-platform), and have created an api key.
+
+### Installation:
+
+Add
+
+`gem 'aboie`
+
+it
+
+### Configuration:
+
+Create an initializer with the following
+
+```
+	 Aboie.configure do |config|
+	   config.api_key = "messanger_api_key"
+	 end
+```
+
+
+### Parsing webhooks
+
+Follow the instructions to setup an inbound webhook for the Messanger Api.
+Aboie can help you parse through the large object and make sense of it.
+
+```
+module Webhooks
+  class FacebooksController < ActionController::Base
+    include Webhooks::Facebook::Verifiable
+
+    def create
+      messages = Aboie.parse_payload(params)
+      message = messages.first
+      query = message[:text]
+      response = Chat::Brain.ask(query)
+      Aboie.send_text(message[:sender], response)
+      render nothing: true, status: :ok
+    end
+
+  end
+end
+
+```
+
+Aboie.parse_payload(params) will parse the array of potential messages, into a simple array containing a hash with `{text: "Message", sender: "SenderId"}` this data can be used to formulate a response and respond to the proper sender id, using Aboie's easy message sending capabilities via `Aboie.send_text` which takes a `(sender_id, message)` as outlined in the example.
+
+
+
+
+## Questions?  Issues?
+
+For issues, please submit a Github issue with steps on how to reproduce the problem.
+
+
+## Contributions
+
+Contributions are welcome. Tests are encouraged.
+
+To run tests / ensure your changes have not caused any regressions:
+
+```
+rspec
+```

data/aboie.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aboie/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "aboie"
+  spec.version       = Aboie::VERSION
+  spec.authors       = ["Justin McNally"]
+  spec.email         = ["justin.cole.mcnally@gmail.com"]
+
+  spec.summary       = %q{Aboie API}
+  spec.description   = %q{A gem for facebook messanger api}
+  spec.homepage      = "http://www.github.com/j-mcnally"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem 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 { |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", "~> 2.0.0.rc2"
+  spec.add_dependency "oj", "2.13.1"
+
+
+  spec.add_development_dependency "webmock", "1.23.0"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "awesome_print", '1.6.1'
+end

data/lib/aboie.rb

@@ -0,0 +1,22 @@
+require 'rest-client'
+require 'oj'
+
+require 'aboie/version'
+require 'aboie/configuration/base'
+require 'aboie/client'
+require 'aboie/errors'
+require 'aboie/parser'
+
+module Aboie
+  extend Configuration::Base
+  extend Parser
+
+  def self.default_client
+    @@client ||= Aboie::Client.new
+  end
+
+  def self.method_missing(name, *args)
+    self.default_client.send(name, *args)
+  end
+
+end

data/lib/aboie/client.rb

@@ -0,0 +1,28 @@
+module Aboie
+  class Client
+    attr_accessor :api_key
+    def initialize(api_key=nil)
+      self.api_key = api_key || Aboie.configuration.api_key
+    end
+
+    def send_text(who, msg)
+
+      payload = {
+        recipient: {id: who},
+        message: {text: msg}
+      }
+
+      begin
+        RestClient.post("https://graph.facebook.com/v2.6/me/messages?access_token=#{self.api_key}",
+          payload.to_json,
+          {accept: :json, content_type: :json}
+        )
+      rescue StandardError => e
+        puts e.response.inspect
+        puts e.response.body
+        raise e
+      end
+    end
+
+  end
+end

data/lib/aboie/configuration/base.rb

@@ -0,0 +1,20 @@
+module Aboie
+  module Configuration
+    module Base
+      def reset
+          @@configuration = OpenStruct.new
+      end
+      def configure(&block)
+        yield configuration
+      end
+
+      def configuration
+        @@configuration
+      end
+
+      def self.extended(base)
+        base.reset
+      end
+    end
+  end
+end

data/lib/aboie/errors.rb

@@ -0,0 +1 @@
+require 'aboie/errors/authentication_error'

data/lib/aboie/errors/authentication_error.rb

@@ -0,0 +1,3 @@
+module Aboie
+class AuthenticationError < StandardError; end
+end

data/lib/aboie/parser.rb

@@ -0,0 +1,15 @@
+module Aboie
+  module Parser
+    def parse_payload(payload)
+      payload = Oj.load(payload) if payload.is_a?(String)
+      messages = []
+      payload["entry"].each do |entry|
+        next if entry["messaging"].nil?
+        entry["messaging"].each do |msg|
+          messages.push({sender: msg["sender"]["id"], text: msg["message"]["text"]})
+        end
+      end
+      messages
+    end
+  end
+end

data/lib/aboie/version.rb

@@ -0,0 +1,3 @@
+module Aboie
+  VERSION = "0.9.0"
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: aboie
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Justin McNally
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.rc2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.rc2
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.13.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.23.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.23.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+description: A gem for facebook messanger api
+email:
+- justin.cole.mcnally@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- aboie.gemspec
+- lib/aboie.rb
+- lib/aboie/client.rb
+- lib/aboie/configuration/base.rb
+- lib/aboie/errors.rb
+- lib/aboie/errors/authentication_error.rb
+- lib/aboie/parser.rb
+- lib/aboie/version.rb
+homepage: http://www.github.com/j-mcnally
+licenses: []
+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
+signing_key: 
+specification_version: 4
+summary: Aboie API
+test_files: []
+has_rdoc: