eml 1.0.0

data/sorbet/rbi/todo.rbi

@@ -0,0 +1,24 @@
+# This file is autogenerated. Do not edit it by hand. Regenerate it with:
+#   srb rbi todo
+
+# typed: strong
+module ::Anonymous_Delegator_4; end
+module ::Anonymous_Delegator_5; end
+module ::Anonymous_Delegator_9; end
+module T::Private::Methods::MethodHooks; end
+module T::Private::Methods::MethodHooks; end
+module T::Private::Methods::MethodHooks; end
+module T::Private::Methods::MethodHooks; end
+module T::Private::Methods::MethodHooks; end
+module T::Private::Methods::MethodHooks; end
+module T::Private::Methods::MethodHooks; end
+module T::Private::Methods::MethodHooks; end
+module T::Private::Methods::SingletonMethodHooks; end
+module T::Private::Methods::SingletonMethodHooks; end
+module T::Private::Methods::SingletonMethodHooks; end
+module T::Private::Methods::SingletonMethodHooks; end
+module T::Private::Methods::SingletonMethodHooks; end
+module T::Private::Methods::SingletonMethodHooks; end
+module T::Private::Methods::SingletonMethodHooks; end
+module T::Private::Methods::SingletonMethodHooks; end
+module T::Private::Methods::SingletonMethodHooks; end

data/spec/config_spec.rb

@@ -0,0 +1,26 @@
+# typed: ignore
+# frozen_string_literal: true
+
+RSpec.describe EML::Config do
+  let(:config) { described_class.new }
+
+  describe "#environment=" do
+    after { config.environment = :test }
+
+    it "sets the environment" do
+      expect { config.environment = :production }.to(
+        change(config.environment, :production?).from(false).to(true)
+      )
+    end
+
+    context "when in invalid environment is supplied" do
+      specify do
+        expect { config.environment = :invalid }.to raise_error(ArgumentError)
+      end
+
+      specify do
+        expect { config.environment = "production" }.to raise_error(TypeError)
+      end
+    end
+  end
+end

data/spec/helpers/config_helper.rb

@@ -0,0 +1,21 @@
+# typed: strict
+# frozen_string_literal: true
+
+module EML
+  module Helpers
+    module Config
+      extend T::Sig
+
+      sig { void }
+      def configure_uk
+        EML::UK.configure do |config|
+          config.username = ENV["UK_REST_API_USERNAME"]
+          config.password = ENV["UK_REST_API_PASSWORD"]
+          config.merchant_group = ENV["UK_REST_API_MERCHANT_GROUP"]
+          config.program = ENV["UK_REST_API_PROGRAM"]
+          config.search_parameter = ENV["UK_REST_API_SEARCH_PARAMETER"]
+        end
+      end
+    end
+  end
+end

data/spec/helpers/vcr_helper.rb

@@ -0,0 +1,19 @@
+# typed: true
+# frozen_string_literal: true
+
+module EML
+  module Helpers
+    module VCR
+      extend T::Sig
+
+      RE_RECORD_INTERVAL = T.let(86_400, Integer)
+
+      sig { params(path: String).void }
+      def self.with_cassette(path)
+        ::VCR.use_cassette(path, re_record_interval: RE_RECORD_INTERVAL) do
+          yield
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,120 @@
+# typed: ignore
+# frozen_string_literal: true
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+ENV["ENV"] = "test"
+
+require "simplecov"
+SimpleCov.start do
+  add_filter "/spec/"
+
+  add_group(
+    "API Operations", %w[lib/eml/api_operations.rb lib/eml/api_operation/]
+  )
+  add_group "UK", %w[lib/eml/uk.rb lib/eml/uk/]
+end
+
+require "date"
+require "dotenv/load"
+require "eml"
+require "faker"
+require "webmock/rspec"
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Some of the tests need to be run in order, for example activating and
+  # voiding a card can not be performed out of order
+  config.order = :defined
+end
+
+%w[helpers shared_examples].each do |directory|
+  Dir[File.dirname(__FILE__) + "/#{directory}/**/*.rb"].each { |f| require f }
+end
+
+require "vcr"
+VCR.configure do |config|
+  config.cassette_library_dir = "spec/vcr_cassettes"
+  config.hook_into :webmock
+end

