genesis_ruby 0.1.0

data/lib/genesis_ruby/api/mixins/requests/financial/threeds/version2/wpf_attributes.rb

@@ -0,0 +1,61 @@
+require 'genesis_ruby/api/mixins/requests/financial/threeds/version2/recurring'
+require 'genesis_ruby/api/mixins/requests/financial/threeds/version2/purchase'
+require 'genesis_ruby/api/mixins/requests/financial/threeds/version2/merchant_risk'
+require 'genesis_ruby/api/mixins/requests/financial/threeds/version2/control'
+require 'genesis_ruby/api/mixins/requests/financial/threeds/version2/card_holder_account'
+
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          module Threeds
+            module Version2
+              # Threeds Version 2 WPF Attributes
+              module WpfAttributes
+
+                include Control
+                include Purchase
+                include Recurring
+                include MerchantRisk
+                include CardHolderAccount
+
+                # WPF doesn't support Threeds V2 Device Type parameter
+                def threeds_v2_control_device_type
+                  raise NoMethodError, "#{__method__} isn't available for the Web Payment Form"
+                end
+
+                # WPF doesn't support Threeds V2 Device Type parameter
+                def threeds_v2_control_device_type=(_value)
+                  raise NoMethodError, "#{__method__} isn't available for the Web Payment Form"
+                end
+
+                protected
+
+                # Request Control Attributes structure available for the Web Payment Form
+                def control_attributes
+                  {
+                    challenge_window_size: threeds_v2_control_challenge_window_size,
+                    challenge_indicator:   threeds_v2_control_challenge_indicator
+                  }
+                end
+
+                # Threeds V2 Web Payment Form Attributes
+                def threeds_v2_wpf_attributes_structure
+                  {
+                    control:             control_attributes,
+                    purchase:            purchase_attributes,
+                    merchant_risk:       merchant_risk_attributes,
+                    card_holder_account: card_holder_account_attributes,
+                    recurring:           recurring_attributes
+                  }
+                end
+
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/restricted_setter.rb

@@ -0,0 +1,75 @@
+require 'genesis_ruby/api/constants/date_time_formats'
+require 'genesis_ruby/utils/common'
+
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        # Helper methods for restricting the available accessor's values
+        module RestrictedSetter
+
+          protected
+
+          # Validation of the value's allowed values
+          def allowed_options(attribute:, allowed:, value:, allow_empty: false, error_message: nil)
+            return assign_instance_variable attribute, nil if allow_empty && value.to_s.empty?
+
+            error_message = format(
+              '%{error_message}%{method} accepts one of the following: %{allowed}',
+              error_message: error_message ? "#{error_message} " : '',
+              method:        attribute,
+              allowed:       allowed.join(', ')
+            )
+
+            raise InvalidArgumentError, error_message unless allowed.include? value
+
+            assign_instance_variable attribute, value
+          end
+
+          # Validation of the value's length
+          def limited_string(attribute:, value:, min: nil, max: nil)
+            len = value.to_s.length
+
+            raise InvalidArgumentError, "#{attribute} value must be min #{min} chars long." if !min.nil? && len < min
+
+            raise InvalidArgumentError, "#{attribute} value must be max #{max} chars long." if !max.nil? && len > max
+
+            assign_instance_variable attribute, value
+          end
+
+          # Parses given date and assign it to the given attribute when it is valid
+          def parse_date(attribute:, value:, formats: [], error_message: nil, allow_empty: false)
+            return assign_instance_variable attribute, nil if allow_empty && value.to_s.empty?
+
+            formats         = GenesisRuby::Api::Constants::DateTimeFormats.all if formats.empty?
+            parsed_date     = GenesisRuby::Utils::Common.parse_date(value, formats)
+            error_message ||= format(
+              '%{method} accepts only valid date values in one of the following formats: %{formats}',
+              method:  attribute,
+              formats: formats.join(', ')
+            )
+
+            raise InvalidArgumentError, error_message unless parsed_date
+
+            assign_instance_variable attribute.to_s.chomp, parsed_date
+          end
+
+          # Parses given value to_i and assign it to the given attribute
+          def parse_int(attribute:, value:, allow_empty: false)
+            return assign_instance_variable attribute, nil if allow_empty && value.to_s.empty?
+
+            assign_instance_variable attribute, value.to_i
+          end
+
+          private
+
+          # Helper for assigning a attribute to the class instance
+          def assign_instance_variable(attribute, value)
+            instance_variable_set "@#{attribute.to_s.chomp "="}", value
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/request.rb

