defra_ruby_mocks 2.3.0 → 2.3.3

data/spec/requests/govpay_spec.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+module DefraRubyMocks
+  RSpec.describe "Govpay", 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.govpay_domain = "http://localhost:3000/defra_ruby_mocks"
+        end
+
+      end
+
+      context "#create_payment" do
+        let(:path) { "/defra_ruby_mocks/govpay/v1/payments" }
+        # Use an example from the Govpay documentation
+        let(:payment_request) do
+          {
+            amount: 14_500,
+            reference: "12345",
+            description: "Pay your council tax",
+            return_url: "https://your.service.gov.uk/completed"
+          }
+        end
+
+        context "when the request is valid" do
+
+          it "returns a valid success response" do
+            post path, params: payment_request.as_json
+
+            expect(response.media_type).to eq("application/json")
+            expect(response.code).to eq("200")
+            response_json = JSON.parse(response.body)
+            expect(response_json["reference"]).to eq payment_request[:reference]
+            expect(response_json["amount"]).to eq payment_request[:amount]
+            expect(response_json["description"]).to eq payment_request[:description]
+            expect(response_json["_links"]["next_url"]["href"]).to eq payment_request[:return_url]
+          end
+
+          it "enqueues a job to perform the payment callback" do
+            ActiveJob::Base.queue_adapter = :test
+            expect { post path, params: payment_request.as_json }.to have_enqueued_job(GovpayPaymentCallbackJob)
+          end
+        end
+
+        context "when the request is missing a mandatory parameter" do
+          before { payment_request[:amount] = nil }
+
+          it "returns a HTTP 500 responseß" do
+            post path, params: payment_request.as_json
+
+            expect(response.code).to eq "500"
+          end
+        end
+      end
+
+      describe "#payment_details" do
+        let(:path) { "/defra_ruby_mocks/govpay/v1/payments/#{payment_id}" }
+
+        context "when the payment id is valid" do
+          before do
+            allow(GovpayGetPaymentService).to receive(:run)
+              .with(payment_id)
+              .and_return(JSON.parse(File.read("spec/fixtures/files/govpay/get_payment_response_success.json")))
+          end
+
+          let(:payment_id) { "12345678901234567890123456" }
+
+          it "returns a valid success response" do
+            get path
+
+            expect(response.code).to eq "200"
+          end
+        end
+
+        context "when the payment id is not valid" do
+          before do
+            allow(GovpayGetPaymentService).to receive(:run)
+              .with(payment_id)
+              .and_return(JSON.parse(File.read("spec/fixtures/files/govpay/get_payment_response_error.json")))
+          end
+
+          let(:payment_id) { "0" }
+
+          it "returns a 422 response" do
+            get path
+
+            expect(response.code).to eq "422"
+          end
+        end
+      end
+    end
+
+    context "when mocks are disabled" do
+      before(:each) { DefraRubyMocks.configuration.enable = false }
+      let(:payment_id) { Faker::Alphanumeric.alphanumeric(number: 26) }
+
+      context "POST #govpay_payments" do
+        let(:path) { "/defra_ruby_mocks/govpay/payments" }
+
+        it "cannot load the page" do
+          expect { post path }.to raise_error(ActionController::RoutingError)
+        end
+      end
+
+      context "GET #govpay_payments" do
+        let(:path) { "/defra_ruby_mocks/govpay/payments/#{payment_id}" }
+
+        it "cannot load the page" do
+          expect { get path }.to raise_error(ActionController::RoutingError)
+        end
+      end
+
+      context "#govpay_refunds" do
+        let(:path) { "/defra_ruby_mocks/govpay/#{payment_id}/refunds" }
+
+        it "cannot load the page" do
+          expect { post path }.to raise_error(ActionController::RoutingError)
+        end
+      end
+    end
+  end
+end

data/spec/requests/worldpay_spec.rb

@@ -21,7 +21,7 @@ module DefraRubyMocks
 
         context "when a payment request is received" do
           context "and the request is valid" do
