locasms 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60e250741b0ad19b1575ac0df29f653a873ed06c
-  data.tar.gz: 64c7461b17fc5d20fcf1289348928a4b7b6b1417
+  metadata.gz: 4e825f5f5729560432aadb5e7874521af3d24219
+  data.tar.gz: 483c62ac2142f95a4b71ee203ad347a496df7920
 SHA512:
-  metadata.gz: 8fe09dc0cf3bd959a5cfac85b21d3eacec7d4b173aefaa7b9ab7de4c1ce37035e17a3fb6ba28b7b3c7a66c516e86ae2f5230d21eb736e9f0a70e004a60ebdda3
-  data.tar.gz: a454160d6e5557b120f497aee2dd6915a42bfe833bb1d12c1db4513812b39082fd2dec434913310d218dc685fe30cbfc1333c2319a81ffdfe08426f3b02b1cd7
+  metadata.gz: a313fd05ed21ec051f30aec10e71fd9b028372745676c06e22327154622fff0a6cb06a1726ddbf9120cdeadf831f30d3c51bd68fb88b59d70721dccf2b13a2e3
+  data.tar.gz: 459409d3696a33b69ff0f5f35aa6a73d9a7a62e9f8be27a031a043511c2a778d23e7dfa11f52f3f498cd13a2c5caa921d5324379b3281648254d868573439170

data/.travis.yml

@@ -1,9 +1,9 @@
 language: ruby
 rvm:
-  - 2.0
-  - 2.1
-  - 2.2
+  - 2.4
   - 2.3
+  - 2.2
+  - 2.1
 env:
   - TRAVIS=true
-
+before_install: gem install bundler -v 1.15.4

data/README.md

@@ -32,6 +32,9 @@ cli = LocaSMS::Client.new 'LOGIN', 'PASSWORD'
 # Short Code:
 cli = LocaSMS::Client.new 'LOGIN', 'PASSWORD', type: :shortcode
 
+# With default url callback (optional):
+cli = LocaSMS::Client.new 'LOGIN', 'PASSWORD', url_callback: 'http://url.to/callback'
+
 # delivering message to one mobile
 cli.deliver 'my message', '1155559999'
 
@@ -41,6 +44,9 @@ cli.deliver 'my message', '1199998888', '5500002222'
 cli.deliver 'my message', ['1199998888', '5500002222']
 cli.deliver 'my message', %w(1199998888 5500002222)
 
+# delivering message with url callback
+cli.deliver 'my message', '1155559999', url_callback: 'http://url.to/callback'
+
 # scheduling the deliver of a message to one mobile
 cli.deliver_at 'my message', '2013-10-12 20:33:00', '1155559999'
 
@@ -50,6 +56,9 @@ cli.deliver_at 'my message', '2013-10-12 20:33:00', '1199998888', '5500002222'
 cli.deliver_at 'my message', '2013-10-12 20:33:00', ['1199998888', '5500002222']
 cli.deliver_at 'my message', '2013-10-12 20:33:00', %w(1199998888 5500002222)
 
+# scheduling the deliver of a message with url callback
+cli.deliver_at 'my message', '2013-10-12 20:33:00', '1155559999', url_callback: 'http://url.to/callback'
+
 # geting the remaining balance
 cli.balance
 

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'locasms'
+
+require 'irb'
+IRB.start

data/lib/locasms/client.rb

@@ -11,7 +11,7 @@ module LocaSMS
       shortcode: "http://#{DOMAIN}/shortcode/api.ashx"
     }.freeze
 
-    attr_reader :login, :password, :type
+    attr_reader :login, :password, :type, :callback
 
     # @param [String] login authorized user
     # @param [String] password access password
@@ -20,8 +20,9 @@ module LocaSMS
     def initialize(login, password, opts={})
       @login    = login
       @password = password
-      @type = opts[:type] || :default
-      @rest = opts[:rest_client]
+      @type     = opts[:type] || :default
+      @rest     = opts[:rest_client]
+      @callback = opts[:url_callback]
     end
 
     # Sends a message to one or more mobiles
@@ -29,8 +30,13 @@ module LocaSMS
     # @param [String,Array<String>] mobiles number of the mobiles to address the message
     # @return [String] campaign id on success
     # @raise [LocaSMS::Exception] if bad numbers were given
-    def deliver(message, *mobiles)
-      rest.get(:sendsms, msg: message, numbers: numbers(mobiles))['data']
+    def deliver(message, *mobiles, **opts)
+      attrs = {
+        msg: message,
+        numbers: numbers(mobiles),
+        url_callback: callback
+      }.merge(opts)
+      rest.get(:sendsms, attrs)['data']
     end
 
     # Schedule the send of a message to one or more mobiles
