Report what version of the schema we checked against

#28

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - Support for schema version 0.2.
   If no meta information is in the data, 0.1 is assumed and work happens as before.
+  - Add new schema_version key for reporting https://github.com/openownership/lib-cove-bods/issues/28
 - Statistic: Count of current ownership/control statements
 - Statistic: Count of ownership-or-control statements by year
 - Statistic: Count of subjects of ownership-or-control statements by year

libcovebods/api.py

@@ -34,6 +34,8 @@ def bods_json_output(output_dir, file, file_type=None, json_data=None,
 
         raise Exception("JSON only for now, sorry!")
 
+    context['schema_version'] = schema_bods.schema_version
+
     context = context_api_transform(
         common_checks_bods(context, output_dir, json_data, schema_bods, lib_cove_bods_config=lib_cove_bods_config)
     )

libcovebods/config.py

@@ -12,6 +12,7 @@
     # These details are used if the data does not specify a version
     'schema_url': os.path.join(_schema_folder, 'schema-0-1-0.json'),
     'schema_url_host': _schema_folder,
+    'schema_version': '0.1',
     # But from 0.2 onwards, data should specify a version
     'schema_versions': {
         '0.2': {

libcovebods/schema.py

@@ -7,6 +7,7 @@ def __init__(self, json_data=None, lib_cove_bods_config=None):
         # The default schema we use ...
         self.release_pkg_schema_url = lib_cove_bods_config.config['schema_url']
         self.schema_host = lib_cove_bods_config.config['schema_url_host']
+        self.schema_version = lib_cove_bods_config.config['schema_version']
         # ... unless the data specifies a version.
         if isinstance(json_data, list) and len(json_data) > 0:
             statement = json_data[0]
@@ -19,3 +20,4 @@ def __init__(self, json_data=None, lib_cove_bods_config=None):
                 if version in lib_cove_bods_config.config['schema_versions']:
                     self.release_pkg_schema_url = lib_cove_bods_config.config['schema_versions'][version]['schema_url']
                     self.schema_host = lib_cove_bods_config.config['schema_versions'][version]['schema_url_host']
+                    self.schema_version = version

tests/test_api_0_1.py

@@ -51,6 +51,7 @@ def test_basic_1():
 
     results = bods_json_output(cove_temp_folder, json_filename)
 
+    assert results['schema_version'] == '0.1'
     assert results['validation_errors_count'] == 0
     assert results['additional_fields_count'] == 0
     assert results['additional_checks_count'] == 0

tests/test_api_0_2.py

@@ -12,6 +12,7 @@ def test_basic_1():
 
     results = bods_json_output(cove_temp_folder, json_filename)
 
+    assert results['schema_version'] == '0.2'
     assert results['validation_errors_count'] == 0
     assert results['additional_fields_count'] == 0
     assert results['additional_checks_count'] == 0