cellular 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a97fa1c32bf2c1aea85c36bd15bb489b9aaa20d9
-  data.tar.gz: a3190fd32b63a7cf284228d0b37481429ce30da4
+  metadata.gz: 798ef5b207911f8698d8199cc06900afd9304152
+  data.tar.gz: 4854425f3b5a9348c2e42f1786991a4887c3f0a5
 SHA512:
-  metadata.gz: 359c6728df2bd17dafc5be5d0f04704ab7a394084ee3e0ace41f112ef48733c9883cd4ad08654a83c03d83a15d06b1fa43e215afb61d3fe628cf8f07118f310c
-  data.tar.gz: 610ac72f15d403b628dd60cdd70ffcb301dea9297402ec6c0d6c00ec0edfae128bfd962837c14993bffcf1dc95a0c1e6d6295772ae57c32682603f0c174e541c
+  metadata.gz: c902309c6f7ec95b0bc5dd478f87fbcceb8cce9a8046e79a1318ee757d978cd19d47e54507eca6bebcf420c98f31ad16756f4da602674133ab2de041ff981ea8
+  data.tar.gz: bb89b59775574a107503149b0a0a089d493b7157e77050a41f4413b232ab0c8867c1b3bcdeee5884b49b9be64ff3cbc8c6a4198cab0d30d28f4085d97259c0ed

data/.travis.yml

@@ -1,7 +1,5 @@
 language: ruby
 rvm:
-  - 2.0.0
-  - 2.1.0
   - 2.2.2
   - 2.3.0
 script: bundle exec rake spec

data/cellular.gemspec

@@ -10,18 +10,18 @@ Gem::Specification.new do |gem|
   gem.version       = Cellular::VERSION
   gem.authors       = ['Sindre Moen', 'Tim Kurvers']
   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.description   = 'Sending and receiving SMSs through pluggable backends'
+  gem.summary       = 'Sending and receiving SMSs through pluggable backends'
   gem.homepage      = ''
 
   gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.add_dependency 'httparty', '~> 0.13.0'
+  gem.add_dependency 'httparty', '~> 0.13'
   gem.add_dependency 'savon',    '~> 2.0'
-  gem.add_dependency 'rails',    '>= 4.2'
+  gem.add_dependency 'rails',    '~> 4.2'
 
   gem.add_development_dependency 'pry', '~> 0.10'
 

data/lib/cellular.rb

@@ -4,6 +4,7 @@ require 'cellular/models/sms'
 require 'cellular/backends'
 require 'cellular/jobs'
 
+# Sending and receiving SMSs through pluggable backends
 module Cellular
   autoload :Logger, 'cellular/logger'
 
@@ -21,5 +22,4 @@ module Cellular
       @config ||= Configuration.new
     end
   end
-
 end

data/lib/cellular/backends.rb

@@ -1,10 +1,12 @@
 module Cellular
+  # Encapsulates all available backends for Cellular
   module Backends
     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'
+    autoload :Twilio, 'cellular/backends/twilio'
+    autoload :LinkMobility, 'cellular/backends/link_mobility'
+    autoload :Log, 'cellular/backends/log'
+    autoload :Test, 'cellular/backends/test'
   end
 end

data/lib/cellular/backends/backend.rb

@@ -1,11 +1,12 @@
 module Cellular
   module Backends
+    # Base class for a Cellular backend
     class Backend
-      def self.deliver(options = {})
+      def self.deliver(_options = {})
         raise NotImplementedError
       end
 
-      def self.receive(data)
+      def self.receive(_data)
         raise NotImplementedError
       end
     end

data/lib/cellular/backends/cool_sms.rb

@@ -2,17 +2,17 @@ require 'httparty'
 
 module Cellular
   module Backends
+    # Cool SMS backend (http://www.coolsms.com)
     class CoolSMS < Backend
-
       # Documentation: http://www.coolsms.com/support/dokumentation/http-gateway.sms