-            let(:data) { File.read("spec/fixtures/payment_request_valid.xml") }
+            let(:data) { File.read("spec/fixtures/files/worldpay/payment_request_valid.xml") }
 
             it "returns an XML response with a 200 code" do
               post path, headers: { "RAW_POST_DATA" => data }
@@ -33,7 +33,7 @@ module DefraRubyMocks
           end
 
           context "and the request is invalid" do
-            let(:data) { File.read("spec/fixtures/payment_request_invalid.xml") }
+            let(:data) { File.read("spec/fixtures/files/worldpay/payment_request_invalid.xml") }
 
             it "returns a response with a 500 code" do
               post path, headers: { "RAW_POST_DATA" => data }
@@ -45,7 +45,7 @@ module DefraRubyMocks
 
         context "when a refund request is received" do
           context "and the request is valid" do
-            let(:data) { File.read("spec/fixtures/refund_request_valid.xml") }
+            let(:data) { File.read("spec/fixtures/files/worldpay/refund_request_valid.xml") }
 
             it "returns an XML response with a 200 code" do
               post path, headers: { "RAW_POST_DATA" => data }

data/spec/services/govpay_create_payment_service_spec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+module DefraRubyMocks
+
+  RSpec.describe GovpayCreatePaymentService do
+
+    before(:each) do
+      Helpers::Configuration.prep_for_tests
+      DefraRubyMocks.configure do |config|
+        config.govpay_domain = "http://localhost:3000/defra_ruby_mocks"
+      end
+    end
+
+    let(:amount) { Faker::Number.number(digits: 4) }
+    let(:description) { Faker::Lorem.sentence }
+    let(:return_url) { Faker::Internet.url }
+
+    describe ".run" do
+
+      subject { described_class.run(amount: amount, description: description, return_url: return_url).deep_symbolize_keys }
+
+      context "for a valid payment request" do
+
+        it "returns a payment response with the order amount" do
+          expect(subject[:amount]).to eq(amount)
+        end
+
+        it "returns a payment response with the description" do
+          expect(subject[:description]).to eq(description)
+        end
+
+        it "returns a payment response with the return_url" do
+          expect(subject[:_links][:next_url][:href]).to eq(return_url)
+        end
+
+        it "returns the expected status" do
+          expect(subject[:state][:status]).to eq("created")
+        end
+      end
+    end
+  end
+end

data/spec/services/govpay_get_payment_service_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+module DefraRubyMocks
+
+  RSpec.describe GovpayGetPaymentService do
+    before { Helpers::Configuration.prep_for_tests }
+
+    let(:order_value) { Faker::Number.number(digits: 4) }
+    let(:payment_id) { SecureRandom.hex(26) }
+
+    # Note that the service currently supports only success responses.
+    describe ".run" do
+
+      subject { described_class.run(payment_id: payment_id, amount: order_value).deep_symbolize_keys }
+
+      context "when the payment is successful" do
+
+        it "returns a payment with the order amount" do
+          expect(subject[:amount]).to eq(order_value)
+        end
+
+        it "returns the expected status" do
+          expect(subject[:state][:status]).to eq("success")
+        end
+      end
+    end
+  end
+end

data/spec/services/worldpay_payment_service_spec.rb

@@ -25,7 +25,7 @@ module DefraRubyMocks
           end
         end
 
-        let(:xml) { Nokogiri::XML(File.read("spec/fixtures/payment_request_valid.xml")) }
+        let(:xml) { Nokogiri::XML(File.read("spec/fixtures/files/worldpay/payment_request_valid.xml")) }
 
         context "the result it returns" do
           it "is a hash" do
@@ -84,7 +84,7 @@ module DefraRubyMocks
       end
 
       context "when the XML is invalid" do
-        let(:xml) { Nokogiri::XML(File.read("spec/fixtures/payment_request_invalid.xml")) }
+        let(:xml) { Nokogiri::XML(File.read("spec/fixtures/files/worldpay/payment_request_invalid.xml")) }
 
         it "raises an error" do
           expect { described_class.run(args) }.to raise_error StandardError

