stealth-smooch 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6e3657bee135d475584a394c1a2248f356d0e9173a49f6e941f1b162b92b2069
+  data.tar.gz: d19f031c8632ae4b3db4bfc9797f303e084b7bc7fe6d5bb7847d945102409180
+SHA512:
+  metadata.gz: fef040a938acf8c730b36351812fbcbbc799406ca81e79a2f3e3360ff641f00fefb37004d8ef3f3ecb2187ed116cdb1f8b2a6a6da064a166d11516961ab42193
+  data.tar.gz: 61f7ebbb9e1eb16de0fa5234bafea9111cee6cc76f19efe12711d0c380f8c19c443001d52900aa8b26f9f1176e6c57040bfd269f3a40c684f19299a363fdb67c

data/.gitignore

@@ -0,0 +1,12 @@
+# please add general patterns to your global ignore list
+# see https://github.com/github/gitignore#readme
+.DS_STORE
+*.swp
+*.rbc
+*.sass-cache
+/pkg
+/doc/api
+/coverage
+.yardoc
+doc/
+*.gem

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,133 @@
+PATH
+  remote: .
+  specs:
+    stealth-smooch (0.9.0)
+      jwt (~> 2.1)
+      smooch-api (~> 4.0)
+      stealth (< 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.2.1)
+      actionview (= 5.2.1)
+      activesupport (= 5.2.1)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.1)
+      activesupport (= 5.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
+      arel (>= 9.0)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.1.3)
+    connection_pool (2.2.2)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    erubi (1.7.1)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.25)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    json (1.8.6)
+    jwt (2.1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.2)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    multi_json (1.13.1)
+    mustermann (1.0.3)
+    nokogiri (1.8.5)
+      mini_portile2 (~> 2.3.0)
+    puma (3.12.0)
+    rack (2.0.6)
+    rack-protection (2.0.4)
+      rack
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.1)
+      actionpack (= 5.2.1)
+      activesupport (= 5.2.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (12.3.1)
+    redis (4.0.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    sidekiq (5.2.3)
+      connection_pool (~> 2.2, >= 2.2.2)
+      rack-protection (>= 1.5.0)
+      redis (>= 3.3.5, < 5)
+    sinatra (2.0.4)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.4)
+      tilt (~> 2.0)
+    smooch-api (4.0)
+      json (~> 1.8, >= 1.8.3)
+      typhoeus (~> 1.0, >= 1.0.1)
+    stealth (1.0.4)
+      activerecord (~> 5.2)
+      activesupport (~> 5.2)
+      multi_json (~> 1.12)
+      puma (~> 3.10)
+      railties (~> 5.2)
+      sidekiq (~> 5.0)
+      sinatra (~> 2.0)
+      thor (~> 0.20)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tilt (2.0.8)
+    typhoeus (1.3.1)
+      ethon (>= 0.9.0)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack-test (~> 1.1)
+  rspec (~> 3.6)
+  rspec_junit_formatter (~> 0.3)
+  stealth-smooch!
+
+BUNDLED WITH
+   1.16.6

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2018 Mauricio Gomes, Black Ops Bureau
+
+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,335 @@
+# Stealth Smooch
+
+This integration adds support for [Smooch](https://smooch.io) powered bots within [Stealth](https://github.com/hellostealth/stealth). It can be used as a drop-in replacement for `stealth-facebook` with the exception of some specialized quick reply buttons (such as Email & Phone).
+
+[![Gem Version](https://badge.fury.io/rb/stealth-smooch.svg)](https://badge.fury.io/rb/stealth-smooch)
+
+## Create Your Smooch App
+
+Via the Smooch interface, create a new Smooch app for your Stealth bot. Once you do, you'll be given your `SMOOCH_APP_ID`.
+
+Follow the instructions on the [smooch-api Ruby](https://github.com/smooch/smooch-ruby) page to generate your secret keys. This will get you your
+`SMOOCH_KEY_ID` and `SMOOCH_SECRET`.
+
+The last thing you will need is the `SMOOCH_JWT_TOKEN` which can be generated using this gem. After you have set the above creds to your `services.yml` file, from your bot's console, run:
+
+```ruby
+Stealth::Services::Smooch::Client.generate_jwt_token
+```
+
+It will output the JWT token based on the `app_id`, `key_id`, and `secret` from your `services.yml` file.
+
+## Configure the Integration
+
+```yaml
+default: &default
+  smooch:
+    app_id: <%= ENV['SMOOCH_APP_ID'] %>
+    key_id: <%= ENV['SMOOCH_KEY_ID'] %>
+    secret: <%= ENV['SMOOCH_SECRET'] %>
+    jwt_token: <%= ENV['SMOOCH_JWT_TOKEN'] %>
+    setup:
+      persistent_menu:
+        - type: 'url'
+          url: 'https://mywebsite.com'
+          text: 'About Us'
+        - type: 'payload'
+          payload: 'contact_support'
+          text: 'Contact Support'
+
+production:
+  <<: *default
+
+development:
+  <<: *default
+
+test:
+  <<: *default
+```
+
+Additionally, you will need to create an initializer called `smooch.rb` in `config/initializers`:
+
+```ruby
+  SmoochApi.configure do |config|
+  config.api_key['Authorization'] = Stealth.config.smooch.jwt_token
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+```
+
+As with all Stealth integrations, integrations can be specified by environment.
+
+These are the supported setup options:
+
+### persistent_menu
+
+The persistent menu is not supported by all integrations. For a complete list, please check out the [Smooch Pesistent Menu Docs](https://docs.smooch.io/rest/#persistent-menus).
+
+Setting the persistent menu is identical to creating buttons in text replies. Please see those docs for more info.
+
+### Webhooks
+
+In order for your bot to receive messages from the Smooch app, we'll need to register our webhooks.
+
+Set `SMOOCH_ENDPOINT` to the endpoint that will be receiving the hooks. It's configured as an ENV variable so you can specify different endpoints for each of your environments.
+
+After you have set `SMOOCH_ENDPOINT`, running setup below will register your webhooks.
+
+### Running Setup
+
+This will set the persistent menu (if available) and register your webhooks.
+
+```
+stealth setup smooch
+```
+
+## Replies
+
+Here are the supported replies for the Smooch integration:
+
+### text
+
+These are standard text replies.
+
+```yaml
+- reply_type: text
+  text: Hello World!
+```
+
+Text replies can also include suggestions, which will be rendered as quick replies:
+
+```yaml
+- reply_type: text
+  text: What is your favorite color?
+  suggestions:
+    - text: Blue
+    - text: Red
+```
+
+Although not as common, text replies can also include buttons:
+
+```yaml
+- reply_type: text
+  text: Would you like to give us a call?
+  buttons:
+    - type: payload
+      text: 'Yes'
+      payload: 'Yes'
+    - type: payload
+      text: 'No'
+      payload: 'No'
+```
+
+### suggestions
+
+Though suggestions are not a reply type on their own, they are frequently used to optimize the accuracy and speed of your bot. In the `text` reply type above, we used simple labels for our suggestions. Smooch supports a few special types of quick replies, however.
+
+#### Location
+
+You can ask a user for their location:
+
+```yaml
+- reply_type: text
+  text: "Where are you located?"
+  suggestions:
+    - type: location
+```
+
+If the user chooses to share their location, the `lat` and `lng` will be available via `current_message.location`:
+
+```ruby
+current_message.location[:lat]
+current_message.location[:lng]
+```
+
+#### Images
+
+While images are not a special quick reply type, you can include and `image_url` for a quick reply as way of adding an icon to a quick reply button:
+
+```yaml
+- reply_type: text
+  text: "What is your favorite color?"
+  suggestions:
+    - text: Red
+      image_url: "http://example.com/img/red.png"
+    - text: Blue
+      image_url: "http://example.com/img/blue.png"
+```
+
+More info [here](https://docs.smooch.io/rest/#reply).
+
+### buttons
+
+As with `suggestions`, `buttons` are not a reply type of their own but are used to make your bot more efficient. Smooch supports a few button types and these are the ones currently supported by this integration:
+
+#### payload
+
+This is the most common button type. When a user presses a button that is `payload` type, that payload string will be sent to your bot. For example:
+
+```yaml
+- reply_type: text
+  text: Please press the button below
+  buttons:
+    - type: payload
+      text: 'Press me!'
+      payload: 'button pressed'
+
+```
+
+When a user presses the button labeled "Press me!", the payload `button pressed` will be accessible in bot via `current_message.payload`.
+
+#### url
+
+The `url` button is useful when sharing a link to a website. By default, it will open up within Facebook Messenger.
+
+```yaml
+- reply_type: text
+  text: Find out more via our website
+  buttons:
+    - type: url
+      text: 'Visit website'
+      url: 'https://example.org'
+
+```
+
+### Delay
+
+Delays are a very important part of bot design. They introduce a pause between text replies to give the user a chance to read each reply. With this integration, in addition to introducing a delay, we will also send a typing indicator to the user to indicate another reply is forthcoming. To insert a delay in your bot:
+
+```yaml
+- reply_type: delay
+  duration: 2
+```
+
+This will add a `2` second delay (with typing indicator). The `duration` can be specified as any floating point value, in seconds.
+
+### Cards
+
+Smooch distinguishes between a single card and a carousel of cards. This integration does not, however. You can send a single card the same way you would send 10 cards (the current maximum).
+
+```yaml
+- reply_type: cards
+  elements:
+    - title: My App
+      subtitle: Download our app below or visit our website for more info.
+      image_url: "https://my-app.com/app-image.png"
+      buttons:
+        - type: url
+          url: "https://my-app.com"
+          text: 'View'
+          webview_height: 'tall'
+        - type: url
+          url: "https://itunes.apple.com/us/app/my-app"
+          text: 'Download iOS App'
+```
+
+The above is a single card with two buttons. If you want to include more cards, though, you would just need to specify another listing under the `elements` heading.
+
+More info about Smooch cards [here](https://docs.smooch.io/rest/#carousel).
+
+### List
+
+A Smooch list is useful for displaying things like a news feed. You can find more info about Smooch lists [here](https://docs.smooch.io/rest/#list).
+
+To generate a list:
+
+```yaml
+- reply_type: list
+  buttons:
+    - type: payload
+      text: View More
+      payload: view_more
+  elements:
+    - title: Your Daily News Update
+      subtitle: The following stories have been curated just for you.
+      image_url: "https://picsum.photos/320/240"
+      buttons:
+        - type: url
+          url: "https://news-articles.com/199"
+          text: 'View'
+    - title: Breakthrough in AI
+      subtitle: Major breakthrough in the AI space.
+      image_url: "https://picsum.photos/320/320"
+      buttons:
+        - type: url
+          url: "https://news-articles.com/201"
+          text: 'View'
+```
+
+The list itself supports having a single button that will be rendered on the bottom of the list. Each individual list item supports having one button as well. List items should have between 2-4 elements.
+
+More info about Smooch lists [here](https://docs.smooch.io/rest/#list).
+
+### Images
+
+To send an image:
+
+```yaml
+- reply_type: image
+  image_url: 'https://example.org/image.png'
+```
+
+The `image_url` should be set to URL where the image has been uploaded.
+
+Image replies support buttons and suggestions like text replies.
+
+### Files
+
+To send a file:
+
+```yaml
+- reply_type: file
+  file_url: 'https://example.org/some.pdf'
+```
+
+The `file_url` should be set to URL where the file has been uploaded.
+
+File replies support buttons and suggestions like text replies.
+
+### Video
+
+To send a video:
+
+```yaml
+- reply_type: video
+  video_url: 'https://example.org/cool_video.mp4'
+```
+
+The `video_url` should be set to URL where the video has been uploaded.
+
+Video replies support buttons and suggestions like text replies.
+
+### Audio
+
+To send an audio clip:
+
+```yaml
+- reply_type: audio
+  audio_url: 'https://example.org/podcast.mp3'
+```
+
+The `audio_url` should be set to URL where the video has been uploaded.
+
+Audio replies support buttons and suggestions like text replies.
+
+## Development
+
+When adding features to this library, you might find it helpful to get a full printout of the HTTP requests and responses from Smooch.
+
+In order to configure your bot to show the debug output, modify your `smooch.rb` initializer like so:
+
+```ruby
+class SmoochLogger
+
+  def self.debug(msg)
+    Stealth::Logger.l(topic: 'smooch', message: msg)
+  end
+
+end
+
+SmoochApi.configure do |config|
+  config.logger = SmoochLogger
+  config.debugging = true
+  config.api_key['Authorization'] = Stealth.config.smooch.jwt_token
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+```

data/VERSION

@@ -0,0 +1 @@
+0.9.0

data/lib/stealth-smooch.rb

@@ -0,0 +1,2 @@
+require 'smooch-api'
+require 'stealth/smooch'

data/lib/stealth/services/smooch/client.rb

@@ -0,0 +1,82 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+require 'stealth/services/smooch/message_handler'
+require 'stealth/services/smooch/reply_handler'
+require 'stealth/services/smooch/setup'
+
+module Stealth
+  module Services
+    module Smooch
+
+      class Client < Stealth::Services::BaseClient
+
+        attr_reader :reply
+
+        def initialize(reply:)
+          @reply = reply
+          @smooch = SmoochApi::ConversationApi.new
+        end
+
+        def transmit
+          begin
+            response = @smooch.send(
+              reply[:reply_type],
+              Stealth.config.smooch.app_id,
+              reply[:recipient_id],
+              reply[:message]
+            )
+          rescue SmoochApi::ApiError => e
+            msg = Stealth::Logger.colorize('[Error]', color: :red) + " #{e.code}: #{e.response_body}"
+            Stealth::Logger.l(topic: 'smooch', message: msg)
+            raise Stealth::Errors::ServiceError
+          end
+
+          if response.present?
+            Stealth::Logger.l(topic: "smooch", message: "Message #{response.message._id} successfully sent.")
+          end
+        end
+
+        def self.generate_jwt_token
+          payload = { scope: 'app' }
+          jwtHeader = { kid: Stealth.config.smooch.key_id }
+          token = JWT.encode(payload, Stealth.config.smooch.secret, 'HS256', jwtHeader)
+
+          puts "#{Stealth::Logger.colorize('[JWT Token]', color: :green)} Your Smooch token is below. Please set the value `jwt_token` to the token in services.yml."
+          puts token
+        end
+
+        def self.register_webhooks(endpoint:)
+          smooch_webhook_api = SmoochApi::WebhookApi.new
+          webhook_create_body = SmoochApi::WebhookCreate.new(
+            target: endpoint,
+            triggers: ['message:appUser', 'postback']
+          )
+
+          response = smooch_webhook_api.create_webhook(
+            Stealth.config.smooch.app_id,
+            webhook_create_body
+          )
+
+          puts "#{Stealth::Logger.colorize('[Web Hooks]', color: :green)} Your Smooch webhooks have been registered to: #{endpoint}"
+        end
+
+        def self.set_persistent_menu(menu)
+          smooch_api = SmoochApi::IntegrationApi.new
+          response = smooch_api.list_integrations(Stealth.config.smooch.app_id)
+          response.integrations.each do |integration|
+            begin
+              smooch_api.update_integration_menu(Stealth.config.smooch.app_id, integration._id, menu)
+              puts "#{Stealth::Logger.colorize('[Persistent Menu]', color: :green)} set for #{integration.type} integration."
+            rescue SmoochApi::ApiError
+              # Not all integrations support the persistent menu
+              puts "#{Stealth::Logger.colorize('[Persistent Menu]', color: :red)} Skipping #{integration.type} integration. Persistent Menu is not supported."
+              next
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/stealth/services/smooch/events/message_event.rb

@@ -0,0 +1,56 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+module Stealth
+  module Services
+    module Smooch
+
+      class MessageEvent
+
+        attr_reader :service_message, :params
+
+        def initialize(service_message:, params:)
+          @service_message = service_message
+          @params = params
+        end
+
+        def process
+          fetch_message
+          fetch_location
+          fetch_attachments
+        end
+
+        private
+
+          def fetch_message
+            service_message.message = params['text']
+          end
+
+          def fetch_location
+            if params['type'] == 'location'
+              service_message.location = {
+                lat: params['coordinates']['lat'],
+                lng: params['coordinates']['lng']
+              }
+            end
+          end
+
+          def fetch_attachments
+            if params['type'] == 'image'
+              service_message.attachments << {
+                type: 'image',
+                url: params['mediaUrl']
+              }
+            elsif params['type'] == 'file'
+              service_message.attachments << {
+                type: params['mediaType'],
+                url: params['mediaUrl']
+              }
+            end
+          end
+
+      end
+
+    end
+  end
+end

data/lib/stealth/services/smooch/events/postback_event.rb

@@ -0,0 +1,31 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+module Stealth
+  module Services
+    module Smooch
+
+      class PostbackEvent
+
+        attr_reader :service_message, :params
+
+        def initialize(service_message:, params:)
+          @service_message = service_message
+          @params = params
+        end
+
+        def process
+          fetch_payload
+        end
+
+        private
+
+          def fetch_payload
+            service_message.payload = params['action']['payload']
+          end
+
+      end
+
+    end
+  end
+end

data/lib/stealth/services/smooch/message_handler.rb

@@ -0,0 +1,71 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+require 'stealth/services/smooch/events/message_event'
+require 'stealth/services/smooch/events/postback_event'
+
+module Stealth
+  module Services
+    module Smooch
+
+      class MessageHandler < Stealth::Services::BaseMessageHandler
+
+        attr_reader :service_message, :params, :headers,
+                    :smooch_response, :smooch_message
+
+        def initialize(params:, headers:)
+          @params = params
+          @headers = headers
+        end
+
+        def coordinate
+          # Queue the request processing so we can respond quickly to Smooch
+          # and also keep track of this message
+          Stealth::Services::HandleMessageJob.perform_async('smooch', params, {})
+
+          # Relay our acceptance
+          [200, 'OK']
+        end
+
+        def process
+          @service_message = ServiceMessage.new(service: 'smooch')
+          @smooch_response = params
+          @smooch_message = @smooch_response['messages'].first
+          service_message.sender_id = get_sender_id
+          service_message.timestamp = get_timestamp
+
+          process_smooch_event
+
+          service_message
+        end
+
+        private
+
+          def get_sender_id
+            smooch_response['appUser']['_id']
+          end
+
+          def get_timestamp
+            Time.at(smooch_message['received']).to_datetime
+          end
+
+          def process_smooch_event
+            if smooch_response['trigger'] == 'message:appUser'
+              message_event = Stealth::Services::Smooch::MessageEvent.new(
+                service_message: service_message,
+                params: smooch_message
+              )
+            elsif smooch_response['trigger'] == 'postback'
+              message_event = Stealth::Services::Smooch::PostbackEvent.new(
+                service_message: service_message,
+                params: smooch_response['postbacks'].first
+              )
+            end
+
+            message_event.process
+          end
+      end
+
+    end
+  end
+end

data/lib/stealth/services/smooch/reply_handler.rb

@@ -0,0 +1,319 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+module Stealth
+  module Services
+    module Smooch
+
+      class ReplyHandler < Stealth::Services::BaseReplyHandler
+
+        attr_reader :recipient_id, :reply
+
+        def initialize(recipient_id: nil, reply: nil)
+          @recipient_id = recipient_id
+          @reply = reply
+        end
+
+        def text
+          message = SmoochApi::MessagePost.new(
+            role: 'appMaker',
+            type: 'text',
+            text: reply['text']
+          )
+
+          if reply['suggestions'].present?
+            smooch_suggestions = generate_suggestions(suggestions: reply['suggestions'])
+            message.actions = smooch_suggestions
+          end
+
+          if reply['buttons'].present?
+            smooch_buttons = generate_buttons(buttons: reply['buttons'])
+            message.actions = smooch_buttons
+          end
+
+          message_template(action: 'post_message', message: message)
+        end
+
+        def image
+          check_if_arguments_are_valid!(
+            suggestions: reply['suggestions'],
+            buttons: reply['buttons']
+          )
+
+          message = SmoochApi::MessagePost.new(
+            role: 'appMaker',
+            type: 'image',
+            mediaUrl: reply['image_url']
+          )
+
+          if reply['suggestions'].present?
+            smooch_suggestions = generate_suggestions(suggestions: reply['suggestions'])
+            message.actions = smooch_suggestions
+          end
+
+          message_template(action: 'post_message', message: message)
+        end
+
+        def audio
+          check_if_arguments_are_valid!(
+            suggestions: reply['suggestions'],
+            buttons: reply['buttons']
+          )
+
+          message = SmoochApi::MessagePost.new(
+            role: 'appMaker',
+            type: 'file',
+            text: reply['text'],
+            mediaUrl: reply['audio_url']
+          )
+
+          if reply['suggestions'].present?
+            smooch_suggestions = generate_suggestions(suggestions: reply['suggestions'])
+            message.actions = smooch_suggestions
+          end
+
+          message_template(action: 'post_message', message: message)
+        end
+
+        def video
+          check_if_arguments_are_valid!(
+            suggestions: reply['suggestions'],
+            buttons: reply['buttons']
+          )
+
+          message = SmoochApi::MessagePost.new(
+            role: 'appMaker',
+            type: 'file',
+            text: reply['text'],
+            mediaUrl: reply['video_url']
+          )
+
+          if reply['suggestions'].present?
+            smooch_suggestions = generate_suggestions(suggestions: reply['suggestions'])
+            message.actions = smooch_suggestions
+          end
+
+          message_template(action: 'post_message', message: message)
+        end
+
+        def file
+          check_if_arguments_are_valid!(
+            suggestions: reply['suggestions'],
+            buttons: reply['buttons']
+          )
+
+          message = SmoochApi::MessagePost.new(
+            role: 'appMaker',
+            type: 'file',
+            text: reply['text'],
+            mediaUrl: reply['file_url']
+          )
+
+          if reply['suggestions'].present?
+            smooch_suggestions = generate_suggestions(suggestions: reply['suggestions'])
+            message.actions = smooch_suggestions
+          end
+
+          message_template(action: 'post_message', message: message)
+        end
+
+        def cards
+          message = SmoochApi::MessagePost.new(
+            role: 'appMaker',
+            type: 'carousel'
+          )
+
+          smooch_items = generate_card_items(elements: reply["elements"])
+          message.items = smooch_items
+
+          message_template(action: 'post_message', message: message)
+        end
+
+        def list
+          message = SmoochApi::MessagePost.new(
+            role: 'appMaker',
+            type: 'list'
+          )
+
+          smooch_items = generate_list_items(elements: reply["elements"])
+          message.items = smooch_items
+
+          if reply['buttons'].present?
+            if reply["buttons"].size > 1
+              raise(ArgumentError, "Smooch lists support a single button attached to the list itsef.")
+            end
+
+            smooch_buttons = generate_buttons(buttons: reply['buttons'])
+            message.actions = smooch_buttons
+          end
+
+          message_template(action: 'post_message', message: message)
+        end
+
+        def enable_typing_indicator
+          message = SmoochApi::TypingActivityTrigger.new(
+            role: 'appMaker',
+            type: 'typing:start'
+          )
+
+          message_template(action: 'trigger_typing_activity', message: message)
+        end
+
+        def disable_typing_indicator
+          message = SmoochApi::TypingActivityTrigger.new(
+            role: 'appMaker',
+            type: 'typing:stop'
+          )
+
+          message_template(action: 'trigger_typing_activity', message: message)
+        end
+
+        def delay
+          enable_typing_indicator
+        end
+
+        def persistent_menu
+          smooch_menu = SmoochApi::Menu.new
+
+          smooch_menu_items = generate_buttons(buttons: Stealth.config.smooch.setup.persistent_menu)
+          smooch_menu.items = smooch_menu_items
+
+          smooch_menu
+        end
+
+        private
+
+          def message_template(action:, message:)
+            {
+              recipient_id: recipient_id,
+              reply_type: action,
+              message: message
+            }
+          end
+
+          def generate_card_items(elements:)
+            if elements.size > 10
+              raise(ArgumentError, "Smooch cards can have at most 10 cards.")
+            end
+
+            smooch_items = elements.collect do |element|
+              smooch_item = item_template(element_type: 'card', element: element)
+            end
+
+            smooch_items
+          end
+
+          def generate_list_items(elements:)
+            if elements.size < 2 || elements.size > 4
+              raise(ArgumentError, "Smooch lists must have 2-4 elements.")
+            end
+
+            smooch_items = elements.collect do |element|
+              smooch_item = item_template(element_type: 'list', element: element)
+            end
+
+            smooch_items
+          end
+
+          def item_template(element_type:, element:)
+            unless element["title"].present?
+              raise(ArgumentError, "Smooch card and list elements must have a 'title' attribute.")
+            end
+
+            smooch_item = SmoochApi::MessageItem.new
+
+            smooch_item.title = element['title']
+
+            if element["subtitle"].present?
+              smooch_item.description = element["subtitle"]
+            end
+
+            if element["image_url"].present?
+              smooch_item.media_url = element["image_url"]
+            end
+
+            if element["buttons"].present?
+              if element_type == 'card' && element["buttons"].size > 3
+                raise(ArgumentError, "Smooch card elements only support 3 buttons.")
+              end
+
+              if element_type == 'list' && element["buttons"].size > 1
+                raise(ArgumentError, "Smooch list elements only support 1 button.")
+              end
+
+              smooch_buttons = generate_buttons(buttons: element['buttons'])
+              smooch_item.actions = smooch_buttons
+            end
+
+            smooch_item
+          end
+
+          def generate_suggestions(suggestions:)
+            quick_replies = suggestions.collect do |suggestion|
+              quick_reply = SmoochApi::Action.new(type: 'reply')
+
+              case suggestion["type"]
+              when 'location'
+                quick_reply.type = 'locationRequest'
+                quick_reply.text = suggestion["text"]
+              when 'phone'
+                quick_reply.text = suggestion["text"]
+              when 'email'
+                quick_reply.text = suggestion["text"]
+              else
+                quick_reply.text = suggestion["text"]
+
+                if suggestion["payload"].present?
+                  quick_reply.payload = suggestion["payload"]
+                else
+                  quick_reply.payload = suggestion["text"]
+                end
+
+                if suggestion["image_url"].present?
+                  quick_reply.icon_url = suggestion["image_url"]
+                end
+              end
+
+              quick_reply
+            end
+
+            quick_replies
+          end
+
+          def generate_buttons(buttons:)
+            smooch_buttons = buttons.collect do |button|
+              case button['type']
+              when 'url'
+                smooch_button = SmoochApi::Action.new(type: 'webview')
+                smooch_button.uri = smooch_button.fallback = button["url"]
+                smooch_button.text = smooch_button.fallback = button["text"]
+
+                if button["webview_height"].present?
+                  smooch_button.size = button["webview_height"]
+                end
+
+              when 'payload'
+                smooch_button = SmoochApi::Action.new(type: 'postback')
+                smooch_button.payload = button["payload"]
+                smooch_button.text = button["text"]
+
+              else
+                raise(Stealth::Errors::ServiceImpaired, "Sorry, we don't yet support #{button["type"]} buttons yet!")
+              end
+
+              smooch_button
+            end
+
+            smooch_buttons
+          end
+
+          def check_if_arguments_are_valid!(suggestions:, buttons:)
+            if suggestions.present? && buttons.present?
+              raise(ArgumentError, "A reply cannot have buttons and suggestions!")
+            end
+          end
+      end
+
+    end
+  end
+end

data/lib/stealth/services/smooch/setup.rb

@@ -0,0 +1,35 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+require 'stealth/services/smooch/client'
+
+module Stealth
+  module Services
+    module Smooch
+
+      class Setup
+
+        class << self
+          def trigger
+            SmoochApi.configure do |config|
+              config.api_key['Authorization'] = Stealth.config.smooch.jwt_token
+              config.api_key_prefix['Authorization'] = 'Bearer'
+            end
+
+            reply_handler = Stealth::Services::Smooch::ReplyHandler.new
+            menu = reply_handler.persistent_menu
+            Stealth::Services::Smooch::Client.set_persistent_menu(menu)
+
+            if ENV['SMOOCH_ENDPOINT'].present?
+              Stealth::Services::Smooch::Client.register_webhooks(endpoint: ENV['SMOOCH_ENDPOINT'])
+            else
+              puts '[ERROR] Please set SMOOCH_ENDPOINT to the endpoint that will receive Smooch webhooks.'
+            end
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/stealth/services/smooch/version.rb

@@ -0,0 +1,16 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+module Stealth
+  module Services
+    module Smooch
+      module Version
+        def self.version
+          File.read(File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'VERSION')).strip
+        end
+      end
+
+      VERSION = Version.version
+    end
+  end
+end

data/lib/stealth/smooch.rb

@@ -0,0 +1,2 @@
+require 'stealth/services/smooch/version'
+require 'stealth/services/smooch/client'

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+
+require 'stealth'
+require 'stealth-smooch'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+
+end

data/spec/version_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Stealth::Services::Smooch::Version" do
+
+  let(:version_in_file) { File.read(File.join(File.dirname(__FILE__), '..', 'VERSION')).strip }
+
+  it "should return the current gem version" do
+    expect(Stealth::Services::Smooch::Version.version).to eq version_in_file
+  end
+
+  it "should return the current gem version via a constant" do
+    expect(Stealth::Services::Smooch::VERSION).to eq version_in_file
+  end
+end

data/stealth-smooch.gemspec

@@ -0,0 +1,27 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+
+version = File.read(File.join(File.dirname(__FILE__), 'VERSION')).strip
+
+Gem::Specification.new do |s|
+  s.name = 'stealth-smooch'
+  s.summary = 'Stealth Smooch driver'
+  s.description = 'Smooch driver for Stealth.'
+  s.homepage = 'https://github.com/hellostealth/stealth-smooch'
+  s.licenses = ['MIT']
+  s.version = version
+  s.author = 'Mauricio Gomes'
+  s.email = 'mauricio@edge14.com'
+
+  s.add_dependency 'stealth', '< 2.0'
+  s.add_dependency 'jwt', '~> 2.1'
+  s.add_dependency 'smooch-api', '~> 4.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6'
+  s.add_development_dependency 'rspec_junit_formatter', '~> 0.3'
+  s.add_development_dependency 'rack-test', '~> 1.1'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: stealth-smooch
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Mauricio Gomes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: stealth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: smooch-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Smooch driver for Stealth.
+email: mauricio@edge14.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- VERSION
+- lib/stealth-smooch.rb
+- lib/stealth/services/smooch/client.rb
+- lib/stealth/services/smooch/events/message_event.rb
+- lib/stealth/services/smooch/events/postback_event.rb
+- lib/stealth/services/smooch/message_handler.rb
+- lib/stealth/services/smooch/reply_handler.rb
+- lib/stealth/services/smooch/setup.rb
+- lib/stealth/services/smooch/version.rb
+- lib/stealth/smooch.rb
+- spec/spec_helper.rb
+- spec/version_spec.rb
+- stealth-smooch.gemspec
+homepage: https://github.com/hellostealth/stealth-smooch
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Stealth Smooch driver
+test_files:
+- spec/spec_helper.rb
+- spec/version_spec.rb