eml 1.0.0

data/lib/eml/uk/lib/parse_date.rb

@@ -0,0 +1,35 @@
+# typed: ignore
+# frozen_string_literal: true
+
+require "bigdecimal"
+
+module EML
+  module UK
+    class ParseDate
+      extend T::Sig
+
+      def self.call(date_string)
+        new(date_string).call
+      end
+
+      def initialize(date_string)
+        @date_string = date_string
+      end
+
+      def call
+        return if @date_string.nil?
+
+        matches = @date_string.match(%r(/Date\(((\d{13})([\+\-]\d{4})?)\)/))
+        return if matches.nil?
+
+        milliseconds = BigDecimal(matches[2])
+        timezone_offset = matches[3]
+
+        time = Time.at(milliseconds / 1000).utc
+        return time if timezone_offset.nil?
+
+        time.localtime("#{timezone_offset[0, 3]}:#{timezone_offset[3, 4]}")
+      end
+    end
+  end
+end

data/lib/eml/uk/model/transaction.rb

@@ -0,0 +1,56 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module UK
+    class Model
+      class Transaction
+        FIELDS = %w[
+          acceptor_code
+          acceptor_location
+          activity
+          amount
+          auth_id
+          authorization_request_id
+          currency
+          eml_id
+          expiration_minutes
+          location
+          merchant_category_code
+          merchant_country
+          notes
+          original_transaction_date
+          pos_transaction_time
+          reason
+          result
+          retrieval_reference_number
+          system_transaction_id
+          timestamp
+          transaction_amount
+          transaction_currency
+          user
+        ].freeze
+        private_constant :FIELDS
+
+        FIELDS.each { |field| __send__(:attr_reader, :"#{field}") }
+
+        def initialize(response)
+          FIELDS.each do |field|
+            value = field_value(field, response[field])
+            instance_variable_set(:"@#{field}", value)
+          end
+        end
+
+        private
+
+        def field_value(field, raw_value)
+          if field.include?("time")
+            EML::UK::ParseDate.(raw_value)
+          else
+            raw_value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eml/uk/parameters.rb

@@ -0,0 +1,99 @@
+# typed: strict
+# frozen_string_literal: true
+
+# Parameters are the elements of a query string.
+# For example: example.com?param1=value1&param2=value2
+module EML
+  module UK
+    class Parameters < ::EML::Parameters
+      extend T::Sig
+
+      sig { params(params: T::Hash[Symbol, T.untyped]).void }
+      def initialize(params)
+        params = merge_required_config(params)
+        params = merge_optional_config(params)
+        super
+      end
+
+      class << self
+        extend T::Sig
+
+        sig do
+          params(
+            resource_class: T.untyped,
+            endpoint: String,
+            params: T::Hash[Symbol, T.untyped]
+          ).returns(T.untyped)
+        end
+        def convert(resource_class, endpoint, params)
+          endpoint_class = EML::UK::EndpointClass.(
+            class_type: self::ENDPOINT_CLASS_TYPE,
+            resource_class: resource_class, endpoint: endpoint
+          )
+
+          convert_with_endpoint_class(
+            endpoint: endpoint, endpoint_class: endpoint_class,
+            resource_class: resource_class, params: params
+          )
+        end
+      end
+
+      protected
+
+      BOOLEAN_OPTIONS = %w[true false].freeze
+
+      sig { params(param_name: String, param_value: String).void }
+      def validate_boolean(param_name, param_value)
+        return if BOOLEAN_OPTIONS.include?(param_value)
+
+        message = "#{param_name} should be the string 'true' or 'false' but " \
+          "received #{param_value.inspect}"
+        raise ArgumentError, message
+      end
+
+      SEARCH_PARAMETER_OPTIONS = %w[
+        ActualCardNumber CarrierNumber ClientTrackingId ExternalId
+        PaymentTrackingID PrintText
+      ].freeze
+
+      sig { params(value: String).void }
+      def validate_search_parameter(value)
+        return if SEARCH_PARAMETER_OPTIONS.include?(value)
+
+        message = "search_parameter should be one of " \
+          "#{SEARCH_PARAMETER_OPTIONS.join(", ")} but received #{value.inspect}"
+        raise ArgumentError, message
+      end
+
+      private
+
+      sig do
+        params(params: T::Hash[Symbol, T.untyped]).
+          returns(T::Hash[Symbol, T.untyped])
+      end
+      def merge_optional_config(params)
+        return params unless self.class.const_defined?(:OPTIONAL_CONFIG)
+
+        config = EML::UK.config
+        self.class.const_get(:OPTIONAL_CONFIG).
+          each_with_object(params.dup) do |name, new_params|
+            new_params[name] ||= config.public_send(name)
+          end
+      end
+
+      sig do
+        params(params: T::Hash[Symbol, T.untyped]).
+          returns(T::Hash[Symbol, T.untyped])
+      end
+      def merge_required_config(params)
+        return params unless self.class.const_defined?(:REQUIRED_CONFIG)
+
+        config = EML::UK.config
+        self.class.const_get(:REQUIRED_CONFIG).
+          each_with_object(params.dup) do |name, new_params|
+            new_params[name] ||= config.require_parameter(name)
+          end
+      end
+    end
+  end
+end

