bs2_api 0.1.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c1e001ddc04c41bef41d3e70d36e8855ccbf8c2f798bcf780053d0e832e924b
-  data.tar.gz: 5eb113c82664566db0fbc4ac9ade7023a55ff7cf7f44820fb7965ec132fc3922
+  metadata.gz: 9153997d692126d6fbbc902507f8a62f95feb214c2b6c815507ebbb82981e9aa
+  data.tar.gz: 413f69f983087e627979be0e5223688c03452e78aacc2becd913ac1c135ff169
 SHA512:
-  metadata.gz: cc1f09dbd72fe994bf3703eb57244cea11ee52cdc83f0b96277af64bb8c385fbf0b1f692d3d513202847fa359c1a336ba17aa1e2df5cb02966e83099718c5442
-  data.tar.gz: 0ab3b8f4202173d42d3ddcef476489e1378f05df4d4d9c632c7141617385e0592e7f15a1615920c8af5c8fd4d3d87c52f59781c361a340ce83a609c2cd4de25c
+  metadata.gz: b667b6c8cf9d321077a6055442bf5fc5632f3a61fcc6cfaf092d42472901450ab3ce079422744a8375591946d54100412ba4002d56b3ef18fff48d74125f5f50
+  data.tar.gz: 84092195a3e63e5d99419bf92631361a7abcbbc94f39332d5769990ea331a2569a1bb822a8187f19cc50774101aad26a9077ae1cb4c9f552d02e19753628130b

data/.env.example

@@ -0,0 +1,3 @@
+BS2_ENVIRONMENT=sandbox
+BS2_CLIENT_ID=123
+BS2_CLIENT_SECRET=123

data/.gitignore

@@ -9,3 +9,7 @@
 
 # rspec failure tracking
 .rspec_status
+
+*.gem
+
+.env.test

data/CHANGELOG.md

@@ -1,4 +1,15 @@
-## [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
+
+- Entities, Auth, Create Pix Key Payment
+
 
 ## [0.1.0] - 2021-06-11
 

data/Gemfile

@@ -2,7 +2,4 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in bs2_api.gemspec
-gemspec
-
-gem "rake", "~> 13.0"
+gemspec

data/Gemfile.lock

@@ -1,34 +1,55 @@
 PATH
   remote: .
   specs:
-    bs2_api (0.1.0)
-      http (~> 5.0)
+    bs2_api (0.3.0)
+      activesupport
+      builder
+      bundler
+      httparty (~> 0.18.1)
+      rake
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      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)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.4.4)
-    domain_name (0.5.20190701)
-      unf (>= 0.0.5, < 1.0.0)
-    ffi (1.15.1)
-    ffi-compiler (1.0.1)
-      ffi (>= 1.0.0)
-      rake
-    http (5.0.0)
-      addressable (~> 2.3)
-      http-cookie (~> 1.0)
-      http-form_data (~> 2.2)
-      llhttp-ffi (~> 0.0.1)
-    http-cookie (1.0.4)
-      domain_name (~> 0.5)
-    http-form_data (2.3.0)
-    llhttp-ffi (0.0.1)
-      ffi-compiler (~> 1.0)
-      rake (~> 13.0)
+    dotenv (2.7.6)
+    hashdiff (1.0.1)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    macaddr (1.7.2)
+      systemu (~> 2.6.5)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0225)
+    minitest (5.14.4)
+    multi_xml (0.6.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
     public_suffix (4.0.6)
     rake (13.0.3)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -42,17 +63,30 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.7)
