rubotnik 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 722a334f07d4832bd7b5c997ec9a466d167a1793
-  data.tar.gz: e05b518c7dffcbcf98e539f36491322aba63d827
+SHA256:
+  metadata.gz: 33af86f4563629621c9a60e41d8ed6e18b57a7bea3049771f1dc4a7d231f09af
+  data.tar.gz: f8231e56a6526c0f371360c5824a148db4c302e5c1b58436598ad4fb0d554b83
 SHA512:
-  metadata.gz: bd63042e7060157641084648f576ec3d058dc5b0d911575aae11ba0efc960d48635b7e630dfb3ade7cad2d72ad602fa47668d44b9ef4dff9ccf15dc1739001dc
-  data.tar.gz: 67ddf59877b68e3bffe51c7b5f51e69a33af8d7f2362b4e5cbf97449e3c518e609cf8937900be0015965fa500475a862f0245df14b54e0197c290254ad278973
+  metadata.gz: e5b74060181a95947438daca6a069e45d31f29bdda0e352ca51a1aa47b6003a4f4948bb7b5014511cc0fa50bbaa8c80a4a03458a0ef176f7f09c14bb1a01aa44
+  data.tar.gz: d86d3550536e110c6aa76c1fea981860c002b7b7e183a55e1dd68cd2c2872fd882518b81e98b78df2388af5038a67cc678dd3e5c5e173ef30aa508cdc3ca269f

data/README.md

@@ -88,7 +88,7 @@ A "command" is just a plain Ruby _method_ inside the `Commands` module that has
 ```ruby
 
 # Will match any of the words and their variations
-bind "hello", "hi", "bonjour", "привет" to: :my_method_for_greeting
+bind "hello", "hi", "bonjour", "привет", to: :my_method_for_greeting
 
 # Will match only if all words are present (ignoring order)
 bind "what", "time", "is", all: true, to: :tell_time
@@ -370,6 +370,21 @@ image = UI::ImageAttachment.new(img_url)
 show(image)
 ```
 
+### Open Graph Attachment
+
+The Open Graph template allows you to send a structured message with an Open Graph URL, plus an optional button. Currently, only sharing songs is supported. The song will appear in a bubble that allows the message recipient to see album art and preview the song.
+
+
+```ruby
+song_url = 'https://open.spotify.com/track/5qqabIl2vWzo9ApSC317sa'
+open_graph_element = UI::FBOpenGraphTemplate.new(song_url, [{title: 'Button', url: 'https://github.com/progapandist/rubotnik', type: 'web_url' }])
+show(open_graph_element)
+```
+
+here's the result:
+
+![opengraph](./docs/open_graph.png)
+
 ## Other events
 
 Events other then `message` and `postback` are currently not supported.

data/lib/rubotnik/commands.rb

@@ -1,3 +1,3 @@
 module Commands
   # The contents of this module will be overridden by Commands inside host app
-end;
+end

data/lib/rubotnik/message_dispatch.rb

@@ -38,6 +38,8 @@ module Rubotnik
     end
 
     def bind(*regex_strings, all: false, to: nil, reply_with: {})
