defra_ruby_mocks 1.0.0 → 1.1.0

data/spec/examples.txt

@@ -1,30 +1,56 @@
-example_id                                                 | status | run_time        |
----------------------------------------------------------- | ------ | --------------- |
-./spec/defra_ruby_mocks_spec.rb[1:1:1]                     | passed | 0.00386 seconds |
-./spec/defra_ruby_mocks_spec.rb[1:2:1:1]                   | passed | 0.0002 seconds  |
-./spec/defra_ruby_mocks_spec.rb[1:2:2:1]                   | passed | 0.00229 seconds |
-./spec/lib/configuration_spec.rb[1:1:1:1]                  | passed | 0.00235 seconds |
-./spec/lib/configuration_spec.rb[1:1:2:1]                  | passed | 0.00021 seconds |
-./spec/lib/configuration_spec.rb[1:1:3:1]                  | passed | 0.00021 seconds |
-./spec/lib/configuration_spec.rb[1:1:4:1]                  | passed | 0.00018 seconds |
-./spec/lib/configuration_spec.rb[1:2:1:1]                  | passed | 0.00017 seconds |
-./spec/lib/configuration_spec.rb[1:2:2:1]                  | passed | 0.00016 seconds |
-./spec/lib/configuration_spec.rb[1:2:3:1]                  | passed | 0.00015 seconds |
-./spec/lib/configuration_spec.rb[1:2:4:1]                  | passed | 0.00012 seconds |
-./spec/requests/company_spec.rb[1:1:1:1]                   | passed | 0.06356 seconds |
-./spec/requests/company_spec.rb[1:1:2:1]                   | passed | 0.00938 seconds |
-./spec/requests/company_spec.rb[1:1:3:1:1]                 | passed | 0.00503 seconds |
-./spec/requests/company_spec.rb[1:1:3:2:1]                 | passed | 0.00478 seconds |
-./spec/requests/company_spec.rb[1:2:1]                     | passed | 0.01834 seconds |
-./spec/services/companies_house_service_spec.rb[1:1:1:1]   | passed | 0.0002 seconds  |
-./spec/services/companies_house_service_spec.rb[1:1:2:1:1] | passed | 0.0001 seconds  |
-./spec/services/companies_house_service_spec.rb[1:1:2:2:1] | passed | 0.00009 seconds |
-./spec/services/companies_house_service_spec.rb[1:1:2:3:1] | passed | 0.00012 seconds |
-./spec/services/companies_house_service_spec.rb[1:1:2:4:1] | passed | 0.00009 seconds |
-./spec/services/companies_house_service_spec.rb[1:1:2:5:1] | passed | 0.0001 seconds  |
-./spec/services/companies_house_service_spec.rb[1:1:2:6:1] | passed | 0.0001 seconds  |
-./spec/services/companies_house_service_spec.rb[1:1:2:7:1] | passed | 0.00013 seconds |
-./spec/services/companies_house_service_spec.rb[1:1:2:8:1] | passed | 0.00012 seconds |
-./spec/services/companies_house_service_spec.rb[1:1:2:9:1] | passed | 0.00012 seconds |
-./spec/services/companies_house_service_spec.rb[1:1:3:1:1] | passed | 0.00012 seconds |
-./spec/services/companies_house_service_spec.rb[1:1:3:2:1] | passed | 0.00015 seconds |
+example_id                                                    | status | run_time        |
+------------------------------------------------------------- | ------ | --------------- |
+./spec/defra_ruby_mocks_spec.rb[1:1:1]                        | passed | 0.00552 seconds |
+./spec/defra_ruby_mocks_spec.rb[1:2:1:1]                      | passed | 0.00013 seconds |
+./spec/defra_ruby_mocks_spec.rb[1:2:2:1]                      | passed | 0.00016 seconds |
+./spec/lib/configuration_spec.rb[1:1:1:1]                     | passed | 0.00009 seconds |
+./spec/lib/configuration_spec.rb[1:1:2:1]                     | passed | 0.00009 seconds |
+./spec/lib/configuration_spec.rb[1:1:3:1]                     | passed | 0.0001 seconds  |
+./spec/lib/configuration_spec.rb[1:1:4:1]                     | passed | 0.00008 seconds |
+./spec/lib/configuration_spec.rb[1:2:1:1]                     | passed | 0.00238 seconds |
+./spec/lib/configuration_spec.rb[1:2:2:1]                     | passed | 0.00009 seconds |
+./spec/lib/configuration_spec.rb[1:2:3:1]                     | passed | 0.0001 seconds  |
+./spec/lib/configuration_spec.rb[1:2:4:1]                     | passed | 0.00011 seconds |
+./spec/requests/company_spec.rb[1:1:1:1]                      | passed | 0.00478 seconds |
+./spec/requests/company_spec.rb[1:1:2:1]                      | passed | 0.065 seconds   |
+./spec/requests/company_spec.rb[1:1:3:1:1]                    | passed | 0.00475 seconds |
+./spec/requests/company_spec.rb[1:1:3:2:1]                    | passed | 0.01227 seconds |
+./spec/requests/company_spec.rb[1:2:1]                        | passed | 0.0137 seconds  |
+./spec/requests/worldpay_spec.rb[1:1:1:1:1]                   | passed | 0.02505 seconds |
+./spec/requests/worldpay_spec.rb[1:1:1:2:1]                   | passed | 0.00472 seconds |
+./spec/requests/worldpay_spec.rb[1:1:2:1:1]                   | passed | 0.00564 seconds |
+./spec/requests/worldpay_spec.rb[1:1:2:2:1:1]                 | passed | 0.00433 seconds |
+./spec/requests/worldpay_spec.rb[1:2:1:1]                     | passed | 0.00355 seconds |
+./spec/requests/worldpay_spec.rb[1:2:2:1]                     | passed | 0.00297 seconds |
+./spec/services/companies_house_service_spec.rb[1:1:1:1]      | passed | 0.00013 seconds |
+./spec/services/companies_house_service_spec.rb[1:1:2:1:1]    | passed | 0.00009 seconds |
+./spec/services/companies_house_service_spec.rb[1:1:2:2:1]    | passed | 0.00009 seconds |
+./spec/services/companies_house_service_spec.rb[1:1:2:3:1]    | passed | 0.00011 seconds |
+./spec/services/companies_house_service_spec.rb[1:1:2:4:1]    | passed | 0.00009 seconds |
+./spec/services/companies_house_service_spec.rb[1:1:2:5:1]    | passed | 0.00009 seconds |
+./spec/services/companies_house_service_spec.rb[1:1:2:6:1]    | passed | 0.00009 seconds |
+./spec/services/companies_house_service_spec.rb[1:1:2:7:1]    | passed | 0.0001 seconds  |
+./spec/services/companies_house_service_spec.rb[1:1:2:8:1]    | passed | 0.00009 seconds |
+./spec/services/companies_house_service_spec.rb[1:1:2:9:1]    | passed | 0.00009 seconds |
+./spec/services/companies_house_service_spec.rb[1:1:3:1:1]    | passed | 0.0001 seconds  |
+./spec/services/companies_house_service_spec.rb[1:1:3:2:1]    | passed | 0.00012 seconds |
+./spec/services/worldpay_request_service_spec.rb[1:1:1:1]     | passed | 0.00014 seconds |
+./spec/services/worldpay_request_service_spec.rb[1:1:2:1:1]   | passed | 0.00233 seconds |
+./spec/services/worldpay_request_service_spec.rb[1:1:2:1:2]   | passed | 0.00076 seconds |
+./spec/services/worldpay_request_service_spec.rb[1:1:2:1:3:1] | passed | 0.0005 seconds  |
+./spec/services/worldpay_request_service_spec.rb[1:1:2:1:3:2] | passed | 0.00047 seconds |
+./spec/services/worldpay_request_service_spec.rb[1:1:2:1:4:1] | passed | 0.0005 seconds  |
+./spec/services/worldpay_request_service_spec.rb[1:1:2:1:4:2] | passed | 0.0005 seconds  |
+./spec/services/worldpay_request_service_spec.rb[1:1:2:1:4:3] | passed | 0.00084 seconds |
+./spec/services/worldpay_request_service_spec.rb[1:1:2:1:5:1] | passed | 0.00056 seconds |
+./spec/services/worldpay_request_service_spec.rb[1:1:3:1]     | passed | 0.00032 seconds |
+./spec/services/worldpay_response_service_spec.rb[1:1:1:1:1]  | passed | 0.00076 seconds |
+./spec/services/worldpay_response_service_spec.rb[1:1:1:1:2]  | passed | 0.00083 seconds |
+./spec/services/worldpay_response_service_spec.rb[1:1:1:1:3]  | passed | 0.0009 seconds  |
+./spec/services/worldpay_response_service_spec.rb[1:1:1:1:4]  | passed | 0.00081 seconds |
+./spec/services/worldpay_response_service_spec.rb[1:1:1:2:1]  | passed | 0.00063 seconds |
+./spec/services/worldpay_response_service_spec.rb[1:1:2:1:1]  | passed | 0.02869 seconds |
+./spec/services/worldpay_response_service_spec.rb[1:1:2:1:2]  | passed | 0.0011 seconds  |
+./spec/services/worldpay_response_service_spec.rb[1:1:2:1:3]  | passed | 0.00111 seconds |
+./spec/services/worldpay_response_service_spec.rb[1:1:2:1:4]  | passed | 0.00138 seconds |
+./spec/services/worldpay_response_service_spec.rb[1:1:2:2:1]  | passed | 0.00091 seconds |

