eml 1.0.0 → 2.0.0

data/lib/eml/parameters.rb

@@ -85,8 +85,11 @@ module EML
     end
 
     sig do
-      params(param_name: Symbol, param_value: String, allowed_values: T::Array[String]).
-        void
+      params(
+        param_name: Symbol,
+        param_value: String,
+        allowed_values: T::Array[String]
+      ).void
     end
     def validate_enum(param_name, param_value, allowed_values)
       return if allowed_values.include?(param_value)

data/lib/eml/uk.rb

@@ -12,7 +12,9 @@ require "eml/uk/config"
 require "eml/uk/lib/endpoint_class"
 require "eml/uk/lib/parse_date"
 
-require "eml/uk/model/transaction"
+require "eml/uk/models/tns_card"
+require "eml/uk/models/tns_transaction"
+require "eml/uk/models/transaction"
 
 require "eml/uk/parameters"
 require "eml/uk/parameters/agreement/show"
@@ -28,9 +30,7 @@ require "eml/uk/parameters/card/unlock"
 require "eml/uk/payload"
 require "eml/uk/payload/agreement/show"
 require "eml/uk/payload/iso"
-require "eml/uk/payload/contactentity"
 require "eml/uk/payload/location"
-require "eml/uk/payload/nil"
 require "eml/uk/payload/card/activation"
 require "eml/uk/payload/card/show"
 require "eml/uk/payload/card/lock"
@@ -49,3 +49,6 @@ require "eml/uk/responses/agreement/show"
 require "eml/uk/responses/card/reload"
 require "eml/uk/responses/card/show"
 require "eml/uk/responses/card/transaction"
+
+require "eml/uk/tns/process_request"
+require "eml/uk/tns/response"

data/lib/eml/uk/api_resource.rb

@@ -52,11 +52,13 @@ module EML
 
       sig { returns(T::Hash[Symbol, T.nilable(String)]) }
       def credentials
-        config = EML::UK.config
-        {
-          username: config.username,
-          password: config.password,
-        }
+        @credentials ||= begin
+          config = EML::UK.config
+          {
+            username: config.rest_username,
+            password: config.rest_password,
+          }
+        end
       end
 
       sig { returns(String) }
@@ -70,14 +72,13 @@ module EML
 
       sig { returns(T::Hash[String, String]) }
       def headers
-        @headers ||= { "Authorization" => "Basic #{base64_credentials}" }
-      end
-
-      sig { returns(String) }
-      def base64_credentials
-        username = credentials[:username]
-        password = credentials[:password]
-        Base64.encode64("#{username}:#{password}").tr("\n", "")
+        @headers ||= {
+          "Authorization" => ::EML::BasicAuth::Generate.(
+            credentials[:username],
+            credentials[:password],
+            prefix: "Basic "
+          ),
+        }
       end
 
       sig { params(endpoint: String).returns(T.class_of(EML::Response)) }

data/lib/eml/uk/config.rb

@@ -21,20 +21,26 @@ module EML
       extend T::Sig
 
       sig { returns(String) }
-      attr_accessor :username
+      attr_accessor :merchant_group
 
       sig { returns(String) }
-      attr_accessor :password
+      attr_accessor :program
 
       sig { returns(String) }
-      attr_accessor :merchant_group
+      attr_accessor :rest_username
 
       sig { returns(String) }
-      attr_accessor :program
+      attr_accessor :rest_password
 
       sig { returns(String) }
       attr_accessor :search_parameter
 
+      sig { returns(String) }
+      attr_accessor :tns_username
+
+      sig { returns(String) }
+      attr_accessor :tns_password
+
       private
 
       sig { params(param: Symbol).void }

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

@@ -0,0 +1,20 @@
+# 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

@@ -0,0 +1,49 @@
+# 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

data/lib/eml/uk/{model → models}/transaction.rb

@@ -3,9 +3,11 @@
 
 module EML
   module UK
