outbox-bandwidth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 795ddc3b92fe3d399e8628c635e202a8d8d004ee23a830386450aa7c1ac4d224
+  data.tar.gz: 908e1f5e20edae4ec276a8464ab8820d3a7fc8ab9784b3c02c52708dbf0933fd
+SHA512:
+  metadata.gz: 738d34f68f434df58f3c62d10407e3ba87231fa53001bd0568ca245fa6f14734cb9e761b2d587cb585dcc49a5c331707e261787228b1fae30c88d76945d3e942
+  data.tar.gz: 2a5775769b1c4bc79ff3e3dc92aff28c7a10cf08ff34152bd4ee47f0acf38dbfc23fb8e017ff26153f384de9f0379f82fd7c061b1354c9fc5fcfb1b3e84e7ed4

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  Exclude:
+    - 'vendor/**/*'
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Naming/FileName:
+  Exclude:
+    - 'lib/outbox-bandwidth.rb'
+
+Layout/LineLength:
+  IgnoreCopDirectives: true
+  Max: 100

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+cache: bundler
+language: ruby
+rvm:
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in outbox-bandwidth.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2020 LocalMed
+
+MIT License
+
+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/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/outbox/bandwidth.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'outbox'
+
+module Outbox
+  module Bandwidth
+    require 'outbox/bandwidth/version'
+    require 'outbox/bandwidth/client'
+  end
+
+  Messages::SMS.register_client_alias(:bandwidth, Outbox::Bandwidth::Client)
+end

data/lib/outbox/bandwidth/client.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'bandwidth'
+
+module Outbox
+  module Bandwidth
+    # Uses Bandwidth's official Ruby API client (bandwidth) to deliver
+    # SMS messages.
+    #
+    #   Outbox::Messages::SMS.default_client(
+    #     :bandwidth,
+    #     account_sid: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+    #     token: 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy',
+    #     secret: 'zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz'
+    #   )
+    #   sms = Outbox::Messages::SMS.new(
+    #     to: '+15552224444',
+    #     from: '+15551115555',
+    #     body: 'Hello World'
+    #   )
+    #   sms.deliver
+    class Client < Outbox::Clients::Base
+      attr_reader :api_client
+      include ::Bandwidth::Messaging
+
+      def initialize(settings = nil)
+        super
+
+        options = @settings.dup
+        @api_client = ::Bandwidth::Client.new(
+          messaging_basic_auth_user_name: options[:token],
+          messaging_basic_auth_password: options[:secret]
+        )
+        @account_id = options[:subaccount_id] || options[:account_id]
+      end
+
+      def deliver(sms)
+        messaging_client = @api_client.messaging_client.client
+        body = ::Bandwidth::MessageRequest.new
+        body.application_id = sms[:application_id]
+        body.to = sms.to
+        body.from = sms.from
+        body.text = sms.body
+        body.media = [sms[:media_url]] unless sms[:media_url].nil?
+        messaging_client.create_message(account_id(sms), body: body)
+      end
+
+      protected
+
+      def account_id(sms)
+        return sms[:account_id] unless sms[:account_id].nil?
+        @account_id
+      end
+    end
+  end
+end

data/lib/outbox/bandwidth/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Outbox
+  module Bandwidth
+    VERSION = '0.1.0'
+  end
+end

data/outbox-bandwidth.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'outbox/bandwidth/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'outbox-bandwidth'
+  spec.version = Outbox::Bandwidth::VERSION
+  spec.authors = ['Pete Browne', 'Kemp Travis']
+  spec.email = ['pete.browne@localmed.com']
+  spec.summary = 'Outbox SMS client for Bandwidth.'
+  spec.description = 'Bandwidth API wrapper for Outbox, a generic interface for sending notificatons.'
+  spec.homepage = 'https://github.com/localmed/outbox-bandwidth'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'bandwidth-sdk', '~> 3.9.0'
+  spec.add_runtime_dependency 'outbox', '~> 0.2'
+  spec.add_development_dependency 'bundler', '>= 1.6'
+  spec.add_development_dependency 'rake', '~> 12.0.0'
+  spec.add_development_dependency 'rspec', '~> 3.5.0'
+  spec.add_development_dependency 'rubocop', '~> 0.82.0'
+end

