getnet_api 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b083288e0b0ceb66b96ec653754a6ef21f464987b09ec56d05713308a61ac5e8
-  data.tar.gz: 249bf80e84152c593846858e785c1762c3bcb75fd0ac6dc926dfcb588de2c641
+  metadata.gz: fe142d6c121ad9f8648364f3e45fafd1acd9ebfe369a87bad034db9cf0223a55
+  data.tar.gz: 3ef9013855d1149c71d5c21f542b25e441e2f6f40d61266e32e301633e7ac8af
 SHA512:
-  metadata.gz: 152b4a70325e83ff21d558ebe801299f347b621735276226cbff7af16dc09d89c3ed6e0a1effe10fd720d0ea7454afcf3c3d536690a7800ea51b38c92676756a
-  data.tar.gz: 7f2f0f5338c61b5874a1f45973a0f8d64f304de1975d5d081ce5813ae7fba05af382966e5d3f2e47e1e0e8841e1f47b133edfc1414490a9b4d511cb8366c2ad8
+  metadata.gz: d80a89c714e683e9437ae27a5839738cca9f54c9e6950a6bb3f096476d0b7ad895bef4c6a910bb4e971a6d322473c1e3f56f2be0edbd11837f863347aa4f1f55
+  data.tar.gz: f898d223eb7ec5629ca087e488ef3b4cede019ba5ca472fcbf0ad9394bada97ce8782ec9201188aebe25f900d8e3cbea469c2066ce4b3adec989b043d92a769b

data/.github/workflows/ruby.yml

@@ -18,11 +18,23 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
+
     - uses: actions/setup-ruby@v1
       with:
         ruby-version: '2.6' 
+
+    - uses: actions/cache@v2
+      name: Fetching cache for bundle
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+
     - name: Install dependencies
-      run: bundle install
+      run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
     - name: Run tests
       run: bundle exec rspec
-      

data/.gitignore

@@ -49,5 +49,7 @@ build-iPhoneSimulator/
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
 
+coverage
+.idea
 
 to_do

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    getnet_api (1.0.1)
+    getnet_api (1.1.0)
       rest-client (>= 1.7.3)
 
 GEM
@@ -15,7 +15,7 @@ GEM
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     coderay (1.1.3)
     concurrent-ruby (1.1.8)
@@ -26,14 +26,16 @@ GEM
       unf (>= 0.0.5, < 1.0.0)
     hashdiff (1.0.0)
     http-accept (1.7.0)
-    http-cookie (1.0.3)
+    http-cookie (1.0.8)
       domain_name (~> 0.5)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
+    logger (1.6.5)
     method_source (1.0.0)
-    mime-types (3.3.1)
+    mime-types (3.6.0)
+      logger
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0225)
+    mime-types-data (3.2025.0107)
     minitest (5.14.4)
     netrc (0.11.0)
     pry (0.13.1)
@@ -61,9 +63,7 @@ GEM
     safe_yaml (1.0.5)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.7)
+    unf (0.2.0)
     vcr (6.0.0)
     webmock (3.7.1)
       addressable (>= 2.3.6)

data/README.md

@@ -1,4 +1,6 @@
 # Gem Getnet API - Meios de Pagamento
