cellular 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2b557a411a9a042061ab2725cc29921a353cf55
-  data.tar.gz: b3c248d7b158b41ce1015f68431b395e1c278db8
+  metadata.gz: 795f3cf5910cae941deac18841ab94e637597054
+  data.tar.gz: 20b41bc30ceee340d9daa9b129ce456c518d5e78
 SHA512:
-  metadata.gz: d4cf9e5c7b6b22d90ed3cc99d60fbb9d44051d6e789b33463136bfceeaf0202ce012a248a946e07a3ef4892d1fa699dab57b8d557027a3b921cbc252aa360ca7
-  data.tar.gz: 0850f3123d23661353059947a672e2a56ba5774d2e90b2e0d856fd5658a3dd55f5be341092bf2bf4259d31230b13b183fcb9eff460aeedc98d4eb6bfd9589680
+  metadata.gz: 9d6de54b0843941760b6c9cd0a728a80d37d357d728cd3a999e703754bf315aad26395da9834272fd3cf3513b3e92066d5cca2c7e0f2588bddfea59e014c12e7
+  data.tar.gz: 7b2cb314b60c8c43e646b50c2005ce98e86132002c3db9d92df124b27339c35312c5fb7dace0956fa0f37dbb401be1ce952e13314f6e02f9f9c576dcb2d425cc

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1.0
 script: bundle exec rake spec

data/LICENSE.md

@@ -1,6 +1,6 @@
 Licensed under the **MIT** license
 
