locasms 0.1.7 → 0.5.0

data/lib/locasms/numbers.rb

@@ -1,5 +1,6 @@
-module LocaSMS
+# frozen_string_literal: true
 
+module LocaSMS
   # Class that sanitizes and validates a list of mobile's numbers
   class Numbers
     attr_reader :good, :bad
@@ -9,15 +10,16 @@ module LocaSMS
     # @see #normalize
     # @see #evaluate
     def initialize(*numbers)
-      evaluated   = evaluate(numbers)
-      @good, @bad = evaluated[:good], evaluated[:bad]
+      evaluated = evaluate(numbers)
+      @good = evaluated[:good]
+      @bad = evaluated[:bad]
     end
 
     # Checks if there are bad numbers
     # @return [TrueClass, FalseClass] true if there are bad numbers
     # @see #valid_number?
     def bad?
-      not bad.empty?
+      !bad.empty?
     end
 
     # Clears all non digits from a mobile's number and converts into a normalized array
@@ -34,17 +36,19 @@ module LocaSMS
     #     numbers.normalize '8888-9999', ['AA', '6666-9999', '7777-0000'], '3333-4444,555-9999'
     #     # => ['88889999','AA','66669999','77770000','33334444','5559999']
     def normalize(*numbers)
-      numbers = numbers.join(',')
+      numbers
+        .join(',')
         .split(',')
-        .map{|number| number.gsub(/[^0-9a-zA-Z]/, '') }
-        .delete_if{|number| number.empty? }
+        .map { |number| number.gsub(/[^0-9a-zA-Z]/, '') }
+        .delete_if(&:empty?)
     end
 
     # Validates if a mobile's number has only digits
     # @param [String] number given number to be validated
     # @return [TrueClass, FalseClass] true if the number is valid
     def valid_number?(number)
-      return false if number.nil? or number =~ /[^0-9a-zA-Z]/
+      return false if number.nil? || number =~ (/[^0-9a-zA-Z]/)
+
       [10, 11].include? number.size
     end
 
@@ -63,10 +67,9 @@ module LocaSMS
     #     Numbers.new.evaluate('4199998888','11777770000','5551212')
     #     #=> {good: ['4199998888','11777770000'], bad: ['5551212']}
     def evaluate(*numbers)
-      normalize(numbers).reduce({good: [], bad: []}) do |hash, number|
+      normalize(numbers).each_with_object({ good: [], bad: [] }) do |number, hash|
         bucket = valid_number?(number) ? :good : :bad
         hash[bucket] << number
-        hash
       end
     end
 
@@ -76,5 +79,4 @@ module LocaSMS
       (good || []).join(',')
     end
   end
-
-end
+end

data/lib/locasms/rest_client.rb

@@ -1,16 +1,19 @@
+# frozen_string_literal: true
+
 require 'json'
+require 'net/http'
 
 module LocaSMS
-
   # Class that handle http calls to LocaSMS api
-  # @see https://github.com/mcorp/locasms/wiki/A-API-de-envio List of avaiable services
+  # @see https://github.com/mcorp/locasms/wiki/A-API-de-envio
+  #   List of avaiable services
   class RestClient
     attr_accessor :base_url, :base_params
 
     # Creates a new instance of the RestClient class
     # @param [String] base_url a well formed url
     # @param [Hash] base_params base params to send on every call
-    def initialize(base_url, base_params={})
+    def initialize(base_url, base_params = {})
       @base_url    = base_url
       @base_params = base_params
     end
@@ -34,12 +37,17 @@ module LocaSMS
     #     client.get :holdsms, id: 345678
     #     # => {"status"=>1,"data"=>nil,"msg"=>"SUCESSO"}
     #
-    # @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
+    # @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
     # @raise [LocaSMS::InvalidOperation] when asked for an invalid operation
     # @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
+    def get(action, params = {})
+      params = params_for action, 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
 
@@ -54,9 +62,10 @@ module LocaSMS
     #    client.params_for :ACTION, a: 1, b: 2
     #    # => { action: :ACTION, lgn: 'LOGIN', pwd: 'PASSWORD', a: 1, b: 2 }
     #