@@ -0,0 +1,171 @@
+require 'genesis_ruby/utils/options/api_config'
+require 'genesis_ruby/errors/endpoint_not_set_error'
+require 'genesis_ruby/builder'
+require 'genesis_ruby/utils/common'
+require 'genesis_ruby/utils/money_format'
+
+module GenesisRuby
+  module Api
+    # Base Request Class
+    class Request
+
+      PROTOCOL_HTTPS = 'https'.freeze
+      PORT_HTTPS     = 443
+
+      METHOD_POST    = 'POST'.freeze
+      METHOD_GET     = 'GET'.freeze
+      METHOD_PUT     = 'PUT'.freeze
+
+      attr_reader :api_config
+
+      def initialize(configuration, builder_interface = 'xml')
+        @configuration     = configuration
+        @builder_interface = builder_interface
+        @api_config        = GenesisRuby::Utils::Options::ApiConfig.new
+
+        init_configuration
+        init_required_fields
+      end
+
+      # Generate the Request Document based on the builder_interface
+      def build_document
+        process_request_parameters
+
+        if tree_structure.instance_of?(Hash)
+          @builder_context = GenesisRuby::Builder.new(builder_interface)
+          builder_context.parse_structure(tree_structure.clone)
+
+          return builder_context.document
+        end
+
+        nil
+      end
+
+      protected
+
+      attr_reader :configuration, :builder_interface, :builder_context
+      attr_accessor :tree_structure
+
+      # Request Configuration
+      def init_configuration; end
+
+      # Required fields for the request
+      def init_required_fields; end
+
+      # Pre-defined XML Request Configuration
+      def init_xml_configuration
+        @api_config.load_xml_config
+      end
+
+      # Pre-defined JSON Request Configuration
+      def init_json_configuration
+        @api_config.load_json_config
+      end
+
+      # Pre-defined FORM Request Configuration
+      def init_form_configuration
+        @api_config.load_form_config
+      end
+
+      # Initializes Api EndPoint Url with request path & terminal token
+      def init_api_gateway_configuration(options = { request_path: 'process', include_token: true })
+        request_path  = options.fetch :request_path, 'process'
+        include_token = options.fetch :include_token, true
+
+        api_config.url = build_request_url(
+          {
+            subdomain: 'gateway',
+            path:      request_path,
+            token:     include_token ? @configuration.token : ''
+          }
+        )
+      end
+
+      # Initializes WPF EndPoint Url with internationalization
+      def init_api_wpf_configuration(options = { language: '' })
+        language = (options.fetch :language, '').to_s
+
+        api_config.url = build_request_url(
+          {
+            subdomain: 'wpf',
+            path:      language.empty? ? 'wpf' : format('%{language}/wpf', { language: language })
+          }
+        )
+      end
+
+      # Process Everything the variables set previously
+      #
+      # Step 1: Execute per-field actions
+      # Step 2: Update the Tree structure
+      # Step 3: Clean the empty leafs
+      # Step 4: Check for Required Fields
+      def process_request_parameters
+        populate_structure
+
+        sanitize_structure
+
+        check_requirements
+      end
+
+      # Create the Tree structure and populate
+      # the fields with the set parameters.
+      # Every request defines the :tree_structure
+      def populate_structure
+        @tree_structure = {}
+      end
+
+      # Remove empty key values from the structure
+      def sanitize_structure
+        GenesisRuby::Utils::Common.deep_compact!(tree_structure) if tree_structure.instance_of?(Hash)
+      end
+
+      # Perform validation over the defined parameters
+      def check_requirements
+        # TODO: perform validation over the defined parameters
+      end
+
+      # Build the Genesis API endpoint
+      # Options:
+      #   subdomain - the service /gateway, wpf, etc/
+      #   path - the requested service /blacklists, threeds/threeds_method/<unique_id>, wpf/reconcile, etc/
+      #   token - the MID configuration, appended to the end of the URL
+      def build_request_url(options = { subdomain: 'gateway', path: '', token: '' })
+        options  = parse_request_parameters(options)
+
+        format('%{protocol}://%{sub}%{domain}:%{port}/%{path}', {
+                 protocol: api_config.protocol || PROTOCOL_HTTPS,
+                 sub:      @configuration.sub_domain(options[:subdomain]),
+                 domain:   @configuration.endpoint,
+                 port:     api_config.port || PORT_HTTPS,
+                 path:     fetch_request_path(options)
+               })
+      end
+
+      # Transform amount to minor currency format
+      def transform_amount(amount, currency)
+        GenesisRuby::Utils::MoneyFormat.amount_to_exponent amount, currency
+      end
+
+      private
+
+      # Parse the Request URL options
+      def parse_request_parameters(options = { subdomain: 'gateway', token: '', path: '' })
+        raise EndpointNotSetError if @configuration.endpoint.empty?
+
+        {
+          subdomain: options.fetch(:subdomain, 'gateway'),
+          token:     options.fetch(:token, ''),
+          path:      options.fetch(:path, '')
+        }
+      end
+
+      # Fetch the request path by the given options
+      def fetch_request_path(options = { path: '', token: '' })
+        return options[:path] if options[:token].empty?
+
+        format('%{path}/%{token}/', { path: options[:path], token: options[:token] })
+      end
+
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/base/financial.rb

