locasms 0.1.7 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9fcc47dc9d81331e507553c2bec302c2fd41ea5e
-  data.tar.gz: 875d43f697d0a428cd93e1ec8b9d06cc0cdbdb0f
+SHA256:
+  metadata.gz: 39596e51a28908193ac0455bf97fb1c703becaedc33c569fe509e1ce450a6e70
+  data.tar.gz: f4a5d880167d667f952ebd75f68116b4dcfda9da03579d9a2b4bca87f735b1ac
 SHA512:
-  metadata.gz: d7ac7758b75ec458c061b5bad63612a7c2ae131bd363c86f14c04e51ee436788b3674db4cd2402b85baf6efa884a18ca469d383a7ad7eef4da611f453a471549
-  data.tar.gz: e371973b0a48b2708ec2e9bae5e03964b1b7e155e18494e8e5c9d1b676ef498c725bbad2cd0ecb7d38341ac15818675df635f6ff4e13fe252955be8397dd0e7f
+  metadata.gz: '028885bb02e34a3f5bb918e805795e24e62a1f7d9bd18acc81bafb53e824502b263128b159c75af90d06d5764b210cd0fc01968d865cfed31a89bf1041fbdbd6'
+  data.tar.gz: 56ca283b83035314141fadcf0b48cedbf875176822c5ca159c99c7a70857260cfe9c3a8284f0ddcd8fe9b147edd4f4a3f91542df4107c683a1f1d2e1a87f3422

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 *.rbc
+*.swp
 .bundle
 .config
 .yardoc

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_from: .rubocop_todo.yml
+
+require: rubocop-rspec
+
+AllCops:
+  NewCops: enable

data/.rubocop_todo.yml

@@ -0,0 +1,30 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-10-15 23:34:33 UTC using RuboCop version 0.93.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 8
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 171
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 27
+
+# Offense count: 1
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 13
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 179

data/.travis.yml

@@ -1,9 +1,17 @@
 language: ruby
 rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3
+  - 2.7
+  - 2.6
+  - 2.5
+  - 2.4
 env:
   - TRAVIS=true
-
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+  - bundle exec rubocop
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in locasms.gemspec

data/Guardfile

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

data/README.md

@@ -1,9 +1,9 @@
 # locasms
