bs2_api 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac4d8162e93c876cdd61a6be56abde26d704a31797aef6b815274c98b8e5da29
-  data.tar.gz: fc30a8fbac319e4b810dedac2582902a59ceeacc037f2e8a3f8fc2a8f3d87a1c
+  metadata.gz: e00122261c7f101e2aa06cd712a97dffc16c9217efff07c83eab99cff74110fe
+  data.tar.gz: fbbaae2c421c022b774601e94e10cc25cc2324770e7db7621c5bd6e173184e63
 SHA512:
-  metadata.gz: 783bbec0c5ad81733d817f0958506bbfc300c75983256454d8f050e13ef7b00640ece3fb4d59858cf5aae36656435e7164893972f103a8f495661d10be5551b2
-  data.tar.gz: c2e1e9df5dd5040ccebcf481e6e3bb649ab2dd134a3f0be4ed50014a1543cf0de67508de31809582ddf4a850bf7333970f6284394d905c94d6c0cd4168fa90c4
+  metadata.gz: 1c146dc459d908d337fd1920522d70498a985f5fac4a64f2daecc491b43436dbe462564a66d91467f90420edb0f2ed3390e88c9dd7af74d910d6cffe12ed7111
+  data.tar.gz: f4a492028c841aca65b635d6a12ba2dd9500b656fd3eae6dd7df88d0480b3104c5640ae5eb3bc8647ff453b18a04018e3bdae85e6afa917932ec5c57c6771795

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,4 +1,10 @@
-## [Unreleased]
+## [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
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bs2_api (0.3.0)
+    bs2_api (0.3.4)
       activesupport
       builder
       bundler
@@ -76,6 +76,7 @@ GEM
     zeitwerk (2.4.2)
 
 PLATFORMS
+  ruby
   x86_64-linux
 
 DEPENDENCIES

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
@@ -43,9 +48,9 @@ ou via initializer:
 
 ```ruby
 Bs2Api.configure do |config|
-  config.client_id       = 'you_bs2_client_id'
-  config.client_secret   = 'you_bs2_client_secret'
-  config.pix_environment = 'sandbox' # ou production
+  config.client_id     = 'you_bs2_client_id'
+  config.client_secret = 'you_bs2_client_secret'
+  config.env           = 'sandbox' # ou production
 end
 ```
 
@@ -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

@@ -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,11 +35,9 @@ require 'bs2_api/payment/confirmation'
 
 require 'bs2_api/request/auth'
 
-require 'bs2_api/util/bank_service'
-
 module Bs2Api
   ENDPOINT = {
-    production: 'https://api.bs2.com:8443',
+    production: 'https://api.bs2.com',
     sandbox: 'https://apihmz.bancobonsucesso.com.br'
   }
 
@@ -47,7 +47,7 @@ module Bs2Api
     def configuration
       @configuration ||= Configuration.new
     end
-  
+
     def configure
       yield(configuration)
     end
@@ -59,7 +59,7 @@ module Bs2Api
     def production?
       env == 'production'
     end
-    
+
     def sandbox?
       env == 'sandbox'
     end
@@ -68,4 +68,4 @@ module Bs2Api
       configuration.env
     end
   end
-end
+end

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
 
@@ -49,4 +49,4 @@ module Bs2Api
      end
     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.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bs2_api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kim Pastro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-16 00:00:00.000000000 Z
+date: 2021-06-17 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"
@@ -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 to_query
-    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