data/spec/fixtures/worldpay_request_invalid.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0"?>
+<!DOCTYPE paymentService PUBLIC "-//WorldPay/DTD WorldPay PaymentService v1/EN" "http://dtd.worldpay.com/paymentService_v1.dtd">
+<paymentService version="1.4">
+  <submit>
+  </submit>
+</paymentService>

data/spec/fixtures/worldpay_request_valid.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0"?>
+<!DOCTYPE paymentService PUBLIC "-//WorldPay/DTD WorldPay PaymentService v1/EN" "http://dtd.worldpay.com/paymentService_v1.dtd">
+<paymentService version="1.4" merchantCode="MERCHME">
+  <submit>
+    <order orderCode="1577726052">
+      <description>Your Waste Carrier Registration CBDU2</description>
+      <amount currencyCode="GBP" value="10500" exponent="2"/>
+      <orderContent>Waste Carrier Registration renewal: CBDU2 for Booth Mcdaniel Associates</orderContent>
+      <paymentMethodMask>
+        <include code="VISA-SSL"/>
+        <include code="MAESTRO-SSL"/>
+        <include code="ECMC-SSL"/>
+      </paymentMethodMask>
+      <shopper>
+        <shopperEmailAddress>vucij@example.com</shopperEmailAddress>
+      </shopper>
+      <billingAddress>
+        <address>
+          <firstName>Bell</firstName>
+          <lastName>Cruz</lastName>
+          <address1>HARMSEN GROUP DEANERY ROAD</address1>
+          <address2/>
+          <postalCode>BS1 5AH</postalCode>
+          <city>BRISTOL</city>
+          <countryCode>GB</countryCode>
+        </address>
+      </billingAddress>
+    </order>
+  </submit>
+</paymentService>

