defra_ruby_mocks 1.0.0 → 1.4.1

data/spec/services/worldpay_request_handler_service_spec.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+module DefraRubyMocks
+  RSpec.describe WorldpayRequestHandlerService do
+    describe ".run" do
+      context "when a request is made" do
+
+        let(:merchant_code) { "MERCHME" }
+        let(:args) { { merchant_code: merchant_code, xml: xml } }
+
+        context "and it's for a payment" do
+          before do
+            allow_any_instance_of(WorldpayPaymentService).to receive(:generate_id) { order_id }
+          end
+
+          let(:xml) { Nokogiri::XML(File.read("spec/fixtures/payment_request_valid.xml")) }
+          let(:order_id) { "1234567890" }
+          let(:request_type) { { request_type: :payment } }
+          let(:response_values) do
+            {
+              merchant_code: merchant_code,
+              order_code: "1577726052",
+              id: order_id,
+              url: "http://example.com"
+            }
+          end
+
+          it "correctly determines the request service to use" do
+            expect(WorldpayPaymentService).to receive(:run).with(args) { response_values }
+
+            described_class.run(xml)
+          end
+
+          it "returns the values the controller needs to handle the request" do
+            expect(WorldpayPaymentService).to receive(:run).with(args) { response_values }
+
+            expect(described_class.run(xml)).to eq(request_type.merge(response_values))
+          end
+        end
+
+        context "and it's for a refund" do
+          let(:xml) { Nokogiri::XML(File.read("spec/fixtures/refund_request_valid.xml")) }
+          let(:request_type) { { request_type: :refund } }
+          let(:response_values) do
+            {
+              merchant_code: merchant_code,
+              order_code: "1579644835",
+              refund_value: "2500",
+              currency_code: "GBP",
+              exponent: "2"
+            }
+          end
+
+          it "correctly determines the request service to use" do
+            expect(WorldpayRefundService).to receive(:run).with(args) { response_values }
+
+            described_class.run(xml)
+          end
+
+          it "returns the values the controller needs to handle the request" do
+            expect(WorldpayRefundService).to receive(:run).with(args) { response_values }
+
+            expect(described_class.run(xml)).to eq(request_type.merge(response_values))
+          end
+        end
+
+        context "but it's not recognised" do
+          let(:xml) { Nokogiri::XML(File.read("spec/fixtures/unrecognised_request.xml")) }
+
+          it "raises a 'UnrecognisedWorldpayRequestError'" do
+            expect { described_class.run(xml) }.to raise_error UnrecognisedWorldpayRequestError
+          end
+        end
+      end
+    end
+  end
+end

