bs2_api 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b24281ad6b04a90d60a0a1d78a3fef7d4b2531c83bf8b5cbd0d44f76fd89695c
-  data.tar.gz: 1fa297c2368031535ca9b2bce0d0758027e5798cc43cd50434db853d3cfb7cd8
+  metadata.gz: 78c5e50ba3341bf79dd9fa5fbdc83c5e78aca818921951c72e2e6481f3b7b3f9
+  data.tar.gz: 63bbcb0806109efb4d714f80324e00594c31273eda6b6e60d600fb0dd673d3b9
 SHA512:
-  metadata.gz: b1d72bedad6b846d25f93732988783b3c0eb728c20c60e09a61e6b3e5016874169bc9ec97dfdd7c3d6dcc464c929e0ef779b7a8929d75853ba25c985ade8192b
-  data.tar.gz: c82f82b0e70840cfc502ed2420af1d099d97532684db41bdefe11f6b951c560781df5211f6542d014f27bdfbdd461ce69c25b197cf6ba394f4f487357e4c1425
+  metadata.gz: 1e70eb0d7ff1bedab7e1437076020da0c30c79cd895ff0657b291087ecc83b8f1e4c4fc39f5616ff82e5e8462ff75affbb290b3177315e3421ece8aef973b23f
+  data.tar.gz: fad7eaf73f6cb8af230af50c66cb43dab416fcf11149036ed215bd9170beae4a223e920a9c2488a409ef08258453c7a2f6d02c5df5a34ddbd55c106e4edbead1

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,20 @@
-## [0.3.1] - 2021-06-16
+## [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.0)
+    bs2_api (1.0.0)
       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
@@ -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

@@ -10,12 +10,14 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "Integração com a API do BS2"
   spec.description   = "Fazer transferências via PIX"
-  spec.homepage      = "https://github.com/kimpastro/bs2_api"
-  spec.required_ruby_version = ">= 2.7.2"
+  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/kimpastro/bs2_api"
-  spec.metadata["changelog_uri"] = "https://github.com/kimpastro/bs2_api/blob/main/CHANGELOG.md"
+  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"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/bs2_api.rb

@@ -2,12 +2,14 @@
 require "httparty"
 require "active_support/core_ext/hash/indifferent_access"
 require "active_support/core_ext/hash/except"
+require "active_support/core_ext/object/to_query"
+require "active_support/core_ext/object/blank"
 
 require 'bs2_api/version'
 require 'bs2_api/configuration'
 
-require 'bs2_api/initializers/object'
-require 'bs2_api/initializers/hash'
+require 'bs2_api/util/bank_service'
+require 'bs2_api/util/response'
 
 require 'bs2_api/errors/base'
 require 'bs2_api/errors/invalid_pix_key'
@@ -33,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,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
@@ -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,8 +39,8 @@ module Bs2Api
           def body
             {
               grant_type: "client_credentials",
-              scope: "pix.write%20pix.read"
-            }.queryfy
+              scope: "pix.write pix.read"
+            }.to_query
           end
 
           def auth_url

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.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bs2_api
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Kim Pastro
@@ -184,6 +184,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".env.example"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
@@ -214,8 +215,6 @@ files:
 - 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
@@ -223,22 +222,27 @@ 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/kimpastro/bs2_api
-licenses: []
+homepage: https://github.com/latamgateway/bs2_api
+licenses:
+- MIT
 metadata:
-  homepage_uri: https://github.com/kimpastro/bs2_api
-  source_code_uri: https://github.com/kimpastro/bs2_api
-  changelog_uri: https://github.com/kimpastro/bs2_api/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/latamgateway/bs2_api
+  source_code_uri: https://github.com/latamgateway/bs2_api
+  changelog_uri: https://github.com/latamgateway/bs2_api/blob/main/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.7'
+  - - "<"
     - !ruby/object:Gem::Version
-      version: 2.7.2
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/bs2_api/initializers/hash.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-class Hash
-  def queryfy
-    keys.map do |key|
-      "#{key}=#{self[key]}"
-    end.join("&")
-  end
-end

data/lib/bs2_api/initializers/object.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-class Object
-  def blank?
-    respond_to?(:empty?) ? !!empty? : !self
-  end
-
-  def present?
-    !blank?
-  end
-end