eml 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30ad0813939d2523225e35e0696d13fedacc43a17151257d979607fb89dc61e1
-  data.tar.gz: ffc2484a9269e9996d11e91ab308498ba33d1e8a6201a55fdda3c6145e2f339d
+  metadata.gz: e01fb29821c0e3e1bb2b2ba438e5dfc662162a398d187904adf1a52725a11936
+  data.tar.gz: a7d4d70f1ad4e28f01b60df90fb5937205985f36b32f8c0d7cbf73895d2e306e
 SHA512:
-  metadata.gz: dd60379793b8c4e2ad4c266e46c102cd42713aa6f947da825e5e4d0f500a6d44adef6ff1ba01ff6117ff162b39d5bbfe27b6ef189e9a0d6d5dde8afc1831f35a
-  data.tar.gz: 1aee829d0b399f6809c92f30f6c22cfe9791ccf15374a222548877ef2bd8ccc1b58f40c82715cf9aa006c3fbcc679542b584ea5442b88eea2ae036213d103390
+  metadata.gz: edd3ebfb85dd29364c3e1942f49aac8417feb5bb99f4c6e14ece9f014e6d77de656838c9158077cda051f4581cc18c3e47861f334aaf10b3ae6ca8c4dd631338
+  data.tar.gz: b2f96353fce3d485aa5663ec73fd36d11884e9db5c3848f0c2700dd15a9051f0e4f312a34dc51a46bdf5b2945599134a28b7b72fb760f182567382ad1e2cb5e2

data/.rubocop.yml

@@ -30,6 +30,7 @@ Lint/AmbiguousBlockAssociation:
 
 Metrics/BlockLength:
   Exclude:
+    - eml.gemspec
     - spec/**/*
 
 RSpec/BeforeAfterAll:

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at development@hashnotadam.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/README.md

@@ -13,7 +13,7 @@ You don't need this source code unless you want to modify the gem. If you just
 want to use the package, just include the following in your Gemfile:
 
 ```sh
-gem "eml", github: "MorningCoffeeDev/eml_ruby"
+gem "eml"
 ```
 
 If you are debugging or developing this gem and wish to use it within the
@@ -36,10 +36,13 @@ with your supplied credentials.
 require "eml"
 
 EML::UK.configure do |config|
-  config.username = "username"
-  config.password = "password"
+  config.rest_username = "username"
+  config.rest_password = "password"
   config.merchant_group = "merchant_id"
   config.program = "program_id"