-    class Model
-      class Transaction
-        FIELDS = %w[
+    module Models
+      class Transaction < ::EML::Model
+        extend T::Sig
+
+        fields(%w[
           acceptor_code
           acceptor_location
           activity
@@ -29,22 +31,13 @@ module EML
           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
+        protected
 
+        sig { params(field: String, raw_value: T.untyped).returns(T.untyped) }
         def field_value(field, raw_value)
-          if field.include?("time")
+          if field.match?(/date|time/)
             EML::UK::ParseDate.(raw_value)
           else
             raw_value

data/lib/eml/uk/parameters.rb

@@ -40,17 +40,6 @@ module EML
 
       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

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

@@ -72,16 +72,14 @@ module EML
             @fields = fields.join(",")
           end
 
-          sig { params(log_balance_inquiry: String).returns(String) }
+          sig { params(log_balance_inquiry: T::Boolean).returns(String) }
           def log_balance_inquiry=(log_balance_inquiry)
-            validate_boolean("log_balance_inquiry", log_balance_inquiry)
-            @log_balance_inquiry = log_balance_inquiry
+            @log_balance_inquiry = log_balance_inquiry.inspect
           end
 
-          sig { params(only_valid_status: String).returns(String) }
+          sig { params(only_valid_status: T::Boolean).returns(String) }
           def only_valid_status=(only_valid_status)
-            validate_boolean("only_valid_status", only_valid_status)
-            @only_valid_status = only_valid_status
+            @only_valid_status = only_valid_status.inspect
           end
 
           sig { params(program: String).returns(String) }

data/lib/eml/uk/payload.rb

@@ -40,17 +40,6 @@ module EML
 
       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)

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

@@ -19,17 +19,17 @@ module EML
           sig { params(developer: String).returns(String) }
           attr_accessor :developer
 
-          sig { params(is_account_expiry: String).returns(String) }
+          # rubocop:disable Naming/VariableName
+          sig { params(is_account_expiry: T::Boolean).returns(String) }
           def is_account_expiry=(is_account_expiry)
-            validate_boolean("is_account_expiry", is_account_expiry)
-            @Is_account_expiry = is_account_expiry
+            @Is_account_expiry = is_account_expiry.inspect
           end
 
-          sig { params(is_fee_free: String).returns(String) }
+          sig { params(is_fee_free: T::Boolean).returns(String) }
           def is_fee_free=(is_fee_free)
-            validate_boolean("is_fee_free", is_fee_free)
-            @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) }
           attr_accessor :merchant_group

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

@@ -10,11 +10,11 @@ module EML
 
           field :count
 
-          sig { returns(T::Array[::EML::UK::Model::Transaction]) }
+          sig { returns(T::Array[::EML::UK::Models::Transaction]) }
           def transactions
             @transactions ||= body["transactions"].
               each_with_object([]) do |transaction, array|
-                array << ::EML::UK::Model::Transaction.new(transaction)
+                array << ::EML::UK::Models::Transaction.new(transaction)
               end
           end
         end

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

