eml 2.1.8 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a0617a8e641936e3923260982484a3707482d132c318f5f0d6da992811b3693
-  data.tar.gz: 5080fa5753654f88cae6a5f01de76a2faacae8955b2efde7b4f42b1c139d1a54
+  metadata.gz: 761eb94e49a489e9d3d46c0c08e587ca35ac3f261844f41c86d9e53e82884d7f
+  data.tar.gz: 250769fefbdd1b167c9d96bbde90d6164c2eeab76b4ed3893a0b6263ea174c80
 SHA512:
-  metadata.gz: ceb2ac9432c63c085bc6bbe3276cd5692c4cd9be47ed5ba5f5bb68af6e9556380daebdb3ed561a1b0f81d305480a9e7c8f7d070bc2d1d25608fa1ffa52eedc9c
-  data.tar.gz: e069b2b8e00157f7fb1124e6b4514ebb3f5219354c79e15e86f26be50c2f99022b2517ca18acfc2aadb2f4df19213796838f86346853ad20d9c0a8e7a45db86b
+  metadata.gz: ea05e0d50c97d7b1383ca7ade24f062f5c3aacb897d240f962e570bf28a6bcb71b15857260bbfe49bac323653b8ba1c9387aa68adcc086b42c3868b35b974526
+  data.tar.gz: 29962159168a5362a3716c3c53f76461a8c2bfd9f11b3fee37d2ff5f0736ead077915b4374ae5b38979b0ee7120b06ea45d17dd3d1c512cbc2051b3017d2a96c

data/eml.gemspec

@@ -22,20 +22,20 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "http", ">= 4.0.0", "< 5.0"
+  spec.add_dependency "http", ">= 4.0.0", "< 6.0"
   spec.add_dependency "sorbet-runtime"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "dotenv"
   spec.add_development_dependency "faker"
   spec.add_development_dependency "pry-byebug"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.8"
   spec.add_development_dependency "rubocop", "~> 0.71"
   spec.add_development_dependency "rubocop-performance"
   spec.add_development_dependency "rubocop-rspec"
   spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "sorbet"
+  spec.add_development_dependency "sorbet", ">= 0.4.5036", "< 1.0"
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
 end

data/lib/eml/error/rest/internal_server.rb

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: strong
 # frozen_string_literal: true
 
 module EML

data/lib/eml/error/tns.rb

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: strong
 # frozen_string_literal: true
 
 module EML

data/lib/eml/lib/basic_auth/generate.rb

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: strong
 # frozen_string_literal: true
 
 require "base64"

data/lib/eml/lib/basic_auth/verify.rb

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: strong
 # frozen_string_literal: true
 
 module EML

data/lib/eml/lib/constant_time_compare.rb

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: false
 # frozen_string_literal: true
 
 module EML

data/lib/eml/parameters.rb

@@ -61,9 +61,12 @@ module EML
     sig { returns(T::Hash[Symbol, T.untyped]) }
     def to_h
       instance_variables.each_with_object({}) do |variable_name, params|
-        key = variable_name.to_s[1..-1].to_sym
+        key = T.must(variable_name.to_s[1..-1]).to_sym
         params[key] = instance_variable_get(variable_name)
-        params[key] = params[key].to_h if params[key].respond_to?(:to_h)
+
+        if !params[key].nil? && params[key].respond_to?(:to_h)
+          params[key] = params[key].to_h
+        end
       end
     end
 
@@ -98,7 +101,7 @@ module EML
 
     private
 
-    sig { params(array: T::Array[String]).returns(String) }
+    sig { params(array: T::Array[Symbol]).returns(String) }
     def array_as_string(array)
       array.dup.tap { |vals| vals[-1] = "or #{vals.last}" }.join(", ")
     end

data/lib/eml/payload.rb

@@ -62,7 +62,7 @@ module EML
     sig { returns(T::Hash[Symbol, T.untyped]) }
     def to_h
       instance_variables.each_with_object({}) do |variable_name, params|
-        key = variable_name.to_s[1..-1].to_sym
+        key = T.must(variable_name.to_s[1..-1]).to_sym
         params[key] = instance_variable_get(variable_name)
         params[key] = params[key].to_h if params[key].respond_to?(:to_h)
       end

data/lib/eml/response.rb

@@ -9,7 +9,7 @@ module EML
     def self.field(field_name)
       define_method(field_name) do
         string_name = field_name.to_s
-        body[string_name]
+        T.unsafe(self).body[string_name]
       end
     end
 

data/lib/eml/uk/models/tns/card.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strong
 # frozen_string_literal: true
 
 module EML

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

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module EML

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

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module EML
@@ -6,6 +6,7 @@ module EML
     class Parameters
       module Agreement
         class Show < ::EML::UK::Parameters
