companies_house_client 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50896e2d1da28f734cbd6c8a6cbae9859ab196db
-  data.tar.gz: b8f80f042bf138cdc979bef786fff4b10d1f7352
+  metadata.gz: ae7a9bca2c3c65f19f0a56ca47dac8ff16353d46
+  data.tar.gz: 7df0a18bab9de3e4ca353e40484efcc721a1cb02
 SHA512:
-  metadata.gz: 92d4f8a1d54a754e296d156891a5048c386ee3236687b59273b6f223635de0164e4227c876a8579bdd0540426eedc3f9d2133a938b5225bd08d6ba39d56b6b49
-  data.tar.gz: 303c9aa305fd9bdd6d8092cf717a686882e9534353fd242a2497ea9e098221c0c581b29a1ba6477dc96a835569a178d095511b56b92866120b1efc1a20d43641
+  metadata.gz: f2ea9b2e997ef34c5e887c7b136f1452e89d614475f5649e3a51a5f5ad038b73fb030e039fe05055e11974f081238801e7fee72ffb42f723f6b21a60a014256b
+  data.tar.gz: 84eb103022d3f9b55e8444cf8ab32a4f2d5f77c1e70782b31fb8fa16aefe91d5f71e341153f726d789fbf8f7d4710bc009beb8c1f4834a87fe3b7862f71d7cb9

data/README.md

@@ -61,10 +61,25 @@ c = CompaniesHouseClient::Company.find("company number")
 c.officers #returns a collection of Officer objects.
 ```
 
+If you just want a list of officers for a given company, you can save a request to the /company endpoint like this:
+ 
+```
+CompaniesHouseClient::Officer.all(company_id: "company number") #will return a collection directly from the officers endpoint
+```
+
+### Filing History
+You can get a list of the company's filing history entries like this:
+
+```
+c = CompaniesHouseClient::Company.find("company number")
+c.filing_histories #returns a collection of FilingHistory objects - note plural on the relation name
+```
 
 ## To do
 
-* We should be able to get a history of accounts.
+* There are Appointments and Charges endpoints set up, and they're documented in the API docs, but they return a 404 for all companies. No idea why.
+* Some tests would be nice.
+* There an issue with the [Her](https://github.com/remiprev/her) where it expects the child resource to have a reference to a parent, which this API doesn't. So you get `(<unknown path, missing `company_id`>)` in the responses for child objects. There is probably a solution.
 
 # Licence
 This gem is MIT licenced. Have fun!

data/lib/companies_house_client.rb

@@ -44,6 +44,7 @@ module CompaniesHouseClient
 
         # Parse collections
         c.use CompaniesHouseClient::CollectionParser
+        # c.use Her::Middleware::DefaultParseJSON
 
         # Adapter
         c.use Faraday::Adapter::NetHttp

data/lib/companies_house_client/collection_parser.rb

@@ -12,7 +12,9 @@ module CompaniesHouseClient
     def on_complete(env)
       json = MultiJson.load(env[:body], symbolize_keys: true)
       env[:body] = {
-        data: json.has_key?(:items) ? json[:items] : json
+        data: json.has_key?(:items) ? json[:items] : json,
+        errors: json[:errors],
+        metadata: json.except(:items)
       }
     end
   end

data/lib/companies_house_client/models/appointment.rb

@@ -0,0 +1,6 @@
+module CompaniesHouseClient
+  class Appointment < Base
+    belongs_to :company, path: "/company/:id"
+    collection_path "/company/:company_id/appointments"
+  end
+end

data/lib/companies_house_client/models/charge.rb

@@ -0,0 +1,6 @@
+module CompaniesHouseClient
+  class Appointment < Base
+    belongs_to :company, path: "/company/:id"
+    collection_path "/company/:company_id/charges"
+  end
+end

data/lib/companies_house_client/models/company.rb

@@ -1,6 +1,10 @@
 module CompaniesHouseClient
   class Company < Base
-    has_many :officers
+    has_one :registered_office_address, path: "/registered-office-address"
+    has_many :officers, path: "/officers"
+    has_many :filing_histories, path: "/filing-history"
+    has_many :appointments, path: "/appointments"
+    has_many :charges, path: "/charges"
     collection_path "/company"
     primary_key :company_number
 

data/lib/companies_house_client/models/filing_history.rb

@@ -0,0 +1,7 @@
+module CompaniesHouseClient
+  class FilingHistory < Base
+    belongs_to :company, path: "/company/:id"
+    primary_key :transaction_id
+    collection_path "/company/:company_id/filing-history"
+  end
+end

data/lib/companies_house_client/models/officer.rb

@@ -1,5 +1,6 @@
 module CompaniesHouseClient
   class Officer < Base
-    belongs_to :company
+    belongs_to :company, path: "/company/:id"
+    collection_path "/company/:company_id/officers"
   end
 end

data/lib/companies_house_client/models/registered_office_address.rb

@@ -0,0 +1,6 @@
+module CompaniesHouseClient
+  class RegisteredOfficeAddress < Base
+    belongs_to :company, path: "/company/:id"
+    collection_path "/company/:company_id/registered-office-address"
+  end
+end

data/lib/companies_house_client/version.rb

@@ -1,3 +1,3 @@
 module CompaniesHouseClient
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: companies_house_client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ed Jones
@@ -85,8 +85,12 @@ files:
 - lib/companies_house_client/base.rb
 - lib/companies_house_client/ca_path.rb
 - lib/companies_house_client/collection_parser.rb
+- lib/companies_house_client/models/appointment.rb
+- lib/companies_house_client/models/charge.rb
 - lib/companies_house_client/models/company.rb
+- lib/companies_house_client/models/filing_history.rb
 - lib/companies_house_client/models/officer.rb
+- lib/companies_house_client/models/registered_office_address.rb
 - lib/companies_house_client/version.rb
 homepage: https://github.com/errorstudio/companies_house_client
 licenses: