stealth-twilio 0.9.6 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31c85acf744f55590059fcc36337e6e9991530aedccbd20248b888ac92315827
-  data.tar.gz: ad11eceb7b575447f0022c1da33aaa53ba1eaaa63f8d469ad2c3b58f76bf1b8e
+  metadata.gz: e58ea195cdd02ebe016c6a3b734b8328dbe401451c44f0cc025ee756433c8ed8
+  data.tar.gz: 35b65726eda6979d2924473431b496612f0cc1ff917cfd40e6325a91f9cf133f
 SHA512:
-  metadata.gz: 2cdbaf353bd3724608ffae1223c6c2e5ae513c7aa15e50c01f46fb9da18c5cb51b882c68a79470f929c4fb4bb25bf1f17d80efe9e8015c8d5c456ea9ef2eee54
-  data.tar.gz: 810c9d90f8c622316b84405e0a9a3a4ccfae26f91f5799bb357bee5409d9f25e3adcfe2cb12014325aef1dbed9df3f4b24f6d48154f7b5ad7173cf08c7fbbac9
+  metadata.gz: ae36604edc20f7a4117d5deb12e2c09443f5052b990ba7a318353de20207b34cbb7f483f2109001b58c110130b5fee7929b892ebd47b6c0bb1e27a6db149aa96
+  data.tar.gz: 768f4f5406f69f2fbb785a6d24e1b6842b05d5b8e5a8046699b1e71fc10ef4ea27093fe474853aa887cb6d98c5a25318dd2764691f3c198971a8e5a1d3491628

data/Gemfile

@@ -1,2 +1,7 @@
 source 'https://rubygems.org'
+
+source 'https://EBQGt-IDpU8vpliiVe76xe1CJ8OOuu48w@gem.fury.io/whoisblackops/' do
+  gem 'stealth', '~> 2.2'
+end
+
 gemspec

data/Gemfile.lock

@@ -1,121 +1,88 @@
 PATH
   remote: .
   specs:
-    stealth-twilio (0.9.5)
-      stealth (< 2.0)
+    stealth-twilio (1.3.1)
+      stealth (~> 2.2)
       twilio-ruby (~> 5.5)
 
 GEM
   remote: https://rubygems.org/
+  remote: https://EBQGt-IDpU8vpliiVe76xe1CJ8OOuu48w@gem.fury.io/whoisblackops/
   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)
+    activesupport (6.0.2.2)
       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.0.5)
+      zeitwerk (~> 2.2)
+    concurrent-ruby (1.1.6)
     connection_pool (2.2.2)
-    crass (1.0.4)
     diff-lcs (1.3)
-    erubi (1.7.1)
-    faraday (0.15.3)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
-    i18n (1.1.1)
+    i18n (1.8.2)
       concurrent-ruby (~> 1.0)
-    jwt (2.1.0)
-    loofah (2.2.2)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    method_source (0.9.0)
-    mini_portile2 (2.3.0)
-    minitest (5.11.3)
-    multi_json (1.13.1)
-    multipart-post (2.0.0)
-    mustermann (1.0.3)
-    nokogiri (1.8.5)
-      mini_portile2 (~> 2.3.0)
-    puma (3.12.0)
-    rack (2.0.5)
-    rack-protection (2.0.4)
+    jwt (2.2.1)
+    mini_portile2 (2.4.0)
+    minitest (5.14.0)
+    multi_json (1.14.1)
+    multipart-post (2.1.1)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    nio4r (2.5.2)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    puma (4.3.3)
+      nio4r (~> 2.0)
+    rack (2.2.2)
+    rack-protection (2.0.8.1)
       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.2)