data/spec/requests/company_spec.rb

@@ -2,14 +2,14 @@
 
 require "rails_helper"
 
-module DefraRuby
+module DefraRubyMocks
   RSpec.describe "Company", type: :request do
+    after(:all) { Helpers::Configuration.reset_for_tests }
 
     let(:path) { "/defra_ruby_mocks/company" }
 
     context "when mocks are enabled" do
-      before(:all) { Helpers::Configuration.prep_for_tests }
-      after(:all) { Helpers::Configuration.reset_for_tests }
+      before(:each) { Helpers::Configuration.prep_for_tests }
 
       context "when the company number is 99999999 for not found" do
         let(:company_number) { "99999999" }

data/spec/requests/worldpay_spec.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+module DefraRubyMocks
+  RSpec.describe "Worldpay", type: :request do
+    after(:all) { Helpers::Configuration.reset_for_tests }
+
+    context "when mocks are enabled" do
+      before(:each) do
+        Helpers::Configuration.prep_for_tests
+        DefraRubyMocks.configure do |config|
+          config.worldpay_admin_code = "admincode1"
+          config.worldpay_mac_secret = "macsecret1"
+          config.worldpay_domain = "http://localhost:3000/defra_ruby_mocks"
+        end
+      end
+
+      context "#payments_service" do
+        let(:path) { "/defra_ruby_mocks/worldpay/payments-service" }
+
+        context "and the request is valid" do
+          let(:data) { File.read("spec/fixtures/worldpay_request_valid.xml") }
+
+          it "returns an XML response with a 200 code" do
+            get path, {}, "RAW_POST_DATA" => data
+
+            expect(response.content_type).to eq("application/xml")
+            expect(response.code).to eq("200")
+          end
+        end
+
+        context "and the request is invalid" do
+          let(:data) { File.read("spec/fixtures/worldpay_request_invalid.xml") }
+
+          it "returns a response with a 500 code" do
+            get path, {}, "RAW_POST_DATA" => data
+
+            expect(response.code).to eq("500")
+          end
+        end
+      end
+
+      context "#dispatcher" do
+        let(:relation) { double(:relation, first: registration) }
+        let(:registration) { double(:registration, finance_details: finance_details) }
+        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, order_code: "987654", total_amount: 105_00) }
+
+        let(:path) { "/defra_ruby_mocks/worldpay/dispatcher?successURL=#{CGI.escape(success_url)}" }
+
+        context "and the request is valid" do
+          let(:response_params) { "orderKey=admincode1^^987654&paymentStatus=AUTHORISED&paymentAmount=10500&paymentCurrency=GBP&mac=0ba5271e1ed1b26f9bb428ef7fb536a4&source=WP" }
+          let(:success_url) { "http://example.com/fo/12345/worldpay/success" }
+
+          it "redirects the user with a 300 code" do
+            expect(::WasteCarriersEngine::TransientRegistration).to receive(:where) { relation }
+
+            get path
+
+            expect(response).to redirect_to("#{success_url}?#{response_params}")
+            expect(response.code).to eq("302")
+          end
+        end
+
+        context "and the request is invalid" do
+          context "because the success url is not in a recognised format" do
+            let(:success_url) { "http://example.com/forthewin" }
+
+            it "returns a response with a 500 code" do
+              get path
+
+              expect(response.code).to eq("500")
+            end
+          end
+        end
+      end
+    end
+
+    context "when mocks are disabled" do
+      before(:each) { DefraRubyMocks.configuration.enable = false }
+
+      context "#payments_service" do
+        let(:path) { "/defra_ruby_mocks/worldpay/payments-service" }
+
+        it "cannot load the page" do
+          expect { get path }.to raise_error(ActionController::RoutingError)
+        end
+      end
+
+      context "#dispatcher" do
+        let(:path) { "/defra_ruby_mocks/worldpay/dispatcher" }
+
+        it "cannot load the page" do
+          expect { get path }.to raise_error(ActionController::RoutingError)
+        end
+      end
+    end
+  end
+end