+    systemu (2.6.5)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    uuid (2.3.9)
+      macaddr (~> 1.0)
+    vcr (6.0.0)
+    webmock (3.13.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
+  ruby
   x86_64-linux
 
 DEPENDENCIES
   bs2_api!
-  rake (~> 13.0)
+  dotenv (~> 2.7, >= 2.7.6)
+  pry-byebug (~> 3.9)
   rspec (~> 3.10)
+  uuid (~> 2.3, >= 2.3.9)
+  vcr (~> 6.0)
+  webmock (~> 3.13)
 
 BUNDLED WITH
    2.2.18

data/Makefile

@@ -0,0 +1,2 @@
+console:
+	ruby bin/console

data/README.md

@@ -1,35 +1,142 @@
 # Bs2Api
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bs2_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+Integração com a API do Banco BS2: https://devs.bs2.com/manual/pix-clientes
 
-TODO: Delete this and the text above, and describe your gem
+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
 
-## Installation
 
-Add this line to your application's Gemfile:
+## Instalação
 
+Adicionar no seu Gemfile:
 ```ruby
 gem 'bs2_api'
 ```
 
-And then execute:
+E então execute:
+```bash
+bundle install
+```
 
-    $ bundle install
+Ou instale diretamente via:
+```bash
+gem install bs2_api
+```
 
-Or install it yourself as:
+### Configuração
+Via variável de ambiente:
+```bash
+BS2_CLIENT_ID
+BS2_CLIENT_SECRET
+BS2_CLIENT_ENVIRONMENT # production or sandbox. Default to sandbox
+```
 
-    $ gem install bs2_api
+ou via initializer:
 
-## Usage
+```ruby
+Bs2Api.configure do |config|
+  config.client_id     = 'you_bs2_client_id'
+  config.client_secret = 'you_bs2_client_secret'
+  config.env           = 'sandbox' # ou production
+end
+```
 
-TODO: Write usage instructions here
+### Inicia ordem de Transferência PIX via: Chave
 
-## Development
+```ruby
+pix_key = Bs2Api::Entities::PixKey.new(
+  key: 'joao@gmail.com',
+  type: 'EMAIL'
+)
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+# 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
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+pay_key.payment.id
+=> "96f0b3c4-4c76-4a7a-9933-9c9f86df7490" # pagamentoId gerado no BS2
 
-## Contributing
+pay_key.payment.merchantId
+=> "E710278662021061618144401750781P" # endToEndId gerado no BS2
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bs2_api.
+```
+
+### Inicia ordem de Transferência PIX via: Manual
+
+```ruby
+account = Bs2Api::Entities::Account.new(
+  bank_code: "218",
+  agency: "0993",
+  number: "042312",
+  type: "ContaCorrente" # ContaCorrente, ContaSalario ou Poupanca
+)
+
+customer = Bs2Api::Entities::Customer.new(
+  document: "88899988811",
+  type: "CPF",
+  name: "Rick Sanches",
+  business_name: "Nome fantasia" # Utilizar apenas se for type CNPJ
+)
+
+receiver_bank = Bs2Api::Entities::Bank.new(
+  account: account,
+  customer: customer
+)
+
+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
+```
+
+### 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
+
+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
+# 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/bin/setup

@@ -3,6 +3,4 @@ set -euo pipefail
 IFS=$'\n\t'
 set -vx
 
-bundle install
-
-# Do any other automated setup that you need to do here
+bundle install

data/bs2_api.gemspec

@@ -9,13 +9,13 @@ 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.homepage      = "https://github.com/kimpastro/bs2_api"
-  spec.required_ruby_version = ">= 2.7.2"
+  spec.description   = "Fazer transferências via PIX"
+  spec.homepage      = "https://github.com/latamgateway/bs2_api"
+  spec.required_ruby_version = "~> 2.7", "< 3"
 
   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.
@@ -26,6 +26,16 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "rspec", "~> 3.10"
-  spec.add_dependency "http", "~> 5.0"
-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,7 +1,71 @@
 # frozen_string_literal: true
+require "httparty"
+require "active_support/core_ext/hash/indifferent_access"
+require "active_support/core_ext/hash/except"
 
-require_relative "bs2_api/version"
+require 'bs2_api/version'
+require 'bs2_api/configuration'
+
+require 'bs2_api/initializers/object'
+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'
+require 'bs2_api/entities/customer'
+require 'bs2_api/entities/payment'
+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'
+
+require 'bs2_api/util/bank_service'
 
 module Bs2Api
-  class Bs2ApiError < StandardError; end
+  ENDPOINT = {
+    production: 'https://api.bs2.com',
+    sandbox: 'https://apihmz.bancobonsucesso.com.br'
+  }
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def endpoint
+      ENDPOINT[configuration.env.to_sym]
+    end
+
+    def production?
+      env == 'production'
+    end
+
+    def sandbox?
+      env == 'sandbox'
+    end
+
+    def env
+      configuration.env
+    end
+  end
 end