defra_ruby_mocks 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2400c544251ae5e153675efe7553c5fab5f1f7f85d22070dcc3ad638d57f37c4
-  data.tar.gz: 0a0f9539751608fe818abb95441827cb870454221f6adf2560a3ea10a4bcad88
+  metadata.gz: bc69209c2d4b90b3726d7486bb0f4f0f001d80aff649951f4e8eaa5e17e46cec
+  data.tar.gz: 2f8ca2c6731b2d0eae695e7aeae936c20288480bf758c4f16fcdcf3a27f70067
 SHA512:
-  metadata.gz: db8efa881a745c8b16c36b60d24ad7e2edc29a1ff237b060013289801be216e93e3af808b34f49aeddff80eb0855d9217b956c35080c72f83c84a243f98ccde3
-  data.tar.gz: da2b9925edb39db3c89b8794a8bc184550cb5972affaf2978f8ea3c9302a6ab7d1d84dbf6c74bbebaa47f864cb17c369a1e4fa216ed6a15ec508b66ccc500d3e
+  metadata.gz: ed7a96c4eb66607adbe341b441181b339b60e28cf1d66e92e1eb6467606d82676110efc587d921a309fec419c472095a82c7b1b1bb8ebbff64740182c38723f4
+  data.tar.gz: f9b8847f14ac049e9b1cef302cfbe8893c6b56797e5f48e6b6548f939c16f923111c2f79be4023ab8c1c5a62aa91db10eebfc73b797de9feb7326798a65af215

data/README.md

@@ -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)

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/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/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 = "2.1.0"
+  VERSION = "2.2.0"
 end