@@ -0,0 +1,44 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module Base
+        # Base class used by all Financial transaction requests
+        class Financial < Request
+
+          include Mixins::Requests::Financial::BaseAttributes
+
+          protected
+
+          # Returns the Request transaction type
+          def transaction_type
+            raise NotImplementedError, 'Transaction Type method must be implemented'
+          end
+
+          # Return additional request attributes
+          def payment_transaction_structure
+            raise NotImplementedError, 'Payment Transaction Structure method must be implemented'
+          end
+
+          # Request Configuration
+          def init_configuration
+            super
+            init_xml_configuration
+            init_api_gateway_configuration
+          end
+
+          def populate_structure
+            self.tree_structure = {
+              payment_transaction: {
+                transaction_type: transaction_type,
+                transaction_id:   transaction_id,
+                usage:            usage,
+                remote_ip:        remote_ip
+              }.merge(payment_transaction_structure)
+            }
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/base/financials/credit_card.rb

@@ -0,0 +1,27 @@
+require 'genesis_ruby/api/requests/base/financial'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module Base
+        module Financials
+          # Base Class used for all transaction request containing Credit Card data
+          class CreditCard < GenesisRuby::Api::Requests::Base::Financial
+
+            include Mixins::Requests::Financial::PaymentAttributes
+            include Mixins::Requests::Financial::Cards::CreditCardAttributes
+            include Mixins::Requests::Financial::Cards::TokenizationAttributes
+
+            protected
+
+            # Credit Card attributes
+            def payment_transaction_structure
+              payment_attributes_structure.merge credit_card_attributes_structure, tokenization_attributes_structure
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/financial/cards/authorize.rb

@@ -0,0 +1,60 @@
+require 'genesis_ruby/api/requests/base/financials/credit_card'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module Financial
+        module Cards
+          # With authorize transactions, you can confirm that a credit card is valid and
+          # reserve the desired amount on the card
+          class Authorize < Requests::Base::Financials::CreditCard
+
+            include Mixins::Requests::AddressInfoAttributes
+            include Mixins::Requests::DocumentAttributes
+            include Mixins::Requests::Financial::Business::BusinessAttributes
+            include Mixins::Requests::Financial::Cards::FxRateAttributes
+            include Mixins::Requests::Financial::Cards::Recurring::RecurringCategoryAttributes
+            include Mixins::Requests::Financial::Cards::Recurring::RecurringTypeAttributes
+            include Mixins::Requests::Financial::CryptoAttributes
+            include Mixins::Requests::Financial::DynamicDescriptorAttributes
+            include Mixins::Requests::Financial::GamingAttributes
+            include Mixins::Requests::Financial::MotoAttributes
+            include Mixins::Requests::Financial::ReferenceAttributes
+            include Mixins::Requests::Financial::RiskAttributes
+            include Mixins::Requests::Financial::ScaAttributes
+            include Mixins::Requests::RestrictedSetter
+
+            protected
+
+            # Authorize Transaction Type
+            def transaction_type
+              GenesisRuby::Api::Constants::Transactions::AUTHORIZE
+            end
+
+            def payment_transaction_structure # rubocop:disable Metrics/MethodLength
+              super.merge(
+                gaming:                    gaming,
+                moto:                      moto,
+                crypto:                    crypto,
+                customer_email:            customer_email,
+                customer_phone:            customer_phone,
+                reference_id:              reference_id,
+                document_id:               document_id,
+                fx_rate_id:                fx_rate_id,
+                billing_address:           billing_address_parameters_structure,
+                shipping_address:          shipping_address_parameters_structure,
+                risk_params:               risk_parameters_structure,
+                dynamic_descriptor_params: dynamic_descriptor_structure,
+                business_attributes:       business_attributes_structure,
+                recurring_type:            recurring_type,
+                recurring_category:        recurring_category,
+                sca_params:                sca_attributes_structure
+              )
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/financial/cards/authorize3d.rb

