eml 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e01fb29821c0e3e1bb2b2ba438e5dfc662162a398d187904adf1a52725a11936
-  data.tar.gz: a7d4d70f1ad4e28f01b60df90fb5937205985f36b32f8c0d7cbf73895d2e306e
+  metadata.gz: c43c6dc3d86873574c0c3cf60f887df5770f6a900a1054c585bebe7117eb3592
+  data.tar.gz: 27d3f3b09e3fb03d2037f983aef3760b3f41c16a09510ddaad705bc1d922ae9a
 SHA512:
-  metadata.gz: edd3ebfb85dd29364c3e1942f49aac8417feb5bb99f4c6e14ece9f014e6d77de656838c9158077cda051f4581cc18c3e47861f334aaf10b3ae6ca8c4dd631338
-  data.tar.gz: b2f96353fce3d485aa5663ec73fd36d11884e9db5c3848f0c2700dd15a9051f0e4f312a34dc51a46bdf5b2945599134a28b7b72fb760f182567382ad1e2cb5e2
+  metadata.gz: 77d7ba1a43c24e0c706dad9e6cffce301a4c56a3e1d8427bb708f7543a024196c9378d2b9992e1753bdc1112b684e1d53a94233bd21b0878b5c2e64c0e060a48
+  data.tar.gz: aca4aee2a57275ca8d69c2f8c4391544eb3bcab6770693e0e4ef24d471e97eaea70edc433953b7722ea68e61061ef3458735d67da6080fe1ff87ac09b4360aae

data/.gitignore

@@ -1,5 +1,6 @@
 .env
 coverage
 Gemfile.lock
+pkg
 spec/examples.txt
 spec/vcr_cassettes

data/.rubocop.yml

@@ -4,6 +4,8 @@ require:
 
 AllCops:
   TargetRubyVersion: 2.6.4
+  Exclude:
+    - bin/**/*
 
 Layout/AlignParameters:
   EnforcedStyle: with_fixed_indentation

data/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/eml.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.homepage = "https://github.com/MorningCoffeeDev/eml_ruby"
   spec.license = "MIT"
 
-  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").
       reject { |f| f.match(%r{^(test|spec|features)/}) }
   end

data/lib/eml/error/rest.rb

@@ -16,27 +16,27 @@ module EML
     def initialize(message = nil, response = nil)
       super(message)
 
-      @response = T.let(response, EML::Response)
+      @response = T.let(response, T.nilable(EML::Response))
     end
 
-    sig { returns(String) }
+    sig { returns(T.nilable(String)) }
     def http_body
-      @response.error || @response.body.to_s
+      @response&.error || @response&.body&.to_s
     end
 
-    sig { returns(T::Hash[Symbol, String]) }
+    sig { returns(T.nilable(T::Hash[Symbol, String])) }
     def http_headers
-      @response.headers
+      @response&.headers
     end
 
-    sig { returns(Integer) }
+    sig { returns(T.nilable(Integer)) }
     def http_status
-      @response.status
+      @response&.http_status
     end
 
-    sig { returns(String) }
+    sig { returns(T.nilable(String)) }
     def url
-      @response.url.to_s
+      @response&.url&.to_s
     end
   end
 end

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

@@ -16,7 +16,7 @@ module EML
         ).returns(String)
       end
       def self.call(username, password, prefix: "")
-        new(username, password, prefix).call
+        new(username, password, prefix: prefix).call
       end
 
       sig do
@@ -26,10 +26,10 @@ module EML
           prefix: String
         ).void
       end
-      def initialize(username, password, prefix)
-        @username = username
-        @password = password
-        @prefix = prefix
+      def initialize(username, password, prefix: "")
+        @username = T.let(username, String)
+        @password = T.let(password, String)
+        @prefix = T.let(prefix, String)
       end
 
       sig { returns(String) }

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

@@ -8,7 +8,7 @@ module EML
 
       sig do
         params(
-          auth_token: String,
+          auth_token: T.nilable(String),
           username: String,
           password: String
         ).returns(T::Boolean)
@@ -19,15 +19,15 @@ module EML
 
       sig do
         params(
-          auth_token: String,
+          auth_token: T.nilable(String),
           username: String,
           password: String
         ).void
       end
       def initialize(auth_token, username, password)
-        @auth_token = auth_token
-        @username = username
-        @password = password
+        @auth_token = T.let(auth_token || "", String)
+        @username = T.let(username, String)
+        @password = T.let(password, String)
       end
 
       sig { returns(T::Boolean) }
@@ -40,6 +40,7 @@ module EML
 
       private
 
