genesis_ruby 0.1.0

data/lib/genesis_ruby/utils/formatters/response/formats/timestamp.rb

@@ -0,0 +1,29 @@
+require 'genesis_ruby/utils/formatters/base'
+require 'date'
+
+module GenesisRuby
+  module Utils
+    module Formatters
+      module Response
+        module Formats
+          # Response Timestamp format
+          class Timestamp < Base
+
+            # The Response keys that the formatter will be applied to
+            def formatting_keys
+              %w(timestamp)
+            end
+
+            # Format the given timestamp to DateTime object
+            def format_key(timestamp)
+              DateTime.parse timestamp
+            rescue StandardError
+              timestamp
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/utils/formatters/response/loader.rb

@@ -0,0 +1,42 @@
+require 'genesis_ruby/utils/formatters/response/definitions'
+
+module GenesisRuby
+  module Utils
+    module Formatters
+      module Response
+        # Response Formatter initializer
+        class Loader
+
+          include Response
+
+          # Load the Available Formatters
+          def initialize
+            initialize_formatters
+          end
+
+          # Initialized Formatters array
+          def formats
+            @formats ||= []
+          end
+
+          # Add new formatter to the formatter array
+          def formats=(formatter_class)
+            @formats = formats
+
+            @formats.push formatter_class
+          end
+
+          private
+
+          # Initialize the Available Formatters
+          def initialize_formatters
+            available_formatters.each do |formatter_class|
+              self.formats = formatter_class.new
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/utils/money/base/strategy.rb

@@ -0,0 +1,38 @@
+require 'genesis_ruby/errors/invalid_argument_error'
+require 'bigdecimal'
+
+module GenesisRuby
+  module Utils
+    module Money
+      module Base
+        # Base Conversion Strategy class
+        class Strategy
+
+          attr_accessor :amount, :currency, :currency_exponent
+
+          # Class constructor
+          def initialize(amount, currency, currency_exponent)
+            @amount            = parse_amount(amount)
+            @currency          = currency
+            @currency_exponent = currency_exponent
+          end
+
+          # Convert Strategy method
+          def convert
+            raise NotImplementedError
+          end
+
+          protected
+
+          # Validate and parse amount into BigDecimal
+          def parse_amount(amount)
+            BigDecimal(amount.to_s)
+          rescue StandardError
+            raise InvalidArgumentError, 'Invalid amount value given.'
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/utils/money/conversions/amount_to_exponent.rb

@@ -0,0 +1,22 @@
+require 'genesis_ruby/utils/money/base/strategy'
+
+module GenesisRuby
+  module Utils
+    module Money
+      module Conversions
+        # Amount To Exponent Money Conversion Strategy
+        class AmountToExponent < GenesisRuby::Utils::Money::Base::Strategy
+
+          # Convert amount to ISO-4217 minor currency unit
+          def convert
+            format(
+              '%d',
+              (amount * parse_amount(10**currency_exponent))
+            )
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/utils/money/conversions/exponent_to_amount.rb

@@ -0,0 +1,22 @@
+require 'genesis_ruby/utils/money/base/strategy'
+
+module GenesisRuby
+  module Utils
+    module Money
+      module Conversions
+        # Amount To Exponent Money Conversion Strategy
+        class ExponentToAmount < GenesisRuby::Utils::Money::Base::Strategy
+
+          # Convert ISO-4217 minor currency unit to amount
+          def convert
+            format(
+              "%.#{currency_exponent}f",
+              (amount / parse_amount(10**currency_exponent)).truncate(currency_exponent)
+            )
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/utils/money/format.rb

@@ -0,0 +1,34 @@
+require 'genesis_ruby/errors/invalid_argument_error'
+
+module GenesisRuby
+  module Utils
+    module Money
+      # Money Helper
+      class Format
+
+        attr_accessor :strategy
+
+        def initialize(strategy)
+          @strategy = strategy
+        end
+
+        # Execute Convert Strategy
+        def convert
+          unless valid_amount_exponent?
+            raise GenesisRuby::InvalidArgumentError, 'Currency exponent do not match the given amount'
+          end
+
+          strategy.convert
+        end
+
+        # Validate the given amount against the defined currency exponent
+        def valid_amount_exponent?
+          amount_sign, amount_digits, amount_base, amount_exponent = strategy.amount.split # rubocop:disable Lint/UselessAssignment
+
+          !amount_sign.negative? && (amount_digits.length - amount_exponent) <= strategy.currency_exponent
+        end
+
+      end
+    end
+  end
+end

