cellular 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fdd4bd856508028b2de1f016627e9a107be0dd4
-  data.tar.gz: a50db77596d53823b496506604356532e9519096
+  metadata.gz: a97fa1c32bf2c1aea85c36bd15bb489b9aaa20d9
+  data.tar.gz: a3190fd32b63a7cf284228d0b37481429ce30da4
 SHA512:
-  metadata.gz: 1670df114c490aae52f7ad804656c4e3d538929f07fa7cbda5121466a4cfe637b3dcec5d39bb5c80e0a575e691842b8734bbe925011195b31a14d97dd4b746b8
-  data.tar.gz: 9403f6ab944a9e0bba7df7b26a0e18c334f8a9bf16635c1cf4835573070aa1161c54814adc84e385fc1bac203097a9afddc0c8a83c36e4ee5e28afcdc0373bbe
+  metadata.gz: 359c6728df2bd17dafc5be5d0f04704ab7a394084ee3e0ace41f112ef48733c9883cd4ad08654a83c03d83a15d06b1fa43e215afb61d3fe628cf8f07118f310c
+  data.tar.gz: 610ac72f15d403b628dd60cdd70ffcb301dea9297402ec6c0d6c00ec0edfae128bfd962837c14993bffcf1dc95a0c1e6d6295772ae57c32682603f0c174e541c

data/.travis.yml

@@ -2,4 +2,6 @@ language: ruby
 rvm:
   - 2.0.0
   - 2.1.0
+  - 2.2.2
+  - 2.3.0
 script: bundle exec rake spec

data/README.md

@@ -36,7 +36,7 @@ Or install it yourself as:
 Cellular.configure do |config|
   config.username = 'username'
   config.password = 'password'
-  config.backend  = Cellular::Backends::Sendega
+  config.backend = Cellular::Backends::Sendega
   config.sender = 'Default custom sender'
   config.country_code = 'NO'
 end
@@ -48,8 +48,9 @@ interface to interact with queue backends. Read appropriate documentation to set
 
 ### Available Backends
 
