hg 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1770164f6ba93c807d497275ee49886066943aae
+  data.tar.gz: 03be35378314a8e56f3ca0adba45f2fdd7c5bdfb
+SHA512:
+  metadata.gz: b39eabfa70e1bae5b176f2b025f292874c3427320c910e07dbff8b8575fcfcec20a296e9ac57a92b2c5cee4bbb93a832fa99cba62877b85ae0500ad55b835a31
+  data.tar.gz: dfee9d3630208bed5eb2c4186c49f6233731e6e032a253ac52dda29d7daf37f7e748ef52d43e9a0ea9286d73c60a01de2a71c2fbce7e530cff736471f086df74

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Voxable
+
+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 @@
+# Hg
+
+**NB: This gem is still under heavy development, and is likely going to change wildly between releases. You probably shouldn't use it quite yet.**
+
+## Getting Started
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hg'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hg
+    
+### Configuration
+
+Create an initializer file within your Rails app at `config/initializers/bot.rb`
+    
+
+## 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]/hg.
+

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

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hg/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hg'
+  spec.version       = Hg::VERSION
+  spec.authors       = ['Matt Buck']
+  spec.email         = ['matt@voxable.io']
+
+  spec.summary       = %q{A library for building Facebook Messenger bots.}
+  spec.homepage      = "https://rubygems.org/hg"
+
+  # 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'] = 'https://rubygems.org'
+  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_runtime_dependency 'facebook-messenger', '~> 0.11.0'
+  spec.add_runtime_dependency 'fuzzy_match', '~> 2.1.0'
+  spec.add_runtime_dependency 'rails', '~> 5.0.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+end

data/lib/hg.rb

@@ -0,0 +1,10 @@
+require 'facebook/messenger'
+require 'fuzzy_match'
+
+require 'hg/version'
+require 'hg/bot'
+require 'hg/chunk'
+
+module Hg
+  # Your code goes here...
+end

data/lib/hg/bot.rb

@@ -0,0 +1,123 @@
+module Hg
+  module Bot
+    def self.included(base)
+      base.extend ClassMethods
+      base.routes = {}
+      base.chunks = []
+      base.call_to_actions = []
+    end
+
+    module ClassMethods
+      attr_accessor :routes
+      attr_accessor :chunks
+      attr_accessor :default_chunk
+      attr_accessor :call_to_actions
+      attr_accessor :get_started_content
+      attr_accessor :greeting_text
+      attr_accessor :image_url_base_portion
+
+      def init
+        initialize_router
+        initialize_persistent_menu
+        initialize_get_started_button
+        initialize_greeting_text
+      end
+
+      def default(chunk)
+        @default_chunk = chunk
+      end
+
+      def persistent_menu(&block)
+        yield
+      end
+
+      def initialize_persistent_menu
+        Facebook::Messenger::Thread.set({
+          setting_type:    'call_to_actions',
+          thread_state:    'existing_thread',
+          call_to_actions: @call_to_actions
+        }, access_token: ENV['ACCESS_TOKEN'])
+      end
+
+      def call_to_action(text, options = {})
+        call_to_action_content = {
+          title: text
+        }
+
+        if options[:to]
+          call_to_action_content[:type] = 'postback'
+          call_to_action_content[:payload] = options[:to].to_s
+        elsif options[:url]
+          call_to_action_content[:type] = 'web_url'
+          call_to_action_content[:url] = options[:url]
+        end
+
+        @call_to_actions << call_to_action_content
+      end
+
+      def get_started(chunk)
+        @get_started_content = {
+          setting_type: 'call_to_actions',
+          thread_state: 'new_thread',
+          call_to_actions: [
+                          {
+                            payload: chunk.to_s
+                          }
+                        ]
+        }
+      end
+
+      def initialize_get_started_button
+        Facebook::Messenger::Thread.set @get_started_content, access_token: ENV['ACCESS_TOKEN']
+      end
+
+      def greeting_text(text)
+        @greeting_text = text
+      end
+
+      def image_url_base(base)
+        @image_url_base_portion = base
+      end
+
+      def initialize_greeting_text
+        Facebook::Messenger::Thread.set({
+          setting_type: 'greeting',
+          greeting: {
+            text: @greeting_text
+          }
+        }, access_token: ENV['ACCESS_TOKEN'])
+      end
+
+      def run_postback_payload(payload, recipient, context)
+        # TODO: Shouldn't be constantizing user input. Need a way to sanitize this.
+        payload.constantize.new(recipient: recipient, context: context).deliver
+      end
+
+      def initialize_router
+        ::Facebook::Messenger::Bot.on :postback do |postback|
+          Rails.logger.info 'POSTBACK'
+          Rails.logger.info postback.payload
+
+          run_postback_payload(postback.payload, postback.sender)
+        end
+
+        ::Facebook::Messenger::Bot.on :message do |message|
+          Rails.logger.info 'MESSAGE'
+          Rails.logger.info message.text
+          Rails.logger.info message.quick_reply
+
+          # Attempt to run a quick reply payload
+          if message.quick_reply
+            run_postback_payload(message.quick_reply, message.sender)
+          # Fall back to fuzzy matching keywords
+          elsif fuzzy_match = FuzzyMatch.new(@routes.keys).find(message.text)
+            @routes[fuzzy_match].deliver(message.sender)
+          # Fallback behavior
+          else
+            @default_chunk.deliver(message.sender)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hg/chunk.rb

