bs2_api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c1e001ddc04c41bef41d3e70d36e8855ccbf8c2f798bcf780053d0e832e924b
-  data.tar.gz: 5eb113c82664566db0fbc4ac9ade7023a55ff7cf7f44820fb7965ec132fc3922
+  metadata.gz: b46010721b6fd642ba8db84aff501d9a29ecf78faacf023c4dc844ff50d58b41
+  data.tar.gz: '0982876fca9f7c65f23c58286d9f60bcb01217d934287b38505fd21d2000f9c2'
 SHA512:
-  metadata.gz: cc1f09dbd72fe994bf3703eb57244cea11ee52cdc83f0b96277af64bb8c385fbf0b1f692d3d513202847fa359c1a336ba17aa1e2df5cb02966e83099718c5442
-  data.tar.gz: 0ab3b8f4202173d42d3ddcef476489e1378f05df4d4d9c632c7141617385e0592e7f15a1615920c8af5c8fd4d3d87c52f59781c361a340ce83a609c2cd4de25c
+  metadata.gz: 6fcee38ab1c4c3c3ada7eb9e2ada3f8090223ad0d28e0797a7494bd8c00bd11a9d828e2ccc545f9ad23278d9ac86b124116f6b604e7cc476ad5aab08cc5c074a
+  data.tar.gz: 98e9b97e08e256ee31145a404758702dbd40c6a62f12d018fcf1e0f2de9456efb3604d25fe8361b43d004104003d96ba237020b7afa690d1bf11088c8646c7cf

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

@@ -5,4 +5,9 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in bs2_api.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem "rake", "~> 13.0"
+
+group :test do
+  gem "pry-byebug", "~> 3.9"
+  gem 'uuid', '~> 2.3', '>= 2.3.9'
+end

data/Gemfile.lock

@@ -1,34 +1,60 @@
 PATH
   remote: .
   specs:
-    bs2_api (0.1.0)
-      http (~> 5.0)
+    bs2_api (0.2.0)
+      activesupport (~> 6.1, >= 6.1.3.2)
+      http (~> 4.4)
 
 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)
+    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)
+    dotenv (2.7.6)
     ffi (1.15.1)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
-    http (5.0.0)
+    hashdiff (1.0.1)
+    http (4.4.1)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
       http-form_data (~> 2.2)
-      llhttp-ffi (~> 0.0.1)
+      http-parser (~> 1.2.0)
     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)
+    http-parser (1.2.3)
+      ffi-compiler (>= 1.0, < 2.0)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    macaddr (1.7.2)
+      systemu (~> 2.6.5)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    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 +68,33 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
+    systemu (2.6.5)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.7)
+    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
   x86_64-linux
 
 DEPENDENCIES
   bs2_api!
+  dotenv (~> 2.7, >= 2.7.6)
+  pry-byebug (~> 3.9)
   rake (~> 13.0)
   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,144 @@
 # 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
-
-## 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
+```
+
+Ou instale diretamente via:
+```bash
+gem install bs2_api
+```
+
+### Configuração
+Via variável de ambiente:
+```bash
+BS2_CLIENT_ID
+BS2_CLIENT_SECRET
+BS2_CLIENT_ENVIRONMENT # production or sandbox. Default to sandbox
+```
+
+ou via initializer:
 
-    $ bundle install
+```ruby
+Bs2Api.configure do |config|
+  config.client_id       = 'you_bs2_client_id'
+  config.client_secret   = 'you_bs2_client_secret'
+  config.pix_environment = 'pix_enviroment'
+end
+```
 
-Or install it yourself as:
+### Iniciar pagamento por Chave
 
-    $ gem install bs2_api
+```ruby
+pix_key = Bs2Api::Entities::PixKey.new(
+  key: 'joao@gmail.com',
+  type: 'EMAIL'
+)
 
