eml 1.0.0

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

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

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

@@ -0,0 +1,38 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module UK
+    class Payload
+      module Card
+        class Unload < ::EML::UK::Payload
+          REQUIRED_CONFIG = %i[merchant_group].freeze
+          REQUIRED_VALUES = %i[amount location.country note].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/unlock.rb

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module UK
+    class Payload
+      module Card
+        class Unlock < ::EML::UK::Payload
+          REQUIRED_CONFIG = %i[merchant_group].freeze
+          REQUIRED_VALUES = %i[note].freeze
+
+          private
+
+          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/void.rb

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module UK
+    class Payload
+      module Card
+        class Void < ::EML::UK::Payload
+          REQUIRED_CONFIG = %i[merchant_group].freeze
+          REQUIRED_VALUES = %i[note].freeze
+
+          private
+
+          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/contactentity.rb

@@ -0,0 +1,64 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module UK
+    class Payload
+      class Contactentity < ::EML::Payload
+        REQUIRED_VALUES = %i[first_name last_name address1 city country].freeze
+
+        include ISO
+
+        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).returns(String) }
+        attr_accessor :city
+
+        sig { params(postal_code: String).returns(String) }
+        attr_accessor :postal_code
+
+        sig { params(phone: String).void }
+        def phone=(phone)
+          validate_max_length(:phone, phone, 20)
+          @phone = phone
+        end
+
+        sig { params(email: String).void }
+        def email=(email)
+          validate_max_length(:email, email, 255)
+          @email = email
+        end
+
+        sig { params(dob: String).void }
+        def dob=(dob)
+          validate_max_length(:dob, dob, 8)
+          @dob = dob
+        end
+      end
+    end
+  end
+end

data/lib/eml/uk/payload/iso.rb

