defra_ruby_mocks 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 11c12df8f46d57ee398b846e7b940eabb3ef666f
-  data.tar.gz: d11d804834f28614a23c4fd6bc486885a9f9bdd9
+SHA256:
+  metadata.gz: a765c4c2a161ee30df850c9d40cfbfad3ed9cb5a521e41083b6e27794678b340
+  data.tar.gz: bbef0343174295fe77676a0f8f3d50faca67fc016994c4474bfd8de9ff66dc8f
 SHA512:
-  metadata.gz: 6ecc755e31cf7a746265c1a4f3292b4e037ca7976040cc2350bf5c0ee89e0c630ce7fc3b416319418de7537a8a229b3f6cae80bbadaa700bb951923923087104
-  data.tar.gz: 8afc6250125e523384ccb27c0e543cd9cdeb0b678a9cf818b63a5bb7c34b458daeaabdd759b8babfd91ac6bd834281968362e34af104f4de3c4145e930483322
+  metadata.gz: 5d4b1e1890c8568d644542407c4a4395e2920bb1a8ad0a545568d064447b70a22c2f9190756e9048a70adef917bca55e055806e9e827beeeecd85d5cfa472aa2
+  data.tar.gz: 71598c40f92872c6be03a66d747629a892e3a1a60bea98cd753b046e8be495d0074579cb36fc4101afff9cbbd85fe41ab52b76d8508d99e63e3a0eacc06b292d

data/README.md

@@ -1,9 +1,9 @@
 # Defra Ruby Mocks
 