+          sig { params(params: T::Hash[T.untyped, T.untyped]).void }
           def initialize(params)
             params[:client_language] ||= "en"
             super
@@ -13,7 +14,7 @@ module EML
 
           private
 
-          sig { params(client_language: String).returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :client_language
         end
       end

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

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module EML
@@ -6,10 +6,10 @@ module EML
     class Parameters
       module Card
         class Activation < ::EML::UK::Parameters
-          REQUIRED_CONFIG = %i[program].freeze
-          OPTIONAL_CONFIG = %i[search_parameter].freeze
+          REQUIRED_CONFIG = T.let(%i[program].freeze, T::Array[Symbol])
+          OPTIONAL_CONFIG = T.let(%i[search_parameter].freeze, T::Array[Symbol])
 
-          sig { params(program: String).returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :program
 
           sig { params(search_parameter: String).returns(String) }

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

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module EML
@@ -6,12 +6,12 @@ module EML
     class Parameters
       module Card
         class Lock < ::EML::UK::Parameters
-          REQUIRED_CONFIG = %i[program].freeze
-          OPTIONAL_CONFIG = %i[search_parameter].freeze
+          REQUIRED_CONFIG = T.let(%i[program].freeze, T::Array[Symbol])
+          OPTIONAL_CONFIG = T.let(%i[search_parameter].freeze, T::Array[Symbol])
 
           private
 
-          sig { params(program: String).returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :program
 
           sig { params(search_parameter: String).returns(String) }

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

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module EML
@@ -6,10 +6,10 @@ module EML
     class Parameters
       module Card
         class Register < ::EML::UK::Parameters
-          REQUIRED_CONFIG = %i[program].freeze
-          OPTIONAL_CONFIG = %i[search_parameter].freeze
+          REQUIRED_CONFIG = T.let(%i[program].freeze, T::Array[Symbol])
+          OPTIONAL_CONFIG = T.let(%i[search_parameter].freeze, T::Array[Symbol])
 
-          sig { params(program: String).returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :program
 
           sig { params(search_parameter: String).returns(String) }

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

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module EML
@@ -6,10 +6,10 @@ module EML
     class Parameters
       module Card
         class Reload < ::EML::UK::Parameters
-          REQUIRED_CONFIG = %i[program].freeze
-          OPTIONAL_CONFIG = %i[search_parameter].freeze
+          REQUIRED_CONFIG = T.let(%i[program].freeze, T::Array[Symbol])
+          OPTIONAL_CONFIG = T.let(%i[search_parameter].freeze, T::Array[Symbol])
 
-          sig { params(program: String).returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :program
 
           sig { params(search_parameter: String).returns(String) }

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

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module EML
@@ -6,10 +6,10 @@ module EML
     class Parameters
       module Card
         class Show < ::EML::UK::Parameters
-          REQUIRED_CONFIG = %i[program].freeze
-          OPTIONAL_CONFIG = %i[search_parameter].freeze
+          REQUIRED_CONFIG = T.let(%i[program].freeze, T::Array[Symbol])
+          OPTIONAL_CONFIG = T.let(%i[search_parameter].freeze, T::Array[Symbol])
 
-          FIELDS_OPTIONS = %i[
+          FIELDS_OPTIONS = T.let(%i[
             account_expiration_date
             activating_merchant_group_name
             activating_merchant_group_uniquetag
@@ -59,7 +59,16 @@ module EML
             status
             uri
             unload_to_ach_fee
-          ].freeze
+          ].freeze, T::Array[Symbol])
+
+          sig { params(params: T::Hash[Symbol, T.untyped]).void }
+          def initialize(params)
+            super
+
+            @fields = T.let(nil, T.nilable(String))
+            @log_balance_inquiry = T.let(nil, T.nilable(String))
+            @only_valid_status = T.let(nil, T.nilable(String))
+          end
 
           sig { params(fields: T::Array[Symbol]).returns(String) }
           def fields=(fields)
@@ -82,7 +91,7 @@ module EML
             @only_valid_status = only_valid_status.inspect
           end
 
-          sig { params(program: String).returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :program
 
           sig { params(search_parameter: String).returns(String) }
@@ -91,7 +100,7 @@ module EML
             @search_parameter = search_parameter
           end
 
-          sig { params(security_code: String).returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :security_code
         end
       end

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

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module EML
@@ -6,12 +6,12 @@ module EML
     class Parameters
       module Card
         class Transaction < ::EML::UK::Parameters
-          REQUIRED_CONFIG = %i[program].freeze
-          OPTIONAL_CONFIG = %i[search_parameter].freeze
+          REQUIRED_CONFIG = T.let(%i[program].freeze, T::Array[Symbol])
+          OPTIONAL_CONFIG = T.let(%i[search_parameter].freeze, T::Array[Symbol])
 
           private
 
-          FIELDS_OPTIONS = %i[
+          FIELDS_OPTIONS = T.let(%i[
             activity
             amount
             authorization_request_id
@@ -28,7 +28,14 @@ module EML
             system_transaction_id
             timestamp
             user
-          ].freeze
+          ].freeze, T::Array[Symbol])
+
+          sig { params(params: T::Hash[Symbol, T.untyped]).void }
+          def initialize(params)
+            super
+
+            @fields = T.let(nil, T.nilable(String))
+          end
 
           sig { params(fields: T::Array[Symbol]).returns(String) }
           def fields=(fields)
@@ -41,10 +48,10 @@ module EML
             @fields = fields.join(",")
           end
 
-          sig { params(filter: String).returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :filter
 
-          sig { params(program: String).returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :program
 
           sig { params(search_parameter: String).returns(String) }

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

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module EML
@@ -6,12 +6,12 @@ module EML
     class Parameters
       module Card
         class Unload < ::EML::UK::Parameters
-          REQUIRED_CONFIG = %i[program].freeze
-          OPTIONAL_CONFIG = %i[search_parameter].freeze
+          REQUIRED_CONFIG = T.let(%i[program].freeze, T::Array[Symbol])
+          OPTIONAL_CONFIG = T.let(%i[search_parameter].freeze, T::Array[Symbol])
 
           private
 
-          sig { params(program: String).returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :program
 
           sig { params(search_parameter: String).returns(String) }

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

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module EML
@@ -6,12 +6,12 @@ module EML
     class Parameters
       module Card
         class Unlock < ::EML::UK::Parameters
-          REQUIRED_CONFIG = %i[program].freeze
-          OPTIONAL_CONFIG = %i[search_parameter].freeze
+          REQUIRED_CONFIG = T.let(%i[program].freeze, T::Array[Symbol])
+          OPTIONAL_CONFIG = T.let(%i[search_parameter].freeze, T::Array[Symbol])
 
           private
 
-          sig { params(program: String).returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :program
 
           sig { params(search_parameter: String).returns(String) }

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

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module EML
@@ -6,12 +6,12 @@ module EML
     class Parameters
       module Card
         class Unlock < ::EML::UK::Parameters
-          REQUIRED_CONFIG = %i[program].freeze
-          OPTIONAL_CONFIG = %i[search_parameter].freeze
+          REQUIRED_CONFIG = T.let(%i[program].freeze, T::Array[Symbol])
+          OPTIONAL_CONFIG = T.let(%i[search_parameter].freeze, T::Array[Symbol])
 
           private
 
-          sig { params(program: String).returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :program
 
           sig { params(search_parameter: String).returns(String) }

data/lib/eml/uk/parameters.rb

@@ -12,6 +12,9 @@ module EML
       def initialize(params)
         params = merge_required_config(params)
         params = merge_optional_config(params)
+
+        @search_parameter = T.let(nil, T.nilable(String))
+
         super
       end
 

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

@@ -1,25 +1,34 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
+# rubocop:disable Naming/VariableName
 module EML
   module UK
     class Payload
       module Agreement
         class Show < ::EML::UK::Payload
-          OPTIONAL_DEFAULTS = %i[merchant_group program].freeze
+          OPTIONAL_DEFAULTS =
+            T.let(%i[merchant_group program].freeze, T::Array[Symbol])
+
+          sig { params(payload: T::Hash[Symbol, T.untyped]).void }
+          def initialize(payload)
+            super
+
+            @Is_account_expiry = T.let(nil, T.nilable(String))
+            @Is_fee_free = T.let(nil, T.nilable(String))
+          end
 
           private
 
-          sig { params(bin: String).returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :bin
 
-          sig { params(country: String).returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :country
 
-          sig { params(developer: String).returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :developer
 
-          # rubocop:disable Naming/VariableName
           sig { params(is_account_expiry: T::Boolean).returns(String) }
           def is_account_expiry=(is_account_expiry)
             @Is_account_expiry = is_account_expiry.inspect
@@ -29,18 +38,18 @@ module EML
           def is_fee_free=(is_fee_free)
             @Is_fee_free = is_fee_free.inspect
           end
-          # rubocop:enable Naming/VariableName
 
-          sig { params(merchant_group: String).returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :merchant_group
 
-          sig { params(program: String).returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :program
 
-          sig { params(region: String).returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :region
         end
       end
     end
   end
 end
+# rubocop:enable Naming/VariableName

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

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module EML
@@ -6,26 +6,37 @@ module EML
     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
+          REQUIRED_VALUES = T.let(
+            %i[amount location.name location.country sales_channel].freeze,
+            T::Array[Symbol]
+          )
+          REQUIRED_CONFIG = T.let(%i[merchant_group].freeze, T::Array[Symbol])
+
+          sig { params(payload: T::Hash[Symbol, T.untyped]).void }
+          def initialize(payload)
+            super
+
+            @client_reference_number = T.let(nil, T.nilable(String))
+            @client_tracking_id = T.let(nil, T.nilable(String))
+            @location = T.let(nil, T.nilable(EML::UK::Payload::Location))
+          end
 
           private
 
-          sig { params(amount: Numeric).returns(Numeric) }
+          sig { returns(T.nilable(Numeric)) }
           attr_accessor :amount
 
-          sig { params(campaign: String).returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :campaign
 
-          sig { params(cardholder_user_id: String).returns(String) }
+          sig { returns(T.nilable(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) }
+          sig { returns(T.nilable(T.untyped)) }
           attr_accessor :client_order_date
 
           sig { params(client_reference_number: String).void }
@@ -40,7 +51,7 @@ module EML
           # 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) }
+          sig { returns(T.nilable(T.untyped)) }
           attr_accessor :client_time
 
           sig { params(client_tracking_id: String).void }
@@ -51,20 +62,20 @@ module EML
             @client_tracking_id = client_tracking_id
           end
 
-          sig { params(location: Hash).void }
+          sig { params(location: T::Hash[T.untyped, T.untyped]).void }
           def location=(location)
             @location = EML::UK::Payload::Location.new(location)
           end
 
-          sig { params(merchant_group: String).returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :merchant_group
 
-          sig { params(note: String).returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :note
 
-          SALES_CHANNELS = %w[Online InPerson].freeze
+          SALES_CHANNELS = T.let(%w[Online InPerson].freeze, T::Array[String])
 
-          sig { params(sales_channel: String).returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :sales_channel
         end
       end

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

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module EML
@@ -6,21 +6,28 @@ module EML
     class Payload
       module Card
         class Lock < ::EML::UK::Payload
-          REQUIRED_CONFIG = %i[merchant_group].freeze
-          REQUIRED_VALUES = %i[note reason].freeze
+          REQUIRED_CONFIG = T.let(%i[merchant_group].freeze, T::Array[Symbol])
+          REQUIRED_VALUES = T.let(%i[note reason].freeze, T::Array[Symbol])
+
+          sig { params(payload: T::Hash[Symbol, T.untyped]).void }
+          def initialize(payload)
+            super
+
+            @reason = T.let(nil, T.nilable(Symbol))
+          end
 
           private
 
-          sig { params(merchant_group: String).returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :merchant_group
 
-          sig { params(note: String).returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :note
 
-          REASONS = %i[
+          REASONS = T.let(%i[
             Damaged DataBreach Lost Miscellaneous OfficeError
             PastAccountExpirationDate Stolen UnclaimedProperty
-          ].freeze
+          ].freeze, T::Array[Symbol])
 
           sig { params(reason: Symbol).void }
           def reason=(reason)

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

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module EML
@@ -8,8 +8,26 @@ module EML
         class Register < ::EML::UK::Payload
           include ISO
 
-          REQUIRED_VALUES =
-            %i[first_name last_name address1 city country email].freeze
+          REQUIRED_VALUES = T.let(
+            %i[first_name last_name address1 city country email].freeze,
+            T::Array[Symbol]
+          )
+
+          # rubocop:disable Metrics/AbcSize
+          sig { params(payload: T::Hash[Symbol, T.untyped]).void }
+          def initialize(payload)
+            super
+
+            @first_name = T.let(nil, T.nilable(String))
+            @last_name = T.let(nil, T.nilable(String))
+            @address1 = T.let(nil, T.nilable(String))
+            @address2 = T.let(nil, T.nilable(String))
+            @city = T.let(nil, T.nilable(String))
+            @dob = T.let(nil, T.nilable(T.any(Date, String, Time)))
+            @email = T.let(nil, T.nilable(String))
+            @phone = T.let(nil, T.nilable(String))
+          end
+          # rubocop:enable Metrics/AbcSize
 
           private
 
@@ -62,7 +80,7 @@ module EML
             @phone = phone
           end
 
-          sig { params(postal_code: String).returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :postal_code
         end
       end