Issue/7 json complete mode

.rubocop.yml

@@ -1,4 +1,4 @@
-Metrics/LineLength:
+Layout/LineLength:
   Max: 100
   Exclude:
     - spec/**/*

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog for DS API rubygem
 
+## 1.1.0 - 2021-10-28 (Bogdan)
+
+- Added support for `@json_mode: "complete"` query parameter
+
 ## 1.0.0 - 2021-06-14 (Bogdan)
 
 - Added a DSAPI to SapiNT converter, which converts all DSAPI queries

README.md

@@ -6,10 +6,26 @@ This gem provides a Ruby API for the [data services API](https://github.com/epim
 
 Add this line to your application's Gemfile:
 
-    gem 'data-api'
+```ruby
+gem 'data-api'
+```
 
 And then execute:
 
-    $ bundle
+```sh
+bundle
+```
 
-Also, an API URL needs to be provided for the Service class in order for the gem to work
+Also, an API URL needs to be provided for the Service class in order for the gem
+to work.
+
+## Tests
+
+To run the tests you must set the environment variable `API_URL` to point to a
+running instance of a valid SAPINT API and run:
+
+```sh
+rake test
+```
+
+If `API_URL` is not set it will default to `http://localhost:8888`

lib/data_services_api/dataset.rb

@@ -26,6 +26,10 @@ def data_api
       @json['data-api']
     end
 
+    def dataset
+      @json['dataset']
+    end
+
     def structure_api
       @json['structure-api']
     end
@@ -51,7 +55,8 @@ def structure
     def query(query)
       sapi_query_params = SapiNTConverter.new(query.to_json).to_sapint_query
       sapint_response = service.api_get_json(data_api, sapi_query_params)
-      DSAPIResponseConverter.new(sapint_response, data_api).to_dsapi_response
+      json_mode_compact = query.terms['@json_mode'] == 'compact'
+      DSAPIResponseConverter.new(sapint_response, dataset, json_mode_compact).to_dsapi_response
     end
 
     def describe(uri)

lib/data_services_api/dsapi_response_converter.rb

@@ -2,9 +2,10 @@
 
 module DataServicesApi
   class DSAPIResponseConverter
-    def initialize(sapint_response, data_api)
+    def initialize(sapint_response, dataset_name, json_mode_compact = false)
       @sapint_response = sapint_response
-      @data_api = data_api
+      @dataset_name = dataset_name
+      @json_mode_compact = json_mode_compact
     end
 
     # Converts SAPINT returned JSON format to DSAPI returned JSON format
@@ -22,15 +23,34 @@ def to_dsapi_item(sapint_item)
       end
     end
 
+    # Return different response formats based on the set JSON mode
     def to_dsapi_json(sapint_key, sapint_value)
-      dataset_name = @data_api[/[a-z]*$/]
+      return json_mode_compact(sapint_key, sapint_value) if @json_mode_compact
 
+      json_mode_complete(sapint_key, sapint_value)
+    end
+
+    def json_mode_compact(sapint_key, sapint_value)
       return { sapint_key => sapint_value } if sapint_key == '@id'
-      return { "#{dataset_name}:#{sapint_key}" => sapint_value } unless sapint_value.is_a?(Hash)
+      return { "#{@dataset_name}:#{sapint_key}" => sapint_value } unless sapint_value.is_a?(Hash)
 
       sapint_value.map do |key, value|
-        ["#{dataset_name}:#{sapint_key}#{key == '@id' ? '' : key.capitalize}", value]
+        ["#{@dataset_name}:#{sapint_key}#{key == '@id' ? '' : key.capitalize}", value]
       end.to_h
     end
+
+    def json_mode_complete(sapint_key, sapint_value)
+      case sapint_key
+      when '@id'
+        return { sapint_key => sapint_value }
+      when 'refMonth'
+        return { "#{@dataset_name}:#{sapint_key}" => { '@value' => sapint_value } }
+      when 'refPeriodStart'
+        return { "#{@dataset_name}:#{sapint_key}" => [{ '@value' => sapint_value }] }
+      end
+      return { "#{@dataset_name}:#{sapint_key}" => [sapint_value] } unless sapint_value.is_a?(Hash)
+
+      { "#{@dataset_name}:#{sapint_key}" => sapint_value }
+    end
   end
 end

lib/data_services_api/service.rb

@@ -17,7 +17,8 @@ def dataset(name)
       raise 'Dataset name is required' unless name
 
       endpoint = {
-        'data-api' => "#{@url}/landregistry/id/#{name}"
+        'data-api' => "#{@url}/landregistry/id/#{name}",
+        'dataset' => name
       }
       Dataset.new(endpoint, self)
     end

lib/data_services_api/version.rb

@@ -2,6 +2,6 @@
 
 # :nodoc:
 module DataServicesApi
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
   MAJOR, MINOR, PATCH = VERSION.split('.')
 end

spec/data_services_api/dataset_spec.rb

@@ -5,7 +5,8 @@
 describe 'DataServiceApi::Dataset' do
   before do
     VCR.insert_cassette name, record: :new_episodes
-    @dataset = DataServicesApi::Service.new(url: 'http://localhost:8080').dataset('ukhpi')
+    api_url = ENV['API_URL'] || 'http://localhost:8888'
+    @dataset = DataServicesApi::Service.new(url: api_url).dataset('ukhpi')
   end
 
   after do
@@ -18,7 +19,16 @@
   end
 
   it 'should accept a query and return the result' do
-    query = { 'ukhpi:refRegion' => { '@eq' => { '@id' => 'http://landregistry.data.gov.uk/id/region/somerset' } } }
+    query = Class.new do
+      def terms
+        { '@and' => [{ 'ukhpi:refMonth' => { '@ge' => { :@value => '2019-01', :@type => 'http://www.w3.org/2001/XMLSchema#gYearMonth' } } }, { 'ukhpi:refRegion' => { '@eq' => { :@id => 'http://landregistry.data.gov.uk/id/region/united-kingdom' } } }], '@sort' => [{ '@down' => 'ukhpi:refMonth' }], '@limit' => 1 }
+      end
+
+      def to_json(*_args)
+        terms.to_json
+      end
+    end.new
+
     json = @dataset.query(query)
     _(json).wont_be_nil
     _(json.size).must_be :>, 0