-      GATEWAY_URL = 'https://sms.coolsmsc.dk/'
+      GATEWAY_URL = 'https://sms.coolsmsc.dk/'.freeze
 
       def self.deliver(options = {})
         request_queue = {}
 
         recipients_batch(options).each_with_index do |recipient, index|
           options[:batch] = recipient
-          result = HTTParty.get(GATEWAY_URL, query: defaults_with(options) )
+          result = HTTParty.get(GATEWAY_URL, query: defaults_with(options))
           request_queue[index] = {
             recipient: recipient,
             response: parse_response(result.parsed_response['smsc'])
@@ -55,7 +55,6 @@ module Cellular
           options[:recipients]
         end
       end
-
     end
   end
 end

data/lib/cellular/backends/link_mobility.rb

@@ -0,0 +1,72 @@
+require 'httparty'
+
+module Cellular
+  module Backends
+    # LinkMobility backend (https://www.linkmobility.com)
+    class LinkMobility < Backend
+      # Documentation: https://www.linkmobility.com/developers/
+      BASE_URL = 'https://wsx.sp247.net/'.freeze
+
+      HTTP_HEADERS = {
+        'Content-Type' => 'application/json; charset=utf-8',
+      }.freeze
+
+      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: link_mobility_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['description']
+        ]
+      end
+
+      def self.sms_url
+        "#{BASE_URL}sms/send"
+      end
+
+      def self.link_mobility_config
+        {
+          username: Cellular.config.username,
+          password: Cellular.config.password
+        }
+      end
+
+      def self.payload(options)
+        {
+          source: options[:sender],
+          destination: options[:batch],
+          userData: options[:message],
+          platformId: 'COMMON_API',
+          platformPartnerId: Cellular.config.partner_id,
+        }.to_json
+      end
+
+      def self.recipients_batch(options)
+        if options[:recipients].blank?
+          [options[:recipient]]
+        else
+          options[:recipients]
+        end
+      end
+    end
+  end
+end

data/lib/cellular/backends/log.rb

@@ -1,5 +1,6 @@
 module Cellular
   module Backends
+    # Writes SMS messages to configured logger
     class Log < Backend
       def self.deliver(options = {})
         Cellular.config.logger.info options[:message]

data/lib/cellular/backends/sendega.rb

@@ -2,9 +2,9 @@ require 'savon'
 
 module Cellular
   module Backends
+    # Sendega backend (http://sendega.com)
     class Sendega < Backend
-
-      GATEWAY_URL = 'https://smsc.sendega.com/Content.asmx?WSDL'
+      GATEWAY_URL = 'https://smsc.sendega.com/Content.asmx?WSDL'.freeze
 
       def self.deliver(options = {}, savon_options = {})
         # Send an SMS and return its initial delivery status code.
@@ -45,7 +45,7 @@ module Cellular
           request_queue[index] = {
             batch: batch,
             result: result,
-            body:result.body[:send_response][:send_result],
+            body: result.body[:send_response][:send_result],
             response: map_response(result.body[:send_response][:send_result])
           }
         end
@@ -54,20 +54,20 @@ module Cellular
         request_queue[0][:response]
       end
 
-      def self.receive(data)
+      def self.receive(_data)
         raise NotImplementedError
       end
 
       def self.savon_config
         {
-           username: Cellular.config.username,
-           password: Cellular.config.password,
-           dlrUrl: Cellular.config.delivery_url
+          username: Cellular.config.username,
+          password: Cellular.config.password,
+          dlrUrl: Cellular.config.delivery_url
         }
       end
 
       def self.defaults_with(options)
-       {
+        {
           sender: options[:sender],
           destination: options[:batch],
           pricegroup: options[:price] || 0, # default price to 0
@@ -85,9 +85,9 @@ module Cellular
         }.merge!(savon_config)
       end
 
-      def self.map_response(_body)
-        msg = _body[:success] ?  success_message : _body[:error_message]
-        [ _body[:error_number].to_i, msg ]
+      def self.map_response(body)
+        msg = body[:success] ? success_message : body[:error_message]
+        [body[:error_number].to_i, msg]
       end
 
       def self.success_message
@@ -98,10 +98,9 @@ module Cellular
         if options[:recipients].blank?
           [options[:recipient]]
         else
-          options[:recipients].each_slice(100).to_a.map{|x| x.join(',') }
+          options[:recipients].each_slice(100).to_a.map { |x| x.join(',') }
         end
       end
-
     end
   end
 end

data/lib/cellular/backends/test.rb

@@ -1,5 +1,6 @@
 module Cellular
   module Backends
+    # Test backend appends deliveries to Cellular.deliveries
     class Test < Backend
       def self.deliver(options = {})
         Cellular.deliveries << options[:message]

data/lib/cellular/backends/twilio.rb

@@ -2,10 +2,11 @@ require 'httparty'
 
 module Cellular
   module Backends
+    # Twilio backend (https://www.twilio.com)
     class Twilio < Backend
       # Documentation: https://www.twilio.com/docs/api/rest
-      API_VERSION = '2010-04-01'
-      BASE_URL = 'https://api.twilio.com/'
+      API_VERSION = '2010-04-01'.freeze
+      BASE_URL = 'https://api.twilio.com/'.freeze
       API_URL = BASE_URL + API_VERSION
 
       HTTP_HEADERS = {
@@ -14,7 +15,7 @@ module Cellular
         'User-Agent' => "cellular/#{Cellular::VERSION}" \
         " (#{RUBY_ENGINE}/#{RUBY_PLATFORM}" \
         " #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL})"
-      }
+      }.freeze
 
       def self.deliver(options = {})
         request_queue = {}
@@ -71,7 +72,6 @@ module Cellular
           options[:recipients]
         end
       end
-
     end
   end
 end

data/lib/cellular/configuration.rb

@@ -1,15 +1,12 @@
 module Cellular
+  # Configuration for Cellular
   class Configuration
-
     attr_accessor :username, :password, :delivery_url, :backend
-
-    attr_accessor :country_code, :price, :sender
-    
+    attr_accessor :country_code, :price, :sender, :partner_id
     attr_accessor :logger
-    
+
     def logger
       @logger ||= Object.const_defined?(:Rails) ? Rails.logger : Logger.new
     end
-
   end
 end

data/lib/cellular/jobs.rb

@@ -1,9 +1,10 @@
 begin
-  require "sidekiq"
+  require 'sidekiq'
 rescue LoadError
 end
 
 module Cellular
+  # Encapsulates all background job implementations
   module Jobs
     require 'cellular/jobs/async_messenger'
   end

data/lib/cellular/jobs/async_messenger.rb

@@ -1,5 +1,6 @@
 require 'active_job'
 
+# Delivers SMSs asynchronously through ActiveJob
 class Cellular::Jobs::AsyncMessenger < ActiveJob::Base
   queue_as :cellular
 

data/lib/cellular/logger.rb

@@ -1,12 +1,9 @@
 module Cellular
-
-  # An API compatible logger when not in a rails environment
-  # logs to stdout
+  # API compatible logger when not in a Rails environment
+  # Logs to stdout
   class Logger
     def info(message)
       $stdout.puts message
     end
   end
-
 end
-

data/lib/cellular/models/sms.rb

@@ -1,10 +1,11 @@
 require 'active_support/time'
 
 module Cellular
+  # Represents an SMS
   class SMS
-
     attr_accessor :recipient, :sender, :message, :price, :country_code
     attr_accessor :recipients, :delivery_status, :delivery_message
+
     def initialize(options = {})
       @backend = Cellular.config.backend
 
@@ -24,15 +25,17 @@ module Cellular
     end
 
     def deliver_async(delivery_options = {})
-      Cellular::Jobs::AsyncMessenger.set(delivery_options).perform_later(options)
+      Cellular::Jobs::AsyncMessenger.set(delivery_options)
+                                    .perform_later(options)
     end
