defra_ruby_mocks 2.3.2 → 2.4.0

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/govpay_refund_details_service_spec.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+module DefraRubyMocks
+
+  RSpec.describe GovpayRefundDetailsService do
+    let(:payment_id) { SecureRandom.hex(26) }
+    let(:refund_id) { SecureRandom.hex(22) }
+
+    before { Helpers::Configuration.prep_for_tests }
+
+    # Note that the service currently supports only success responses.
+    describe ".run" do
+      let(:create_request_time) { Time.zone.now }
+      let(:submitted_success_lag) { "10" }
+
+      subject { described_class.run(payment_id: payment_id, refund_id: refund_id).deep_symbolize_keys }
+
+      # the service shoud return "submitted" for up to GOVPAY_REFUND_SUBMITTED_SUCCESS_LAG seconds, "success" thereafter
+      before do
+        Timecop.freeze(create_request_time)
+        allow(ENV).to receive(:fetch).with("GOVPAY_REFUND_SUBMITTED_SUCCESS_LAG", any_args).and_return(submitted_success_lag)
+        FileUtils.rm_rf("#{Dir.tmpdir}/govpay_request_refund_service_last_run_time")
+      end
+
+      context "when no refund timestamp file exists" do
+        it { expect(subject[:status]).to eq "success" }
+      end
+
+      context "when a refund has been requested" do
+        before do
+          GovpayRequestRefundService.run(payment_id: payment_id, amount: 100, refund_amount_available: 100).deep_symbolize_keys
+        end
+
+        context "when less than 10 seconds has elapsed since the last create request" do
+          before { Timecop.freeze(create_request_time + (submitted_success_lag.to_i - 8).seconds) }
+
+          it { expect(subject[:status]).to eq "submitted" }
+        end
+
+        context "when 10 seconds has elapsed since the last create request" do
+          before { Timecop.freeze(create_request_time + (submitted_success_lag.to_i + 8).seconds) }
+
+          it { expect(subject[:status]).to eq "success" }
+        end
+
+        context "when GOVPAY_REFUND_SUBMITTED_SUCCESS_LAG is not set" do
+          let(:submitted_success_lag) { nil }
+
+          before { Timecop.freeze(create_request_time + 1.hour) }
+
+          it { expect(subject[:status]).to eq "success" }
+        end
+      end
+    end
+  end
+end

data/spec/services/govpay_request_refund_service_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+module DefraRubyMocks
+
+  RSpec.describe GovpayRequestRefundService do
+    let(:payment_id) { SecureRandom.hex(26) }
+    let(:amount) { 2000 }
+    let(:refund_amount_available) { amount }
+
+    before { Helpers::Configuration.prep_for_tests }
+
+    # Note that the service currently supports only "submitted" responses.
+    describe ".run" do
+
+      subject { described_class.run(payment_id: payment_id, amount: amount, refund_amount_available: refund_amount_available).deep_symbolize_keys }
+
+      context "when the refund has been successfully submitted" do
+
+        it "returns a response with the expected status" do
+          expect(subject[:status]).to eq("submitted")
+        end
+
+        it "returns a response with the expected amount" do
+          expect(subject[:amount]).to eq(amount)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defra_ruby_mocks
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.4.0
 platform: ruby
 authors:
 - Defra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-23 00:00:00.000000000 Z
+date: 2023-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !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
@@ -150,29 +136,23 @@ files:
 - 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
-- app/services/defra_ruby_mocks/worldpay_resource_service.rb
-- app/services/defra_ruby_mocks/worldpay_response_service.rb
+- app/services/defra_ruby_mocks/govpay_refund_details_service.rb
+- app/services/defra_ruby_mocks/govpay_request_refund_service.rb
 - app/views/defra_ruby_mocks/company/not_found.json.erb
 - app/views/defra_ruby_mocks/company/officers.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
@@ -213,23 +193,25 @@ 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/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/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/services/govpay_create_payment_service_spec.rb
+- spec/services/govpay_get_payment_service_spec.rb
+- spec/services/govpay_refund_details_service_spec.rb
+- spec/services/govpay_request_refund_service_spec.rb
 - spec/spec_helper.rb
 - spec/support/helpers/configuration.rb
 - spec/support/helpers/helpers.rb