-[![Build Status](https://travis-ci.com/DEFRA/defra-ruby-mocks.svg?branch=master)](https://travis-ci.com/DEFRA/defra-ruby-mocks)
-[![Maintainability](https://api.codeclimate.com/v1/badges/8b14cc1e0e1c1d6a33cc/maintainability)](https://codeclimate.com/github/DEFRA/defra-ruby-mocks/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/8b14cc1e0e1c1d6a33cc/test_coverage)](https://codeclimate.com/github/DEFRA/defra-ruby-mocks/test_coverage)
-[![security](https://hakiri.io/github/DEFRA/defra-ruby-mocks/master.svg)](https://hakiri.io/github/DEFRA/defra-ruby-mocks/master)
+[![Build Status](https://travis-ci.com/DEFRA/defra-ruby-mocks.svg?branch=main)](https://travis-ci.com/DEFRA/defra-ruby-mocks)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_defra-ruby-mocks&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=DEFRA_defra-ruby-mocks)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_defra-ruby-mocks&metric=coverage)](https://sonarcloud.io/dashboard?id=DEFRA_defra-ruby-mocks)
+[![security](https://hakiri.io/github/DEFRA/defra-ruby-mocks/main.svg)](https://hakiri.io/github/DEFRA/defra-ruby-mocks/main)
 [![Licence](https://img.shields.io/badge/Licence-OGLv3-blue.svg)](http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3)
 
 A Rails Engine used by the [Ruby services team](https://github.com/DEFRA/ruby-services-team) in their digital services.
@@ -21,7 +21,7 @@ Things to note
 
 Make sure you already have:
 
-- Ruby 2.4.2
+- Ruby 2.7.1
 - [Bundler](http://bundler.io/) – for installing Ruby gems
 
 ## Mounting the engine
@@ -122,6 +122,46 @@ This Worldpay mock replicates those 2 interactions with the following urls
 - `../worldpay/payments-service`
 - `../worldpay/dispatcher`
 
+##### Cancelled payments
+
+The engine has the ability to mock a user cancelling a payment when on the Worldpay site. To have the mock return a cancelled payment response just ensure the registration's company name includes the word `cancel` (case doesn't matter).
+
+If it does the engine will redirect back to the cancelled url instead of the success url provided, plus set the payment status to `CANCELLED`.
+
+This allows us to test how the application handles Worldpay responding with a cancelled payment response.
+
+##### Errored payments
+
+The engine has the ability to Worldpay erroring during a payment. To have the mock return an errored payment response just ensure the registration's company name includes the word `error` (case doesn't matter).
+
+If it does the engine will redirect back to the error url instead of the success url provided, plus set the payment status to `ERROR`.
+
+This allows us to test how the application handles Worldpay responding with an errored payment response.
+
+##### Pending payments
+
+The engine has the ability to also mock Worldpay marking a payment as pending. To have the mock return a payment pending response just ensure the registration's company name includes the word `pending` (case doesn't matter).
+
+If it does the engine will redirect back to the pending url instead of the success url provided, plus set the payment status to `SENT_FOR_AUTHORISATION`.
+
+This allows us to test how the application handles Worldpay responding with a payment pending response.
+
+##### Refused payments
+
+The engine has the ability to also mock Worldpay refusing a payment. To have the mock refuse payment just ensure the registration's company name includes the word `reject` (case doesn't matter).
+
+If it does the engine will redirect back to the failure url instead of the success url provided, plus set the payment status to `REFUSED`.
+
+This allows us to test how the application handles both successful and unsucessful Worldpay payments.
+
+##### Stuck payments
+
+The engine has the ability to also mock Worldpay not redirecting back to the service. This is the equivalent of a registration getting 'stuck at Worldpay'. To have the mock not respond just ensure the registration's company name includes the word `stuck` (case doesn't matter).
+
+If it does the engine will not redirect back to the service, but instead render a 'You're stuck!' page.
+
+This allows us to test how the application handles Worldpay not returning after we redirect a user to them.
+
 #### Refunds
 
 Requesting a refund from Worldpay is a single step process.

data/Rakefile

@@ -25,7 +25,6 @@ Bundler::GemHelper.install_tasks
 # This is wrapped to prevent an error when rake is called in environments where
 # rspec may not be available, e.g. production. As such we don't need to handle
 # the error.
-# rubocop:disable Lint/HandleExceptions
 begin
   require "rspec/core/rake_task"
 
@@ -35,4 +34,3 @@ begin
 rescue LoadError
   # no rspec available
 end
-# rubocop:enable Lint/HandleExceptions

data/app/controllers/defra_ruby_mocks/company_controller.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module DefraRubyMocks
-  class CompanyController < ApplicationController
+  class CompanyController < ::DefraRubyMocks::ApplicationController
 
     before_action :set_default_response_format
 

data/app/controllers/defra_ruby_mocks/worldpay_controller.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module DefraRubyMocks
-  class WorldpayController < ApplicationController
+  class WorldpayController < ::DefraRubyMocks::ApplicationController
 
     before_action :set_default_response_format
 
@@ -10,14 +10,27 @@ module DefraRubyMocks
 
       render_payment_response if @values[:request_type] == :payment
       render_refund_response if @values[:request_type] == :refund
-    rescue StandardError
+    rescue StandardError => e
+      Rails.logger.error("MOCKS: Worldpay payments service error: #{e.message}")
       head 500
     end
 
     def dispatcher
-      success_url = params[:successURL]
-      redirect_to WorldpayResponseService.run(success_url)
-    rescue StandardError
+      @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
 

data/app/services/defra_ruby_mocks/base_service.rb

@@ -2,8 +2,14 @@
 
 module DefraRubyMocks
   class BaseService
-    def self.run(attrs = nil)
-      new.run(attrs)
+    def self.run(options = nil)
+      if options && !options.is_a?(Hash)
+        new.run(options)
+      elsif options
+        new.run(**options)
+      else
+        new.run
+      end
     end
   end
 end

data/app/services/defra_ruby_mocks/worldpay_resource_service.rb

@@ -0,0 +1,55 @@
+# 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

@@ -3,16 +3,40 @@
 module DefraRubyMocks
   class WorldpayResponseService < BaseService
 
-    def run(success_url)
-      parse_reference(success_url)
-      locate_registration
-      @order = last_order
-
-      response_url(success_url)
+    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("/")
@@ -28,71 +52,66 @@ module DefraRubyMocks
       end
     end
 
-    def locate_registration
-      @registration = locate_transient_registration || locate_completed_registration
-
-      raise(MissingRegistrationError, @reference) if @registration.nil?
-    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 last_order
-      @registration.finance_details&.orders&.order_by(dateCreated: :desc)&.first
-    end
-
     def order_key
       [
         DefraRubyMocks.configuration.worldpay_admin_code,
         DefraRubyMocks.configuration.worldpay_merchant_code,
-        @order.order_code
+        @resource.order.order_code
       ].join("^")
     end
 
     def order_value
-      @order.total_amount.to_s
+      @resource.order.total_amount.to_s
+    end
+
+    def payment_status
+      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
 
-    def generate_mac
+    # 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",
-        "AUTHORISED",
-        DefraRubyMocks.configuration.worldpay_mac_secret
+        "GBP"
       ]
+      data << status unless status == :CANCELLED
+      data << DefraRubyMocks.configuration.worldpay_mac_secret
 
       Digest::MD5.hexdigest(data.join).to_s
     end
 
-    def query_string
-      [
-        "orderKey=#{order_key}",
-        "paymentStatus=AUTHORISED",
-        "paymentAmount=#{order_value}",
-        "paymentCurrency=GBP",
-        "mac=#{generate_mac}",
-        "source=WP"
-      ].join("&")
-    end
+    def generate_response(urls)
+      status = payment_status
 
-    def response_url(success_url)
-      if @url_format == :new
-        "#{success_url}?#{query_string}"
-      else
-        "#{success_url}&#{query_string}"
-      end
+      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/stuck.html.erb

@@ -0,0 +1,37 @@
+<!doctype html>
+
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+
+  <title>You is stuck</title>
+  <meta name="description" content="Thw Worldpay stuck page">
+  <meta name="author" content="Defra">
+</head>
+
+<body>
+  <main>
+    <div id="message">
+      <h1>Stuck!</h1>
+      <p>Looks like your registration has gotten stuck whilst paying for it using Worldpay.</p>
+      <p>We hope that's what you expected to happen.</p>
+      <p>Regards, the Ruby Services Team</p>
+    </div>
+    <% if @response %>
+      <div id="debug">
+        <h2>Debug</h2>
+        <ul>
+          <li><strong>Supplied URL</strong> <code><%= @response.supplied_url %></code></li>
+          <li><strong>Separator</strong> <code><%= @response.separator %></code></li>
+          <li><strong>Order key</strong> <code><%= @response.order_key %></code></li>
+          <li><strong>Mac</strong> <code><%= @response.mac %></code></li>
+          <li><strong>Value</strong> <code><%= @response.value %></code></li>
+          <li><strong>Status</strong> <code><%= @response.status %></code></li>
+          <li><strong>Reference</strong> <code><%= @response.reference %></code></li>
+          <li><strong>Url</strong> <code><%= @response.url %></code></li>
+        </ul>
+      </div>
+    <% end %>
+  </main>
+</body>
+</html>

data/lib/defra_ruby_mocks/engine.rb

@@ -2,7 +2,7 @@
 
 require_relative "configuration"
 require_relative "invalid_config_error"
-require_relative "missing_registration_error"
+require_relative "missing_resource_error"
 require_relative "unrecognised_worldpay_request_error"
 
 module DefraRubyMocks

data/lib/defra_ruby_mocks/missing_resource_error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DefraRubyMocks
+  class MissingResourceError < StandardError
+    def initialize(reference)
+      super("Could not find resource: #{reference}")
+    end
+  end
+end

data/lib/defra_ruby_mocks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DefraRubyMocks
-  VERSION = "1.2.0"
+  VERSION = "2.0.0"
 end

data/spec/requests/company_spec.rb

@@ -18,7 +18,7 @@ module DefraRubyMocks
           get "#{path}/#{company_number}"
           content = JSON.parse(response.body)
 
-          expect(response.content_type).to eq("application/json")
+          expect(response.media_type).to eq("application/json")
           expect(response.code).to eq("404")
           expect(content).to include("errors")
         end
@@ -31,7 +31,7 @@ module DefraRubyMocks
           get "#{path}/#{company_number}"
           company_status = JSON.parse(response.body)["company_status"]
 
-          expect(response.content_type).to eq("application/json")
+          expect(response.media_type).to eq("application/json")
           expect(response.code).to eq("200")
           expect(company_status).not_to eq("active")
         end
@@ -45,7 +45,7 @@ module DefraRubyMocks
             get "#{path}/#{company_number}"
             company_status = JSON.parse(response.body)["company_status"]
 
-            expect(response.content_type).to eq("application/json")
+            expect(response.media_type).to eq("application/json")
             expect(response.code).to eq("200")
             expect(company_status).to eq("active")
           end
@@ -58,7 +58,7 @@ module DefraRubyMocks
             get "#{path}/#{company_number}"
             content = JSON.parse(response.body)
 
-            expect(response.content_type).to eq("application/json")
+            expect(response.media_type).to eq("application/json")
             expect(response.code).to eq("404")
             expect(content).to include("errors")
           end