+      sig { returns(String) }
       def parse_auth_token
         @auth_token.sub(/^[^\s]+\s/, "")
       end

data/lib/eml/lib/constant_time_compare.rb

@@ -12,8 +12,8 @@ module EML
 
     sig { params(comparison: String, expected: String).void }
     def initialize(comparison, expected)
-      @comparison = comparison
-      @expected = expected
+      @comparison = T.let(comparison, String)
+      @expected = T.let(expected, String)
     end
 
     sig { returns(T::Boolean) }
@@ -22,8 +22,8 @@ module EML
 
       result = 0
 
-      Hash[[@comparison.bytes, @expected.bytes].transpose].
-        each { |x, y| result |= x ^ y }
+      transposed = [@comparison.bytes, @expected.bytes].transpose
+      Hash[transposed].each { |x, y| result |= x ^ y }
 
       result.zero?
     end

data/lib/eml/lib/endpoint_class.rb

@@ -5,6 +5,10 @@ module EML
   class EndpointClass
     extend T::Sig
 
+    sig do
+      params(class_type: String, resource_class: T.untyped, endpoint: String).
+        returns(T.untyped)
+    end
     def self.call(class_type:, resource_class:, endpoint:)
       new(
         class_type: class_type,
@@ -13,18 +17,25 @@ module EML
       ).call
     end
 
+    sig do
+      params(class_type: String, resource_class: T.untyped, endpoint: String).
+        void
+    end
     def initialize(class_type:, resource_class:, endpoint:)
-      @class_type = class_type
-      @resource_class = resource_class
-      @endpoint = endpoint
+      @class_type = T.let(class_type, String)
+      @resource_class = T.let(resource_class, T.untyped)
+      @endpoint = T.let(endpoint, String)
+      @class_name = T.let(nil, T.nilable(String))
     end
 
+    sig { returns(T.untyped) }
     def call
       Object.const_get(class_name) if Object.const_defined?(class_name)
     end
 
     private
 
+    sig { returns(String) }
     def class_name
       @class_name ||= begin
         name_parts = @resource_class.name.split("::")
@@ -35,6 +46,7 @@ module EML
       end
     end
 
+    sig { returns(String) }
     def action_class_name
       @endpoint.capitalize.sub(/s$/, "")
     end

data/lib/eml/lib/model_hash.rb

@@ -0,0 +1,54 @@
+# typed: strict
+# frozen_string_literal: true
+
+module EML
+  class ModelHash
+    extend T::Sig
+
+    sig { params(model: EML::Model).returns(T::Hash[Symbol, T.untyped]) }
+    def self.call(model)
+      new(model).call
+    end
+
+    sig { params(model: EML::Model).void }
+    def initialize(model)
+      @model = T.let(model, EML::Model)
+      @hash = T.let({}, T::Hash[Symbol, T.untyped])
+    end
+
+    sig { returns(T::Hash[Symbol, T.untyped]) }
+    def call
+      @model.class.enumerate_fields do |_, local_name|
+        value = @model.public_send(local_name)
+        add_value(local_name, value)
+      end
+
+      @hash
+    end
+
+    private
+
+    sig { params(name: Symbol, value: T.untyped).void }
+    def add_value(name, value)
+      @hash[name] = stored_value(value)
+    end
+
+    sig { params(value: T.untyped).returns(T.untyped) }
+    def stored_value(value)
+      if value.is_a?(Array)
+        array_value(value)
+      elsif value.respond_to?(:to_h)
+        value.to_h
+      else
+        value
+      end
+    end
+
+    sig { params(value: T::Array[T.untyped]).returns(T::Array[T.untyped]) }
+    def array_value(value)
+      value.each_with_object([]) do |item, array|
+        array << stored_value(item)
+      end
+    end
+  end
+end

data/lib/eml/model.rb

@@ -1,27 +1,52 @@
 # typed: true
 # frozen_string_literal: true
 
+require "json"
+
 module EML
   class Model
     extend T::Sig
+    extend T::Helpers
+    abstract!
 
+    sig do
+      params(
+        fields: T.any(T::Hash[String, T.untyped], T::Array[String])
+      ).void
+    end
     def self.fields(fields)
       const_set(:FIELDS, fields.freeze)
-      fields.each do |response_name, local_name|
-        local_name ||= response_name
+      enumerate_fields do |_, local_name|
         __send__(:attr_reader, :"#{local_name}")
       end
     end
 
