abacatepay-ruby 0.1.0

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module AbacatePay
+  module Enums
+    module Billing
+      # Enumeration defining billing methods.
+      #
+      # This enumeration is used to represent different payment methods available for billing.
+      class Methods
+        # PIX payment method.
+        # @return [String] Represents the PIX payment method, a popular instant payment system in Brazil
+        PIX = "PIX"
+
+        # Gets all valid method values
+        # @return [Array<String>] List of all valid payment methods
+        def self.values
+          [PIX]
+        end
+
+        # Validates if a given value is a valid method
+        # @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 payment method: #{value}" unless valid?(value)
+          value
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module AbacatePay
+  module Enums
+    module Billing
+      # Enumeration defining billing statuses.
+      #
+      # This enumeration is used to represent the various statuses that a billing process can have.
+      class Statuses
+        # Indicates that the billing is pending and has not yet been processed.
+        # @return [String]
+        PENDING = "PENDING"
+
+        # Indicates that the billing has expired and is no longer valid.
+        # @return [String]
+        EXPIRED = "EXPIRED"
+
+        # Indicates that the billing has been cancelled and will not be processed.
+        # @return [String]
+        CANCELLED = "CANCELLED"
+
+        # Indicates that the billing has been successfully paid.
+        # @return [String]
+        PAID = "PAID"
+
+        # Indicates that the billing has been refunded to the payer.
+        # @return [String]
+        REFUNDED = "REFUNDED"
+
+        # Gets all valid status values
+        # @return [Array<String>] List of all valid statuses
+        def self.values
+          [PENDING, EXPIRED, CANCELLED, PAID, REFUNDED]
+        end
+
+        # Validates if a given value is a valid status
+        # @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 status: #{value}" unless valid?(value)
+          value
+        end
+      end
+    end
+  end
+end

data/lib/abacatepay/enums.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "abacate_pay/enums/billing/frequencies"
+require "abacate_pay/enums/billing/methods"
+require "abacate_pay/enums/billing/statuses"
+
+module AbacatePay
+  # The Enums module contains all enumeration classes used
+  # throughout the AbacatePay SDK.
+  module Enums
+  end
+end

data/lib/abacatepay/resources/billing/metadata.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module AbacatePay
+  module Resources
+    module Billing
+      # Represents metadata for a billing resource in the AbacatePay system.
+      #
+      # This class contains additional information related to a billing resource,
+      # such as fee, return URL, and completion URL.
+      class Metadata < Resource
+        # @return [Integer, nil] Fee associated with the billing
+        attr_accessor :fee
+
+        # @return [String, nil] URL to redirect the user after payment is canceled or abandoned
+        attr_accessor :return_url
+
+        # @return [String, nil] URL to redirect the user after successful payment
+        attr_accessor :completion_url
+
+        # Creates a new Metadata instance
+        #
+        # @param data [Hash] The metadata properties
+        def initialize(data)
+          fill(data)
+        end
+
+        protected
+
+        def to_hash
+          super
+        end
+      end
+    end
+  end
+end

data/lib/abacatepay/resources/billing/product.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module AbacatePay
+  module Resources
+    module Billing
+      # Represents a product in a billing resource in the AbacatePay system.
+      #
+      # This class contains information about a product, such as its identifier,
+      # name, description, quantity, and price.
+      class Product < Resource
+        # @return [String, nil] External identifier for the product
+        attr_accessor :external_id
+
+        # @return [String, nil] Internal identifier for the product in the system
+        attr_accessor :product_id
+
+        # @return [String, nil] Name of the product
+        attr_accessor :name
+
+        # @return [String, nil] Description of the product
+        attr_accessor :description
+
+        # @return [Integer, nil] Quantity of the product
+        attr_accessor :quantity
+
+        # @return [Integer, nil] Price of the product in smallest currency unit (e.g., cents)
+        attr_accessor :price
+
+        # Creates a new Product instance
+        #
+        # @param data [Hash] The product properties
+        def initialize(data)
+          fill(data)
+        end
+
+        protected
+
+        def to_hash
+          super
+        end
+      end
+    end
+  end
+end

