stealth-bandwidth 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7819293192d202d15f7d9bdfc5f9bcda6f9a4316f929e6d6a96b8e08286a8530
+  data.tar.gz: 23828c62352610ac0c52947150f2b1e4790070ee09d4cfdeec27eef11d68fc8a
+SHA512:
+  metadata.gz: b425eb611f44cbb026e01b3fa6a68c54f47d8f8be29303b6069dd15de4fe64f25ae4bfa71b17d09e28f011b7421467c912a76d63a32373321b8b1dadba289ed3
+  data.tar.gz: 6b06a35322e10a7e9303ff68b446db8c1e54ddaa8086d7cf334e09816a99c48e6caef689d8fb7472a5e6079f8972e467a241864e5d20fdb5a4dcd5cfb606428e

data/.circleci/config.yml

@@ -0,0 +1,60 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.4.1-node-browsers
+         environment:
+           STEALTH_ENV: test
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress \
+                --format RspecJunitFormatter \
+                --out /tmp/test-results/rspec.xml \
+                --format progress \
+                -- \
+                $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

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,5 @@
+source 'https://rubygems.org'
+
+gem 'stealth', '>= 2.0.0.beta6'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,109 @@
+PATH
+  remote: .
+  specs:
+    stealth-bandwidth (1.0.0)
+      http (~> 4.1)
+      oj (~> 3.11)
+      stealth (>= 2.0.0.beta6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    concurrent-ruby (1.1.10)
+    connection_pool (2.3.0)
+    diff-lcs (1.5.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.15.5)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    http (4.4.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    http-parser (1.2.3)
+      ffi-compiler (>= 1.0, < 2.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.16.3)
+    multi_json (1.15.0)
+    mustermann (2.0.2)
+      ruby2_keywords (~> 0.0.1)
+    nio4r (2.5.8)
+    oj (3.13.21)
+    public_suffix (5.0.0)
+    puma (5.6.5)
+      nio4r (~> 2.0)
+    rack (2.2.4)
+    rack-protection (2.2.2)
+      rack
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rake (13.0.6)
+    redis (4.8.0)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rspec_junit_formatter (0.5.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    ruby2_keywords (0.0.5)
+    sidekiq (6.5.6)
+      connection_pool (>= 2.2.5)
+      rack (~> 2.0)
+      redis (>= 4.5.0, < 5)
+    sinatra (2.2.2)
+      mustermann (~> 2.0)
+      rack (~> 2.2)
+      rack-protection (= 2.2.2)
+      tilt (~> 2.0)
+    stealth (2.0.0.beta6)
+      activesupport (~> 6.0)
+      multi_json (~> 1.12)
+      puma (>= 4.2, < 6.0)
+      sidekiq (~> 6.0)
+      sinatra (~> 2.0)
+      thor (~> 1.0)
+    thor (1.2.1)
+    tilt (2.0.11)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+    zeitwerk (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack-test (~> 1.1)
+  rspec (~> 3.6)
+  rspec_junit_formatter (~> 0.3)
+  stealth (>= 2.0.0.beta6)
+  stealth-bandwidth!
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,21 @@
+# Stealth Bandwidth SMS
+
+The [Stealth](https://github.com/whoisblackops/stealth) Bandwidth SMS driver adds the ability to build your bot using Bandwidth's SMS service.
+
+## 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 Bandwidth that
+the content is limited to images, however, this is the full list of supported content types: https://dev.bandwidth.com/faq/messaging/mediaType.html.
+
+If you store your files on S3, please make sure you have set the `content-type` appropriately or Bandwidth might reject your media.
+
+## Service Message
+
+This driver will set `current_message.target_id` to the array of phone numbers the SMS message was delivered to. In most cases the array will just contain a single phone number (the phone number of your bot), but in the case of a group message, it will contain the phone numbers of each recipient in addition to your bot's phone number.

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/stealth/bandwidth.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+require 'stealth/services/bandwidth/version'
+require 'stealth/services/bandwidth/client'

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'http'
+
+require 'stealth/services/bandwidth/message_handler'
+require 'stealth/services/bandwidth/reply_handler'
+require 'stealth/services/bandwidth/setup'
+
+module Stealth
+  module Services
+    module Bandwidth
+      class Client < Stealth::Services::BaseClient
+
+        attr_reader :http_client, :reply, :endpoint
+
+        def initialize(reply:)
+          @reply = reply
+          account_id = Stealth.config.bandwidth.account_id
+          username = Stealth.config.bandwidth.api_username
+          password = Stealth.config.bandwidth.api_password
+          application_id = Stealth.config.bandwidth.application_id
+          @endpoint = "https://messaging.bandwidth.com/api/v2/users/#{account_id}/messages"
+          @http_client = HTTP
+                          .timeout(connect: 15, read: 30)
+                          .basic_auth(user: username, pass: password)
+                          .headers('Content-Type' => 'application/json')
+        end
+
+        def transmit
+          # Don't transmit anything for delays
+          return true if reply.blank?
+
+          json_reply = Oj.dump(reply, mode: :compat)
+          response = http_client.post(endpoint, body: json_reply)
+
+          Stealth::Logger.l(
+            topic: 'bandwidth',
+            message: "Transmitting. Response: #{response.status.code}: #{response.body}"
+          )
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Stealth
+  module Services
+    module Bandwidth
+      class MessageHandler < Stealth::Services::BaseMessageHandler
+        attr_reader :service_message, :params, :headers
+
+        def initialize(params:, headers:)
+          @params = params
+          @headers = headers
+        end
+
+        def coordinate
+          case params.dig('message', 'direction')
+          when "in"
+            Stealth::Services::HandleMessageJob.perform_async(
+              'bandwidth',
+              params,
+              headers
+            )
+          when "out"
+            # Ignoring outbound messages
+          end
+
+          # Relay our acceptance
+          [202, 'Accepted']
+        end
+
+        def process
+          @service_message = ServiceMessage.new(service: 'bandwidth')
+
+          service_message.sender_id = params.dig('message', 'from')
+          service_message.target_id = params.dig('message', 'to').first
+          service_message.message = params.dig('message', 'text')
+          service_message.timestamp = params.dig('message', 'time')
+          params.dig('message', 'media')&.each do |attachment_url|
+            service_message.attachments << {
+              url: attachment_url
+            }
+          end
+
+          service_message
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,128 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+module Stealth
+  module Services
+    module Bandwidth
+      class ReplyHandler < Stealth::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({ text: translated_reply })
+        end
+
+        def image
+          check_text_length
+
+          format_response({ text: reply['text'], media: [reply['image_url']] })
+        end
+
+        def audio
+          check_text_length
+
+          format_response({ text: reply['text'], media: [reply['audio_url']] })
+        end
+
+        def video
+          check_text_length
+
+          format_response({ text: reply['text'], media: [reply['video_url']] })
+        end
+
+        def file
+          check_text_length
+
+          format_response({ text: reply['text'], media: [reply['file_url']] })
+        end
+
+        def delay
+
+        end
+
+        private
+
+          def check_text_length
+            if reply['text'].present? && reply['text'].size > 2048
+              raise(ArgumentError, 'Text messages must be 2048 characters or less.')
+            end
+          end
+
+          def format_response(response)
+            sender_info = {
+              from: Stealth.config.bandwidth.from_phone.to_s,
+              to: recipient_id,
+              applicationId: Stealth.config.bandwidth.application_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/stealth/services/bandwidth/setup.rb

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

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Stealth
+  module Services
+    module Bandwidth
+      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-bandwidth.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'stealth/bandwidth'

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-bandwidth'
+
+# 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::Bandwidth::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::Bandwidth::Version.version).to eq version_in_file
+  end
+
+  it "should return the current gem version via a constant" do
+    expect(Stealth::Services::Bandwidth::VERSION).to eq version_in_file
+  end
+end

data/stealth-bandwidth.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-bandwidth'
+  s.summary = 'Stealth Bandwidth SMS driver'
+  s.description = 'Bandwidth.com SMS driver for Stealth.'
+  s.homepage = 'https://github.com/hellostealth/stealth-bandwidth'
+  s.licenses = ['MIT']
+  s.version = version
+  s.authors = ['Mauricio Gomes', 'Emilie Morissette']
+  s.email = ['mauricio@edge14.com', 'emorissettegregoire@gmail.com']
+
+  s.add_dependency 'stealth', '>= 2.0.0.beta6'
+  s.add_dependency 'http', '~> 4.1'
+  s.add_dependency 'oj', '~> 3.11'
+
+  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-bandwidth
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mauricio Gomes
+- Emilie Morissette
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-09-23 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.0.beta6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta6
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+- !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: Bandwidth.com SMS driver for Stealth.
+email:
+- mauricio@edge14.com
+- emorissettegregoire@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- VERSION
+- lib/stealth-bandwidth.rb
+- lib/stealth/bandwidth.rb
+- lib/stealth/services/bandwidth/client.rb
+- lib/stealth/services/bandwidth/message_handler.rb
+- lib/stealth/services/bandwidth/reply_handler.rb
+- lib/stealth/services/bandwidth/setup.rb
+- lib/stealth/services/bandwidth/version.rb
+- spec/spec_helper.rb
+- spec/version_spec.rb
+- stealth-bandwidth.gemspec
+homepage: https://github.com/hellostealth/stealth-bandwidth
+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.0.8
+signing_key:
+specification_version: 4
+summary: Stealth Bandwidth SMS driver
+test_files:
+- spec/spec_helper.rb
+- spec/version_spec.rb