+    sig { void }
+    def self.enumerate_fields
+      const_get(:FIELDS).each do |response_name, local_name|
+        local_name ||= response_name.to_sym
+        yield(response_name, local_name)
+      end
+    end
+
     sig { params(raw_values: T::Hash[String, T.untyped]).void }
     def initialize(raw_values)
-      self.class::FIELDS.each do |response_name, local_name|
-        local_name ||= response_name
+      self.class.enumerate_fields do |response_name, local_name|
         value = field_value(response_name, raw_values[response_name])
         instance_variable_set(:"@#{local_name}", value)
       end
     end
 
+    sig { returns(T::Hash[Symbol, T.untyped]) }
+    def to_h
+      ModelHash.(self)
+    end
+
+    sig { params(_args: T.nilable(Array)).returns(String) }
+    def to_json(*_args)
+      to_h.to_json
+    end
+
     protected
 
     sig { params(name: String, raw_value: T.untyped).returns(T.untyped) }

data/lib/eml/parameters.rb

@@ -24,7 +24,7 @@ module EML
           params: T::Hash[Symbol, T.untyped]
         ).returns(T.untyped)
       end
-      def self.convert(resource_class, endpoint, params)
+      def convert(resource_class, endpoint, params)
         endpoint_class = EML::EndpointClass.(
           class_type: ENDPOINT_CLASS_TYPE, resource_class: resource_class,
           endpoint: endpoint
@@ -112,6 +112,7 @@ module EML
 
     private
 
+    sig { params(array: T::Array[String]).returns(String) }
     def array_as_string(array)
       array.dup.tap { |vals| vals[-1] = "or #{vals.last}" }.join(", ")
     end

data/lib/eml/response.rb

@@ -84,7 +84,7 @@ module EML
 
     sig { returns(T.nilable(EML::RESTError)) }
     def check_for_incorrectly_categorised_errors
-      if error.match?(/is not in (the proper|a valid) status/)
+      if error&.match?(/is not in (the proper|a valid) status/)
         raise T.unsafe(EML::REST::UnprocessableEntityError).new(error, self)
       end
     end

data/lib/eml/uk/api_resource.rb

@@ -15,6 +15,7 @@ module EML
       def initialize(id: nil)
         @id = T.let(id, T.nilable(String))
         @headers = T.let(nil, T.nilable(T::Hash[String, String]))
+        @credentials = T.let(nil, T.nilable(T::Hash[Symbol, String]))
       end
 
       sig do
@@ -50,13 +51,13 @@ module EML
 
       private
 
-      sig { returns(T::Hash[Symbol, T.nilable(String)]) }
+      sig { returns(T::Hash[Symbol, String]) }
       def credentials
         @credentials ||= begin
           config = EML::UK.config
           {
-            username: config.rest_username,
-            password: config.rest_password,
+            username: config.rest_username || "",
+            password: config.rest_password || "",
           }
         end
       end
@@ -74,8 +75,8 @@ module EML
       def headers
         @headers ||= {
           "Authorization" => ::EML::BasicAuth::Generate.(
-            credentials[:username],
-            credentials[:password],
+            T.must(credentials[:username]),
+            T.must(credentials[:password]),
             prefix: "Basic "
           ),
         }

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

@@ -0,0 +1,22 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module UK
+    module Models
+      module TNS
+        class Card < ::EML::Model
+          fields(
+            "AvailableBalance" => :availableBalance,
+            "CarrierNumber" => :carrierNumber,
+            "ClientTrackingId" => :clientTrackingId,
+            "Currency" => :currency,
+            "ExternalId" => :externalId,
+            "Program" => :program,
+            "MerchantGroup" => :merchantGroup
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module UK
+    module Models
+      module TNS
+        class Message < ::EML::Model
+          extend T::Sig
+
+          fields("Transactions" => :transactions)
+
+          sig { params(raw_values: T::Hash[Symbol, T.untyped]).void }
+          def initialize(raw_values)
+            @transactions = raw_values[:Transactions].
+              each_with_object([]) do |raw_transaction, transactions|
+                transactions << EML::UK::Models::TNS::Transaction.
+                  new(raw_transaction)
+              end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module UK
+    module Models
+      module TNS
+        class Transaction < ::EML::Model
+          extend T::Sig
+
+          fields(
+            "AuthorizationRequestId" => :authorizationRequestId,
+            "Card" => :card,
+            "Cards" => :cards,
+            "EmlId" => :emlId,
+            "MerchantCategoryCode" => :merchantCategoryCode,
+            "MerchantCountry" => :merchantCountry,
+            "Note" => :note,
+            "OriginalTransactionDate" => :originalDate,
+            "PosTransactionTime" => :posTime,
+            "Reason" => :reason,
+            "Result" => :result,
+            "RetrievalReferenceNumber" => :retrievalReferenceNumber,
+            "TransactionAmount" => :amount,
+            "TransactionCurrency" => :currency,
+            "TransactionDescription" => :description,
+            "TransactionId" => :transactionId,
+            "TransactionLocation" => :location,
+            "TransactionTime" => :time
+          )
+
+          sig { params(raw_values: T::Hash[String, T.untyped]).void }
+          def initialize(raw_values)
+            super
+            initialize_cards
+          end
+
+          private
+
+          sig { void }
+          def initialize_cards
+            @card = Card.new(@card) unless @card.nil?
+            @cards = (@cards || []).each_with_object([]) do |card, cards|
+              cards << Card.new(card)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -38,7 +38,7 @@ module EML
         sig { params(field: String, raw_value: T.untyped).returns(T.untyped) }
         def field_value(field, raw_value)
           if field.match?(/date|time/)
-            EML::UK::ParseDate.(raw_value)
+            ::EML::UK::ParseDate.(raw_value)
           else
             raw_value
           end

data/lib/eml/uk/parameters.rb

@@ -27,7 +27,7 @@ module EML
         end
         def convert(resource_class, endpoint, params)
           endpoint_class = EML::UK::EndpointClass.(
-            class_type: self::ENDPOINT_CLASS_TYPE,
+            class_type: const_get(:ENDPOINT_CLASS_TYPE),
             resource_class: resource_class, endpoint: endpoint
           )
 
@@ -40,10 +40,13 @@ module EML
 
       protected
 
-      SEARCH_PARAMETER_OPTIONS = %w[
-        ActualCardNumber CarrierNumber ClientTrackingId ExternalId
-        PaymentTrackingID PrintText
-      ].freeze
+      SEARCH_PARAMETER_OPTIONS = T.let(
+        %w[
+          ActualCardNumber CarrierNumber ClientTrackingId ExternalId
+          PaymentTrackingID PrintText
+        ].freeze,
+        T::Array[String]
+      )
 
       sig { params(value: String).void }
       def validate_search_parameter(value)

data/lib/eml/uk/payload.rb

@@ -26,7 +26,7 @@ module EML
         end
         def convert(resource_class, endpoint, payload)
           endpoint_class = EML::UK::EndpointClass.(
-            class_type: self::ENDPOINT_CLASS_TYPE,
+            class_type: const_get(:ENDPOINT_CLASS_TYPE),
             resource_class: resource_class,
             endpoint: endpoint
           )

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

@@ -10,6 +10,16 @@ module EML
 
           field :count
 
+          sig { params(response: HTTP::Response, id: T.nilable(String)).void }
+          def initialize(response, id: nil)
+            super
+
+            @transactions = T.let(
+              nil,
+              T.nilable(T::Array[::EML::UK::Models::Transaction])
+            )
+          end
+
           sig { returns(T::Array[::EML::UK::Models::Transaction]) }
           def transactions
             @transactions ||= body["transactions"].

data/lib/eml/uk/tns/process_request.rb

@@ -11,7 +11,7 @@ module EML
           params(
             auth_token: String,
             parameters: T::Hash[Symbol, T.untyped]
-          ).returns(EML::UK::TNS::Response)
+          ).returns(EML::UK::Models::TNS::Message)
         end
         def self.call(auth_token, parameters)
           new(auth_token, parameters).call
@@ -24,14 +24,15 @@ module EML
           ).void
         end
         def initialize(auth_token, parameters)
