cellular 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6797a5f2c6ccf1a9f71167bad98a54eeed77d729
-  data.tar.gz: 03dd1fcc61fd35ab0bfebee9a40b181fe731dff5
+  metadata.gz: 4d69945358dbd5a90eda81aee664adfffe7a971a
+  data.tar.gz: d0cccde1eb19cc6d1eb8b54d2414ee21815f02f0
 SHA512:
-  metadata.gz: 14a1c8bf8e47f83eaa088cecf5efc867b60b76c5578b7b8236ed3897821018b85dc8b726bb969556bd72648e44aab42ce12324954f0c5a260a96475eae8b192b
-  data.tar.gz: 1554bbe7f7d214a02aa49c0de8d3c58c6155bc0738e9d79ab1d2ce088b4ae75873d51a3b992775e6cf877af96386e86f118efea8240e0022ba44d027f18ca119
+  metadata.gz: 1e752bde39f9752f58f4e5c09aa2eb73a431c19066324aeb69a45930b83393aa59e042e5afe8549c5c23c749bdf5d390880273b977cee25a8f0c959080cb255f
+  data.tar.gz: 87d001976dbefd1fc8b7bc76f6e01007ebe23e17f28ec74f0a2ac37c6d8b9fdab0de2cd5b7c623935bfb7487c11e928b4b17fe6e4c35a6d506e1f254201821b2

data/.gitignore

@@ -1,2 +1,4 @@
 Gemfile.lock
+coverage/
 pkg/
+vendor/cache/

data/.rspec

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

data/.travis.yml

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

data/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})          { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/support/(.+)\.rb$}) { 'spec' }
+  watch('spec/spec_helper.rb')       { 'spec' }
+end

data/README.md

@@ -1,8 +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)
+
 Sending and receiving SMSs with Ruby through pluggable backends.
 
-**Supported Ruby versions: 1.9 or higher**
+**Supported Ruby versions: 1.9.3 or higher**
 
 Licensed under the **MIT** license, see LICENSE for more information.
 
@@ -24,7 +30,37 @@ Or install it yourself as:
 
 ## Usage
 
