turbot-runner 0.1.21 → 0.1.22

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTBiNjljYWU5MzdhMzk4ZjJiMGI4MmNkMzJiZTU4MjIwYjIyNGZhZg==
+    OWJlODcyODQyMDg3YzcyMDFmNjRkMTJmMjkzOWY2NDdjYWJkMmE0ZQ==
   data.tar.gz: !binary |-
-    ODEzZmE5ZjBlMDQ0MzY5MWQyODlkN2RjZDU0Y2UyODI3ODVmOWZkYw==
+    MjI4ODIxYTgxNDg3MWNkOGIyYTdiOTMyMzUxOTE4YzYyMDA4ZmY4Yg==
 SHA512:
   metadata.gz: !binary |-
-    ZGQwMzJhZWY1NzUwOGYyZDQ1YjEyZjEyY2M1OGQ5YzY2YmU1ZjhlZjZlN2Y5
-    YmNjN2FiYTFkZWUxNzUyMDQ0MDIyYzA2OTI1MzEyNzA3ZGNjM2ViMDY4NGQ3
-    MWExM2JiMzkyOWE3MzExODMyNDMyNzYxMTEzNGU1YjNmYTcyODU=
+    ODlmN2FmZjEwMDBhOThhMGJkNDcxYjA5MzcwMDhhZmNiODgwYjJlNDc2NDEz
+    MDc3YTYwMjU2N2EzZTI2MTFlYjM2YjI1OWY5N2JjMzhhODcwM2I0ZGQ4NjY4
+    ODRlNTEyNzU2Y2IzYmE2ZTc2MzM2NTQ0OTFlY2FiMjhmNDdkNGY=
   data.tar.gz: !binary |-
-    Y2U0NGY0MDFmMzk4MTNhMWYxYjQwMzJhYmVlMjg5MGVkNDRhYWQ0NDBkZGQy
-    MzlkMmQyYjY0NTFkMjRjOGQ0MjFlN2Y0NDkxZWVkMjRiNjcyYjg5ODZiZGNi
-    MzZmNDQxOWM2YTg0YTI5NjQ5MGE0NzAwZWFiNmVmY2I5NWRkNTg=
+    NTAyNjEwNDZjMTJmYTZhYzM1ZGRmMDMyZTJjNmVjZWU2NzIyZmYwMTY0ODYw
+    OTkyNTEwZDNmYTdiMTMzYmI2YzExYWIyZjM5N2JhY2U1NGU1N2Q5OTIzODJk
+    ZDM1Mjc2MjA2NmIyMzM2NTBhZDM4NTlmMWI0OTQwMWVmNzhjMWY=

data/lib/turbot_runner/version.rb

@@ -1,3 +1,3 @@
 module TurbotRunner
-  VERSION = '0.1.21'
+  VERSION = '0.1.22'
 end

data/schema/schemas/includes/company-for-nesting.json

