boletosimples 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2308d90f08f6bc03b5924e079ea4025c78fdf098
-  data.tar.gz: 228d16b39a08fb903dae06cecc343063a40a5440
+  metadata.gz: 544af5de32ea938f99ed648486d828b9414115f8
+  data.tar.gz: 29b5b8c262fa0e1e5c21db89a907ed2e390d4327
 SHA512:
-  metadata.gz: c5b659dd17090bb8d4f9a505fc4d7bc873b68e3e265913c48ed32aa6f16693b4b7ae359e8078aea3f2c3a57a19514fd09cc41ceb65df913030ff96f491e57f8e
-  data.tar.gz: e9542387817afba27ff562706ec11bd6dd806580f2b95656ae7eeb93255eb8d78141327775b5cbfe2e6e523e24dfddf194ee950b556bcfb147b8b675b616f1d0
+  metadata.gz: bf70373d7671b92546e502195f903db5206d578ecf715c6d9258ea5ba81c2a5af759e43dcb24694c83740d526d2dd20fbd6ce1ecc6f4256e3b60a46c9123cbbb
+  data.tar.gz: de8e4b256b7407fd4fd0ed4661ab1d45253117227fbb881090ceb483797531af97b596c18cd1b647677d4cd920d6e4fb0b9fc664e2140cf5331e74523453fdd6

data/.ruby-version

@@ -1 +1 @@
-2.1.3
+2.1.5

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## 0.0.7 (unreleased)
+
+### 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)`
+
+### bug fixes

data/boletosimples.gemspec

@@ -27,7 +27,9 @@ Gem::Specification.new do |gem|
 
   # Gems that must be installed for boletosimples to compile and build
   gem.add_development_dependency 'pry'
-  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rspec', '~> 3.1'
+  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'

data/example/access_token_example.rb

