boletosimples 0.0.7 → 0.1.1

data/lib/boletosimples/resources/customer.rb

@@ -0,0 +1,4 @@
+module BoletoSimples
+  class Customer < BaseModel
+  end
+end

data/lib/boletosimples/resources/partner/user.rb

@@ -0,0 +1,7 @@
+module BoletoSimples
+  module Partner
+    class User < BoletoSimples::BaseModel
+      collection_path "partner/users"
+    end
+  end
+end

data/lib/boletosimples/resources/transaction.rb

@@ -0,0 +1,4 @@
+module BoletoSimples
+  class Transaction < BaseModel
+  end
+end

data/lib/boletosimples/response_error.rb

@@ -0,0 +1,43 @@
+module BoletoSimples
+  # BoletoSimples::ResponseError
+  # Exception that gets raised if the response is an error (4xx or 5xx)
+  #
+  # Formats a readable error message including HTTP status, method and requested URL
+  #
+  # Examples:
+  #
+  #   BoletoSimples::BankBillet.all
+  #   BoletoSimples::ResponseError: 401 POST https://sandbox.boletosimples.com.br/api/v1/bank_billets
+  #
+  #   begin
+  #     BoletoSimples::BankBillet.all
+  #   rescue BoletoSimples::ResponseError => response
+  #     response.status # => 401
+  #     response.method # => "GET"
+  #     response.url # => "https://sandbox.boletosimples.com.br/api/v1/bank_billets"
+  #     response.body # => "{"error":"Você precisa se logar ou registrar antes de prosseguir."}"
+  #     response.error_message # => "Você precisa se logar ou registrar antes de prosseguir."
+  #   end
+  #
+  class ResponseError < StandardError
+    attr_reader :response, :body, :status, :method, :url, :error_message
+
+    def initialize(response = nil)
+      @response = response
+
+      @body = response[:body][:data]
+      @status = response[:status].to_i
+      @method = response[:method].to_s.upcase
+      @url = response[:url]
+      @error_message = @body[:error]
+
+      super
+    end
+
+    def to_s
+      msg = "#{status} #{method} #{url}"
+      msg << " (#{error_message})" unless error_message.blank?
+      msg
+    end
+  end
+end

data/lib/boletosimples/version.rb

@@ -1,3 +1,3 @@
 module BoletoSimples
-  VERSION = '0.0.7'
+  VERSION = '0.1.1'
 end

data/spec/boletosimples/configuration_spec.rb

