openc_bot 0.0.27 → 0.0.46

data/schemas/.gitignore

@@ -1,13 +0,0 @@
-/.bundle
-/.rvmrc
-/coverage
-/pkg
-/rdoc
-/tags
-/vendor
-/.rbenv-version
-.rspec
-.DS_Store
-*~
-.#*
-#*#

data/schemas/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-rvm:
-  - "1.9.3"
-  - "2.0.0"
-  - "2.1.0"

data/schemas/Gemfile

@@ -1,9 +0,0 @@
-# A sample Gemfile
-source "https://rubygems.org"
-
-group :test do
-  gem "rspec"
-  gem 'json-schema'
-  # gem 'debugger'
-  gem 'rake'
-end

data/schemas/README.md

@@ -1,2 +0,0 @@
-These are JSON schemas for validating data before it is sent to
-OpenCorporates.

data/schemas/Rakefile

@@ -1,46 +0,0 @@
-require "rubygems"
-
-PROJECT_ROOT = File.expand_path("..", __FILE__)
-
-require "rspec/core/rake_task"
-# require 'debugger'
-
-desc "Run all specs"
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.verbose = true
-end
-
-task :default => :spec
-
-## dist
-
-require "json"
-
-desc "Regenerate schema files from snippets and reference files"
-task :regenerate_data_object_schemas do
-  spacers = '='*20
-  puts "Regenerating OpenCorporates DataObject schemas"
-  puts spacers
-  base_object = JSON.parse(File.new(File.join(PROJECT_ROOT,'lib','base-statement.json')).read)
-  snippets = Dir.glob(File.join(PROJECT_ROOT,'lib','snippets','*base.json'))
-  snippets.each do |snippet|
-    object_name = snippet[/\/([^\/]+)-base.json/,1]
-    snippet_data = JSON.parse(File.new(snippet).read)
-    combined_data = {}.merge(snippet_data).merge(base_object)
-    combined_data['properties']['data']['items'] = {
-        "$ref" => "includes/#{object_name}-data-object.json"
-      }
-    File.open(File.join(PROJECT_ROOT,'schemas',"#{object_name}-schema.json"),'w') { |file| file.puts JSON.pretty_generate(combined_data) }
-    puts "Generated schema: '#{object_name}-schema.json'"
-  end
-  puts spacers
-  puts "Finished regenerating schemas.\nNow running validation specs"
-  puts spacers
-  Rake::Task['run_validation_specs'].invoke
-end
-
-task :run_validation_specs do
-  Rake::Task['default'].invoke
-end
-
-

data/schemas/lib/base-statement.json

@@ -1,22 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "type": "object",
-  "properties": {
-    "source_jurisdiction": {
-      "description": "Jurisdiction of the source of the data",
-      "type": "string"
-    },
-    "company": {
-      "$ref" : "includes/company.json"
-    },
-    "data": {
-      "type": "array",
-      "description": "This is an array of data objects, that is the objects which actually contain the data about the datum. Generally there will only be one element in this, although in for some types of data_types there may naturally be several releated to the same company, e.g. shareholders",
-      "items": {
-        "$ref": "includes/financial-payment-data-object.json"
-      },
-      "additionalItems": false
-    }
-  },
-  "required": ["company", "data"]
-}

data/schemas/lib/snippets/financial-payment-base.json

@@ -1,4 +0,0 @@
-{
-  "title": "Financial-Payment",
-  "description": "A Financial-Payment is a payment from government to a recipient"
-}

data/schemas/lib/snippets/licence-base.json

@@ -1,4 +0,0 @@
-{
-  "title": "Licence Schema",
-  "description": "A Licence is a permission for an entity to do something that would otherwise not be permitted. An example is a 'Financial' licence to operate as a bank, or an financial advisor, for example, or a 'Business' Licence to sell alcohol, or operate an amusement arcade. Future licence types (extractives, pollution) will be added later"
-}

data/schemas/schemas/company-schema.json