-* [CoolSMS](http://coolsms.com/)
-* [Sendega](http://sendega.com/)
+* [Cellular::Backends::CoolSMS](http://coolsms.com/)
+* [Cellular::Backends::Sendega](http://sendega.com/)
+* [Cellular::Backends::Twilio](http://twilio.com/)
 * Log (logs to `$stdout`)
 * Test (adds messages to `Cellular.deliveries`)
 
@@ -60,8 +61,8 @@ The options supported may differ between backends.
 
 ```ruby
 sms = Cellular::SMS.new(
-  recipient: '47xxxxxxxx',
-  sender: 'Custom sender',
+  recipient: '+47xxxxxxxx', # Valid international format
+  sender: '+370xxxxxxxx',
   message: 'This is an SMS message',
   price: 0,
   country_code: 'NO' # defaults to Cellular.config.country_code
@@ -73,8 +74,8 @@ For use with multiple recipients in one request use:
 
 ```ruby
 sms = Cellular::SMS.new(
-  recipients: ['47xxxxxxx1','47xxxxxxx2','47xxxxxxx3'],
-  sender: 'Custom sender',
+  recipients: ['+47xxxxxxx1','+47xxxxxxx2','+47xxxxxxx3'],
+  sender: '+370xxxxxxxx',
   message: 'This is an SMS message',
   price: 0,
   country_code: 'NO' # defaults to Cellular.config.country_code
@@ -92,8 +93,8 @@ and are concerned that it might time out or something. To use it, just call
 
 ```ruby
 sms = Cellular::SMS.new(
-  recipient: '47xxxxxxxx',
-  sender: 'Custom sender',
+  recipient: '+47xxxxxxxx',
+  sender: '+47xxxxxxxx',
   message: 'This is an SMS message'
 )
 
@@ -113,21 +114,30 @@ Just call `deliver_async(wait_until: timestamp)` or `deliver_async(wait: time)`
 
 ```ruby
 sms = Cellular::SMS.new(
-  recipient: '47xxxxxxxx',
-  sender: 'Custom sender',
+  recipient: '+47xxxxxxxx',
+  sender: '+47xxxxxxxx',
   message: 'This is an SMS message'
 )
 
 sms.deliver_async(wait_until: Date.tomorrow.noon)
 ```
 
+## Troubleshooting
+
+If you are using Twilio as a backend, please make sure you add or (port)[https://www.twilio.com/help/faq/porting] a phone number to your account so, that you can use that as a sender option. You won't be able to send messages from any phone number unless you port it to Twilio. 
+
+Also, make sure phone numbers are in valid international format: 
+[`+47xxxxxx`, `+370xxxxx`]
+
 ## Contributing
 
 1. Fork it
-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 pull request
+2. Create your feature branch (`git checkout -b feature/my-new-feature`)
+3. Write your code and necessary tests 
+4. Run your tests (`bundle exec rspec`)
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin feature/my-new-feature`)
+7. Create pull request and be awesome!
 
 
 ## Credits

data/cellular.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |gem|
   gem.name          = 'cellular'
   gem.version       = Cellular::VERSION
   gem.authors       = ['Sindre Moen', 'Tim Kurvers']
-  gem.email         = ['johannes@hyper.no']
+  gem.email         = ['ruby@hyper.no']
   gem.description   = %q{Sending and receiving SMSs through pluggable backends}
   gem.summary       = %q{Sending and receiving SMSs through pluggable backends}
   gem.homepage      = ''
@@ -25,8 +25,6 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'pry', '~> 0.10'
 
-  gem.add_development_dependency 'guard', '~> 2.6'
-  gem.add_development_dependency 'guard-rspec', '~> 4.3'
   gem.add_development_dependency 'rake', '~> 10.3'
   gem.add_development_dependency 'webmock', '~> 1.19'
 

data/lib/cellular/backends.rb

@@ -3,6 +3,7 @@ module Cellular
     autoload :Backend, 'cellular/backends/backend'
     autoload :CoolSMS, 'cellular/backends/cool_sms'
     autoload :Sendega, 'cellular/backends/sendega'
+    autoload :Twilio,  'cellular/backends/twilio'
     autoload :Log,     'cellular/backends/log'
     autoload :Test,    'cellular/backends/test'
   end

data/lib/cellular/backends/twilio.rb

@@ -0,0 +1,77 @@
+require 'httparty'
+
+module Cellular
+  module Backends
+    class Twilio < Backend
+      # Documentation: https://www.twilio.com/docs/api/rest
+      API_VERSION = '2010-04-01'
+      BASE_URL = 'https://api.twilio.com/'
+      API_URL = BASE_URL + API_VERSION
+
+      HTTP_HEADERS = {
+        'Accept' => 'application/json',
+        'Accept-Charset' => 'utf-8',
+        'User-Agent' => "cellular/#{Cellular::VERSION}" \
+        " (#{RUBY_ENGINE}/#{RUBY_PLATFORM}" \
+        " #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL})"
+      }
+
+      def self.deliver(options = {})
+        request_queue = {}
+        recipients_batch(options).each_with_index do |recipient, index|
+          options[:batch] = recipient
+          request = HTTParty.post(
+            sms_url,
+            body: payload(options),
+            basic_auth: twilio_config,
+            headers: HTTP_HEADERS
+          )
+
+          request_queue[index] = {
+            recipient: options[:batch],
+            response: parse_response(request)
+          }
+        end
+
+        # return first response for now
+        request_queue[0][:response]
+      end
+
+      def self.parse_response(response)
+        [
+          response.code,
+          response.message
+        ]
+      end
+
+      def self.sms_url
+        "#{API_URL}/Accounts/#{twilio_config[:username]}/Messages"
+      end
+
+      def self.twilio_config
+        {
+          username: Cellular.config.username,
+          password: Cellular.config.password
+        }
+      end
+
+      def self.payload(options)
+        {
+          From: options[:sender],
+          To: options[:batch],
+          Body: options[:message],
+          MaxPrice: options[:price] || 0.50
+        }
+      end
+
+      def self.recipients_batch(options)
+        if options[:recipients].blank?
+          [options[:recipient]]
+        else
+          options[:recipients]
+        end
+      end
+
+    end
+  end
+end

data/lib/cellular/models/sms.rb

@@ -4,7 +4,7 @@ module Cellular
   class SMS
 
     attr_accessor :recipient, :sender, :message, :price, :country_code
-    attr_accessor :recipients
+    attr_accessor :recipients, :delivery_status, :delivery_message
     def initialize(options = {})
       @backend = Cellular.config.backend
 

data/lib/cellular/version.rb

@@ -1,3 +1,3 @@
 module Cellular
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/spec/cellular/backends/twilio_spec.rb

@@ -0,0 +1,148 @@
+require 'spec_helper'
+
+describe Cellular::Backends::Twilio do
+
+  let(:recipient) { '+15005550004' }
+  let(:sender)    { '+15005550006' }
+  let(:message)   { 'This is an SMS message' }
+  let(:price)   { 0.001 }
+
+  let(:options) {
+    {
+      recipient: recipient,
+      sender: sender,
+      message: message,
+      price: price
+    }
+  }
+
+  let(:auth) {
+    {
+      username: 'account_sid',
+      password: 'auth_token'
+    }
+  }
+
+  let(:payload) {
+    {
+      From: sender,
+      To: recipient,
+      Body: message,
+      MaxPrice: price
+    }
+  }
+
+  before do
+    Cellular.config.username = 'account_sid'
+    Cellular.config.password = 'auth_token'
+    Cellular.config.backend = Cellular::Backends::Twilio
+  end
+
+  describe '::deliver' do
+    before do
+      stub_request(:post, "https://account_sid:auth_token@api.twilio.com/2010-04-01/Accounts/account_sid/Messages").
+       to_return(:status => [201, "CREATED"], :body => fixture('backends/twilio/success.json'), :headers => {'Content-Type' => 'application/json'})
+    end
+
+    it 'does uses HTTParty to deliver an SMS' do
+      expect(HTTParty).to receive(:post).with(described_class::sms_url, body:
+        payload, headers: described_class::HTTP_HEADERS, basic_auth: described_class::twilio_config).and_call_original
+
+      described_class.deliver(options)
+    end
+
+    context 'when successful' do
+      it 'does return a status code and message' do
+        expect(described_class.deliver(options)).to eq([
+          201,
+          'CREATED'
+        ])
+      end
+    end
+
+    context 'when not successful' do
+      before do
+        stub_request(:post, "https://account_sid:auth_token@api.twilio.com/2010-04-01/Accounts/account_sid/Messages").
+          to_return(:status => [400, "BAD REQUEST"], :body => fixture('backends/twilio/failure.json'), :headers => {'Content-Type' => 'application/json'})
+      end
+
+      it 'does return a status code and message' do
+        expect(described_class.deliver(options)).to eq([
+          400,
+          'BAD REQUEST'
+        ])
+      end
+    end
+
+  end
+
+  describe '::twilio_config' do
+    it 'does return the config for twilio' do
+      expect(described_class.twilio_config).to eq(
+        {
+          username: 'account_sid',
+          password: 'auth_token'
+        })
+    end
+  end
+
+  describe '::sms_url' do
+    it 'does return the full sms gateway url' do
+      expect(described_class.sms_url).to eq(
+        "https://api.twilio.com/2010-04-01/Accounts/account_sid/Messages"
+      )
+    end
+  end
+
+  describe '::payload' do
+    it 'does return the request payload' do
+      options[:batch] = recipient
+      expect(described_class.payload(options)).to eq(payload)
+    end
+  end
+
+  describe '::parse_response' do
+    before do
+      subject { Object.new }
+    end
+
+    context 'when not successful' do
+      it 'does return the formatted success response' do
+        subject.stub(:code).and_return(201)
+        subject.stub(:message).and_return('CREATED')
+
+        expect(described_class.parse_response(subject)).to eq(
+          [
+            201,
+            'CREATED'
+          ]
+        )
+      end
+    end
+
+    context 'when not successful' do
+      it 'does return the formatted failed response' do
+        subject.stub(:code).and_return(400)
+        subject.stub(:message).and_return('BAD REQUEST')
+
+        expect(described_class.parse_response(subject)).to eq(
+          [
+            400,
+            'BAD REQUEST'
+          ]
+        )
+      end
+    end
+  end
+
+  describe '::recipients_batch' do
+    it 'does wrap recipient option into a array' do
+      expect(described_class.recipients_batch({recipient: recipient}))
+        .to eq([recipient])
+    end
+    it 'does return recipients option as it is' do
+      expect(described_class.recipients_batch({recipients: [recipient,recipient]}))
+        .to eq([recipient,recipient])
+    end
+  end
+end

data/spec/cellular/jobs/async_messenger_spec.rb

@@ -4,21 +4,22 @@ describe Cellular::Jobs::AsyncMessenger do
   let(:sms_stub)    { double "SMS", deliver: true }
   let(:sms_options) { { "recipient" => "12345678", "text" => "Foo" } }
 
+  before do
+    allow(Cellular::SMS).to receive(:new).and_return sms_stub
+  end
+
   it 'creates a new SMS object' do
     symbolized_sms_options = { recipient: "12345678", text: "Foo" }
 
-    expect(Cellular::SMS).to receive(:new)
-      .with(symbolized_sms_options)
-      .and_return sms_stub
-
     subject.perform sms_options
+
+    expect(Cellular::SMS).to have_received(:new)
+      .with(symbolized_sms_options)
   end
 
   it "delivers the SMS" do
-    allow(Cellular::SMS).to receive(:new).and_return sms_stub
-
-    expect(sms_stub).to receive :deliver
-
     subject.perform sms_options
+
+    expect(sms_stub).to have_received :deliver
   end
 end

data/spec/fixtures/backends/twilio/failure.json

@@ -0,0 +1,10 @@
+{
+  "TwilioResponse": {
+    "RestException": {
+      "Code": "21211",
+      "Message": "The 'To' number +4475703596201 is not a valid phone number.",
+      "MoreInfo": "https://www.twilio.com/docs/errors/21211",
+      "Status": "400"
+    }
+  }
+}

data/spec/fixtures/backends/twilio/success.json

@@ -0,0 +1,28 @@
+{
+  "TwilioResponse": {
+    "Message": {
+      "Sid": "SM3576e58e202041bf8be28e4ef52cbcbc",
+      "DateCreated": "Mon, 25 Apr 2016 05:18:07 +0000",
+      "DateUpdated": "Mon, 25 Apr 2016 05:18:07 +0000",
+      "DateSent": "",
+      "AccountSid": "AC800d5bd49542346c71674b49851a1bbf",
+      "To": "+447570359620",
+      "From": "+15005550006",
+      "MessagingServiceSid": "",
+      "Body": "This is an SMS message",
+      "Status": "queued",
+      "NumSegments": "1",
+      "NumMedia": "0",
+      "Direction": "outbound-api",
+      "ApiVersion": "2010-04-01",
+      "Price": "",
+      "PriceUnit": "USD",
+      "ErrorCode": "",
+      "ErrorMessage": "",
+      "Uri": "/2010-04-01/Accounts/AC800d5bd49542346c71674b49851a1bbf/Messages/SM3576e58e202041bf8be28e4ef52cbcbc",
+      "SubresourceUris": {
+        "Media": "/2010-04-01/Accounts/AC800d5bd49542346c71674b49851a1bbf/Messages/SM3576e58e202041bf8be28e4ef52cbcbc/Media"
+      }
+    }
+  }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cellular
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Sindre Moen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-26 00:00:00.000000000 Z
+date: 2016-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -67,34 +67,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.6'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -167,7 +139,7 @@ dependencies:
         version: '0.9'
 description: Sending and receiving SMSs through pluggable backends
 email:
-- johannes@hyper.no
+- ruby@hyper.no
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -176,7 +148,6 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
-- Guardfile
 - LICENSE.md
 - README.md
 - Rakefile
@@ -188,6 +159,7 @@ files:
 - lib/cellular/backends/log.rb
 - lib/cellular/backends/sendega.rb
 - lib/cellular/backends/test.rb
+- lib/cellular/backends/twilio.rb
 - lib/cellular/configuration.rb
 - lib/cellular/jobs.rb
 - lib/cellular/jobs/async_messenger.rb
@@ -199,6 +171,7 @@ files:
 - spec/cellular/backends/log_with_rails_spec.rb
 - spec/cellular/backends/sendega_spec.rb
 - spec/cellular/backends/test_spec.rb
+- spec/cellular/backends/twilio_spec.rb
 - spec/cellular/configuration_spec.rb
 - spec/cellular/jobs/async_messenger_spec.rb
 - spec/cellular/logger_spec.rb
@@ -209,6 +182,8 @@ files:
 - spec/fixtures/backends/sendega/failure.xml
 - spec/fixtures/backends/sendega/service.wsdl
 - spec/fixtures/backends/sendega/success.xml
+- spec/fixtures/backends/twilio/failure.json
+- spec/fixtures/backends/twilio/success.json
 - spec/spec_helper.rb
 - spec/support/fixture.rb
 homepage: ''
@@ -230,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Sending and receiving SMSs through pluggable backends
@@ -240,6 +215,7 @@ test_files:
 - spec/cellular/backends/log_with_rails_spec.rb
 - spec/cellular/backends/sendega_spec.rb
 - spec/cellular/backends/test_spec.rb
+- spec/cellular/backends/twilio_spec.rb
 - spec/cellular/configuration_spec.rb
 - spec/cellular/jobs/async_messenger_spec.rb
 - spec/cellular/logger_spec.rb
@@ -250,5 +226,7 @@ test_files:
 - spec/fixtures/backends/sendega/failure.xml
 - spec/fixtures/backends/sendega/service.wsdl
 - spec/fixtures/backends/sendega/success.xml
+- spec/fixtures/backends/twilio/failure.json
+- spec/fixtures/backends/twilio/success.json
 - spec/spec_helper.rb
 - spec/support/fixture.rb

data/Guardfile

@@ -1,23 +0,0 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-guard :rspec, cmd: 'bundle exec rspec', notification: false do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
-
-  # Rails example
-  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
-  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
-  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
-  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
-  watch('config/routes.rb')                           { "spec/routing" }
-  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
-
-  # Capybara features specs
-  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
-
-  # Turnip features and steps
-  watch(%r{^spec/acceptance/(.+)\.feature$})
-  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
-end