xip-twilio 1.3.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f408ff6f6a53eb1a47055d96f0c0a36788c7a5ac9ee1c811ff1ee5530fbd552
+  data.tar.gz: 3618f4ad0bd769814e8a2ec3478c55db7b07be11b6617adf8c00423e03896eff
+SHA512:
+  metadata.gz: f0525b41729d8e520f7ac6f8164708e4ddfac0a59b0c35f9352f36b8e2e2a4d99d4dab6457ed6b1364149d9d3e26eb796902cdb902e10b31ea021f93db65118a
+  data.tar.gz: ea5f502da45cfc7083065c6fb3376925a7a5130b5422a0562308d61707df52ad0b07c942dfc047d4f9590d0b3e378e86068f53422f5678494b48475524293385

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'xip', '~> 2.0.0.beta'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,96 @@
+PATH
+  remote: .
+  specs:
+    xip-twilio (1.3.3)
+      twilio-ruby (~> 5.5)
+      xip (>= 2.0.0.beta)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.1.7)
+    connection_pool (2.2.3)
+    diff-lcs (1.4.4)
+    faraday (1.1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    jwt (2.2.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.2)
+    multi_json (1.15.0)
+    multipart-post (2.1.1)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    nio4r (2.5.4)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    puma (4.3.7)
+      nio4r (~> 2.0)
+    rack (2.2.3)
+    rack-protection (2.1.0)
+      rack
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    redis (4.2.5)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    ruby2_keywords (0.0.2)
+    sidekiq (6.1.2)
+      connection_pool (>= 2.2.2)
+      rack (~> 2.0)
+      redis (>= 4.2.0)
+    sinatra (2.1.0)
+      mustermann (~> 1.0)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
+      tilt (~> 2.0)
+    thor (1.0.1)
+    tilt (2.0.10)
+    twilio-ruby (5.45.1)
+      faraday (>= 0.9, < 2.0)
+      jwt (>= 1.5, <= 2.5)
+      nokogiri (>= 1.6, < 2.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    xip (2.0.0.beta2)
+      activesupport (~> 6.0)
+      multi_json (~> 1.12)
+      puma (>= 4.2, < 5.0)
+      sidekiq (~> 6.0)
+      sinatra (~> 2.0)
+      thor (~> 1.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack-test (~> 1.1)
+  rspec (~> 3)
+  rspec_junit_formatter (~> 0.3)
+  xip (~> 2.0.0.beta)
+  xip-twilio!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2017-2020 Mauricio Gomes
+
+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,19 @@
+# Twilio SMS and Whatsapp Xip Kit Component
+
+The [Xip Kit](https://github.com/xipkit/xip) Twilio SMS and Whatsapp component adds the ability to connect your bot to the Whatsapp and SMS platforms.
+
+[![Gem Version](https://badge.fury.io/rb/xip-twilio.svg)](https://badge.fury.io/rb/xip-twilio)
+
+## Supported Reply Types
+
+* Text
+* Image
+* Audio
+* Video
+* File
+* Delay
+
+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

@@ -0,0 +1 @@
+1.3.3

data/lib/xip-twilio.rb

@@ -0,0 +1 @@
+require 'xip/twilio'

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'twilio-ruby'
+
+require 'xip/services/twilio/message_handler'
+require 'xip/services/twilio/reply_handler'
+require 'xip/services/twilio/setup'
+
+module Xip
+  module Services
+    module Twilio
+      class Client < Xip::Services::BaseClient
+
+        attr_reader :twilio_client, :reply
+
+        def initialize(reply:)
+          @reply = reply
+          account_sid = Xip.config.twilio.account_sid
+          api_key = Xip.config.twilio.api_key
+          auth_token = Xip.config.twilio.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?
+
+          begin
+            response = twilio_client.messages.create(reply)
+          rescue ::Twilio::REST::RestError => e
+            case e.message
+            when /21610/ # Attempt to send to unsubscribed recipient
+              raise Xip::Errors::UserOptOut
+            when /21612/ # 'To' phone number is not currently reachable via SMS
+              raise Xip::Errors::UserOptOut
+            when /21614/ # 'To' number is not a valid mobile number
+              raise Xip::Errors::UserOptOut
+            when /30004/ # Message blocked
+              raise Xip::Errors::UserOptOut
+            when /21211/ # Invalid 'To' Phone Number
+              raise Xip::Errors::InvalidSessionID
+            when /30003/ # Unreachable destination handset
+              raise Xip::Errors::InvalidSessionID
+            when /30005/ # Unknown destination handset
+              raise Xip::Errors::InvalidSessionID
+            else
+              raise
+            end
+          end
+
+          Xip::Logger.l(
+            topic: "twilio",
+            message: "Transmitting. Response: #{response.status}: #{response.error_message}"
+          )
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Xip
+  module Services
+    module Twilio
+      class MessageHandler < Xip::Services::BaseMessageHandler
+        attr_reader :service_message, :params, :headers
+
+        def initialize(params:, headers:)
+          @params = params
+          @headers = headers
+        end
+
+        def coordinate
+          Xip::Services::HandleMessageJob.perform_async(
+            'twilio',
+            params,
+            headers
+          )
+
+          # Relay our acceptance
+          [204, 'No Content']
+        end
+
+        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 = params['NumMedia'].to_i
+
+          attachment_count.times do |i|
+            service_message.attachments << {
+              type: params["MediaContentType#{i}"],
+              url: params["MediaUrl#{i}"]
+            }
+          end
+
+          service_message
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Xip
+  module Services
+    module Twilio
+      class ReplyHandler < Xip::Services::BaseReplyHandler
+
+        ALPHA_ORDINALS = ('A'..'Z').to_a.freeze
+
+        attr_reader :recipient_id, :reply
+
+        def initialize(recipient_id: nil, reply: nil)
+          @recipient_id = recipient_id
+          @reply = reply
+        end
+
+        def text
+          check_text_length
+
+          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
+          check_text_length
+
+          format_response({ body: reply['text'], media_url: reply['image_url'] })
+        end
+
+        def audio
+          check_text_length
+
+          format_response({ body: reply['text'], media_url: reply['audio_url'] })
+        end
+
+        def video
+          check_text_length
+
+          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
+
+        private
+
+          def check_text_length
+            if reply['text'].present? && reply['text'].size > 1600
+              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
+            }
+            response.merge(sender_info)
+          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/xip/services/twilio/setup.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'xip/services/twilio/client'
+
+module Xip
+  module Services
+    module Twilio
+
+      class Setup
+
+        class << self
+          def trigger
+            Xip::Logger.l(
+              topic: "twilio",
+              message: "There is no setup needed!"
+            )
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/xip/services/twilio/version.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Xip
+  module Services
+    module Twilio
+      module Version
+        def self.version
+          File.read(File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'VERSION')).strip
+        end
+      end
+
+      VERSION = Version.version
+    end
+  end
+end

data/lib/xip/twilio.rb

@@ -0,0 +1,2 @@
+require 'xip/services/twilio/version'
+require 'xip/services/twilio/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 'xip'
+require 'xip-twilio'
+
+# 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 "Xip::Services::Twilio::Version" do
+
+  let(:version_in_file) { File.read(File.join(File.dirname(__FILE__), '..', 'VERSION')).strip }
+
+  it "should return the current gem version" do
+    expect(Xip::Services::Twilio::Version.version).to eq version_in_file
+  end
+
+  it "should return the current gem version via a constant" do
+    expect(Xip::Services::Twilio::VERSION).to eq version_in_file
+  end
+end

data/xip-twilio.gemspec

@@ -0,0 +1,26 @@
+$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 = 'xip-twilio'
+  s.summary = 'Twilio SMS and Whatsapp Xip Kit component'
+  s.description = 'Twilio SMS and Whatsapp Xip Kit component.'
+  s.homepage = 'https://github.com/xipkit/xip-twilio'
+  s.licenses = ['MIT']
+  s.version = version
+  s.author = 'Mauricio Gomes'
+  s.email = 'mauricio@edge14.com'
+
+  s.add_dependency 'xip', '~> 2.0.0.beta'
+  s.add_dependency 'twilio-ruby', '~> 5.5'
+
+  s.add_development_dependency 'rspec', '~> 3'
+  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,129 @@
+--- !ruby/object:Gem::Specification
+name: xip-twilio
+version: !ruby/object:Gem::Version
+  version: 1.3.3
+platform: ruby
+authors:
+- Mauricio Gomes
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta
+- !ruby/object:Gem::Dependency
+  name: twilio-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !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: Twilio SMS and Whatsapp Xip Kit component.
+email: mauricio@edge14.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- VERSION
+- lib/xip-twilio.rb
+- lib/xip/services/twilio/client.rb
+- lib/xip/services/twilio/message_handler.rb
+- lib/xip/services/twilio/reply_handler.rb
+- lib/xip/services/twilio/setup.rb
+- lib/xip/services/twilio/version.rb
+- lib/xip/twilio.rb
+- spec/spec_helper.rb
+- spec/version_spec.rb
+- xip-twilio.gemspec
+homepage: https://github.com/xipkit/xip-twilio
+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: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Twilio SMS and Whatsapp Xip Kit component
+test_files:
+- spec/spec_helper.rb
+- spec/version_spec.rb