@@ -0,0 +1,76 @@
+require 'genesis_ruby/api/requests/base/financials/credit_card'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module Financial
+        module Cards
+          # Authorize 3D transactions, credit card based, can be synchronous or asynchronous based on the workflow and
+          # the additional parameters for card holder authentication
+          class Authorize3d < Requests::Base::Financials::CreditCard
+
+            include Mixins::Requests::AddressInfoAttributes
+            include Mixins::Requests::DocumentAttributes
+            include Mixins::Requests::Financial::AsyncAttributes
+            include Mixins::Requests::Financial::Business::BusinessAttributes
+            include Mixins::Requests::Financial::Cards::FxRateAttributes
+            include Mixins::Requests::Financial::Cards::Recurring::RecurringCategoryAttributes
+            include Mixins::Requests::Financial::Cards::Recurring::RecurringTypeAttributes
+            include Mixins::Requests::Financial::CryptoAttributes
+            include Mixins::Requests::Financial::DynamicDescriptorAttributes
+            include Mixins::Requests::Financial::GamingAttributes
+            include Mixins::Requests::Financial::MotoAttributes
+            include Mixins::Requests::Financial::NotificationAttributes
+            include Mixins::Requests::Financial::RiskAttributes
+            include Mixins::Requests::Financial::ScaAttributes
+            include Mixins::Requests::Financial::Threeds::Version2::CommonAttributes
+            include Mixins::Requests::RestrictedSetter
+
+            # Specifies the recurring type of transaction
+            def recurring_type=(value)
+              allowed_values = [
+                GenesisRuby::Api::Constants::Transactions::Parameters::Recurring::Types::INITIAL,
+                GenesisRuby::Api::Constants::Transactions::Parameters::Recurring::Types::MANAGED
+              ]
+
+              allowed_options attribute: __method__, allowed: allowed_values, value: value, allow_empty: true
+            end
+
+            protected
+
+            # Authorize 3D Transaction Type
+            def transaction_type
+              GenesisRuby::Api::Constants::Transactions::AUTHORIZE_3D
+            end
+
+            # Authorize 3D transaction request parameters
+            def payment_transaction_structure # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+              super.merge(
+                notification_url:          notification_url,
+                return_success_url:        return_success_url,
+                return_failure_url:        return_failure_url,
+                gaming:                    gaming,
+                moto:                      moto,
+                crypto:                    crypto,
+                customer_email:            customer_email,
+                customer_phone:            customer_phone,
+                document_id:               document_id,
+                fx_rate_id:                fx_rate_id,
+                billing_address:           billing_address_parameters_structure,
+                shipping_address:          shipping_address_parameters_structure,
+                risk_params:               risk_parameters_structure,
+                dynamic_descriptor_params: dynamic_descriptor_structure,
+                business_attributes:       business_attributes_structure,
+                recurring_type:            recurring_type,
+                recurring_category:        recurring_category,
+                sca_params:                sca_attributes_structure,
+                threeds_v2_params:         threeds_v2_common_attributes_structure
+              )
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/financial/cards/sale.rb