data/spec/services/worldpay_resource_service_spec.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+module DefraRubyMocks
+  RSpec.describe WorldpayResourceService do
+    before(:each) do
+      allow(::WasteCarriersEngine::TransientRegistration).to receive(:where) { transient_relation }
+      allow(::WasteCarriersEngine::Registration).to receive(:where) { registration_relation }
+    end
+
+    let(:reference) { "12345" }
+    let(:company_name) { "Pay for the thing" }
+
+    let(:resource) { double(:resource, finance_details: finance_details, company_name: company_name) }
+    let(:finance_details) { double(:finance_details, orders: orders) }
+    let(:orders) { double(:orders, order_by: sorted_orders) }
+    let(:sorted_orders) { double(:sorted_orders, first: order) }
+    let(:order) { double(:order) }
+
+    let(:args) { { reference: reference } }
+
+    describe ".run" do
+
+      context "when the resource is a TransientRegistration" do
+        let(:transient_relation) { double(:relation, first: resource) }
+
+        it "will only search transient registrations" do
+          described_class.run(args)
+
+          expect(::WasteCarriersEngine::TransientRegistration).to have_received(:where).with(token: reference)
+
+          expect(::WasteCarriersEngine::Registration).not_to have_received(:where).with(reg_uuid: reference)
+        end
+
+        it "returns an object with the matching resource" do
+          expect(described_class.run(args).resource).to eq(resource)
+        end
+
+        it "returns an object with the expected order" do
+          expect(described_class.run(args).order).to eq(order)
+        end
+
+        it "returns an object with the expected company name" do
+          expect(described_class.run(args).company_name).to eq(company_name.downcase)
+        end
+      end
+
+      context "when the resource is a Registration" do
+        let(:transient_relation) { double(:relation, first: nil) }
+        let(:registration_relation) { double(:relation, first: resource) }
+
+        it "will search transient registrations first, then registrations" do
+          described_class.run(args)
+
+          expect(::WasteCarriersEngine::TransientRegistration).to have_received(:where).with(token: reference)
+
+          expect(::WasteCarriersEngine::Registration).to have_received(:where).with(reg_uuid: reference)
+        end
+
+        it "returns an object with the matching resource" do
+          expect(described_class.run(args).resource).to eq(resource)
+        end
+
+        it "returns an object with the expected order" do
+          expect(described_class.run(args).order).to eq(order)
+        end
+
+        it "returns an object with the expected company name" do
+          expect(described_class.run(args).company_name).to eq(company_name.downcase)
+        end
+      end
+
+      context "when the resource is a OrderCopyCardsRegistration" do
+        before do
+          # Because we do not copy the company name to
+          # `OrderCopyCardsRegistration` instances when we create them in WCR
+          # we need to locate the orignal registration they are based on. We
+          # determine in the class if the 'resource' is an instance of one by
+          # comparing the result of resource.class.to_s to
+          # "WasteCarriersEngine::OrderCopyCardsRegistration". The problem is
+          # when testing 'resource' is actually an instance of
+          # `RSpec::Mocks::Double`! So we subvert the call to class on
+          # RSpec::Mocks::Double to return "WasteCarriersEngine::OrderCopyCardsRegistration"
+          # just in this spec. We can then test that the service does indeed
+          # locate the original registration for a company name
+          allow_any_instance_of(RSpec::Mocks::Double).to receive(:class)
+            .and_return("WasteCarriersEngine::OrderCopyCardsRegistration")
+        end
+
+        let(:copy_card_resource) { double(:resource, finance_details: finance_details, reg_identifier: "CBDU123") }
+        let(:transient_relation) { double(:relation, first: copy_card_resource) }
+        let(:registration_relation) { double(:relation, first: resource) }
+
+        it "locates the original registration to grab the company name" do
+          expect(described_class.run(args).company_name).to eq(company_name.downcase)
+
+          expect(::WasteCarriersEngine::Registration).to have_received(:where).with(reg_identifier: "CBDU123")
+        end
+      end
+
+      context "when the resource does not exist" do
+        let(:transient_relation) { double(:relation, first: nil) }
+        let(:registration_relation) { double(:relation, first: nil) }
+
+        it "causes an error" do
+          expect { described_class.run(args) }.to raise_error MissingResourceError
+        end
+      end
+    end
+  end
+end

