dlocal_go 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8f9e2ff547bf6bc0042c696f0c4815d7601135cb72ec74948faca35073efb458
+  data.tar.gz: 072cd8f884e3d1ce4947899a37b9c4e397b2e491d22b8da1ac4fcf6e6133de00
+SHA512:
+  metadata.gz: 508e9b4fde2d886f3b4531257e8d3e8b38519303617a0630b395cb802380458d4f5c54673f65d9e77d02d19e234a2237c7ca2b2364b7a3320cd9a4fdd909b3af
+  data.tar.gz: 5ac6fe63c35bc31d14ed05cfd3a3200ee902e0dc6526bbae2a9ad3737986b42e162ba2d7aa63f44349c1b7b7306c26254b9392c1bf43c631c6c169fd16886f42

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/AbcSize:
+  Enabled: true
+  Max: 30

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## [0.1.0] - 2023-03-03
+
+### Initial release
+
+- Config Dlocal Go API credentials
+- Config environment and supported countries
+- Basic client with: create_payment, get_payment, and create_refund
+

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dlocal_go.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "webmock"
+
+gem "debug"

data/Gemfile.lock

@@ -0,0 +1,99 @@
+PATH
+  remote: .
+  specs:
+    dlocal_go (0.1.0)
+      http
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
+    debug (1.6.2)
+      irb (>= 1.3.6)
+      reline (>= 0.3.1)
+    diff-lcs (1.5.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.15.5)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    hashdiff (1.0.1)
+    http (5.1.1)
+      addressable (~> 2.8)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      llhttp-ffi (~> 0.4.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    io-console (0.5.11)
+    irb (1.4.1)
+      reline (>= 0.3.0)
+    json (2.6.2)
+    llhttp-ffi (0.4.0)
+      ffi-compiler (~> 1.0)
+      rake (~> 13.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    reline (0.3.1)
+      io-console (~> 0.5)
+    rexml (3.2.5)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (1.36.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+    unicode-display_width (2.2.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  debug
+  dlocal_go!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  webmock
+
+BUNDLED WITH
+   2.3.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 matiassalles99
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+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.

data/README.md

@@ -0,0 +1,72 @@
+# DlocalGo
+
+Ruby client for the [dLocal Go](https://dlocalgo.com/) API.
+
+## Installation
+
+Add dlocal_go in your Gemfile
+
+    $ gem 'dlocal_go'
+    $ bundle install
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install dlocal_go
+
+## Usage
+
+1. Configure DlocalGo in a initializer
+
+```ruby
+  DlocalGo.setup do |config|
+    config.api_key = 'your_api_key'
+    config.api_secret = 'your_api_secret'
+    config.environment = 'sandbox' # or 'production'
+    config.supported_countries = %w[AR BR CL CO MX PE UY] # Optional, default:  %w[UY AR CL BO BR CO CR EC GT ID MX MY PE PY]
+  end
+```
+
+
+2. Use the client to create a payment, get a payment, or create a refund.
+
+- Create Payment
+
+```ruby
+  params = {
+    country_code: "UY",
+    currency: "USD", # Optional, if not supplied, it uses the default currency for the country
+    amount: 100,
+    success_url: "https://success.url", # Where the user will be redirected after the payment is approved
+    back_url: "https://back.url", # Where the user is redirected if they go back from the checkout page
+    notification_url: "https://notification.url" # Optional, where the notification will be sent when payment state changes, (It will send a POST request with a payment_id param in the body, which can be used to retrieve the payment)
+  }
+  response = DlocalGo::Client.create_payment(params)
+  # If request is not successful, it will raise a DlocalGo::Error, otherwise the response will be a DlocalGo::Response::Payment object
+```
+
+- Get Payment
+
+```ruby
+  response = DlocalGo::Client.get_payment("payment_id")
+  # If request is not successful, it will raise a DlocalGo::Error, otherwise the response will be a DlocalGo::Response::Payment object
+```
+
+- Create Refund
+
+```ruby
+  params = {
+    payment_id: "payment_id_sample",
+    amount: 100,
+    reason: "reason_sample"
+  }
+  response = DlocalGo::Client.create_refund(params)
+  # If request is not successful, it will raise a DlocalGo::Error, otherwise the response will be a DlocalGo::Response::Refund object
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/MetaLabs-inc/dlocal_go.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/dlocal_go.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/dlocal_go/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "dlocal_go"
+  spec.version = DlocalGo::VERSION
+  spec.authors = ["matiassalles99"]
+  spec.email = ["matiassalles99@gmail.com"]
+
+  spec.summary = "Dlocal Go client for ruby"
+  spec.description = "Dlocal Go client written in ruby to interact with Dlocal Go's API"
+  spec.homepage = "https://github.com/MetaLabs-inc/dlocal_go"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/MetaLabs-inc/dlocal_go"
+  spec.metadata["changelog_uri"] = "https://github.com/MetaLabs-inc/dlocal_go/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.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "http"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/dlocal_go/client.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require_relative "responses/payment"
+require_relative "responses/refund"
+
+module DlocalGo
+  # Client for Dlocal Go API
+  class Client
+    SANDBOX_URL = "https://api-sbx.dlocalgo.com"
+    PRODUCTION_URL = "https://api.dlocalgo.com"
+    DEFAULT_SUPPORTED_COUNTRIES = %w[UY AR CL BO BR CO CR EC GT ID MX MY PE PY].freeze
+    CURRENCY_FOR_COUNTRY = { UY: "UYU", AR: "ARS", CL: "CLP", BO: "BOB", BR: "BRL",
+                             CO: "COP", CR: "CRC", EC: "USD", GT: "GTQ", ID: "IDR", MX: "MXN",
+                             MY: "MYR", PE: "PEN", PY: "PYG" }.freeze
+
+    def initialize
+      @api_key = DlocalGo.api_key
+      @api_secret = DlocalGo.api_secret
+      @base_url = DlocalGo.environment == "production" ? PRODUCTION_URL : SANDBOX_URL
+
+      raise DlocalGo::Error, "Dlocal Go api key is not set" if @api_key.nil?
+      raise DlocalGo::Error, "Dlocal Go api secret is not set" if @api_secret.nil?
+    end
+
+    def create_payment(params = {})
+      raise DlocalGo::Error, "Unsupported country" unless supported_countries.include?(params[:country_code])
+
+      uri = "/v1/payments"
+      body = { amount: params[:amount], country: params[:country_code], notification_url: params[:notification_url],
+               currency: params[:currency] || CURRENCY_FOR_COUNTRY[params[:country_code].to_sym],
+               success_url: params[:success_url], back_url: params[:back_url] }
+
+      response = HTTP.auth(auth_header).headers(json_content_type).post(endpoint_url(uri), json: body)
+
+      raise DlocalGo::Error, "Error creating checkout #{response.parse}" unless response.status.success?
+
+      DlocalGo::Responses::Payment.new(OpenStruct.new(response.parse))
+    end
+
+    def get_payment(payment_id)
+      uri = "/v1/payments/#{payment_id}"
+      response = HTTP.auth(auth_header).get(endpoint_url(uri))
+
+      raise DlocalGo::Error, "Error getting payment: #{response.parse}" unless response.status.success?
+
+      DlocalGo::Responses::Payment.new(OpenStruct.new(response.parse))
+    end
+
+    def create_refund(params = {})
+      uri = "/v1/refunds"
+      body = { payment_id: params[:payment_id], currency: params[:currency], amount: params[:amount],
+               notification_url: params[:notification_url] }
+
+      response = HTTP.auth(auth_header).headers(json_content_type).post(endpoint_url(uri), json: body)
+
+      raise DlocalGo::Error, "Error creating refund: #{response.parse}" unless response.status.success?
+
+      DlocalGo::Responses::Refund.new(OpenStruct.new(response.parse))
+    end
+
+    private
+
+    def auth_header
+      "Bearer #{@api_key}:#{@api_secret}"
+    end
+
+    def json_content_type
+      { 'content-type': "application/json" }
+    end
+
+    def endpoint_url(endpoint_url)
+      "#{@base_url}#{endpoint_url}"
+    end
+
+    def supported_countries
+      DlocalGo.supported_countries || DEFAULT_SUPPORTED_COUNTRIES
+    end
+  end
+end

data/lib/dlocal_go/errors.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DlocalGo
+  class Error < StandardError; end
+end

data/lib/dlocal_go/responses/payment.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DlocalGo
+  module Responses
+    # Class that represents Dlocal Go payment schema
+    class Payment
+      RESPONSE_ATTRIBUTES = %i[id amount currency country created_date status order_id success_url back_url
+                               redirect_url merchant_checkout_token direct].freeze
+
+      attr_reader(*RESPONSE_ATTRIBUTES)
+
+      def initialize(response)
+        RESPONSE_ATTRIBUTES.each do |attribute|
+          instance_variable_set("@#{attribute}", response.send(attribute))
+        end
+      end
+    end
+  end
+end

data/lib/dlocal_go/responses/refund.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module DlocalGo
+  module Responses
+    # Class that represents Dlocal Go refund schema
+    class Refund
+      RESPONSE_ATTRIBUTES = %i[id amount status].freeze
+
+      attr_reader(*RESPONSE_ATTRIBUTES)
+
+      def initialize(response)
+        RESPONSE_ATTRIBUTES.each do |attribute|
+          instance_variable_set("@#{attribute}", response.send(attribute))
+        end
+      end
+    end
+  end
+end

data/lib/dlocal_go/version.rb

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

data/lib/dlocal_go.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "dlocal_go/version"
+require_relative "dlocal_go/errors"
+require_relative "dlocal_go/client"
+
+# Main module for Dlocal Go, it provides a way to configure the gem and imports the client
+module DlocalGo
+  def self.setup
+    yield self
+  end
+
+  def self.clear_setup
+    self.api_key = nil
+    self.api_secret = nil
+    self.environment = nil
+    self.supported_countries = nil
+  end
+
+  class << self
+    attr_accessor :api_key, :api_secret, :environment, :supported_countries
+  end
+
+  self.api_key = nil
+  self.api_secret = nil
+  self.environment = nil
+  self.supported_countries = nil
+end

data/sig/dlocal_go/client.rbs

@@ -0,0 +1,26 @@
+module DlocalGo
+  class Client
+    CURRENCY_FOR_COUNTRY: Hash[Symbol, String]
+    DEFAULT_SUPPORTED_COUNTRIES: Array[String]
+    SANDBOX_URL: String
+    PRODUCTION_URL: String
+
+    @api_key: String
+    @api_secret: String
+    @base_url: String
+
+    def create_payment: -> Responses::Payment
+    def get_payment: -> Responses::Payment
+    def create_refund: -> Responses::Refund
+
+    private
+
+    def auth_header: -> untyped
+
+    def endpoint_url: -> untyped
+
+    def json_content_type: -> untyped
+
+    def supported_countries: -> untyped
+  end
+end

data/sig/dlocal_go/responses/payment.rbs

@@ -0,0 +1,7 @@
+module DlocalGo
+  module Responses
+    class Payment
+      RESPONSE_ATTRIBUTES: Array[Symbol]
+    end
+  end
+end

data/sig/dlocal_go/responses/refund.rbs

@@ -0,0 +1,7 @@
+module DlocalGo
+  module Responses
+    class Refund
+      RESPONSE_ATTRIBUTES: Array[Symbol]
+    end
+  end
+end

data/sig/dlocal_go.rbs

@@ -0,0 +1,4 @@
+module DlocalGo
+  VERSION: String
+  def self.setup: -> untyped
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: dlocal_go
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- matiassalles99
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  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: Dlocal Go client written in ruby to interact with Dlocal Go's API
+email:
+- matiassalles99@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- dlocal_go.gemspec
+- lib/dlocal_go.rb
+- lib/dlocal_go/client.rb
+- lib/dlocal_go/errors.rb
+- lib/dlocal_go/responses/payment.rb
+- lib/dlocal_go/responses/refund.rb
+- lib/dlocal_go/version.rb
+- sig/dlocal_go.rbs
+- sig/dlocal_go/client.rbs
+- sig/dlocal_go/responses/payment.rbs
+- sig/dlocal_go/responses/refund.rbs
+homepage: https://github.com/MetaLabs-inc/dlocal_go
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/MetaLabs-inc/dlocal_go
+  source_code_uri: https://github.com/MetaLabs-inc/dlocal_go
+  changelog_uri: https://github.com/MetaLabs-inc/dlocal_go/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.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Dlocal Go client for ruby
+test_files: []