@@ -0,0 +1,48 @@
+# typed: false
+# frozen_string_literal: true
+
+module EML
+  module UK
+    class Payload
+      module ISO
+        private
+
+        def state=(state)
+          state_or_province(state, "state")
+        end
+
+        def province=(province)
+          state_or_province(province, "province")
+        end
+
+        def state_or_province(state, title)
+          if EML::STATES.include?(state) || state.nil?
+            instance_variable_set(:"@#{title}", state)
+            return
+          end
+
+          raise(
+            ArgumentError,
+            "Expected #{title} to be an uppercase ISO 3166-2 code " +
+            %(but received "#{state}".) + "\n" \
+            "Please see http://www.unece.org/cefact/locode/subdivisions.html"
+          )
+        end
+
+        def country=(country)
+          if EML::COUNTRIES.include?(country) || country.nil?
+            @country = country
+            return
+          end
+
+          raise(
+            ArgumentError,
+            "Expected country to be an uppercase ISO 3166-1 alpha-3 code " +
+              %(but received "#{country}".) + "\nPlease see " \
+              "https://unstats.un.org/unsd/tradekb/Knowledgebase/Country-Code"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/eml/uk/payload/location.rb

@@ -0,0 +1,30 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module UK
+    class Payload
+      class Location < ::EML::Payload
+        extend T::Sig
+        include ISO
+
+        private
+
+        sig { params(name: String).returns(String) }
+        attr_accessor :name
+
+        sig { params(address1: String).returns(String) }
+        attr_accessor :address1
+
+        sig { params(address2: String).returns(String) }
+        attr_accessor :address2
+
+        sig { params(city: String).returns(String) }
+        attr_accessor :city
+
+        sig { params(postal_code: String).returns(String) }
+        attr_accessor :postal_code
+      end
+    end
+  end
+end

data/lib/eml/uk/resources/agreement.rb

@@ -0,0 +1,32 @@
+# typed: strict
+# frozen_string_literal: true
+
+module EML
+  module UK
+    class Agreement < APIResource
+      ENDPOINT_BASE = T.let("agreements", String)
+
+      class << self
+        extend T::Sig
+
+        # Cardholder Agreement Lookup
+        # Look up the cardholder agreement URL for a card that has not been
+        # created
+        #
+        # @param payload [Hash] POST payload that conforms to
+        #   EML::UK::Payload::Agreement::Show
+        # @param params [Hash] URL query string parameters that conform to
+        #   EML::UK::Parameters::Agreement::Show
+        sig do
+          params(
+            payload: T::Hash[Symbol, T.untyped],
+            params: T::Hash[Symbol, T.untyped]
+          ).returns(EML::Response)
+        end
+        def show(payload: {}, params: {})
+          new.request(:post, payload: payload, params: params)
+        end
+      end
+    end
+  end
+end

data/lib/eml/uk/resources/card.rb

@@ -0,0 +1,181 @@
+# typed: strict
+# frozen_string_literal: true
+
+module EML
+  module UK
+    class Card < APIResource
+      ENDPOINT_BASE = T.let("cards", String)
+
+      class << self
+        extend T::Sig
+
+        # Activate a card
+        # Activation is a necessary first step but does not associate a person
+        # with the card; that requires registration
+        #
+        # @param id [String] Card identifier
+        # @param payload [Hash] POST payload that conforms to
+        #   EML::UK::Payload::Card::Activation
+        # @param params [Hash] URL query string parameters that conform to
+        #   EML::UK::Parameters::Card::Activation
+        sig do
+          params(
+            id: String,
+            payload: T::Hash[Symbol, T.untyped],
+            params: T::Hash[Symbol, T.untyped]
+          ).returns(EML::Response)
+        end
+        def activate(id:, payload:, params: {})
+          new(id: id).
+            request(:post, "activations", payload: payload, params: params)
+        end
+
+        # Register a card
+        # Registration is associating a person with an activated card
+        #
+        # @param id [String] Card identifier
+        # @param payload [Hash] POST payload that conforms to
+        #   EML::UK::Payload::Card::Register
+        # @param params [Hash] URL query string parameters that conform to
+        #   EML::UK::Parameters::Card::Register
+        sig do
+          params(
+            id: String,
+            payload: T::Hash[Symbol, T.untyped],
+            params: T::Hash[Symbol, T.untyped]
+          ).returns(EML::Response)
+        end
+        def register(id:, payload:, params: {})
+          new(id: id).
+            request(:post, "register", payload: payload, params: params)
+        end
+
+        # Retrieve card information
+        #
+        # @param id [String] Card identifier
+        # @param params [Hash] URL query string parameters that conform to
+        #   EML::UK::Parameters::Card::Info
+        sig do
+          params(id: String, params: T::Hash[Symbol, T.untyped]).
+            returns(EML::Response)
+        end
+        def show(id:, params: {})
+          new(id: id).request(:get, params: params)
+        end
+
+        # Access a card's transaction history
+        # The level of detail in this transaction history is relatively
+        # extensive and therefore would not be suitable for presentation to card
+        # holders
+        #
+        # @param id [String] Card identifier
+        # @param params [Hash] URL query string parameters that conform to
+        #   EML::UK::Parameters::Card::Transactions
+        sig do
+          params(
+            id: String,
+            params: T::Hash[Symbol, T.untyped]
+          ).returns(EML::Response)
+        end
+        def transactions(id:, params: {})
+          new(id: id).request(:get, "transactions", params: params)
+        end
+
+        # Reload a card
+        # Add funds onto an active card, provided the amount does not violate
+        # the existing regulations
+        #
+        # @param id [String] Card identifier
+        # @param payload [Hash] POST payload that conforms to
+        #   EML::UK::Payload::Card::Reload
+        # @param params [Hash] URL query string parameters that conform to
+        #   EML::UK::Parameters::Card::Reload
+        sig do
+          params(
+            id: String,
+            payload: T::Hash[Symbol, T.untyped],
+            params: T::Hash[Symbol, T.untyped]
+          ).returns(EML::Response)
+        end
+        def reload(id:, payload:, params: {})
+          new(id: id).
+            request(:post, "reloads", payload: payload, params: params)
+        end
+
+        # Unload a card
+        # Remove funds from a card
+        #
+        # @param id [String] Card identifier
+        # @param payload [Hash] POST payload that conforms to
+        #   EML::UK::Payload::Card::Unload
+        # @param params [Hash] URL query string parameters that conform to
+        #   EML::UK::Parameters::Card::Unload
+        sig do
+          params(
+            id: String,
+            payload: T::Hash[Symbol, T.untyped],
+            params: T::Hash[Symbol, T.untyped]
+          ).returns(EML::Response)
+        end
+        def unload(id:, payload:, params: {})
+          new(id: id).request(:post, "unload", payload: payload, params: params)
+        end
+
+        # Lock a card
+        #
+        # @param id [String] Card identifier
+        # @param payload [Hash] POST payload that conforms to
+        #   EML::UK::Payload::Card::Lock
+        # @param params [Hash] URL query string parameters that conform to
+        #   EML::UK::Parameters::Card::Lock
+        sig do
+          params(
+            id: String,
+            payload: T::Hash[Symbol, T.untyped],
+            params: T::Hash[Symbol, T.untyped]
+          ).returns(EML::Response)
+        end
+        def lock(id:, payload:, params: {})
+          new(id: id).request(:post, "locks", payload: payload, params: params)
+        end
+
+        # Unlock a card
+        #
+        # @param id [String] Card identifier
+        # @param payload [Hash] POST payload that conforms to
+        #   EML::UK::Payload::Card::Unlock
+        # @param params [Hash] URL query string parameters that conform to
+        #   EML::UK::Parameters::Card::Unlock
+        sig do
+          params(
+            id: String,
+            payload: T::Hash[Symbol, T.untyped],
+            params: T::Hash[Symbol, T.untyped]
+          ).returns(EML::Response)
+        end
+        def unlock(id:, payload:, params: {})
+          new(id: id).
+            request(:post, "unlocks", payload: payload, params: params)
+        end
+
+        # Void a card
+        #
+        # @param id [String] Card identifier
+        # @param payload [Hash] POST payload that conforms to
+        #   EML::UK::Payload::Card::Void
+        # @param params [Hash] URL query string parameters that conform to
+        #   EML::UK::Parameters::Card::Void
+        sig do
+          params(
+            id: String,
+            payload: T::Hash[Symbol, T.untyped],
+            params: T::Hash[Symbol, T.untyped]
+          ).returns(EML::Response)
+        end
+        def void(id:, payload:, params: {})
+          new(id: id).request(:post, "voids", payload: payload, params: params)
+        end
+      end
+    end
+  end
+end