data/spec/services/worldpay_refund_service_spec.rb

@@ -11,7 +11,7 @@ module DefraRubyMocks
 
       context "when the XML is valid" do
 
-        let(:xml) { Nokogiri::XML(File.read("spec/fixtures/refund_request_valid.xml")) }
+        let(:xml) { Nokogiri::XML(File.read("spec/fixtures/files/worldpay/refund_request_valid.xml")) }
 
         context "the result it returns" do
           it "is a hash" do
@@ -57,7 +57,7 @@ module DefraRubyMocks
       end
 
       context "when the XML is invalid" do
-        let(:xml) { Nokogiri::XML(File.read("spec/fixtures/refund_request_invalid.xml")) }
+        let(:xml) { Nokogiri::XML(File.read("spec/fixtures/files/worldpay/refund_request_invalid.xml")) }
 
         it "raises an error" do
           expect { described_class.run(args) }.to raise_error StandardError

data/spec/services/worldpay_request_handler_service_spec.rb

@@ -15,7 +15,7 @@ module DefraRubyMocks
             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(:xml) { Nokogiri::XML(File.read("spec/fixtures/files/worldpay/payment_request_valid.xml")) }
           let(:order_id) { "1234567890" }
           let(:request_type) { { request_type: :payment } }
           let(:response_values) do
@@ -41,7 +41,7 @@ module DefraRubyMocks
         end
 
         context "and it's for a refund" do