@@ -0,0 +1,84 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+RSpec.describe BoletoSimples::Configuration do
+  describe 'defaults' do
+    before {
+      allow(ENV).to receive(:[]).with('BOLETOSIMPLES_ENV').and_return(nil)
+      allow(ENV).to receive(:[]).with('BOLETOSIMPLES_APP_ID').and_return(nil)
+      allow(ENV).to receive(:[]).with('BOLETOSIMPLES_APP_SECRET').and_return(nil)
+      allow(ENV).to receive(:[]).with('BOLETOSIMPLES_ACCESS_TOKEN').and_return(nil)
+    }
+    subject { BoletoSimples::Configuration.new }
+    it { expect(subject.environment).to eq(:sandbox) }
+    it { expect(subject.base_uri).to eq('https://sandbox.boletosimples.com.br/api/v1') }
+    it { expect(subject.application_id).to be_nil }
+    it { expect(subject.application_secret).to be_nil }
+    it { expect(subject.access_token).to be_nil }
+    it { expect(subject.cache).to be_nil }
+    it { expect(subject).not_to be_access_token }
+  end
+  describe 'environment variables' do
+    before {
+      allow(ENV).to receive(:[]).with('BOLETOSIMPLES_ENV').and_return('production')
+      allow(ENV).to receive(:[]).with('BOLETOSIMPLES_APP_ID').and_return('app-id')
+      allow(ENV).to receive(:[]).with('BOLETOSIMPLES_APP_SECRET').and_return('app-secret')
+      allow(ENV).to receive(:[]).with('BOLETOSIMPLES_ACCESS_TOKEN').and_return('access-token')
+    }
+    subject { BoletoSimples::Configuration.new }
+    it { expect(subject.environment).to eq(:production) }
+    it { expect(subject.base_uri).to eq('https://boletosimples.com.br/api/v1') }
+    it { expect(subject.application_id).to eq('app-id') }
+    it { expect(subject.application_secret).to eq('app-secret') }
+    it { expect(subject.access_token).to eq('access-token') }
+    it { expect(subject).to be_access_token }
+    describe 'cache' do
+      it { expect(subject.cache).to be_nil }
+      it { expect(Her::API.default_api.connection.builder.handlers).not_to include(Faraday::HttpCache) }
+    end
+  end
+  describe 'configuration' do
+    let(:cache_object) { double('Dalli') }
+    before {
+      BoletoSimples.configure do |c|
+        c.environment = :production
+        c.application_id = 'app-id'
+        c.application_secret = 'app-secret'
+        c.access_token = 'access-token'
+        c.cache = cache_object
+      end
+    }
+    subject { BoletoSimples.configuration }
+    it { expect(subject.environment).to eq(:production) }
+    it { expect(subject.user_agent).to eq("BoletoSimples Ruby Client v#{BoletoSimples::VERSION} (contato@boletosimples.com.br)") }
+    it { expect(subject.base_uri).to eq('https://boletosimples.com.br/api/v1') }
+    it { expect(subject.application_id).to eq('app-id') }
+    it { expect(subject.application_secret).to eq('app-secret') }
+    it { expect(subject.access_token).to eq('access-token') }
+    describe 'cache' do
+      it { expect(subject.cache).to eq(cache_object) }
+      it { expect(Her::API.default_api.connection.builder.handlers).to include(Faraday::HttpCache) }
+    end
+    describe 'client credentials' do
+      context 'invalid credentials', vcr: { cassette_name: 'configuration/client_credentials/invalid'} do
+        before {
+          BoletoSimples.configure do |c|
+            c.application_id = 'app-id'
+            c.application_secret = 'app-secret'
+            c.access_token = nil
+          end
+        }
+        it { expect{subject.client_credentials}.to raise_error(BoletoSimples::ResponseError, "401 POST https://sandbox.boletosimples.com.br/api/v1/oauth2/token (invalid_client)") }
+      end
+      context 'valid credentials', vcr: { cassette_name: 'configuration/client_credentials/valid'} do
+        # Before running this spec again, you need to set environment variable BOLETOSIMPLES_APP_ID and BOLETOSIMPLES_APP_SECRET
+        before {
+          BoletoSimples.configure do |c|
+            c.access_token = nil
+          end
+        }
+        it { expect(subject.client_credentials).to include(:access_token) }
+      end
+    end
+  end
+end

data/spec/boletosimples/extra_spec.rb

@@ -0,0 +1,31 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+# Before running this spec again, you need to set environment variable BOLETOSIMPLES_ACCESS_TOKEN
+RSpec.describe BoletoSimples::Extra do
+  context 'not authenticated' do
+    before {
+      BoletoSimples.configure do |c|
+        c.application_id = nil
+        c.application_secret = nil
+        c.access_token = 'invalid'
+      end
+    }
+    describe 'userinfo', vcr: { cassette_name: 'extra/userinfo/not_authenticated'} do
+      subject { BoletoSimples::Extra.userinfo }
+      it { expect{subject}.to raise_error(BoletoSimples::ResponseError, "401 GET https://sandbox.boletosimples.com.br/api/v1/userinfo.json?access_token=invalid (Você precisa se logar ou registrar antes de prosseguir.)") }
+    end
+  end
+  context 'authenticated' do
+    before {
+      BoletoSimples.configure do |c|
+        c.application_id = nil
+        c.application_secret = nil
+      end
+    }
+    describe 'userinfo', vcr: { cassette_name: 'extra/userinfo/authenticated'} do
+      subject { BoletoSimples::Extra.userinfo }
+      it { expect(subject).to eq({:id=>53, :login_url=>"https://sandbox.boletosimples.com.br/welcome?email=user1%40example.com&token=Dx6tDtrP_v9_CcDjMRmr", :email=>"user1@example.com", :account_type=>nil, :first_name=>nil, :middle_name=>nil, :last_name=>nil, :full_name=>nil, :cpf=>nil, :date_of_birth=>nil, :mother_name=>nil, :father_name=>nil, :account_level=>2, :phone_number=>nil, :address_street_name=>nil, :address_number=>nil, :address_complement=>nil, :address_neighborhood=>nil, :address_postal_code=>nil, :address_city_name=>nil, :address_state=>nil, :business_name=>nil, :business_cnpj=>nil, :business_legal_name=>nil}) }
+    end
+  end
+end

