boletosimples 0.0.7 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 544af5de32ea938f99ed648486d828b9414115f8
-  data.tar.gz: 29b5b8c262fa0e1e5c21db89a907ed2e390d4327
+  metadata.gz: 948e6f3aa087ac1903c87f91160c0f93e225dcea
+  data.tar.gz: 935cd49f3e6963721f5b02822441ee5921a83f7d
 SHA512:
-  metadata.gz: bf70373d7671b92546e502195f903db5206d578ecf715c6d9258ea5ba81c2a5af759e43dcb24694c83740d526d2dd20fbd6ce1ecc6f4256e3b60a46c9123cbbb
-  data.tar.gz: de8e4b256b7407fd4fd0ed4661ab1d45253117227fbb881090ceb483797531af97b596c18cd1b647677d4cd920d6e4fb0b9fc664e2140cf5331e74523453fdd6
+  metadata.gz: a512a53c11957d7d8392da1ee15bc86ebe1253bf85d3ff010fbf8f05a14aeda732eabd69fd087b052f57ae98a0bf4dd0da830b2465f51d1f215b15e20019f919
+  data.tar.gz: 9df50c21b21b7a952816772b93ce48febe8128b81e922643743b676732dff346ba5f2a1ffe30525b53a79710b62a99b0469099eae342f3df9f07213697b0f595

data/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## 0.0.7 (unreleased)
+## 0.1.1 (unreleased)
 
 ### features
 

data/README.md

