locasms 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 061caed197edecf988387ffa2f5145f4cc9249d6
-  data.tar.gz: 04d6e7039d8e83261e83d4575e88e74a65cce055
+SHA256:
+  metadata.gz: 39596e51a28908193ac0455bf97fb1c703becaedc33c569fe509e1ce450a6e70
+  data.tar.gz: f4a5d880167d667f952ebd75f68116b4dcfda9da03579d9a2b4bca87f735b1ac
 SHA512:
-  metadata.gz: 69d4f764660e36d5cfa3745d944fab97405a92227d9990c4be889f2280f288b96bed3e2e2d6ea4cb82b04998b126495514a588630b5a370da15bf2506ff908d3
-  data.tar.gz: 57ca434f3d72c864e63b201162f11fd7b3d7de6ae1a4b545f3baf1b9c5998d63e35d6192be51af4e80e3095e9490d168e7b5be746d30ba6353064042dfbec961
+  metadata.gz: '028885bb02e34a3f5bb918e805795e24e62a1f7d9bd18acc81bafb53e824502b263128b159c75af90d06d5764b210cd0fc01968d865cfed31a89bf1041fbdbd6'
+  data.tar.gz: 56ca283b83035314141fadcf0b48cedbf875176822c5ca159c99c7a70857260cfe9c3a8284f0ddcd8fe9b147edd4f4a3f91542df4107c683a1f1d2e1a87f3422

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,10 +1,17 @@
 language: ruby
 rvm:
+  - 2.7
+  - 2.6
   - 2.5
   - 2.4
-  - 2.3
-  - 2.2
-  - 2.1
 env:
   - TRAVIS=true
-before_install: gem install bundler -v 1.15.4
+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,5 +1,5 @@
 # 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://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 `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.
 

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

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require 'bundler/setup'
 require 'locasms'
 

data/lib/locasms.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 require 'locasms/version'
 
 autoload :CSV,       'csv'
 autoload :MultiJson, 'multi_json'
 
+# Module to encapsulate implementation
 module LocaSMS
   autoload :Client,           'locasms/client'
   autoload :Exception,        'locasms/exception'
@@ -11,6 +14,7 @@ module LocaSMS
   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,13 +1,14 @@
-module LocaSMS
+# frozen_string_literal: true
 
+module LocaSMS
   # Client to interact with LocaSMS API
   class Client
     # Default API "domain"
-    DOMAIN = 'app.locasms.com.br'.freeze
+    DOMAIN = 'app.locasms.com.br'
 
     # Default API address
     ENDPOINT = {
-      default:   "http://#{DOMAIN}/painel/api.ashx",
+      default: "http://#{DOMAIN}/painel/api.ashx",
       shortcode: "http://#{DOMAIN}/shortcode/api.ashx"
     }.freeze
 
@@ -17,7 +18,7 @@ module LocaSMS
     # @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
       @type     = opts[:type] || :default
@@ -65,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,
@@ -91,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
 
@@ -128,7 +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

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,17 +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
@@ -35,11 +37,12 @@ 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
+    def get(action, params = {})
+      params = params_for action, params
 
       uri = URI.parse(base_url)
       uri.query = URI.encode_www_form(params)
@@ -59,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).select {|k, v| v }
+    # @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
@@ -73,13 +77,17 @@ module LocaSMS
     def parse_response(action, response)
       raise InvalidOperation.new(action: action) if response =~ /^0:OPERACAO INVALIDA$/i
 
-      j = MultiJson.load(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