data/spec/boletosimples/last_request_spec.rb

@@ -0,0 +1,34 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+RSpec.describe BoletoSimples::LastRequest do
+  before {
+    BoletoSimples.configure do |c|
+      c.application_id = nil
+      c.application_secret = nil
+    end
+  }
+  describe 'bank_billets', vcr: { cassette_name: 'last_request/bank_billets'} do
+    before { BoletoSimples::BankBillet.all.size }
+    subject { BoletoSimples.last_request }
+    it { expect(subject).to be_kind_of(BoletoSimples::LastRequest) }
+    it { expect(subject.body).to be_kind_of(Array) }
+    it { expect(subject.body.first).to be_kind_of(Hash) }
+    it { expect(subject.response_headers).to be_kind_of(Hash) }
+    it { expect(subject.total).to be_kind_of(Integer) }
+    it { expect(subject.ratelimit_limit).to be_kind_of(Integer) }
+    it { expect(subject.ratelimit_remaining).to be_kind_of(Integer) }
+    it { expect(subject.links.keys).to match_array([:next, :last]) }
+  end
+  describe 'user_info', vcr: { cassette_name: 'last_request/userinfo'} do
+    before { BoletoSimples::Extra.userinfo }
+    subject { BoletoSimples.last_request }
+    it { expect(subject).to be_kind_of(BoletoSimples::LastRequest) }
+    it { expect(subject.body).to be_kind_of(Hash) }
+    it { expect(subject.response_headers).to be_kind_of(Hash) }
+    it { expect(subject.total).to eq(0) }
+    it { expect(subject.ratelimit_limit).to be_kind_of(Integer) }
+    it { expect(subject.ratelimit_remaining).to be_kind_of(Integer) }
+    it { expect(subject.links).to eq({}) }
+  end
+end

data/spec/boletosimples/resources/bank_billet_spec.rb

