sicoob_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4d201618226be8e7c5495ff1dba58de27b32c04a1cb32f23fb0f2aa8fc152f53
+  data.tar.gz: e6e2c854ff1ec1f2b9cf3a80a0324c71279638dfd251fd4f21742ea3c0320c68
+SHA512:
+  metadata.gz: 5ef3778e556f6cd251d7d0dc30a2a4e5f9475b707f264de5d79cd7ac95803fef44bcb72b8d1205d6a630ca8073a5a63a37e2fc33d0a0139cdc8acf15c88cdc9d
+  data.tar.gz: ef8e4e299689e1e30d156b5d87d9cd1bb8440fe90cb0124fa9c8762b9ca33f9c2fee3ef2f8087808717d7c4eb39e7dc632e7a18274a029cd4e3fdec3d1afab39

data/README.md

@@ -0,0 +1,10 @@
+# Sicoob Api
+<!-- Explain what your extension does. -->
+
+## Installation
+
+Add sicoob_api to your Gemfile:
+
+```ruby
+gem 'sicoob_api'
+```

data/lib/sicoob_api/client.rb

@@ -0,0 +1,106 @@
+module SicoobApi
+  class Client < Ac::Base
+    BASE_URL = "https://api.sicoob.com.br/pix/api/v2"
+    # SAVE_RESPONSES = true
+    MAX_RETIES = 2
+
+    attr_accessor :client_id, :chave_pix, :crt, :key, :token, :token_expires_at, :scopes
+
+    def initialize(client_id:, chave_pix:, crt:, key:, token: nil, token_expires_at: nil, scopes: "cob.write cob.read cobv.write cobv.read lotecobv.write lotecobv.read pix.write pix.read webhook.read webhook.write payloadlocation.write payloadlocation.read")
+      @client_id = client_id
+      @chave_pix = chave_pix
+      @crt = crt
+      @key = key
+      @token = token
+      @token_expires_at = token_expires_at
+      @scopes = scopes
+      access_token
+    end
+
+    def access_token
+      if token.nil? || token_expires_at.nil? || token_expires_at < Time.now
+        response = Typhoeus.post("https://auth.sicoob.com.br/auth/realms/cooperado/protocol/openid-connect/token",
+          body: {
+            client_id: client_id,
+            scope: scopes,
+            grant_type: "client_credentials"
+          },
+          sslcert: crt,
+          sslkey: key) { |response| validate_response(response, "access_token") }
+        raise "Erro ao obter token: #{response.body}" unless response.success?
+        @token = response.json["access_token"]
+        @token_expires_at = Time.now + response.json["expires_in"]
+      end
+      token
+    end
+
+    def create_payment amount:, payer_tax_id: nil, payer_name: nil, expiration: 3600, solicitacao_pagador: nil, info_adicionais: []
+      body = {
+        calendario: {
+          expiracao: expiration
+        },
+        valor: {
+          original: format("%.2f", amount),
+          modalidadeAlteracao: 0
+        },
+        chave: chave_pix
+      }
+      body[:devedor] = devedor(payer_tax_id, payer_name) if payer_tax_id && payer_name
+      body[:solicitacaoPagador] = solicitacao_pagador if solicitacao_pagador
+      body[:infoAdicionais] = info_adicionais if info_adicionais.any?
+      response = post("cob", sslcert: crt, sslkey: key, body: JSON.dump(body), headers: {"content-type": "application/json"}) { |response| validate_response(response, "txid") }
+      SicoobApi::Payment.new(response.json, self)
+    end
+
+    def get_payment txid
+      response = get("cob/#{txid}", sslcert: crt, sslkey: key) { |response| validate_response(response, "txid") }
+      SicoobApi::Payment.new(response.json, self)
+    end
+
+    def update_payment(payment_id, body)
+      response = patch("cob/#{payment_id}", headers: {"content-type": "application/json"}, sslcert: @crt, sslkey: @key, body: JSON.dump(body)) { |response| validate_response(response, "txid") }
+      SicoobApi::Payment.new(response.json, self)
+    end
+
+    def refund_payment(end_to_end_id, amount, refund_nature, description)
+      id = SecureRandom.hex(10)
+      body = {
+        valor: format("%.2f", amount),
+        natureza: refund_nature,
+        descricao: description
+      }
+      response = put("pix/#{end_to_end_id}/devolucao/#{id}", headers: {"content-type": "application/json"}, sslcert: @crt, sslkey: @key, body: JSON.dump(body)) { |response| validate_response(response, "id") }
+      response.json
+    end
+
+    def get_refund(end_to_end_id, id)
+      response = get("pix/#{end_to_end_id}/devolucao/#{id}", headers: {"content-type": "application/json"}, sslcert: @crt, sslkey: @key) { |response| validate_response(response, "id") }
+      response.json
+    end
+
+    def update_webhook url
+      put("webhook/#{chave_pix}", sslcert: crt, sslkey: key, body: JSON.dump({webhookUrl: url})) { |response| validate_response(response, "") }
+    end
+
+    def get_webhook
+      get("webhook/#{chave_pix}", sslcert: crt, sslkey: key) { |response| validate_response(response, "webhookUrl") }
+    end
+
+    private
+
+    def devedor(payer_tax_id, payer_name)
+      return {} if payer_tax_id.nil? || payer_name.nil?
+      formatted_tax_id = payer_tax_id.gsub(/\D/, "")
+      document_type = (formatted_tax_id.length == 11) ? "cpf" : "cnpj"
+      {
+        document_type => formatted_tax_id,
+        "nome" => payer_name
+      }
+    end
+
+    def validate_response(response, required_response_key)
+      puts response.json unless response.success?
+      ![500, 429].include?(response.code) || response.json.dig(*required_response_key)
+    end
+  end
+end

