bs2_api 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86300aea3210ea0f4a86d34cc062b75ec68e1315520b240c907b2ec0cf79cd62
-  data.tar.gz: 3515768ebac73fec3704b59f332b4c2ddd09b71a33866682ea692409653e577f
+  metadata.gz: ac4d8162e93c876cdd61a6be56abde26d704a31797aef6b815274c98b8e5da29
+  data.tar.gz: fc30a8fbac319e4b810dedac2582902a59ceeacc037f2e8a3f8fc2a8f3d87a1c
 SHA512:
-  metadata.gz: b6ff81648836152febb2a1faa2bf1e592c5e8f3a962e25d29782a6dc99dceddb74d906a83bdfe194c95f32c27b8b1ea1c92bde3d8917d4afeda07d23c1043a4e
-  data.tar.gz: 4f195c7cc92db0bbddb6680e2cb54113c65350deeedce4c936a9a244b91b233dd703bcc36d86c8b22b574d214ac32732e94ca2f88573ab619a83405e66d42da6
+  metadata.gz: 783bbec0c5ad81733d817f0958506bbfc300c75983256454d8f050e13ef7b00640ece3fb4d59858cf5aae36656435e7164893972f103a8f495661d10be5551b2
+  data.tar.gz: c2e1e9df5dd5040ccebcf481e6e3bb649ab2dd134a3f0be4ed50014a1543cf0de67508de31809582ddf4a850bf7333970f6284394d905c94d6c0cd4168fa90c4

data/Gemfile

@@ -2,17 +2,4 @@
 
 source "https://rubygems.org"
 
-gemspec
-
-gem "rake", "~> 13.0"
-gem "httparty", "~> 0.18.1"
-gem "activesupport", "~> 6.1", ">= 6.1.3.2"
-
-group :test do
-  gem "pry-byebug", "~> 3.9"
-  gem "uuid", "~> 2.3", ">= 2.3.9"
-  gem "rspec", "~> 3.10"
-  gem "webmock", "~> 3.13"
-  gem "vcr", "~> 6.0"
-  gem "dotenv", "~> 2.7", ">= 2.7.6"
-end
+gemspec

data/Gemfile.lock

@@ -1,8 +1,12 @@
 PATH
   remote: .
   specs:
-    bs2_api (0.2.0)
-      activesupport (~> 6.1, >= 6.1.3.2)
+    bs2_api (0.3.0)
+      activesupport
+      builder
+      bundler
+      httparty (~> 0.18.1)
+      rake
 
 GEM
   remote: https://rubygems.org/
@@ -15,6 +19,7 @@ GEM
       zeitwerk (~> 2.3)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
+    builder (3.2.4)
     byebug (11.1.3)
     coderay (1.1.3)
     concurrent-ruby (1.1.9)
@@ -74,12 +79,9 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  activesupport (~> 6.1, >= 6.1.3.2)
   bs2_api!
   dotenv (~> 2.7, >= 2.7.6)
-  httparty (~> 0.18.1)
   pry-byebug (~> 3.9)
-  rake (~> 13.0)
   rspec (~> 3.10)
   uuid (~> 2.3, >= 2.3.9)
   vcr (~> 6.0)

data/README.md

@@ -2,6 +2,18 @@
 
 Integração com a API do Banco BS2: https://devs.bs2.com/manual/pix-clientes
 
+TO-DO:
+- Pagamentos (**Transfere** dinheiro para alguém)
+  - [x] Criar pagamento por Chave
+  - [x] Criar pagamento Manual
+  - [x] Confirmar pagamento
+  - [ ] Consultar pagamento
+- Recebimentos (**Recebe** dinheiro de alguém)
+  - [ ] Cobrança estático
+  - [ ] Cobrança dinâmico
+  - [ ] Consultar cobrança
+
+
 ## Instalação
 
 Adicionar no seu Gemfile:
@@ -33,11 +45,11 @@ ou via initializer:
 Bs2Api.configure do |config|
   config.client_id       = 'you_bs2_client_id'
   config.client_secret   = 'you_bs2_client_secret'