-          let(:xml) { Nokogiri::XML(File.read("spec/fixtures/refund_request_valid.xml")) }
+          let(:xml) { Nokogiri::XML(File.read("spec/fixtures/files/worldpay/refund_request_valid.xml")) }
           let(:request_type) { { request_type: :refund } }
           let(:response_values) do
             {
@@ -67,7 +67,7 @@ module DefraRubyMocks
         end
 
         context "but it's not recognised" do
-          let(:xml) { Nokogiri::XML(File.read("spec/fixtures/unrecognised_request.xml")) }
+          let(:xml) { Nokogiri::XML(File.read("spec/fixtures/files/worldpay/unrecognised_request.xml")) }
 
           it "raises a 'UnrecognisedWorldpayRequestError'" do
             expect { described_class.run(xml) }.to raise_error UnrecognisedWorldpayRequestError

data/spec/services/worldpay_resource_service_spec.rb

@@ -44,6 +44,14 @@ module DefraRubyMocks
         it "returns an object with the expected company name" do
           expect(described_class.run(args).company_name).to eq(company_name.downcase)
         end
+
+        context "when the company name is not populated" do
+          let(:company_name) { nil }
+
+          it "returns the object" do
+            expect(described_class.run(args).resource).to eq(resource)
+          end
+        end
       end
 
       context "when the resource is a Registration" do

data/spec/services/worldpay_response_service_spec.rb

@@ -16,7 +16,7 @@ module DefraRubyMocks
       allow(WorldpayResourceService).to receive(:run) { resource }
     end
 
-    let(:resource) { double(:resource, order: order, company_name: company_name.downcase) }
+    let(:resource) { double(:resource, order: order, company_name: company_name&.downcase) }
 
     let(:admin_code) { "admincode1" }
     let(:merchant_code) { "merchantcode1" }
@@ -83,6 +83,14 @@ module DefraRubyMocks
 
               expect(described_class.run(args).url).to eq(expected_response_url)
             end
+
+            context "and the company name is blank" do
+              let(:company_name) { nil }
+
+              it "can extract the reference from the `success_url`" do
+                expect(described_class.run(args).reference).to eq(reference)
+              end
+            end
           end
 
           context "and is for a rejected payment" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defra_ruby_mocks
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.3
 platform: ruby
 authors:
 - Defra
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-29 00:00:00.000000000 Z
+date: 2022-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -149,9 +149,14 @@ files:
 - Rakefile
 - app/controllers/defra_ruby_mocks/application_controller.rb
 - app/controllers/defra_ruby_mocks/company_controller.rb
+- app/controllers/defra_ruby_mocks/govpay_controller.rb
 - app/controllers/defra_ruby_mocks/worldpay_controller.rb
+- app/jobs/defra_ruby_mocks/application_job.rb
+- app/jobs/defra_ruby_mocks/govpay_payment_callback_job.rb
 - app/services/defra_ruby_mocks/base_service.rb
 - app/services/defra_ruby_mocks/companies_house_service.rb
+- app/services/defra_ruby_mocks/govpay_create_payment_service.rb
+- app/services/defra_ruby_mocks/govpay_get_payment_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
@@ -210,17 +215,29 @@ 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/fixtures/files/govpay/create_payment_created_response.json
+- spec/fixtures/files/govpay/create_payment_error_response.json
+- spec/fixtures/files/govpay/get_payment_response_cancelled.json
+- spec/fixtures/files/govpay/get_payment_response_created.json
+- spec/fixtures/files/govpay/get_payment_response_error.json
+- spec/fixtures/files/govpay/get_payment_response_failure.json
+- spec/fixtures/files/govpay/get_payment_response_not_found.json
+- spec/fixtures/files/govpay/get_payment_response_submitted.json
+- spec/fixtures/files/govpay/get_payment_response_success.json
+- spec/fixtures/files/worldpay/payment_request_invalid.xml
+- spec/fixtures/files/worldpay/payment_request_valid.xml
+- spec/fixtures/files/worldpay/refund_request_invalid.xml
+- spec/fixtures/files/worldpay/refund_request_valid.xml
+- spec/fixtures/files/worldpay/unrecognised_request.xml
 - spec/lib/configuration_spec.rb
 - spec/rails_helper.rb
 - spec/requests/company_spec.rb
+- spec/requests/govpay_spec.rb
 - spec/requests/officers_spec.rb
 - spec/requests/worldpay_spec.rb
 - spec/services/companies_house_service_spec.rb
+- spec/services/govpay_create_payment_service_spec.rb
+- spec/services/govpay_get_payment_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
@@ -237,7 +254,7 @@ homepage: https://github.com/DEFRA/defra-ruby-mocks
 licenses:
 - The Open Government Licence (OGL) Version 3
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -253,7 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Defra Ruby on Rails external API mocking engine
 test_files:
@@ -295,6 +312,7 @@ test_files:
 - spec/dummy/README.rdoc
 - spec/examples.txt
 - spec/defra_ruby_mocks_spec.rb
+- spec/requests/govpay_spec.rb
 - spec/requests/company_spec.rb
 - spec/requests/worldpay_spec.rb
 - spec/requests/officers_spec.rb
@@ -305,15 +323,26 @@ test_files:
 - 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/fixtures/files/worldpay/unrecognised_request.xml
+- spec/fixtures/files/worldpay/payment_request_invalid.xml
+- spec/fixtures/files/worldpay/refund_request_valid.xml
+- spec/fixtures/files/worldpay/payment_request_valid.xml
+- spec/fixtures/files/worldpay/refund_request_invalid.xml
+- spec/fixtures/files/govpay/get_payment_response_submitted.json
+- spec/fixtures/files/govpay/get_payment_response_not_found.json
+- spec/fixtures/files/govpay/create_payment_created_response.json
+- spec/fixtures/files/govpay/get_payment_response_created.json
+- spec/fixtures/files/govpay/create_payment_error_response.json
+- spec/fixtures/files/govpay/get_payment_response_success.json
+- spec/fixtures/files/govpay/get_payment_response_failure.json
+- spec/fixtures/files/govpay/get_payment_response_cancelled.json
+- spec/fixtures/files/govpay/get_payment_response_error.json
 - spec/rails_helper.rb
+- spec/services/govpay_get_payment_service_spec.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
+- spec/services/govpay_create_payment_service_spec.rb