@@ -39,9 +45,16 @@ module LocaSMS
     # @param [String,Array<String>] mobiles number of the mobiles to address the message
     # @return UNDEF
     # @raise [LocaSMS::Exception] if bad numbers were given
-    def deliver_at(message, datetime, *mobiles)
+    def deliver_at(message, datetime, *mobiles, **opts)
       date, time = Helpers::DateTimeHelper.split datetime
-      rest.get(:sendsms, msg: message, numbers: numbers(mobiles), jobdate: date, jobtime: time)['data']
+      attrs = {
+        msg: message,
+        numbers: numbers(mobiles),
+        jobdate: date,
+        jobtime: time,
+        url_callback: callback
+      }.merge(opts)
+      rest.get(:sendsms, attrs)['data']
     end
 
     # Get de current amount of sending credits

data/lib/locasms/rest_client.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'net/http'
 
 module LocaSMS
 
@@ -39,7 +40,11 @@ module LocaSMS
     # @raise [LocaSMS::InvalidLogin] when the given credentials are invalid
     def get(action, params={})
       params   = params_for action, params
-      response = ::RestClient.get base_url, params: params
+
+      uri = URI.parse(base_url)
+      uri.query = URI.encode_www_form(params)
+      response = Net::HTTP.get_response(uri).body
+
       parse_response(action, response)
     end
 
@@ -56,7 +61,7 @@ module LocaSMS
     #
     # @see https://github.com/mcorp/locasms/wiki/A-API-de-envio#lista-das-a%C3%A7%C3%B5es-dispon%C3%ADveis List of avaiable actions
     def params_for(action, params={})
-      {action: action}.merge(base_params).merge(params)
+      { action: action }.merge(base_params).merge(params).select {|k, v| v }
     end
 
     # Parses a result trying to get it in json
@@ -77,4 +82,4 @@ module LocaSMS
     end
   end
 
-end
+end

data/lib/locasms/version.rb

@@ -1,3 +1,3 @@
 module LocaSMS
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/locasms.rb

@@ -1,17 +1,16 @@
 require 'locasms/version'
 
-autoload :CSV,        'csv'
-autoload :JSON,       'json'
-autoload :RestClient, 'rest_client'
-autoload :Logger,     'logger'
+autoload :CSV,    'csv'
+autoload :JSON,   'json'
+autoload :Logger, 'logger'
 
 module LocaSMS
-  autoload :Client, 'locasms/client'
-  autoload :Exception, 'locasms/exception'
-  autoload :InvalidLogin, 'locasms/exception'
+  autoload :Client,           'locasms/client'
+  autoload :Exception,        'locasms/exception'
+  autoload :InvalidLogin,     'locasms/exception'
   autoload :InvalidOperation, 'locasms/exception'
-  autoload :Numbers, 'locasms/numbers'
-  autoload :RestClient, 'locasms/rest_client'
+  autoload :Numbers,          'locasms/numbers'
+  autoload :RestClient,       'locasms/rest_client'
 
   module Helpers
     autoload :DateTimeHelper, 'locasms/helpers/date_time_helper'

data/locasms.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = LocaSMS::VERSION
   spec.authors       = ["Adilson Carvalho", "Leonardo Saraiva", "Marco Carvalho"]
   spec.email         = ["lc.adilson@gmail.com", "vyper@maneh.org", "marco.carvalho.swasthya@gmail.com"]