-          @auth_token = auth_token
-          @parameters = parameters
+          @auth_token = T.let(auth_token, String)
+          @parameters = T.let(parameters, T::Hash[Symbol, T.untyped])
+          @credentials = T.let(nil, T.nilable(T::Hash[Symbol, T.untyped]))
         end
 
-        sig { returns(EML::UK::TNS::Response) }
+        sig { returns(EML::UK::Models::TNS::Message) }
         def call
           verify_auth_token
-          EML::UK::TNS::Response.new(@parameters)
+          EML::UK::Models::TNS::Message.new(@parameters)
         end
 
         private

data/lib/eml/uk/tns/response.rb

@@ -7,13 +7,27 @@ module EML
       class Response
         extend T::Sig
 
+        sig { returns(T::Array[EML::UK::Models::TNS::Transaction]) }
         attr_reader :transactions
 
         sig { params(response: T::Hash[Symbol, T.untyped]).void }
         def initialize(response)
-          @transactions = response[:Transactions].
+          @transactions = T.let(
+            model_transactions(response),
+            T::Array[EML::UK::Models::TNS::Transaction]
+          )
+        end
+
+        private
+
+        sig do
+          params(response: T::Hash[Symbol, T.untyped]).
+            returns(T::Array[EML::UK::Models::TNS::Transaction])
+        end
+        def model_transactions(response)
+          response[:Transactions].
             each_with_object([]) do |raw_transaction, transactions|