data/lib/eml/uk/parameters/agreement/show.rb

@@ -0,0 +1,22 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module UK
+    class Parameters
+      module Agreement
+        class Show < ::EML::UK::Parameters
+          def initialize(params)
+            params[:client_language] ||= "en"
+            super
+          end
+
+          private
+
+          sig { params(client_language: String).returns(String) }
+          attr_accessor :client_language
+        end
+      end
+    end
+  end
+end

data/lib/eml/uk/parameters/card/activation.rb

@@ -0,0 +1,24 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module UK
+    class Parameters
+      module Card
+        class Activation < ::EML::UK::Parameters
+          REQUIRED_CONFIG = %i[program].freeze
+          OPTIONAL_CONFIG = %i[search_parameter].freeze
+
+          sig { params(program: String).returns(String) }
+          attr_accessor :program
+
+          sig { params(search_parameter: String).returns(String) }
+          def search_parameter=(search_parameter)
+            validate_search_parameter(search_parameter)
+            @search_parameter = search_parameter
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eml/uk/parameters/card/lock.rb

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module UK
+    class Parameters
+      module Card
+        class Lock < ::EML::UK::Parameters
+          REQUIRED_CONFIG = %i[program].freeze
+          OPTIONAL_CONFIG = %i[search_parameter].freeze
+
+          private
+
+          sig { params(program: String).returns(String) }
+          attr_accessor :program
+
+          sig { params(search_parameter: String).returns(String) }
+          def search_parameter=(search_parameter)
+            validate_search_parameter(search_parameter)
+            @search_parameter = search_parameter
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eml/uk/parameters/card/register.rb

@@ -0,0 +1,24 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module UK
+    class Parameters
+      module Card
+        class Register < ::EML::UK::Parameters
+          REQUIRED_CONFIG = %i[program].freeze
+          OPTIONAL_CONFIG = %i[search_parameter].freeze
+
+          sig { params(program: String).returns(String) }
+          attr_accessor :program
+
+          sig { params(search_parameter: String).returns(String) }
+          def search_parameter=(search_parameter)
+            validate_search_parameter(search_parameter)
+            @search_parameter = search_parameter
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eml/uk/parameters/card/reload.rb

@@ -0,0 +1,24 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module UK
+    class Parameters
+      module Card
+        class Reload < ::EML::UK::Parameters
+          REQUIRED_CONFIG = %i[program].freeze
+          OPTIONAL_CONFIG = %i[search_parameter].freeze
+
+          sig { params(program: String).returns(String) }
+          attr_accessor :program
+
+          sig { params(search_parameter: String).returns(String) }
+          def search_parameter=(search_parameter)
+            validate_search_parameter(search_parameter)
+            @search_parameter = search_parameter
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eml/uk/parameters/card/show.rb

