boletosimples 0.4.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 490d1c76e70d03fec1a8578e593b6a18e6c58f1e
-  data.tar.gz: ffc415cf01929b2237ce2dc928460973cda9516c
+SHA256:
+  metadata.gz: '080a1d5f5d9ba832ed3dd093f291dbeb217b732eba56d3713932917ae91534a0'
+  data.tar.gz: 954683fba1d52eca0c0831e46828caeecc57ab04b250ab5674433371fb77083d
 SHA512:
-  metadata.gz: 9bd04063532e772ab874480ce21af8c8a6108b2649857062ea4aed159586078a96c76b492c03412c099d025fd1d9812745f5fea3c6440f4021a8b03cda1b8125
-  data.tar.gz: c6aaa930072ad9c2d954c5b5f400496aaba2ee25426f8b999634db769526080f8d5becdbc76b4d64168cb7f34a791e96d9911ded6a7ccae96aa14860f33ed541
+  metadata.gz: 1a224228c2735cf16331fba27644c75eb0f38904f1cdc39a0b15209063a8f9a0250438231449e28dee0be4d39e8c84bd1a7607623c5e1aa018e35c91c6db7656
+  data.tar.gz: fe49d834e95ef86f2b38362fe15c22e592d617b9f3a0d34e00b1b0f71bfec039f8f8d9e029ac77819a70f59a037018b4d38c79372b57a7cf9b658477236cabe3

data/.github/workflows/ruby.yml

@@ -0,0 +1,34 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: Test against Ruby ${{ matrix.ruby-version }}
+    strategy:
+      matrix:
+        ruby-version: [2.4, 2.5, 2.6, 2.7, 3.0]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed
+
+      - name: Run tests
+        run: bundle exec rake

data/.rspec

@@ -0,0 +1,3 @@
+--format Fuubar
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,9 @@
+require:
+  - rubocop-performance
+  - "test_prof/rubocop"
+  - rubocop-rspec
+  - rubocop-rake
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+3.0.1

data/CHANGELOG.md

@@ -1,18 +1,10 @@
 # Changelog
 
-## 0.2.2
+## 1.0.0
 
-### features
+### Breaking changes
 
-- Add BankBilletAccount resource
-
-## 0.1.1
-
-### features
-
-- Created `client.cancel_bank_billet(id, options)` to cancel bank billets
-
-### improvements
-
-- Changed `client.create_customer({ "customer" => params })` to `client.create_customer(params)`
-- Changed `client.create_bank_billet({ "bank_billet" => params })` to `client.create_bank_billet(params)`
+- Remove Oauth code
+- Require user_agent configuration
+- Require api_token configuration
+- All Errors now return with same root `errors`

data/Gemfile

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

data/README.md