-[![Gem Version](https://badge.fury.io/rb/locasms.svg)](http://badge.fury.io/rb/locasms) [![Build Status](https://travis-ci.org/mcorp/locasms.png?branch=master)](https://travis-ci.org/mcorp/locasms) [![Dependency Status](https://gemnasium.com/mcorp/locasms.png)](https://gemnasium.com/mcorp/locasms) [![Code Climate](https://codeclimate.com/github/mcorp/locasms.png)](https://codeclimate.com/github/mcorp/locasms) [![Inline docs](http://inch-ci.org/github/mcorp/locasms.svg?branch=master)](http://inch-ci.org/github/mcorp/locasms)
+[![Gem Version](https://badge.fury.io/rb/locasms.svg)](http://badge.fury.io/rb/locasms) [![Build Status](https://travis-ci.org/mcorp/locasms.png?branch=master)](https://travis-ci.org/mcorp/locasms) [![Code Climate](https://api.codeclimate.com/v1/badges/4187ea939aabd3b66bf7/maintainability)](https://codeclimate.com/github/mcorp/locasms) [![CC Coverage](https://api.codeclimate.com/v1/badges/4187ea939aabd3b66bf7/test_coverage)](https://codeclimate.com/github/mcorp/locasms/test_coverage) [![Inline docs](http://inch-ci.org/github/mcorp/locasms.svg?branch=master)](http://inch-ci.org/github/mcorp/locasms)
 
-> :warning: After `March 29, 2016` the base IP of the service will change as noticed on this [issue](https://github.com/mcorp/locasms/issues/6). If you don't upgrade to version `0.1.7` your app will stop delivering SMS
+> :warning: After `February, 10, 2018` the base IP of the service will change as noticed on this [issue](https://github.com/mcorp/locasms/issues/21). If you don't upgrade to version `0.3.1` your app will stop delivering SMS.
 
-Client to consume [LocaSMS api's][0].
+Client to consume API's from [LocaSMS][0] and its Short Code SMS version [SMS Plataforma][1].
 
 ## Installation
 
@@ -26,8 +26,15 @@ Simple example:
 ```ruby
 require 'locasms'
 
+# Default:
 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'
 
@@ -37,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'
 
@@ -46,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
 
@@ -67,4 +80,5 @@ cli.campaign_release '0000'
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-[0]: http://locasms.com.br/#page_2/
+[0]: http://locasms.com.br
+[1]: http://smsplataforma.com.br

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler'
 
@@ -14,4 +16,4 @@ task :console do
   sh 'bundle exec irb -rubygems -I lib -r locasms.rb'
 end
 
-task :default => (ENV['TRAVIS'] ? :spec : :console)
+task default: (ENV['TRAVIS'] ? :spec : :console)

data/bin/console

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

data/lib/locasms.rb

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
+
 require 'locasms/version'
 
-autoload :CSV,        'csv'
-autoload :JSON,       'json'
-autoload :RestClient, 'rest_client'
-autoload :Logger,     'logger'
+autoload :CSV,       'csv'
+autoload :MultiJson, 'multi_json'
 
+# Module to encapsulate implementation
 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 to encapsulate helpers
   module Helpers
     autoload :DateTimeHelper, 'locasms/helpers/date_time_helper'
   end

data/lib/locasms/client.rb

@@ -1,27 +1,29 @@
-module LocaSMS
+# frozen_string_literal: true
 
+module LocaSMS
   # Client to interact with LocaSMS API
   class Client
+    # Default API "domain"
+    DOMAIN = 'app.locasms.com.br'
+
     # Default API address
-    ENDPOINT = if Time.now >= Time.parse('2016-03-29T00:00:00-0300')
-                 'http://54.173.24.177/painel/api.ashx'
-               elsif Time.now >= Time.parse('2015-06-01T00:00:00-0300')
-                 'http://209.133.196.250/painel/api.ashx'
-               else
-                 'http://173.44.33.18/painel/api.ashx'
-               end
+    ENDPOINT = {
+      default: "http://#{DOMAIN}/painel/api.ashx",
+      shortcode: "http://#{DOMAIN}/shortcode/api.ashx"
+    }.freeze
 
-    attr_reader :login, :password
+    attr_reader :login, :password, :type, :callback
 
     # @param [String] login authorized user
     # @param [String] password access password
     # @param [Hash] opts
     # @option opts :rest_client (RestClient) client to be used to handle http requests
-    def initialize(login, password, opts={})
+    def initialize(login, password, opts = {})
       @login    = login
       @password = password
-
-      @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 +31,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 +46,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
@@ -52,20 +66,24 @@ module LocaSMS
 
     # Gets the current status of the given campaign
     # @param [String] id campaign id
-    # @return [Array<Hash>] {campaign_id: id, delivery_id: delivery_id, enqueue_time: enqueue_time, delivery_time: delivery_time, status: status, carrier: carrier, mobile_number: mobile_number, message: message }
+    # @return [Array<Hash>]
+    #   { campaign_id: id, delivery_id: delivery_id, enqueue_time: enqueue_time,
+    #   delivery_time: delivery_time, status: status, carrier: carrier,
+    #   mobile_number: mobile_number, message: message }
     def campaign_status(id)
       response = rest.get(:getstatus, id: id)
       begin
         CSV.new(response['data'] || '', col_sep: ';', quote_char: '"').map do |delivery_id, _, enqueue_time, _, delivery_time, _, status, _, _, carrier, mobile_number, _, message|
-          status = if status =~ /aguardando envio/i
-            :waiting
-          elsif status =~ /sucesso/i
-            :success
-          elsif status =~ /numero invalido|nao cadastrado/i
-            :invalid
-          else
-            :unknown
-          end
+          status = case status
+                   when /aguardando envio/i
+                     waiting
+                   when /sucesso/i
+                     success
+                   when /numero invalido|nao cadastrado/i
+                     invalid
+                   else
+                     unknown
+                   end
 
           {
             campaign_id: id,
@@ -78,8 +96,8 @@ module LocaSMS
             message: message
           }
         end
-      rescue
-        raise Exception.new 'Invalid delivery response data'
+      rescue StandardError
+        raise LocaSMS::Exception.new(message: 'Invalid delivery response data')
       end
     end
 
@@ -97,13 +115,13 @@ module LocaSMS
       rest.get(:releasesms, id: id)['data']
     end
 
-  private
+    private
 
     # Gets the current RestClient to handle http requests
     # @return [RestClient] you can set on class creation passing it on the options
     # @private
     def rest
-      @rest ||= RestClient.new ENDPOINT, lgn: login, pwd: password
+      @rest ||= RestClient.new ENDPOINT[type], lgn: login, pwd: password
     end
 
     # Processes and returns all good numbers in a string
@@ -115,9 +133,7 @@ module LocaSMS
       numbers = Numbers.new mobiles
       return numbers.to_s unless numbers.bad?
 
-      raise Exception("Bad numbers were given: #{numbers.bad.join(',')}")
+      raise LocaSMS::Exception.new(message: "Bad numbers were given: #{numbers.bad.join(',')}")
     end
-
   end
-
 end

data/lib/locasms/exception.rb

@@ -1,7 +1,8 @@
-module LocaSMS
+# frozen_string_literal: true
 
+module LocaSMS
   # Common base exception
-  class Exception < ::Exception
+  class Exception < RuntimeError
     attr_reader :raw, :action
 
     def initialize(data = {})
@@ -11,7 +12,7 @@ module LocaSMS
       super data[:message] || default_message
     end
 
-  private
+    private
 
     def default_message
       nil
@@ -20,17 +21,16 @@ module LocaSMS
 
   # Raised when asked for an invalid operation
   # @see https://github.com/mcorp/locasms/wiki/A-API-de-envio#lista-das-a%C3%A7%C3%B5es-dispon%C3%ADveis
-  class InvalidOperation < Exception
+  class InvalidOperation < RuntimeError
     def default_message
       'Invalid Operation'
     end
   end
 
   # Raised when the given credentials are invalid
-  class InvalidLogin < Exception
+  class InvalidLogin < RuntimeError
     def default_message
       'Invalid Login'
     end
   end
-
-end
+end

data/lib/locasms/helpers/date_time_helper.rb

@@ -1,74 +1,43 @@
-module LocaSMS
-module Helpers
-
-  # Helper class to handle with time parsing
-  class DateTimeHelper
-    # Parse a value into a time
-    # @param [Fixnum,String,DateTime,Time,#to_time] date
-    # @result [Time] return a parsed time
-    #
-    # @example
-    #
-    #     DateTimeHelper.parse '1977-03-14 14:12:00'
-    #     # => 1977-03-14 14:12:00 -0300
-    #
-    #     DateTimeHelper.split 227207520
-    #     # => 1977-03-14 14:12:00 -0300
-    #
-    def self.parse(date)
-      date = Time.at(date)    if date.is_a? Fixnum
-      date = Time.parse(date) if date.is_a? String
-      date = date.to_time     if date.respond_to? :to_time
-    end
-
-    # Breaks a given date in date and time
-    # @param [Fixnum,String,DateTime,Time,#to_time] date
-    # @result [Array<String>] an array containing respectively DD/MM/YYYY and HH:MM
-    #
-    # @example
-    #
-    #     DateTimeHelper.split Time.now
-    #     # => ['14/03/1977', '14:12']
-    #
-    #     DateTimeHelper.split 227207520
-    #     # => ['14/03/1977', '14:12']
-    #
-    def self.split(date)
-      parse(date).strftime('%d/%m/%Y %H:%M').split(' ')
-    end
+# frozen_string_literal: true
 
-    # Parse a value into a time
-    # @param [Fixnum,String,DateTime,Time,#to_time] date
-    # @result [Time] return a parsed time
-    #
-    # @example
-    #
-    #     DateTimeHelper.parse '1977-03-14 14:12:00'
-    #     # => 1977-03-14 14:12:00 -0300
-    #
-    #     DateTimeHelper.split 227207520
-    #     # => 1977-03-14 14:12:00 -0300
-    #
-    def parse(date)
-      DateTimeHelper.parse date
-    end
+module LocaSMS
+  module Helpers
+    # Helper class to handle with time parsing
+    class DateTimeHelper
+      # Parse a value into a time
+      # @param [Fixnum,String,DateTime,Time,#to_time] date
+      # @result [Time] return a parsed time
+      #
+      # @example
+      #
+      #     DateTimeHelper.parse '1977-03-14 14:12:00'
+      #     # => 1977-03-14 14:12:00 -0300
+      #
+      #     DateTimeHelper.split 227207520
+      #     # => 1977-03-14 14:12:00 -0300
+      #
+      def self.parse(date)
+        date = Time.at(date)    if date.is_a? Integer
+        date = Time.parse(date) if date.is_a? String
+        date = date.to_time     if date.respond_to? :to_time
+        date
+      end
 
-    # Breaks a given date in date and time
-    # @param [Fixnum,String,DateTime,Time,#to_time] date
-    # @result [Array<String>] an array containing respectively DD/MM/YYYY and HH:MM
-    #
-    # @example
-    #
-    #     DateTimeHelper.split Time.now
-    #     # => ['14/03/1977', '14:12']
-    #
-    #     DateTimeHelper.split 227207520
-    #     # => ['14/03/1977', '14:12']
-    #
-    def split(date)
-      DateTimeHelper.split date
+      # Breaks a given date in date and time
+      # @param [Fixnum,String,DateTime,Time,#to_time] date
+      # @result [Array<String>] an array containing respectively DD/MM/YYYY and HH:MM
+      #
+      # @example
+      #
+      #     DateTimeHelper.split Time.now
+      #     # => ['14/03/1977', '14:12']
+      #
+      #     DateTimeHelper.split 227207520
+      #     # => ['14/03/1977', '14:12']
+      #
+      def self.split(date)
+        parse(date).strftime('%d/%m/%Y %H:%M').split(' ')
+      end
     end
   end
-
 end
-end