bs2_api 0.3.3 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2b8b144d4d8f5045e87461029c823e9b5f5a7c3d5a9191f1e39a542ac5d7400
-  data.tar.gz: c9bcf3bb230b56e8a0ac0d0e2d4373ec37a49869bc1918597b36dd57d1ff5bab
+  metadata.gz: fedfacb857654251513141faee3fe9594e888c3d10f6de512016d4902f532e17
+  data.tar.gz: 5d424e8fd30eeeeb261470ac5aef0e4bc09cf511aafe9f221f8f684a684477b6
 SHA512:
-  metadata.gz: d4a1c8e8823be43d5c6f8a69b4817552e58e3e1a82d81780ed3a181ecae7449d6da2f0235bda18d36b2632dc7e58d06346624690efc9ed6f1b46ef526167572f
-  data.tar.gz: 242287b0695c77833428867361fb1a469eb912ffa0b387c8443f8fbba3db23a2bdd4aa1dbc6e9e172084166fb087ff8fbe9ff19a0cdc6260a12449963ecc7e86
+  metadata.gz: ac0eb6711af976b5354a2f4a8b61e1aa63f7818df87601f7234390788b88621176dde42e1c34d6c175ba2a4801c783750bb47b2372a3e6d62f93112480d2864d
+  data.tar.gz: 0ecd2596091a8a4c664307e4f9d40e7c0a95fb113466d97bb3ac59c8e45e9914630e4a590bbba0813bce72a53d08e921af61f036152a02f711a9f78dcfd5ddd1

data/.github/workflows/test.yml

@@ -0,0 +1,34 @@
+name: bs2_api test
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    types: [ opened, synchronize, reopened ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    env:
+      BS2_ENVIRONMENT: 'sandbox'
+      BS2_CLIENT_ID: '123'
+      BS2_CLIENT_SECRET: '123'
+      BS2_EVP_TEST_KEY: '123'
+    
+    strategy:
+      matrix:
+        ruby-version: ["2.7.2"]
+
+    steps:
+    - uses: actions/checkout@v2
+    
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+
+    - name: Install dependencies
+      run: bundle install
+
+    - name: Run tests
+      run: bundle exec rspec spec/

data/CHANGELOG.md

@@ -1,16 +1,23 @@
-## [0.3.1] - 2021-06-16
+## [1.0.1] - 2021-06-25
+- Adjust HTTP response code when create payments into BS2
+
+## [1.0.0] - 2021-06-18
+- Changed payment.id to payment.payment_id
+- Changed payment.merchant_id to payment.end_to_end_id
 
+## [0.4.0] - 2021-06-17
+- Configuration#valid? missing return true
+- Created Util::Response.parse_error
+- Bs2Api::Payment::Confirmation#success? was private, moved it to public
+
+## [0.3.1] - 2021-06-16
 - Method Hash#to_query conflicting with Rails
 
 ## [0.3.0] - 2021-06-16
-
 - Confirmation, Adjust README.md
 
 ## [0.2.0] - 2021-06-15
-
 - Entities, Auth, Create Pix Key Payment
 
-
 ## [0.1.0] - 2021-06-11
-
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bs2_api (0.3.2)
+    bs2_api (1.0.1)
       activesupport
       builder
       bundler
@@ -11,7 +11,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3.2)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)

data/README.md