-    # @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)
+    # @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).select { |_k, v| v }
     end
 
     # Parses a result trying to get it in json
@@ -68,13 +77,17 @@ module LocaSMS
     def parse_response(action, response)
       raise InvalidOperation.new(action: action) if response =~ /^0:OPERACAO INVALIDA$/i
 
-      j = JSON.parse(response) rescue { 'status' => 1, 'data' => response, 'msg' => nil }
+      j = begin
+        MultiJson.load(response)
+      rescue StandardError
+        { 'status' => 1, 'data' => response, 'msg' => nil }
+      end
 
-      return j if j['status'] == 1 or action == :getstatus
+      return j if (j['status'] == 1) || (action == :getstatus)
 
       raise InvalidLogin.new(action: action) if j['msg'] =~ /^falha ao realizar login$/i
-      raise Exception.new(message: j['msg'], raw: response, action: action)
+
+      raise LocaSMS::Exception.new(message: j['msg'], raw: response, action: action)
     end
   end
-
-end
+end

data/lib/locasms/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LocaSMS
-  VERSION = '0.1.7'
+  VERSION = '0.5.0'
 end

data/locasms.gemspec

@@ -1,42 +1,44 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'locasms/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "locasms"
+  spec.name          = 'locasms'
   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}
-  spec.summary       = %q{Cliente para o serviço de disparo de SMS da LocaSMS}
-  spec.homepage      = "https://github.com/mcorp/locasms"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files`.split($/)
+  spec.authors       = ['Adilson Carvalho', 'Leonardo Saraiva', 'Marco Carvalho']
+  spec.email         = ['lc.adilson@gmail.com', 'vyper@maneh.org', 'marco.carvalho.swasthya@gmail.com']
+  spec.description   = 'Cliente para o serviço de disparo de SMS da LocaSMS e de sua
+                          versão para Short Code SMS (SMS Plataforma)'
+  spec.summary       = 'Cliente para disparo de SMS, regular e Short Code, através da LocaSMS/SMS Plataforma'
+  spec.homepage      = 'https://github.com/mcorp/locasms'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake', '~> 10.4.2'
+  spec.required_ruby_version = '~> 2.4'
 
-  # 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_dependency 'multi_json', '~> 1.13'
 
-  # run tests automatically
-  spec.add_development_dependency 'guard'
-  spec.add_development_dependency 'guard-rspec'
-  spec.add_development_dependency 'growl'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake',      '~> 13.0'
+
+  # test stuff
+  spec.add_development_dependency 'rspec',     '~> 3.9'
+  spec.add_development_dependency 'timecop',   '~> 0.9'
 
   # for documentation
-  spec.add_development_dependency 'yard'
-  spec.add_development_dependency 'redcarpet'
+  spec.add_development_dependency 'redcarpet', '~> 3.5'
+  spec.add_development_dependency 'yard',      '~> 0.9'
 
   # for code coverage
-  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov', '~> 0.18'
 
-  spec.add_dependency 'rest-client', '~> 1.6'
+  # for code quality
+  spec.add_development_dependency 'rubocop',       '~> 0.93'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.43'
 end

data/spec/lib/locasms/client_spec.rb

@@ -1,140 +1,148 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-describe LocaSMS::Client do
-  let(:rest_client) { 'rest_client mock' }
-  subject { LocaSMS::Client.new :login, :password, rest_client: rest_client }
+describe LocaSMS::Client do # rubocop:disable RSpec/FilePath
+  subject(:client) { described_class.new :login, :password, rest_client: rest_client, callback: nil }
 
-  context '.ENDPOINT' do
-    def test_when(moment_in_time)
-      Timecop.freeze(Time.parse(moment_in_time)) do
-        LocaSMS.send :remove_const, :Client
-        load 'lib/locasms/client.rb'
-        yield
-      end
-    end
+  let(:rest_client) { instance_double 'RestClient' }
+  let(:base_args) { { msg: 'given message', numbers: '11988889991,11988889992,11988889993' } }
+  let(:default_callback_args) { base_args.merge(url_callback: 'default') }
+  let(:some_callback_args) { base_args.merge(url_callback: 'something') }
 
-    it 'prior to Jun 1st, 2015' do
-      test_when('2015-05-31T23:59:59-0300') do
-        expect(LocaSMS::Client::ENDPOINT).to(
-          eq('http://173.44.33.18/painel/api.ashx')
-        )
+  describe '::ENDPOINT' do
+    let(:domain) { described_class::DOMAIN }
+
+    context 'when default' do
+      it 'returns the default URL' do
+        endpoint = described_class::ENDPOINT[client.type]
+        expect(endpoint).to eq("http://#{domain}/painel/api.ashx")
       end
     end
 
-    it 'is Jun 1st, 2015' do
-      test_when('2015-06-01T00:00:00-0300') do
-        expect(LocaSMS::Client::ENDPOINT).to(
-          eq('http://209.133.196.250/painel/api.ashx')
-        )
+    context 'when shortcode' do
+      subject(:client) { described_class.new :login, :password, type: :shortcode }
+
+      it 'returns the short code URL' do
+        endpoint = described_class::ENDPOINT[client.type]
+        expect(endpoint).to eq("http://#{domain}/shortcode/api.ashx")
       end
     end
+  end
 
-    it 'after Jun 1st, 2015 and prior to March 29, 2016' do
-      test_when('2016-03-28T00:00:00-0300') do
-        expect(LocaSMS::Client::ENDPOINT).to(
-          eq('http://209.133.196.250/painel/api.ashx')
-        )
-      end
+  describe '.initialize' do
+    it { expect(client.login).to be(:login) }
+    it { expect(client.password).to be(:password) }
+  end
+
+  describe '#deliver' do
+    it 'sends SMS' do
+      allow(rest_client).to receive(:get).and_return({})
+
+      client.deliver 'given message', '11988889991', '11988889992', '11988889993'
+
+      expect(rest_client).to have_received(:get).once.with(:sendsms, base_args.merge(url_callback: nil))
     end
 
-    it 'is March 29, 2016' do
-      test_when('2016-03-29T00:00:00-0300') do
-        expect(LocaSMS::Client::ENDPOINT).to(
-          eq('http://54.173.24.177/painel/api.ashx')
-        )
+    context 'when receive an error' do
+      let(:wrong_deliver) { -> { client.deliver('given message', '1', '2', '3') } }
+
+      it { expect(wrong_deliver).to raise_error(LocaSMS::Exception) }
+
+      it 'does not send SMS' do
+        allow(rest_client).to receive(:get)
+
+        wrong_deliver
+
+        expect(rest_client).not_to have_received(:get)
       end
     end
 
-    it 'after March 29, 2016' do
-      test_when('2017-01-01T00:00:00-0300') do
-        expect(LocaSMS::Client::ENDPOINT).to(
-          eq('http://54.173.24.177/painel/api.ashx')
-        )
+    context 'when callback given as arg to #deliver' do
+      it 'uses specific callback' do
+        allow(rest_client).to receive(:get).and_return({})
+
+        client.deliver 'given message', '11988889991', '11988889992', '11988889993', url_callback: 'something'
+
+        expect(rest_client).to have_received(:get).once.with(:sendsms, some_callback_args)
       end
     end
-  end
 
-  describe '.initialize' do
-    it { expect(subject.login).to be(:login) }
-    it { expect(subject.password).to be(:password) }
+    it 'uses default callback' do
+      client = described_class.new :login, :password, rest_client: rest_client, url_callback: 'default'
+
+      allow(rest_client).to receive(:get).and_return({})
+
+      client.deliver 'given message', '11988889991', '11988889992', '11988889993'
+
+      expect(rest_client).to have_received(:get).once.with(:sendsms, default_callback_args)
+    end
   end
 
-  describe '#deliver' do
-    it 'Should send SMS' 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')
-        .and_return({})
-
-      subject.deliver 'given message', :a, :b, :c
+  describe '#deliver_at' do
+    let(:base_args) do
+      {
+        msg: 'given message',
+        numbers: '11988889991,11988889992,11988889993',
+        jobdate: '10/10/2020',
+        jobtime: '10:10'
+      }
     end
 
-    it 'Should not send SMS' do
-      expect(subject).to receive(:numbers)
-        .once
-        .with([:a, :b, :c])
-        .and_raise(LocaSMS::Exception)
+    it 'sends SMS' do
+      allow(rest_client).to receive(:get).and_return({})
 
-      expect(rest_client).to receive(:get).never
+      client.deliver_at 'given message', '2020-10-10 10:10', '11988889991', '11988889992', '11988889993'
 
-      expect { subject.deliver('given message', :a, :b, :c) }.to raise_error(LocaSMS::Exception)
+      expect(rest_client).to have_received(:get).once.with(:sendsms, base_args.merge(url_callback: nil))
     end
-  end
 
-  describe '#deliver_at' do
-    it 'Should send SMS' 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')
-        .and_return({})
-
-      subject.deliver_at 'given message', :datetime, :a, :b, :c
+    context 'when receive an error' do
+      let(:wrong_deliver_at) { -> { client.deliver_at('given message', '2020-10-10 10:10', '1', '2', '3') } }
+
+      it { expect(wrong_deliver_at).to raise_error(LocaSMS::Exception) }
+
+      it 'does not send SMS' do
+        allow(rest_client).to receive(:get)
+
+        wrong_deliver_at
+
+        expect(rest_client).not_to have_received(:get)
+      end
     end
 
-    it 'Should not send SMS' do
-      expect(subject).to receive(:numbers)
-        .once
-        .with([:a, :b, :c])
-        .and_raise(LocaSMS::Exception)
+    context 'with callback option' do
+      it 'when callback given as arg to #deliver' do
+        allow(rest_client).to receive(:get).and_return({})
+
+        client.deliver_at 'given message', '2020-10-10 10:10', '11988889991', '11988889992', '11988889993', url_callback: 'something'
+
+        expect(rest_client).to have_received(:get).once.with(:sendsms, some_callback_args)
+      end
+
+      it 'uses default callback' do
+        client = described_class.new :login, :password, rest_client: rest_client, url_callback: 'default'
 
-      expect(LocaSMS::Helpers::DateTimeHelper).to receive(:split)
-        .once
-        .with(:datetime)
-        .and_return(%w[date time])
+        allow(rest_client).to receive(:get).and_return({})
 
-      expect(rest_client).to receive(:get).never
+        client.deliver_at 'given message', '2020-10-10 10:10', '11988889991', '11988889992', '11988889993'
 
-      expect { subject.deliver_at('given message', :datetime, :a, :b, :c) }.to raise_error(LocaSMS::Exception)
+        expect(rest_client).to have_received(:get).once.with(:sendsms, default_callback_args)
+      end
     end
   end
 
   describe '#balance' do
-    it 'Should check param assignment' do
-      expect(rest_client).to receive(:get)
-        .once
-        .with(:getbalance)
-        .and_return({})
+    it 'checks param assignment' do
+      allow(rest_client).to receive(:get).and_return({})
+
+      client.balance
 
-      subject.balance
+      expect(rest_client).to have_received(:get).once.with(:getbalance)
     end
   end
 
-  context 'Testing all campaign based methods' do
+  context 'when receive all campaign based methods' do
     def check_for(method)
       rest_method = {
         campaign_status: :getstatus,
@@ -142,19 +150,17 @@ describe LocaSMS::Client do
         campaign_release: :releasesms
       }[method]
 
-      expect(rest_client).to receive(:get)
-        .once
-        .with(rest_method, id: '12345')
-        .and_return({})
+      allow(rest_client).to receive(:get).and_return({})
 
-      subject.send method, '12345'
+      client.send method, '12345'
+
+      expect(rest_client).to have_received(:get).once.with(rest_method, id: '12345')
     end
 
-    it{ check_for :campaign_status  }
-    it{ check_for :campaign_hold    }
-    it{ check_for :campaign_release }
+    it { check_for :campaign_status  }
+    it { check_for :campaign_hold    }
+    it { check_for :campaign_release }
 
-    it 'Should have tests to cover campaign_status csv result'
+    it 'has tests to cover campaign_status csv result'
   end
-
 end