+  config.search_parameter = "program_id"
+  config.tns_username = "username"
+  config.tns_password = "password"
 end
 ```
 

data/Rakefile

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

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "eml"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/eml.gemspec

@@ -4,34 +4,38 @@ $LOAD_PATH.unshift(::File.join(::File.dirname(__FILE__), "lib"))
 
 require "eml/version"
 
-Gem::Specification.new do |s|
-  s.name = "eml"
-  s.version = EML::VERSION
-  s.required_ruby_version = ">= 2.6.0"
-  s.summary = "Ruby bindings for the EML API"
-  s.description = "Connect to the EML payments APIs and " \
+Gem::Specification.new do |spec|
+  spec.name = "eml"
+  spec.version = EML::VERSION
+  spec.required_ruby_version = ">= 2.6.0"
+  spec.summary = "Ruby bindings for the EML API"
+  spec.description = "Connect to the EML payments APIs and " \
     "Transaction Notification Serices"
-  s.author = "Morning Coffee"
-  s.email = "developers@morningcoffee.com.au"
-  s.homepage = "https://github.com/MorningCoffeeDev/eml_ruby"
-  s.license = "MIT"
+  spec.author = "Morning Coffee"
+  spec.email = "developers@morningcoffee.com.au"
+  spec.homepage = "https://github.com/MorningCoffeeDev/eml_ruby"
+  spec.license = "MIT"
 
-  s.files = `git ls-files`.split("\n")
-  s.test_files = `git ls-files -- test/*`.split("\n")
-  s.require_paths = ["lib"]
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").
+      reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
 
-  s.add_dependency "http", "~> 4.0.0"
-  s.add_dependency "sorbet-runtime"
+  spec.add_dependency "http", "~> 4.0.0"
+  spec.add_dependency "sorbet-runtime"
 
-  s.add_development_dependency "dotenv"
-  s.add_development_dependency "faker"
-  s.add_development_dependency "pry-byebug"
-  s.add_development_dependency "rspec", "~> 3.8"
-  s.add_development_dependency "rubocop", "~> 0.71"
-  s.add_development_dependency "rubocop-performance"
-  s.add_development_dependency "rubocop-rspec"
-  s.add_development_dependency "simplecov"
-  s.add_development_dependency "sorbet"
-  s.add_development_dependency "vcr"
-  s.add_development_dependency "webmock"
+  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 "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 "vcr"
+  spec.add_development_dependency "webmock"
 end

data/lib/eml.rb

@@ -13,10 +13,28 @@ require "eml/data/states"
 
 require "eml/config"
 require "eml/environment"
+
 require "eml/error"
+require "eml/error/rest"
+require "eml/error/rest/authentication"
+require "eml/error/rest/bad_request"
+require "eml/error/rest/daily_funding_limit"
+require "eml/error/rest/forbidden"
+require "eml/error/rest/internal_server"
+require "eml/error/rest/not_found"
+require "eml/error/rest/unprocessable_entity"
+require "eml/error/tns"
+require "eml/error/tns/authentication"
+
+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/model"
 require "eml/parameters"
 require "eml/payload"
 require "eml/response"
-require "eml/uk"
 require "eml/version"
+
+require "eml/uk"

data/lib/eml/error.rb

@@ -14,12 +14,3 @@ module EML
     end
   end
 end
-
-require "eml/error/rest"
-require "eml/error/rest/authentication"
-require "eml/error/rest/bad_request"
-require "eml/error/rest/daily_funding_limit"
-require "eml/error/rest/forbidden"
-require "eml/error/rest/internal_server"
-require "eml/error/rest/not_found"
-require "eml/error/rest/unprocessable_entity"

data/lib/eml/error/tns.rb

@@ -0,0 +1,8 @@
+# typed: strict
+# frozen_string_literal: true
+
+module EML
+  # TNSError is the parent class for errors related to messages received on the
+  # Transaction Notificaiton Service
+  class TNSError < Error; end
+end

data/lib/eml/error/tns/authentication.rb

@@ -0,0 +1,17 @@
+# typed: strict
+# frozen_string_literal: true
+
+module EML
+  module TNS
+    class AuthenticationError < ::EML::TNSError
+      sig { params(message: T.nilable(String)).void }
+      def initialize(message = nil)
+        message ||= "An unexpected authorization token was supplied in the " \
+          "request. Please check that you have set the correct tns_username " \
+          "and tns_password in your config and that EML is using the same " \
+          "credentials. Failing this, it is possible you are being attacked"
+        super
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "base64"
+
+module EML
+  module BasicAuth
+    class Generate
+      extend T::Sig
+
+      sig do
+        params(
+          username: String,
+          password: String,
+          prefix: String
+        ).returns(String)
+      end
+      def self.call(username, password, prefix: "")
+        new(username, password, prefix).call
+      end
+
+      sig do
+        params(
+          username: String,
+          password: String,
+          prefix: String
+        ).void
+      end
+      def initialize(username, password, prefix)
+        @username = username
+        @password = password
+        @prefix = prefix
+      end
+
+      sig { returns(String) }
+      def call
+        token = Base64.encode64("#{@username}:#{@password}").tr("\n", "")
+        "#{@prefix}#{token}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# typed: strict
+# frozen_string_literal: true
+
+module EML
+  module BasicAuth
+    class Verify
+      extend T::Sig
+
+      sig do
+        params(
+          auth_token: String,
+          username: String,
+          password: String
+        ).returns(T::Boolean)
+      end
+      def self.call(auth_token, username, password)
+        new(auth_token, username, password).call
+      end
+
+      sig do
+        params(
+          auth_token: String,
+          username: String,
+          password: String
+        ).void
+      end
+      def initialize(auth_token, username, password)
+        @auth_token = auth_token
+        @username = username
+        @password = password
+      end
+
+      sig { returns(T::Boolean) }
+      def call
+        request_token = parse_auth_token
+        expected_token = Generate.(@username, @password)
+
+        ::EML::ConstantTimeCompare.(request_token, expected_token)
+      end
+
+      private
+
+      def parse_auth_token
+        @auth_token.sub(/^[^\s]+\s/, "")
+      end
+    end
+  end
+end

data/lib/eml/lib/constant_time_compare.rb

@@ -0,0 +1,31 @@
+# typed: strict
+# frozen_string_literal: true
+
+module EML
+  class ConstantTimeCompare
+    extend T::Sig
+
+    sig { params(comparison: String, expected: String).returns(T::Boolean) }
+    def self.call(comparison, expected)
+      new(comparison, expected).call
+    end
+
+    sig { params(comparison: String, expected: String).void }
+    def initialize(comparison, expected)
+      @comparison = comparison
+      @expected = expected
+    end
+
+    sig { returns(T::Boolean) }
+    def call
+      return false if @comparison.length != @expected.length
+
+      result = 0
+
+      Hash[[@comparison.bytes, @expected.bytes].transpose].
+        each { |x, y| result |= x ^ y }
+
+      result.zero?
+    end
+  end
+end

data/lib/eml/model.rb

@@ -0,0 +1,35 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  class Model
+    extend T::Sig
+
+    def self.fields(fields)
+      const_set(:FIELDS, fields.freeze)
+      fields.each do |response_name, local_name|
+        local_name ||= response_name
+        __send__(:attr_reader, :"#{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
+        value = field_value(response_name, raw_values[response_name])
+        instance_variable_set(:"@#{local_name}", value)
+      end
+    end
+
+    protected
+
+    sig { params(name: String, raw_value: T.untyped).returns(T.untyped) }
+    def field_value(name, raw_value)
+      return raw_value unless name.match?(/(Date|Time)$/)
+      return raw_value if raw_value.nil? || raw_value.empty?
+
+      Time.parse(raw_value)
+    end
+  end
+end