data/lib/genesis_ruby/utils/money_format.rb

@@ -0,0 +1,39 @@
+require 'genesis_ruby/api/constants/currencies/iso4217'
+require 'genesis_ruby/utils/money/conversions/amount_to_exponent'
+require 'genesis_ruby/utils/money/conversions/exponent_to_amount'
+require 'genesis_ruby/utils/money/format'
+
+module GenesisRuby
+  module Utils
+    # Money Helper
+    class MoneyFormat
+
+      class << self
+
+        # Convert major to minor currency format units
+        def amount_to_exponent(amount, currency)
+          strategy = GenesisRuby::Utils::Money::Conversions::AmountToExponent.new(
+            amount,
+            currency,
+            GenesisRuby::Api::Constants::Currencies::Iso4217.fetch_exponent(currency)
+          )
+
+          GenesisRuby::Utils::Money::Format.new(strategy).convert
+        end
+
+        # Convert minor to major currency format units
+        def exponent_to_amount(amount, currency)
+          strategy = GenesisRuby::Utils::Money::Conversions::ExponentToAmount.new(
+            amount,
+            currency,
+            GenesisRuby::Api::Constants::Currencies::Iso4217.fetch_exponent(currency)
+          )
+
+          GenesisRuby::Utils::Money::Format.new(strategy).convert
+        end
+
+      end
+
+    end
+  end
+end

data/lib/genesis_ruby/utils/object_formatter.rb

@@ -0,0 +1,67 @@
+require 'genesis_ruby/errors/object_formatter_error'
+
+module GenesisRuby
+  module Utils
+    # Object Formatter component
+    class ObjectFormatter
+
+      # Available Formatters
+      def formats
+        @formats ||= []
+      end
+
+      # Add new formatter to the formatter array
+      def formats=(formatters)
+        raise ObjectFormatterError, 'Invalid array value given for Formats.' unless formatters.is_a? Array
+
+        formats.push *formatters
+      end
+
+      # Apply all Formatter on the given object
+      def format_structure(response_object)
+        return format_hash(response_object) if response_object.is_a? Hash
+        return format_array(response_object) if response_object.is_a? Array
+
+        response_object
+      end
+
+      private
+
+      # Format Object with Hash type
+      def format_hash(response_object)
+        response_object.each do |response_key, response_value|
+          response_object[response_key] = if response_value.is_a?(Hash) || response_value.is_a?(Array)
+                                            format_structure(response_value)
+                                          else
+                                            format_value(response_object, response_key, response_value)
+                                          end
+        end
+
+        response_object
+      end
+
+      # Format Object with Array type
+      def format_array(response_object)
+        response_object.each do |response_value|
+          format_structure(response_value)
+        end
+      end
+
+      # Format Object key value
+      def format_value(response_object, response_key, response_value)
+        formats.each do |formatter|
+          next unless formatter.formatting_keys.include?(response_key.to_s)
+
+          required_values = formatter.collect_required_key_values(response_object)
+
+          return response_value if required_values.count != formatter.required_keys.count
+
+          return formatter.format_key(response_value, *required_values)
+        end
+
+        response_value
+      end
+
+    end
+  end
+end

data/lib/genesis_ruby/utils/options/api_config.rb

@@ -0,0 +1,36 @@
+require 'genesis_ruby/utils/options/base'
+
+module GenesisRuby
+  module Utils
+    module Options
+      # Configurable Options used for the API Request configuration
+      class ApiConfig < Base
+
+        # Load pre-defined XML configuration
+        def load_xml_config
+          self.protocol = GenesisRuby::Api::Request::PROTOCOL_HTTPS
+          self.port     = GenesisRuby::Api::Request::PORT_HTTPS
+          self.type     = GenesisRuby::Api::Request::METHOD_POST
+          self.format   = 'xml' # TODO: use the builder constant
+        end
+
+        # Load pre-defined JSON configuration
+        def load_json_config
+          self.protocol = GenesisRuby::Api::Request::PROTOCOL_HTTPS
+          self.port     = GenesisRuby::Api::Request::PORT_HTTPS
+          self.type     = GenesisRuby::Api::Request::METHOD_POST
+          self.format   = 'json' # TODO: use the builder constant
+        end
+
+        # Load pre-defined FORM configuration
+        def load_form_config
+          self.protocol = GenesisRuby::Api::Request::PROTOCOL_HTTPS
+          self.port     = GenesisRuby::Api::Request::PORT_HTTPS
+          self.type     = GenesisRuby::Api::Request::METHOD_POST
+          self.format   = 'form' # TODO: use the builder constant
+        end
+
+      end
+    end
+  end
+end