@@ -0,0 +1,271 @@
+module Hg
+  module Chunk
+    def self.included(base)
+      base.extend ClassMethods
+      base.prepend Initializer
+      base.id = base.to_s
+      base.deliverables = []
+      base.dynamic = false
+      base.add_to_router
+      base.add_to_chunks
+      base.include_chunks
+    end
+
+    def deliver
+      self.class.show_typing(@recipient)
+
+      Rails.logger.info 'DELIVERABLES'
+      Rails.logger.info self.class.deliverables.inspect
+
+      self.class.deliverables.each do |deliverable|
+        # If another chunk, deliver it
+        if deliverable.is_a? Class
+          deliverable.new(recipient: @recipient, context: @context).deliver
+        # If dynamic, then it needs to be evaluated at delivery time. Create a
+        # `template` with empty `@deliverables`, then evaluate
+        # the dynamic block within it and deliver.
+        elsif deliverable.is_a? Proc
+          template = self.class.dup
+          template.deliverables = []
+
+          template.class_exec(@recipient, @context, &deliverable)
+
+          template.new(recipient: @recipient, context: @context).deliver
+        # Otherwise, it's just a raw message. Deliver it.
+        else
+          Facebook::Messenger::Bot.deliver(deliverable.merge(recipient: @recipient), access_token: ENV['ACCESS_TOKEN'])
+        end
+      end
+    end
+
+    module Initializer
+      def initialize(recipient: nil, context: nil)
+        @recipient = recipient
+        @context = context
+      end
+    end
+
+    module ClassMethods
+      attr_accessor :id
+      attr_accessor :deliverables
+      attr_accessor :label
+      attr_accessor :recipient
+      attr_accessor :context
+      attr_accessor :dynamic
+
+      def bot_class
+        self.to_s.split('::').first.constantize
+      end
+
+      def label(text)
+        @label = text
+      end
+
+      def add_to_router
+        bot_class.routes.merge(@id.to_sym => self)
+      end
+
+      def add_to_chunks
+        bot_class.chunks << self
+      end
+
+      def include_chunks
+        bot_class.class_eval "include #{bot_class.to_s}::Chunks"
+      end
+
+      def dynamic(&block)
+        @dynamic = true
+
+        @deliverables << block
+      end
+
+      def show_typing(recipient)
+        Facebook::Messenger::Bot.deliver({
+          recipient: recipient,
+          sender_action: 'typing_on'
+        }, access_token: ENV['ACCESS_TOKEN'])
+      end
+
+      def keywords(*chunk_keywords)
+        chunk_keywords.each do |keyword|
+          bot_class.routes[keyword] = self
+        end
+      end
+
+      def text(message)
+        @deliverables <<
+          {
+            message: {
+              text: message
+            }
+          }
+      end
+
+      def title(text)
+        @card[:title] = text
+      end
+
+      def subtitle(text)
+        @card[:subtitle] = text
+      end
+
+      def image_url(path)
+        @card[:image_url] = bot_class.instance_variable_get(:@image_url_base_portion) + path
+      end
+
+      def item_url(url)
+        @card[:item_url] = url
+      end
+
+      # Build a button template message.
+      # See https://developers.facebook.com/docs/messenger-platform/send-api-reference/button-template
+      def buttons(&block)
+        @card = {}
+
+        yield
+
+        deliverable = {
+          message: {
+            attachment: {
+              type: 'template',
+              payload: {
+                template_type: 'button'
+              }
+            }
+          }
+        }
+
+        # Move buttons to proper location
+        deliverable[:message][:attachment][:payload][:buttons] = @card.delete(:buttons)
+        deliverable[:message][:attachment][:payload][:text] = @deliverables.pop[:message][:text]
+
+        @deliverables << deliverable
+      end
+
+      def log_in(url)
+        button nil, url: url, type: 'account_link'
+      end
+
+      def button(text, options = {})
+        # TODO: text needs a better name
+        # If the first argument is a chunk, then make this button a link to that chunk
+        if text.is_a? Class
+          klass = text
+          text = text.instance_variable_get(:@label)
+
+          button_content = {
+            title: text,
+            type: 'postback',
+            payload: klass.to_s
+          }
+        else
+          button_content = {
+            title: text
+          }
+        end
+
+        # If a `to` option is present, assume this is a postback link to another chunk.
+        if options[:to]
+          button_content[:type] = 'postback'
+          button_content[:payload] = options[:to].to_s
+        # If a different type of button is specified (e.g. "Log in"), then pass
+        # through the `type` and `url`.
+        elsif options[:type]
+          button_content[:type] = options[:type]
+
+          button_content[:url] = evaluate_option(options[:url])
+        # If a `url` option is present, assume this is a webview link button.
+        elsif options[:url]
+          button_content[:type] = 'web_url'
+
+          button_content[:url] = evaluate_option(options[:url])
+        end
+
+        # Pass through the `webview_height_ratio` option.
+        button_content[:webview_height_ratio] = options[:webview_height_ratio]
+
+        @card[:buttons] = [] unless @card[:buttons]
+
+        @card[:buttons] << button_content
+      end
+
+      def quick_replies(*classes)
+        classes.each do |klass|
+          quick_reply klass.instance_variable_get(:@label), to: klass
+        end
+      end
+
+      def quick_reply(title, options = {})
+        quick_reply_content = {
+          content_type: 'text',
+          title: title,
+          payload: options[:to].to_s
+        }
+
+        unless @deliverables.last[:message][:quick_replies]
+          @deliverables.last[:message][:quick_replies] = []
+        end
+
+        @deliverables.last[:message][:quick_replies] << quick_reply_content
+      end
+
+      def card(&block)
+        @card = {}
+        yield
+        @gallery[:cards] << @card
+      end
+
+      def gallery(&block)
+        @gallery = {
+          cards: [],
+          message: {
+            attachment: {
+              type: 'template',
+              payload: {
+                template_type: 'generic',
+                elements: []
+              }
+            }
+          }
+        }
+
+        yield
+
+        @gallery[:message][:attachment][:payload][:elements] = @gallery.delete(:cards)
+
+        @deliverables << @gallery
+      end
+
+      def image(path)
+        @deliverables << {
+          message: {
+            attachment: {
+              type: 'image',
+              payload: {
+                url: bot_class.instance_variable_get(:@image_url_base_portion) + path
+              }
+            }
+          }
+        }
+      end
+
+      def chunk(chunk_class)
+        @deliverables << chunk_class
+      end
+
+      private
+
+      # Take an option, and either call it (if a lambda) or return its value.
+      #
+      # @param [lambda, String] option Either a lambda to be evaluated, or a value
+      # @return [String] The option value
+      def evaluate_option(option)
+        if option.respond_to?(:call)
+          option.call(@context)
+        else
+          option
+        end
+      end
+    end
+  end
+end

data/lib/hg/version.rb

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

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: hg
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Buck
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: facebook-messenger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: fuzzy_match
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: 
+email:
+- matt@voxable.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hg.gemspec
+- lib/hg.rb
+- lib/hg/bot.rb
+- lib/hg/chunk.rb
+- lib/hg/version.rb
+homepage: https://rubygems.org/hg
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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 library for building Facebook Messenger bots.
+test_files: []