@@ -301,7 +283,6 @@ test_files:
 - 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
 - spec/support/simplecov.rb
 - spec/support/pry.rb
@@ -310,15 +291,18 @@ 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/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/worldpay_response_service_spec.rb
-- spec/services/worldpay_resource_service_spec.rb
+- spec/services/govpay_get_payment_service_spec.rb
+- spec/services/govpay_request_refund_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_refund_details_service_spec.rb
+- spec/services/govpay_create_payment_service_spec.rb

data/app/controllers/defra_ruby_mocks/worldpay_controller.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-module DefraRubyMocks
-  class WorldpayController < ::DefraRubyMocks::ApplicationController
-    protect_from_forgery with: :exception, except: [:payments_service]
-
-    before_action :set_default_response_format
-
-    def payments_service
-      @values = WorldpayRequestHandlerService.run(convert_request_body_to_xml)
-
-      render_payment_response if @values[:request_type] == :payment
-      render_refund_response if @values[:request_type] == :refund
-    rescue StandardError => e
-      Rails.logger.error("MOCKS: Worldpay payments service error: #{e.message}")
-      head 500
-    end
-
-    def dispatcher
-      @response = WorldpayResponseService.run(
-        success_url: params[:successURL],
-        failure_url: params[:failureURL],
-        pending_url: params[:pendingURL],
-        cancel_url: params[:cancelURL],
-        error_url: params[:errorURL]
-      )
-
-      if @response.status == :STUCK
-        render formats: :html, action: "stuck", layout: false
-      else
-        redirect_to @response.url
-      end
-    rescue StandardError => e
-      Rails.logger.error("MOCKS: Worldpay dispatcher error: #{e.message}")
-      head 500
-    end
-
-    private
-
-    def set_default_response_format
-      request.format = :xml
-    end
-
-    def convert_request_body_to_xml
-      Nokogiri::XML(request.body.read)
-    end
-
-    def render_payment_response
-      render "defra_ruby_mocks/worldpay/payment_request"
-    end
-
-    def render_refund_response
-      render "defra_ruby_mocks/worldpay/refund_request"
-    end
-
-  end
-end

data/app/services/defra_ruby_mocks/worldpay_payment_service.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module DefraRubyMocks
-  class WorldpayPaymentService < BaseService
-    def run(merchant_code:, xml:)
-      check_config
-
-      @merchant_code = merchant_code
-      @order_code = extract_order_code(xml)
-
-      {
-        merchant_code: @merchant_code,
-        order_code: @order_code,
-        id: generate_id,
-        url: generate_url
-      }
-    end
-
-    private
-
-    def check_config
-      domain = DefraRubyMocks.configuration.worldpay_domain
-
-      raise InvalidConfigError, :worldpay_domain if domain.blank?
-    end
-
-    def extract_order_code(xml)
-      order = xml.at_xpath("//order")
-      order.attribute("orderCode").text
-    end
-
-    def generate_id
-      # Worldpay seems to generate 10 digit numbers for all its ID's. So we
-      # replicate that here with this.
-      # https://stackoverflow.com/a/31043825
-      rand(1e9...1e10).to_i.to_s
-    end
-
-    def generate_url
-      "#{base_url}?OrderKey=#{@merchant_code}%5E#{@order_code}"
-    end
-
-    def base_url
-      File.join(DefraRubyMocks.configuration.worldpay_domain, "/worldpay/dispatcher")
-    end
-  end
-end

