bs2_api 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2b8b144d4d8f5045e87461029c823e9b5f5a7c3d5a9191f1e39a542ac5d7400
-  data.tar.gz: c9bcf3bb230b56e8a0ac0d0e2d4373ec37a49869bc1918597b36dd57d1ff5bab
+  metadata.gz: 83d1974407ed876b13a3c90b79f4ea2ac0d10f018671176974d0546c8cf37c16
+  data.tar.gz: 11ae325cfb8f34158df8cffc73bb97b44371b5c1092a3c45784fb9a947672d7c
 SHA512:
-  metadata.gz: d4a1c8e8823be43d5c6f8a69b4817552e58e3e1a82d81780ed3a181ecae7449d6da2f0235bda18d36b2632dc7e58d06346624690efc9ed6f1b46ef526167572f
-  data.tar.gz: 242287b0695c77833428867361fb1a469eb912ffa0b387c8443f8fbba3db23a2bdd4aa1dbc6e9e172084166fb087ff8fbe9ff19a0cdc6260a12449963ecc7e86
+  metadata.gz: afa20659aead1ad39f6a5d8123d7d34a880b3379888c4a1f4357fea96805ba3aa5da8ad95da622dd06fa656b63f2e9c05082d75136dcfd30ac9d49f8914f97da
+  data.tar.gz: fc45ca9142c72de060b098e716c578a6a636ebab90bdd67627be66ec8fa00d9c2603c1e5efb8b5c6be0bba500f9dff68bdf89a85b0e11a580972fe0996e507c1

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/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bs2_api (0.3.2)
+    bs2_api (0.3.4)
       activesupport
       builder
       bundler

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
@@ -64,7 +69,7 @@ pay_key = Bs2Api::Payment::Key.new(pix_key).call
 pay_key.payment.id
 => "96f0b3c4-4c76-4a7a-9933-9c9f86df7490" # pagamentoId gerado no BS2
 
-pay_key.payment.merchantId
+pay_key.payment.merchant_id
 => "E710278662021061618144401750781P" # endToEndId gerado no BS2
 
 ```
@@ -101,32 +106,33 @@ pay_manual.payment.merchantId
 ```
 
 ### 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/payment/base.rb

@@ -9,7 +9,7 @@ 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.created?
         
         @payment = Bs2Api::Entities::Payment.from_response(response)
         self
@@ -32,21 +32,6 @@ 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

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
@@ -29,10 +33,6 @@ module Bs2Api
         def url
           "#{Bs2Api.endpoint}/pix/direto/forintegration/v1/pagamentos/#{@payment.id}/confirmacao"
         end
-
-        def success?
-          !!@success
-        end
     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/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 = "0.3.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bs2_api
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Kim Pastro
@@ -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