data/outbox-bandwidth.rb

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

data/spec/outbox/bandwidth/client_spec.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'ostruct'
+
+describe Outbox::Bandwidth::Client do
+  describe '.new' do
+    it 'configures the Bandwidth API client' do
+      api_client = double(:api_client)
+      expect(::Bandwidth::Client).to receive(:new).with(
+        messaging_basic_auth_user_name: 'AC1',
+        messaging_basic_auth_password: 'abcdef'
+      ).and_return(api_client)
+      client = Outbox::Bandwidth::Client.new(
+        token: 'AC1',
+        secret: 'abcdef'
+      )
+      expect(client.api_client).to be(api_client)
+    end
+  end
+
+  describe '#deliver' do
+    before do
+      @messaging_client = double(:messaging_client)
+      @api_client = double(:api_client)
+      @body = double(:body)
+      allow(::Bandwidth::MessageRequest).to receive(:new).and_return(@body)
+      allow(::Bandwidth::Client).to receive(:new).with(
+        messaging_basic_auth_user_name: 'AC1',
+        messaging_basic_auth_password: 'abcdef'
+      ).and_return(@api_client)
+      @client = Outbox::Bandwidth::Client.new(
+        token: 'AC1',
+        secret: 'abcdef',
+        account_id: 'account_1'
+      )
+      @sms = Outbox::Messages::SMS.new do
+        to '+14155551212'
+        from 'Company Name'
+        body 'Hello world.'
+      end
+    end
+
+    it 'delivers the SMS' do
+      expect(@body).to receive(:application_id=)
+      expect(@body).to receive(:to=)
+      expect(@body).to receive(:from=)
+      expect(@body).to receive(:text=)
+      expect(@api_client).to receive_message_chain(:messaging_client, :client) { @messaging_client }
+      expect(@messaging_client).to receive(:create_message).with(
+        'account_1',
+        body: @body
+      )
+      @client.deliver(@sms)
+    end
+
+    context 'with a subaccount' do
+      it 'delivers the SMS from the subaccount' do
+        @sms[:account_id] = 'subaccount_id_1'
+        expect(@body).to receive(:application_id=)
+        expect(@body).to receive(:to=)
+        expect(@body).to receive(:from=)
+        expect(@body).to receive(:text=)
+        expect(@api_client).to receive_message_chain(:messaging_client, :client) { @messaging_client }
+        expect(@messaging_client).to receive(:create_message).with(
+          'subaccount_id_1',
+          body: @body
+        )
+        @client.deliver(@sms)
+      end
+    end
+  end
+end

data/spec/outbox/bandwidth_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Outbox::Bandwidth do
+  it 'has a version number' do
+    expect(Outbox::Bandwidth::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'outbox/bandwidth'

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: outbox-bandwidth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pete Browne
+- Kemp Travis
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bandwidth-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: outbox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.82.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.82.0
+description: Bandwidth API wrapper for Outbox, a generic interface for sending notificatons.
+email:
+- pete.browne@localmed.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- Rakefile
+- lib/.DS_Store
+- lib/outbox/.DS_Store
+- lib/outbox/bandwidth.rb
+- lib/outbox/bandwidth/.DS_Store
+- lib/outbox/bandwidth/client.rb
+- lib/outbox/bandwidth/version.rb
+- outbox-bandwidth.gemspec
+- outbox-bandwidth.rb
+- spec/outbox/bandwidth/client_spec.rb
+- spec/outbox/bandwidth_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/localmed/outbox-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.3
+signing_key:
+specification_version: 4
+summary: Outbox SMS client for Bandwidth.
+test_files:
+- spec/outbox/bandwidth/client_spec.rb
+- spec/outbox/bandwidth_spec.rb
+- spec/spec_helper.rb