outbox-twilio 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f76b2573c58081b5482e6d6c6cb737a7a7b6e61c
+  data.tar.gz: d189ed5b419e0c30d3a59f69e07d67022fe1732a
+SHA512:
+  metadata.gz: c75f9d19ae1d5163a7d7f0b09fa328d7c0b013077d06e7cf676846eaee24d271b04a8d16afa12ea86e8053c2e9388bf87a99af03d0f07b953466ab814f92fcb9
+  data.tar.gz: d463c686af3d5be49db8d514fd0eda925405fedebb15b625ec6e9de459c38cfff57880da303c4cbf5414bfd4be566005a04084dbd8cf7790f02776202f42ec18

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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in outbox-twilio.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 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/README.md

@@ -0,0 +1,61 @@
+Outbox::Twilio
+==============
+
+[![Gem Version](https://badge.fury.io/rb/outbox-twilio.png)](http://badge.fury.io/rb/outbox-twilio)
+
+Twilio SMS client wrapper for [Outbox](https://github.com/localmed/outbox).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'outbox-twilio'
+```
+
+And then execute:
+
+``` bash
+$ bundle
+```
+
+Or install it yourself as:
+
+``` bash
+$ gem install outbox-twilio
+```
+
+## Usage
+
+Configure Outbox to use Outbox::Twilio as the default SMS client:
+
+``` ruby
+Outbox::Messages::SMS.default_client(
+  :twilio,
+  account_sid: 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+  auth_token: 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy',
+  # Supports other Twilio::REST::Client options:
+  timeout: 30,
+  retry_limit: 1
+)
+```
+
+SMS messages will now use the Twilio API for devlivery:
+
+``` ruby
+sms = Outbox::Messages::SMS.new(
+  from: '+15551115555',
+  body: 'Hello World',
+  # supports Twilio's non-standard parameters:
+  media_url: 'https://www.example.com/hearts.png'
+)
+sms.deliver('+15552224444')
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/localmed/outbox-twilio/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/lib/outbox-twilio.rb

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

data/lib/outbox/twilio.rb

@@ -0,0 +1,10 @@
+require 'outbox'
+
+module Outbox
+  module Twilio
+    require 'outbox/twilio/version'
+    require 'outbox/twilio/client'
+  end
+
+  Messages::SMS.register_client_alias(:twilio, Outbox::Twilio::Client)
+end

data/lib/outbox/twilio/client.rb

@@ -0,0 +1,46 @@
+require 'twilio-ruby'
+
+module Outbox
+  module Twilio
+    # Uses Twilio's official Ruby API client (twilio-ruby) to deliver
+    # SMS messages.
+    #
+    #   Outbox::Messages::SMS.default_client(
+    #     :twilio,
+    #     account_sid: 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+    #     auth_token: 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
+    #   )
+    #   sms = Outbox::Messages::SMS.new(
+    #     from: '+15551115555',
+    #     body: 'Hello World'
+    #   )
+    #   sms.deliver('+15552224444')
+    class Client < Outbox::Clients::Base
+      attr_reader :api_client
+
+      def initialize(settings = nil)
+        super
+
+        options = @settings.dup
+        @api_client = ::Twilio::REST::Client.new(
+          options.delete(:account_sid),
+          options.delete(:auth_token),
+          options
+        )
+      end
+
+      def deliver(sms)
+        params = {
+          from: sms.from,
+          to: sms.to,
+          body: sms.body,
+          media_url: sms[:media_url],
+          status_callback: sms[:status_callback],
+          application_sid: sms[:application_sid]
+        }
+        params.delete_if { |_, value| value.nil? }
+        @api_client.account.messages.create(params)
+      end
+    end
+  end
+end

data/lib/outbox/twilio/version.rb

@@ -0,0 +1,5 @@
+module Outbox
+  module Twilio
+    VERSION = '0.2.0'
+  end
+end

data/outbox-twilio.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'outbox/twilio/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'outbox-twilio'
+  spec.version       = Outbox::Twilio::VERSION
+  spec.authors       = ['Pete Browne']
+  spec.email         = ['pete.browne@localmed.com']
+  spec.summary       = %q{Outbox SMS client for Twilio.}
+  spec.description   = %q{Twilio API wrapper for Outbox, a generic interface for sending notificatons.}
+  spec.homepage      = 'https://github.com/localmed/outbox-twilio'
+  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 'outbox', '~> 0.2'
+  spec.add_runtime_dependency 'twilio-ruby', '~> 3.11'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+end

data/spec/outbox/twilio/client_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Outbox::Twilio::Client do
+  describe '.new' do
+    it 'configures the Twilio API client' do
+      api_client = double(:api_client)
+      expect(::Twilio::REST::Client).to receive(:new).with(
+        'AC1',
+        'abcdef',
+        timeout: 5,
+        retry_limit: 2
+      ).and_return(api_client)
+      client = Outbox::Twilio::Client.new(
+        account_sid: 'AC1',
+        auth_token: 'abcdef',
+        timeout: 5,
+        retry_limit: 2
+      )
+      expect(client.api_client).to be(api_client)
+    end
+  end
+
+  describe '#deliver' do
+    before do
+      @client = Outbox::Twilio::Client.new(
+        account_sid: 'AC1',
+        auth_token: 'abcdef'
+      )
+      @sms = Outbox::Messages::SMS.new do
+        to '+14155551212'
+        from 'Company Name'
+        body 'Hello world.'
+      end
+      @sms[:media_url] = 'http://www.example.com/hearts.png'
+      @sms[:status_callback] = 'http://www.example.com/callback'
+      @sms[:application_sid] = '1234'
+    end
+
+    it 'delivers the SMS' do
+      expect(@client.api_client.account.messages).to receive(:create).with(
+        to: '+14155551212',
+        from: 'Company Name',
+        body: 'Hello world.',
+        media_url: 'http://www.example.com/hearts.png',
+        status_callback: 'http://www.example.com/callback',
+        application_sid: '1234'
+      )
+      @client.deliver(@sms)
+    end
+  end
+end

data/spec/outbox/twilio_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Outbox::Twilio do
+  it 'has a version number' do
+    expect(Outbox::Twilio::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'outbox/twilio'

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: outbox-twilio
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Pete Browne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-20 00:00:00.000000000 Z
+dependencies:
+- !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: twilio-ruby
+  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: 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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Twilio API wrapper for Outbox, a generic interface for sending notificatons.
+email:
+- pete.browne@localmed.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/outbox-twilio.rb
+- lib/outbox/twilio.rb
+- lib/outbox/twilio/client.rb
+- lib/outbox/twilio/version.rb
+- outbox-twilio.gemspec
+- spec/outbox/twilio/client_spec.rb
+- spec/outbox/twilio_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/localmed/outbox-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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Outbox SMS client for Twilio.
+test_files:
+- spec/outbox/twilio/client_spec.rb
+- spec/outbox/twilio_spec.rb
+- spec/spec_helper.rb