data/app/services/defra_ruby_mocks/worldpay_refund_service.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module DefraRubyMocks
-  class WorldpayRefundService < BaseService
-    def run(merchant_code:, xml:)
-      {
-        merchant_code: merchant_code,
-        order_code: extract_order_code(xml),
-        refund_value: extract_refund_value(xml),
-        currency_code: extract_currency_code(xml),
-        exponent: extract_exponent(xml)
-      }
-    end
-
-    private
-
-    def extract_order_code(xml)
-      order_modification = xml.at_xpath("//orderModification")
-      order_modification.attribute("orderCode").text
-    end
-
-    def extract_refund_value(xml)
-      amount = xml.at_xpath("//amount")
-      amount.attribute("value").text
-    end
-
-    def extract_currency_code(xml)
-      amount = xml.at_xpath("//amount")
-      amount.attribute("currencyCode").text
-    end
-
-    def extract_exponent(xml)
-      amount = xml.at_xpath("//amount")
-      amount.attribute("exponent").text
-    end
-  end
-end

data/app/services/defra_ruby_mocks/worldpay_request_handler_service.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module DefraRubyMocks
-  class WorldpayRequestHandlerService < BaseService
-    def run(xml)
-      arguments = {
-        merchant_code: extract_merchant_code(xml),
-        xml: xml
-      }
-
-      generate_response(arguments)
-    end
-
-    private
-
-    def extract_merchant_code(xml)
-      payment_service = xml.at_xpath("//paymentService")
-      payment_service.attribute("merchantCode").text
-    end
-
-    def generate_response(arguments)
-      return WorldpayPaymentService.run(arguments).merge(request_type: :payment) if payment_request?(arguments[:xml])
-      return WorldpayRefundService.run(arguments).merge(request_type: :refund) if refund_request?(arguments[:xml])
-
-      raise UnrecognisedWorldpayRequestError
-    end
-
-    def payment_request?(xml)
-      submit = xml.at_xpath("//submit")
-
-      !submit.nil?
-    end
-
-    def refund_request?(xml)
-      modify = xml.at_xpath("//modify")
-
-      !modify.nil?
-    end
-  end
-end

data/app/services/defra_ruby_mocks/worldpay_resource_service.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module DefraRubyMocks
-  class WorldpayResourceService < BaseService
-
-    def run(reference:)
-      @reference = reference
-
-      raise(MissingResourceError, @reference) if resource.nil?
-
-      WorldpayResource.new(resource, order, company_name)
-    end
-
-    private
-
-    WorldpayResource = Struct.new(:resource, :order, :company_name)
-
-    def resource
-      @_resource ||= locate_transient_registration || locate_completed_registration
-    end
-
-    def locate_transient_registration
-      "WasteCarriersEngine::TransientRegistration"
-        .constantize
-        .where(token: @reference)
-        .first
-    end
-
-    def locate_completed_registration
-      "WasteCarriersEngine::Registration"
-        .constantize
-        .where(reg_uuid: @reference)
-        .first
-    end
-
-    def locate_original_registration(reg_identifier)
-      "WasteCarriersEngine::Registration"
-        .constantize
-        .where(reg_identifier: reg_identifier)
-        .first
-    end
-
-    def order
-      @_order ||= resource.finance_details&.orders&.order_by(dateCreated: :desc)&.first
-    end
-
-    def company_name
-      if resource.class.to_s == "WasteCarriersEngine::OrderCopyCardsRegistration"
-        locate_original_registration(resource.reg_identifier).company_name&.downcase
-      else
-        resource.company_name&.downcase
-      end
-    end
-  end
-end

data/app/services/defra_ruby_mocks/worldpay_response_service.rb