data/lib/genesis_ruby/utils/options/base.rb

@@ -0,0 +1,35 @@
+module GenesisRuby
+  module Utils
+    module Options
+      # Simple key value hash object
+      # Usage: ConfigurableOptions.<name>=, ConfigurableOptions.<name>
+      class Base < Hash
+
+        def []=(key, value)
+          super(key.to_sym, value)
+        end
+
+        def [](key)
+          super(key.to_sym)
+        end
+
+        # Dynamic accessors for the hash[keys]
+        def method_missing(name, *args)
+          name_string = name.to_s
+          if name_string.chomp!('=')
+            self[name_string] = args.first
+          else
+            self[name_string]
+          end
+        end
+
+        # Define ConfigurableOptions.method("<method>") call
+        # If we dont have defined hash key we will raise exception
+        def respond_to_missing?(name, include_private = false)
+          method_missing(name) || super
+        end
+
+      end
+    end
+  end
+end

data/lib/genesis_ruby/utils/options/network_adapter_config.rb

@@ -0,0 +1,41 @@
+require 'genesis_ruby/utils/options/base'
+
+module GenesisRuby
+  module Utils
+    module Options
+      # Configurable Options used for the API Request configuration
+      class NetworkAdapterConfig < Base
+
+        # Map the Adapter configuration from the Request object
+        def map_from_request(request) # rubocop:disable Metrics/AbcSize
+          self.body     = request.build_document
+          self.url      = request.api_config.url
+          self.type     = request.api_config.type
+          self.port     = request.api_config.port
+          self.protocol = request.api_config.protocol
+          self.format   = fetch_content_type(request.api_config.format)
+
+          self
+        end
+
+        protected
+
+        # Retrieve the Request data format that must be used as Content-Type header
+        def fetch_content_type(data_format)
+          # TODO: Builder Constants
+          case data_format
+          when 'xml'
+            'text/xml'
+          when 'json'
+            'application/json'
+          when 'form'
+            'application/x-www-form-urlencoded'
+          else
+            raise InvalidArgumentError, 'Invalid request format type. Allowed are XML, JSON and FORM'
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/genesis_ruby/utils/transactions/financial_types.rb

@@ -0,0 +1,50 @@
+module GenesisRuby
+  module Utils
+    module Transactions
+      # Financial Transaction Types Helper methods
+      class FinancialTypes
+
+        class << self
+
+          include GenesisRuby::Api::Constants::Transactions
+
+          # Return array containing all available Web Payment Form transaction types
+          def all # rubocop:disable Metrics/MethodLength
+            [
+              AFRICAN_MOBILE_PAYOUT, AFRICAN_MOBILE_SALE, APPLE_PAY, ARGENCARD, AURA, AUTHORIZE, AUTHORIZE_3D,
+              BALOTO, BANCOMER, BANCONTACT, BANCO_DE_OCCIDENTE, BANCO_DO_BRASIL, BITPAY_PAYOUT, BITPAY_REFUND,
+              BITPAY_SALE, BOLETO, BRADESCO,
+              CABAL, CAPTURE, CASHU, CENCOSUD, CREDIT,
+              DAVIVIENDA,
+              EFECTY, ELO, EPS,
+              EZEECARD_PAYOUT, EZEEWALLET,
+              FASHIONCHEQUE,
+              GIROPAY, GOOGLE_PAY,
+              IDEAL, IDEBIT_PAYIN, IDEBIT_PAYOUT, INCREMENTAL_AUTHORIZE, INSTA_DEBIT_PAYIN, INSTA_DEBIT_PAYOUT,
+              INTERSOLVE, ITAU,
+              MULTIBANCO, MY_BANK,
+              NARANJA, NATIVA, NEOSURF, NETELLER,
+              ONLINE_BANKING_PAYIN, ONLINE_BANKING_PAYOUT,
+              OXXO,
+              P24, PAGO_FACIL, PARTIAL_REVERSAL, PAYOUT, PAYSAFECARD, PAYU, PAY_PAL, PIX, POLI, POST_FINANCE, PPRO, PSE,
+              RAPI_PAGO, REDPAGOS, REFUND, RUSSIAN_MOBILE_PAYOUT, RUSSIAN_MOBILE_SALE,
+              SAFETYPAY, SALE, SALE_3D, SANTANDER, SCT_PAYOUT, SDD_INIT_RECURRING_SALE, SDD_RECURRING_SALE, SDD_REFUND,
+              SDD_SALE, SOFORT,
+              TARJETA_SHOPPING, TCS, TRANSFER_TO_PAYOUT, TRUSTLY_SALE,
+              UPI,
+              VOID,
+              WEBMONEY, WEBPAY, WECHAT
+            ]
+          end
+
+          # Validates the given type against the available Web Payment Form transaction types
+          def valid?(type)
+            all.include? type.to_s.downcase
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/genesis_ruby/utils/transactions/references/capturable_types.rb

