eml 1.0.0

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

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module UK
+    class Parameters
+      module Card
+        class Unload < ::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/unlock.rb

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module UK
+    class Parameters
+      module Card
+        class Unlock < ::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/void.rb

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module UK
+    class Parameters
+      module Card
+        class Unlock < ::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/payload.rb

@@ -0,0 +1,94 @@
+# typed: strict
+# frozen_string_literal: true
+
+# A payload is the data sent in the body of a request such as POST or PUT
+module EML
+  module UK
+    class Payload < ::EML::Payload
+      extend T::Sig
+
+      sig { params(payload: T::Hash[Symbol, T.untyped]).void }
+      def initialize(payload)
+        payload = merge_optional_config(payload)
+        payload = merge_required_config(payload)
+        super
+      end
+
+      class << self
+        extend T::Sig
+
+        sig do
+          params(
+            resource_class: T.untyped,
+            endpoint: String,
+            payload: T::Hash[Symbol, T.untyped]
+          ).returns(T.untyped)
+        end
+        def convert(resource_class, endpoint, payload)
+          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,
+            payload: payload, resource_class: resource_class
+          )
+        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
+
+      sig { params(dob: String).void }
+      def validate_dob(dob)
+        validate_max_length(:dob, dob, 8)
+        dob_i = dob.to_i
+        raise ArgumentError if dob_i < 1_011_900 || dob_i > 13_000_000
+      rescue ArgumentError
+        raise ArgumentError, "DOB should be in the format MMDDYYYY"
+      end
+
+      private
+
+      sig do
+        params(payload: T::Hash[Symbol, T.untyped]).
+          returns(T::Hash[Symbol, T.untyped])
+      end
+      def merge_optional_config(payload)
+        return payload unless self.class.const_defined?(:OPTIONAL_CONFIG)
+
+        config = EML::UK.config
+        self.class.const_get(:OPTIONAL_CONFIG).
+          each_with_object(payload.dup) do |name, new_payload|
+            new_payload[name] ||= config.public_send(name)
+          end
+      end
+
+      sig do
+        params(payload: T::Hash[Symbol, T.untyped]).
+          returns(T::Hash[Symbol, T.untyped])
+      end
+      def merge_required_config(payload)
+        return payload unless self.class.const_defined?(:REQUIRED_CONFIG)
+
+        config = EML::UK.config
+        self.class.const_get(:REQUIRED_CONFIG).
+          each_with_object(payload.dup) do |name, new_payload|
+            new_payload[name] ||= config.require_parameter(name)
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module UK
+    class Payload
+      module Agreement
+        class Show < ::EML::UK::Payload
+          OPTIONAL_DEFAULTS = %i[merchant_group program].freeze
+
+          private
+
+          sig { params(bin: String).returns(String) }
+          attr_accessor :bin
+
+          sig { params(country: String).returns(String) }
+          attr_accessor :country
+
+          sig { params(developer: String).returns(String) }
+          attr_accessor :developer
+
+          sig { params(is_account_expiry: String).returns(String) }
+          def is_account_expiry=(is_account_expiry)
+            validate_boolean("is_account_expiry", is_account_expiry)
+            @Is_account_expiry = is_account_expiry
+          end
+
+          sig { params(is_fee_free: String).returns(String) }
+          def is_fee_free=(is_fee_free)
+            validate_boolean("is_fee_free", is_fee_free)
+            @Is_fee_free = is_fee_free
+          end
+
+          sig { params(merchant_group: String).returns(String) }
+          attr_accessor :merchant_group
+
+          sig { params(program: String).returns(String) }
+          attr_accessor :program
+
+          sig { params(region: String).returns(String) }
+          attr_accessor :region
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module UK
+    class Payload
+      module Card
+        class Activation < ::EML::UK::Payload
+          REQUIRED_VALUES =
+            %i[amount location.name location.country sales_channel].freeze
+          REQUIRED_CONFIG = %i[merchant_group].freeze
+
+          private
+
+          sig { params(amount: Numeric).returns(Numeric) }
+          attr_accessor :amount
+
+          sig { params(campaign: String).returns(String) }
+          attr_accessor :campaign
+
+          sig { params(cardholder_user_id: String).returns(String) }
+          attr_accessor :cardholder_user_id
+
+          # While client_order_date is sent to EML as a JSON DateTime,
+          # there are many classes that could be used which causes a typing
+          # challenge. For example, if Rails is in use, we will probably receive
+          # a ActiveSupport::TimeWithZone
+          sig { params(client_order_date: T.untyped).returns(T.untyped) }
+          attr_accessor :client_order_date
+
+          sig { params(client_reference_number: String).void }
+          def client_reference_number=(client_reference_number)
+            validate_max_length(
+              :client_reference_number, client_reference_number, 50
+            )
+            @client_reference_number = client_reference_number
+          end
+
+          # While client_time is sent to EML as a JSON DateTime,
+          # there are many classes that could be used which causes a typing
+          # challenge. For example, if Rails is in use, we will probably receive
+          # a ActiveSupport::TimeWithZone
+          sig { params(client_time: T.untyped).returns(T.untyped) }
+          attr_accessor :client_time
+
+          sig { params(client_tracking_id: String).void }
+          def client_tracking_id=(client_tracking_id)
+            validate_max_length(
+              :client_tracking_id, client_tracking_id, 50
+            )
+            @client_tracking_id = client_tracking_id
+          end
+
+          sig { params(location: Hash).void }
+          def location=(location)
+            @location = EML::UK::Payload::Location.new(location)
+          end
+
+          sig { params(merchant_group: String).returns(String) }
+          attr_accessor :merchant_group
+
+          sig { params(note: String).returns(String) }
+          attr_accessor :note
+
+          SALES_CHANNELS = %w[Online InPerson].freeze
+
+          sig { params(sales_channel: String).returns(String) }
+          attr_accessor :sales_channel
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module UK
+    class Payload
+      module Card
+        class Lock < ::EML::UK::Payload
+          REQUIRED_CONFIG = %i[merchant_group].freeze
+          REQUIRED_VALUES = %i[note reason].freeze
+
+          private
+
+          sig { params(merchant_group: String).returns(String) }
+          attr_accessor :merchant_group
+
+          sig { params(note: String).returns(String) }
+          attr_accessor :note
+
+          REASONS = %w[
+            Damaged DataBreach Lost Miscellaneous OfficeError
+            PastAccountExpirationDate Stolen UnclaimedProperty
+          ].freeze
+
+          sig { params(reason: String).void }
+          def reason=(reason)
+            validate_enum(:reason, reason, REASONS)
+            @reason = reason
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module UK
+    class Payload
+      module Card
+        class Register < ::EML::UK::Payload
+          include ISO
+
+          REQUIRED_VALUES =
+            %i[first_name last_name address1 city country email].freeze
+
+          private
+
+          sig { params(first_name: String).void }
+          def first_name=(first_name)
+            validate_max_length(:first_name, first_name, 50)
+            @first_name = first_name
+          end
+
+          sig { params(last_name: String).void }
+          def last_name=(last_name)
+            validate_max_length(:last_name, last_name, 50)
+            @last_name = last_name
+          end
+
+          sig { params(address1: String).void }
+          def address1=(address1)
+            validate_max_length(:address1, address1, 255)
+            @address1 = address1
+          end
+
+          sig { params(address2: String).void }
+          def address2=(address2)
+            validate_max_length(:address2, address2, 255)
+            @address2 = address2
+          end
+
+          sig { params(city: String).void }
+          def city=(city)
+            validate_max_length(:city, city, 255)
+            @city = city
+          end
+
+          sig { params(dob: String).void }
+          def dob=(dob)
+            validate_dob(dob)
+            @dob = dob
+          end
+
+          sig { params(email: String).void }
+          def email=(email)
+            validate_max_length(:email, email, 255)
+            @email = email
+          end
+
+          sig { params(phone: String).void }
+          def phone=(phone)
+            validate_max_length(:phone, phone, 20)
+            @phone = phone
+          end
+
+          sig { params(postal_code: String).returns(String) }
+          attr_accessor :postal_code
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module UK
+    class Payload
+      module Card
+        class Reload < ::EML::UK::Payload
+          REQUIRED_CONFIG = %i[merchant_group].freeze
+          REQUIRED_VALUES = %i[amount location.country].freeze
+
+          private
+
+          sig { params(amount: Numeric).returns(Numeric) }
+          attr_accessor :amount
+
+          # While client_time is sent to EML as a JSON DateTime, there are many
+          # classes that could be used which causes a typing challenge. For
+          # example, if Rails is in use, we will probably receive a
+          # ActiveSupport::TimeWithZone
+          sig { params(client_time: T.untyped).returns(T.untyped) }
+          attr_accessor :client_time
+
+          sig { params(location: Hash).void }
+          def location=(location)
+            @location = EML::UK::Payload::Location.new(location)
+          end
+
+          sig { params(merchant_group: String).returns(String) }
+          attr_accessor :merchant_group
+
+          sig { params(note: String).returns(String) }
+          attr_accessor :note
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module UK
+    class Payload
+      module Card
+        class Show < ::EML::UK::Payload; end
+      end
+    end
+  end
+end