-  spec.description   = %q{Cliente para o serviço de disparo de SMS da LocaSMS e de sua 
+  spec.description   = %q{Cliente para o serviço de disparo de SMS da LocaSMS e de sua
                           versão para Short Code SMS (SMS Plataforma)}
   spec.summary       = %q{Cliente para disparo de SMS, regular e Short Code, através da LocaSMS/SMS Plataforma}
   spec.homepage      = "https://github.com/mcorp/locasms"
@@ -19,25 +19,19 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake', '~> 10.4.2'
+  spec.required_ruby_version = '~> 2.0'
 
-  # test stuff
-  spec.add_development_dependency 'rspec', '~> 3.2'
-  spec.add_development_dependency 'fuubar', '~> 2.0.0'
-  spec.add_development_dependency 'timecop', '~> 0.7.3'
+  spec.add_development_dependency 'bundler',   '~> 1.15'
+  spec.add_development_dependency 'rake',      '~> 12.1'
 
-  # run tests automatically
-  spec.add_development_dependency 'guard'
-  spec.add_development_dependency 'guard-rspec'
-  spec.add_development_dependency 'growl'
+  # test stuff
+  spec.add_development_dependency 'rspec',     '~> 3.6'
+  spec.add_development_dependency 'timecop',   '~> 0.9'
 
   # for documentation
-  spec.add_development_dependency 'yard'
-  spec.add_development_dependency 'redcarpet'
+  spec.add_development_dependency 'yard',      '~> 0.9'
+  spec.add_development_dependency 'redcarpet', '~> 3.4'
 
   # for code coverage
-  spec.add_development_dependency 'simplecov'
-
-  spec.add_dependency 'rest-client', '~> 1.6'
+  spec.add_development_dependency 'simplecov', '~> 0.15'
 end

data/spec/lib/locasms/client_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe LocaSMS::Client do
   let(:rest_client) { 'rest_client mock' }
-  subject { LocaSMS::Client.new :login, :password, rest_client: rest_client }
+  subject { LocaSMS::Client.new :login, :password, rest_client: rest_client, callback: nil }
 
   describe '::ENDPOINT' do
     let(:domain) { LocaSMS::Client::DOMAIN }
@@ -14,7 +14,7 @@ describe LocaSMS::Client do
       end
     end
 
-    context 'When default' do
+    context 'When shortcode' do
       subject { LocaSMS::Client.new :login, :password, type: :shortcode }
 
       it 'Should return the short code URL' do
@@ -38,7 +38,7 @@ describe LocaSMS::Client do
 
       expect(rest_client).to receive(:get)
         .once
-        .with(:sendsms, msg: 'given message', numbers:'XXX')
+        .with(:sendsms, msg: 'given message', numbers:'XXX', url_callback: nil)
         .and_return({})
 
       subject.deliver 'given message', :a, :b, :c
@@ -54,6 +54,40 @@ describe LocaSMS::Client do
 
       expect { subject.deliver('given message', :a, :b, :c) }.to raise_error(LocaSMS::Exception)
     end
+
+    context 'with callback option' do
+      context 'callback given as arg to #deliver' do
+        it 'uses specific callback' do
+          expect(subject).to receive(:numbers)
+            .once
+            .with([:a, :b, :c])
+            .and_return('XXX')
+
+          expect(rest_client).to receive(:get)
+            .once
+            .with(:sendsms, msg: 'given message', numbers:'XXX', url_callback: 'something')
+            .and_return({})
+
+          subject.deliver 'given message', :a, :b, :c, url_callback: 'something'
+        end
+      end
+
+      it 'uses default callback' do
+        client = LocaSMS::Client.new :login, :password, rest_client: rest_client, url_callback: 'default'
+
+        expect(client).to receive(:numbers)
+          .once
+          .with([:a, :b, :c])
+          .and_return('XXX')
+
+        expect(rest_client).to receive(:get)
+          .once
+          .with(:sendsms, msg: 'given message', numbers:'XXX', url_callback: 'default')
+          .and_return({})
+
+        client.deliver 'given message', :a, :b, :c
+      end
+    end
   end
 
   describe '#deliver_at' do
@@ -70,7 +104,7 @@ describe LocaSMS::Client do
 
       expect(rest_client).to receive(:get)
         .once
-        .with(:sendsms, msg: 'given message', numbers:'XXX', jobdate: 'date', jobtime: 'time')
+        .with(:sendsms, msg: 'given message', numbers:'XXX', jobdate: 'date', jobtime: 'time', url_callback: nil)
         .and_return({})
 
       subject.deliver_at 'given message', :datetime, :a, :b, :c
@@ -91,6 +125,50 @@ describe LocaSMS::Client do
 
       expect { subject.deliver_at('given message', :datetime, :a, :b, :c) }.to raise_error(LocaSMS::Exception)
     end
+
+    context 'with callback option' do
+      context 'callback given as arg to #deliver' do
+        it 'uses specific callback' do
+          expect(subject).to receive(:numbers)
+            .once
+            .with([:a, :b, :c])
+            .and_return('XXX')
+
+          expect(LocaSMS::Helpers::DateTimeHelper).to receive(:split)
+            .once
+            .with(:datetime)
+            .and_return(%w[date time])
+
+          expect(rest_client).to receive(:get)
+            .once
+            .with(:sendsms, msg: 'given message', numbers:'XXX', jobdate: 'date', jobtime: 'time', url_callback: 'something')
+            .and_return({})
+
+          subject.deliver_at 'given message', :datetime, :a, :b, :c, url_callback: 'something'
+        end
+      end
+
+      it 'uses default callback' do
+        client = LocaSMS::Client.new :login, :password, rest_client: rest_client, url_callback: 'default'
+
+        expect(client).to receive(:numbers)
+          .once
+          .with([:a, :b, :c])
+          .and_return('XXX')
+
+        expect(LocaSMS::Helpers::DateTimeHelper).to receive(:split)
+          .once
+          .with(:datetime)
+          .and_return(%w[date time])
+
+        expect(rest_client).to receive(:get)
+          .once
+          .with(:sendsms, msg: 'given message', numbers:'XXX', jobdate: 'date', jobtime: 'time', url_callback: 'default')
+          .and_return({})
+
+        client.deliver_at 'given message', :datetime, :a, :b, :c
+      end
+    end
   end
 
   describe '#balance' do

data/spec/lib/locasms/rest_client_spec.rb

@@ -1,6 +1,9 @@
 require 'spec_helper'
 
 describe LocaSMS::RestClient do
+  let(:callback) { 'http://example.com/callback' }
+  let(:params) { { lgn: 'LOGIN', pwd: 'PASSWORD', url_callback: callback } }
+
   describe '.initialize' do
     context 'When giving proper initialization parameters' do
       subject { LocaSMS::RestClient.new :url, :params }
@@ -10,14 +13,31 @@ describe LocaSMS::RestClient do
   end
 
   describe '#get' do
-    it 'Is missing tests for get'
+    let(:action) { 'sendsms' }
+    let(:body) { '{"status":1,"data":28,"msg":null}' }
+    subject { LocaSMS::RestClient.new(action, params) }
+
+    it 'Performs get request to url with parameters' do
+      expect(Net::HTTP).
+        to receive(:get_response).
+             and_return(OpenStruct.new(body: body))
+
+      subject.get(action, params)
+    end
   end
 
   describe '#params_for' do
-    subject { LocaSMS::RestClient.new :url, { b1: 'X' } }
+    subject { LocaSMS::RestClient.new :url, params }
+
+    it { expect(subject.params_for(:action)).to eq({action: :action}.merge(params)) }
+    it { expect(subject.params_for(:action, p1: 10)).to eq({action: :action, p1: 10}.merge(params)) }
 
-    it { expect(subject.params_for(:action)).to eq({action: :action, b1: 'X'}) }
-    it { expect(subject.params_for(:action, p1: 10)).to eq({action: :action, b1: 'X', p1: 10}) }
+    context 'callback nil' do
+      let(:callback) { nil }
+      it 'should not be in params' do
+        expect(subject.params_for(:action)).to eq({action: :action, lgn: 'LOGIN', pwd: 'PASSWORD'})
+      end
+    end
   end
 
   describe '#parse_response' do
@@ -44,4 +64,4 @@ describe LocaSMS::RestClient do
     end
   end
 
-end
+end

data/spec/spec.opts

@@ -1,3 +1,2 @@
 --colour
---format Fuubar
---backtrace
+--backtrace

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: locasms
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Adilson Carvalho
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-04 00:00:00.000000000 Z
+date: 2017-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -18,175 +18,107 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: '12.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: '12.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
-- !ruby/object:Gem::Dependency
-  name: fuubar
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.3
-- !ruby/object:Gem::Dependency
-  name: guard
-  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'
-- !ruby/object:Gem::Dependency
-  name: guard-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'
-- !ruby/object:Gem::Dependency
-  name: growl
-  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'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: yard
   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'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: simplecov
-  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'
-- !ruby/object:Gem::Dependency
-  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :runtime
+        version: '0.15'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
-description: "Cliente para o serviço de disparo de SMS da LocaSMS e de sua \n                          versão
-  para Short Code SMS (SMS Plataforma)"
+        version: '0.15'
+description: |-
+  Cliente para o serviço de disparo de SMS da LocaSMS e de sua
+                            versão para Short Code SMS (SMS Plataforma)
 email:
 - lc.adilson@gmail.com
 - vyper@maneh.org
 - marco.carvalho.swasthya@gmail.com
-executables: []
+executables:
+- console
 extensions: []
 extra_rdoc_files: []
 files:
@@ -200,6 +132,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
 - lib/locasms.rb
 - lib/locasms/client.rb
 - lib/locasms/exception.rb
@@ -224,9 +157,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -234,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Cliente para disparo de SMS, regular e Short Code, através da LocaSMS/SMS
@@ -246,4 +179,3 @@ test_files:
 - spec/lib/locasms/rest_client_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-has_rdoc: