zspay 0.1.8 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d8da6e23747908a859867732e595bbb26e19ae091ca291f0eec8714d52d4527
-  data.tar.gz: c370d49816a0d1301fea761877d8cc48aeb2c3e585dc66e994d739ea21a75f7b
+  metadata.gz: 180b5f125d68bd72b22362b92793b1870f926ab450a00232d98bf488e18910f0
+  data.tar.gz: 335056151d11456d19ead9d8930496b1fdbb1e8def541b2fb9635bc438e19f35
 SHA512:
-  metadata.gz: 0e363d8a7dcc419690081c1bede2ba55c76962eeabb080dddd10a68b1be235851a330cccfb2b1dd1fe79e0fafb52ec8f24e2439ed29ac33c3a421479e28c9cc5
-  data.tar.gz: ee85f60714b2518dc37b51c1aa5526c608f3c5b35490f46345cbc960b00e90d33f38ed514e371199af1fcaf1ac3354267f220cab29fbafb3d1bdb4d8bfb6b493
+  metadata.gz: f4a81a5e4670548d4473f2ed29fed0cdaa3a019d44d2444a0aa2821d90166f09e53f7b71a40b3aa20d6e5781e3676b7d439e23ceb0ce9b05986c665c25027b91
+  data.tar.gz: bc21ef4823d88e0401cee6f9dbe914ccc4d01315e89e0cc4bb166e563b6e00baceea8a87ba91b5f01d6749b529c88993447323c88e8160a0695437c4d2135621

data/.rubocop.yml

@@ -0,0 +1,26 @@
+require:
+  - rubocop-rake
+  - rubocop-minitest
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Naming/FileName:
+  Exclude:
+    - Rakefile.rb
+
+# TODO: replace OpenStruct in version 2
+Style/OpenStructUse:
+  Enabled: false

data/.yardopts

@@ -0,0 +1 @@
+--private

data/README.md

@@ -0,0 +1,106 @@
+# Zspay Ruby Gem
+The Zspay Ruby Gem provides an easy-to-use interface for integrating Zspay's payment processing features into Ruby applications. This includes handling clients, bank accounts, sales, transfers, and more.
+
+## Installation
+Add this line to your application's Gemfile:
+```rb
+gem 'zspay'
+```
+
+And then execute:
+```shell
+bundle install
+```
+
+Or install it yourself as:
+```shell
+gem install zspay
+```
+
+## Configuration
+
+Before using the Zspay gem, you must configure it with your Zspay API credentials. This is typically done in an initializer in your Ruby application, such as config/initializers/zspay.rb.
+```rb
+Zspay.configure do |config|
+  config.token = ENV.fetch('YOUR_TOKEN')
+end
+```
+
+## Usage
+
+Here's how to use the Zspay gem to interact with different resources:
+
+### Clients
+```rb
+# Create a new client
+client = Zspay::Client.create({
+  name: 'John Doe',
+  email: 'john@example.com',
+  document: '12345678900'
+})
+
+# Create a new card for a client
+card = Zspay::Client.create_card(client_id, {
+  number: '4111111111111111',
+  expiry_month: '12',
+  expiry_year: '2030',
+  cvv: '123'
+})
+```
+
+### Bank Accounts
+
+```rb
+# List bank accounts
+accounts = Zspay::BankAccount.index
+
+# Create a new bank account
+account = Zspay::BankAccount.create({
+  bank_code: '001',
+  agency: '0001',
+  account: '123456',
+  account_digit: '7'
+})
+
+# Activate a bank account
+Zspay::BankAccount.active(account_id)
+```
+
+### Sales
+```rb
+# Create a new sale
+sale = Zspay::Sale.create({
+  amount: 100,
+  currency: 'BRL'
+})
+
+# Retrieve details of a sale
+sale_details = Zspay::Sale.show(sale_id)
+
+# Refund a sale
+refund = Zspay::Sale.refund(sale_id)
+```
+
+### Transfers
+```rb
+# Create a new transfer
+transfer = Zspay::Transfer.create({
+  amount: 100,
+  recipient_id: 'recipient_id'
+})
+
+# Schedule a transfer
+scheduled_transfer = Zspay::Transfer.schedule_transfer(transfer_id)
+
+# Remove a scheduled transfer
+Zspay::Transfer.remove(transfer_id)
+```
+
+## 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.
+
+## Contributing
+Bug reports and pull requests are welcome. This project is intended to be a safe, welcoming space for collaboration.
+
+## License
+The gem is available as open source under the terms of the MIT License.

data/Rakefile.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+require "rubocop/rake_task"
+
+Minitest::TestTask.create
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/zspay/configuration.rb

@@ -1,13 +1,18 @@
 # frozen_string_literal: true
 
 module Zspay
+  # The Configuration class is used to manage configuration settings for the Zspay library.
+  # It provides class-level accessors and methods to set and retrieve the configuration settings.
   class Configuration
-    class << self
-      attr_accessor :token
+    # @!attribute [rw] token
+    #   @return [String] the API token used for authenticating requests to the Zspay service.
+    attr_accessor :token
 
-      def endpoint
-        'https://api.zsystems.com.br'
-      end
+    # Returns the default API endpoint for the Zspay service.
+    #
+    # @return [String] the base URL of the Zspay API endpoint.
+    def endpoint
+      ENV.fetch("Z_SYSTEMS_API", "https://api.zsystems.com.br")
     end
   end
 end

data/lib/zspay/resource.rb

@@ -1,46 +1,105 @@
 # frozen_string_literal: true
 
 module Zspay
+  # The Resource class provides methods to perform HTTP requests to the Zspay API.
+  # This class is designed to be a base class from which other resource-specific classes can inherit.
   class Resource
     class << self
-      def post(path, payload = {}, custom_token = nil, body: 'json')
+      # Performs a POST request to the specified API path.
+      #
+      # @param path [String] the API path to send the request to.
+      # @param payload [Hash] the request payload, defaults to an empty hash.
+      # @param custom_token [String, nil] an optional custom token to use for the request.
+      # @param body [String] the format of the request body, defaults to 'json'.
+      # @return [OpenStruct] the parsed response.
+      def post(path, payload = {}, custom_token = nil, body: "json")
         req(:post, path, payload, custom_token, body: body)
       end
 
+      # Performs a PATCH request to the specified API path.
+      #
+      # @param path [String] the API path to send the request to.
+      # @param payload [Hash] the request payload.
+      # @param custom_token [String, nil] an optional custom token to use for the request.
+      # @return [OpenStruct] the parsed response.
       def patch(path, payload, custom_token = nil)
         req(:patch, path, payload, custom_token)
       end
 
+      # Performs a GET request to the specified API path.
+      #
+      # @param path [String] the API path to send the request to.
+      # @param custom_token [String, nil] an optional custom token to use for the request.
+      # @return [OpenStruct] the parsed response.
       def get(path, custom_token = nil)
         req(:get, path, {}, custom_token)
       end
 
+      # Performs a DELETE request to the specified API path.
+      #
+      # @param path [String] the API path to send the request to.
+      # @param custom_token [String, nil] an optional custom token to use for the request.
+      # @return [OpenStruct] the parsed response.
       def delete(path, custom_token = nil)
         req(:delete, path, {}, custom_token)
       end
 
+      # Performs a PUT request to the specified API path.
+      #
+      # @param path [String] the API path to send the request to.
+      # @param payload [Hash] the request payload, defaults to an empty hash.
+      # @param custom_token [String, nil] an optional custom token to use for the request.
+      # @return [OpenStruct] the parsed response.
       def put(path, payload = {}, custom_token = nil)
         req(:put, path, payload, custom_token)
       end
 
       private
 
-      def req(method, path, payload = {}, custom_token = nil, body: 'json')
+      # A private method to perform an HTTP request using the specified method, path, and payload.
+      #
+      # @param method [Symbol] the HTTP method to use for the request.
+      # @param path [String] the API path to send the request to.
+      # @param payload [Hash] the request payload, defaults to an empty hash.
+      # @param custom_token [String, nil] an optional custom token to use for the request.
+      # @param body [String] the format of the request body, defaults to 'json'.
+      # @return [OpenStruct] the parsed response.
+      def req(method, path, payload = {}, custom_token = nil, body: "json")
         send("req_#{body}", method, path, payload, custom_token)
       end
 
+      # A private method to send a request with JSON body format.
+      #
+      # @param method [Symbol] the HTTP method.
+      # @param path [String] the path to send the request to.
+      # @param payload [Hash] the request payload.
+      # @param custom_token [String, nil] an optional custom token for the request.
+      # @return [OpenStruct] the parsed response.
       def req_json(method, path, payload, custom_token)
         res = HTTP.headers(headers(custom_token)).send(method, "#{endpoint}#{path}", json: payload)
 
         parse_body(res)
       end
 
+      # A private method to send a request with form body format.
+      #
+      # @param method [Symbol] the HTTP method.
+      # @param path [String] the path to send the request to.
+      # @param payload [Hash] the request payload.
+      # @param custom_token [String, nil] an optional custom token for the request.
+      # @return [OpenStruct] the parsed response.
       def req_form(method, path, payload, custom_token)
         payload = HTTP::FormData::Multipart.new(payload)
         res = HTTP.headers(headers(custom_token)).send(method, "#{endpoint}#{path}", form: payload)
         parse_body(res)
       end
 
+      # Parses the response body and returns it as an OpenStruct.
+      # If the request was successful, returns the JSON parsed body.
+      # Otherwise, logs the error and returns an error message.
+      #
+      # @param response [HTTP::Response] the HTTP response to parse.
+      # @return [OpenStruct] the parsed response.
       def parse_body(response)
         if success_request?(response)
           body = response.body.to_s
@@ -50,34 +109,47 @@ module Zspay
 
           OpenStruct.new({ success: false, error: body })
         else
-          error_log = Logger.new(STDERR)
-          error_log.error("Error while making Zspay request" \
-                            " to: #{response.uri}" \
-                            " body: #{response.body}" \
-                            " status: #{response.code}")
+          error_log = Logger.new($stderr)
+          error_log.error("Request error to: #{response.uri}\ncode: #{response.code}\nbody: #{response.body}")
 
-          OpenStruct.new({ success: false, message: 'An error occurred while making the request' })
+          OpenStruct.new({ success: false, message: "An error occurred while making the request" })
         end
       end
 
+      # Returns the base endpoint URL from the configuration.
+      #
+      # @return [String] the API endpoint URL.
       def endpoint
-        Zspay::Configuration.endpoint
+        Zspay.configuration.endpoint
       end
 
+      # Constructs the headers for the request.
+      # If a custom token is provided, it is used; otherwise, the default token from configuration is used.
+      #
+      # @param custom_token [String, nil] an optional custom token for the request.
+      # @return [Hash] the request headers.
       def headers(custom_token = nil)
-        token = custom_token ? "Bearer #{custom_token}" : "Bearer #{Zspay::Configuration.token}"
+        token = "Bearer #{custom_token || Zspay.configuration.token}"
         {
-          'Authorization': token
+          Authorization: token
         }
       end
 
+      # Determines whether the response was successful based on the status code.
+      #
+      # @param response [HTTP::Response] the response to check.
+      # @return [Boolean] true if the response was successful, false otherwise.
       def success_request?(response)
         response.code.to_s =~ /2../ && response
       end
 
+      # Parses a JSON string into an OpenStruct. If parsing fails, returns the original JSON string.
+      #
+      # @param json [String] the JSON string to parse.
+      # @return [OpenStruct, String] the parsed JSON or the original string if parsing failed.
       def parse_json(json)
         JSON.parse(json, object_class: OpenStruct)
-      rescue JSON::ParserError => e
+      rescue JSON::ParserError => _e
         json
       end
     end

data/lib/zspay/resources/bank_account.rb

@@ -1,20 +1,38 @@
 # frozen_string_literal: true
 
 module Zspay
+  # The BankAccount class provides methods to manage bank accounts within the Zspay platform.
+  # This class extends the Zspay::Resource class, utilizing its HTTP request methods.
   class BankAccount < Zspay::Resource
     class << self
+      # Retrieves a list of all bank accounts associated with the current establishment.
+      #
+      # @return [OpenStruct] A list of bank accounts if the request is successful.
       def index
-        get('/estabelecimentos/contas_bancarias')
+        get("/estabelecimentos/contas_bancarias")
       end
 
+      # Creates a new bank account for the current establishment.
+      #
+      # @param account [Hash] The bank account details required for creation.
+      # @return [OpenStruct] The created bank account details if the request is successful.
       def create(account)
-        post('/estabelecimentos/contas_bancarias', account)
+        post("/estabelecimentos/contas_bancarias", account)
       end
 
+      # Activates a specific bank account for the current establishment.
+      #
+      # @param account_id [String] The unique identifier of the bank account to be activated.
+      # @return [OpenStruct] The status of the bank account after attempting activation.
       def active(account_id)
         post("/estabelecimentos/contas_bancarias/#{account_id}/ativar")
       end
 
+      # Deletes a specific bank account from the establishment.
+      #
+      # @param establishment_id [String] The unique identifier of the establishment.
+      # @param account_id [String] The unique identifier of the bank account to be deleted.
+      # @return [OpenStruct] The status message indicating the result of the deletion request.
       def destroy(establishment_id, account_id)
         delete("/estabelecimentos/#{establishment_id}/contas_bancarias/#{account_id}/excluir")
       end

data/lib/zspay/resources/client.rb

@@ -1,12 +1,29 @@
 # frozen_string_literal: true
 
 module Zspay
+  # The Client class is responsible for handling client-related actions within the Zspay platform.
+  # It allows for creating clients and their associated cards by extending the Zspay::Resource class.
   class Client < Zspay::Resource
     class << self
+      # Creates a new client on the Zspay platform.
+      #
+      # This method sends a POST request to the Zspay API to create a new client record.
+      # The client's information should be provided in the form of a hash.
+      #
+      # @param client [Hash] A hash containing the client's information, such as name, email, etc.
+      # @return [OpenStruct] A structure containing the newly created client's details if successful.
       def create(client)
-        post('/clientes', client)
+        post("/clientes", client)
       end
 
+      # Adds a new card for an existing client on the Zspay platform.
+      #
+      # This method sends a POST request to add a new card to the specified client's account.
+      # The card information, including number, expiry date, and CVV, should be provided in the form of a hash.
+      #
+      # @param client_id [String] The unique identifier of the client to whom the card will be added.
+      # @param card [Hash] A hash containing the card's information, such as number, expiry date, and CVV.
+      # @return [OpenStruct] A structure containing the newly added card's details if successful.
       def create_card(client_id, card)
         post("/clientes/#{client_id}/cartoes", card)
       end

data/lib/zspay/resources/establishment.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Zspay
+  # The Establishment class manages establishment-related actions within the Zspay platform.
+  # It allows for listing, creating, enabling, disabling establishment, and more, extending the functionality
+  # from Zspay::Resource.
+  class Establishment < Zspay::Resource
+    class << self
+      # Retrieves a list of child establishments associated with the current establishment.
+      #
+      # @return [OpenStruct] A structure containing the list of child establishments if the request is successful.
+      def index
+        get("/estabelecimentos/filhos")
+      end
+
+      # Creates a new establishment on the Zspay platform.
+      #
+      # @param establishment [Hash] A hash containing the establishment's information.
+      # @return [OpenStruct] A structure containing the newly created establishment's details if the request
+      # is successful.
+      def create(establishment)
+        post("/estabelecimentos", establishment, body: "form")
+      end
+
+      # Activates an existing establishment on the Zspay platform.
+      #
+      # @param establishment_id [String] The unique identifier of the establishment to be activated.
+      # @return [OpenStruct] A structure indicating the activation status of the establishment if the request
+      # is successful.
+      def active(establishment_id)
+        post("/estabelecimentos/#{establishment_id}/habilitar")
+      end
+
+      # Disables an existing establishment on the Zspay platform.
+      #
+      # @param establishment_id [String] The unique identifier of the establishment to be disabled.
+      # @return [OpenStruct] A structure indicating the disabled status of the establishment if the request
+      # is successful.
+      def disable(establishment_id)
+        delete("/estabelecimentos/#{establishment_id}")
+      end
+
+      # Retrieves the token associated with a specific establishment.
+      #
+      # This token is typically used for authentication in subsequent API requests.
+      #
+      # @param establishment_id [String] The unique identifier of the establishment for which to retrieve the token.
+      # @return [OpenStruct] A structure containing the establishment's token if the request is successful.
+      def token(establishment_id)
+        get("/estabelecimentos/#{establishment_id}/token")
+      end
+
+      # Retrieves the balance of a specific establishment.
+      #
+      # @param establishment_id [String] The unique identifier of the establishment for which to retrieve the balance.
+      # @return [OpenStruct] A structure containing the establishment's balance details if the request is successful.
+      def balance(establishment_id)
+        get("/estabelecimentos/#{establishment_id}/saldo")
+      end
+
+      # Searches for an establishment based on its document number.
+      #
+      # @param document [String] The document number of the establishment to search for.
+      # @return [OpenStruct] A structure containing the establishment's details if found, otherwise an error message.
+      def search_by_document(document)
+        get("/estabelecimentos/por_documento/#{document}")
+      end
+    end
+  end
+end