data/lib/sicoob_api/payment.rb

@@ -0,0 +1,87 @@
+module SicoobApi
+  class Payment
+    attr_reader :response, :txid, :end_to_end_id, :devolucoes, :copia_e_cola, :status, :solicitacao, :info_adicionais, :valor_original, :valor_pago, :criacao, :expiracao, :pago_em, :devedor_nome, :devedor_tax_id, :internal_error
+    def initialize(response, client)
+      @client = client
+      @response = response
+      @txid = response.dig("txid")
+      @end_to_end_id = response.dig("pix", 0, "endToEndId")
+      @devolucoes = response.dig("pix", 0, "devolucoes")
+      @copia_e_cola = response.dig("brcode") || response.dig("qrCode")
+      @status = response.dig("status")
+      @solicitacao = response.dig("solicitacaoPagador")
+      @info_adicionais = response.dig("infoAdicionais")
+      @valor_original = response.dig("valor", "original")
+      @valor_pago = response.dig("pix", 0, "valor")
+      @criacao = creation_date
+      @expiracao = expiration_date
+      @pago_em = paid_date
+      @devedor_nome = response.dig("devedor", "nome")
+      @devedor_tax_id = response.dig("devedor", "cpf") || response.dig("devedor", "cnpj")
+      @internal_error = PaymentError.new(response).internal_error
+    end
+
+    def paid? external_value = nil
+      external_value = @valor_original if external_value.nil?
+      @status == "CONCLUIDA" && @valor_original.to_d == @valor_pago.to_d && external_value.to_d == @valor_pago.to_d
+    end
+
+    def valid?
+      @status == "ATIVA" && @expiracao > Time.now
+    end
+
+    def retrieve
+      @client.get_payment(@txid)
+    end
+
+    def reload!
+      new_payment = retrieve
+      instance_variables.each do |variable|
+        instance_variable_set(variable, new_payment.instance_variable_get(variable))
+      end
+      self
+    end
+
+    def update(body)
+      @client.update_payment(@txid, body)
+    end
+
+    def invalidate!
+      update({status: "REMOVIDA_PELO_USUARIO_RECEBEDOR"})
+      reload!
+    end
+
+    def refund(amount: nil, refund_nature: nil, description: nil)
+      amount ||= @valor_pago
+      refund_nature ||= "ORIGINAL"
+      @client.refund_payment(@end_to_end_id, amount, refund_nature, description)
+    end
+
+    def qr_code(module_size: 4)
+      return false unless @copia_e_cola
+      qr = RQRCode::QRCode.new(@copia_e_cola, size: 10, level: :l)
+      qr.as_svg(module_size: module_size)
+    end
+
+    def puts_qrcode
+      puts RQRCode::QRCode.new(@copia_e_cola).to_s(dark: "██", light: "  ")
+    end
+
+    private
+
+    def creation_date
+      return nil unless @response.dig("calendario", "criacao")
+      Time.new(@response.dig("calendario", "criacao"))
+    end
+
+    def expiration_date
+      return nil unless @response.dig("calendario", "criacao")
+      Time.new(@response.dig("calendario", "criacao")) + @response.dig("calendario", "expiracao")
+    end
+
+    def paid_date
+      return nil unless @response.dig("pix", 0, "horario")
+      Time.new(@response.dig("pix", 0, "horario"))
+    end
+  end
+end

data/lib/sicoob_api/payment_error.rb

@@ -0,0 +1,25 @@
+module SicoobApi
+  class PaymentError
+    STATUS_ERROR = [400, 403, 404, 503]
+    attr_accessor :json_response
+    def initialize json_response
+      @json_response = json_response
+    end
+
+    def internal_error
+      return nil unless json_response["violacoes"] || STATUS_ERROR.include?(json_response["status"])
+      failed_message_error || rejected_message_error || "Pagamento recusado."
+    end
+
+    private
+
+    def rejected_message_error
+      "#{json_response["title"]} => #{json_response["detail"]}"
+    end
+
+    def failed_message_error
+      return false unless json_response["violacoes"]
+      "#{json_response["violacoes"][0]["razao"]} => #{json_response["violacoes"][0]["propriedade"]}"
+    end
+  end
+end

data/lib/sicoob_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SicoobApi
+  VERSION = "0.0.1"
+end

data/lib/sicoob_api.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "ac"
+require "bigdecimal/util"
+require "securerandom"
+require "rqrcode"
+
+require_relative "sicoob_api/version"
+require_relative "sicoob_api/client"
+require_relative "sicoob_api/payment"
+require_relative "sicoob_api/payment_error"
+
+module SicoobApi
+  Typhoeus::Config.timeout = 10
+
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: sicoob_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- hamilton
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ac
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rqrcode
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: securerandom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email: hamilton@todasessascoisas.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/sicoob_api.rb
+- lib/sicoob_api/client.rb
+- lib/sicoob_api/payment.rb
+- lib/sicoob_api/payment_error.rb
+- lib/sicoob_api/version.rb
+homepage: https://github.com/todasessascoisas/sicoob_api
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.10
+signing_key:
+specification_version: 4
+summary: ''
+test_files: []