@@ -1,183 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "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": "includes/address.json"
-    },
-    "headquarters_address": {
-      "$ref": "includes/address.json"
-    },
-    "mailing_address": {
-      "$ref": "includes/address.json"
-    },
-    "officers": {
-      "type": "array",
-      "items": {
-        "$ref": "includes/officer.json"
-      }
-    },
-    "share_parcels": {
-      "type": "array",
-      "items": {
-        "$ref": "includes/share-parcel.json"
-      }
-    },
-    "total_shares": {
-      "$ref": "includes/total-shares.json"
-    },
-    "filings": {
-      "type": "array",
-      "items": {
-        "$ref": "includes/filing.json"
-      }
-    },
-    "industry_codes": {
-      "type": "array",
-      "items": {
-        "$ref": "includes/industry_code.json"
-      }
-    },
-    "previous_names": {
-      "type": "array",
-      "items": {
-        "$ref": "includes/previous_name.json"
-      }
-    },
-    "alternative_names": {
-      "type": "array",
-      "items": {
-        "$ref": "includes/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": ["company_number", "name", "jurisdiction_code"]
-}

data/schemas/schemas/financial-payment-schema.json

@@ -1,27 +0,0 @@
-{
-  "title": "Financial-Payment",
-  "description": "A Financial-Payment is a payment from government to a recipient",
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "type": "object",
-  "properties": {
-    "source_jurisdiction": {
-      "description": "Jurisdiction of the source of the data",
-      "type": "string"
-    },
-    "company": {
-      "$ref": "includes/company.json"
-    },
-    "data": {
-      "type": "array",
-      "description": "This is an array of data objects, that is the objects which actually contain the data about the datum. Generally there will only be one element in this, although in for some types of data_types there may naturally be several releated to the same company, e.g. shareholders",
-      "items": {
-        "$ref": "includes/financial-payment-data-object.json"
-      },
-      "additionalItems": false
-    }
-  },
-  "required": [
-    "company",
-    "data"
-  ]
-}

data/schemas/schemas/includes/address.json

@@ -1,23 +0,0 @@
-{ "oneOf":
-  [
-    {
-      "type": ["string","null"],
-      "minLength": 2
-    },
-    {
-      "name": "Address",
-      "description": "An address object",
-      "type": "object",
-      "properties": { "street_address": { "type": "string" },
-                      "locality": {"type":"string"},
-                      "region":   { "type": "string" },
-                      "postal_code":   { "type": "string" },
-                      "country":   { "type": "string" }
-      },
-      "anyOf": [ { "required": ["street_address"] },
-                 { "required": ["postal_code"] }
-               ]
-    }
-  ]
-}
-

data/schemas/schemas/includes/alternative_name.json

@@ -1,13 +0,0 @@
-{
-  "name": "AlternativeName",
-  "description": "An alternative name of a company, e.g. abbreviation, trading (including dba or doing business as), legal. As well as trading names etc, it can be used for storing alternative language representations of the legal name, in which case the language should be represented as two-letter ISO-639 code",
-  "type": "object",
-  "properties": { "company_name": { "type": "string", "minLength": 1 },
-                  "start_date": {"type":"string","format": "date"},
-                  "end_date": {"type":"string","format": "date"},
-                  "language": { "type": "string", "minLength": 2, "maxLength": 2 },
-                  "type": { "type": "string", "enum": ["trading", "abbreviation", "legal"] }
-  },
-  "required": [ "company_name", "type" ]
-}
-

data/schemas/schemas/includes/company.json

@@ -1,16 +0,0 @@
-{
-  "name": "Company",
-  "description": "A company which is the subject of a statement",
-  "type": "object",
-  "properties": {
-    "name": { "type": "string" },
-    "jurisdiction": { "type": "string" },
-    "company_number": { "type": "string" },
-    "identifier": {
-      "type": "string",
-      "description": "An official identifier paired with a code for the issuer of the identifier, e.g sec/12345",
-      "pattern": "^[^/]+/[^/]+$"
-    }
-  },
-  "required": [ "name", "jurisdiction" ]
-}

data/schemas/schemas/includes/filing.json

@@ -1,20 +0,0 @@
-{
-  "name": "Filing",
-  "description": "A statutory filing",
-  "type": "object",
-  "properties": { "title": { "type": "string" },
-                  "date": {"type":"string","format": "date"},
-                  "description":   { "type": "string" },
-                  "uid":   { "type": "string" },
-                  "url":   { "type": "string" },
-                  "filing_type_code":   { "type": "string" },
-                  "filing_type_name":   { "type": "string" },
-                  "other_attributes": { "type": "object" }
-  },
-  "required": [ "date" ],
-  "anyOf": [ { "required": ["title"] },
-             { "required": ["description"] },
-             { "required": ["filing_type_name"] }
-           ]
-}
-

data/schemas/schemas/includes/financial-payment-data-object.json

@@ -1,60 +0,0 @@
-{
-  "name": "Financial Payment Datum",
-  "type": "object",
-  "properties": {
-    "data_type": { "enum": [ "financial_payment" ] },
-    "source_url": {
-      "type": "string"},
-    "confidence": {
-      "type": "string"},
-    "properties": {
-      "type": "object",
-      "properties": {
-        "value": {
-          "description": "The amount transacted (e.g. 19.95)",
-          "type": "string"},
-        "payee_name": {
-          "description": "The name of the payee (the entity that received the money)",
-          "type": "string"},
-        "currency": {
-          "description": "The currency of the payment (three letter symbol, e.g. USD, GBP, EUR)",
-          "type": "string"},
-        "date": {
-          "description": "The date on which the payment was made",
-          "type": "date"},
-        "transaction_number": {
-          "description": "The unique identifier for the transaction, scoped to this bot",
-          "type": "string"},
-        "jurisdiction": {
-          "description": "The jurisdiction of the body that made the payment, eg. UK, France, Delaware, Manchester",
-          "type": "string"},
-        "more_details_url": {
-          "description": "A url from which more details can be seen (may be the same as the source_url)",
-          "type": ["string",null]},
-        "description": {
-          "description": "The description of the transaction as given in the raw data",
-          "type": ["string",null]},
-        "expense_type": {
-          "description": "The type of expense -- can be either capital, revenue (i.e. current expenditure) or null",
-          "enum": ["capital","revenue",null]},
-        "expense_area": {
-          "description": "category (in words) of the expenditure",
-          "type": ["string",null]},
-        "entity_name": {
-          "description": "The name of the government entity that made the payment, e.g. Environment Agency",
-          "type": "string"},
-        "entity_uri": {
-          "description": "A unique URL (ideally a dereferencable URI) for the government entity",
-          "type": ["string",null]},
-        "department_name": {
-          "description": "The name of the government department which the entity belongs to (if relevant), e.g. Department of Health",
-          "type": ["string",null]},
-        "csv_line_number": {
-          "description": "If the source for the data is a CSV file, you can optionally include the line number of the CSV from which this data was retrieved",
-          "type": ["string",null]}
-      },
-      "required": [ "value", "payee_name", "date","currency" ]
-    }
-  },
-  "required": [ "data_type", "properties","source_url","confidence" ]
-}