@@ -0,0 +1,75 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+# Before running this spec again, you need to set environment variable BOLETOSIMPLES_ACCESS_TOKEN
+RSpec.describe BoletoSimples::BankBillet do
+  before {
+    BoletoSimples.configure do |c|
+      c.application_id = nil
+      c.application_secret = nil
+    end
+  }
+  describe 'methods' do
+    before {
+      VCR.use_cassette('resources/bank_billet/create/valid') do
+        @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'
+        })
+      end
+    }
+    describe 'create' do
+      context 'valid parameters' do
+        subject { @bank_billet }
+        it { expect(subject).to be_a_kind_of(BoletoSimples::BankBillet) }
+        it { expect(subject.response_errors).to eq({}) }
+        it { expect(subject.attributes.keys).to match_array(["amount","description","expire_at","customer_address","customer_address_complement","customer_address_number","customer_city_name","customer_cnpj_cpf","customer_email","customer_neighborhood","customer_person_name","customer_person_type","customer_phone_number","customer_state","customer_zipcode","notification_url","id","paid_at","status","shorten_url","send_email_on_creation","created_via_api","paid_amount"]) }
+      end
+      context 'invalid parameters' do
+        context 'empty bank_billet' do
+          subject {
+            VCR.use_cassette('resources/bank_billet/create/invalid_root') do
+              BoletoSimples::BankBillet.create({})
+            end
+          }
+          it { expect(subject.response_errors).to eq({:bank_billet=>["não pode ficar em branco"]}) }
+        end
+        context 'invalid params' do
+          subject {
+            VCR.use_cassette('resources/bank_billet/create/invalid_params') do
+              BoletoSimples::BankBillet.create({amount: 9.1})
+            end
+          }
+          it { expect(subject.response_errors).to eq({: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"], :description=>["não pode ficar em branco"], :customer_zipcode=>["não pode ficar em branco"]}) }
+        end
+      end
+    end
+    describe 'find', vcr: { cassette_name: 'resources/bank_billet/find'} do
+      subject { BoletoSimples::BankBillet.find(@bank_billet.id) }
+      it { expect(subject).to be_a_kind_of(BoletoSimples::BankBillet) }
+    end
+    describe 'cancel', vcr: { cassette_name: 'resources/bank_billet/cancel'} do
+      subject { BoletoSimples::BankBillet.find(@bank_billet.id).cancel }
+      it { expect(subject).to be_a_kind_of(BoletoSimples::BankBillet) }
+    end
+    describe 'all', vcr: { cassette_name: 'resources/bank_billet/all'} do
+      subject { BoletoSimples::BankBillet.all }
+      it { expect(subject.first).to be_a_kind_of(BoletoSimples::BankBillet) }
+    end
+  end
+end

data/spec/boletosimples/resources/customer_spec.rb

@@ -0,0 +1,66 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+# Before running this spec again, you need to set environment variable BOLETOSIMPLES_ACCESS_TOKEN
+RSpec.describe BoletoSimples::Customer do
+  before {
+    BoletoSimples.configure do |c|
+      c.application_id = nil
+      c.application_secret = nil
+    end
+  }
+  describe 'methods' do
+    before {
+      VCR.use_cassette('resources/customer/create/valid') do
+        @customer = BoletoSimples::Customer.create({
+          person_name: "Maria José",
+          cnpj_cpf: "811.536.151-85",
+          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"
+        })
+      end
+    }
+    describe 'create' do
+      context 'valid parameters' do
+        subject { @customer }
+        it { expect(subject).to be_a_kind_of(BoletoSimples::Customer) }
+        it { expect(subject.response_errors).to eq({}) }
+        it { expect(subject.attributes.keys).to match_array(["person_name","cnpj_cpf","email","address","city_name","state","neighborhood","zipcode","address_number","address_complement","phone_number","mobile_number","person_type","mobile_local_code","created_via_api","id"]) }
+      end
+      context 'invalid parameters' do
+        context 'empty bank_billet' do
+          subject {
+            VCR.use_cassette('resources/customer/create/invalid_root') do
+              BoletoSimples::Customer.create({})
+            end
+          }
+          it { expect(subject.response_errors).to eq({:customer=>["não pode ficar em branco"]}) }
+        end
+        context 'invalid params' do
+          subject {
+            VCR.use_cassette('resources/customer/create/invalid_params') do
+              BoletoSimples::Customer.create({person_name: ''})
+            end
+          }
+          it { expect(subject.response_errors).to eq({:person_name=>["não pode ficar em branco"], :cnpj_cpf=>["não pode ficar em branco"], :zipcode=>["não pode ficar em branco"]}) }
+        end
+      end
+    end
+    describe 'find', vcr: { cassette_name: 'resources/customer/find'} do
+      subject { BoletoSimples::Customer.find(@customer.id) }
+      it { expect(subject).to be_a_kind_of(BoletoSimples::Customer) }
+    end
+    describe 'all', vcr: { cassette_name: 'resources/customer/all'} do
+      subject { BoletoSimples::Customer.all }
+      it { expect(subject.first).to be_a_kind_of(BoletoSimples::Customer) }
+    end
+  end
+end

data/spec/boletosimples/resources/partner/user_spec.rb

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+# Before running this spec again, you need to set environment variable BOLETOSIPLES_CLIENT_CREDENTIALS_TOKEN
+RSpec.describe BoletoSimples::Partner::User do
+  before {
+    BoletoSimples.configure do |c|
+      c.access_token = ENV['BOLETOSIMPLES_CLIENT_CREDENTIALS_TOKEN']
+    end
+  }
+  # ATENÇÃO: Após rodar este teste, edite o vcr_cassette e remova o token do login_url e substitua o application_access_token para xxx
+  describe 'create', vcr: { cassette_name: 'resources/partner/user/create'} do
+    subject { BoletoSimples::Partner::User.create(email: 'user2@example.com') }
+    it { expect(subject.id).not_to be_nil }
+    it { expect(subject.response_errors).to eq({}) }
+    it { expect(subject.attributes.keys).to eq(["email", "id", "account_type", "sex", "cpf", "address_street_name", "address_state", "address_neighborhood", "address_postal_code", "address_number", "address_complement", "phone_number", "withdrawal_period", "notification_url", "first_name", "middle_name", "last_name", "date_of_birth", "business_category", "business_subcategory", "business_website", "business_name", "business_legal_name", "business_type", "business_cnpj", "address_city_name", "full_name", "login_url", "mother_name", "father_name", "application_access_token"]) }
+  end
+end

data/spec/boletosimples/resources/transactions_spec.rb

@@ -0,0 +1,17 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+# Before running this spec again, you need to set environment variable BOLETOSIMPLES_ACCESS_TOKEN
+RSpec.describe BoletoSimples::Transaction do
+  before {
+    BoletoSimples.configure do |c|
+      c.application_id = nil
+      c.application_secret = nil
+    end
+  }
+  describe 'all', vcr: { cassette_name: 'resources/transaction/all'} do
+    subject { BoletoSimples::Transaction.all }
+    it { expect(subject.first).to be_a_kind_of(BoletoSimples::Transaction) }
+  end
+end

data/spec/fixtures/vcr_cassettes/configuration/client_credentials/invalid.yml

@@ -0,0 +1,64 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://sandbox.boletosimples.com.br/api/v1/oauth2/token
+    body:
+      encoding: UTF-8
+      string: '{"grant_type":"client_credentials","client_id":"app-id","client_secret":"app-secret"}'
+    headers:
+      User-Agent:
+      - BoletoSimples Ruby Client v0.1.0 (contato@boletosimples.com.br)
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 401
+      message: Unauthorized
+    headers:
+      Server:
+      - Cowboy
+      Connection:
+      - keep-alive
+      Strict-Transport-Security:
+      - max-age=2592000
+      Cache-Control:
+      - no-store
+      Pragma:
+      - no-cache
+      Content-Type:
+      - application/json; charset=utf-8
+      Www-Authenticate:
+      - !binary |-
+        QmVhcmVyIHJlYWxtPSJCb2xldG9TaW1wbGVzIiwgZXJyb3I9ImludmFsaWRf
+        Y2xpZW50IiwgZXJyb3JfZGVzY3JpcHRpb249IkF1dGVudGljYcOnw6NvIGRv
+        IGNsaWVudGUgZmFsaG91IGRldmlkbyBow6EgdW0gY2xpZW50ZSBkZXNjb25o
+        ZWNpZG8sIG5lbmh1bSBjbGllbnRlIGRlIGF1dGVudGljYcOnw6NvIGluY2x1
+        c28sIG91IG3DqXRvZG8gZGUgYXV0ZW50aWNhw6fDo28gbsOjbyBzdXBvcnRh
+        ZG8uIg==
+      X-Request-Id:
+      - c694e3a4-3021-40b6-94f4-b8e8d8bac941
+      X-Runtime:
+      - '0.014012'
+      Date:
+      - Sun, 08 Mar 2015 19:58:22 GMT
+      X-Rack-Cache:
+      - invalidate, pass
+      Vary:
+      - Accept-Encoding
+      Transfer-Encoding:
+      - chunked
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: '{"error":"invalid_client","error_description":"Autenticação do cliente
+        falhou devido há um cliente desconhecido, nenhum cliente de autenticação incluso,
+        ou método de autenticação não suportado."}'
+    http_version: 
+  recorded_at: Sun, 08 Mar 2015 19:58:21 GMT
+recorded_with: VCR 2.9.3