@@ -1,3 +1,8 @@
+[![CI status](https://github.com/latamgateway/bs2_api/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/latamgateway/bs2_api/actions/workflows/test.yml)
+[![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/latamgateway/bs2_api.svg?style=flat-square)](http://github.com/latamgateway/bs2_api/releases)
+[![Version](https://img.shields.io/gem/v/bs2_api.svg?style=flat-square)](https://rubygems.org/gems/bs2_api)
+[![GitHub](https://img.shields.io/github/license/latamgateway/bs2_api?style=flat-square)](https://github.com/latamgateway/bs2_api/blob/main/LICENSE)
+
 # Bs2Api
 
 Integração com a API do Banco BS2: https://devs.bs2.com/manual/pix-clientes
@@ -61,10 +66,10 @@ pix_key = Bs2Api::Entities::PixKey.new(
 # Veja abaixo (Classes de errors) quais erros que podem ser lançados
 pay_key = Bs2Api::Payment::Key.new(pix_key).call
 
-pay_key.payment.id
+pay_key.payment.payment_idid
 => "96f0b3c4-4c76-4a7a-9933-9c9f86df7490" # pagamentoId gerado no BS2
 
-pay_key.payment.merchantId
+pay_key.payment.end_to_end_id
 => "E710278662021061618144401750781P" # endToEndId gerado no BS2
 
 ```
@@ -93,40 +98,41 @@ receiver_bank = Bs2Api::Entities::Bank.new(
 
 pay_manual = Bs2Api::Payment::Manual.new(receiver_bank).call
 
-pay_manual.payment.id
+pay_manual.payment.payment_id
 => "96f0b3c4-4c76-4a7a-9933-9c9f86df7490" # UUID gerado no BS2
 
-pay_manual.payment.merchantId
+pay_manual.payment.end_to_end_id
 => "E710278662021061618144401750781P" # endToEndId gerado no BS2
 ```
 
 ### Confirmar ordem de transferência
-```ruby
-# Após criar um Payment é necessário confirmar
-# Nessa etapa o dinheiro é de fato transferido
+Após criar um Payment é necessário confirmar, nessa etapa o dinheiro é de fato transferido.
+Nessa etapa é necessário **informar o valor** que deseja ser 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
+```ruby
 
-# Ou caso tenha criado a ordem via Manual no passo anterior:
-payment = pay_manual.payment
+# Ambos modelos de criação da ordem de pagamento possuem o mesmo objeto payment
+# podendo ser utilizado da mesma forma nos dois casos:
+# pay_key.payment ou pay_manual.payment
 
+payment = pay_key.payment
 amount = 10.50
+
 confirmation = Bs2Api::Payment::Confirmation.new(payment, value: amount).call
 
-# Caso a confirmação de problema, um erro será lançado.
+# Caso a confirmação dê 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
+# Caso nenhum erro seja lançado significa que foi sucesso. Você pode ter certeza com
 confirmation.success?
 ```
----
+
 ### Classes de erros:
 ```ruby
 # Todos erros herdam de:
 Bs2Api::Errors::Base
 
+# Errors possíveis de serem lançados
 Bs2Api::Errors::BadRequest
 Bs2Api::Errors::ConfirmationError
 Bs2Api::Errors::InvalidCustomer
@@ -134,9 +140,10 @@ 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
 ```
+
+---
+
+### Observações
+- Método `call` retorna o próprio objeto
+- Em caso de retorno diferente de sucesso na comunicação com a API do Bs2, um erro sempre será lançado.

data/bs2_api.gemspec

@@ -13,6 +13,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/latamgateway/bs2_api"
   spec.required_ruby_version = "~> 2.7", "< 3"
 
+  spec.license = "MIT"
+
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/latamgateway/bs2_api"
   spec.metadata["changelog_uri"] = "https://github.com/latamgateway/bs2_api/blob/main/CHANGELOG.md"

data/lib/bs2_api.rb

@@ -8,6 +8,9 @@ require "active_support/core_ext/object/blank"
 require 'bs2_api/version'
 require 'bs2_api/configuration'
 
+require 'bs2_api/util/bank_service'
+require 'bs2_api/util/response'
+
 require 'bs2_api/errors/base'
 require 'bs2_api/errors/invalid_pix_key'
 require 'bs2_api/errors/invalid_bank'
@@ -32,8 +35,6 @@ require 'bs2_api/payment/confirmation'
 
 require 'bs2_api/request/auth'
 
-require 'bs2_api/util/bank_service'
-
 module Bs2Api
   ENDPOINT = {
     production: 'https://api.bs2.com',

data/lib/bs2_api/configuration.rb

@@ -11,5 +11,7 @@ class Configuration
 
   def valid?
     raise Bs2Api::Errors::MissingConfiguration, 'Missing configuration credentials' if @client_id.blank? || @client_secret.blank?
+
+    true
   end
 end

data/lib/bs2_api/entities/payment.rb

@@ -3,22 +3,22 @@
 module Bs2Api
   module Entities
     class Payment
-      attr_accessor :id, :merchant_id, :receiver, :payer
+      attr_accessor :payment_id, :end_to_end_id, :receiver, :payer
 
       def initialize(args = {})
-        @id          = args.fetch(:id, nil)
-        @merchant_id = args.fetch(:merchant_id, nil)
-        @receiver    = args.fetch(:receiver, nil)
-        @payer       = args.fetch(:payer, nil)
+        @payment_id    = args.fetch(:payment_id, nil)
+        @end_to_end_id = args.fetch(:end_to_end_id, nil)
+        @receiver      = args.fetch(:receiver, nil)
+        @payer         = args.fetch(:payer, nil)
       end
 
       def to_hash
         ActiveSupport::HashWithIndifferentAccess.new(
           {
-            "pagamentoId": @id,
-            "endToEndId": @merchant_id,
-            "recebedor": @receiver.to_hash,
-            "pagador": @payer.to_hash
+            "pagamentoId": @payment_id,
+            "endToEndId":  @end_to_end_id,
+            "recebedor":   @receiver.to_hash,
+            "pagador":     @payer.to_hash
           }
         )
       end
@@ -27,10 +27,10 @@ module Bs2Api
         hash = ActiveSupport::HashWithIndifferentAccess.new(hash_payload)
 
         Bs2Api::Entities::Payment.new(
-          id: hash["pagamentoId"],
-          merchant_id: hash["endToEndId"],
-          receiver: Bs2Api::Entities::Bank.from_response(hash["recebedor"]),
-          payer: Bs2Api::Entities::Bank.from_response(hash["pagador"])
+          payment_id:    hash["pagamentoId"],
+          end_to_end_id: hash["endToEndId"],
+          receiver:      Bs2Api::Entities::Bank.from_response(hash["recebedor"]),
+          payer:         Bs2Api::Entities::Bank.from_response(hash["pagador"])
         )
       end
     end

data/lib/bs2_api/payment/base.rb

@@ -9,8 +9,8 @@ module Bs2Api
 
       def call
         response = post_request
-        raise Bs2Api::Errors::BadRequest, parse_error(response) unless response.created?
-        
+        raise Bs2Api::Errors::BadRequest, ::Util::Response.parse_error(response) unless response.ok?
+
         @payment = Bs2Api::Entities::Payment.from_response(response)
         self
       end
@@ -32,28 +32,13 @@ module Bs2Api
           Bs2Api::Request::Auth.token
         end
 
-        def parse_error(response)
-          hash    = JSON.parse(response.body)
-          message = "#{response.code}: "
-
-          if hash.is_a?(Array)
-            message << hash[0]["descricao"]
-          elsif hash.key?("error_description")
-            message << hash["error_description"]
-          else 
-            message << hash.to_s
-          end
-
-          message
-        end
-
         def payload
           raise NoMethodError, "Missing #{__method__} to #{self.class}"
         end
-        
+
         def url
           raise NoMethodError, "Missing #{__method__} to #{self.class}"
         end
     end
   end
-end
+end

data/lib/bs2_api/payment/confirmation.rb

@@ -13,12 +13,16 @@ module Bs2Api
 
       def call
         response = post_request
-        raise Bs2Api::Errors::ConfirmationError, parse_error(response) unless response.accepted?
+        raise Bs2Api::Errors::ConfirmationError, ::Util::Response.parse_error(response) unless response.accepted?
 
         @success = true
         self
       end
 
+      def success?
+        !!@success
+      end
+
       private
         def payload
           @payment.to_hash
@@ -27,11 +31,7 @@ module Bs2Api
         end
         
         def url
-          "#{Bs2Api.endpoint}/pix/direto/forintegration/v1/pagamentos/#{@payment.id}/confirmacao"
-        end
-
-        def success?
-          !!@success
+          "#{Bs2Api.endpoint}/pix/direto/forintegration/v1/pagamentos/#{@payment.payment_id}/confirmacao"
         end
     end
   end

data/lib/bs2_api/request/auth.rb

@@ -39,7 +39,7 @@ module Bs2Api
           def body
             {
               grant_type: "client_credentials",
-              scope: "pix.write%20pix.read"
+              scope: "pix.write pix.read"
             }.to_query
           end
 

data/lib/bs2_api/util/bank_service.rb

@@ -12,10 +12,9 @@ module Bs2Api
           bank
         end
 
-        private
-          def bank_list
-            @bank_list ||= YAML.load_file(File.join(__dir__, 'banks.yml'))
-          end
+        def bank_list
+          @bank_list ||= YAML.load_file(File.join(__dir__, 'banks.yml'))
+        end
       end
     end
   end

data/lib/bs2_api/util/response.rb

@@ -0,0 +1,20 @@
+module Util
+  class Response
+    class << self
+      def parse_error res
+        hash    = JSON.parse(res.body)
+        message = "#{res.code}: "
+
+        if hash.is_a?(Array)
+          message << hash[0]["descricao"]
+        elsif hash.key?("error_description")
+          message << hash["error_description"]
+        else 
+          message << hash.to_s
+        end
+
+        message
+      end
+    end
+  end
+end

data/lib/bs2_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bs2_api
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 1.0.2
 platform: ruby
 authors:
 - Kim Pastro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-17 00:00:00.000000000 Z
+date: 2021-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -184,6 +184,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".env.example"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
@@ -221,9 +222,11 @@ files:
 - lib/bs2_api/request/auth.rb
 - lib/bs2_api/util/bank_service.rb
 - lib/bs2_api/util/banks.yml
+- lib/bs2_api/util/response.rb
 - lib/bs2_api/version.rb
 homepage: https://github.com/latamgateway/bs2_api
-licenses: []
+licenses:
+- MIT
 metadata:
   homepage_uri: https://github.com/latamgateway/bs2_api
   source_code_uri: https://github.com/latamgateway/bs2_api