-## Usage
+payment = Bs2Api::Payment::Key.new(pix_key).call
+```
 
-TODO: Write usage instructions here
+Tipos:
+```bash
+CPF
+CNPJ
+PHONE
+EMAIL
+EVP (Chave aleatória)
+```
 
-## Development
 
-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.
+### Iniciar pagamento Manual
 
-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).
+```ruby
+account = Bs2Api::Entities::Account.new(
+  bank_code: '341',
+  bank_name: 'Itaú',
+  agency: '0944',
+  number: '09442-1',
+  type: 'ContaCorrente'
+)
+
+customer = Bs2Api::Entities::Customer.new(
+  document: '88899988811',
+  type: 'CPF',
+  name: 'João Silva'
+)
+
+receiver = Bs2Api::Entities::Bank.new(
+  account: account, 
+  customer: customer
+)
+
+payment = Bs2Api::Payment::Manual.new(receiver).call
+```
 
-## Contributing
+### Objetos
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bs2_api.
+##### Payment
+```ruby
+payment.id # pagamentoId
+payment.merchant_id # endToEndId
+payment.receiver # recebedor
+payment.payer # pagador
+
+payment.receiver.class
+=> Bs2Api::Entities::Bank
+
+payment.payer.class
+=> Bs2Api::Entities::Bank
+
+payment.payer.account # conta
+=> Bs2Api::Entities::Account
+
+payment.payer.customer # pessoa
+=> Bs2Api::Entities::Customer
+
+payment.to_hash
+{
+  "pagamentoId"=>"123", 
+  "endToEndId"=>"456", 
+  "recebedor"=>{
+    "ispb"=>"71027866", 
+    "conta"=>{
+      "banco"=>"218", 
+      "bancoNome"=>"BCO BS2 S.A.", 
+      "agencia"=>"0001", 
+      "numero"=>"3134806", 
+      "tipo"=>"ContaCorrente"
+    },
+    "pessoa"=>{
+      "documento"=>"25215188000116", 
+      "tipoDocumento"=>"CNPJ", 
+      "nome"=>"Teste Automatizado", 
+      "nomeFantasia"=>nil
+    }
+  }, 
+  "pagador"=>{
+    "ispb"=>"71027866", 
+    "conta"=>{
+      "banco"=>"218", 
+      "bancoNome"=>"BCO BS2 S.A.", 
+      "agencia"=>"0001", 
+      "numero"=>"3134806", 
+      "tipo"=>"ContaCorrente"
+    },
+    "pessoa"=>{
+      "documento"=>"25215188000116", 
+      "tipoDocumento"=>"CNPJ", 
+      "nome"=>"Teste Automatizado", 
+      "nomeFantasia"=>nil
+    }
+  }
+}
+```

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

@@ -27,5 +27,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "rspec", "~> 3.10"
-  spec.add_dependency "http", "~> 5.0"
+  spec.add_development_dependency "webmock", "~> 3.13"
+  spec.add_development_dependency "vcr", "~> 6.0"
+  spec.add_development_dependency "dotenv", "~> 2.7", ">= 2.7.6"
+
+  spec.add_dependency "http", "~> 4.4"
+  spec.add_dependency "activesupport", "~> 6.1", ">= 6.1.3.2"
 end

data/lib/bs2_api.rb

@@ -1,7 +1,65 @@
 # frozen_string_literal: true
 
-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/missing_configuration'
+require 'bs2_api/errors/unauthorized'
+require 'bs2_api/errors/bad_request'
+require 'bs2_api/errors/server_error'
+
+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/request/auth'
+
+require 'bs2_api/util/bank_service'
+
+require "active_support/core_ext/hash/indifferent_access"
 
 module Bs2Api
-  class Bs2ApiError < StandardError; end
-end
+  ENDPOINT = {
+    production: 'https://api.bs2.com:8443',
+    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

data/lib/bs2_api/configuration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class Configuration
+  attr_accessor :client_id, :client_secret, :pix_key, :env
+
+  def initialize
+    @env           = ENV.fetch('BS2_ENVIRONMENT', 'sandbox')
+    @client_id     = ENV.fetch('BS2_CLIENT_ID', nil)
+    @client_secret = ENV.fetch('BS2_CLIENT_SECRET', nil)
+  end
+
+  def valid?
+    raise Bs2Api::Errors::MissingConfiguration, 'Missing configuration credentials' if @client_id.blank? || @client_secret.blank?
+  end
+end

data/lib/bs2_api/entities/account.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Bs2Api
+  module Entities
+    class Account
+      attr_accessor :bank_code, :bank_name, :agency, :number, :type
+  
+      TYPES = {
+        checking: 'ContaCorrente',
+        salary: 'ContaSalario',
+        saving: 'Poupanca'
+      }
+
+      def initialize(args = {})
+        @bank_code  = args.fetch(:bank_code, nil)
+        @bank_name  = args.fetch(:bank_name, nil)
+        @agency     = args.fetch(:agency, nil)
+        @number     = args.fetch(:number, nil)
+        @type       = args.fetch(:type, nil)
+      end
+
+      def to_hash
+        ActiveSupport::HashWithIndifferentAccess.new(
+          {
+            "banco": @bank_code,
+            "bancoNome": bank_name,
+            "agencia": @agency,
+            "numero": @number,
+            "tipo": @type
+          }
+        )
+      end
+
+      def self.from_response(hash_payload)
+        hash = ActiveSupport::HashWithIndifferentAccess.new(hash_payload)
+
+        Bs2Api::Entities::Account.new(
+          bank_code: hash["banco"],
+          bank_name: hash["bancoNome"],
+          agency: hash["agencia"],
+          number: hash["numero"],
+          type: hash["tipo"]
+        )
+      end
+
+      def checking?
+        @type == TYPES[:checking]
+      end
+
+      def salary?
+        @type == TYPES[:salary]
+      end
+
+      def saving?
+        @type == TYPES[:saving]
+      end
+    end
+  end
+end