-Usage instructions to follow shortly.
+### Configuration
+
+```ruby
+Cellular.configure do |config|
+  config.username = 'username'
+  config.password = 'password'
+  config.backend  = Cellular::Backends::Sendega
+end
+```
+
+
+### Available Backends
+
+* CoolSMS (http://coolsms.com/)
+* Sendega (http://sendega.com/)
+
+
+### Sending SMSs
+
+The options supported may differ between backends.
+
+```ruby
+sms = Cellular::SMS.new(
+  recipient: '47xxxxxxxx',
+  sender: 'Custom sender',
+  country: 'NO',
+  message: 'This is an SMS message'
+)
+
+sms.deliver
+```
 
 
 ## Contributing
@@ -33,4 +69,4 @@ Usage instructions to follow shortly.
 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
+5. Create pull request

data/Rakefile

@@ -1 +1,9 @@
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+task test: :spec
+task default: :spec

data/cellular.gemspec

@@ -19,7 +19,16 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.add_dependency 'savon'
+  gem.add_dependency 'httparty', '~> 0.13.0'
+  gem.add_dependency 'savon',    '~> 2.0'
 
   gem.add_development_dependency 'pry'
+
+  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 'coveralls'
+  gem.add_development_dependency 'simplecov'
 end

data/lib/cellular/backends.rb

@@ -1,5 +1,6 @@
 module Cellular
   module Backends
+    autoload :CoolSMS, 'cellular/backends/cool_sms'
     autoload :Sendega, 'cellular/backends/sendega'
   end
 end

data/lib/cellular/backends/cool_sms.rb

@@ -0,0 +1,33 @@
+require 'httparty'
+
+module Cellular
+  module Backends
+    class CoolSMS
+
+      # Documentation: http://www.coolsms.com/support/dokumentation/http-gateway.sms
+      GATEWAY_URL = 'https://sms.coolsmsc.dk/'
+
+      def self.deliver(options = {})
+        query = {
+          username: Cellular.config.username,
+          password: Cellular.config.password,
+          from: options[:sender],
+          to: options[:recipient],
+          message: options[:message],
+          charset: 'utf-8',
+          resulttype: 'xml',
+          lang: 'en'
+        }
+
+        result = HTTParty.get(GATEWAY_URL, query: query)
+        response = result.parsed_response['smsc']
+
+        [
+          response['status'],
+          response['result'] || response['message']['result']
+        ]
+      end
+
+    end
+  end
+end

data/lib/cellular/backends/sendega.rb

@@ -6,7 +6,7 @@ module Cellular
 
       GATEWAY_URL = 'https://smsc.sendega.com/Content.asmx?WSDL'
 
-      def self.deliver(options = {})
+      def self.deliver(options = {}, savon_options = {})
         # Send an SMS and return its initial delivery status code.
         #
         # Delivery status codes:
@@ -34,7 +34,9 @@ module Cellular
         # See Gate API Documentation:
         # http://www.sendega.no/downloads/Sendega%20API%20documentation%20v2.0.pdf
 
-        client = Savon.client wsdl: GATEWAY_URL
+        savon_options[:wsdl] = GATEWAY_URL
+
+        client = Savon.client savon_options
 
         result = client.call(:send, message: {
             username: Cellular.config.username,
@@ -43,13 +45,13 @@ module Cellular
             destination: options[:recipient],
             pricegroup: options[:price] || 0, # default price to 0
             contentTypeID: 1,
-            contentHeader: "",
+            contentHeader: '',
             content: options[:message],
             dlrUrl: Cellular.config.delivery_url,
             ageLimit: 0,
-            extID: "",
-            sendDate: "",
-            refID: "",
+            extID: '',
+            sendDate: '',
+            refID: '',
             priority: 0,
             gwID: 0,
             pid: 0,
@@ -57,10 +59,18 @@ module Cellular
           }
         )
 
-        if result.success?
-          [ result.body[:error_number], 'Message is received and is being processed.' ]
+        body = result.body[:send_response][:send_result]
+
+        if body[:success]
+          [
+            body[:error_number].to_i,
+            'Message is received and is being processed.'
+          ]
         else
-          [ result.body[:error_number], result.body[:error_message] ]
+          [
+            body[:error_number].to_i,
+            body[:error_message]
+          ]
         end
       end
 

data/lib/cellular/models/sms.rb

@@ -27,11 +27,11 @@ module Cellular
       @delivered = true
     end
 
-    def save(options)
+    def save(options = {})
       raise NotImplementedError
     end
 
-    def receive(options)
+    def receive(options = {})
       raise NotImplementedError
     end
 

data/lib/cellular/version.rb

@@ -1,3 +1,3 @@
 module Cellular
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/spec/cellular/backends/cool_sms_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Cellular::Backends::CoolSMS do
+
+  let(:recipient) { '47xxxxxxxx' }
+  let(:sender)    { 'Custom sender' }
+  let(:message)   { 'This is an SMS message' }
+
+  let(:options) {
+    {
+      recipient: recipient,
+      sender: sender,
+      message: message
+    }
+  }
+
+  before do
+    Cellular.config.username = 'username'
+    Cellular.config.password = 'password'
+  end
+
+  describe '::deliver' do
+    before do
+      stub_request(:get, 'https://sms.coolsmsc.dk/?charset=utf-8&from=Custom%20sender&lang=en&message=This%20is%20an%20SMS%20message&password=password&resulttype=xml&to=47xxxxxxxx&username=username').
+        to_return headers: { 'Content-Type' => 'text/xml' }, body: fixture('backends/cool_sms/success.xml')
+    end
+
+    it 'uses HTTParty to deliver an SMS' do
+      expect(HTTParty).to receive(:get).with(described_class::GATEWAY_URL, query: {
+        username: 'username',
+        password: 'password',
+        from: sender,
+        to: recipient,
+        message: message,
+        charset: 'utf-8',
+        resulttype: 'xml',
+        lang: 'en'
+      }).and_call_original
+
+      described_class.deliver(options)
+    end
+
+    context 'when successful' do
+      it 'returns success and a message' do
+        expect(described_class.deliver(options)).to eq [
+          'success',
+          'The message was sent correctly.'
+        ]
+      end
+    end
+
+    context 'when not successful' do
+      before do
+        stub_request(:get, 'https://sms.coolsmsc.dk/?charset=utf-8&from=Custom%20sender&lang=en&message=This%20is%20an%20SMS%20message&password=password&resulttype=xml&to=47xxxxxxxx&username=username').
+          to_return headers: { 'Content-Type' => 'text/xml' }, body: fixture('backends/cool_sms/failure.xml')
+      end
+
+      it 'returns failure and a message' do
+        expect(described_class.deliver(options)).to eq [
+          'failure',
+          'Access denied.'
+        ]
+      end
+    end
+  end
+
+end

data/spec/cellular/backends/sendega_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe Cellular::Backends::Sendega 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
+    }
+  }
+  let(:savon_options) {
+    {
+      log: false
+    }
+  }
+
+  before do
+    stub_request(:get, described_class::GATEWAY_URL).
+      to_return body: fixture('backends/sendega/service.wsdl')
+
+    Cellular.config.username = 'username'
+    Cellular.config.password = 'password'
+    Cellular.config.delivery_url = nil
+  end
+
+  describe '::deliver' do
+    it 'uses Savon to deliver an SMS' do
+      client = double()
+      Savon.stub(:client).and_return client
+
+      result = double(body: {send_response: {send_result: {}}})
+
+      expect(client).to receive(:call).with(:send, message: {
+        username: Cellular.config.username,
+        password: Cellular.config.password,
+        sender: sender,
+        destination: recipient,
+        pricegroup: price,
+        contentTypeID: 1,
+        contentHeader: '',
+        content: message,
+        dlrUrl: nil,
+        ageLimit: 0,
+        extID: '',
+        sendDate: '',
+        refID: '',
+        priority: 0,
+        gwID: 0,
+        pid: 0,
+        dcs: 0
+      }).and_return result
+
+      described_class.deliver(options, savon_options)
+    end
+
+    context 'when successful' do
+      before do
+        stub_request(:post, 'https://smsc.sendega.com/Content.asmx').
+          to_return body: fixture('backends/sendega/success.xml')
+      end
+
+      it 'returns a success code and a message' do
+        expect(described_class.deliver(options, savon_options)).to eq [
+          0,
+          'Message is received and is being processed.'
+        ]
+      end
+    end
+
+    context 'when not successful' do
+      before do
+        stub_request(:post, 'https://smsc.sendega.com/Content.asmx').
+          to_return body: fixture('backends/sendega/failure.xml')
+      end
+
+      it 'returns an error code and a message' do
+        expect(described_class.deliver(options, savon_options)).to eq [
+          9001,
+          'Not validated - Username and password does not match (e)'
+        ]
+      end
+    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/configuration_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Cellular::Configuration do
+
+  it { should respond_to :username= }
+  it { should respond_to :username }
+  it { should respond_to :password= }
+  it { should respond_to :password }
+  it { should respond_to :delivery_url= }
+  it { should respond_to :delivery_url }
+  it { should respond_to :backend= }
+  it { should respond_to :backend }
+
+end

data/spec/cellular/models/sms_spec.rb

@@ -0,0 +1,68 @@
+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 '}
+
+  subject do
+    described_class.new(
+      recipient: recipient,
+      sender: sender,
+      message: message,
+      price: price,
+      country: country
+    )
+  end
+
+  before do
+    Cellular.config.backend = Cellular::Backends::Sendega
+  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 }
+
+    it { should_not be_delivered }
+  end
+
+  describe '#deliver' do
+    before do
+      expect(Cellular::Backends::Sendega).to receive(:deliver).with(
+        recipient: recipient,
+        sender: sender,
+        price: price,
+        country: country,
+        message: message
+      )
+    end
+
+    it 'uses configured backend and marks SMS as delivered' do
+      subject.deliver
+      expect(subject).to be_delivered
+    end
+  end
+
+  describe '#save' do
+    it 'has not been implemented yet' do
+      expect do
+        subject.save
+      end.to raise_error NotImplementedError
+    end
+  end
+
+  describe '#receive' do
+    it 'has not been implemented yet' do
+      expect do
+        subject.receive
+      end.to raise_error NotImplementedError
+    end
+  end
+
+end