-  config.pix_environment = 'pix_enviroment'
+  config.pix_environment = 'sandbox' # ou production
 end
 ```
 
-### Iniciar pagamento por Chave
+### Inicia ordem de Transferência PIX via: Chave
 
 ```ruby
 pix_key = Bs2Api::Entities::PixKey.new(
@@ -45,100 +57,86 @@ pix_key = Bs2Api::Entities::PixKey.new(
   type: 'EMAIL'
 )
 
-payment = Bs2Api::Payment::Key.new(pix_key).call
-```
+# Caso ocorra algum problema na criação, um erro será lançado
+# Veja abaixo (Classes de errors) quais erros que podem ser lançados
+pay_key = Bs2Api::Payment::Key.new(pix_key).call
 
-Tipos:
-```bash
-CPF
-CNPJ
-PHONE
-EMAIL
-EVP (Chave aleatória)
-```
+pay_key.payment.id
+=> "96f0b3c4-4c76-4a7a-9933-9c9f86df7490" # pagamentoId gerado no BS2
+
+pay_key.payment.merchantId
+=> "E710278662021061618144401750781P" # endToEndId gerado no BS2
 
+```
 
-### Iniciar pagamento Manual
+### Inicia ordem de Transferência PIX via: Manual
 
 ```ruby
 account = Bs2Api::Entities::Account.new(
-  bank_code: '341',
-  bank_name: 'Itaú',
-  agency: '0944',
-  number: '09442-1',
-  type: 'ContaCorrente'
+  bank_code: "218",
+  agency: "0993",
+  number: "042312",
+  type: "ContaCorrente" # ContaCorrente, ContaSalario ou Poupanca
 )
 
 customer = Bs2Api::Entities::Customer.new(
-  document: '88899988811',
-  type: 'CPF',
-  name: 'João Silva'
+  document: "88899988811",
+  type: "CPF",
+  name: "Rick Sanches",
+  business_name: "Nome fantasia" # Utilizar apenas se for type CNPJ
 )
 
-receiver = Bs2Api::Entities::Bank.new(
-  account: account, 
+receiver_bank = Bs2Api::Entities::Bank.new(
+  account: account,
   customer: customer
 )
 
-payment = Bs2Api::Payment::Manual.new(receiver).call
+pay_manual = Bs2Api::Payment::Manual.new(receiver_bank).call
+
+pay_manual.payment.id
+=> "96f0b3c4-4c76-4a7a-9933-9c9f86df7490" # UUID gerado no BS2
+
+pay_manual.payment.merchantId
+=> "E710278662021061618144401750781P" # endToEndId gerado no BS2
 ```
 
-### Objetos
+### Confirmar ordem de transferência
+```ruby
+# Após criar um Payment é necessário confirmar
+# Nessa etapa o dinheiro é de fato transferido
+
+# Tanto a ordem de transferência via chave ou manual tem o mesmo payment.
+# Caso tenha criado via chave no passo anterior:
+payment = pay_key.payment 
+
+# Ou caso tenha criado a ordem via Manual no passo anterior:
+payment = pay_manual.payment
 
-##### Payment
+amount = 10.50
+confirmation = Bs2Api::Payment::Confirmation.new(payment, value: amount).call
+
+# Caso a confirmação de problema, um erro será lançado.
+raise Bs2Api::Errors::ConfirmationError
+
+# Caso nenhum erro seja lançado (já é sucesso) porém, você pode ter certeza com
+confirmation.success?
+```
+---
+### Classes de erros:
 ```ruby
-payment.id # pagamentoId
-payment.merchant_id # endToEndId
-payment.receiver # recebedor
-payment.payer # pagador
-
-payment.receiver.class
-=> Bs2Api::Entities::Bank
-
-payment.payer.class
-=> Bs2Api::Entities::Bank
-
-payment.payer.account # conta
-=> Bs2Api::Entities::Account
-
-payment.payer.customer # pessoa
-=> Bs2Api::Entities::Customer
-
-payment.to_hash
-{
-  "pagamentoId"=>"123", 
-  "endToEndId"=>"456", 
-  "recebedor"=>{
-    "ispb"=>"71027866", 
-    "conta"=>{
-      "banco"=>"218", 
-      "bancoNome"=>"BCO BS2 S.A.", 
-      "agencia"=>"0001", 
-      "numero"=>"3134806", 
-      "tipo"=>"ContaCorrente"
-    },
-    "pessoa"=>{
-      "documento"=>"25215188000116", 
-      "tipoDocumento"=>"CNPJ", 
-      "nome"=>"Teste Automatizado", 
-      "nomeFantasia"=>nil
-    }
-  }, 
-  "pagador"=>{
-    "ispb"=>"71027866", 
-    "conta"=>{
-      "banco"=>"218", 
-      "bancoNome"=>"BCO BS2 S.A.", 
-      "agencia"=>"0001", 
-      "numero"=>"3134806", 
-      "tipo"=>"ContaCorrente"
-    },
-    "pessoa"=>{
-      "documento"=>"25215188000116", 
-      "tipoDocumento"=>"CNPJ", 
-      "nome"=>"Teste Automatizado", 
-      "nomeFantasia"=>nil
-    }
-  }
-}
+# Todos erros herdam de:
+Bs2Api::Errors::Base
+
+Bs2Api::Errors::BadRequest
+Bs2Api::Errors::ConfirmationError
+Bs2Api::Errors::InvalidCustomer
+Bs2Api::Errors::InvalidPixKey
+Bs2Api::Errors::MissingConfiguration
+Bs2Api::Errors::ServerError
+Bs2Api::Errors::Unauthorized
+
+# Caso não queira tratar um erro em específico basta fazer rescue do Base
+rescue Bs2Api::Errors::Base => e
+  puts "Erro: #{e.message}"
+end
 ```

data/bs2_api.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["kimpastro@gmail.com"]
 
   spec.summary       = "Integração com a API do BS2"
-  spec.description   = "Criar pagamentos PIX"
+  spec.description   = "Fazer transferências via PIX"
   spec.homepage      = "https://github.com/kimpastro/bs2_api"
   spec.required_ruby_version = ">= 2.7.2"
 
@@ -26,5 +26,16 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activesupport", "~> 6.1", ">= 6.1.3.2"
-end
+  spec.add_dependency("builder")
+  spec.add_dependency("bundler")
+  spec.add_dependency("rake")
+  spec.add_dependency("activesupport")
+  spec.add_dependency("httparty", "~> 0.18.1")
+
+  spec.add_development_dependency("pry-byebug", "~> 3.9")
+  spec.add_development_dependency("uuid", "~> 2.3", ">= 2.3.9")
+  spec.add_development_dependency("rspec", "~> 3.10")
+  spec.add_development_dependency("webmock", "~> 3.13")
+  spec.add_development_dependency("vcr", "~> 6.0")
+  spec.add_development_dependency("dotenv", "~> 2.7", ">= 2.7.6")
+end

data/lib/bs2_api.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
-require 'httparty'
+require "httparty"
 require "active_support/core_ext/hash/indifferent_access"
+require "active_support/core_ext/hash/except"
 
 require 'bs2_api/version'
 require 'bs2_api/configuration'
@@ -10,10 +11,14 @@ require 'bs2_api/initializers/hash'
 
 require 'bs2_api/errors/base'
 require 'bs2_api/errors/invalid_pix_key'
+require 'bs2_api/errors/invalid_bank'
+require 'bs2_api/errors/invalid_customer'
 require 'bs2_api/errors/missing_configuration'
 require 'bs2_api/errors/unauthorized'
 require 'bs2_api/errors/bad_request'
 require 'bs2_api/errors/server_error'
+require 'bs2_api/errors/confirmation_error'
+require 'bs2_api/errors/missing_bank'
 
 require 'bs2_api/entities/account'
 require 'bs2_api/entities/bank'
@@ -24,6 +29,7 @@ require 'bs2_api/entities/pix_key'
 require 'bs2_api/payment/base'
 require 'bs2_api/payment/key'
 require 'bs2_api/payment/manual'
+require 'bs2_api/payment/confirmation'
 
 require 'bs2_api/request/auth'
 

data/lib/bs2_api/entities/account.rb

@@ -13,17 +13,17 @@ module Bs2Api
 
       def initialize(args = {})
         @bank_code  = args.fetch(:bank_code, nil)
-        @bank_name  = args.fetch(:bank_name, nil)
         @agency     = args.fetch(:agency, nil)
         @number     = args.fetch(:number, nil)
         @type       = args.fetch(:type, nil)
+        @bank_name  = get_bank_name
       end
 
       def to_hash
         ActiveSupport::HashWithIndifferentAccess.new(
           {
             "banco": @bank_code,
-            "bancoNome": bank_name,
+            "bancoNome": get_bank_name,
             "agencia": @agency,
             "numero": @number,
             "tipo": @type
@@ -54,6 +54,11 @@ module Bs2Api
       def saving?
         @type == TYPES[:saving]
       end
+
+      private
+        def get_bank_name
+          Bs2Api::Util::BankService.find_by_code(@bank_code)["name"]
+        end
     end
   end
 end

data/lib/bs2_api/errors/confirmation_error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Bs2Api
+  module Errors
+    class ConfirmationError < Base; end
+  end
+end

data/lib/bs2_api/errors/invalid_bank.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Bs2Api
+  module Errors
+    class InvalidBank < Base; end
+  end
+end

data/lib/bs2_api/errors/missing_bank.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Bs2Api
+  module Errors
+    class MissingBank < Base; end
+  end
+end

data/lib/bs2_api/payment/base.rb

@@ -1,11 +1,18 @@
 module Bs2Api
   module Payment
     class Base
+      attr_reader :payment
+
+      def initialize
+        raise NoMethodError, "Missing #{__method__} to #{self.class}"
+      end
+
       def call
         response = post_request
-
-        raise Bs2Api::Errors::BadRequest, parse_error(response) if !response.created?
-        Bs2Api::Entities::Payment.from_response(response)
+        raise Bs2Api::Errors::BadRequest, parse_error(response) unless response.created?
+        
+        @payment = Bs2Api::Entities::Payment.from_response(response)
+        self
       end
 
       private

data/lib/bs2_api/payment/confirmation.rb

@@ -0,0 +1,38 @@
+module Bs2Api
+  module Payment
+    class Confirmation < Base
+      attr_reader :success
+
+      def initialize payment, value: nil
+        raise Bs2Api::Errors::ConfirmationError, 'invalid payment' unless payment.present? && payment.is_a?(Bs2Api::Entities::Payment)
+        raise Bs2Api::Errors::ConfirmationError, 'invalid value' unless value.to_f.positive?
+        @payment = payment
+
+        @value = value.to_f
+      end
+
+      def call
+        response = post_request
+        raise Bs2Api::Errors::ConfirmationError, parse_error(response) unless response.accepted?
+
+        @success = true
+        self
+      end
+
+      private
+        def payload
+          @payment.to_hash
+                  .except!("pagamentoId", "endToEndId")
+                  .merge("valor": @value)
+        end
+        
+        def url
+          "#{Bs2Api.endpoint}/pix/direto/forintegration/v1/pagamentos/#{@payment.id}/confirmacao"
+        end
+
+        def success?
+          !!@success
+        end
+    end
+  end
+end

data/lib/bs2_api/payment/manual.rb

@@ -4,6 +4,7 @@ module Bs2Api
   module Payment
     class Manual < Base
       def initialize bank
+        raise Bs2Api::Errors::InvalidBank, 'Invalid Bank' unless bank.is_a?(Bs2Api::Entities::Bank)
         @bank = bank
       end
 

data/lib/bs2_api/util/bank_service.rb

@@ -7,7 +7,9 @@ module Bs2Api
     class BankService
       class << self
         def find_by_code code
-          bank_list.find {|b| b["code"] == code }
+          bank = bank_list.find {|b| b["code"] == code }
+          raise Bs2Api::Errors::MissingBank, 'Bank not registered into util/banks.yml file' if bank.blank?
+          bank
         end
 
         private

data/lib/bs2_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bs2Api
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bs2_api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Kim Pastro
@@ -10,27 +10,173 @@ bindir: exe
 cert_chain: []
 date: 2021-06-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.3.2
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: uuid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.9
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.3.2
-description: Criar pagamentos PIX
+        version: 2.7.6
+description: Fazer transferências via PIX
 email:
 - kimpastro@gmail.com
 executables: []
@@ -60,14 +206,18 @@ files:
 - lib/bs2_api/entities/pix_key.rb
 - lib/bs2_api/errors/bad_request.rb
 - lib/bs2_api/errors/base.rb
+- lib/bs2_api/errors/confirmation_error.rb
+- lib/bs2_api/errors/invalid_bank.rb
 - lib/bs2_api/errors/invalid_customer.rb
 - lib/bs2_api/errors/invalid_pix_key.rb
+- lib/bs2_api/errors/missing_bank.rb
 - lib/bs2_api/errors/missing_configuration.rb
 - lib/bs2_api/errors/server_error.rb
 - lib/bs2_api/errors/unauthorized.rb
 - lib/bs2_api/initializers/hash.rb
 - lib/bs2_api/initializers/object.rb
 - lib/bs2_api/payment/base.rb
+- lib/bs2_api/payment/confirmation.rb
 - lib/bs2_api/payment/key.rb
 - lib/bs2_api/payment/manual.rb
 - lib/bs2_api/request/auth.rb