data/spec/uk/api_resource_spec.rb

@@ -0,0 +1,39 @@
+# typed: ignore
+# frozen_string_literal: true
+
+RSpec.describe EML::UK::APIResource do
+  extend EML::Helpers::Config
+  configure_uk
+
+  describe ".request" do
+    context "when the credentials are wrong" do
+      before do
+        EML::UK.configure do |config|
+          config.username = "username"
+          config.password = "password"
+        end
+
+        allow(described_class).to receive(:const_get).with(:ENDPOINT_BASE).
+          and_return("cards")
+        allow(EML::UK::Payload).to receive(:convert).and_return({})
+        allow(EML::UK::Parameters).to receive(:convert).and_return({})
+      end
+
+      after do
+        EML::UK.configure do |config|
+          config.username = ENV["UK_REST_API_USERNAME"]
+          config.password = ENV["UK_REST_API_PASSWORD"]
+        end
+      end
+
+      let(:cassette) { "uk/api_resource/authentiction_error" }
+
+      it "raises an AuthenticationError" do
+        EML::Helpers::VCR.with_cassette(cassette) do
+          expect { described_class.new.request(:get, "") }.
+            to raise_error(EML::REST::AuthenticationError)
+        end
+      end
+    end
+  end
+end

data/spec/uk/resources/agreement_spec.rb

