eml 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 30ad0813939d2523225e35e0696d13fedacc43a17151257d979607fb89dc61e1
+  data.tar.gz: ffc2484a9269e9996d11e91ab308498ba33d1e8a6201a55fdda3c6145e2f339d
+SHA512:
+  metadata.gz: dd60379793b8c4e2ad4c266e46c102cd42713aa6f947da825e5e4d0f500a6d44adef6ff1ba01ff6117ff162b39d5bbfe27b6ef189e9a0d6d5dde8afc1831f35a
+  data.tar.gz: 1aee829d0b399f6809c92f30f6c22cfe9791ccf15374a222548877ef2bd8ccc1b58f40c82715cf9aa006c3fbcc679542b584ea5442b88eea2ae036213d103390

data/.editorconfig

@@ -0,0 +1,10 @@
+# see http://editorconfig.org/
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+insert_final_newline = true

data/.env.example

@@ -0,0 +1,6 @@
+UK_CARD_EXTERNAL_ID='ABCDEFGHIJKLM123'
+
+UK_REST_API_USERNAME='username'
+UK_REST_API_PASSWORD='password'
+UK_REST_API_MERCHANT_GROUP='tag'
+UK_REST_API_PROGRAM='tag'

data/.gitignore

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

data/.rspec

@@ -0,0 +1,5 @@
+--color
+--fail-fast
+--format documentation
+--profile
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,90 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.6.4
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/EndAlignment:
+  AutoCorrect: true
+  EnforcedStyleAlignWith: variable
+
+Layout/IndentFirstArrayElement:
+  EnforcedStyle: consistent
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - spec/**/*
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+RSpec/BeforeAfterAll:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 4
+
+RSpec/FilePath:
+  Enabled: false
+
+Security/Eval:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/LambdaCall:
+  Enabled: false
+
+Style/NegatedIf:
+  Enabled: false
+
+Style/OptionalArguments:
+  Exclude:
+    - lib/eml/error/**/*
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/Send:
+  Enabled: true
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrivialAccessors:
+  Exclude:
+    - lib/eml/uk/payload.rb
+    - lib/eml/uk/payload/**/*

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Declare your dependencies in eml.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2019- Morning Coffee Pty Ltd (https://morningcoffee.com.au)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+# EML API integration library for Ruby
+
+The EML API integration library provides convenient access to EML's REST Web
+Services and Transaction Notification Service for applications written in
+the Ruby language.
+
+Version 1 supports the UK APIs with Australian support coming as existing code
+is extracted.
+
+## Installation
+
+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"
+```
+
+If you are debugging or developing this gem and wish to use it within the
+context of an existing application, modify your Gemfile to read:
+
+```sh
+gem "eml", path: "../path_to_gem"
+```
+
+### Requirements
+
+- Ruby 2.6+ (untested in prior versions)
+
+## Usage
+
+Each geographical region is a separate module and will need to be configured
+with your supplied credentials.
+
+```ruby
+require "eml"
+
+EML::UK.configure do |config|
+  config.username = "username"
+  config.password = "password"
+  config.merchant_group = "merchant_id"
+  config.program = "program_id"
+end
+```
+
+Make sure you never commit your credentials to git. If you are using Ruby on
+Rails, it is usually best to keep your secrets in your
+[credentials file]: https://edgeguides.rubyonrails.org/security.html#custom-credentials
+
+## Development
+
+Since it is necessary to authenticate with EML to test API resources,
+credentials and a test card ID are required. The dotenv gem is loaded when tests
+are run and will look for a .env file in the root directory. A .env.example file
+has been supplied so you copy it to .env and replace the example values:
+
+```sh
+cp .env.example .env
+```
+
+The .env file has been added to the .gitignore list and should never been
+commited to the repository.
+
+Run all tests:
+
+```sh
+bundle exec rspec
+```
+
+Run a single test suite:
+
+```sh
+bundle exec rspec spec/path/to/file.rb
+```
+
+Run a single test, include the line number:
+
+```sh
+bundle exec rspec spec/path/to/file.rb:123
+```
+
+Please ensure that all changes have been run by the Rubocop before creating a
+pull request:
+
+```sh
+bundle exec rubocop
+```

data/eml.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+$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 " \
+    "Transaction Notification Serices"
+  s.author = "Morning Coffee"
+  s.email = "developers@morningcoffee.com.au"
+  s.homepage = "https://github.com/MorningCoffeeDev/eml_ruby"
+  s.license = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- test/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency "http", "~> 4.0.0"
+  s.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"
+end

data/lib/eml.rb

@@ -0,0 +1,22 @@
+# typed: strong
+# frozen_string_literal: true
+
+require "http"
+require "sorbet-runtime"
+
+module EML
+end
+
+require "eml/data/countries"
+require "eml/data/currencies"
+require "eml/data/states"
+
+require "eml/config"
+require "eml/environment"
+require "eml/error"
+require "eml/lib/endpoint_class"
+require "eml/parameters"
+require "eml/payload"
+require "eml/response"
+require "eml/uk"
+require "eml/version"

data/lib/eml/config.rb

@@ -0,0 +1,49 @@
+# typed: ignore
+# frozen_string_literal: true
+
+module EML
+  class Config
+    extend T::Sig
+
+    sig { returns(EML::Environment.class) }
+    def environment
+      EML::Environment
+    end
+
+    sig { params(value: Symbol).void }
+    def environment=(value)
+      EML::Environment.set(value)
+    end
+
+    sig { params(param: Symbol).returns(String) }
+    def require(param)
+      value = public_send(param)
+      return value unless value.nil? || value.empty?
+
+      require_error(param)
+    end
+
+    sig { params(param: Symbol).returns(String) }
+    def require_parameter(param)
+      require(param)
+    rescue ArgumentError => e
+      message = e.message + "\n" \
+        "Alternatively, you can pass dynamic values with your request " \
+        "parameters"
+      raise ArgumentError, message
+    end
+
+    private
+
+    sig { params(param: Symbol).void }
+    def require_error(param)
+      raise(
+        ArgumentError,
+        "#{param} is required but hasn't been set.\n" \
+          "EML::Config.configuration do |config|\n" +
+          %(  config.#{param} = "value") + "\n" \
+          "end"
+      )
+    end
+  end
+end

data/lib/eml/data/countries.rb

@@ -0,0 +1,260 @@
+# typed: strong
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/ModuleLength
+# rubocop:disable Style/AsciiComments
+module EML
+  COUNTRIES = T.let(
+    [
+      "ABW", # Aruba
+      "AFG", # Afghanistan
+      "AGO", # Angola
+      "AIA", # Anguilla
+      "ALA", # Åland Islands
+      "ALB", # Albania
+      "AND", # Andorra
+      "ANT", # Netherlands Antilles
+      "ARE", # United Arab Emirates
+      "ARG", # Argentina
+      "ARM", # Armenia
+      "ASM", # American Samoa
+      "ATA", # Antarctica
+      "ATF", # French Southern Territories
+      "ATG", # Antigua and Barbuda
+      "AUS", # Australia
+      "AUT", # Austria
+      "AZE", # Azerbaijan
+      "BDI", # Burundi
+      "BEL", # Belgium
+      "BEN", # Benin
+      "BFA", # Burkina Faso
+      "BGD", # Bangladesh
+      "BGR", # Bulgaria
+      "BHR", # Bahrain
+      "BHS", # Bahamas
+      "BIH", # Bosnia and Herzegovina
+      "BLM", # Saint Barthélemy
+      "BLR", # Belarus
+      "BLZ", # Belize
+      "BMU", # Bermuda
+      "BOL", # Bolivia, Plurinational State of
+      "BRA", # Brazil
+      "BRB", # Barbados
+      "BRN", # Brunei Darussalam
+      "BTN", # Bhutan
+      "BVT", # Bouvet Island
+      "BWA", # Botswana
+      "CAF", # Central African Republic
+      "CAN", # Canada
+      "CCK", # Cocos (Keeling) Islands
+      "CHE", # Switzerland
+      "CHL", # Chile
+      "CHN", # China
+      "CIV", # Côte d'Ivoire
+      "CMR", # Cameroon
+      "COD", # Congo, the Democratic Republic of the
+      "COG", # Congo
+      "COK", # Cook Islands
+      "COL", # Colombia
+      "COM", # Comoros
+      "CPV", # Cape Verde
+      "CRI", # Costa Rica
+      "CUB", # Cuba
+      "CXR", # Christmas Island
+      "CYM", # Cayman Islands
+      "CYP", # Cyprus
+      "CZE", # Czech Republic
+      "DEU", # Germany
+      "DJI", # Djibouti
+      "DMA", # Dominica
+      "DNK", # Denmark
+      "DOM", # Dominican Republic
+      "DZA", # Algeria
+      "ECU", # Ecuador
+      "EGY", # Egypt
+      "ERI", # Eritrea
+      "ESH", # Western Sahara
+      "ESP", # Spain
+      "EST", # Estonia
+      "ETH", # Ethiopia
+      "FIN", # Finland
+      "FJI", # Fiji
+      "FLK", # Falkland Islands (Malvinas)
+      "FRA", # France
+      "FRO", # Faroe Islands
+      "FSM", # Micronesia, Federated States of
+      "GAB", # Gabon
+      "GBR", # United Kingdom
+      "GEO", # Georgia
+      "GGY", # Guernsey
+      "GHA", # Ghana
+      "GIB", # Gibraltar
+      "GIN", # Guinea
+      "GLP", # Guadeloupe
+      "GMB", # Gambia
+      "GNB", # Guinea-Bissau
+      "GNQ", # Equatorial Guinea
+      "GRC", # Greece
+      "GRD", # Grenada
+      "GRL", # Greenland
+      "GTM", # Guatemala
+      "GUF", # French Guiana
+      "GUM", # Guam
+      "GUY", # Guyana
+      "HKG", # Hong Kong
+      "HMD", # Heard Island and McDonald Islands
+      "HND", # Honduras
+      "HRV", # Croatia
+      "HTI", # Haiti
+      "HUN", # Hungary
+      "IDN", # Indonesia
+      "IMN", # Isle of Man
+      "IND", # India
+      "IOT", # British Indian Ocean Territory
+      "IRL", # Ireland
+      "IRN", # Iran, Islamic Republic of
+      "IRQ", # Iraq
+      "ISL", # Iceland
+      "ISR", # Israel
+      "ITA", # Italy
+      "JAM", # Jamaica
+      "JEY", # Jersey
+      "JOR", # Jordan
+      "JPN", # Japan
+      "KAZ", # Kazakhstan
+      "KEN", # Kenya
+      "KGZ", # Kyrgyzstan
+      "KHM", # Cambodia
+      "KIR", # Kiribati
+      "KNA", # Saint Kitts and Nevis
+      "KOR", # Korea, Republic of
+      "KWT", # Kuwait
+      "LAO", # Lao People's Democratic Republic
+      "LBN", # Lebanon
+      "LBR", # Liberia
+      "LBY", # Libyan Arab Jamahiriya
+      "LCA", # Saint Lucia
+      "LIE", # Liechtenstein
+      "LKA", # Sri Lanka
+      "LSO", # Lesotho
+      "LTU", # Lithuania
+      "LUX", # Luxembourg
+      "LVA", # Latvia
+      "MAC", # Macao
+      "MAF", # Saint Martin (French part)
+      "MAR", # Morocco
+      "MCO", # Monaco
+      "MDA", # Moldova, Republic of
+      "MDG", # Madagascar
+      "MDV", # Maldives
+      "MEX", # Mexico
+      "MHL", # Marshall Islands
+      "MKD", # Macedonia, the former Yugoslav Republic of
+      "MLI", # Mali
+      "MLT", # Malta
+      "MMR", # Myanmar
+      "MNE", # Montenegro
+      "MNG", # Mongolia
+      "MNP", # Northern Mariana Islands
+      "MOZ", # Mozambique
+      "MRT", # Mauritania
+      "MSR", # Montserrat
+      "MTQ", # Martinique
+      "MUS", # Mauritius
+      "MWI", # Malawi
+      "MYS", # Malaysia
+      "MYT", # Mayotte
+      "NAM", # Namibia
+      "NCL", # New Caledonia
+      "NER", # Niger
+      "NFK", # Norfolk Island
+      "NGA", # Nigeria
+      "NIC", # Nicaragua
+      "NIU", # Niue
+      "NLD", # Netherlands
+      "NOR", # Norway
+      "NPL", # Nepal
+      "NRU", # Nauru
+      "NZL", # New Zealand
+      "OMN", # Oman
+      "PAK", # Pakistan
+      "PAN", # Panama
+      "PCN", # Pitcairn
+      "PER", # Peru
+      "PHL", # Philippines
+      "PLW", # Palau
+      "PNG", # Papua New Guinea
+      "POL", # Poland
+      "PRI", # Puerto Rico
+      "PRK", # Korea, Democratic People's Republic of
+      "PRT", # Portugal
+      "PRY", # Paraguay
+      "PSE", # Palestinian Territory, Occupied
+      "PYF", # French Polynesia
+      "QAT", # Qatar
+      "REU", # Réunion
+      "ROU", # Romania
+      "RUS", # Russian Federation
+      "RWA", # Rwanda
+      "SAU", # Saudi Arabia
+      "SDN", # Sudan
+      "SEN", # Senegal
+      "SGP", # Singapore
+      "SGS", # South Georgia and the South Sandwich Islands
+      "SHN", # Saint Helena, Ascension and Tristan da Cunha
+      "SJM", # Svalbard and Jan Mayen
+      "SLB", # Solomon Islands
+      "SLE", # Sierra Leone
+      "SLV", # El Salvador
+      "SMR", # San Marino
+      "SOM", # Somalia
+      "SPM", # Saint Pierre and Miquelon
+      "SRB", # Serbia
+      "STP", # Sao Tome and Principe
+      "SUR", # Suriname
+      "SVK", # Slovakia
+      "SVN", # Slovenia
+      "SWE", # Sweden
+      "SWZ", # Swaziland
+      "SYC", # Seychelles
+      "SYR", # Syrian Arab Republic
+      "TCA", # Turks and Caicos Islands
+      "TCD", # Chad
+      "TGO", # Togo
+      "THA", # Thailand
+      "TJK", # Tajikistan
+      "TKL", # Tokelau
+      "TKM", # Turkmenistan
+      "TLS", # Timor-Leste
+      "TON", # Tonga
+      "TTO", # Trinidad and Tobago
+      "TUN", # Tunisia
+      "TUR", # Turkey
+      "TUV", # Tuvalu
+      "TWN", # Taiwan, Province of China
+      "TZA", # Tanzania, United Republic of
+      "UGA", # Uganda
+      "UKR", # Ukraine
+      "UMI", # United States Minor Outlying Islands
+      "URY", # Uruguay
+      "USA", # United States
+      "UZB", # Uzbekistan
+      "VAT", # Holy See (Vatican City State)
+      "VCT", # Saint Vincent and the Grenadines
+      "VEN", # Venezuela, Bolivarian Republic of
+      "VGB", # Virgin Islands, British
+      "VIR", # Virgin Islands, U.S.
+      "VNM", # Viet Nam
+      "VUT", # Vanuatu
+      "WLF", # Wallis and Futuna
+      "WSM", # Samoa
+      "YEM", # Yemen
+      "ZAF", # South Africa
+      "ZMB", # Zambia
+      "ZWE", # Zimbabwe
+    ].freeze,
+    T::Array[String]
+  )
+end
+# rubocop:enable Metrics/ModuleLength
+# rubocop:enable Style/AsciiComments