boletosimples 0.6.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 267fcb0a89580d774bde7f6f875cedffb19d56cf81b5fea7adc7a25d51948320
-  data.tar.gz: 121d8f4fa802857f9b401ff37f33ac72fcecb0c43f1ceb817687d342e097b8fb
+  metadata.gz: 4b0b065f756a9ee10d080e10686637aee38ca6b63306878dc4879dbf56fd676c
+  data.tar.gz: c83c0eadff5245a19d07ea7a6cbe8c184eeed809e0895db4eb9ca78802250cf8
 SHA512:
-  metadata.gz: a3e8c7819279bc063e647329d89bda39047cc70182df5c6832fbc9635382b92896dbbf670dceba67698f88bd6fca35defb2a4bad49911b9aaa19b0fad2a39e27
-  data.tar.gz: 1eb282604546f93c830134f9137c3f78a73190d3461d4c1e7a6f8e065a188321f8d030a4bbcc92892903123d6978d1c755f21ff8e4a2ce999cee8e477803eaac
+  metadata.gz: 977fb2769a02f9fcc6da3e2a4a4fe35ba9fe9f80327584bfc3b48dbb1446ea666f1b1cb0c5b61d09422cc1f1ff702a88768e3b58c820b8c83121972dab9ae4cd
+  data.tar.gz: fa35fda07bc7f85c31c03f4991fed958107e4709418292798c22122da79940719688bc337c5ab686224877102c30e475421e79e9d117b4f7ba66c883fba7c333

data/CHANGELOG.md

@@ -1,24 +1,28 @@
 # Changelog
 
-## 0.4.2
+## 2.0.0
 
-### improvements
+### Changes
 
-- Update dependencies
+- Update URLs based on new API: https://developers.kobana.com.br/reference/endpoints-1
 
-## 0.2.2
+## 1.0.4
 
-### features
+### Changes
 
-- Add BankBilletAccount resource
+- Fix cache
 
-## 0.1.1
+## 1.0.3
 
-### features
+### Changes
 
-- Created `client.cancel_bank_billet(id, options)` to cancel bank billets
+- Add debug option
 
-### improvements
+## 1.0.0
 
-- 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)`
+### Breaking changes
+
+- Remove Oauth code
+- Require user_agent configuration
+- Require api_token configuration
+- All Errors now return with same root `errors`

data/README.md

@@ -1,18 +1,11 @@
 # 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).
+Biblioteca Ruby para acessar informações da [Kobana](https://www.kobana.com.br) através da [API](https://api.kobana.com.br).
 
 ## Instalação
 
@@ -30,12 +23,19 @@ Ou instale você mesmo:
 
 ## Configuração
 
+Saiba mais sobre o [Token de API ](https://developers.kobana.com.br/reference/token-de-acesso)
+
 ```ruby
 require 'boletosimples'
 
 BoletoSimples.configure do |c|
   c.environment = :production # defaut :sandbox
-  c.access_token = 'access-token'
+  # production - https://app.kobana.com.br/conta/api/tokens
+  # sandbox - https://app-sandbox.kobana.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
+  # c.custom_headers = { 'X-CUSTOM' => 'CONTENT' }
 end
 ```
 
@@ -45,14 +45,13 @@ 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
 
-É altamente recomendável utilizar o cache para evitar chegar no [limite de requisições](http://api.boletosimples.com.br/#limite-de-requisicoes)
+É altamente recomendável utilizar o cache para evitar chegar no [limite de requisições](https://developers.kobana.com.br/reference/limite-de-requisições)
 
 Para isso recomendamos a utilização da gem [Dalli](https://github.com/mperham/dalli)
 
@@ -62,7 +61,9 @@ Exemplo:
   require 'dalli'
 
   BoletoSimples.configure do |c|
-    c.cache = ActiveSupport::Cache.lookup_store(:dalli_store, ['localhost:11211'], namespace: 'boletosimples_client', compress: true)
+    c.cache = ActiveSupport::Cache.lookup_store(:mem_cache_store, ['localhost:11211'],
+                                              namespace: 'boletosimples_client',
+                                              compress: true)
   end
 ```
 
@@ -72,7 +73,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 +89,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,17 +113,8 @@ 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
+@bank_billet = BoletoSimples::BankBillet.cancel(id: 1)
 
 ```
 
@@ -130,7 +122,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 +134,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 +147,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/configuration.rb

@@ -1,67 +1,64 @@
-# encoding: utf-8
-module BoletoSimples
+# frozen_string_literal: true
 
+module BoletoSimples
   class Configuration
-    attr_accessor :environment, :application_id, :application_secret, :access_token, :cache, :user_agent
+    attr_accessor :environment, :cache, :user_agent, :custom_headers, :api_token, :debug
 
     BASE_URI = {
-      sandbox: 'https://sandbox.boletosimples.com.br/api/v1',
-      production: 'https://boletosimples.com.br/api/v1',
+      sandbox: 'https://api-sandbox.kobana.com.br/v1',
+      production: 'https://api.kobana.com.br/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']
+      @environment = ENV.fetch('BOLETOSIMPLES_ENV', :sandbox).to_sym
+      @api_token = ENV.fetch('BOLETOSIMPLES_API_TOKEN', nil)
+      @user_agent = ENV.fetch('BOLETOSIMPLES_USER_AGENT', nil)
+      @custom_headers = {}
       @cache = nil
-      @user_agent = ENV['BOLETOSIMPLES_USER_AGENT'] || "BoletoSimples Ruby Client v#{BoletoSimples::VERSION} (contato@boletosimples.com.br)"
+      @debug = ENV.fetch('BOLETOSIMPLES_DEBUG', nil)
     end
 
     def base_uri
       BASE_URI[@environment]
     end
 
-    def access_token?
-      !@access_token.nil?
+    def api_token?
+      !@api_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 BoletoSimples::Middleware::CustomHeaders
         c.use Faraday::Request::Multipart
-        c.use Faraday::Request::UrlEncoded
         c.use FaradayMiddleware::EncodeJson
-        c.use Faraday::HttpCache, store: cache unless cache.nil?
+        c.use Her::Middleware::AcceptJSON
+        c.use Faraday::HttpCache, store: cache, serializer: Marshal 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, EmailDelivery, BankBilletDischarge, BankBilletPayment, BankBilletRemittance].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,6 +1,8 @@
+# frozen_string_literal: true
+
 module BoletoSimples
   class LastRequest
-    attr_reader :body, :response_headers, :total, :ratelimit_limit, :ratelimit_remaining, :links
+    attr_reader :body, :request_headers, :response_headers, :total, :ratelimit_limit, :ratelimit_remaining, :links
 
     def initialize(env)
       @env = env
@@ -10,34 +12,39 @@ module BoletoSimples
       @body ||= @env[:body][:data]
     end
 
+    def request_headers
+      @request_headers ||= @env.request_headers
+    end
+
     def response_headers
       @response_headers ||= @env[:response_headers]
     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/custom_headers.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module BoletoSimples
+  module Middleware
+    class CustomHeaders < Faraday::Middleware
+      def call(env)
+        env[:request_headers].merge!(BoletoSimples.configuration.custom_headers)
+        @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

data/lib/boletosimples/middlewares/user_agent.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module BoletoSimples
   module Middleware
     class UserAgent < Faraday::Middleware
       def call(env)
-        env[:request_headers]["User-Agent"] = BoletoSimples.configuration.user_agent
+        env[:request_headers]['User-Agent'] = BoletoSimples.configuration.user_agent
         @app.call(env)
       end
     end

data/lib/boletosimples/resources/bank_billet.rb

@@ -1,14 +1,8 @@
+# frozen_string_literal: true
+
 module BoletoSimples
   class BankBillet < BaseModel
-
-    def cancel
-      self.class.request(:_method => :put, :_path => self.class.build_request_path('bank_billets/:id/cancel', {self.class.primary_key => id})) do |parsed_data, response|
-        assign_attributes(self.class.parse(parsed_data[:data])) if parsed_data[:data].any?
-        @metadata = parsed_data[:metadata]
-        @response_errors = parsed_data[:errors]
-        @response = response
-      end
-      return @response.success?
-    end
+    custom_put :pay, :cancel
+    custom_post :duplicate
   end
-end
+end

data/lib/boletosimples/resources/bank_billet_account.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module BoletoSimples
   class BankBilletAccount < BaseModel
   end
-end
+end

data/lib/boletosimples/resources/bank_billet_discharge.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module BoletoSimples
   class BankBilletDischarge < BaseModel
   end
-end
+end

data/lib/boletosimples/resources/bank_billet_payment.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module BoletoSimples
   class BankBilletPayment < BaseModel
   end
-end
+end

data/lib/boletosimples/resources/bank_billet_remittance.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module BoletoSimples
   class BankBilletRemittance < BaseModel
   end
-end
+end

data/lib/boletosimples/resources/base_model.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BoletoSimples
   class BaseModel
     include Her::Model
@@ -5,4 +7,4 @@ module BoletoSimples
     parse_root_in_json true
     include_root_in_json true
   end
-end
+end

data/lib/boletosimples/resources/customer.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module BoletoSimples
   class Customer < BaseModel
   end
-end
+end

data/lib/boletosimples/resources/customer_import.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module BoletoSimples
   class CustomerImport < BaseModel
-    collection_path "imports/customers"
-    resource_path "imports/customers/:id"
+    collection_path 'imports/customers'
+    resource_path 'imports/customers/:id'
   end
-end
+end

data/lib/boletosimples/resources/customer_subscription.rb

@@ -1,14 +1,7 @@
+# frozen_string_literal: true
+
 module BoletoSimples
   class CustomerSubscription < BaseModel
-
-    def next_charge
-      self.class.request(:_method => :post, :_path => self.class.build_request_path('customer_subscriptions/:id/next_charge', {self.class.primary_key => id})) do |parsed_data, response|
-        assign_attributes(self.class.parse(parsed_data[:data])) if parsed_data[:data].any?
-        @metadata = parsed_data[:metadata]
-        @response_errors = parsed_data[:errors]
-        @response = response
-      end
-      return @response.success?
-    end
+    custom_post :next_charge
   end
 end

data/lib/boletosimples/resources/customer_subscription_import.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module BoletoSimples
   class CustomerSubscriptionImport < BaseModel
-    collection_path "imports/customer_subscriptions"
-    resource_path "imports/customer_subscriptions/:id"
+    collection_path 'imports/customer_subscriptions'
+    resource_path 'imports/customer_subscriptions/:id'
   end
-end
+end

data/lib/boletosimples/resources/discharge.rb

@@ -1,14 +1,7 @@
+# frozen_string_literal: true
+
 module BoletoSimples
   class Discharge < BaseModel
-    
-    def pay_off
-      self.class.request(:_method => :put, :_path => self.class.build_request_path('discharges/:id/pay_off', {self.class.primary_key => id})) do |parsed_data, response|
-        assign_attributes(self.class.parse(parsed_data[:data])) if parsed_data[:data].any?
-        @metadata = parsed_data[:metadata]
-        @response_errors = parsed_data[:errors]
-        @response = response
-      end
-      return @response.success?
-    end
+    custom_put :pay_off
   end
-end
+end

data/lib/boletosimples/resources/email_delivery.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module BoletoSimples
   class EmailDelivery < BaseModel
   end
-end
+end

data/lib/boletosimples/resources/event.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module BoletoSimples
   class Event < BaseModel
   end
-end
+end

data/lib/boletosimples/resources/installment.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module BoletoSimples
   class Installment < BaseModel
   end
-end
+end

data/lib/boletosimples/resources/remittance.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module BoletoSimples
   class Remittance < BaseModel
   end
-end
+end

data/lib/boletosimples/resources/sms_delivery.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module BoletoSimples
+  class SmsDelivery < BaseModel
+  end
+end