@@ -12,7 +12,7 @@ client = BoletoSimples::Client.new('access_token', user_agent: 'Meu e-Commerce (
 
 # pp client.customer 2
 #
-# pp client.create_customer({:customer =>
+# pp client.create_customer(
 #   {
 #     person_name: "Joao da Silva",
 #     cnpj_cpf: "012.345.678-90",
@@ -26,13 +26,36 @@ client = BoletoSimples::Client.new('access_token', user_agent: 'Meu e-Commerce (
 #     address_complement: "Sala 4",
 #     phone_number: "2112123434"
 #   }
-# })
+# )
 
 # pp client.bank_billets
 
 # pp client.bank_billet 3
 
-# pp client.create_bank_billet({bank_billet:
+# Boleto normal
+# pp client.create_bank_billet(
+#   {
+#     amount: 41.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',
+#     description: 'Despesas do contrato 0012',
+#     expire_at: '2014-01-01',
+#     notification_url: 'http://example.com.br/notify'
+#   }
+# )
+
+# Boleto parcelado
+# pp client.create_bank_billet(
 #   {
 #     amount: 41.01,
 #     customer_address: 'Rua quinhentos',
@@ -50,5 +73,7 @@ client = BoletoSimples::Client.new('access_token', user_agent: 'Meu e-Commerce (
 #     description: 'Despesas do contrato 0012',
 #     expire_at: '2014-01-01',
 #     notification_url: 'http://example.com.br/notify',
+#     parcels: 3
 #   }
-# })
+# )
+

data/example/oauth_example.rb

@@ -60,7 +60,7 @@ client = BoletoSimples::OAuthClient.new('app_id',
 
 # pp client.customer 2
 #
-# pp client.create_customer({:customer =>
+# pp client.create_customer(
 #   {
 #     person_name: "Joao da Silva",
 #     cnpj_cpf: "012.345.678-90",
@@ -74,13 +74,36 @@ client = BoletoSimples::OAuthClient.new('app_id',
 #     address_complement: "Sala 4",
 #     phone_number: "2112123434"
 #   }
-# })
+# )
 
 # pp client.bank_billets
 
 # pp client.bank_billet 3
 
-# pp client.create_bank_billet({bank_billet:
+# Boleto normal
+# pp client.create_bank_billet(
+#   {
+#     amount: 41.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',
+#     description: 'Despesas do contrato 0012',
+#     expire_at: '2014-01-01',
+#     notification_url: 'http://example.com.br/notify'
+#   }
+# )
+
+# Boleto parcelado
+# pp client.create_bank_billet(
 #   {
 #     amount: 41.01,
 #     customer_address: 'Rua quinhentos',
@@ -98,5 +121,6 @@ client = BoletoSimples::OAuthClient.new('app_id',
 #     description: 'Despesas do contrato 0012',
 #     expire_at: '2014-01-01',
 #     notification_url: 'http://example.com.br/notify',
+#     parcels: 3
 #   }
-# })
+# )

data/lib/boletosimples/client.rb

@@ -38,7 +38,7 @@ module BoletoSimples
     end
 
     def create_customer(options = {})
-      post '/customers', options
+      post '/customers', customer: options
     end
 
     def customer(id = 1, options = {})
@@ -51,15 +51,18 @@ module BoletoSimples
     end
 
     def create_bank_billet(options = {})
-      post '/bank_billets', options
+      post '/bank_billets', bank_billet: options
     end
 
-    def bank_billet(id = 1, options = {})
+    def bank_billet(id, options = {})
       get "/bank_billets/#{id}", options
     end
 
-    # Wrappers for the main HTTP verbs
+    def cancel_bank_billet(id, options = {})
+      put "/bank_billets/#{id}/cancel", options
+    end
 
+    # Wrappers for the main HTTP verbs 
     def get(path, options = {})
       http_verb :get, path, options
     end
@@ -72,6 +75,10 @@ module BoletoSimples
       http_verb :put, path, options
     end
 
+    def patch(path, options = {})
+      http_verb :patch, path, options
+    end
+
     def delete(path, options = {})
       http_verb :delete, path, options
     end

data/lib/boletosimples/version.rb

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

data/spec/boletosimples/client_spec.rb

@@ -2,11 +2,414 @@
 
 require 'spec_helper'
 
-describe BoletoSimples::Client do
-  describe :userinfo do
-    context :without_authentication do
-      let(:client) { BoletoSimples::Client.new(nil, user_agent: 'Meu e-Commerce (meuecommerce@example.com)') }
+RSpec.describe BoletoSimples::Client do
+  subject(:client) do
+    BoletoSimples::Client.new(access_token, user_agent: 'Meu e-Commerce (meuecommerce@example.com)')
+  end
+
+  let(:access_token) { '9e616874dbf0674ace28170a748c9258ac1f0f87e0a544441ebffe976645bc09' }
+
+  describe '#userinfo' do
+    context 'without authentication', :vcr do
+      let(:access_token) { nil }
+
       it { expect(client.userinfo).to eq('error' => 'Você precisa se logar ou registrar antes de prosseguir.') }
     end
+
+    context 'with authentication', vcr: { cassette_name: 'BoletoSimples_Client/_userinfo/with_authentication'} do
+      let(:json_keys) do
+        ["account_level", "account_type",
+         "address_city_name", "address_complement",
+         "address_neighborhood", "address_number",
+         "address_postal_code", "address_state",
+         "address_street_name", "business_cnpj",
+         "business_legal_name", "business_name",
+         "cpf", "date_of_birth", "email", "father_name",
+         "first_name", "full_name", "id", "last_name",
+         "login_url", "middle_name", "mother_name" , "phone_number"
+        ]
+      end
+
+      it { expect(client.userinfo['email']).to eq('marciojunior1991@gmail.com') }
+      it { expect(client.userinfo['account_level']).to eq(2) }
+      it { expect(client.userinfo.keys).to match_array(json_keys) }
+    end
+  end
+
+  describe '#create_customer' do
+
+    context 'with valid data', vcr: { cassette_name: 'BoletoSimples_Client/_create_customer/with_valid_data' } do
+      let(:payload) do
+        {
+          "id" => 32,
+          "mobile_local_code" => nil,
+          "mobile_number" => nil,
+          "person_type" => "individual",
+          "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"
+        }
+      end
+
+      def create_customer
+        client.create_customer({
+          "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"
+        })
+      end
+
+      it { expect(create_customer).to eq(payload) }
+    end
+
+    context 'with invalid data', vcr: { cassette_name: 'BoletoSimples_Client/_create_customer/with_invalid_data' } do
+      let(:payload) do
+        {
+          "errors" => {
+            "cnpj_cpf" => ["não pode ficar em branco"],
+            "phone_number" => ["é muito curto (mínimo: 10 caracteres)"]
+          }
+        }
+      end
+
+      def create_customer
+        client.create_customer({
+          "person_name" => "Joao da Silva",
+          "cnpj_cpf"=> "foo",
+          "email" => "cliente@bom.com",
+          "address" => "Rua quinhentos",
+          "city_name" => "Rio de Janeiro",
+          "state" => "RJ",
+          "neighborhood" => "bairro",
+          "zipcode" => "123",
+          "address_number" => "111",
+          "address_complement" => "Sala 4",
+          "phone_number" => "2123434"
+        })
+      end
+
+      it { expect(create_customer).to eq(payload) }
+    end
+  end
+
+  describe '#customers', vcr: { cassette_name: 'BoletoSimples_Client/_customers' } do
+    let(:customer) do
+       {"id"=>32,
+         "city_name" => "Rio de Janeiro",
+         "person_name" => "Joao da Silva",
+         "address" => "Rua quinhentos",
+         "address_complement" => "Sala 4",
+         "address_number" => "111",
+         "mobile_number" => nil,
+         "cnpj_cpf" => "012.345.678-90",
+         "email" => "cliente@bom.com",
+         "neighborhood" => "bairro",
+         "person_type" => "individual",
+         "phone_number" => "2112123434",
+         "zipcode" => "12312-123",
+         "mobile_local_code" => nil,
+         "state" => "RJ"
+       }
+    end
+
+    it { expect(client.customers).to eq([customer]) }
+  end
+
+  describe '#customer' do
+
+    context "not found", vcr: { cassette_name: 'BoletoSimples_Client/_customer/not_found' } do
+      it { expect(client.customer(42)).to eq({"status"=>404, "error"=>"Not Found"}) }
+    end
+
+    context "existing customer", vcr: { cassette_name: 'BoletoSimples_Client/_customer/existing_customer' } do
+      let(:customer) do
+         {
+           "id"=>32,
+           "city_name" => "Rio de Janeiro",
+           "person_name" => "Joao da Silva",
+           "address" => "Rua quinhentos",
+           "address_complement" => "Sala 4",
+           "address_number" => "111",
+           "mobile_number" => nil,
+           "cnpj_cpf" => "012.345.678-90",
+           "email" => "cliente@bom.com",
+           "neighborhood" => "bairro",
+           "person_type" => "individual",
+           "phone_number" => "2112123434",
+           "zipcode" => "12312-123",
+           "mobile_local_code" => nil,
+           "state" => "RJ"
+         }
+      end
+
+      it { expect(client.customer(32)).to eq(customer) }
+    end
+  end
+
+  describe '#create_bank_billet' do
+
+    context 'with valid data', vcr: { cassette_name: 'BoletoSimples_Client/_create_bank_billet/with_valid_data' } do
+      let(:payload) do
+        {
+          "amount" => 9.01,
+          "created_via_api" => true,
+          "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",
+          "description" => "Despesas do contrato 0012",
+          "expire_at" => "2014-01-01",
+          "id" => 113,
+          "notification_url" => "http://example.com.br/notify",
+          "paid_amount" => 0.0,
+          "paid_at" => nil,
+          "send_email_on_creation" => nil,
+          "shorten_url" => nil,
+          "status" => "generating"
+        }
+      end
+
+      def create_bank_billet
+        client.create_bank_billet({
+          "amount" => 9.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',
+          "description" => 'Despesas do contrato 0012',
+          "expire_at" => '2014-01-01',
+          "notification_url" => 'http://example.com.br/notify'
+        })
+      end
+
+      it { expect(create_bank_billet).to eq(payload) }
+    end
+
+    context 'with invalid data', vcr: { cassette_name: 'BoletoSimples_Client/_create_bank_billet/with_invalid_data' } do
+      let(:payload) do
+        {
+          "errors"=> {
+            "customer_cnpj_cpf" => ["não pode ficar em branco"],
+            "customer_email" => ["não é válido"],
+            "customer" => [
+              {
+                "cnpj_cpf" => ["não pode ficar em branco"],
+                "phone_number" => ["é muito curto (mínimo: 10 caracteres)"],
+                "email" => ["não é válido"]
+              }
+            ],
+            "amount"=>["deve ser menor ou igual a 10"]
+          }
+        }
+      end
+
+      def create_bank_billet
+        client.create_bank_billet({
+          "amount" => 19.01,
+          "customer_address" => 'Rua quinhentos',
+          "customer_address_complement" => 'Sala 4',
+          "customer_address_number" => '111',
+          "customer_city_name" => 'Rio de Janeiro',
+          "customer_cnpj_cpf" => '34567890',
+          "customer_email" => 'cliente',
+          "customer_neighborhood" => 'Sao Francisco',
+          "customer_person_name" => 'Joao da Silva',
+          "customer_person_type" => 'individual',
+          "customer_phone_number" => '123434',
+          "customer_state" => 'RJ',
+          "customer_zipcode" => '12312',
+          "description" => 'Despesas do contrato 0012',
+          "expire_at" => '2014-01-01',
+          "notification_url" => 'http://example.com.br/notify'
+        })
+      end
+
+      it { expect(create_bank_billet).to eq(payload) }
+    end
+  end
+
+  describe '#bank_billets', vcr: { cassette_name: 'BoletoSimples_Client/_bank_billets' } do
+    let(:bank_billet) do
+      {
+        "id"=>113,
+        "expire_at"=>"2014-01-01",
+        "paid_at"=>nil,
+        "description"=>"Despesas do contrato 0012",
+        "status"=>"opened",
+        "shorten_url"=>"http://staging.bole.to/nhhvauui",
+        "customer_person_type"=>"individual",
+        "customer_person_name"=>"Joao da Silva",
+        "customer_cnpj_cpf"=>"012.345.678-90",
+        "customer_address"=>"Rua quinhentos",
+        "customer_state"=>"RJ",
+        "customer_neighborhood"=>"Sao Francisco",
+        "customer_zipcode"=>"12312-123",
+        "customer_address_number"=>"111",
+        "customer_address_complement"=>"Sala 4",
+        "customer_phone_number"=>"2112123434",
+        "customer_email"=>"cliente@bom.com",
+        "notification_url"=>"http://example.com.br/notify",
+        "send_email_on_creation"=>nil,
+        "created_via_api"=>true,
+        "customer_city_name"=>"Rio de Janeiro",
+        "paid_amount"=>0.0,
+        "amount"=>9.01
+      }
+    end
+
+    it { expect(client.bank_billets).to eq([bank_billet]) }
+  end
+
+  describe '#bank_billet' do
+    context 'not found', vcr: { cassette_name: 'BoletoSimples_Client/_bank_billet/not_found' } do
+      it { expect(client.bank_billet(4324)).to eq({ "status"=>"404", "error"=>"Not Found" }) }
+    end
+
+    context 'existing bank billet', vcr: { cassette_name: 'BoletoSimples_Client/_bank_billet/existing_bank_billet' } do
+      let(:bank_billet) do
+        {
+          "id"=>113,
+          "expire_at"=>"2014-01-01",
+          "paid_at"=>nil,
+          "description"=>"Despesas do contrato 0012",
+          "status"=>"opened",
+          "shorten_url"=>"http://staging.bole.to/nhhvauui",
+          "customer_person_type"=>"individual",
+          "customer_person_name"=>"Joao da Silva",
+          "customer_cnpj_cpf"=>"012.345.678-90",
+          "customer_address"=>"Rua quinhentos",
+          "customer_state"=>"RJ",
+          "customer_neighborhood"=>"Sao Francisco",
+          "customer_zipcode"=>"12312-123",
+          "customer_address_number"=>"111",
+          "customer_address_complement"=>"Sala 4",
+          "customer_phone_number"=>"2112123434",
+          "customer_email"=>"cliente@bom.com",
+          "notification_url"=>"http://example.com.br/notify",
+          "send_email_on_creation"=>nil,
+          "created_via_api"=>true,
+          "customer_city_name"=>"Rio de Janeiro",
+          "paid_amount"=>0.0,
+          "amount"=>9.01
+        }
+      end
+
+      it { expect(client.bank_billet(113)).to eq(bank_billet) }
+    end
+  end
+
+  describe '#cancel_bank_billet' do
+    context 'with valid bank billet', vcr: { cassette_name: 'BoletoSimples_Client/_cancel_bank_billet/with_valid_bank_billet' } do
+      let(:canceled_bank_billet) do
+        {
+          "amount" => 10.0,
+          "created_via_api" => false,
+          "customer_address" => "Rua José Scheuer",
+          "customer_address_complement" => "",
+          "customer_address_number" => "12",
+          "customer_city_name" => "Jaraguá do Sul",
+          "customer_cnpj_cpf" => "33.368.751/0001-14",
+          "customer_email" => "foo@bar.com",
+          "customer_neighborhood" => "Amizade",
+          "customer_person_name" => "marcio junior",
+          "customer_person_type" => "juridical",
+          "customer_phone_number" => "",
+          "customer_state" => "SC",
+          "customer_zipcode" => "89255-800",
+          "description" => "foo",
+          "expire_at" => "2014-10-19",
+          "id" => 245,
+          "notification_url" => nil,
+          "paid_amount" => 0.0,
+          "paid_at" => nil,
+          "send_email_on_creation" => nil,
+          "shorten_url" => "http://staging.bole.to/ni8jav1w",
+          "status" => "canceled"
+        }
+      end
+
+      it{ expect(client.cancel_bank_billet(245)).to eq(canceled_bank_billet) }
+    end
+
+    context 'with invalid bank billet', vcr: { cassette_name: 'BoletoSimples_Client/_cancel_bank_billet/with_invalid_bank_billet' } do
+      let(:error) do
+        {"errors"=>{"status"=>["cannot transition via cancel"]}}
+      end
+
+      it{ expect(client.cancel_bank_billet(113)).to eq(error) }
+    end
+
+    context 'already canceled', vcr: { cassette_name: 'BoletoSimples_Client/_cancel_bank_billet/already_canceled' } do
+      let(:error) do
+        {"errors"=>{"status"=>["cannot transition via cancel"]}}
+      end
+
+      it{ expect(client.cancel_bank_billet(245)).to eq(error) }
+    end
+
+  end
+
+  describe '#transactions', vcr: { cassette_name: 'BoletoSimples_Client/_transactions' } do
+    let(:credit_tx) do
+      {
+        "id"=>15,
+        "amount"=>9.01,
+        "created_at"=>"2014-11-03",
+        "description"=>"Boleto Bancário 113",
+        "kind"=>"credit",
+        "processed_at"=>nil,
+        "sent_at"=>nil,
+        "status"=>"unprocessed",
+        "credit_at"=>"2014-11-06"
+      }
+    end
+
+    let(:fee_tx) do
+      {
+        "id"=>16,
+        "amount"=>-5.0,
+        "created_at"=>"2014-11-03",
+        "description"=>"Boleto Bancário 113",
+        "kind"=>"fee",
+        "processed_at"=>nil,
+        "sent_at"=>nil,
+        "status"=>"unprocessed",
+        "credit_at"=>"2014-11-06"
+      }
+    end
+
+    it { expect(client.transactions).to match_array([fee_tx, credit_tx]) }
   end
 end