@@ -0,0 +1,59 @@
+require 'genesis_ruby/api/requests/base/financials/credit_card'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module Financial
+        module Cards
+          # Sale transactions combine authorize and capture into one step
+          class Sale < Requests::Base::Financials::CreditCard
+
+            include Mixins::Requests::AddressInfoAttributes
+            include Mixins::Requests::DocumentAttributes
+            include Mixins::Requests::Financial::Business::BusinessAttributes
+            include Mixins::Requests::Financial::Cards::FxRateAttributes
+            include Mixins::Requests::Financial::Cards::Recurring::RecurringCategoryAttributes
+            include Mixins::Requests::Financial::Cards::Recurring::RecurringTypeAttributes
+            include Mixins::Requests::Financial::CryptoAttributes
+            include Mixins::Requests::Financial::DynamicDescriptorAttributes
+            include Mixins::Requests::Financial::GamingAttributes
+            include Mixins::Requests::Financial::MotoAttributes
+            include Mixins::Requests::Financial::ReferenceAttributes
+            include Mixins::Requests::Financial::RiskAttributes
+            include Mixins::Requests::Financial::ScaAttributes
+            include Mixins::Requests::RestrictedSetter
+
+            protected
+
+            # Sale Transaction Type
+            def transaction_type
+              GenesisRuby::Api::Constants::Transactions::SALE
+            end
+
+            def payment_transaction_structure # rubocop:disable Metrics/MethodLength
+              super.merge(
+                gaming:                    gaming,
+                moto:                      moto,
+                crypto:                    crypto,
+                customer_email:            customer_email,
+                customer_phone:            customer_phone,
+                reference_id:              reference_id,
+                document_id:               document_id,
+                fx_rate_id:                fx_rate_id,
+                billing_address:           billing_address_parameters_structure,
+                shipping_address:          shipping_address_parameters_structure,
+                risk_params:               risk_parameters_structure,
+                dynamic_descriptor_params: dynamic_descriptor_structure,
+                business_attributes:       business_attributes_structure,
+                recurring_type:            recurring_type,
+                recurring_category:        recurring_category,
+                sca_params:                sca_attributes_structure
+              )
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/financial/cards/sale3d.rb

@@ -0,0 +1,75 @@
+require 'genesis_ruby/api/requests/base/financials/credit_card'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module Financial
+        module Cards
+          # Sale3D combines a Sale transaction request by adding asynchronous processing
+          class Sale3d < Requests::Base::Financials::CreditCard
+
+            include Mixins::Requests::AddressInfoAttributes
+            include Mixins::Requests::DocumentAttributes
+            include Mixins::Requests::Financial::AsyncAttributes
+            include Mixins::Requests::Financial::Business::BusinessAttributes
+            include Mixins::Requests::Financial::Cards::FxRateAttributes
+            include Mixins::Requests::Financial::Cards::Recurring::RecurringCategoryAttributes
+            include Mixins::Requests::Financial::Cards::Recurring::RecurringTypeAttributes
+            include Mixins::Requests::Financial::CryptoAttributes
+            include Mixins::Requests::Financial::DynamicDescriptorAttributes
+            include Mixins::Requests::Financial::GamingAttributes
+            include Mixins::Requests::Financial::MotoAttributes
+            include Mixins::Requests::Financial::NotificationAttributes
+            include Mixins::Requests::Financial::RiskAttributes
+            include Mixins::Requests::Financial::ScaAttributes
+            include Mixins::Requests::Financial::Threeds::Version2::CommonAttributes
+            include Mixins::Requests::RestrictedSetter
+
+            # Specifies the recurring type of transaction
+            def recurring_type=(value)
+              allowed_values = [
+                GenesisRuby::Api::Constants::Transactions::Parameters::Recurring::Types::INITIAL,
+                GenesisRuby::Api::Constants::Transactions::Parameters::Recurring::Types::MANAGED
+              ]
+
+              allowed_options attribute: __method__, allowed: allowed_values, value: value, allow_empty: true
+            end
+
+            protected
+
+            # Sale 3D Transaction Type
+            def transaction_type
+              GenesisRuby::Api::Constants::Transactions::SALE_3D
+            end
+
+            # Sale 3D transaction request parameters
+            def payment_transaction_structure # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+              super.merge(
+                notification_url:          notification_url,
+                return_success_url:        return_success_url,
+                return_failure_url:        return_failure_url,
+                gaming:                    gaming,
+                moto:                      moto,
+                crypto:                    crypto,
+                customer_email:            customer_email,
+                customer_phone:            customer_phone,
+                document_id:               document_id,
+                fx_rate_id:                fx_rate_id,
+                billing_address:           billing_address_parameters_structure,
+                shipping_address:          shipping_address_parameters_structure,
+                risk_params:               risk_parameters_structure,
+                dynamic_descriptor_params: dynamic_descriptor_structure,
+                business_attributes:       business_attributes_structure,
+                recurring_type:            recurring_type,
+                recurring_category:        recurring_category,
+                sca_params:                sca_attributes_structure,
+                threeds_v2_params:         threeds_v2_common_attributes_structure
+              )
+            end
+
+          end
+        end
+      end
+    end
+  end
+end