@@ -0,0 +1,64 @@
+# typed: strict
+# frozen_string_literal: true
+
+module EML
+  module UK
+    module TNS
+      class ProcessRequest
+        extend T::Sig
+
+        sig do
+          params(
+            auth_token: String,
+            parameters: T::Hash[Symbol, T.untyped]
+          ).returns(EML::UK::TNS::Response)
+        end
+        def self.call(auth_token, parameters)
+          new(auth_token, parameters).call
+        end
+
+        sig do
+          params(
+            auth_token: String,
+            parameters: T::Hash[Symbol, T.untyped]
+          ).void
+        end
+        def initialize(auth_token, parameters)
+          @auth_token = auth_token
+          @parameters = parameters
+        end
+
+        sig { returns(EML::UK::TNS::Response) }
+        def call
+          verify_auth_token
+          EML::UK::TNS::Response.new(@parameters)
+        end
+
+        private
+
+        sig { void }
+        def verify_auth_token
+          valid = ::EML::BasicAuth::Verify.(
+            @auth_token,
+            credentials[:username],
+            credentials[:password]
+          )
+          return if valid == true
+
+          raise ::EML::TNS::AuthenticationError
+        end
+
+        sig { returns(T::Hash[Symbol, T.untyped]) }
+        def credentials
+          @credentials ||= begin
+            config = EML::UK.config
+            {
+              username: config.tns_username,
+              password: config.tns_password,
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# typed: strict
+# frozen_string_literal: true
+
+module EML
+  module UK
+    module TNS
+      class Response
+        extend T::Sig
+
+        attr_reader :transactions
+
+        sig { params(response: T::Hash[Symbol, T.untyped]).void }
+        def initialize(response)
+          @transactions = response[:Transactions].
+            each_with_object([]) do |raw_transaction, transactions|
+              transactions << EML::UK::Models::TNSTransaction.
+                new(raw_transaction)
+            end
+        end
+      end
+    end
+  end
+end

data/lib/eml/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eml
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Morning Coffee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-14 00:00:00.000000000 Z
+date: 2019-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -203,9 +231,13 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
 - README.md
+- Rakefile
+- bin/console
+- bin/setup
 - eml.gemspec
 - lib/eml.rb
 - lib/eml/config.rb
@@ -222,7 +254,13 @@ files:
 - lib/eml/error/rest/internal_server.rb
 - lib/eml/error/rest/not_found.rb
 - lib/eml/error/rest/unprocessable_entity.rb
+- lib/eml/error/tns.rb
+- lib/eml/error/tns/authentication.rb
+- lib/eml/lib/basic_auth/generate.rb
+- lib/eml/lib/basic_auth/verify.rb
+- lib/eml/lib/constant_time_compare.rb
 - lib/eml/lib/endpoint_class.rb
+- lib/eml/model.rb
 - lib/eml/parameters.rb
 - lib/eml/payload.rb
 - lib/eml/response.rb
@@ -231,7 +269,9 @@ files:
 - lib/eml/uk/config.rb
 - lib/eml/uk/lib/endpoint_class.rb
 - lib/eml/uk/lib/parse_date.rb
-- lib/eml/uk/model/transaction.rb
+- lib/eml/uk/models/tns_card.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
 - lib/eml/uk/parameters/card/activation.rb
@@ -254,7 +294,6 @@ files:
 - lib/eml/uk/payload/card/unload.rb
 - lib/eml/uk/payload/card/unlock.rb
 - lib/eml/uk/payload/card/void.rb
-- lib/eml/uk/payload/contactentity.rb
 - lib/eml/uk/payload/iso.rb
 - lib/eml/uk/payload/location.rb
 - lib/eml/uk/resources/agreement.rb
@@ -264,6 +303,8 @@ files:
 - lib/eml/uk/responses/card/reload.rb
 - lib/eml/uk/responses/card/show.rb
 - lib/eml/uk/responses/card/transaction.rb
+- lib/eml/uk/tns/process_request.rb
+- lib/eml/uk/tns/response.rb
 - lib/eml/version.rb
 - sorbet/config
 - sorbet/rbi/gems/addressable.rbi
@@ -305,14 +346,6 @@ files:
 - sorbet/rbi/sorbet-typed/lib/ruby/all/open3.rbi
 - sorbet/rbi/sorbet-typed/lib/ruby/all/resolv.rbi
 - sorbet/rbi/todo.rbi
-- spec/config_spec.rb
-- spec/helpers/config_helper.rb
-- spec/helpers/vcr_helper.rb
-- spec/spec_helper.rb
-- spec/uk/api_resource_spec.rb
-- spec/uk/resources/agreement_spec.rb
-- spec/uk/resources/card_spec.rb
-- spec/vcr_cassettes/.keep
 homepage: https://github.com/MorningCoffeeDev/eml_ruby
 licenses:
 - MIT