data/spec/services/worldpay_request_service_spec.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+module DefraRubyMocks
+  RSpec.describe WorldpayRequestService do
+    describe ".run" do
+      after(:each) { Helpers::Configuration.reset_for_tests }
+
+      context "when the mocks config is missing a worldpay domain" do
+        it "raises a 'InvalidConfigError'" do
+          expect { described_class.run(nil) }.to raise_error InvalidConfigError
+        end
+      end
+
+      context "when the XML data is valid" do
+        before(:each) do
+          DefraRubyMocks.configure do |config|
+            config.worldpay_domain = "http://localhost:3000/defra_ruby_mocks"
+          end
+        end
+
+        let(:data) { File.read("spec/fixtures/worldpay_request_valid.xml") }
+
+        context "the result it returns" do
+          it "is a hash" do
+            expect(described_class.run(data)).to be_an_instance_of(Hash)
+          end
+
+          it "contains 4 values" do
+            result = described_class.run(data).length
+            expect(result).to eq(4)
+          end
+
+          context "has values extracted from the XML data" do
+            it "a merchant code" do
+              result = described_class.run(data)[:merchant_code]
+
+              expect(result).to eq("MERCHME")
+            end
+
+            it "an order code" do
+              result = described_class.run(data)[:order_code]
+
+              expect(result).to eq("1577726052")
+            end
+          end
+
+          context "has a generated ID which is" do
+            it "10 characters long" do
+              result = described_class.run(data)[:id]
+
+              expect(result.length).to eq(10)
+            end
+
+            it "only made up of the digits 0 to 9" do
+              result = described_class.run(data)[:id]
+
+              expect(result.scan(/\D/).empty?).to be_truthy
+            end
+
+            it "different each time" do
+              results = []
+              3.times do
+                results << described_class.run(data)[:id]
+              end
+
+              expect(results.uniq.length).to eq(results.length)
+            end
+          end
+
+          context "has a url" do
+            it "based on the configured domain, and extracted merchant and order codes" do
+              result = described_class.run(data)[:url]
+
+              expect(result).to eq("http://localhost:3000/defra_ruby_mocks/worldpay/dispatcher?OrderKey=MERCHME%5E1577726052")
+            end
+          end
+        end
+
+      end
+
+      context "when the data is invalid" do
+        let(:data) { File.read("spec/fixtures/worldpay_request_invalid.xml") }
+
+        it "raises an error" do
+          expect { described_class.run(data) }.to raise_error StandardError
+        end
+      end
+    end
+  end
+end

