abacatepay-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ec476ed39de31a64c6de7517af308b971922f06a8a554de6764ea4992052b641
+  data.tar.gz: cf82e3363dfa431419b29b120fcabddb671d91e3789ec90880dd131b46a08684
+SHA512:
+  metadata.gz: 84f338ecbd8a318c44987d7417579f812b5002c66eb04929e59511b61a4de9a378df861449ce98d7d24753cf4ef8bd373886b6ce602fd53c500bcca5f5254274
+  data.tar.gz: 7e87dd6972d35d967bb1cece1e825579f96a26b0da3f624ead50734195bcf15c193674a5c0e6cbffd1e167ea28a8ee2fb63f6d78ec4151633ed4037445b0825d

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-12-11
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at mathuscardoso@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 user-matth
+
+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,166 @@
+# AbacatePay SDK for Ruby on Rails
+
+## 💻 Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'abacatepay-ruby'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install abacatepay-ruby
+```
+
+## 🔧 Configuration
+
+Configure your API token and environment in an initializer:
+
+```ruby
+# config/initializers/abacatepay.rb
+AbacatePay.configure do |config|
+  config.api_token = ENV['ABACATEPAY_TOKEN']
+  config.environment = :sandbox # or :production
+end
+```
+
+## 🌟 Resources
+
+### Billing
+
+**Initialize the Billing Client**
+
+```ruby
+billing_client = AbacatePay::Clients::BillingClient.new
+```
+
+**List Billings**
+
+Retrieve a list of all billings:
+
+```ruby
+billing_client.list
+```
+
+**Create a Billing**
+
+To create a billing, use the following code:
+
+```ruby
+billing_client.create(
+  AbacatePay::Resources::Billing.new(
+    frequency: AbacatePay::Enums::Billing::Frequencies::ONE_TIME,
+    methods: [AbacatePay::Enums::Billing::Methods::PIX],
+    products: [
+      AbacatePay::Resources::Billing::Product.new(
+        external_id: 'abc_123',
+        name: 'Product A',
+        description: 'Description of product A',
+        quantity: 1,
+        price: 100 # Price in cents
+      )
+    ],
+    metadata: AbacatePay::Resources::Billing::Metadata.new(
+      return_url: 'https://www.abacatepay.com',
+      completion_url: 'https://www.abacatepay.com'
+    ),
+    customer: AbacatePay::Resources::Customer.new(
+      metadata: AbacatePay::Resources::Customer::Metadata.new(
+        name: 'Abacate Lover',
+        cellphone: '01912341234',
+        email: 'lover@abacate.com',
+        tax_id: '13827826837'
+      )
+    )
+  )
+)
+```
+
+Alternatively, you can use a previously created customer by specifying their ID:
+
+```ruby
+AbacatePay::Resources::Customer.new(
+  id: 'cust_DEbpqcN...'
+)
+```
+
+### Customer
+
+**Initialize the Customer Client**
+
+```ruby
+customer_client = AbacatePay::Clients::CustomerClient.new
+```
+
+**List Customers**
+
+Retrieve a list of all customers:
+
+```ruby
+customer_client.list
+```
+
+**Create a Customer**
+
+To create a customer, use the following code:
+
+```ruby
+customer_client.create(
+  AbacatePay::Resources::Customer.new(
+    metadata: AbacatePay::Resources::Customer::Metadata.new(
+      name: 'Abacate Lover',
+      cellphone: '01912341234',
+      email: 'lover@abacate.com',
+      tax_id: '13827826837'
+    )
+  )
+)
+```
+
+## 📚 Documentation
+
+For detailed information about the API and SDK, refer to the official documentation:
+https://abacatepay.readme.io/reference
+
+## 🤝 Contribution
+
+Contributions are welcome! If you wish to contribute:
+
+1. Fork the repository
+2. Create a new branch for your feature or fix:
+
+```bash
+git checkout -b feature/your-feature-name
+```
+
+3. Make your changes and commit them:
+
+```bash
+git commit -m "Add your detailed commit message here"
+```
+
+4. Push to your branch:
+
+```bash
+git push origin feature/your-feature-name
+```
+
+5. Open a pull request with a clear description of your changes
+
+Please ensure your code:
+
+- Includes proper documentation
+- Follows Ruby style guidelines
+- Includes appropriate tests
+- Passes all existing tests (bundle exec rspec)
+- Passes code style checks (bundle exec rubocop)
+
+### Happy coding! 🚀

data/Rakefile

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

data/abacatepay-ruby.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative "lib/abacatepay/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "abacatepay-ruby"
+  spec.version = AbacatePay::VERSION
+  spec.authors = ["Matheus Cardoso"]
+  spec.email = ["mathuscardoso@gmail.com"]
+
+  spec.summary = "AbacatePay Ruby on Rails SDK for you to start receiving payments in seconds"
+  spec.description = "The easiest way to integrate your Ruby on Rails SDK base code to AbacatePay Gateway with support to coroutines."
+  spec.homepage = "https://www.abacatepay.com/"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "https://github.com/AbacatePay/abacatepay-ruby-sdk"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/AbacatePay/abacatepay-ruby-sdk"
+  spec.metadata["changelog_uri"] = "https://github.com/AbacatePay/abacatepay-ruby-sdk/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|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Runtime dependencies
+  spec.add_dependency "rails", "~> 7.0", ">= 7.0.0"
+  spec.add_dependency "faraday", "~> 2.9"
+
+  # Development dependencies
+  spec.add_development_dependency "rspec-rails", "~> 6.0"
+  spec.add_development_dependency "rubocop", "~> 1.57"
+  spec.add_development_dependency "rubocop-rails", "~> 2.22"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.25"
+  spec.add_development_dependency "simplecov", "~> 0.22"
+
+  # 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/abacate_pay.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "abacate_pay/version"
+require "abacate_pay/configuration"
+
+# Main module for AbacatePay SDK integration
+module AbacatePay
+  class Error < StandardError; end
+  class ConfigurationError < Error; end
+  class ApiError < Error; end
+
+  class << self
+    # Gets or sets the global configuration
+    attr_accessor :configuration
+  end
+
+  # Configures the SDK
+  #
+  # @example
+  #   AbacatePay.configure do |config|
+  #     config.api_token = "your-token-here"
+  #     config.environment = :sandbox
+  #   end
+  #
+  # @yield [config] Configuration object
+  # @return [void]
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+    configuration.validate!
+  end
+
+  # Resets the configuration to defaults
+  #
+  # @return [void]
+  def self.reset!
+    self.configuration = Configuration.new
+  end
+end
+
+# Autoload all components
+Dir[File.join(__dir__, "abacate_pay", "**", "*.rb")].sort.each { |file| require file }

data/lib/abacatepay/clients/billing_client.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module AbacatePay
+  module Clients
+    # Client class for managing billing-related operations in the AbacatePay API.
+    class BillingClient < Client
+      # API endpoint for billing-related operations
+      URI = "billing"
+
+      # @param client [Faraday::Connection, nil] Optional Faraday client for custom configurations
+      def initialize(client = nil)
+        super(URI, client)
+      end
+
+      # Retrieves a list of billings
+      #
+      # @return [Array<Resources::Billing>] Array of Billing objects
+      def list
+        response = request("GET", "list")
+        response.map { |data| Resources::Billing.new(data) }
+      end
+
+      # Creates a new billing
+      #
+      # @param data [Resources::Billing] The billing data to be sent for creation
+      # @return [Resources::Billing] The created Billing object
+      def create(data)
+        request_data = {
+          frequency: data.frequency,
+          methods: data.methods,
+          returnUrl: data.metadata&.return_url,
+          completionUrl: data.metadata&.completion_url,
+          products: data.products&.map { |product|
+            {
+              externalId: product.external_id,
+              name: product.name,
+              description: product.description,
+              quantity: product.quantity,
+              price: product.price
+            }
+          }
+        }
+
+        if data.customer&.id
+          request_data[:customerId] = data.customer.id
+        else
+          request_data[:customer] = {
+            name: data.customer&.metadata&.name,
+            email: data.customer&.metadata&.email,
+            cellphone: data.customer&.metadata&.cellphone,
+            taxId: data.customer&.metadata&.tax_id
+          }
+        end
+
+        response = request("POST", "create", json: request_data)
+        Resources::Billing.new(response)
+      end
+    end
+  end
+end

data/lib/abacatepay/clients/client.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+module AbacatePay
+  module Clients
+    # Client class for interacting with the AbacatePay API.
+    #
+    # This class handles API requests using Faraday and provides a way to manage
+    # authentication and communication with the AbacatePay service.
+    class Client
+      # @param uri [String] The specific API endpoint to interact with
+      # @param client [Faraday::Connection, nil] Optional Faraday client for custom configurations
+      def initialize(uri, client = nil)
+        @client = client || build_client(uri)
+      end
+
+      private
+
+      # Sends an HTTP request to the API
+      #
+      # @param method [String] The HTTP method (e.g., GET, POST)
+      # @param uri [String] The endpoint URI relative to the base URI
+      # @param options [Hash] Optional settings and parameters for the request
+      # @return [Hash] The response data
+      # @raise [ApiError] If an error occurs during the request
+      def request(method, uri, options = {})
+        response = @client.public_send(method.downcase) do |req|
+          req.url uri
+          req.body = options[:json].to_json if options[:json]
+        end
+
+        JSON.parse(response.body).fetch("data")
+      rescue Faraday::Error => e
+        handle_request_error(e)
+      rescue StandardError => e
+        raise ApiError, "Unexpected error: #{e.message}"
+      end
+
+      # Builds a new Faraday client with default configuration
+      #
+      # @param uri [String] The endpoint URI
+      # @return [Faraday::Connection] Configured Faraday client
+      def build_client(uri)
+        Faraday.new(
+          url: "#{AbacatePay.configuration.api_url}/#{uri}/",
+          headers: {
+            "Content-Type" => "application/json",
+            "Authorization" => "Bearer #{AbacatePay.configuration.api_token}"
+          }
+        )
+      end
+
+      # Handles API request errors
+      #
+      # @param error [Faraday::Error] The error to handle
+      # @raise [ApiError] With appropriate error message
+      def handle_request_error(error)
+        error_message = if error.response&.body
+          response_body = JSON.parse(error.response.body)
+          response_body["message"] || response_body["error"]
+        end
+
+        raise ApiError, "Request error: #{error_message || error.message}"
+      end
+    end
+  end
+end

data/lib/abacatepay/clients/customer_client.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module AbacatePay
+  module Clients
+    # Client class for managing customer-related operations in the AbacatePay API.
+    class CustomerClient < Client
+      # API endpoint for customer-related operations
+      URI = "customer"
+
+      # @param client [Faraday::Connection, nil] Optional Faraday client for custom configurations
+      def initialize(client = nil)
+        super(URI, client)
+      end
+
+      # Retrieves a list of customers
+      #
+      # @return [Array<Resources::Customer>] Array of Customer objects
+      def list
+        response = request("GET", "list")
+        response.map { |data| Resources::Customer.new(data) }
+      end
+
+      # Creates a new customer
+      #
+      # @param data [Resources::Customer] The customer data to be sent for creation
+      # @return [Resources::Customer] The created Customer object
+      def create(data)
+        response = request("POST", "create", json: {
+          name: data.metadata&.name,
+          email: data.metadata&.email,
+          cellphone: data.metadata&.cellphone,
+          taxId: data.metadata&.tax_id
+        })
+
+        Resources::Customer.new(response)
+      end
+    end
+  end
+end

data/lib/abacatepay/clients.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "abacate_pay/clients/client"
+require "abacate_pay/clients/billing_client"
+require "abacate_pay/clients/customer_client"
+
+module AbacatePay
+  # The Clients module contains all API client implementations
+  # for interacting with the AbacatePay API endpoints.
+  module Clients
+  end
+end

data/lib/abacatepay/configuration.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module AbacatePay
+  # Configuration class for the AbacatePay SDK
+  #
+  # This class handles all configuration options for the SDK, including
+  # API credentials, environment settings, and other customizable options.
+  #
+  # @api public
+  class Configuration
+    # @return [String] API token for authentication
+    attr_accessor :api_token
+
+    # @return [Symbol] Current environment (:production or :sandbox)
+    attr_accessor :environment
+
+    # @return [Integer] Request timeout in seconds
+    attr_accessor :timeout
+
+    # @return [String] Base API URL
+    attr_reader :api_url
+
+    # Initialize a new configuration with default values
+    #
+    # @api public
+    def initialize
+      @environment = :sandbox
+      @timeout = 30
+      @api_token = nil
+    end
+
+    # Validates the configuration
+    #
+    # @raise [ConfigurationError] if any required settings are missing or invalid
+    # @return [void]
+    #
+    # @api public
+    def validate!
+      raise ConfigurationError, "API token is required" if api_token.nil?
+      raise ConfigurationError, "Invalid environment" unless %i[production sandbox].include?(environment)
+    end
+
+    # Gets the base API URL based on the environment
+    #
+    # @return [String] The base API URL
+    #
+    # @api public
+    def api_url
+      if environment == :production
+        "https://api.abacatepay.com/v1"
+      else
+        "https://sandbox.api.abacatepay.com/v1"
+      end
+    end
+  end
+end

data/lib/abacatepay/enums/billing/frequencies.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module AbacatePay
+  module Enums
+    module Billing
+      # Enumeration defining billing frequencies.
+      #
+      # This enumeration is used to categorize different payment or billing frequencies.
+      class Frequencies
+        # One-time billing.
+        # @return [String] Represents a billing that occurs only once
+        ONE_TIME = "ONE_TIME"
+
+        # Gets all valid frequency values
+        # @return [Array<String>] List of all valid frequencies
+        def self.values
+          [ONE_TIME]
+        end
+
+        # Validates if a given value is a valid frequency
+        # @param value [String] The value to validate
+        # @return [Boolean] true if valid, false otherwise
+        def self.valid?(value)
+          values.include?(value)
+        end
+
+        # Validates and returns the value if valid
+        # @param value [String] The value to validate
+        # @return [String] The validated value
+        # @raise [ArgumentError] if value is invalid
+        def self.validate!(value)
+          raise ArgumentError, "Invalid frequency: #{value}" unless valid?(value)
+          value
+        end
+      end
+    end
+  end
+end