stealth-messagebird 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a1228659f9b45371d5a9ccf1abaf8e6a6df5f3a4fff7a3a49ec7412e28459870
+  data.tar.gz: d10bcc20c96acf5aa4950ba62aaab8ebba6c0b39030d549144f6252f70416626
+SHA512:
+  metadata.gz: 520c7678bc8d73f64c487e1badad84438e58dae307782f09305ca3bc74df92ad58bfe07c2fc8670b67d56b5975f5f7720251ec524200a46e07951057d6300bf1
+  data.tar.gz: c9eaeae10966f14f6eb943511fe5b865414a96e549c21fd5dbf84858d1eedd189d07e27ceb8235fdf4993dcee95c93eb797b67016d9189df04be9209e11777a3

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,13 @@
+# 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
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'stealth', '>= 2.0.0.beta'
+
+gemspec
+

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Emilie Morissette
+
+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,77 @@
+# Messagebird WhatsApp Driver for Stealth
+
+The [Stealth](https://github.com/hellostealth/stealth) WhatsApp driver adds the ability to build your bot using [Messagebird](https://www.messagebird.com/en/solutions/whatsapp-api) service.
+
+Messagebird allow you to use your [own mobile number](https://support.messagebird.com/hc/en-us/articles/360000244558-How-to-pick-a-number-for-WhatsApp-Business) for WhatsApp. So no geographic restrictions compare to virtual mobile numbers (VMNs).
+
+First thing first, create a Messagebird account and install your [WhatsApp Business channel](https://support.messagebird.com/hc/en-us/articles/360000258437-WhatsApp-Business-step-by-step-onboarding). This gem is not supporting the Messagebird Sandbox, since their Sandbox has limitations.
+
+## WhatsApp Supported Reply Types
+
+* Text
+* Image
+* Audio
+* Video/GIF (receive only)
+* File
+* Delay
+
+* Location
+
+In your replies files
+```
+- reply_type: location
+  latitude: 41.69352000000001
+  longitude: 44.801473999999985
+```
+
+More info here: https://developers.messagebird.com/quickstarts/whatsapp-deepdive/
+
+## Configure Messagebird with your Stealth bot
+Once your WhatsApp Business Channel is active, you will receive a `channel_id`.
+To visualize your channel_id, go to `Channels` in the sidebar of your Messagebird Dashboard.
+You will need your Live API Key as well, go to `Developers` in the sidebar of your Messagebird Dashboard.
+
+In `services.yml`
+```
+messagebird:
+    access_key: <%= ENV['MESSAGEBIRD_ACCESS_KEY'] %>
+    channel_id: <%= ENV['MESSAGEBIRD_CHANNEL_ID'] %>
+```
+
+## Setup your Webhook
+Create your webhook so that Messagebird can communicate with your app when receiving a message from a user.
+Subscribe to `message.created` event only.
+
+```
+curl -X POST "https://conversations.messagebird.com/v1/webhooks/" \
+  -H "Authorization: AccessKey YOUR_ACCESS_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "events": ["message.created"],
+    "channelId": "YOUR_CHANNEL_ID",
+    "url": "https://1cfd8wc098r0.ngrok.io/incoming/messagebird"
+  }'
+```
+When you provide your local ngrok URL to a messaging service, you will have to add /incoming/messagebird. More infos on [Stealth Repo](https://github.com/hellostealth/stealth/wiki/Local-Development).
+
+For more infos on webhooks, follow the [Messagebird instructions](https://developers.messagebird.com/api/conversations/#create-webhook).
+
+## current_message
+When calling the `current_message` method in your Stealth bot, you can retrieve the following informations:
+```
+#<Stealth::Services::Messagebird::MessagebirdServiceMessage:0x00009ceg7cef4cd3
+@attachments=[],
+@conversation_id="1cdeee16bd432a987c167f67b611056f",
+@display_name="Emilie",
+@first_name="",
+@last_name="",
+@location={},
+@message="Yo",
+@messagebird_id="9881a12f6hhe4g41b9935hh4d299c01f",
+@platform="whatsapp",
+@read={},
+@sender_id="33320110909",
+@service="messagebird",
+@target_id="098882ge-b745-1f12-a02f-4c1239da7d01",
+@timestamp="2021-04-13T12:23:16Z">
+```

data/VERSION

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

data/lib/stealth/messagebird.rb

@@ -0,0 +1,4 @@
+require 'pry'
+require 'json'
+require 'stealth/services/messagebird/version'
+require 'stealth/services/messagebird/client'

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+require 'messagebird'
+require 'stealth/services/messagebird/message_handler'
+require 'stealth/services/messagebird/messagebird_service_message'
+require 'stealth/services/messagebird/reply_handler'
+require 'stealth/services/messagebird/setup'
+
+module Stealth
+  module Services
+    module Messagebird
+      class Client < Stealth::Services::BaseClient
+        attr_reader :messagebird_client, :reply
+
+        def initialize(reply:)
+          @reply = reply
+          access_key = Stealth.config.messagebird.access_key
+          @messagebird_client = MessageBird::Client.new(access_key)
+        end
+
+        def transmit
+          # Don't transmit anything for delays
+          return true if reply.blank?
+
+          response = messagebird_client.send_conversation_message(reply[:from], reply[:to], reply)
+
+          if response.status == "failed" || response.status == "rejected"
+            case response.error.code
+            when 301 # Message failed to send
+              raise Stealth::Errors::UserOptOut
+            when 302 # Contact is not registered on WhatsApp
+              raise Stealth::Errors::UserOptOut
+            when 470 # Outside the support window for freeform messages
+              raise Stealth::Errors::UserOptOut
+            when 2 # Request not allowed
+              raise Stealth::Errors::UserOptOut
+            when 25 # Not enough balance
+              raise Stealth::Errors::UserOptOut
+            else
+              raise
+            end
+          end
+
+          message = "Transmitting. Response: #{response.status}: "
+          if response.status == "failed" || response.status == "rejected"
+            message += response.error.description
+          end
+          Stealth::Logger.l(topic: "messagebird", message: message)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+module Stealth
+  module Services
+    module Messagebird
+      class MessageHandler < Stealth::Services::BaseMessageHandler
+        attr_reader :service_message, :params, :headers
+
+        def initialize(params:, headers:)
+          @params = params
+          @headers = headers
+        end
+
+        def coordinate
+          if params.dig('message', 'direction') == 'received'
+            Stealth::Services::HandleMessageJob.perform_async(
+              'messagebird',
+              params,
+              headers
+            )
+          end
+          # Relay our acceptance
+          [200, 'OK']
+        end
+
+        def process
+          @service_message = MessagebirdServiceMessage.new(service: 'messagebird')
+          service_message.sender_id = params['contact']['msisdn'].to_s
+          service_message.target_id = params['message']['channelId']
+          service_message.timestamp = params['message']['createdDatetime']
+          service_message.message = params['message']['content']['text']
+          service_message.conversation_id = params['message']['conversationId']
+          service_message.messagebird_id = params['contact']['id']
+          service_message.display_name = params['contact']['displayName']
+          service_message.first_name = params['contact']['firstName']
+          service_message.last_name = params['contact']['lastName']
+          service_message.platform = params['message']['platform']
+
+          if params['message']['type'] == 'image'
+            service_message.attachments = [{
+              type: params['message']['type'],
+              url: params['message']['content']['image']['url']
+            }]
+          elsif params['message']['type'] == 'video'
+            service_message.attachments = [{
+              type: params['message']['type'],
+              url: params['message']['content']['video']['url']
+            }]
+          elsif params['message']['type'] == 'audio'
+            service_message.attachments = [{
+              type: params['message']['type'],
+              url: params['message']['content']['audio']['url']
+            }]
+          elsif params['message']['type'] == 'file'
+            service_message.attachments = [{
+              type: params['message']['type'],
+              location: params['message']['content']['file']['url']
+            }]
+          elsif params['message']['type'] == 'location'
+            service_message.location = [{
+              type: params['message']['type'],
+              location: params['message']['content']['location']
+            }]
+          end
+
+          service_message
+        end
+      end
+    end
+  end
+end

data/lib/stealth/services/messagebird/messagebird_service_message.rb

@@ -0,0 +1,15 @@
+module Stealth
+  module Services
+    module Messagebird
+      class MessagebirdServiceMessage < Stealth::ServiceMessage
+        attr_accessor :conversation_id,
+                      :messagebird_id,
+                      :platform,
+                      :display_name,
+                      :first_name,
+                      :last_name
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+module Stealth
+  module Services
+    module Messagebird
+      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
+          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,
+              I18n.t(
+                "stealth.messagebird.respond_with_a_number",
+                default: "Respond with a number:"
+              )
+            ].join("\n\n")
+
+            suggestions.each_with_index do |suggestion, i|
+              translated_reply = [
+                translated_reply,
+                I18n.t(
+                  "stealth.messagebird.number_option",
+                  number: i + 1,
+                  suggestion: suggestion,
+                  default: "%{number} 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 })
+          format_response(type: 'text', content: { text: translated_reply })
+        end
+
+        def image
+          check_text_length
+          format_response(type: 'image', content: { image: { caption: reply['text'], url: reply['image_url'] } })
+        end
+
+        def audio
+          check_text_length
+
+          format_response(type: 'audio', content: { audio: { caption: reply['text'], url: reply['audio_url'] } })
+        end
+
+        def video
+          check_text_length
+
+          format_response(type: 'video', content: { video: { caption: reply['text'], url: reply['video_url'] } })
+        end
+
+        def file
+          check_text_length
+
+          format_response(type: 'file', content: { file: { caption: reply['text'], url: reply['file_url'] } })
+        end
+
+        def location
+          check_text_length
+
+          format_response(type: 'location', content: { location: { latitude: reply['latitude'], longitude: reply['longitude'] } })
+        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.messagebird.channel_id.to_s,
+            to: recipient_id.to_s
+          }
+          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'
+              I18n.t(
+                "stealth.messagebird.text_option",
+                text: button['text'],
+                option: button['payload'],
+                default: "For %{text}: Text %{option}"
+              )
+            when 'call'
+              "#{button['text']}: #{button['phone_number']}"
+            end
+          end.compact
+
+          sms_buttons
+        end
+      end
+    end
+  end
+end

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

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

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

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

@@ -0,0 +1 @@
+require 'stealth/messagebird'

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

data/stealth-messagebird.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 = 'stealth-messagebird'
+  s.summary = 'Stealth MessageBird Whatsapp driver'
+  s.description = 'MessageBird Whatsapp driver for Stealth.'
+  s.homepage = 'https://github.com/emorissettegregoire/stealth-messagebird'
+  s.licenses = ['MIT']
+  s.version = version
+  s.author = 'Emilie Morissette'
+  s.email = 'emorissettegregoire@gmail.com'
+
+  s.add_dependency 'stealth', '>= 2.0.0.beta'
+  s.add_dependency 'messagebird-rest', '1.4.2'
+
+  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,131 @@
+--- !ruby/object:Gem::Specification
+name: stealth-messagebird
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- 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.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: messagebird-rest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+- !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: MessageBird Whatsapp driver for Stealth.
+email: emorissettegregoire@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- VERSION
+- lib/stealth-messagebird.rb
+- lib/stealth/messagebird.rb
+- lib/stealth/services/messagebird/client.rb
+- lib/stealth/services/messagebird/message_handler.rb
+- lib/stealth/services/messagebird/messagebird_service_message.rb
+- lib/stealth/services/messagebird/reply_handler.rb
+- lib/stealth/services/messagebird/setup.rb
+- lib/stealth/services/messagebird/version.rb
+- spec/spec_helper.rb
+- spec/version_spec.rb
+- stealth-messagebird.gemspec
+homepage: https://github.com/emorissettegregoire/stealth-messagebird
+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 MessageBird Whatsapp driver
+test_files:
+- spec/spec_helper.rb
+- spec/version_spec.rb