data/spec/services/worldpay_response_service_spec.rb

@@ -0,0 +1,146 @@
+# 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(::WasteCarriersEngine::TransientRegistration).to receive(:where) { relation }
+      allow(::WasteCarriersEngine::Registration).to receive(:where) { relation }
+    end
+
+    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(:registration) { double(:registration, finance_details: finance_details) }
+    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, order_code: order_code, total_amount: order_value) }
+
+    let(:mac) do
+      data = [
+        order_key,
+        order_value,
+        "GBP",
+        "AUTHORISED",
+        mac_secret
+      ]
+
+      Digest::MD5.hexdigest(data.join).to_s
+    end
+
+    let(:query_string) do
+      [
+        "orderKey=#{order_key}",
+        "paymentStatus=AUTHORISED",
+        "paymentAmount=#{order_value}",
+        "paymentCurrency=GBP",
+        "mac=#{mac}",
+        "source=WP"
+      ].join("&")
+    end
+
+    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" }
+
+        context "and is valid" do
+          let(:relation) { double(:relation, first: registration) }
+
+          it "can extract the reference from the `success_url`" do
+            described_class.run(success_url)
+
+            expect(::WasteCarriersEngine::TransientRegistration).to have_received(:where).with(token: reference)
+          end
+
+          it "can generate a valid order key" do
+            params = parse_for_params(described_class.run(success_url))
+
+            expect(params["orderKey"]).to eq(order_key)
+          end
+
+          it "can generate a valid mac" do
+            params = parse_for_params(described_class.run(success_url))
+
+            expect(params["mac"]).to eq(mac)
+          end
+
+          it "returns a url in the expected format" do
+            expected_response = "#{success_url}?#{query_string}"
+
+            expect(described_class.run(success_url)).to eq(expected_response)
+          end
+        end
+
+        context "but the registration does not exist" do
+          let(:relation) { double(:relation, first: nil) }
+
+          it "causes an error" do
+            expect { described_class.run(success_url) }.to raise_error MissingRegistrationError
+          end
+        end
+      end
+
+      context "when the request comes from the waste-carriers-frontend" do
+        before do
+          # The service will search transient registrations for a match first
+          # before then searching for the registration. Hence we need to stub
+          # `locate_transient_registration()` to allow the service to then
+          # call `locate_registration()`
+          allow_any_instance_of(described_class).to receive(:locate_transient_registration).and_return(nil)
+        end
+
+        let(:success_url) { "http://example.com/your-registration/#{reference}/worldpay/success/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
+            described_class.run(success_url)
+
+            expect(::WasteCarriersEngine::Registration).to have_received(:where).with(reg_uuid: reference)
+          end
+
+          it "can generate a valid order key" do
+            params = parse_for_params(described_class.run(success_url))
+
+            expect(params["orderKey"]).to eq(order_key)
+          end
+
+          it "can generate a valid mac" do
+            params = parse_for_params(described_class.run(success_url))
+
+            expect(params["mac"]).to eq(mac)
+          end
+
+          it "returns a url in the expected format" do
+            expected_response = "#{success_url}&#{query_string}"
+
+            expect(described_class.run(success_url)).to eq(expected_response)
+          end
+        end
+
+        context "but the registration does not exist" do
+          let(:relation) { double(:relation, first: nil) }
+
+          it "causes an error" do
+            expect { described_class.run(success_url) }.to raise_error MissingRegistrationError
+          end
+        end
+      end
+    end
+  end
+end