@@ -1,16 +1,9 @@
 # Boleto Simples Ruby
 
 [![Gem Version](http://img.shields.io/gem/v/boletosimples.svg)][gem]
-[![Build Status](http://img.shields.io/travis/BoletoSimples/boletosimples-ruby.svg)][travis]
-[![Dependency Status](http://img.shields.io/gemnasium/BoletoSimples/boletosimples-ruby.svg)][gemnasium]
-[![Code Climate](http://img.shields.io/codeclimate/github/BoletoSimples/boletosimples-ruby.svg)][codeclimate]
-[![Coverage Status](http://img.shields.io/coveralls/BoletoSimples/boletosimples-ruby.svg)][coveralls]
+[![Ruby](https://github.com/BoletoSimples/boletosimples-ruby/actions/workflows/ruby.yml/badge.svg?branch=master)](https://github.com/BoletoSimples/boletosimples-ruby/actions/workflows/ruby.yml)
 
 [gem]: https://rubygems.org/gems/boletosimples
-[travis]: http://travis-ci.org/BoletoSimples/boletosimples-ruby
-[gemnasium]: https://gemnasium.com/BoletoSimples/boletosimples-ruby
-[codeclimate]: https://codeclimate.com/github/BoletoSimples/boletosimples-ruby
-[coveralls]: https://coveralls.io/r/BoletoSimples/boletosimples-ruby
 
 Biblioteca Ruby para acessar informações do [Boleto Simples](http://boletosimples.com.br) através da [API](http://api.boletosimples.com.br).
 
@@ -30,12 +23,17 @@ Ou instale você mesmo:
 
 ## Configuração
 
+Saiba mais sobre o [Token de API ](https://api.boletosimples.com.br/authentication/token/)
+
 ```ruby
 require 'boletosimples'
 
 BoletoSimples.configure do |c|
   c.environment = :production # defaut :sandbox
-  c.access_token = 'access-token'
+  # production - https://boletosimples.com.br/conta/api/tokens
+  # sandbox - https://sandbox.boletosimples.com.br/conta/api/tokens
+  c.api_token = 'api-token'
+  c.user_agent = 'email@minhaempresa.com.br' #Colocar um e-mail válido para contatos técnicos relacionado ao uso da API.
 end
 ```
 
@@ -45,9 +43,7 @@ Você também pode configurar as variáveis de ambiente a seguir e não será ne
 
 ```bash
 ENV['BOLETOSIMPLES_ENV']
-ENV['BOLETOSIMPLES_APP_ID']
-ENV['BOLETOSIMPLES_APP_SECRET']
-ENV['BOLETOSIMPLES_ACCESS_TOKEN']
+ENV['BOLETOSIMPLES_API_TOKEN']
 ```
 
 ### Configurando cache
@@ -72,7 +68,7 @@ Exemplo:
 
 ```ruby
 # Criar um boleto
-@bank_billet = BoletoSimples::BankBillet.create({
+@bank_billet = BoletoSimples::BankBillet.create(
   amount: 9.01,
   description: 'Despesas do contrato 0012',
   expire_at: '2014-01-01',
@@ -88,7 +84,7 @@ Exemplo:
   customer_phone_number: '2112123434',
   customer_state: 'RJ',
   customer_zipcode: '12312-123'
-})
+)
 
 # Criar um novo boleto instanciando o objeto
 @bank_billet = BoletoSimples::BankBillet.new(amount: 199.99, expire_at: '2020-01-01')
@@ -112,14 +108,6 @@ Exemplo:
   puts bank_billet.attributes
 end
 
- # Após realizar a chamada na listagem, você terá acesso aos seguintes dados:
-
-BoletoSimples.last_request.total # número total de boletos
-BoletoSimples.last_request.links[:first] # url da primeira página
-BoletoSimples.last_request.links[:prev] # url da página anterior
-BoletoSimples.last_request.links[:next] # url da próxima página
-BoletoSimples.last_request.links[:last] # url da última página
-
 # Cancelar um boleto
 @bank_billet = BoletoSimples::BankBillet.find(1)
 @bank_billet.cancel
@@ -130,7 +118,7 @@ BoletoSimples.last_request.links[:last] # url da última página
 
 ```ruby
 # Criar um cliente
-@customer = BoletoSimples::Customer.create({
+@customer = BoletoSimples::Customer.create(
   person_name: "Joao da Silva",
   cnpj_cpf: "012.345.678-90",
   email: "cliente@example.com",
@@ -142,7 +130,7 @@ BoletoSimples.last_request.links[:last] # url da última página
   address_number: "111",
   address_complement: "Sala 4",
   phone_number: "2112123434"
-})
+)
 
 # Mensagens de erro na criação do cliente
 @customer = BoletoSimples::Customer.new(person_name: '')
@@ -155,38 +143,8 @@ BoletoSimples.last_request.links[:last] # url da última página
   puts customer.attributes
 end
 
- # Após realizar a chamada na listagem, você terá acesso aos seguintes dados:
-
-BoletoSimples.last_request.total # número total de clientes
-BoletoSimples.last_request.links[:first] # url da primeira página
-BoletoSimples.last_request.links[:prev] # url da página anterior
-BoletoSimples.last_request.links[:next] # url da próxima página
-BoletoSimples.last_request.links[:last] # url da última página
-
 # Atualizar um cliente
 @customer = BoletoSimples::Customer.find(1)
 @customer.person_name = 'Novo nome'
 @customer.save
 ```
-
-### Extrato
-
-```ruby
-# Listar todas as transações
-@transactions = BoletoSimples::Transaction.all
-@transactions.each do |transaction|
-  puts transaction.attributes
-end
-```
-
-### Extras
-
-```ruby
-# Dados do usuário logado
-@userinfo = BoletoSimples::Extra.userinfo
-```
-
-## OAuth 2.0 Authentication (para acessar as contas dos usuários)
-
-Comece [solicitando um cadastro de OAuth 2.0 application](http://suporte.boletosimples.com.br)
-

data/Rakefile

@@ -1,6 +1,16 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+
+  ARGV.clear
+  IRB.start
+end

data/boletosimples.gemspec

@@ -1,6 +1,6 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'boletosimples/version'
 
@@ -13,25 +13,29 @@ Gem::Specification.new do |gem|
   gem.summary       = 'Boleto Simples API wrapper.'
   gem.homepage      = 'https://github.com/BoletoSimples/boletosimples-ruby'
 
-  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  gem.executables   = gem.files.grep(/^bin\//).map { |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(/^(test|spec|features)\//)
-  gem.require_paths = ['lib']
+  gem.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(spec|features)/})
+  end
 
-  gem.required_ruby_version = '>= 1.9'
+  gem.test_files = `git ls-files -- {spec,features}/*`.split("\n")
+  gem.require_paths = ['lib']
 
   # Gems that must be intalled for boletosimples to work
-  gem.add_dependency 'her', '~> 0.8.1'
-  gem.add_dependency 'faraday_middleware', '~> 0.10.0'
-  gem.add_dependency 'faraday-http-cache', '~> 1.3.1'
+  gem.add_dependency 'faraday-http-cache', '~> 2.2.0'
+  gem.add_dependency 'faraday_middleware', '~> 0.14'
+  gem.add_dependency 'her', '~> 1.1'
 
   # Gems that must be installed for boletosimples to compile and build
-  gem.add_development_dependency 'pry', '~> 0.10.1'
-  gem.add_development_dependency 'rspec', '~> 3.5.0'
-  gem.add_development_dependency 'vcr', '~> 3.0'
-  gem.add_development_dependency 'webmock', '~> 2.1.0'
-  gem.add_development_dependency 'rake', '~> 11.2.2'
-  gem.add_development_dependency 'coveralls', '~> 0.8.2'
-  gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.6.0'
+  gem.add_development_dependency 'fuubar'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'rubocop'
+  gem.add_development_dependency 'rubocop-performance'
+  gem.add_development_dependency 'rubocop-rake'
+  gem.add_development_dependency 'rubocop-rspec'
+  gem.add_development_dependency 'solargraph'
+  gem.add_development_dependency 'stub_env'
+  gem.add_development_dependency 'test-prof'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'webmock'
 end

data/lib/boletosimples.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'her'
 require 'faraday_middleware'
 require 'faraday-http-cache'
@@ -5,15 +7,21 @@ require 'boletosimples/version'
 
 module BoletoSimples
   autoload :Configuration, 'boletosimples/configuration'
-  autoload :Extra, 'boletosimples/extra'
   autoload :ResponseError, 'boletosimples/response_error'
   autoload :LastRequest, 'boletosimples/last_request'
 
   autoload :BankBillet, 'boletosimples/resources/bank_billet'
   autoload :BankBilletAccount, 'boletosimples/resources/bank_billet_account'
+  autoload :BankBilletDischarge, 'boletosimples/resources/bank_billet_discharge'
+  autoload :BankBilletPayment, 'boletosimples/resources/bank_billet_payment'
+  autoload :BankBilletRemittance, 'boletosimples/resources/bank_billet_remittance'
   autoload :Event, 'boletosimples/resources/event'
+  autoload :EmailDelivery, 'boletosimples/resources/email_delivery'
+  autoload :SmsDelivery, 'boletosimples/resources/sms_delivery'
   autoload :Customer, 'boletosimples/resources/customer'
+  autoload :CustomerImport, 'boletosimples/resources/customer_import'
   autoload :CustomerSubscription, 'boletosimples/resources/customer_subscription'
+  autoload :CustomerSubscriptionImport, 'boletosimples/resources/customer_subscription_import'
   autoload :Installment, 'boletosimples/resources/installment'
   autoload :Transaction, 'boletosimples/resources/transaction'
   autoload :Remittance, 'boletosimples/resources/remittance'
@@ -22,14 +30,11 @@ module BoletoSimples
   autoload :Webhook, 'boletosimples/resources/webhook'
   autoload :WebhookDelivery, 'boletosimples/resources/webhook_delivery'
 
-  module Partner
-    autoload :User, 'boletosimples/resources/partner/user'
-  end
-
   module Middleware
     autoload :UserAgent, 'boletosimples/middlewares/user_agent'
     autoload :RaiseError, 'boletosimples/middlewares/raise_error'
     autoload :LastRequest, 'boletosimples/middlewares/last_request'
+    autoload :Bearer, 'boletosimples/middlewares/bearer'
   end
 
   class << self
@@ -41,7 +46,6 @@ module BoletoSimples
       configuration.setup_her # after changing configuration gem her should be configured
     end
   end
-
 end
 
 BoletoSimples.configure

data/lib/boletosimples/configuration.rb

@@ -1,21 +1,19 @@
-# encoding: utf-8
-module BoletoSimples
+# frozen_string_literal: true
 
+module BoletoSimples
   class Configuration
-    attr_accessor :environment, :application_id, :application_secret, :access_token, :cache
-
+    attr_accessor :environment, :cache, :user_agent, :api_token
 
     BASE_URI = {
       sandbox: 'https://sandbox.boletosimples.com.br/api/v1',
       production: 'https://boletosimples.com.br/api/v1',
       development: 'http://localhost:5000/api/v1'
-    }
+    }.freeze
 
     def initialize
       @environment = (ENV['BOLETOSIMPLES_ENV'] || :sandbox).to_sym
-      @application_id = ENV['BOLETOSIMPLES_APP_ID']
-      @application_secret = ENV['BOLETOSIMPLES_APP_SECRET']
-      @access_token = ENV['BOLETOSIMPLES_ACCESS_TOKEN']
+      @api_token = ENV['BOLETOSIMPLES_API_TOKEN']
+      @user_agent = ENV['BOLETOSIMPLES_USER_AGENT']
       @cache = nil
     end
 
@@ -23,32 +21,19 @@ module BoletoSimples
       BASE_URI[@environment]
     end
 
-    def user_agent
-      "BoletoSimples Ruby Client v#{BoletoSimples::VERSION} (contato@boletosimples.com.br)"
-    end
-
-    def access_token?
-      !@access_token.nil?
-    end
-
-    def client_credentials
-      response = Her::API.default_api.connection.post 'oauth2/token', {
-        grant_type: 'client_credentials',
-        client_id: application_id,
-        client_secret: application_secret
-      }
-      response.body[:data]
+    def api_token?
+      !@api_token.nil?
     end
 
     def setup_her
-      Her::API.setup url: BoletoSimples.configuration.base_uri do |c|
+      Her::API.setup url: base_uri do |c|
         # Request
         c.use BoletoSimples::Middleware::UserAgent
-        c.use FaradayMiddleware::OAuth2, BoletoSimples.configuration.access_token if BoletoSimples.configuration.access_token?
+        c.use BoletoSimples::Middleware::Bearer if api_token?
+        c.use Faraday::Request::Multipart
         c.use FaradayMiddleware::EncodeJson
-        if !BoletoSimples.configuration.cache.nil?
-          c.use Faraday::HttpCache, store: BoletoSimples.configuration.cache
-        end
+        c.use Her::Middleware::AcceptJSON
+        c.use Faraday::HttpCache, store: cache unless cache.nil?
 
         # Response
         c.use BoletoSimples::Middleware::LastRequest
@@ -60,12 +45,12 @@ module BoletoSimples
       end
 
       # Because Her set the api on the moment module is included we need to call use_api again, after changing the configuration.
-      [BankBillet, BankBilletAccount, Customer, CustomerSubscription, Installment, Transaction, Partner::User,
-        Webhook, Discharge, Remittance, WebhookDelivery, Event].each do |klass|
+      [BankBillet, BankBilletAccount, Customer, CustomerImport, CustomerSubscription,
+       CustomerSubscriptionImport, Installment, Transaction, Webhook, Discharge,
+       Remittance, WebhookDelivery, Event, EmailDelivery, BankBilletDischarge,
+       BankBilletPayment, BankBilletRemittance, SmsDelivery].each do |klass|
         klass.send(:use_api, Her::API.default_api)
       end
     end
-
   end
-
 end

data/lib/boletosimples/last_request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BoletoSimples
   class LastRequest
     attr_reader :body, :response_headers, :total, :ratelimit_limit, :ratelimit_remaining, :links
@@ -15,29 +17,30 @@ module BoletoSimples
     end
 
     def total
-      @total ||= @env[:response_headers]["total"].to_i
+      @total ||= @env[:response_headers]['total'].to_i
     end
 
     def ratelimit_limit
-      ratelimit_limit ||= @env[:response_headers]["x-ratelimit-limit"].to_i
+      ratelimit_limit ||= @env[:response_headers]['x-ratelimit-limit'].to_i
     end
 
     def ratelimit_remaining
-      @ratelimit_remaining ||= @env[:response_headers]["x-ratelimit-remaining"].to_i
+      @ratelimit_remaining ||= @env[:response_headers]['x-ratelimit-remaining'].to_i
     end
 
     def links
       return @links unless @links.nil?
-      link_header = @env[:response_headers]["link"]
+
+      link_header = @env[:response_headers]['link']
       return {} if link_header.nil?
+
       @links = {}
-      link_header.split(", ").each do |link|
-        key = /rel=\"(.*)\"/.match(link)[1]
-        value = /\<(.*)\>/.match(link)[1]
+      link_header.split(', ').each do |link|
+        key = /rel="(.*)"/.match(link)[1]
+        value = /<(.*)>/.match(link)[1]
         @links[key] = value
       end
       @links.symbolize_keys!
     end
-
   end
-end
+end