data/lib/abacatepay/resources/billing.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require "abacate_pay/resources/billing/metadata"
+require "abacate_pay/resources/billing/product"
+
+module AbacatePay
+  module Resources
+    # Represents a billing resource in the AbacatePay payment system.
+    #
+    # Manages billing-related data including payment methods, products, scheduling,
+    # and customer information for recurring and one-time payments.
+    class Billing < Resource
+      # Maps property names to their corresponding resource classes
+      RESOURCE_PROPERTIES = {
+        metadata: 'AbacatePay::Resources::Billing::Metadata',
+        customer: 'AbacatePay::Resources::Customer',
+        products: 'AbacatePay::Resources::Billing::Product'
+      }.freeze
+
+      # Maps property names to their corresponding enum classes
+      ENUM_PROPERTIES = {
+        status: 'AbacatePay::Enums::Billing::Statuses',
+        frequency: 'AbacatePay::Enums::Billing::Frequencies',
+        methods: 'AbacatePay::Enums::Billing::Methods'
+      }.freeze
+
+      # Properties that should be handled as DateTime objects
+      DATETIME_PROPERTIES = %w[
+        next_billing
+        created_at
+        updated_at
+      ].freeze
+
+      # Basic attributes
+      attr_reader :id, :account_id, :url, :dev_mode, :amount
+
+      # Complex attributes
+      attr_reader :methods, :products, :metadata, :customer
+
+      # Enum attributes
+      attr_reader :frequency, :status
+
+      # DateTime attributes
+      attr_reader :next_billing, :created_at, :updated_at
+
+      # Creates a new Billing instance
+      #
+      # @param data [Hash] The raw billing data
+      # @raise [ArgumentError] If the data is invalid
+      def initialize(data)
+        fill(data)
+      end
+
+      # Checks if billing is in development mode
+      #
+      # @return [Boolean, nil] True if in dev mode, false if not, or nil if not set
+      def dev_mode?
+        @dev_mode
+      end
+
+      private
+
+      # Process a value based on its property
+      #
+      # @param property [String] The property name
+      # @param value [Object] The value to process
+      # @return [Object] The processed value
+      def process_value(property, value)
+        return nil if value.nil?
+
+        if DATETIME_PROPERTIES.include?(property)
+          initialize_date_time(value)
+        elsif ENUM_PROPERTIES.key?(property.to_sym)
+          process_enum_value(property, value)
+        elsif RESOURCE_PROPERTIES.key?(property.to_sym)
+          process_resource_value(property, value)
+        else
+          value
+        end
+      end
+
+      # Process enum values
+      #
+      # @param property [String] The property name
+      # @param value [Object] The value to process
+      # @return [Object] The processed value
+      def process_enum_value(property, value)
+        enum_class = Object.const_get(ENUM_PROPERTIES[property.to_sym])
+        
+        if value.is_a?(Array)
+          value.map { |item| initialize_enum(enum_class, item) }
+        else
+          initialize_enum(enum_class, value)
+        end
+      end
+
+      # Process resource values
+      #
+      # @param property [String] The property name
+      # @param value [Object] The value to process
+      # @return [Object] The processed value
+      def process_resource_value(property, value)
+        resource_class = Object.const_get(RESOURCE_PROPERTIES[property.to_sym])
+        
+        if property.to_s == 'products' && value.is_a?(Array)
+          value.map { |item| initialize_resource(resource_class, item) }
+        else
+          initialize_resource(resource_class, value)
+        end
+      end
+
+      protected
+
+      # @!visibility private
+      attr_writer :id, :account_id, :url, :methods, :products,
+                 :dev_mode, :amount, :metadata, :frequency, :status,
+                 :customer, :next_billing, :created_at, :updated_at
+    end
+  end
+end

data/lib/abacatepay/resources/customer/metadata.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module AbacatePay
+  module Resources
+    module Customer
+      # Represents metadata for a customer in the AbacatePay system.
+      #
+      # This class contains additional information about a customer, such as their name,
+      # contact details, and tax identification number.
+      class Metadata < Resource
+        # @return [String, nil] Customer's name
+        attr_accessor :name
+
+        # @return [String, nil] Customer's cellphone number
+        attr_accessor :cellphone
+
+        # @return [String, nil] Customer's email address
+        attr_accessor :email
+
+        # @return [String, nil] Customer's tax identification number
+        attr_accessor :tax_id
+
+        # Creates a new Metadata instance
+        #
+        # @param data [Hash] The metadata properties
+        def initialize(data)
+          fill(data)
+        end
+
+        protected
+
+        def to_hash
+          super
+        end
+      end
+    end
+  end
+end

