defra_ruby_mocks 2.1.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2400c544251ae5e153675efe7553c5fab5f1f7f85d22070dcc3ad638d57f37c4
-  data.tar.gz: 0a0f9539751608fe818abb95441827cb870454221f6adf2560a3ea10a4bcad88
+  metadata.gz: 234acb79fe01017da60fcef23605cd3ff4506fefb54765f29cbe707533016ba2
+  data.tar.gz: 4a52336dbd39d3c03ffab8b96f7d1c4b90ca83af1dca3ffb72973635f85d40e1
 SHA512:
-  metadata.gz: db8efa881a745c8b16c36b60d24ad7e2edc29a1ff237b060013289801be216e93e3af808b34f49aeddff80eb0855d9217b956c35080c72f83c84a243f98ccde3
-  data.tar.gz: da2b9925edb39db3c89b8794a8bc184550cb5972affaf2978f8ea3c9302a6ab7d1d84dbf6c74bbebaa47f864cb17c369a1e4fa216ed6a15ec508b66ccc500d3e
+  metadata.gz: 6f5256bb6536f34b6d7aa373bd02f6ba9e7c200cbfcf7c344d5f0ab127d960ba3768c73b3c150a6b4c3d46e2c405d76dd4f5ea8ab784ad9f22a852db8a330414
+  data.tar.gz: da3cfafbe7aa6939ca4cec698f00b982b004da1cf39bfcb97e26d72a4b219e9e6df88cea29effadfa3ccfbbb9bbbf6bb058671cd34db71b80fe9ab607e98f5ee

data/README.md

@@ -3,7 +3,6 @@
 ![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/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.
@@ -71,14 +70,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 +122,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)

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

@@ -2,6 +2,7 @@
 
 module DefraRubyMocks
   class WorldpayController < ::DefraRubyMocks::ApplicationController
+    protect_from_forgery with: :exception, except: [:payments_service]
 
     before_action :set_default_response_format
 

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_resource_service.rb

@@ -46,9 +46,9 @@ module DefraRubyMocks
 
     def company_name
       if resource.class.to_s == "WasteCarriersEngine::OrderCopyCardsRegistration"
-        locate_original_registration(resource.reg_identifier).company_name.downcase
+        locate_original_registration(resource.reg_identifier).company_name&.downcase
       else
-        resource.company_name.downcase
+        resource.company_name&.downcase
       end
     end
   end

data/app/services/defra_ruby_mocks/worldpay_response_service.rb

@@ -65,6 +65,8 @@ module DefraRubyMocks
     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")

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,11 +6,16 @@ DefraRubyMocks::Engine.routes.draw do
       as: "company",
       constraints: ->(_request) { DefraRubyMocks.configuration.enabled? }
 
-  get "/worldpay/payments-service",
-      to: "worldpay#payments_service",
-      as: "worldpay_payments_service",
+  get "/company/:id/officers",
+      to: "company#officers",
+      as: "company_officers",
       constraints: ->(_request) { DefraRubyMocks.configuration.enabled? }
 
+  post "/worldpay/payments-service",
+       to: "worldpay#payments_service",
+       as: "worldpay_payments_service",
+       constraints: ->(_request) { DefraRubyMocks.configuration.enabled? }
+
   get "/worldpay/dispatcher",
       to: "worldpay#dispatcher",
       as: "worldpay_dispatcher",

data/lib/defra_ruby_mocks/configuration.rb

@@ -5,8 +5,7 @@ module DefraRubyMocks
 
     DEFAULT_DELAY = 1000
 
-    attr_accessor :worldpay_admin_code, :worldpay_mac_secret
-    attr_accessor :worldpay_merchant_code, :worldpay_domain
+    attr_accessor :worldpay_admin_code, :worldpay_mac_secret, :worldpay_merchant_code, :worldpay_domain
     attr_reader :delay
 
     def initialize

data/lib/defra_ruby_mocks/version.rb

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