@@ -1,119 +0,0 @@
-# frozen_string_literal: true
-
-module DefraRubyMocks
-  class WorldpayResponseService < BaseService
-
-    def run(success_url:, failure_url:, pending_url:, cancel_url:, error_url:)
-      urls = {
-        success: success_url,
-        failure: failure_url,
-        pending: pending_url,
-        cancel: cancel_url,
-        error: error_url
-      }
-
-      parse_reference(urls[:success])
-      @resource = WorldpayResourceService.run(reference: @reference)
-
-      generate_response(urls)
-    end
-
-    private
-
-    WorldpayResponse = Struct.new(:supplied_url, :separator, :order_key, :mac, :value, :status, :reference) do
-      def url
-        [supplied_url, separator, params].join
-      end
-
-      def params
-        [
-          "orderKey=#{order_key}",
-          "paymentStatus=#{status}",
-          "paymentAmount=#{value}",
-          "paymentCurrency=GBP",
-          "mac=#{mac}",
-          "source=WP"
-        ].join("&")
-      end
-    end
-
-    def parse_reference(url)
-      path = URI.parse(url).path
-      parts = path.split("/")
-
-      if parts[1].downcase == "your-registration"
-        # ["", "your-registration", "xP2zj9nqWYI0SAsMtGZn6w", "worldpay", "success", "1577812071", "NEWREG"]
-        @reference = parts[-5]
-        @url_format = :old
-      else
-        # ["", "fo", "jq6sTt2RQguAu4ZyKFfRg9zm", "worldpay", "success"]
-        @reference = parts[-3]
-        @url_format = :new
-      end
-    end
-
-    def order_key
-      [
-        DefraRubyMocks.configuration.worldpay_admin_code,
-        DefraRubyMocks.configuration.worldpay_merchant_code,
-        @resource.order.order_code
-      ].join("^")
-    end
-
-    def order_value
-      @resource.order.total_amount.to_s
-    end
-
-    def payment_status
-      return :AUTHORISED unless @resource.company_name
-
-      return :REFUSED if @resource.company_name.include?("reject")
-      return :STUCK if @resource.company_name.include?("stuck")
-      return :SENT_FOR_AUTHORISATION if @resource.company_name.include?("pending")
-      return :CANCELLED if @resource.company_name.include?("cancel")
-      return :ERROR if @resource.company_name.include?("error")
-
-      :AUTHORISED
-    end
-
-    def url(payment_status, urls)
-      return urls[:failure] if %i[REFUSED STUCK].include?(payment_status)
-      return urls[:pending] if payment_status == :SENT_FOR_AUTHORISATION
-      return urls[:cancel] if payment_status == :CANCELLED
-      return urls[:error] if payment_status == :ERROR
-
-      urls[:success]
-    end
-
-    # Generate a mac that matches what Worldpay would generate
-    #
-    # For whatever reason, if the payment is cancelled by the user Worldpay does
-    # not include the payment status in the mac it generates. Plus the order of
-    # things in the array is important.
-    def generate_mac(status)
-      data = [
-        order_key,
-        order_value,
-        "GBP"
-      ]
-      data << status unless status == :CANCELLED
-      data << DefraRubyMocks.configuration.worldpay_mac_secret
-
-      Digest::MD5.hexdigest(data.join).to_s
-    end
-
-    def generate_response(urls)
-      status = payment_status
-
-      WorldpayResponse.new(
-        url(status, urls),
-        @url_format == :new ? "?" : "&",
-        order_key,
-        generate_mac(status),
-        order_value,
-        status,
-        @reference
-      )
-    end
-  end
-end

data/app/views/defra_ruby_mocks/worldpay/payment_request.xml.erb

@@ -1,4 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE paymentService PUBLIC "-//WorldPay//DTD WorldPay PaymentService v1//EN"
-        "http://dtd.worldpay.com/paymentService_v1.dtd">
-<paymentService version="1.4" merchantCode="<%= @values[:merchant_code] %>"><reply><orderStatus orderCode="<%= @values[:order_code] %>"><reference id="<%= @values[:id] %>"><%= @values[:url] %></reference></orderStatus></reply></paymentService>

data/app/views/defra_ruby_mocks/worldpay/refund_request.xml.erb

@@ -1,4 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE paymentService PUBLIC "-//WorldPay//DTD WorldPay PaymentService v1//EN"
-                                "http://dtd.worldpay.com/paymentService_v1.dtd">
-<paymentService version="1.4" merchantCode="<%= @values[:merchant_code] %>"><reply><ok><refundReceived orderCode="<%= @values[:order_code] %>"><amount value="<%= @values[:refund_value] %>" currencyCode="<%= @values[:currency_code] %>" exponent="<%= @values[:exponent] %>" debitCreditIndicator="credit"/></refundReceived></ok></reply></paymentService>