data/lib/abacatepay/resources/customer.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "abacate_pay/resources/customer/metadata"
+
+module AbacatePay
+  module Resources
+    # Represents a customer resource in the AbacatePay payment system.
+    #
+    # This class handles customer data including identification and metadata,
+    # providing a structured way to manage customer information within the system.
+    class Customer < Resource
+      # Maps property names to their corresponding resource classes
+      RESOURCE_PROPERTIES = {
+        metadata: 'AbacatePay::Resources::Customer::Metadata'
+      }.freeze
+
+      # @return [String, nil] The unique identifier for the customer
+      attr_reader :id
+
+      # @return [Metadata, nil] Additional customer information
+      attr_reader :metadata
+
+      # Creates a new Customer instance
+      #
+      # @param data [Hash] The raw customer data
+      # @raise [ArgumentError] If the data is invalid
+      def initialize(data)
+        fill(data)
+      end
+
+      private
+
+      # Process a value based on its property
+      #
+      # @param property [String] The property name
+      # @param value [Object] The value to process
+      # @return [Object] The processed value
+      def process_value(property, value)
+        return nil if value.nil?
+
+        if RESOURCE_PROPERTIES.key?(property.to_sym)
+          initialize_resource(
+            Object.const_get(RESOURCE_PROPERTIES[property.to_sym]),
+            value
+          )
+        else
+          value
+        end
+      end
+
+      protected
+
+      # @!visibility private
+      attr_writer :id, :metadata
+    end
+  end
+end

data/lib/abacatepay/resources/resource.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module AbacatePay
+  module Resources
+    # Base class for resources in the AbacatePay system.
+    class Resource
+      private
+
+      # Initialize a DateTime object from a string or DateTime
+      #
+      # @param value [String, DateTime] The value to initialize
+      # @return [DateTime, nil] The initialized DateTime object or nil
+      # @raise [ArgumentError] If the value is invalid
+      def initialize_date_time(value)
+        return nil if value.nil? || value.empty?
+        return value.clone if value.is_a?(DateTime)
+
+        DateTime.parse(value)
+      rescue Date::Error
+        raise ArgumentError, "Invalid datetime value: #{value}"
+      end
+
+      # Initialize an enum from a string or enum object
+      #
+      # @param enum_class [Class] The enum class to initialize
+      # @param value [String, Object] The value to initialize
+      # @return [Object, nil] The initialized enum or nil
+      # @raise [ArgumentError] If the value is invalid
+      def initialize_enum(enum_class, value)
+        return nil if value.nil? || value.empty?
+        
+        enum_class.validate!(value)
+      end
+
+      # Initialize a resource from a hash or resource object
+      #
+      # @param resource_class [Class] The resource class to initialize
+      # @param value [Hash, Object] The value to initialize
+      # @return [Object, nil] The initialized resource or nil
+      # @raise [ArgumentError] If the value is invalid
+      def initialize_resource(resource_class, value)
+        return nil if value.nil? || value.empty?
+        return value.clone if value.is_a?(resource_class)
+
+        unless value.is_a?(Hash)
+          raise ArgumentError, "Invalid resource value. Expected Hash or #{resource_class}, got #{value.class}"
+        end
+
+        resource_class.new(value)
+      end
+
+      # Fill the object with data
+      #
+      # @param data [Hash] The data to fill with
+      # @return [void]
+      def fill(data)
+        data.each do |key, value|
+          property = camel_to_snake(key)
+          next unless respond_to?("#{property}=", true)
+          
+          send("#{property}=", process_value(property, value))
+        end
+      end
+
+      # Convert camelCase to snake_case
+      #
+      # @param str [String] The string to convert
+      # @return [String] The converted string
+      def camel_to_snake(str)
+        str.to_s
+           .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+           .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+           .downcase
+      end
+
+      # Convert snake_case to camelCase
+      #
+      # @param str [String] The string to convert
+      # @return [String] The converted string
+      def snake_to_camel(str)
+        str.split('_')
+           .map.with_index { |word, i| i.zero? ? word : word.capitalize }
+           .join
+      end
+
+      protected
+
+      # Convert the resource to a hash
+      #
+      # @return [Hash] The hash representation
+      def to_hash
+        instance_variables.each_with_object({}) do |var, hash|
+          next if var.to_s.start_with?('@__')
+          
+          value = instance_variable_get(var)
+          key = snake_to_camel(var.to_s.delete('@'))
+          
+          hash[key] = case value
+                     when DateTime
+                       value.iso8601
+                     when Resource
+                       value.to_hash
+                     when Module
+                       value.respond_to?(:value) ? value.value : value
+                     when Array
+                       value.map { |v| v.respond_to?(:to_hash) ? v.to_hash : v }
+                     else
+                       value
+                     end
+        end.compact
+      end
+    end
+  end
+end

data/lib/abacatepay/resources.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "abacate_pay/resources/resource"
+require "abacate_pay/resources/billing"
+require "abacate_pay/resources/customer"
+require "abacate_pay/resources/billing/metadata"
+require "abacate_pay/resources/billing/product"
+require "abacate_pay/resources/customer/metadata"
+
+module AbacatePay
+  # The Resources module contains all resource classes that
+  # represent the various entities in the AbacatePay system.
+  module Resources
+  end
+end

data/lib/abacatepay/version.rb

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

data/sig/abacatepay/rails.rbs

@@ -0,0 +1,6 @@
+module Abacatepay
+  module Rails
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end