@@ -0,0 +1,23 @@
+# typed: ignore
+# frozen_string_literal: true
+
+RSpec.describe EML::UK::Agreement do
+  extend EML::Helpers::Config
+  configure_uk
+
+  describe ".show" do
+    it "gives an ok response" do
+      EML::Helpers::VCR.with_cassette("uk/agreement/show") do
+        response = described_class.show
+        expect(response.success?).to be true
+      end
+    end
+
+    it "retreives a URL" do
+      EML::Helpers::VCR.with_cassette("uk/agreement/show") do
+        response = described_class.show
+        expect(response.pdf_url.match?(%r{https://.+\.pdf})).to be true
+      end
+    end
+  end
+end

data/spec/uk/resources/card_spec.rb

@@ -0,0 +1,197 @@
+# typed: ignore
+# frozen_string_literal: true
+
+RSpec.describe EML::UK::Card do
+  extend EML::Helpers::Config
+  configure_uk
+
+  let(:card_id) { ENV["UK_CARD_EXTERNAL_ID"] }
+  let(:location) do
+    {
+      name: "Number 10",
+      address1: "10 Downing St",
+      city: "Westminster",
+      province: "LND",
+      postal_code: "SW1A 2AA",
+      country: "GBR",
+    }
+  end
+
+  describe ".activate" do
+    let(:payload) do
+      {
+        amount: 0,
+        location: location,
+        client_order_date: DateTime.now,
+        sales_channel: "Online",
+      }
+    end
+
+    # it "activates the card" do
+    #   EML::Helpers::VCR.with_cassette("uk/card/activation") do
+    #     response = described_class.activate(card_id, payload)
+    #     expect(response.success?).to be true
+    #   end
+    # end
+
+    context "when the card is already active" do
+      it "raises an UnprocessableEntityError" do
+        cassette = "uk/card/activation/unprocessable"
+        EML::Helpers::VCR.with_cassette(cassette) do
+          expect { described_class.activate(id: card_id, payload: payload) }.
+            to raise_error(EML::REST::UnprocessableEntityError)
+        end
+      end
+    end
+  end
+
+  describe ".register" do
+    let(:payload) do
+      location.delete(:name)
+      {
+        first_name: "Adam",
+        last_name: "Quitzon",
+        email: "not.an@ddress.fake",
+      }.merge(location)
+    end
+
+    it "registers the card" do
+      EML::Helpers::VCR.with_cassette("uk/card/register") do
+        response = described_class.register(id: card_id, payload: payload)
+        expect(response.success?).to be true
+      end
+    end
+
+    context "when the DOB is in the wrong format" do
+      it "raises an ArgumentError" do
+        payload[:dob] = "31012000"
+        cassette = "uk/card/register/dob"
+        EML::Helpers::VCR.with_cassette(cassette) do
+          expect { described_class.register(id: card_id, payload: payload) }.
+            to raise_error(ArgumentError)
+        end
+      end
+    end
+  end
+
+  describe ".reload" do
+    let(:payload) do
+      {
+        amount: 1.00,
+        location: location,
+      }
+    end
+
+    it "loads funds onto the card" do
+      EML::Helpers::VCR.with_cassette("uk/card/reload") do
+        response = described_class.reload(id: card_id, payload: payload)
+        expect(response.body["adjusted_balance"]).to eq(1)
+      end
+    end
+  end
+
+  describe ".show" do
+    it "gives an ok response" do
+      EML::Helpers::VCR.with_cassette("uk/card/show") do
+        response = described_class.show(id: card_id)
+        expect(response.success?).to be true
+      end
+    end
+
+    it "returns the information about the card" do
+      EML::Helpers::VCR.with_cassette("uk/card/show") do
+        response = described_class.show(id: card_id)
+        expect(response.body["actual_balance"]).to eq(1)
+      end
+    end
+  end
+
+  describe ".transactions" do
+    it "gives an ok response" do
+      EML::Helpers::VCR.with_cassette("uk/card/transactions") do
+        response = described_class.transactions(id: card_id)
+        expect(response.success?).to be true
+      end
+    end
+
+    it "get the transactions" do
+      EML::Helpers::VCR.with_cassette("uk/card/transactions") do
+        response = described_class.transactions(id: card_id)
+        expect(response.transactions.length).to be > 0
+      end
+    end
+  end
+
+  describe ".unload" do
+    let(:payload) do
+      {
+        amount: 1.00,
+        location: location,
+        note: "Unloading test",
+      }
+    end
+
+    it "removes funds from the card" do
+      EML::Helpers::VCR.with_cassette("uk/card/unload") do
+        response = described_class.unload(id: card_id, payload: payload)
+        expect(response.body["adjusted_balance"]).to eq(0)
+      end
+    end
+  end
+
+  describe ".lock" do
+    let(:payload) do
+      {
+        note: "Test suite",
+        reason: "Stolen",
+      }
+    end
+
+    it "locks the card" do
+      EML::Helpers::VCR.with_cassette("uk/card/lock") do
+        response = described_class.lock(id: card_id, payload: payload)
+        expect(response.success?).to be true
+      end
+    end
+
+    context "when the reason is invalid" do
+      before { payload[:reason] = "InvalidReason" }
+
+      it "raises an Argument error" do
+        expect { described_class.lock(id: card_id, payload: payload) }.
+          to raise_error(ArgumentError)
+      end
+    end
+
+    context "when the card is already locked" do
+      it "raises an UnprocessableEntityError" do
+        EML::Helpers::VCR.with_cassette("uk/card/lock/unprocessable") do
+          expect { described_class.lock(id: card_id, payload: payload) }.
+            to raise_error(EML::REST::UnprocessableEntityError)
+        end
+      end
+    end
+  end
+
+  describe ".unlock" do
+    let(:payload) do
+      { note: "Test suite" }
+    end
+
+    it "unlocks the card" do
+      EML::Helpers::VCR.with_cassette("uk/card/unlock") do
+        response = described_class.unlock(id: card_id, payload: payload)
+        expect(response.success?).to be true
+      end
+    end
+
+    context "when the card is already unlocked" do
+      it "raises an UnprocessableEntityError" do
+        EML::Helpers::VCR.with_cassette("uk/card/unlock/unprocessable") do
+          expect { described_class.unlock(id: card_id, payload: payload) }.
+            to raise_error(EML::REST::UnprocessableEntityError)
+        end
+      end
+    end
+  end
+end