@@ -0,0 +1,182 @@
+{
+  "title": "Company Schema",
+  "type": "object",
+  "description": "A company in OpenCorporates",
+  "properties": {
+    "company_number": {
+      "type": "string",
+      "description": "unique identifier given by the corporate register with which it is incorporated",
+      "minLength": 1
+    },
+    "name": {
+      "type": "string",
+      "description": "Legal name of the company",
+      "minLength": 1
+    },
+    "jurisdiction_code": {
+      "type": "string",
+      "description": "Code representing the jurisdiction/company register which is the canonical record of the company’s existence. Uses underscored ISO 3166-2 to represent it, e.g. es for Spain, us_de for Delaware",
+      "minLength": 2,
+      "maxLength": 5
+    },
+    "incorporation_date": {
+      "type": "date"
+    },
+    "dissolution_date": {
+      "type": "date"
+    },
+    "retrieved_at": {
+      "type": "date-time"
+    },
+    "current_status": {
+      "type": "string"
+    },
+    "company_type": {
+      "type": "string"
+    },
+    "registry_url": {
+      "type": "string"
+    },
+    "website": {
+      "type": "string",
+      "minLength": 5
+    },
+    "telephone_number": {
+      "type": "string",
+      "minLength": 4
+    },
+    "fax_number": {
+      "type": "string",
+      "minLength": 4
+    },
+    "registered_address": {
+      "$ref": "address.json"
+    },
+    "headquarters_address": {
+      "$ref": "address.json"
+    },
+    "mailing_address": {
+      "$ref": "address.json"
+    },
+    "officers": {
+      "type": "array",
+      "items": {
+        "$ref": "officer.json"
+      }
+    },
+    "share_parcels": {
+      "type": "array",
+      "items": {
+        "$ref": "share-parcel.json"
+      }
+    },
+    "total_shares": {
+      "$ref": "total-shares.json"
+    },
+    "filings": {
+      "type": "array",
+      "items": {
+        "$ref": "filing.json"
+      }
+    },
+    "industry_codes": {
+      "type": "array",
+      "items": {
+        "$ref": "industry_code.json"
+      }
+    },
+    "previous_names": {
+      "type": "array",
+      "items": {
+        "$ref": "previous_name.json"
+      }
+    },
+    "alternative_names": {
+      "type": "array",
+      "items": {
+        "$ref": "alternative_name.json"
+      }
+    },
+    "branch": {
+      "type": ["string","null"],
+      "description": "A flag to denote whether a company is a branch entity. This should only be set if the company is a type of branch (otherwise should be null). In general the only option here is 'F' for a 'Foreign' branch, i.e. an out-of-jurisdiction entity that has registered as having a presence in the jurisdiction. In the US this is sometimes called a Foreign Corporation",
+      "enum": ["F", "L",null]
+    },
+    "all_attributes": {
+      "type": "object",
+      "description": "Other arbitrary attributes for a given company",
+      "properties": {
+        "jurisdiction_of_origin": {
+          "type": ["string","null"],
+          "description": "The jurisdiction of the 'home' company if this is a branch",
+          "minLength": 1
+        },
+        "home_company_number": {
+          "type": ["string","null"],
+          "description": "If the entity is a 'branch', this is the company_number of the 'home' company in the home company's jurisdiction",
+          "minLength": 1
+        },
+        "home_legal_name": {
+          "type": ["string","null"],
+          "description": "The legal name of the 'home' company in its jurisdiction if this is a branch, and the name is different from the legal name of the branch",
+          "minLength": 1
+        },
+        "registered_agent_address": {
+          "type": ["string","null"],
+          "description": "The address of the 'Agent', a public address to which legal papers can be served",
+          "minLength": 1
+        },
+        "registered_agent_name": {
+          "type": ["string","null"],
+          "description": "The 'Agent' of the company \u2013 a person or entity that is empowered to accept service for the company",
+          "minLength": 1
+        },
+        "number_of_employees": {
+          "anyOf": [
+            {"type":"string","minLength": 1},
+            {"type":"number","minimum": 0}
+          ],
+          "description": "The number of employees"
+        },
+        "merged_into": {
+          "type": "object",
+          "description": "Information on the merger of this company into a 'survivor' company",
+          "properties": {
+            "surviving_company": {
+              "type": ["object"],
+              "description": "the surviving_company that this has been merged into",
+              "properties": {
+                "name": {
+                  "type": "string",
+                  "description": "The legal name of the surviving company",
+                  "minLength": 1
+                },
+                "company_number": {
+                  "type": "string",
+                  "description": "The company_number of the surviving company, if known",
+                  "minLength": 1
+                },
+                "jurisdiction": {
+                  "type": "string",
+                  "description": "The jurisdiction of incorporation of the surviving company",
+                  "minLength": 2
+                }
+              },
+              "anyOf": [{"required": ["name"]},
+                        {"required": ["company_number"]}]
+            },
+            "effective_date": {
+              "type": "string",
+              "format": "date",
+              "description": "The date of the merger"
+            }
+          },
+          "additionalProperties": false,
+          "required": ["surviving_company"]
+        }
+      }
+    }
+  },
+  "additionalProperties": false,
+  "required": ["name"]
+}

data/schema/schemas/includes/person.json