data/lib/zspay/resources/sale.rb

@@ -1,18 +1,38 @@
 # frozen_string_literal: true
 
 module Zspay
+  # The Sale class manages sale-related actions within the Zspay platform.
+  # It provides methods to create a sale, retrieve sale details, and refund a sale,
+  # extending the functionality from Zspay::Resource.
   class Sale < Zspay::Resource
     class << self
+      # Creates a new sale on the Zspay platform.
+      #
+      # @param sale [Hash] A hash containing the sale information.
+      # @param custom_token [String, nil] An optional custom token to use for the request.
+      # @return [OpenStruct] A structure containing the newly created sale's details if the request is successful.
       def create(sale, custom_token = nil)
-        post('/vendas', sale, custom_token)
+        post("/vendas", sale, custom_token)
       end
 
+      # Retrieves details of a specific sale.
+      #
+      # @param sale_id [String] The unique identifier of the sale to retrieve.
+      # @param custom_token [String, nil] An optional custom token to use for the request.
+      # @return [OpenStruct] A structure containing the sale's details if the request is successful.
       def show(sale_id, custom_token = nil)
         get("/vendas/#{sale_id}", custom_token)
       end
 
+      # Processes a refund for a specific sale.
+      #
+      # This method sends a request to refund a previously made sale. The sale is identified by its unique ID.
+      #
+      # @param sale_id [String] The unique identifier of the sale to refund.
+      # @param custom_token [String, nil] An optional custom token to use for the request.
+      # @return [OpenStruct] A structure indicating the result of the refund operation if the request is successful.
       def refund(sale_id, custom_token = nil)
-        post("/vendas/#{sale_id}/estornar", payload = {}, custom_token)
+        post("/vendas/#{sale_id}/estornar", {}, custom_token)
       end
     end
   end

data/lib/zspay/resources/transfer.rb

@@ -1,16 +1,39 @@
 # frozen_string_literal: true
 
 module Zspay
+  # The Transfer class manages transfer-related actions within the Zspay platform.
+  # It provides methods to create, schedule, and remove transfers, extending from Zspay::Resource.
   class Transfer < Zspay::Resource
     class << self
+      # Creates a new transfer on the Zspay platform.
+      #
+      # This method sends a POST request to create a new transfer with the provided details.
+      #
+      # @param transfer [Hash] A hash containing the transfer details.
+      # @param custom_token [String, nil] An optional custom token to use for the request.
+      # @return [OpenStruct] A structure containing the newly created transfer's details if the request is successful.
       def create(transfer, custom_token = nil)
-        post('/transferencias', transfer, custom_token)
+        post("/transferencias", transfer, custom_token)
       end
 
+      # Retrieves the details of a scheduled transfer.
+      #
+      # This method sends a GET request to obtain details about a transfer that has been scheduled.
+      #
+      # @param transfer_id [String] The unique identifier of the scheduled transfer.
+      # @param custom_token [String, nil] An optional custom token to use for the request.
+      # @return [OpenStruct] A structure containing the scheduled transfer's details if the request is successful.
       def schedule_transfer(transfer_id, custom_token = nil)
         get("/transferencias/agendadas/#{transfer_id}", custom_token)
       end
 
+      # Cancels a scheduled transfer.
+      #
+      # This method sends a DELETE request to remove a previously scheduled transfer from the system.
+      #
+      # @param transfer_id [String] The unique identifier of the transfer to be removed.
+      # @param custom_token [String, nil] An optional custom token to use for the request.
+      # @return [OpenStruct] A structure indicating the result of the cancellation if the request is successful.
       def remove(transfer_id, custom_token = nil)
         delete("/transferencias/agendadas/#{transfer_id}", custom_token)
       end