@@ -0,0 +1,52 @@
+module GenesisRuby
+  module Utils
+    module Transactions
+      module References
+        # Capturable Transaction Types Helper Methods
+        class CapturableTypes
+
+          class << self
+
+            include GenesisRuby::Api::Constants::Transactions
+
+            # Array containing all available Capturable Types
+            def all
+              [
+                APPLE_PAY, AUTHORIZE, AUTHORIZE_3D,
+                GOOGLE_PAY,
+                INVOICE,
+                PAY_PAL
+              ]
+            end
+
+            # Checks if the given type is allowed for the execution of Reference Capture Transaction Type
+            def allowed_reference?(type)
+              all.include?(type.to_s.downcase)
+            end
+
+            # Checks if the given type is a Capture type
+            def valid?(type)
+              [
+                CAPTURE,
+                INVOICE_CAPTURE
+              ].include?(type.to_s.downcase)
+            end
+
+            # Fetches the correct Transaction type that must be used for the execution of the Capture
+            # ex. invoice -> invoice_capture
+            def fetch_reference(type)
+              case type.to_s.downcase
+              when INVOICE
+                INVOICE_CAPTURE
+              else
+                CAPTURE
+              end
+            end
+
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/utils/transactions/references/refundable_types.rb

@@ -0,0 +1,70 @@
+module GenesisRuby
+  module Utils
+    module Transactions
+      module References
+        # Refundable Transaction Types Helper Methods
+        class RefundableTypes
+
+          class << self
+
+            include GenesisRuby::Api::Constants::Transactions
+
+            # Array containing all available Refundable Types
+            def all # rubocop:disable Metrics/MethodLength
+              [
+                AFRICAN_MOBILE_PAYOUT, AFRICAN_MOBILE_SALE, APPLE_PAY,
+                BALOTO, BANCOMER, BANCONTACT, BANCO_DE_OCCIDENTE, BANCO_DO_BRASIL, BITPAY_SALE, BOLETO, BRADESCO,
+                CAPTURE, CASHU,
+                DAVIVIENDA,
+                EFECTY, EPS, FASHIONCHEQUE,
+                GIROPAY, GOOGLE_PAY,
+                IDEAL, IDEBIT_PAYIN, INIT_RECURRING_SALE, INIT_RECURRING_SALE_3D, INVOICE_CAPTURE, ITAU,
+                MY_BANK,
+                NEOSURF,
+                ONLINE_BANKING_PAYIN, OXXO,
+                P24, PAGO_FACIL, PARTIAL_REVERSAL, PAYU, PAY_PAL, PIX, POST_FINANCE, PPRO, PSE, RAPI_PAGO,
+                RECURRING_SALE, REDPAGOS,
+                SAFETYPAY, SALE, SALE_3D, SANTANDER, SDD_INIT_RECURRING_SALE, SDD_RECURRING_SALE, SDD_SALE, SOFORT,
+                TRUSTLY_SALE,
+                UPI,
+                WEBPAY, WECHAT
+              ]
+            end
+
+            # Checks if the given type is allowed for the execution of Reference Refund Transaction Type
+            def allowed_reference?(type)
+              all.include?(type.to_s.downcase)
+            end
+
+            # Checks if the given type is a Refund type
+            def valid?(type)
+              [
+                BITPAY_REFUND,
+                INVOICE_REFUND,
+                REFUND,
+                SDD_REFUND
+              ].include?(type.to_s.downcase)
+            end
+
+            # Fetches the correct Transaction type that must be used for the execution of the Refund
+            # ex. sdd_sale -> sdd_refund, sale -> refund
+            def fetch_reference(type)
+              case type.to_s.downcase
+              when BITPAY_SALE
+                BITPAY_REFUND
+              when SDD_SALE, SDD_RECURRING_SALE, SDD_INIT_RECURRING_SALE
+                SDD_REFUND
+              when INVOICE_CAPTURE
+                INVOICE_REFUND
+              else
+                REFUND
+              end
+            end
+
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/utils/transactions/references/voidable_types.rb