+[![GetnetApi Master Actions Status](https://github.com/minestore/getnet_api/workflows/Ruby/badge.svg)](https://github.com/minestore/getnet_api/actions)
+<a href="https://codeclimate.com/github/minestore/getnet_api/maintainability"><img src="https://api.codeclimate.com/v1/badges/779e36dcfce7e558f24b/maintainability" /></a>
 
 ## Versão Beta
 
@@ -39,7 +41,7 @@ GetnetApi.configure do |config|
   #
   # Código que identifica o seller_id dentro da Getnet
   # Enviado pela Getnet
-  config.seller_id = '5c89ec4a-db89-45a6-8c96-5b0b72907ef5'
+  config.seller_id = '5c89ec4a-db89-45a6-8c96-5b0b72907ef5' 
 
   #
   # Código que identifica o client_id dentro da Getnet
@@ -109,7 +111,6 @@ obj_pagamento = GetnetApi::Payment.new ({
   amount:           100,        # Quantidade em centavos
   order:            obj_pedido, # Objeto da classe GetnetApi::Order
   customer:         obj_cliente, # Objeto da classe GetnetApi::Customer
-  billing_address:  obj_endereco, # Objeto da classe GetnetApi::Address
 })
 ```
 ## Criando um pagamento na GetNet do tipo Credit
@@ -157,6 +158,26 @@ obj_boleto = GetnetApi::Boleto.new ({
 novo_pagamento = GetnetApi::Payment.create obj_pagamento, obj_boleto, :boleto
 ```
 
+---
+
+## Criando um pagamento na GetNet do tipo Pix
+
+### Montar [Pix](https://www.rubydoc.info/gems/getnet_api/GetnetApi/Pix)
+https://developers.getnet.com.br/api#tag/PIX%2Fpaths%2F~1v1~1payments~1qrcode~1pix%2Fpost
+
+```ruby
+obj_pix = GetnetApi::Pix.new ({
+  order_id: "6598",
+  customer_id: "1234"
+})
+```
+
+```ruby
+# No Caso de pagamento de Pix
+# GetnetApi::Payment.create(GetnetApi::Payment, GetnetApi::Pix, tipo)
+novo_pagamento = GetnetApi::Payment.create obj_pagamento, obj_pix, :pix
+```
+
 ## Criando um cancelamento de cartão de crédito
 
 ### Montar [Cancelamento](https://www.rubydoc.info/gems/getnet_api/GetnetApi/PaymentCancel)
@@ -186,13 +207,13 @@ cancelamento = GetnetApi::PaymentCancel.create obj_cancelamento
 
 ## Copyright
 
-[QW3 Software & Marketing](http://qw3.com.br)
+[Falcão Tecnologias Digitais](http://qw3.com.br)
 
-![QW3 Logo](http://qw3.com.br/qw3_logo.png)
+![FalcãoTD Logo](https://falcaotd.com.br/assets/icons/logo-tarja.svg)
 
 MIT License
 
-Copyright (c) 2018 QW3 - Software, Marketing e Consultoria
+Copyright (c) 2025 FalcãoTD - Software, Marketing e Consultoria
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -210,4 +231,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

data/lib/getnet_api/base.rb

@@ -1,10 +1,9 @@
 module GetnetApi
   class Base
-    require 'uri'
-    require 'net/http'
-
-    def self.build_request endpoint, metodo, body=nil
+    require "uri"
+    require "net/http"
 
+    def self.build_request endpoint, metodo, body = nil
       url = URI("#{GetnetApi.base_uri}/#{endpoint}")
 
       http = Net::HTTP.new(url.host, url.port)
@@ -23,14 +22,14 @@ module GetnetApi
       request = GetnetApi::Base.default_headers request
 
       request.body = body.to_json
-      return http.request(request)
+      http.request(request)
     end
 
     def self.default_headers request
       request["authorization"] = "Bearer #{GetnetApi::Base.valid_bearer}"
       request["Content-Type"] = "application/json"
-      request["seller_id"] = "#{GetnetApi.seller_id}"
-      return request
+      request["seller_id"] = GetnetApi.seller_id.to_s
+      request
     end
 
     def self.get_token_de_bearer
@@ -38,27 +37,24 @@ module GetnetApi
       http = Net::HTTP.new(url.host, url.port)
       http.use_ssl = true
       request = Net::HTTP::Post.new(url)
-      request.basic_auth "#{GetnetApi.client_id}", "#{GetnetApi.client_secret}"
+      request.basic_auth GetnetApi.client_id.to_s, GetnetApi.client_secret.to_s
       request["Content-Type"] = "application/x-www-form-urlencoded"
-      hash =  {
-                "scope" => 'oob',
-                "grant_type" => 'client_credentials',
-              }
+      hash = {
+        "scope" => "oob",
+        "grant_type" => "client_credentials"
+      }
       request.body = hash.to_query
-      response =  http.request(request)
+      response = http.request(request)
       result = JSON.parse(response.read_body)
       GetnetApi.access_token = result["access_token"]
       GetnetApi.expires_in = DateTime.now + result["expires_in"].to_i.seconds - 60.seconds
     end
 
     def self.valid_bearer
-      if GetnetApi.expires_in > DateTime.now
-        return GetnetApi.access_token
-      else
+      unless GetnetApi.expires_in > DateTime.now
         GetnetApi::Base.get_token_de_bearer
-        return GetnetApi.access_token
       end
+      GetnetApi.access_token
     end
-
   end
 end

data/lib/getnet_api/boleto.rb

@@ -29,7 +29,6 @@ module GetnetApi
 
     # validates :valor_total, length: { maximum:  }
     # validates :expiration_date, length: { maximum:  }
-    validates :moeda, length: { maximum: 3 }
     validates :our_number , length: { maximum: 12 }
     validates :document_number, length: { maximum: 15 }
     validates :instructions, length: { maximum: 1000 }

data/lib/getnet_api/customer.rb

@@ -9,7 +9,7 @@ module GetnetApi
     }
 
     # Código que identifica o cliente no estabelecimento.
-    # Alfa Numérico - Até 20 caracteres
+    # Alfa Numérico - Até 100 caracteres
     attr_accessor :customer_id
 
     # Nome do comprador
@@ -106,10 +106,10 @@ module GetnetApi
       }
 
       if tipo == :customer
-          customer.merge!({"address" => address.to_request,})
+          customer.merge!({address: address.to_request})
       elsif tipo == :payment
-          customer.merge!({"name" => self.name.to_s,})
-          customer.merge!({"billing_address" => address.to_request,})
+          customer.merge!({name: self.name.to_s})
+          customer.merge!({billing_address: address.to_request})
       end
 
       return customer
@@ -128,7 +128,7 @@ module GetnetApi
     private
 
     def self.endpoint
-      return "/customers"
+      return "customers"
     end
 
   end

data/lib/getnet_api/payment.rb

@@ -23,7 +23,6 @@ module GetnetApi
     # Validações do Rails 3
     include ActiveModel::Validations
 
-    validates :amount, length: { maximum: 3 }
     validates :currency, length: { maximum: 3 }
 
     validates_each [:order] do |record, attr, value|
@@ -36,16 +35,6 @@ module GetnetApi
       end
     end
 
-    validates_each [:boleto] do |record, attr, value|
-      if value.is_a? GetnetApi::Boleto
-        if value.invalid?
-          value.errors.full_messages.each { |msg| record.errors.add(attr, msg) }
-        end
-      else
-        record.errors.add(attr, 'deve ser um objeto GetnetApi::Boleto.')
-      end
-    end
-
     validates_each [:customer] do |record, attr, value|
       if value.is_a? GetnetApi::Customer
         if value.invalid?
@@ -74,41 +63,46 @@ module GetnetApi
     # Montar o Hash de dados do usuario no padrão utilizado pela Getnet
     def to_request obj, type
       payment = {
-        seller_id:        GetnetApi.seller_id.to_s,
-        amount:           self.amount.to_i,
-        currency:         self.currency.to_s,
-        order:            self.order.to_request,
-        customer:         self.customer.to_request(:payment),
+        seller_id: GetnetApi.seller_id.to_s,
+        amount: amount.to_i,
+        currency: currency.to_s,
+        order: order.to_request,
+        customer: customer.to_request(:payment)
       }
 
+      if type == :boleto || type == :credit
+        payment[:order] = order.to_request
+        payment[:customer] = customer.to_request(:payment)
+      end
+
       if type == :boleto
-          payment.merge!({"boleto" => obj.to_request,})
-      elsif :credit
-          payment.merge!({"credit" => obj.to_request,})
+        payment[:boleto] = obj.to_request
+      elsif type == :credit
+        payment[:credit] = obj.to_request
+      elsif type == :pix
+        payment.merge!(obj.to_request)
       end
 
-      return payment
+      payment
     end
 
     # a = GetnetApi::Payment.create pagamento, boleto, :boleto
     def self.create(payment, obj, type)
-
       hash = payment.to_request(obj, type)
 
-      response = self.build_request self.endpoint(type), "post", hash
+      response = build_request(endpoint(type), "post", hash)
 
-      return JSON.parse(response.read_body)
+      JSON.parse(response.read_body)
     end
 
-    private
-
     def self.endpoint type
       if type == :boleto
-        return "payments/boleto"
-      elsif :credit
-        return "payments/credit"
+        "payments/boleto"
+      elsif type == :credit
+        "payments/credit"
+      elsif type == :pix
+        "payments/qrcode/pix"
       end
     end
-
   end
 end

data/lib/getnet_api/pix.rb

@@ -0,0 +1,35 @@
+module GetnetApi
+  class Pix
+    # string 200 characters
+    # Código de identificação da compra utilizado pelo e-commerce. Caso seja informado ele será repassado na Notificação de Pagamento PIX.
+    attr_accessor :order_id
+
+    # string 36 characters
+    # Identificador do comprador utilizado pelo e-commerce. Caso seja informado ele será repassado na Notificação de Pagamento PIX.
+    attr_accessor :customer_id
+
+    # Validações do Rails 3
+    include ActiveModel::Validations
+
+    validates :order_id, length: {maximum: 200}
+    validates :customer_id, length: {maximum: 36}
+
+    # Nova instancia da classe Pix
+    # @param [Hash] campos
+    def initialize(campos = {})
+      campos.each do |campo, valor|
+        if GetnetApi::Pix.public_instance_methods.include? "#{campo}=".to_sym
+          send "#{campo}=", valor
+        end
+      end
+    end
+
+    # Montar o Hash de dados do pagamento no padrão utilizado pela Getnet
+    def to_request
+      {
+        order_id: order_id,
+        customer_id: customer_id
+      }
+    end
+  end
+end

data/lib/getnet_api/version.rb

@@ -2,8 +2,8 @@
 module GetnetApi
   module Version
     MAJOR = 1
-    MINOR = 0
-    PATCH = 3
+    MINOR = 1
+    PATCH = 0
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 end

data/lib/getnet_api.rb

@@ -1,8 +1,7 @@
-# -*- encoding : utf-8 -*-
-require 'rubygems'
-require 'active_model'
-require 'active_support/time'
-require 'json'
+require "rubygems"
+require "active_model"
+require "active_support/time"
+require "json"
 
 require "getnet_api/version"
 require "getnet_api/configure"
@@ -17,10 +16,9 @@ require "getnet_api/boleto"
 require "getnet_api/credit"
 require "getnet_api/payment"
 require "getnet_api/payment_cancel"
-
+require "getnet_api/pix"
 
 # -*- encoding : utf-8 -*-
 module GetnetApi
   extend GetnetApi::Configure
-
 end

data/spec/lib/getnet_api/address_spec.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+describe GetnetApi::Address do
+  let(:address) do
+    GetnetApi::Address.new(
+      street: 'Nome da Rua',
+      number: '123',
+      complement: 'Complemento',
+      district: 'Nome do Bairro',
+      city: 'São Paulo',
+      state: 'SP',
+      country: 'Brasil',
+      postal_code: '01010010'
+    )
+  end
+
+  it 'is valid with valid attributes' do
+    expect(address).to be_valid
+  end
+
+  it 'is not valid with street length > 60' do
+    address.street = 'A' * 61
+    expect(address).not_to be_valid
+    expect(address.errors.messages[:street]).to be_present
+  end
+
+  it 'is not valid with number length > 10' do
+    address.number = '1' * 11
+    expect(address).not_to be_valid
+    expect(address.errors.messages[:number]).to be_present
+  end
+
+  it 'is not valid with complement length > 60' do
+    address.complement = 'A' * 61
+    expect(address).not_to be_valid
+    expect(address.errors.messages[:complement]).to be_present
+  end
+
+  it 'is not valid with district length > 40' do
+    address.district = 'A' * 41
+    expect(address).not_to be_valid
+    expect(address.errors.messages[:district]).to be_present
+  end
+
+  it 'is not valid with city length > 40' do
+    address.city = 'A' * 41
+    expect(address).not_to be_valid
+    expect(address.errors.messages[:city]).to be_present
+  end
+
+  it 'is not valid with state length > 20' do
+    address.state = 'A' * 21
+    expect(address).not_to be_valid
+    expect(address.errors.messages[:state]).to be_present
+  end
+
+  it 'is not valid with country length > 20' do
+    address.country = 'A' * 21
+    expect(address).not_to be_valid
+    expect(address.errors.messages[:country]).to be_present
+  end
+
+  it 'is not valid with postal code length > 8' do
+    address.postal_code = '1' * 9
+    expect(address).not_to be_valid
+    expect(address.errors.messages[:postal_code]).to be_present
+  end
+
+  context '#to_request' do
+    it 'returns address object as a hash' do
+      address_hash = address.to_request
+      address_hash.keys.each do |key|
+        expect(address_hash[key]).to eq address.send(key)
+      end
+    end
+  end
+end

data/spec/lib/getnet_api/base_spec.rb

@@ -1,15 +1,13 @@
 # frozen_string_literal: true
 
 describe GetnetApi::Base do
-  describe '.build_request' do
+  describe '.build_request', :vcr do
     it 'builds and executes request based on' do
-      VCR.use_cassette 'getnet_api/base/build_request' do
-        GetnetApi.ambiente = :sandbox
-        response = GetnetApi::Base.build_request 'some_endpoint', 'get'
-        expect(response).to be_a Net::HTTPNotFound
-        expected_uri = 'https://api-sandbox.getnet.com.br/v1/some_endpoint'
-        expect(WebMock).to have_requested(:get, expected_uri)
-      end
+      GetnetApi.ambiente = :sandbox
+      response = GetnetApi::Base.build_request 'some_endpoint', 'get'
+      expect(response).to be_a Net::HTTPNotFound
+      expected_uri = 'https://api-sandbox.getnet.com.br/v1/some_endpoint'
+      expect(WebMock).to have_requested(:get, expected_uri)
     end
   end
 

data/spec/lib/getnet_api/boleto_spec.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+describe GetnetApi::Boleto do
+  let(:boleto) do
+    GetnetApi::Boleto.new(
+      our_number: '123321123',
+      document_number: '12345678',
+      instructions: 'Não receber após o vencimento',
+      provider: 'santander'
+    )
+  end
+
+  it 'is valid with valid attributes' do
+    expect(boleto).to be_valid
+  end
+
+  it 'is not valid with our number length > 12' do
+    boleto.our_number = '1' * 13
+    expect(boleto).not_to be_valid
+    expect(boleto.errors.messages[:our_number]).to be_present
+  end
+
+  it 'is not valid with document number length > 15' do
+    boleto.document_number = '1' * 16
+    expect(boleto).not_to be_valid
+    expect(boleto.errors.messages[:document_number]).to be_present
+  end
+
+  it 'is not valid with instructions length > 1000' do
+    boleto.instructions = 'A' * 1001
+    expect(boleto).not_to be_valid
+    expect(boleto.errors.messages[:instructions]).to be_present
+  end
+
+  it 'is not valid with provider length > 40' do
+    boleto.provider = 'A' * 41
+    expect(boleto).not_to be_valid
+    expect(boleto.errors.messages[:provider]).to be_present
+  end
+
+  context '#to_request' do
+    it 'returns boleto object as a hash' do
+      boleto_hash = boleto.to_request
+      boleto_hash.keys.each do |key|
+        expect(boleto_hash[key]).to eq boleto.send(key)
+      end
+    end
+  end
+end

data/spec/lib/getnet_api/card_spec.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+describe GetnetApi::Card do
+  let(:card) do
+    GetnetApi::Card.new(
+      number_token: 'dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c',
+      cardholder_name: 'JOAO DA SILVA',
+      security_code: '123',
+      brand: 'Mastercard',
+      expiration_month: '12',
+      expiration_year: '20'
+    )
+  end
+
+  it 'is valid with valid attributes' do
+    expect(card).to be_valid
+  end
+
+  it 'is not valid with number token length > 128' do
+    card.number_token = '1' * 129
+    expect(card).not_to be_valid
+    expect(card.errors.messages[:number_token]).to be_present
+  end
+
+  it 'is not valid with cardholder name length > 26' do
+    card.cardholder_name = '1' * 27
+    expect(card).not_to be_valid
+    expect(card.errors.messages[:cardholder_name]).to be_present
+  end
+
+  it 'is not valid with security_code length > 4' do
+    card.security_code = 'A' * 5
+    expect(card).not_to be_valid
+    expect(card.errors.messages[:security_code]).to be_present
+  end
+
+  it 'is not valid with security_code length < 3' do
+    card.security_code = 'AA'
+    expect(card).not_to be_valid
+    expect(card.errors.messages[:security_code]).to be_present
+  end
+
+  it 'is not valid with brand length > 50' do
+    card.brand = 'A' * 51
+    expect(card).not_to be_valid
+    expect(card.errors.messages[:brand]).to be_present
+  end
+
+  it 'is not valid with expiration month length > 2' do
+    card.expiration_month = '123'
+    expect(card).not_to be_valid
+    expect(card.errors.messages[:expiration_month]).to be_present
+  end
+
+  it 'is not valid with expiration year length > 2' do
+    card.expiration_year = '123'
+    expect(card).not_to be_valid
+    expect(card.errors.messages[:expiration_year]).to be_present
+  end
+
+  context '#to_request' do
+    it 'returns card object as a hash' do
+      card_hash = card.to_request
+      card_hash.keys.each do |key|
+        expect(card_hash[key]).to eq card.send(key)
+      end
+    end
+  end
+end