-> Copyright (c) 2014 Hyper
+> Copyright (c) 2014 Hyper Interaktiv AS
 >
 > Permission is hereby granted, free of charge, to any person obtaining
 > a copy of this software and associated documentation files (the

data/README.md

@@ -1,14 +1,14 @@
 # Cellular
 
-[![Gem Version](https://badge.fury.io/rb/cellular.png)](https://rubygems.org/gems/cellular)
-[![Build Status](https://secure.travis-ci.org/hyperoslo/cellular.png?branch=master)](https://travis-ci.org/hyperoslo/cellular)
-[![Dependency Status](https://gemnasium.com/hyperoslo/cellular.png)](https://gemnasium.com/hyperoslo/cellular)
-[![Code Climate](https://codeclimate.com/github/hyperoslo/cellular.png)](https://codeclimate.com/github/hyperoslo/cellular)
-[![Coverage Status](https://coveralls.io/repos/hyperoslo/cellular/badge.png?branch=master)](https://coveralls.io/r/hyperoslo/cellular)
+[![Gem Version](https://img.shields.io/gem/v/cellular.svg?style=flat)](https://rubygems.org/gems/cellular)
+[![Build Status](https://img.shields.io/travis/hyperoslo/cellular.svg?style=flat)](https://travis-ci.org/hyperoslo/cellular)
+[![Dependency Status](https://img.shields.io/gemnasium/hyperoslo/cellular.svg?style=flat)](https://gemnasium.com/hyperoslo/cellular)
+[![Code Climate](https://img.shields.io/codeclimate/github/hyperoslo/cellular.svg?style=flat)](https://codeclimate.com/github/hyperoslo/cellular)
+[![Coverage Status](https://img.shields.io/coveralls/hyperoslo/cellular.svg?style=flat)](https://coveralls.io/r/hyperoslo/cellular)
 
 Sending and receiving SMSs with Ruby through pluggable backends.
 
-**Supported Ruby versions: 1.9.3 or higher**
+**Supported Ruby versions: 2.0.0 or higher**
 
 Licensed under the **MIT** license, see LICENSE for more information.
 
@@ -38,14 +38,17 @@ Cellular.configure do |config|
   config.password = 'password'
   config.backend  = Cellular::Backends::Sendega
   config.sender = 'Default custom sender'
+  config.country_code = 'NO'
 end
 ```
 
 
 ### Available Backends
 
-* CoolSMS (http://coolsms.com/)
-* Sendega (http://sendega.com/)
+* [CoolSMS](http://coolsms.com/)
+* [Sendega](http://sendega.com/)
+* Log (logs to `$stdout`)
+* Test (adds messages to `Cellular.deliveries`)
 
 
 ### Sending SMSs
@@ -56,12 +59,34 @@ The options supported may differ between backends.
 sms = Cellular::SMS.new(
   recipient: '47xxxxxxxx',
   sender: 'Custom sender',
-  message: 'This is an SMS message'
+  message: 'This is an SMS message',
+  price: 0,
+  country_code: 'NO' # defaults to Cellular.config.country_code
 )
 
 sms.deliver
 ```
 
+You can also use Sidekiq to send texts, which is great if you're in a Rails app
+and are concerned that it might time out or something. Actually, if you have
+Sidekiq at your disposal, it's a great idea anyway! To use it, just call
+`deliver_later` instead of `deliver` on the SMS object:
+
+```ruby
+sms = Cellular::SMS.new(
+  recipient: '47xxxxxxxx',
+  sender: 'Custom sender',
+  message: 'This is an SMS message'
+)
+
+sms.deliver_later
+```
+
+This will create a Sidekiq job for you on the **cellular** queue, so make sure
+that Sidekiq is processing that queue.
+
+[sidekiq]: http://sidekiq.org
+
 
 ## Contributing
 

data/cellular.gemspec

@@ -22,13 +22,16 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'httparty', '~> 0.13.0'
   gem.add_dependency 'savon',    '~> 2.0'
 
-  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'pry', '~> 0.10'
 
-  gem.add_development_dependency 'guard'
-  gem.add_development_dependency 'guard-rspec'
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'webmock'
+  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'
 
-  gem.add_development_dependency 'coveralls'
-  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'sidekiq', '~> 3.2'
+  gem.add_development_dependency 'rspec-rails', '~> 2.99'
+
+  gem.add_development_dependency 'coveralls', '~> 0.7'
+  gem.add_development_dependency 'simplecov', '~> 0.9'
 end

data/lib/cellular.rb

@@ -2,10 +2,13 @@ require 'cellular/version'
 require 'cellular/configuration'
 require 'cellular/models/sms'
 require 'cellular/backends'
+require 'cellular/jobs'
 
 module Cellular
+  @deliveries = []
 
   class << self
+    attr_accessor :deliveries
     attr_accessor :config
 
     def configure

data/lib/cellular/backends.rb

@@ -2,5 +2,7 @@ module Cellular
   module Backends
     autoload :CoolSMS, 'cellular/backends/cool_sms'
     autoload :Sendega, 'cellular/backends/sendega'
+    autoload :Log,     'cellular/backends/log'
+    autoload :Test,    'cellular/backends/test'
   end
 end

data/lib/cellular/backends/log.rb

@@ -0,0 +1,13 @@
+module Cellular
+  module Backends
+    class Log
+      def self.deliver(options = {})
+        $stdout.puts options[:message]
+      end
+
+      def self.receive(data)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/cellular/backends/sendega.rb

@@ -32,7 +32,7 @@ module Cellular
         # 9007 -- Demo account empty
         #
         # See Gate API Documentation:
-        # http://www.sendega.no/downloads/Sendega%20API%20documentation%20v2.0.pdf
+        # http://controlpanel.sendega.no/Content/Sendega%20-%20API%20documentation%20v2.3.pdf
 
         savon_options[:wsdl] = GATEWAY_URL
 

data/lib/cellular/backends/test.rb

@@ -0,0 +1,13 @@
+module Cellular
+  module Backends
+    class Test
+      def self.deliver(options = {})
+        Cellular.deliveries << options[:message]
+      end
+
+      def self.receive(data)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/cellular/jobs.rb

@@ -0,0 +1,10 @@
+begin
+  require "sidekiq"
+rescue LoadError
+end
+
+module Cellular
+  module Jobs
+    require 'cellular/jobs/async_messenger'
+  end
+end

data/lib/cellular/jobs/async_messenger.rb

@@ -0,0 +1,15 @@
+class Cellular::Jobs::AsyncMessenger
+  include Sidekiq::Worker
+
+  sidekiq_options queue: :cellular, retry: false
+
+  def perform(sms_options)
+    sms_options.keys.each do |key|
+      sms_options[key.to_sym] = sms_options.delete key
+    end
+
+    sms = Cellular::SMS.new sms_options
+    sms.deliver
+  end
+
+end

data/lib/cellular/models/sms.rb

@@ -1,7 +1,7 @@
 module Cellular
   class SMS
 
-    attr_accessor :recipient, :sender, :message, :price, :country
+    attr_accessor :recipient, :sender, :message, :price, :country_code
 
     def initialize(options = {})
       @backend = Cellular.config.backend
@@ -10,23 +10,20 @@ module Cellular
       @sender = options[:sender] || Cellular.config.sender
       @message = options[:message]
       @price = options[:price] || Cellular.config.price
-      @country = options[:country] || Cellular.config.country_code
+      @country_code = options[:country_code] || Cellular.config.country_code
 
       @delivered = false
     end
 
     def deliver
-      @delivery_status, @delivery_message = @backend.deliver(
-        recipient: @recipient,
-        sender: @sender,
-        price: @price,
-        country: @country,
-        message: @message
-      )
-
+      @delivery_status, @delivery_message = @backend.deliver options
       @delivered = true
     end
 
+    def deliver_later
+      Cellular::Jobs::AsyncMessenger.perform_async options
+    end
+
     def save(options = {})
       raise NotImplementedError
     end
@@ -38,6 +35,28 @@ module Cellular
     def delivered?
       @delivered
     end
+    
+    def country
+      warn "[DEPRECATION] 'country' is deprecated; use 'country_code' instead"
+      @country_code
+    end
+
+    def country=(country)
+      warn "[DEPRECATION] 'country' is deprecated; use 'country_code' instead"
+      @country_code = country
+    end
+
+    private
+
+    def options
+      {
+        recipient: @recipient,
+        sender: @sender,
+        message: @message,
+        price: @price,
+        country_code: @country_code
+      }
+    end
 
   end
 end

data/lib/cellular/version.rb

@@ -1,3 +1,3 @@
 module Cellular
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/spec/cellular/backends/log_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Cellular::Backends::Log do
+
+  let(:recipient) { '47xxxxxxxx' }
+  let(:sender)    { 'Custom sender' }
+  let(:message)   { 'This is an SMS message' }
+  let(:price)     { 100 }
+  let(:country)   { 'NO '}
+
+  let(:options) {
+    {
+      recipient: recipient,
+      sender: sender,
+      message: message,
+      price: price
+    }
+  }
+
+  before do
+    Cellular.config.username = 'username'
+    Cellular.config.password = 'password'
+    Cellular.config.delivery_url = nil
+  end
+
+  describe '::deliver' do
+    let(:deliveries) { Cellular.deliveries }
+
+    it 'logs the message' do
+      expect(STDOUT).to receive(:puts)
+      described_class.deliver(options)
+    end
+  end
+
+  describe '::receive' do
+    it 'has not been implemented yet' do
+      expect do
+        described_class.receive ''
+      end.to raise_error NotImplementedError
+    end
+  end
+
+end

data/spec/cellular/backends/test_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe Cellular::Backends::Test do
+
+  let(:recipient) { '47xxxxxxxx' }
+  let(:sender)    { 'Custom sender' }
+  let(:message)   { 'This is an SMS message' }
+  let(:price)     { 100 }
+  let(:country)   { 'NO '}
+
+  let(:options) {
+    {
+      recipient: recipient,
+      sender: sender,
+      message: message,
+      price: price
+    }
+  }
+
+  before do
+    Cellular.config.username = 'username'
+    Cellular.config.password = 'password'
+    Cellular.config.delivery_url = nil
+  end
+
+  describe '::deliver' do
+    let(:deliveries) { Cellular.deliveries }
+    let(:delivery)   { deliveries.first }
+
+    before do
+      Cellular.deliveries.clear
+    end
+
+    it 'appends the message to deliveries' do
+      described_class.deliver message: 'This is a message'
+      expect(deliveries.count).to eq 1
+    end
+
+    it 'stores the message of the message' do
+      described_class.deliver message: 'This is a message'
+      expect(delivery).to eq 'This is a message'
+    end
+  end
+
+  describe '::receive' do
+    it 'has not been implemented yet' do
+      expect do
+        described_class.receive ''
+      end.to raise_error NotImplementedError
+    end
+  end
+
+end

data/spec/cellular/jobs/async_messenger_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Cellular::Jobs::AsyncMessenger do
+  let(:sms_stub)    { double "SMS", deliver: true }
+  let(:sms_options) { { "recipient" => "12345678", "text" => "Foo" } }
+
+  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
+  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
+  end
+end

data/spec/cellular/models/sms_spec.rb

@@ -2,11 +2,11 @@ require 'spec_helper'
 
 describe Cellular::SMS do
 
-  let(:recipient) { '47xxxxxxxx' }
-  let(:sender)    { 'Custom sender' }
-  let(:message)   { 'This is an SMS message' }
-  let(:price)     { 100 }
-  let(:country)   { 'NO'}
+  let(:recipient)    { '47xxxxxxxx' }
+  let(:sender)       { 'Custom sender' }
+  let(:message)      { 'This is an SMS message' }
+  let(:price)        { 100 }
+  let(:country_code) { 'NO'}
 
   subject do
     described_class.new(
@@ -14,7 +14,7 @@ describe Cellular::SMS do
       sender: sender,
       message: message,
       price: price,
-      country: country
+      country_code: country_code
     )
   end
 
@@ -23,11 +23,11 @@ describe Cellular::SMS do
   end
 
   describe '#initialize' do
-    its(:recipient) { should eq recipient }
-    its(:sender)    { should eq sender }
-    its(:message)   { should eq message }
-    its(:price)     { should eq price }
-    its(:country)   { should eq country }
+    its(:recipient)    { should eq recipient }
+    its(:sender)       { should eq sender }
+    its(:message)      { should eq message }
+    its(:price)        { should eq price }
+    its(:country_code) { should eq country_code }
 
     it { should_not be_delivered }
 
@@ -58,7 +58,7 @@ describe Cellular::SMS do
 
       subject { described_class.new }
 
-      its(:country) { should eq 'NL' }
+      its(:country_code) { should eq 'NL' }
     end
   end
 
@@ -68,7 +68,7 @@ describe Cellular::SMS do
         recipient: recipient,
         sender: sender,
         price: price,
-        country: country,
+        country_code: country_code,
         message: message
       )
     end
@@ -79,6 +79,25 @@ describe Cellular::SMS do
     end
   end
 
+  describe "#deliver_later" do
+    it "calls out to the Sidekiq job to send the SMS" do
+      sms_options = {
+        receiver: "12345678",
+        message: "Test SMS"
+      }
+
+      expect(Cellular::Jobs::AsyncMessenger)
+        .to receive(:perform_async)
+        .with sms_options
+
+      sms = Cellular::SMS.new sms_options
+
+      allow(sms).to receive(:options).and_return sms_options
+
+      sms.deliver_later
+    end
+  end
+
   describe '#save' do
     it 'has not been implemented yet' do
       expect do
@@ -95,4 +114,29 @@ describe Cellular::SMS do
     end
   end
 
+  describe '#country' do
+    it 'issues a deprecation warning' do
+      expect(subject).to receive(:warn)
+      subject.country
+    end
+
+    it 'returns country_code' do
+      allow(subject).to receive(:warn)
+      expect(subject.country).to eq(subject.country_code)
+    end
+  end
+
+  describe '#country=' do
+    it 'issues a deprecation warning' do
+      expect(subject).to receive(:warn)
+      subject.country = 'Test'
+    end
+
+    it 'assigns country_code' do
+      allow(subject).to receive(:warn)
+      subject.country = 'Test'
+      expect(subject.country_code).to eq('Test')
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cellular
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Sindre Moen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-05 00:00:00.000000000 Z
+date: 2014-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -43,100 +43,128 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.19'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.99'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.99'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 description: Sending and receiving SMSs through pluggable backends
 email:
 - johannes@hyper.no
@@ -145,7 +173,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rspec"
 - ".travis.yml"
 - Gemfile
 - Guardfile
@@ -156,13 +183,20 @@ files:
 - lib/cellular.rb
 - lib/cellular/backends.rb
 - lib/cellular/backends/cool_sms.rb
+- lib/cellular/backends/log.rb
 - lib/cellular/backends/sendega.rb
+- lib/cellular/backends/test.rb
 - lib/cellular/configuration.rb
+- lib/cellular/jobs.rb
+- lib/cellular/jobs/async_messenger.rb
 - lib/cellular/models/sms.rb
 - lib/cellular/version.rb
 - spec/cellular/backends/cool_sms_spec.rb
+- spec/cellular/backends/log_spec.rb
 - spec/cellular/backends/sendega_spec.rb
+- spec/cellular/backends/test_spec.rb
 - spec/cellular/configuration_spec.rb
+- spec/cellular/jobs/async_messenger_spec.rb
 - spec/cellular/models/sms_spec.rb
 - spec/cellular_spec.rb
 - spec/fixtures/backends/cool_sms/failure.xml
@@ -191,14 +225,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Sending and receiving SMSs through pluggable backends
 test_files:
 - spec/cellular/backends/cool_sms_spec.rb
+- spec/cellular/backends/log_spec.rb
 - spec/cellular/backends/sendega_spec.rb
+- spec/cellular/backends/test_spec.rb
 - spec/cellular/configuration_spec.rb
+- spec/cellular/jobs/async_messenger_spec.rb
 - spec/cellular/models/sms_spec.rb
 - spec/cellular_spec.rb
 - spec/fixtures/backends/cool_sms/failure.xml

data/.rspec

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