@@ -0,0 +1,102 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module UK
+    class Parameters
+      module Card
+        class Show < ::EML::UK::Parameters
+          REQUIRED_CONFIG = %i[program].freeze
+          OPTIONAL_CONFIG = %i[search_parameter].freeze
+
+          FIELDS_OPTIONS = %w[
+            account_expiration_date
+            activating_merchant_group_name
+            activating_merchant_group_uniquetag
+            activation_amount
+            activation_country
+            activation_date
+            activation_transaction_Id
+            actual_balance
+            adjusted_balance
+            agreement_txt
+            agreement_pdf
+            agreement_pdf_fileName
+            amf_amount
+            amf_start_date
+            amf_next_date
+            available_balance
+            bank_name
+            barcode_image
+            can_activate
+            can_redeem
+            card_image
+            card_type
+            client_tracking_id
+            currency
+            cvv2
+            distributor_refund
+            expiration_date
+            has_atm_access
+            has_pin
+            id
+            is_icc_card
+            is_organization_registration
+            is_registered
+            is_reloadable
+            is_virtual
+            pan
+            pan_last_four
+            pin_enabled
+            print_text
+            program_can_register
+            program_name
+            program_uniquetag
+            promotion_balance
+            promotion_expiration
+            promotion_type_id
+            security_code
+            status
+            uri
+            unload_to_ach_fee
+          ].freeze
+
+          sig { params(fields: T::Array[String]).returns(String) }
+          def fields=(fields)
+            unless fields.first == "all"
+              fields.each do |field|
+                validate_array("fields", field, FIELDS_OPTIONS)
+              end
+            end
+
+            @fields = fields.join(",")
+          end
+
+          sig { params(log_balance_inquiry: String).returns(String) }
+          def log_balance_inquiry=(log_balance_inquiry)
+            validate_boolean("log_balance_inquiry", log_balance_inquiry)
+            @log_balance_inquiry = log_balance_inquiry
+          end
+
+          sig { params(only_valid_status: String).returns(String) }
+          def only_valid_status=(only_valid_status)
+            validate_boolean("only_valid_status", only_valid_status)
+            @only_valid_status = only_valid_status
+          end
+
+          sig { params(program: String).returns(String) }
+          attr_accessor :program
+
+          sig { params(search_parameter: String).returns(String) }
+          def search_parameter=(search_parameter)
+            validate_search_parameter(search_parameter)
+            @search_parameter = search_parameter
+          end
+
+          sig { params(security_code: String).returns(String) }
+          attr_accessor :security_code
+        end
+      end
+    end
+  end
+end

data/lib/eml/uk/parameters/card/transaction.rb

@@ -0,0 +1,59 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module UK
+    class Parameters
+      module Card
+        class Transaction < ::EML::UK::Parameters
+          REQUIRED_CONFIG = %i[program].freeze
+          OPTIONAL_CONFIG = %i[search_parameter].freeze
+
+          private
+
+          FIELDS_OPTIONS = %w[
+            activity
+            amount
+            authorization_request_id
+            currency
+            location
+            merchant_category_code
+            merchant_country
+            notes
+            original_transaction_date
+            pos_transaction_time
+            reason
+            result
+            retrieval_reference_number
+            system_transaction_id
+            timestamp
+            user
+          ].freeze
+
+          sig { params(fields: T::Array[String]).returns(String) }
+          def fields=(fields)
+            unless fields.first == "all"
+              fields.each do |field|
+                validate_array("fields", field, FIELDS_OPTIONS)
+              end
+            end
+
+            @fields = fields.join(",")
+          end
+
+          sig { params(filter: String).returns(String) }
+          attr_accessor :filter
+
+          sig { params(program: String).returns(String) }
+          attr_accessor :program
+
+          sig { params(search_parameter: String).returns(String) }
+          def search_parameter=(search_parameter)
+            validate_search_parameter(search_parameter)
+            @search_parameter = search_parameter
+          end
+        end
+      end
+    end
+  end
+end