-              transactions << EML::UK::Models::TNSTransaction.
+              transactions << EML::UK::Models::TNS::Transaction.
                 new(raw_transaction)
             end
         end

data/lib/eml/uk.rb

@@ -12,8 +12,9 @@ require "eml/uk/config"
 require "eml/uk/lib/endpoint_class"
 require "eml/uk/lib/parse_date"
 
-require "eml/uk/models/tns_card"
-require "eml/uk/models/tns_transaction"
+require "eml/uk/models/tns/card"
+require "eml/uk/models/tns/message"
+require "eml/uk/models/tns/transaction"
 require "eml/uk/models/transaction"
 
 require "eml/uk/parameters"

data/lib/eml/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module EML
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/lib/eml.rb

@@ -30,6 +30,7 @@ require "eml/lib/basic_auth/generate"
 require "eml/lib/basic_auth/verify"
 require "eml/lib/constant_time_compare"
 require "eml/lib/endpoint_class"
+require "eml/lib/model_hash"
 
 require "eml/model"
 require "eml/parameters"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eml
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Morning Coffee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-18 00:00:00.000000000 Z
+date: 2019-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -260,6 +260,7 @@ files:
 - lib/eml/lib/basic_auth/verify.rb
 - lib/eml/lib/constant_time_compare.rb
 - lib/eml/lib/endpoint_class.rb
+- lib/eml/lib/model_hash.rb
 - lib/eml/model.rb
 - lib/eml/parameters.rb
 - lib/eml/payload.rb
@@ -269,8 +270,9 @@ files:
 - lib/eml/uk/config.rb
 - lib/eml/uk/lib/endpoint_class.rb
 - lib/eml/uk/lib/parse_date.rb
-- lib/eml/uk/models/tns_card.rb
-- lib/eml/uk/models/tns_transaction.rb
+- lib/eml/uk/models/tns/card.rb
+- lib/eml/uk/models/tns/message.rb
+- lib/eml/uk/models/tns/transaction.rb
 - lib/eml/uk/models/transaction.rb
 - lib/eml/uk/parameters.rb
 - lib/eml/uk/parameters/agreement/show.rb

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

@@ -1,20 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module EML
-  module UK
-    module Models
-      class TNSCard < ::EML::Model
-        fields(
-          "AvailableBalance" => :availableBalance,
-          "CarrierNumber" => :carrierNumber,
-          "ClientTrackingId" => :clientTrackingId,
-          "Currency" => :currency,
-          "ExternalId" => :externalId,
-          "Program" => :program,
-          "MerchantGroup" => :merchantGroup,
-        )
-      end
-    end
-  end
-end

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

@@ -1,49 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module EML
-  module UK
-    module Models
-      class TNSTransaction < ::EML::Model
-        extend T::Sig
-
-        fields(
-          "AuthorizationRequestId" => :authorizationRequestId,
-          "Card" => :card,
-          "Cards" => :cards,
-          "EmlId" => :emlId,
-          "MerchantCategoryCode" => :merchantCategoryCode,
-          "MerchantCountry" => :merchantCountry,
-          "Note" => :note,
-          "OriginalTransactionDate" => :originalDate,
-          "PosTransactionTime" => :posTime,
-          "Reason" => :reason,
-          "Result" => :result,
-          "RetrievalReferenceNumber" => :retrievalReferenceNumber,
-          "TransactionAmount" => :amount,
-          "TransactionCurrency" => :currency,
-          "TransactionDescription" => :description,
-          "TransactionId" => :transactionId,
-          "TransactionLocation" => :location,
-          "TransactionTime" => :time
-        )
-
-        sig { params(raw_values: T::Hash[String, T.untyped]).void }
-        def initialize(raw_values)
-          super
-          initialize_cards
-        end
-
-        private
-
-        sig { void }
-        def initialize_cards
-          @card = TNSCard.new(@card) unless @card.nil?
-          @cards = (@cards || []).each_with_object([]) do |card, cards|
-            cards << TNSCard.new(card)
-          end
-        end
-      end
-    end
-  end
-end