defra_ruby_mocks 1.4.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37b80527c008c3d05100caffb316ae36fd75050a7d5612db07a180f163e3e17a
-  data.tar.gz: 622dc9a174d7e0af97046b33a12164b37deec2d3574afebd42932b7c7b699171
+  metadata.gz: bc69209c2d4b90b3726d7486bb0f4f0f001d80aff649951f4e8eaa5e17e46cec
+  data.tar.gz: 2f8ca2c6731b2d0eae695e7aeae936c20288480bf758c4f16fcdcf3a27f70067
 SHA512:
-  metadata.gz: ab9dec997252c0e656cb39c4364e9d2f28e28bfd707309178a3d0e17d3d3289241720cc4c78a1f542edef1545a5d30e43573aea389e6fc69ee33237e47414c95
-  data.tar.gz: e3f3707826e51e569703a04aaaaeb4593f99db011331ffd73018909c8548f702cf317ccefe0f30308047b3734107b4ce292c8ef740fb362e9647834b3eb79e4c
+  metadata.gz: ed7a96c4eb66607adbe341b441181b339b60e28cf1d66e92e1eb6467606d82676110efc587d921a309fec419c472095a82c7b1b1bb8ebbff64740182c38723f4
+  data.tar.gz: f9b8847f14ac049e9b1cef302cfbe8893c6b56797e5f48e6b6548f939c16f923111c2f79be4023ab8c1c5a62aa91db10eebfc73b797de9feb7326798a65af215

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)
+![Build Status](https://github.com/DEFRA/defra-ruby-mocks/workflows/CI/badge.svg?branch=main)
 [![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/master.svg)](https://hakiri.io/github/DEFRA/defra-ruby-mocks/master)
+[![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
@@ -71,14 +71,38 @@ The project currently mocks the following services.
 
 When mounted into an app you can make requests to `/mocks/company/[company number]` to get a response that matches what our apps expect.
 
-This is an important distinction to note. When our apps like the [Waste Exemptions front office](https://github.com/DEFRA/waste-exemptions-front-office) make a real request to Companies House, they get a lot more information back in the JSON reponse. However the only thing they are interested in is the value of `"company_status"`.
+This is an important distinction to note. When our apps like the [Waste Exemptions front office](https://github.com/DEFRA/waste-exemptions-front-office) make a real request to Companies House, they get a lot more information back in the JSON reponse. However the only things they are interested in are the value of `"company_name"`, `"company_status"`, `"company_type"` and `"registered_office"`, .
 
-So rather than maintain a lot of unused JSON data, the mock just returns that bit of the JSON.
+So rather than maintain a lot of unused JSON data, the mock just returns those bits of the JSON.
 
 ```bash
 curl http://localhost:3000/mocks/company/SC123456
 {
-    "company_status": "active"
+    "company_name": "Acme Industries",
+    "company_status": "active",
+    "company_type": "ltd",
+    "registered_office_address": {
+        "address_line_1": "10 Downing St",
+        "address_line_2": "Horizon House",
+        "locality": "Bristol",
+        "postal_code": "BS1 5AH"
+    }
+}
+```
+
+Additionally, an Officers endpoint is available at `/mocks/company/[company number]/officers`. This returns a list of partial Officer data, eg:
+```bash
+curl http://localhost:3000/mocks/company/SC123456/officers
+{
+   "items": [
+    {
+      "name": "APPLE, Alice",
+      "officer_role": "director"
+    },
+    {
+      "name": "BANANA, Bob",
+      "officer_role": "director"
+    },...
 }
 ```
 
@@ -99,6 +123,11 @@ The exceptions to this are the 'special' numbers listed below. Use them if you a
 - `33333333` will return `"open"`
 - `22222222` will return `"closed"`
 
+Additionally, an `"active"` LLP company can be retrieved by using the following registration numbers:
+
+- `XX999999`
+- `YY999999`
+
 The list of possible statuses was taken from
 
 - [Companies House API](https://developer.companieshouse.gov.uk/api/docs/company/company_number/companyProfile-resource.html)
@@ -122,6 +151,30 @@ 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).

data/app/controllers/defra_ruby_mocks/company_controller.rb

@@ -6,13 +6,20 @@ module DefraRubyMocks
     before_action :set_default_response_format
 
     def show
-      @status = CompaniesHouseService.run(params[:id])
+      service = CompaniesHouseService.run(params[:id])
+
+      @company_status = service.company_status
+      @company_type = service.company_type
 
       respond_to :json
     rescue NotFoundError
       render "not_found", status: 404
     end
 
+    def officers
+      respond_to :json
+    end
+
     private
 
     def set_default_response_format

data/app/controllers/defra_ruby_mocks/worldpay_controller.rb

@@ -10,14 +10,18 @@ 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
       @response = WorldpayResponseService.run(
         success_url: params[:successURL],
-        failure_url: params[:failureURL]
+        failure_url: params[:failureURL],
+        pending_url: params[:pendingURL],
+        cancel_url: params[:cancelURL],
+        error_url: params[:errorURL]
       )
 
       if @response.status == :STUCK
@@ -25,7 +29,8 @@ module DefraRubyMocks
       else
         redirect_to @response.url
       end
-    rescue StandardError
+    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/companies_house_service.rb

@@ -31,15 +31,22 @@ module DefraRubyMocks
       }
     end
 
+    def self.llp_company_numbers
+      %w[XX999999 YY999999]
+    end
+
     def run(company_number)
       raise NotFoundError unless valid_company_number?(company_number)
       raise NotFoundError if company_number == NOT_FOUND
 
-      return specials[company_number] if specials.key?(company_number)
+      @company_status = specials[company_number] || "active"
+      @company_type = llps.include?(company_number) ? "llp" : "ltd"
 
-      "active"
+      self
     end
 
+    attr_reader :company_status, :company_type
+
     private
 
     def valid_company_number?(company_number)
@@ -50,5 +57,8 @@ module DefraRubyMocks
       self.class.special_company_numbers
     end
 
+    def llps
+      self.class.llp_company_numbers
+    end
   end
 end

data/app/services/defra_ruby_mocks/worldpay_response_service.rb

@@ -3,11 +3,19 @@
 module DefraRubyMocks
   class WorldpayResponseService < BaseService
 
-    def run(success_url:, failure_url:)
-      parse_reference(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(success_url, failure_url)
+      generate_response(urls)
     end
 
     private
@@ -59,27 +67,44 @@ module DefraRubyMocks
     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
+
+    # 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",
-        status,
-        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 generate_response(success_url, failure_url)
+    def generate_response(urls)
       status = payment_status
 
       WorldpayResponse.new(
-        status == :AUTHORISED ? success_url : failure_url,
+        url(status, urls),
         @url_format == :new ? "?" : "&",
         order_key,
         generate_mac(status),

data/app/views/defra_ruby_mocks/company/officers.json.erb

@@ -0,0 +1,26 @@
+// https://developer-specs.company-information.service.gov.uk/companies-house-public-data-api/resources/officerlist
+{
+  "items": [
+    {
+      "name": "APPLE, Alice",
+      "officer_role": "director"
+    },
+    {
+      "name": "BANANA, Bob",
+      "officer_role": "director"
+    },
+    {
+      "name": "CARROT, Charlie",
+      "officer_role": "director",
+      "resigned_on": "2020-01-21"
+    },
+    {
+      "name": "DONUT, Dave Dickie",
+      "officer_role": "llp-member"
+    },
+    {
+      "name": "ENDIVE, Eve Marie",
+      "officer_role": "llp-designated-member"
+    }
+  ]
+}

data/app/views/defra_ruby_mocks/company/show.json.erb

@@ -1,3 +1,12 @@
+// https://developer-specs.company-information.service.gov.uk/companies-house-public-data-api/resources/companyprofile
 {
-    "company_status": "<%= @status %>"
+    "company_name": "Acme Industries",
+    "company_status": "<%= @company_status %>",
+    "type": "<%= @company_type %>",
+    "registered_office_address": {
+        "address_line_1": "10 Downing St",
+        "address_line_2": "Horizon House",
+        "locality": "Bristol",
+        "postal_code": "BS1 5AH"
+    }
 }

data/config/routes.rb

@@ -6,6 +6,11 @@ DefraRubyMocks::Engine.routes.draw do
       as: "company",
       constraints: ->(_request) { DefraRubyMocks.configuration.enabled? }
 
+  get "/company/:id/officers",
+      to: "company#officers",
+      as: "company_officers",
+      constraints: ->(_request) { DefraRubyMocks.configuration.enabled? }
+
   get "/worldpay/payments-service",
       to: "worldpay#payments_service",
       as: "worldpay_payments_service",

data/lib/defra_ruby_mocks/version.rb

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