data/spec/services/worldpay_response_service_spec.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+module DefraRubyMocks
+
+  RSpec.describe WorldpayResponseService do
+    before(:each) do
+      Helpers::Configuration.prep_for_tests
+      DefraRubyMocks.configure do |config|
+        config.worldpay_admin_code = admin_code
+        config.worldpay_merchant_code = merchant_code
+        config.worldpay_mac_secret = mac_secret
+      end
+
+      allow(WorldpayResourceService).to receive(:run) { resource }
+    end
+
+    let(:resource) { double(:resource, order: order, company_name: company_name.downcase) }
+
+    let(:admin_code) { "admincode1" }
+    let(:merchant_code) { "merchantcode1" }
+    let(:mac_secret) { "mac1" }
+    let(:reference) { "12345" }
+    let(:order_code) { "54321" }
+    let(:order_key) { "#{admin_code}^#{merchant_code}^#{order_code}" }
+    let(:order_value) { 105_00 }
+    let(:payment_status) { :AUTHORISED }
+    let(:company_name) { "Pay for the thing" }
+
+    let(:order) { double(:order, order_code: order_code, total_amount: order_value) }
+
+    let(:mac) do
+      data = [
+        order_key,
+        order_value,
+        "GBP",
+        payment_status,
+        mac_secret
+      ]
+
+      Digest::MD5.hexdigest(data.join).to_s
+    end
+
+    let(:query_string) do
+      [
+        "orderKey=#{order_key}",
+        "paymentStatus=#{payment_status}",
+        "paymentAmount=#{order_value}",
+        "paymentCurrency=GBP",
+        "mac=#{mac}",
+        "source=WP"
+      ].join("&")
+    end
+
+    let(:args) { { success_url: success_url, failure_url: failure_url } }
+
+    describe ".run" do
+      context "when the request comes from the waste-carriers-front-office" do
+        let(:success_url) { "http://example.com/fo/#{reference}/worldpay/success" }
+        let(:failure_url) { "http://example.com/fo/#{reference}/worldpay/failure" }
+
+        context "and is valid" do
+          let(:relation) { double(:relation, first: registration) }
+
+          it "can extract the reference from the `success_url`" do
+            expect(described_class.run(args).reference).to eq(reference)
+          end
+
+          it "can generate a valid order key" do
+            expect(described_class.run(args).order_key).to eq(order_key)
+          end
+
+          it "can generate a valid mac" do
+            expect(described_class.run(args).mac).to eq(mac)
+          end
+
+          context "and is for a successful payment" do
+            it "returns a url in the expected format" do
+              expected_response_url = "#{success_url}?#{query_string}"
+
+              expect(described_class.run(args).url).to eq(expected_response_url)
+            end
+          end
+
+          context "and is for a rejected payment" do
+            let(:payment_status) { :REFUSED }
+            let(:company_name) { "Reject for the thing" }
+
+            it "returns a url in the expected format" do
+              expected_response_url = "#{failure_url}?#{query_string}"
+
+              expect(described_class.run(args).url).to eq(expected_response_url)
+            end
+          end
+
+          context "and is for a stuck payment" do
+            let(:company_name) { "Give me a stuck thing" }
+
+            it "returns a status of :STUCK" do
+              expect(described_class.run(args).status).to eq(:STUCK)
+            end
+          end
+        end
+      end
+
+      context "when the request comes from the waste-carriers-frontend" do
+        let(:success_url) { "http://example.com/your-registration/#{reference}/worldpay/success/54321/NEWREG?locale=en" }
+        let(:failure_url) { "http://example.com/your-registration/#{reference}/worldpay/failure/54321/NEWREG?locale=en" }
+
+        context "and is valid" do
+          let(:relation) { double(:relation, first: registration) }
+
+          it "can extract the reference from the `success_url`" do
+            expect(described_class.run(args).reference).to eq(reference)
+          end
+
+          it "can generate a valid order key" do
+            expect(described_class.run(args).order_key).to eq(order_key)
+          end
+
+          it "can generate a valid mac" do
+            expect(described_class.run(args).mac).to eq(mac)
+          end
+
+          context "and is for a successful payment" do
+            it "returns a url in the expected format" do
+              expected_response_url = "#{success_url}&#{query_string}"
+
+              expect(described_class.run(args).url).to eq(expected_response_url)
+            end
+          end
+
+          context "and is for a rejected payment" do
+            let(:payment_status) { :REFUSED }
+            let(:company_name) { "Reject for the thing" }
+
+            it "returns a url in the expected format" do
+              expected_response_url = "#{failure_url}&#{query_string}"
+
+              expect(described_class.run(args).url).to eq(expected_response_url)
+            end
+          end
+
+          context "and is for a stuck payment" do
+            let(:company_name) { "Give me a stuck thing" }
+
+            it "returns a status of :STUCK" do
+              expect(described_class.run(args).status).to eq(:STUCK)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require "simplecov"
-SimpleCov.start
+# Require and run our simplecov initializer as the very first thing we do.
+# This is as per its docs https://github.com/colszowka/simplecov#getting-started
+require "./spec/support/simplecov"
 
 # This file was generated by the `rails generate rspec:install` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.

data/spec/support/helpers/configuration.rb

@@ -3,6 +3,7 @@
 module Helpers
   module Configuration
     def self.prep_for_tests(delay = 100)
+      DefraRubyMocks.reset_configuration
       DefraRubyMocks.configure do |config|
         config.enable = true
         config.delay = delay

data/spec/support/helpers/helpers.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+def parse_for_params(url)
+  query = URI.parse(url).query
+
+  params = {}
+  query.split("&").each do |param|
+    parts = param.split("=")
+    params[parts[0]] = parts[1]
+  end
+
+  params
+end

data/spec/support/helpers/waste_carriers_engine.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module WasteCarriersEngine
+  class Registration
+    def self.where(*); end
+  end
+  class TransientRegistration
+    def self.where(*); end
+  end
+end

data/spec/support/helpers/xml_matchers.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "rspec/expectations"
+
+RSpec::Matchers.define :be_xml do
+  match do
+    begin
+      Nokogiri::XML(actual, &:strict)
+
+      true
+    rescue Nokogiri::XML::SyntaxError
+      false
+    end
+  end
+
+  failure_message do |actual|
+    "expected that \"#{actual}\" would be a valid XML document"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defra_ruby_mocks
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Defra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-30 00:00:00.000000000 Z
+date: 2020-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.2.11.1
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.2
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: github_changelog_generator
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +112,16 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.1
 description: A Rails engine which can be used to mock external services when loaded
   into an application
 email:
@@ -107,14 +135,26 @@ files:
 - Rakefile
 - app/controllers/defra_ruby_mocks/application_controller.rb
 - app/controllers/defra_ruby_mocks/company_controller.rb
+- app/controllers/defra_ruby_mocks/worldpay_controller.rb
 - app/services/defra_ruby_mocks/base_service.rb
 - app/services/defra_ruby_mocks/companies_house_service.rb
+- app/services/defra_ruby_mocks/worldpay_payment_service.rb
+- app/services/defra_ruby_mocks/worldpay_refund_service.rb
+- app/services/defra_ruby_mocks/worldpay_request_handler_service.rb
+- app/services/defra_ruby_mocks/worldpay_resource_service.rb
+- app/services/defra_ruby_mocks/worldpay_response_service.rb
 - app/views/defra_ruby_mocks/company/not_found.json.erb
 - app/views/defra_ruby_mocks/company/show.json.erb
+- app/views/defra_ruby_mocks/worldpay/payment_request.xml.erb
+- app/views/defra_ruby_mocks/worldpay/refund_request.xml.erb
+- app/views/defra_ruby_mocks/worldpay/stuck.html.erb
 - config/routes.rb
 - lib/defra_ruby_mocks.rb
 - lib/defra_ruby_mocks/configuration.rb
 - lib/defra_ruby_mocks/engine.rb
+- lib/defra_ruby_mocks/invalid_config_error.rb
+- lib/defra_ruby_mocks/missing_resource_error.rb
+- lib/defra_ruby_mocks/unrecognised_worldpay_request_error.rb
 - lib/defra_ruby_mocks/version.rb
 - lib/tasks/changelog.rake
 - lib/tasks/defra_ruby_mocks_tasks.rake
@@ -156,12 +196,26 @@ files:
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/examples.txt
+- spec/fixtures/payment_request_invalid.xml
+- spec/fixtures/payment_request_valid.xml
+- spec/fixtures/refund_request_invalid.xml
+- spec/fixtures/refund_request_valid.xml
+- spec/fixtures/unrecognised_request.xml
 - spec/lib/configuration_spec.rb
 - spec/rails_helper.rb
 - spec/requests/company_spec.rb
+- spec/requests/worldpay_spec.rb
 - spec/services/companies_house_service_spec.rb
+- spec/services/worldpay_payment_service_spec.rb
+- spec/services/worldpay_refund_service_spec.rb
+- spec/services/worldpay_request_handler_service_spec.rb
+- spec/services/worldpay_resource_service_spec.rb
+- spec/services/worldpay_response_service_spec.rb
 - spec/spec_helper.rb
 - spec/support/helpers/configuration.rb
+- spec/support/helpers/helpers.rb
+- spec/support/helpers/waste_carriers_engine.rb
+- spec/support/helpers/xml_matchers.rb
 - spec/support/pry.rb
 - spec/support/simplecov.rb
 homepage: https://github.com/DEFRA/defra-ruby-mocks
@@ -183,8 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.0
 signing_key: 
 specification_version: 4
 summary: Defra Ruby on Rails external API mocking engine
@@ -229,9 +282,23 @@ test_files:
 - spec/examples.txt
 - spec/defra_ruby_mocks_spec.rb
 - spec/requests/company_spec.rb
+- spec/requests/worldpay_spec.rb
 - spec/support/simplecov.rb
 - spec/support/pry.rb
+- spec/support/helpers/helpers.rb
+- spec/support/helpers/xml_matchers.rb
 - spec/support/helpers/configuration.rb
+- spec/support/helpers/waste_carriers_engine.rb
 - spec/lib/configuration_spec.rb
+- spec/fixtures/unrecognised_request.xml
+- spec/fixtures/payment_request_invalid.xml
+- spec/fixtures/refund_request_valid.xml
+- spec/fixtures/payment_request_valid.xml
+- spec/fixtures/refund_request_invalid.xml
 - spec/rails_helper.rb
+- spec/services/worldpay_response_service_spec.rb
+- spec/services/worldpay_resource_service_spec.rb
 - spec/services/companies_house_service_spec.rb
+- spec/services/worldpay_payment_service_spec.rb
+- spec/services/worldpay_refund_service_spec.rb
+- spec/services/worldpay_request_handler_service_spec.rb