boletosimples 0.4.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c76fb6e8155355e8695d78ee37756aa0cc2dc5cc
-  data.tar.gz: bddd7d242f6f1cc0b759397bceaf8ad5d8927deb
+SHA256:
+  metadata.gz: 5047dd925f3b36110d38363bd557b1e2e0485c11106663e515aaa995c9678bf8
+  data.tar.gz: 0612c53269469fc2288bed2a0ae12b54fa31cccecfe2e0adbb5fb6dcb7dc6ea4
 SHA512:
-  metadata.gz: 3b647a784cfe93ff534a75dce7298f51ccfee3ab72a2d070656ffd9d25476ed347c679733fc8a7960cef68195f6661cbbe9fabe14af20eac46eab40d10007b82
-  data.tar.gz: dbf082c46a21758f78e447a86dc580bd665cdb3f994c5f8d24edb40c561d3d39abb68f88a25ac3f8ed44fb897c3b4efa8adb31daf045e1e708b7f3ee9df4701d
+  metadata.gz: c091d334a34ea8c8fd8bd2e3fe7af7d3143fe53c1357f7453d27e0aaa9a416858bd7f3eef37fc346596169226d5b0ac1badfe3ab08d7024c3f5b3b4977f74f47
+  data.tar.gz: f170c056e9d3cd25363e2321ac3e277bd4c06aa65f03ed88406d874bf16d6723cfb1d57b444aa28d7b24e9d0664ad26c29ba18bc03abf254db2ece277224740e

data/CHANGELOG.md

@@ -1,24 +1,16 @@
 # Changelog
 
-## 0.4.2
+## 1.0.3
 
-### improvements
+### Changes
 
-- Update dependencies
+- Add debug option
 
-## 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/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,18 @@ 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.
+  # c.debug = true
 end
 ```
 
@@ -45,9 +44,8 @@ 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']
+ENV['BOLETOSIMPLES_DEBUG']
 ```
 
 ### Configurando cache
@@ -72,7 +70,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 +86,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 +110,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 +120,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 +132,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 +145,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/lib/boletosimples.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'her'
 require 'faraday_middleware'
 require 'faraday-http-cache'
@@ -5,13 +7,17 @@ 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'
@@ -24,14 +30,12 @@ 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 :Debug, 'boletosimples/middlewares/debug'
+    autoload :Bearer, 'boletosimples/middlewares/bearer'
   end
 
   class << self
@@ -43,7 +47,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,71 +1,62 @@
-# 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, :debug
 
     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
+      @debug = ENV['BOLETOSIMPLES_DEBUG']
     end
 
     def base_uri
       BASE_URI[@environment]
     end
 
-    def user_agent
-      "BoletoSimples Ruby Client v#{BoletoSimples::VERSION} (contato@boletosimples.com.br)"
+    def api_token?
+      !@api_token.nil?
     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 debug?
+      !@debug.nil?
     end
 
     def setup_her
       Her::API.setup url: base_uri do |c|
         # Request
         c.use BoletoSimples::Middleware::UserAgent
-        c.use FaradayMiddleware::OAuth2, access_token, token_type: 'param' if access_token?
+        c.use BoletoSimples::Middleware::Bearer if api_token?
         c.use Faraday::Request::Multipart
-        c.use Faraday::Request::UrlEncoded
         c.use FaradayMiddleware::EncodeJson
+        c.use Her::Middleware::AcceptJSON
         c.use Faraday::HttpCache, store: cache unless cache.nil?
 
         # Response
+        c.use BoletoSimples::Middleware::Debug if debug?
         c.use BoletoSimples::Middleware::LastRequest
         c.use BoletoSimples::Middleware::RaiseError
         c.use Her::Middleware::DefaultParseJSON
 
         # Adapter
-        c.use Faraday::Adapter::NetHttp
+        c.adapter Faraday::Adapter::NetHttp
       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, CustomerImport, CustomerSubscription, CustomerSubscriptionImport, 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

data/lib/boletosimples/middlewares/bearer.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module BoletoSimples
+  module Middleware
+    class Bearer < Faraday::Middleware
+      def call(env)
+        env[:request_headers]['Authorization'] = "Bearer #{BoletoSimples.configuration.api_token}"
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/boletosimples/middlewares/debug.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module BoletoSimples
+  module Middleware
+    class Debug < Faraday::Response::Middleware
+      def initialize(app, logger = nil)
+        super(app)
+        @logger = logger || begin
+          require 'logger'
+          ::Logger.new($stdout)
+        end
+      end
+
+      def on_complete(env)
+        @logger.info "\n::#{env[:method].upcase} #{env[:url]}"
+        @logger.info '  Request'
+        env[:request_headers].each do |key, value|
+          @logger.info "  -- #{key}: #{value}"
+        end
+        @logger.info '  Response'
+        @logger.info "  -- Status: #{env[:status]}"
+        env[:response_headers].each do |key, value|
+          @logger.info "  -- #{key}: #{value}"
+        end
+        @logger.info '  Response body'
+        @logger.info "  -- #{env[:body]} \n"
+      end
+    end
+  end
+end

data/lib/boletosimples/middlewares/last_request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BoletoSimples
   module Middleware
     class LastRequest < Faraday::Response::Middleware
@@ -6,4 +8,4 @@ module BoletoSimples
       end
     end
   end
-end
+end

data/lib/boletosimples/middlewares/raise_error.rb

@@ -1,11 +1,18 @@
+# frozen_string_literal: true
+
 module BoletoSimples
   module Middleware
     class RaiseError < Faraday::Response::Middleware
       def on_complete(env)
         status = env[:status].to_i
+        return if status == 422
+
         klass = BoletoSimples::ResponseError
-        raise klass.new(env) if (400..599).include?(status) and env[:body][:data][:error]
+        if (400..599).cover?(status) && env[:body][:errors]
+          puts env.inspect
+          raise klass, env
+        end
       end
     end
   end
-end
+end