+
     alias_method :deliver_later, :deliver_async
 
-    def save(options = {})
+    def save(_options = {})
       raise NotImplementedError
     end
 
-    def receive(options = {})
+    def receive(_options = {})
       raise NotImplementedError
     end
 
@@ -52,6 +55,5 @@ module Cellular
         country_code: @country_code
       }
     end
-
   end
 end

data/lib/cellular/version.rb

@@ -1,3 +1,3 @@
 module Cellular
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'.freeze
 end

data/spec/cellular/backends/backend_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Cellular::Backends::Backend do
+  describe '::deliver' do
+    it 'has not been implemented yet' do
+      expect do
+        described_class.deliver
+      end.to raise_error NotImplementedError
+    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/cool_sms_spec.rb

@@ -1,20 +1,19 @@
 require 'spec_helper'
 
 describe Cellular::Backends::CoolSMS do
-
   let(:recipient) { '47xxxxxxxx' }
   let(:sender)    { 'Custom sender' }
   let(:message)   { 'This is an SMS message' }
 
-  let(:options) {
+  let(:options) do
     {
       recipient: recipient,
       sender: sender,
       message: message
     }
-  }
+  end
 
-  let(:payload) {
+  let(:payload) do
     {
       username: 'username',
       password: 'password',
@@ -25,7 +24,7 @@ describe Cellular::Backends::CoolSMS do
       resulttype: 'xml',
       lang: 'en'
     }
-  }
+  end
 
   before do
     Cellular.config.username = 'username'
@@ -34,13 +33,15 @@ describe Cellular::Backends::CoolSMS do
 
   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')
+      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:
-        payload).and_call_original
+      expect(HTTParty).to receive(:get).with(
+        described_class::GATEWAY_URL,
+        query: payload
+      ).and_call_original
 
       described_class.deliver(options)
     end
@@ -56,8 +57,8 @@ describe Cellular::Backends::CoolSMS do
 
     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')
+        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
@@ -70,12 +71,14 @@ describe Cellular::Backends::CoolSMS do
   end
 
   describe '::parse_response' do
-    it 'should return the correct response' do
+    it 'returns the correct response' do
       message = ['success', 'The message was sent correctly.']
 
       check = { 'status' => message[0], 'result' => message[1] }
-      second_check =  { 'status' => message[0],
-                        'message' => { 'result' => message[1] } }
+      second_check = {
+        'status' => message[0],
+        'message' => { 'result' => message[1] }
+      }
 
       expect(described_class.parse_response(check)).to eq(message)
       expect(described_class.parse_response(second_check)).to eq(message)
@@ -83,31 +86,32 @@ describe Cellular::Backends::CoolSMS do
   end
 
   describe '::coolsms_config' do
-    it 'should return the config for coolsms' do
+    it 'returns the config for coolsms' do
       expect(described_class.coolsms_config).to eq(
-        {
-          username: Cellular.config.username,
-          password: Cellular.config.password
-        })
+        username: Cellular.config.username,
+        password: Cellular.config.password
+      )
     end
   end
 
   describe '::defaults_with' do
-    it 'should return the whole query' do
+    it 'returns the whole query' do
       options[:batch] = recipient
       expect(described_class.defaults_with(options)).to eq(payload)
     end
   end
 
   describe '::recipients_batch' do
-    it 'should wrap recipient option into a array' do
-      expect(described_class.recipients_batch({recipient: recipient}))
-        .to eq([recipient])
+    it 'wraps recipient option into an array' do
+      result = described_class.recipients_batch(recipient: recipient)
+      expect(result).to eq([recipient])
     end
-    it 'should return recipients option as it is' do
-      expect(described_class.recipients_batch({recipients: [recipient,recipient]}))
-        .to eq([recipient,recipient])
+
+    it 'returns recipients option as-is' do
+      result = described_class.recipients_batch(
+        recipients: [recipient, recipient]
+      )
+      expect(result).to eq([recipient, recipient])
     end
   end
-
 end