-    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)
+    redis (4.1.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    sidekiq (5.2.2)
-      connection_pool (~> 2.2, >= 2.2.2)
-      rack-protection (>= 1.5.0)
-      redis (>= 3.3.5, < 5)
-    sinatra (2.0.4)
+    ruby2_keywords (0.0.2)
+    sidekiq (6.0.6)
+      connection_pool (>= 2.2.2)
+      rack (~> 2.0)
+      rack-protection (>= 2.0.0)
+      redis (>= 4.1.0)
+    sinatra (2.0.8.1)
       mustermann (~> 1.0)
       rack (~> 2.0)
-      rack-protection (= 2.0.4)
+      rack-protection (= 2.0.8.1)
       tilt (~> 2.0)
-    stealth (1.0.4)
-      activerecord (~> 5.2)
-      activesupport (~> 5.2)
+    stealth (2.4.0)
+      activesupport (~> 6.0)
       multi_json (~> 1.12)
-      puma (~> 3.10)
-      railties (~> 5.2)
-      sidekiq (~> 5.0)
+      puma (>= 4.2, < 5.0)
+      sidekiq (~> 6.0)
       sinatra (~> 2.0)
-      thor (~> 0.20)
-    thor (0.20.0)
+      thor (~> 1.0)
+    thor (1.0.1)
     thread_safe (0.3.6)
-    tilt (2.0.8)
-    twilio-ruby (5.15.0)
-      faraday (~> 0.9)
+    tilt (2.0.10)
+    twilio-ruby (5.33.0)
+      faraday (~> 1.0.0)
       jwt (>= 1.5, <= 2.5)
       nokogiri (>= 1.6, < 2.0)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
@@ -124,7 +91,8 @@ DEPENDENCIES
   rack-test (~> 1.1)
   rspec (~> 3.6)
   rspec_junit_formatter (~> 0.3)
+  stealth (~> 2.2)!
   stealth-twilio!
 
 BUNDLED WITH
-   1.16.3
+   2.1.4

data/README.md

@@ -2,15 +2,18 @@
 
 The [Stealth](https://github.com/hellostealth/stealth) Twilio SMS driver adds the ability to build your bot using Twilio's SMS service.
 
+[![Gem Version](https://badge.fury.io/rb/stealth-twilio.svg)](https://badge.fury.io/rb/stealth-twilio)
+
 ## Supported Reply Types
 
 * Text
 * Image
 * Audio
 * Video
+* File
 * Delay
 
-Image, Audio, and Video reply types will leverage the MMS protocol. It is recommended by Twilio that
+Image, Audio, Video, and File reply types will leverage the MMS protocol. It is recommended by Twilio that
 the content is limited to images, however, this is the full list of supported content types: https://www.twilio.com/docs/api/messaging/accepted-mime-types.
 
-
+If you store your files on S3, please make sure you have set the `content-type` appropriately or Twilio might reject your media.

data/VERSION

@@ -1 +1 @@
-0.9.6
+1.3.1

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

@@ -10,7 +10,6 @@ require 'stealth/services/twilio/setup'
 module Stealth
   module Services
     module Twilio
-
       class Client < Stealth::Services::BaseClient
 
         attr_reader :twilio_client, :reply
@@ -18,20 +17,52 @@ module Stealth
         def initialize(reply:)
           @reply = reply
           account_sid = Stealth.config.twilio.account_sid
+          api_key = Stealth.config.twilio.api_key
           auth_token = Stealth.config.twilio.auth_token
-          @twilio_client = ::Twilio::REST::Client.new(account_sid, auth_token)
+
+          if api_key.present?
+            @twilio_client = ::Twilio::REST::Client.new(
+              api_key, auth_token, account_sid
+            )
+          else
+            @twilio_client = ::Twilio::REST::Client.new(account_sid, auth_token)
+          end
         end
 
         def transmit
           # Don't transmit anything for delays
           return true if reply.blank?
 
-          response = twilio_client.messages.create(reply)
-          Stealth::Logger.l(topic: "twilio", message: "Transmitting. Response: #{response.status}: #{response.error_message}")
+          begin
+            response = twilio_client.messages.create(reply)
+          rescue ::Twilio::REST::RestError => e
+            case e.message
+            when /21610/ # Attempt to send to unsubscribed recipient
+              raise Stealth::Errors::UserOptOut
+            when /21612/ # 'To' phone number is not currently reachable via SMS
+              raise Stealth::Errors::UserOptOut
+            when /21614/ # 'To' number is not a valid mobile number
+              raise Stealth::Errors::UserOptOut
+            when /30004/ # Message blocked
+              raise Stealth::Errors::UserOptOut
+            when /21211/ # Invalid 'To' Phone Number
+              raise Stealth::Errors::InvalidSessionID
+            when /30003/ # Unreachable destination handset
+              raise Stealth::Errors::InvalidSessionID
+            when /30005/ # Unknown destination handset
+              raise Stealth::Errors::InvalidSessionID
+            else
+              raise
+            end
+          end
+
+          Stealth::Logger.l(
+            topic: "twilio",
+            message: "Transmitting. Response: #{response.status}: #{response.error_message}"
+          )
         end
 
       end
-
     end
   end
 end

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

@@ -4,9 +4,7 @@
 module Stealth
   module Services
     module Twilio
-
       class MessageHandler < Stealth::Services::BaseMessageHandler
-
         attr_reader :service_message, :params, :headers
 
         def initialize(params:, headers:)
@@ -15,7 +13,11 @@ module Stealth
         end
 
         def coordinate
-          Stealth::Services::HandleMessageJob.perform_async('twilio', params, {})
+          Stealth::Services::HandleMessageJob.perform_async(
+            'twilio',
+            params,
+            headers
+          )
 
           # Relay our acceptance
           [204, 'No Content']
@@ -24,23 +26,17 @@ module Stealth
         def process
           @service_message = ServiceMessage.new(service: 'twilio')
           service_message.sender_id = params['From']
+          service_message.target_id = params['To']
           service_message.message = params['Body']
 
           # Check for media attachments
-          attachment_count = 0
-          begin
-            attachment_count = Integer(params['NumMedia'])
-          rescue ArgumentError
-
-          end
+          attachment_count = params['NumMedia'].to_i
 
-          if attachment_count > 0
-            for i in (0..attachment_count) do
-              service_message.attachments << {
-                type: params["MediaContentType#{i}"],
-                url: params["MediaUrl#{i}"]
-              }
-            end
+          attachment_count.times do |i|
+            service_message.attachments << {
+              type: params["MediaContentType#{i}"],
+              url: params["MediaUrl#{i}"]
+            }
           end
 
           service_message

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

@@ -4,9 +4,10 @@
 module Stealth
   module Services
     module Twilio
-
       class ReplyHandler < Stealth::Services::BaseReplyHandler
 
+        ALPHA_ORDINALS = ('A'..'Z').to_a.freeze
+
         attr_reader :recipient_id, :reply
 
         def initialize(recipient_id: nil, reply: nil)
@@ -17,7 +18,35 @@ module Stealth
         def text
           check_text_length
 
-          format_response({ body: reply['text'] })
+          translated_reply = reply['text']
+
+          suggestions = generate_suggestions(suggestions: reply['suggestions'])
+          buttons = generate_buttons(buttons: reply['buttons'])
+
+          if suggestions.present?
+            translated_reply = [
+              translated_reply,
+              'Reply with:'
+            ].join("\n\n")
+
+            suggestions.each_with_index do |suggestion, i|
+              translated_reply = [
+                translated_reply,
+                "\"#{ALPHA_ORDINALS[i]}\" for #{suggestion}"
+              ].join("\n")
+            end
+          end
+
+          if buttons.present?
+            buttons.each do |button|
+              translated_reply = [
+                translated_reply,
+                button
+              ].join("\n\n")
+            end
+          end
+
+          format_response({ body: translated_reply })
         end
 
         def image
@@ -38,6 +67,12 @@ module Stealth
           format_response({ body: reply['text'], media_url: reply['video_url'] })
         end
 
+        def file
+          check_text_length
+
+          format_response({ body: reply['text'], media_url: reply['file_url'] })
+        end
+
         def delay
 
         end
@@ -46,17 +81,46 @@ module Stealth
 
           def check_text_length
             if reply['text'].present? && reply['text'].size > 1600
-              raise(ArgumentError, "Text messages must be 1600 characters or less.")
+              raise(ArgumentError, 'Text messages must be 1600 characters or less.')
             end
           end
 
           def format_response(response)
-            sender_info = { from: Stealth.config.twilio.from_phone, to: recipient_id }
+            sender_info = {
+              from: Stealth.config.twilio.from_phone,
+              to: recipient_id
+            }
             response.merge(sender_info)
           end
 
-      end
+          def generate_suggestions(suggestions:)
+            return if suggestions.blank?
 
+            mf = suggestions.collect do |suggestion|
+              suggestion['text']
+            end.compact
+          end
+
+          def generate_buttons(buttons:)
+            return if buttons.blank?
+
+            sms_buttons = buttons.map do |button|
+              case button['type']
+              when 'url'
+                "#{button['text']}: #{button['url']}"
+              when 'payload'
+                "To #{button['text'].downcase}: Text #{button['payload'].upcase}"
+              when 'call'
+                "#{button['text']}: #{button['phone_number']}"
+              else # Don't raise for unsupported buttons
+                next
+              end
+            end.compact
+
+            sms_buttons
+          end
+
+      end
     end
   end
 end

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

@@ -11,7 +11,10 @@ module Stealth
 
         class << self
           def trigger
-            Stealth::Logger.l(topic: "twilio", message: "There is no setup needed!")
+            Stealth::Logger.l(
+              topic: "twilio",
+              message: "There is no setup needed!"
+            )
           end
         end
 

data/stealth-twilio.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.author = 'Mauricio Gomes'
   s.email = 'mauricio@edge14.com'
 
-  s.add_dependency 'stealth', '< 2.0'
+  s.add_dependency 'stealth', '~> 2'
   s.add_dependency 'twilio-ruby', '~> 5.5'
 
   s.add_development_dependency 'rspec', '~> 3.6'

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: stealth-twilio
 version: !ruby/object:Gem::Version
-  version: 0.9.6
+  version: 1.3.1
 platform: ruby
 authors:
 - Mauricio Gomes
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-10-15 00:00:00.000000000 Z
+date: 2020-09-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'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: twilio-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -90,7 +90,6 @@ files:
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
-- LICENSE
 - README.md
 - VERSION
 - lib/stealth-twilio.rb
@@ -107,7 +106,7 @@ homepage: https://github.com/hellostealth/stealth-twilio
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -122,9 +121,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Stealth Twilio SMS driver
 test_files:

data/LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2017 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.