@@ -1,7 +1,7 @@
 {
   "title": "Person",
   "type": "object",
-  "description": "A person, for example, referenced in some other context, e.g. director of a company, shareholder, licence-holder, lobbyist",
+  "description": "A person, for example, referenced in some other context, e.g. director of a company, shareholder, licence-holder, lobbyist. This should be used only if the person is the subject of the datum",
   "properties": {
     "name": {
       "oneOf": [
@@ -15,6 +15,13 @@
       "type": "string",
       "description": "Name of the jurisdiction in which the entity is based"
     },
+    "company": {
+      "description": "Company the person is representing. NB If the licence holder is a company, and the individual is a just a contact, then use the company-schema for the entity. This is where the individual  themselves are the licence holder",
+      "$ref": "../company-schema.json"
+    },
+    "relationship_with_company": {
+        "enum": ["employee", "director", "shareholder", null]
+    },
     "website": {
       "type": "string",
       "minLength": 5

data/schema/schemas/rich-licence-schema.json

@@ -1,62 +1,86 @@
 {
   "title": "Rich Licence Schema",
-  "description": "A Licence is a permission for an entity to do something that would otherwise not be permitted. Note that such permissions are recorded in multiple different ways and to different granularity. In addition categories cross over, for example a pornborker may be regulated as a retail establishment by a city, but also as a financial institution by a national or regional financial regulator. Sometimes the licence is a simple statement – the government of Rwanda has given a banking licence to a certain bank -- other times it is fine-grained and highly complex (e.g. an extractives licence or the UK FCA licencing scheme). This schema tries to make it easy to submit the former, while not losing granularity of the latter. The object has the name of Rich Licence to distinguish it from Simple Licence, which it is expected to ultimately replace.",
+  "description": "A Licence is a permission for an entity to do something that would otherwise not be permitted. Note that such permissions are recorded in multiple different ways and to different granularity. In addition categories cross over, for example a pawnborker may be regulated as a retail establishment by a city, but also as a financial institution by a national or regional financial regulator. Sometimes the licence is a simple statement – the government of Rwanda has given a banking licence to a certain bank -- other times it is fine-grained and highly complex (e.g. an extractives licence or the UK FCA licencing scheme). This schema tries to make it easy to submit the former, while not losing granularity of the latter. The object has the name of Rich Licence to distinguish it from Simple Licence, which it is expected to ultimately replace.",
   "$schema": "http://json-schema.org/draft-04/schema#",
-	"properties": {
-          "sample_date": {"type": "string", "format": "date"},
-          "start_date": {"type": "string", "format": "date"},
-          "end_date": {"type": "string", "format": "date"},
-		"licence_holder": {
-      "entity": {
-        "oneOf": [
-          {"$ref": "company-schema.json"},
-          {"$ref": "includes/person.json"},
-          {"$ref": "includes/organisation.json"},
-          {"$ref": "includes/unknown_entity_type.json"}
-        ]
-      },
-      "entity_type": {
-        "enum": ["company", "person", "organisation", "unknown_entity_type", null]
+  "properties": {
+    "licence_holder": {
+      "properties": {
+        "entity": {
+          "oneOf": [
+            {
+              "properties": {
+                "entity_type": {"enum": ["company"]},
+                "entity_properties": {"$ref": "includes/company-for-nesting.json"}
+              }
+            }, {
+                "properties": {
+                "entity_type": {"enum": ["person"]},
+                "entity_properties": {"$ref": "includes/person.json"}
+              }
+            }, {
+                "properties": {
+                "entity_type": {"enum": ["organisation"]},
+                "entity_properties": {"$ref": "includes/organisation.json"}
+              }
+            }, {
+                "properties": {
+                "entity_type": {"enum": ["unknown"]},
+                "entity_properties": {"$ref": "includes/unknown_entity_type.json"}
+              }
+            }
+          ]
+        },
+        "entity_type": {
+          "enum": ["company", "person", "organisation", "unknown_entity_type", null]
+        }
       }
-		},
-		"licence_issuer": {
+    },
+    "licence_issuer": {
       "oneOf": [
         {
           "type": ["string","null"],
           "minLength": 2
         },
-  			{"$ref": "includes/organisation.json"}
+        {"$ref": "includes/organisation.json"}
       ]
-		},
-		"licenced_location": {
-			"$ref": "includes/address.json"
-		},
-		"licence_number": {
-			"type": "string"
-		},
-		"start_date": {
+    },
+    "licenced_location": {
+      "$ref": "includes/address.json"
+    },
+    "licence_number": {
+      "type": "string"
+    },
+    "start_date": {
       "description": "The issue date of the licence",
-			"type": "date"
-		},
-		"end_date": {
+              "type": "string",
+              "format": "date"
+    },
+    "end_date": {
       "description": "The expiry date of the licence",
-			"type": "date"
-		},
-		"renewal_date": {
-			"type": "date"
-		},
-		"licence_url": {
-			"type": "string",
+              "type": "string",
+              "format": "date"
+    },
+    "renewal_date": {
+              "type": "string",
+              "format": "date"
+    },
+    "sample_date": {
+      "description": "Date on which we know this to be true (usually date this information was retrieved from the source)",
+      "type": "string",
+      "format": "date"
+    },
+    "licence_url": {
+      "type": "string",
       "description": "A public URL for the licence"
-		},
-		"jurisdiction_of_licence": {
-			"type": "string",
+    },
+    "jurisdiction_of_licence": {
+      "type": "string",
       "description": "The area in which this licence is valid"
-		},
-		"status": {
-			"type": "string",
+    },
+    "status": {
+      "type": "string",
       "description": "The status of the licence. If the licence is made up of a number of permissions, each of which has a status, store the status in the permissions field instead/as well"
-		},
+    },
     "category": {
       "description": "Category of licence",
       "type": "array",
@@ -65,15 +89,15 @@
         "enum": ["Financial", "Business", "Extractive"]
       }
     },
-		"permissions": {
-			"type": "array",
-			"items": {
-				"$ref": "includes/permission.json"
-			}
-		},
+    "permissions": {
+      "type": "array",
+      "items": {
+        "$ref": "includes/permission.json"
+      }
+    },
     "other_attributes": {
       "description": "Use for other licence attributes for which we don't yet have curated schema attributes"
     }
-	},
+  },
   "required": ["source_url", "sample_date", "licence_holder", "permissions", "licence_issuer", "jurisdiction_of_licence"]
 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turbot-runner
 version: !ruby/object:Gem::Version
-  version: 0.1.21
+  version: 0.1.22
 platform: ruby
 authors:
 - OpenCorporates
@@ -46,6 +46,7 @@ files:
 - schema/schemas/financial-payment-schema.json
 - schema/schemas/includes/address.json
 - schema/schemas/includes/alternative_name.json
+- schema/schemas/includes/company-for-nesting.json
 - schema/schemas/includes/company.json
 - schema/schemas/includes/filing.json
 - schema/schemas/includes/financial-payment-data-object.json