@@ -14,8 +14,6 @@
 
 Esta gem inclui todos os métodos disponíveis na [Boleto Simples JSON API](http://api.boletosimples.com.br).
 
-Ela suporta Basic Auth e OAuth 2.0 para ações realizadas por parceiros.
-
 ## Instalação
 
 Adicione a linha a baixo no seu Gemfile:
@@ -30,9 +28,164 @@ Ou instale você mesmo:
 
     $ gem install boletosimples
 
+## Configuração
+
+```ruby
+require 'boletosimples'
+
+BoletoSimples.configure do |c|
+  c.environment = :production # defaut :sandbox
+  c.access_token = 'access-token'
+end
+```
+
+### Variáveis de ambiente
+
+Você também pode configurar as variáveis de ambiente a seguir e não será necessário chamar `BoletoSimples.configure`
+
+```bash
+ENV['BOLETOSIMPLES_ENV']
+ENV['BOLETOSIMPLES_APP_ID']
+ENV['BOLETOSIMPLES_APP_SECRET']
+ENV['BOLETOSIMPLES_ACCESS_TOKEN']
+```
+
+### Configurando cache
+
+É altamente recomendável utilizar o cache para evitar chegar no [limite de requisições](http://api.boletosimples.com.br/#limite-de-requisicoes)
+
+Para isso recomendamos a utilização da gem [Dalli](https://github.com/mperham/dalli)
+
+Exemplo:
+
+```ruby
+  require 'dalli'
+
+  BoletoSimples.configure do |c|
+    c.cache = ActiveSupport::Cache.lookup_store(:dalli_store, ['localhost:11211'], namespace: 'boletosimples_client', compress: true)
+  end
+```
+
 ## Exemplos
 
-Veja a [lista de métodos aqui](https://github.com/boletosimples/boletosimples-ruby/blob/master/example)
+### Boletos Bancários
+
+```ruby
+# Criar um boleto
+@bank_billet = BoletoSimples::BankBillet.create({
+  amount: 9.01,
+  description: 'Despesas do contrato 0012',
+  expire_at: '2014-01-01',
+  customer_address: 'Rua quinhentos',
+  customer_address_complement: 'Sala 4',
+  customer_address_number: '111',
+  customer_city_name: 'Rio de Janeiro',
+  customer_cnpj_cpf: '012.345.678-90',
+  customer_email: 'cliente@bom.com',
+  customer_neighborhood: 'Sao Francisco',
+  customer_person_name: 'Joao da Silva',
+  customer_person_type: 'individual',
+  customer_phone_number: '2112123434',
+  customer_state: 'RJ',
+  customer_zipcode: '12312-123',
+  notification_url: 'http://example.com.br/notify'
+})
+
+# Criar um novo boleto instanciando o objeto
+@bank_billet = BoletoSimples::BankBillet.new(amount: 199.99, expire_at: '2020-01-01')
+@bank_billet.description = 'Cobrança XPTO'
+@bank_billet.save
+
+# Mensagens de erro na criação do boleto
+@bank_billet = BoletoSimples::BankBillet.create(amount: 199.99)
+@bank_billet.response_errors
+  # {:expire_at=>["não pode ficar em branco", "não é uma data válida"], :customer_person_name=>["não pode ficar em branco"], :customer_cnpj_cpf=>["não pode ficar em branco", "não é um CPNJ ou CPF válido"], :description=>["não pode ficar em branco"], :customer_zipcode=>["não pode ficar em branco"]
+
+# Pegar informações de um boleto
+@bank_billet = BoletoSimples::BankBillet.find(1) # onde 1 é o id do boleto.
+
+ # Se o não for encontrado nenhum boleto com o id informado, uma exceção será levantada com a mensagem:
+ # Couldn't find BankBillet with 'id'=1
+
+# Listar os boletos
+@bank_billets = BoletoSimples::BankBillet.all(page: 1, per_page: 50)
+@bank_billet.each do |bank_billet|
+  puts bank_billet.id
+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
+
+```
+
+### Clientes
+
+```ruby
+# Criar um cliente
+@customer = BoletoSimples::Customer.create({
+  person_name: "Joao da Silva",
+  cnpj_cpf: "012.345.678-90",
+  email: "cliente@bom.com",
+  address: "Rua quinhentos",
+  city_name: "Rio de Janeiro",
+  state: "RJ",
+  neighborhood: "bairro",
+  zipcode: "12312-123",
+  address_number: "111",
+  address_complement: "Sala 4",
+  phone_number: "2112123434"
+})
+
+# Mensagens de erro na criação do cliente
+@customer = BoletoSimples::Customer.new(person_name: '')
+@customer.response_errors
+  # {:person_name=>["não pode ficar em branco"], :cnpj_cpf=>["não pode ficar em branco"], :zipcode=>["não pode ficar em branco"]}
+
+# Listar os clientes
+@customers = BoletoSimples::Customer.all(page: 1, per_page: 50)
+@customers.each do |customer|
+  puts customer.id
+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.id
+end
+```
+
+### Extras
+
+```ruby
+# Dados do usuário logado
+@userinfo = BoletoSimples::Extra.userinfo
+```
 
 ## OAuth 2.0 Authentication (para acessar as contas dos usuários)
 

data/boletosimples.gemspec

@@ -21,16 +21,16 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 1.9'
 
   # Gems that must be intalled for boletosimples to work
-  gem.add_dependency 'httparty', '~> 0.13.1'
-  gem.add_dependency 'multi_json', '~> 1.10.1'
-  gem.add_dependency 'oauth2', '~> 1.0.0'
+  gem.add_dependency 'her', '~> 0.7.3'
+  gem.add_dependency 'faraday_middleware', '~> 0.9.1'
+  gem.add_dependency 'faraday-http-cache', '~> 1.0.1'
 
   # Gems that must be installed for boletosimples to compile and build
-  gem.add_development_dependency 'pry'
-  gem.add_development_dependency 'rspec', '~> 3.1'
+  gem.add_development_dependency 'pry', '~> 0.10.1'
+  gem.add_development_dependency 'rspec', '~> 3.2.0'
   gem.add_development_dependency 'vcr', '~> 2.9'
-  gem.add_development_dependency 'webmock'
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'coveralls'
-  gem.add_development_dependency 'codeclimate-test-reporter'
+  gem.add_development_dependency 'webmock', '~> 1.20.4'
+  gem.add_development_dependency 'rake', '~> 10.4.2'
+  gem.add_development_dependency 'coveralls', '~> 0.7.11'
+  gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.4.7'
 end

data/lib/boletosimples.rb

@@ -1,5 +1,39 @@
-require 'json'
+require 'her'
+require 'faraday_middleware'
+require 'faraday-http-cache'
 require 'boletosimples/version'
-require 'boletosimples/client'
-require 'boletosimples/oauth_client'
-require 'oauth2_patch'
+
+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 :Customer, 'boletosimples/resources/customer'
+  autoload :Transaction, 'boletosimples/resources/transaction'
+  autoload :BaseModel, 'boletosimples/resources/base_model'
+
+  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'
+  end
+
+  class << self
+    attr_accessor :configuration, :last_request
+
+    def configure
+      @configuration = Configuration.new
+      yield(configuration) if block_given?
+      configuration.setup_her # after changing configuration gem her should be configured
+    end
+  end
+
+end
+
+BoletoSimples.configure

data/lib/boletosimples/configuration.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+module BoletoSimples
+
+  class Configuration
+    attr_accessor :environment, :application_id, :application_secret, :access_token, :cache
+
+
+    BASE_URI = {
+      sandbox: 'https://sandbox.boletosimples.com.br/api/v1',
+      production: 'https://boletosimples.com.br/api/v1'
+    }
+
+    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']
+      @cache = nil
+    end
+
+    def base_uri
+      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]
+    end
+
+    def setup_her
+      Her::API.setup url: BoletoSimples.configuration.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 FaradayMiddleware::EncodeJson
+        if !BoletoSimples.configuration.cache.nil?
+          c.use Faraday::HttpCache, store: BoletoSimples.configuration.cache
+        end
+
+        # Response
+        c.use BoletoSimples::Middleware::LastRequest
+        c.use BoletoSimples::Middleware::RaiseError
+        c.use Her::Middleware::DefaultParseJSON
+
+        # Adapter
+        c.use 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, Customer, Transaction, Partner::User].each do |klass|
+        klass.send(:use_api, Her::API.default_api)
+      end
+    end
+
+  end
+
+end

data/lib/boletosimples/extra.rb

@@ -0,0 +1,8 @@
+module BoletoSimples
+  class Extra
+    def self.userinfo
+      response = Her::API.default_api.connection.get '/api/v1/userinfo.json'
+      response.body[:data]
+    end
+  end
+end

data/lib/boletosimples/last_request.rb

@@ -0,0 +1,43 @@
+module BoletoSimples
+  class LastRequest
+    attr_reader :body, :response_headers, :total, :ratelimit_limit, :ratelimit_remaining, :links
+
+    def initialize(env)
+      @env = env
+    end
+
+    def body
+      @body ||= @env[:body][:data]
+    end
+
+    def response_headers
+      @response_headers ||= @env[:response_headers]
+    end
+
+    def total
+      @total ||= @env[:response_headers]["total"].to_i
+    end
+
+    def ratelimit_limit
+      ratelimit_limit ||= @env[:response_headers]["x-ratelimit-limit"].to_i
+    end
+
+    def ratelimit_remaining
+      @ratelimit_remaining ||= @env[:response_headers]["x-ratelimit-remaining"].to_i
+    end
+
+    def links
+      return @links unless @links.nil?
+      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]
+        @links[key] = value
+      end
+      @links.symbolize_keys!
+    end
+
+  end
+end

data/lib/boletosimples/middlewares/last_request.rb

@@ -0,0 +1,9 @@
+module BoletoSimples
+  module Middleware
+    class LastRequest < Faraday::Response::Middleware
+      def on_complete(env)
+        BoletoSimples.last_request = BoletoSimples::LastRequest.new(env)
+      end
+    end
+  end
+end

data/lib/boletosimples/middlewares/raise_error.rb

@@ -0,0 +1,11 @@
+module BoletoSimples
+  module Middleware
+    class RaiseError < Faraday::Response::Middleware
+      def on_complete(env)
+        status = env[:status].to_i
+        klass = BoletoSimples::ResponseError
+        raise klass.new(env) if (400..599).include?(status) and env[:body][:data][:error]
+      end
+    end
+  end
+end

data/lib/boletosimples/middlewares/user_agent.rb

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

data/lib/boletosimples/resources/bank_billet.rb

@@ -0,0 +1,13 @@
+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]
+      end
+      self
+    end
+  end
+end

data/lib/boletosimples/resources/base_model.rb

@@ -0,0 +1,8 @@
+module BoletoSimples
+  class BaseModel
+    include Her::Model
+
+    parse_root_in_json true
+    include_root_in_json true
+  end
+end