@@ -0,0 +1,49 @@
+module GenesisRuby
+  module Utils
+    module Transactions
+      module References
+        # Voidable Transaction Types Helper Methods
+        class VoidableTypes
+
+          class << self
+
+            include GenesisRuby::Api::Constants::Transactions
+
+            # Array containing all available Voidable Types
+            def all
+              [
+                AFRICAN_MOBILE_PAYOUT, AFRICAN_MOBILE_SALE, APPLE_PAY, AUTHORIZE, AUTHORIZE_3D,
+                FASHIONCHEQUE,
+                GOOGLE_PAY,
+                INTERSOLVE, INVOICE,
+                PAY_PAL,
+                REFUND,
+                SALE, SALE_3D,
+                TCS, TRUSTLY_SALE
+              ]
+            end
+
+            # Checks if the given type is allowed for the execution of Reference Void Transaction Type
+            def allowed_reference?(type)
+              all.include?(type.to_s.downcase)
+            end
+
+            # Checks if the given type is a Void type
+            def valid?(type)
+              [
+                VOID
+              ].include?(type.to_s.downcase)
+            end
+
+            # Fetches the correct Transaction type that must be used for the execution of the Void
+            def fetch_reference(_type)
+              VOID
+            end
+
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/utils/transactions/wpf_types.rb

@@ -0,0 +1,43 @@
+module GenesisRuby
+  module Utils
+    module Transactions
+      # Web Payment Form Transaction Types Helper methods
+      class WpfTypes
+
+        class << self
+
+          include GenesisRuby::Api::Constants::Transactions
+
+          # Return array containing all available Web Payment Form transaction types
+          def all # rubocop:disable Metrics/MethodLength
+            [
+              ACCOUNT_VERIFICATION, ARGENCARD, APPLE_PAY, AURA, AUTHORIZE, AUTHORIZE_3D,
+              BALOTO, BANCOMER, BANCONTACT, BANCO_DE_OCCIDENTE, BANCO_DO_BRASIL, BITPAY_PAYOUT, BITPAY_SALE, BOLETO,
+              BRADESCO,
+              CABAL, CASHU, CENCOSUD, DAVIVIENDA,
+              EFECTY, ELO, EPS, EZEEWALLET, FASHIONCHEQUE,
+              GIROPAY, GOOGLE_PAY,
+              IDEAL, IDEBIT_PAYIN, INSTA_DEBIT_PAYIN, INTERSOLVE, ITAU,
+              MULTIBANCO, MY_BANK,
+              NARANJA, NATIVA, NEOSURF, NETELLER,
+              ONLINE_BANKING_PAYIN, OXXO,
+              P24, PAGO_FACIL, PAY_PAL, PAYSAFECARD, PAYU, PIX, POLI, POST_FINANCE, PPRO, PSE,
+              RAPI_PAGO, REDPAGOS, RUSSIAN_MOBILE_SALE,
+              SAFETYPAY, SALE, SALE_3D, SANTANDER, SDD_INIT_RECURRING_SALE, SDD_SALE,
+              TARJETA_SHOPPING, TCS, TRUSTLY_SALE,
+              UPI,
+              WEBMONEY, WEBPAY, WECHAT
+            ]
+          end
+
+          # Validates the given type against the available Web Payment Form transaction types
+          def valid?(type)
+            all.include? type.to_s.downcase
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/genesis_ruby/version.rb

@@ -0,0 +1,5 @@
+module GenesisRuby
+
+  VERSION = '0.1.0'.freeze
+
+end