data/lib/zspay/resources.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'zspay/resources/bank_account'
-require 'zspay/resources/client'
-require 'zspay/resources/establishments'
-require 'zspay/resources/sale'
-require 'zspay/resources/transfer'
+require "zspay/resources/bank_account"
+require "zspay/resources/client"
+require "zspay/resources/establishment"
+require "zspay/resources/sale"
+require "zspay/resources/transfer"

data/lib/zspay/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Zspay
-  VERSION = '0.1.8'
+  VERSION = "1.0.1"
 end

data/lib/zspay.rb

@@ -1,21 +1,42 @@
 # frozen_string_literal: true
 
-require 'http'
-require 'byebug'
-require 'logger'
-require 'active_support/hash_with_indifferent_access'
+require "http"
+require "logger"
+require "active_support/hash_with_indifferent_access"
 
-require 'zspay/configuration'
+require "zspay/version"
 
-require 'zspay/resource'
-require 'zspay/resources'
+require "zspay/configuration"
 
+require "zspay/resource"
+require "zspay/resources"
+
+# The Zspay module is the main namespace for the Zspay gem.
+# It provides methods to configure and access the gem's settings.
+#
+# Examples:
+#   Zspay.configure do |config|
+#     config.token = 'your_api_token'
+#   end
 module Zspay
   class << self
+    # Returns the configuration object for Zspay. If the configuration
+    # has not yet been initialized, it will create a new instance of
+    # Configuration.
+    #
+    # @return [Zspay::Configuration] the current Zspay configuration
     def configuration
       @configuration ||= Configuration.new
     end
 
+    # Yields the current Zspay configuration to a block.
+    # This method is typically used to set up the gem's settings.
+    #
+    # @yieldparam config [Zspay::Configuration] the current Zspay configuration
+    # @example
+    #   Zspay.configure do |config|
+    #     config.token = 'your_api_token'
+    #   end
     def configure
       yield(configuration)
     end

metadata

@@ -1,60 +1,47 @@
 --- !ruby/object:Gem::Specification
 name: zspay
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 1.0.1
 platform: ruby
 authors:
 - Pedro Augusto Silva
 - Edson Lima
 - Nullbug
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2022-06-28 00:00:00.000000000 Z
+date: 2024-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: http
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 5.2.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description: ZSPAY
+        version: 5.2.0
+description: A Ruby interface for integrating and managing payment and transfer functionalities
+  with the Zspay platform.
 email:
 - pedro@nullbug.dev
 - edson@nullbug.dev
@@ -62,37 +49,42 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rubocop.yml"
+- ".yardopts"
+- README.md
+- Rakefile.rb
 - lib/zspay.rb
 - lib/zspay/configuration.rb
 - lib/zspay/resource.rb
 - lib/zspay/resources.rb
 - lib/zspay/resources/bank_account.rb
 - lib/zspay/resources/client.rb
-- lib/zspay/resources/establishments.rb
+- lib/zspay/resources/establishment.rb
 - lib/zspay/resources/sale.rb
 - lib/zspay/resources/transfer.rb
 - lib/zspay/version.rb
-homepage: ''
+homepage: https://github.com/pedroaugustofsilva/zspay-ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.6
 signing_key: 
 specification_version: 4
-summary: ZSPAY
+summary: Ruby interface for Zspay API.
 test_files: []

data/lib/zspay/resources/establishments.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module Zspay
-  class Establishments < Zspay::Resource
-    class << self
-      def index
-        get('/estabelecimentos/filhos')
-      end
-
-      def create(establishment)
-        post('/estabelecimentos', establishment, body: 'form')
-      end
-
-      def active(establishment_id)
-        post("/estabelecimentos/#{establishment_id}/habilitar")
-      end
-
-      def disable(establishment_id)
-        delete("/estabelecimentos/#{establishment_id}")
-      end
-
-      def token(establishment_id)
-        get("/estabelecimentos/#{establishment_id}/token")
-      end
-
-      def balance(establishment_id)
-        get("/estabelecimentos/#{establishment_id}/saldo")
-      end
-
-      def search_by_document(document)
-        get("/estabelecimentos/por_documento/#{document}")
-      end
-    end
-  end
-end