+      return if @matched
+
       regexps = regex_strings.map { |rs| /\b#{rs}/i }
       proceed = regexps.any? { |regex| @message.text =~ regex }
       proceed = regexps.all? { |regex| @message.text =~ regex } if all

data/lib/rubotnik/user_store.rb

@@ -4,7 +4,7 @@ require_relative 'user'
 class UserStore
   include Singleton
   attr_reader :users
-  
+
   def initialize
     @users = []
   end

data/lib/rubotnik/version.rb

@@ -1,3 +1,3 @@
 module Rubotnik
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/rubotnik.rb

@@ -6,8 +6,11 @@ require 'rubotnik/user'
 require 'rubotnik/cli'
 require 'rubotnik/generator'
 require 'rubotnik/autoloader'
+require 'ui/base_ui_element'
+require 'ui/common/has_buttons'
 require 'ui/fb_button_template'
 require 'ui/fb_carousel'
+require 'ui/fb_open_graph_template'
 require 'ui/image_attachment'
 require 'ui/quick_replies'
 require 'sinatra'

data/lib/ui/base_ui_element.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/MethodLength
+
+module UI
+  class BaseUiElement
+    # Sends the valid JSON to Messenger API
+    def send(user)
+      formed = build(user)
+      Bot.deliver(formed, access_token: ENV['ACCESS_TOKEN'])
+    end
+
+    # Use this method to return a valid hash and save it for later
+    def build(user)
+      @template[:recipient][:id] = user.id
+      @template
+    end
+  end
+end

data/lib/ui/common/has_buttons.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module UI
+  module Common
+    module HasButtons
+      private
+
+      def parse_buttons(buttons)
+        return [] if buttons.nil? || buttons.empty?
+        buttons.map do |button|
+          button[:type] = button[:type].to_s
+          button
+        end
+      end
+    end
+  end
+end

data/lib/ui/fb_button_template.rb

@@ -3,7 +3,7 @@
 module UI
   ########################### BUTTON TEMPLATE #############################
   # https://developers.facebook.com/docs/messenger-platform/send-api-reference/button-template
-  class FBButtonTemplate
+  class FBButtonTemplate < UI::BaseUiElement
     def initialize(text, buttons)
       @template = {
         recipient: {
@@ -21,27 +21,5 @@ module UI
         }
       }
     end
-
-    # Sends the valid JSON to Messenger API
-    def send(user)
-      formed = build(user)
-      Bot.deliver(formed, access_token: ENV['ACCESS_TOKEN'])
-    end
-
-    # Use this method to return a valid hash and save it for later
-    def build(user)
-      @template[:recipient][:id] = user.id
-      @template
-    end
-
-    private
-
-    def parse_buttons(buttons)
-      return [] if buttons.nil? || buttons.empty?
-      buttons.map do |button|
-        button[:type] = button[:type].to_s
-        button
-      end
-    end
   end
 end

data/lib/ui/fb_carousel.rb

@@ -2,7 +2,9 @@
 module UI
   ################## GENERIC TEMPLATE (aka CAROUSEL) #######################
   # https://developers.facebook.com/docs/messenger-platform/send-api-reference/generic-template
-  class FBCarousel
+  class FBCarousel < UI::BaseUiElement
+    include Common::HasButtons
+
     def initialize(elements)
       @template = {
         recipient: { id: nil },
@@ -19,18 +21,6 @@ module UI
       }
     end
 
-    # Sends the valid JSON to Messenger API
-    def send(user)
-      template = build(user)
-      Bot.deliver(template, access_token: ENV['ACCESS_TOKEN'])
-    end
-
-    # Use this method to return a valid hash and save it for later
-    def build(user)
-      @template[:recipient][:id] = user.id
-      @template
-    end
-
     # set image aspect ratio to 'square'
     def square_images
       @template[:message][:attachment][:payload][:image_aspect_ratio] = 'square'
@@ -53,13 +43,5 @@ module UI
         elt
       end
     end
-
-    def parse_buttons(buttons)
-      return [] if buttons.nil? || buttons.empty?
-      buttons.map do |button|
-        button[:type] = button[:type].to_s
-        button
-      end
-    end
   end
 end

data/lib/ui/fb_open_graph_template.rb

@@ -0,0 +1,42 @@
+# rubocop:disable Metrics/MethodLength
+
+module UI
+  ########################### OPEN GRAPH TEMPLATE #############################
+  # https://developers.facebook.com/docs/messenger-platform/send-messages/template/open-graph
+  class FBOpenGraphTemplate < UI::BaseUiElement
+    include UI::Common::HasButtons
+
+    def initialize(url, buttons = [])
+      @url = url
+      @buttons = buttons
+
+      @template = {
+        recipient: {
+          id: nil
+        },
+        message: {
+          attachment: {
+            type: 'template',
+            payload: {
+              template_type: 'open_graph',
+              elements: elements
+            }
+          }
+        }
+      }
+    end
+
+    private
+
+    attr_reader :url, :buttons
+
+    def elements
+      res = { url: url }
+
+      buttons_payload = parse_buttons(buttons)
+      res[:buttons] = buttons_payload if buttons_payload.any?
+
+      [res]
+    end
+  end
+end

data/lib/ui/image_attachment.rb

@@ -1,7 +1,7 @@
 # rubocop:disable Metrics/MethodLength
 module UI
   # https://developers.facebook.com/docs/messenger-platform/send-api-reference/image-attachment
-  class ImageAttachment
+  class ImageAttachment < UI::BaseUiElement
     def initialize(url)
       @template = {
         recipient: {
@@ -17,15 +17,5 @@ module UI
         }
       }
     end
-
-    def send(user)
-      formed = build(user)
-      Bot.deliver(formed, access_token: ENV['ACCESS_TOKEN'])
-    end
-
-    def build(user)
-      @template[:recipient][:id] = user.id
-      @template
-    end
   end
 end

data/rubotnik.gemspec

@@ -30,4 +30,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "factory_bot", "~> 4.0"
+  spec.add_development_dependency "pry"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubotnik
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Andy Barnov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-15 00:00:00.000000000 Z
+date: 2018-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: facebook-messenger
@@ -150,6 +150,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
 description: 
 email:
 - andy.barnov@gmail.com
@@ -169,6 +197,7 @@ files:
 - bin/setup
 - docs/button_template.png
 - docs/carousel.png
+- docs/open_graph.png
 - docs/quick_replies.PNG
 - exe/rubotnik
 - lib/rubotnik.rb
@@ -182,8 +211,11 @@ files:
 - lib/rubotnik/user.rb
 - lib/rubotnik/user_store.rb
 - lib/rubotnik/version.rb
+- lib/ui/base_ui_element.rb
+- lib/ui/common/has_buttons.rb
 - lib/ui/fb_button_template.rb
 - lib/ui/fb_carousel.rb
+- lib/ui/fb_open_graph_template.rb
 - lib/ui/image_attachment.rb
 - lib/ui/quick_replies.rb
 - rubotnik.gemspec
@@ -218,7 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby "bot-end" micro-framework for Facebook Messenger