ons_openapi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b1a1edf4c26311e209664f2c74d01601f169c77d
+  data.tar.gz: d25742c9874d3bd14602b0cd1a0bafc89ea83ed4
+SHA512:
+  metadata.gz: 211e09eae5a302907f2a1f06256fbe88e592c48d85609bfc901b3802d3a960b0cd14bc12b1ea18f75aa89688c1dcbbeaaad61bd2b295277786cd0a72c04d1694
+  data.tar.gz: e172c11cf23355fcc0db0519b37bbde324beb677023cf7e4e05df9434f5ea666b823705e7d2724b2f2338a93c6b3f1280422bf03a585dac2c65ec880cc124966

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Rob McKinnon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,218 @@
+ons-openapi
+===========
+
+Ruby wrapper around the [ONS OpenAPI](https://www.ons.gov.uk/ons/apiservice/web/apiservice/home) - the UK Office of National Statistics's data API. The intention is to make it easy to quickly retrieve data. It may not expose the full functionality of the ONS OpenAPI.
+
+This gem was partially written at [Accountability Hack 2014](https://twitter.com/search?q=%23AccHack14), an event organised by Parliament, ONS, and NAO.
+
+Please provide feedback via [GitHub issues](https://github.com/robmckinnon/ons-openapi/issues).
+
+# Installation
+
+```
+gem install ons_openapi
+```
+
+then in Ruby code
+
+```
+require 'ons_openapi'
+```
+
+or if using bundler (as with Rails), add to the Gemfile
+
+```
+gem 'ons_openapi'
+```
+
+You must have an ExecJS supported runtime when running this gem. If you are using Mac OS X or Windows, you already have a JavaScript runtime installed in your operating system. Check [ExecJS documentation](https://github.com/sstephenson/execjs#readme) to know all supported JavaScript runtimes.
+
+The gem includes code from the [JSON-stat Javascript Toolkit](https://github.com/badosa/JSON-stat) to parse JSON-stat formatted results from the ONS OpenAPI. ExecJS is used to run JSON-stat JavaScript code from within Ruby.
+
+# Register for API key
+
+The ONS OpenAPI requires you [register for an API key](https://www.ons.gov.uk/ons/apiservice/web/apiservice/home#reg-main-content).
+
+When using the gem, set an environment variable named `ONS_APIKEY` with your API key value.
+
+```
+$ ONS_APIKEY=<your_ons_openapi_key>
+```
+
+# Getting started
+
+Running in irb:
+
+    $ ONS_APIKEY=<your_ons_openapi_key> irb
+
+    require 'ons_openapi'
+
+    census = OnsOpenApi.context('Census')
+
+    religion_detailed = census.collection('Religion (detailed)')
+
+    religion_detailed.data_for('Islington')
+    #=> [["2011 Administrative Hierarchy", "Religion (Flat) (T059A)", "Time Dimension", "Value"],
+    #    ["Islington", "All categories: Religion", "2011", 206125],
+    #    ["Islington", "Christian", "2011", 82879],
+    #    ["Islington", "Buddhist", "2011", 2117],
+    #  ...
+
+    religion_detailed.data_for('Islington S')
+    #=> [["2011 Westminster Parliamentary Constituency Hierarchy", "Religion (Flat) (T059A)", "Time", "Value"],
+    #    ["Islington South and Finsbury", "All categories: Religion", "2011", 102656],
+    #    ["Islington South and Finsbury", "Christian", "2011", 42222],
+    #    ["Islington South and Finsbury", "Buddhist", "2011", 1126],
+    #  ...
+
+    religion_detailed.data_for('England')
+    #=> [["2011 Administrative Hierarchy", "Religion (Flat) (T059A)", "Time Dimension", "Value"],
+    #    ["England", "All categories: Religion", "2011", 53012456],
+    #    ["England", "Christian", "2011", 31479876],
+    #    ["England", "Buddhist", "2011", 238626],
+    #  ...
+
+    religion_detailed.data_for('North West')
+    #=> [["2011 Administrative Hierarchy", "Religion (Flat) (T059A)", "Time Dimension", "Value"],
+    #    ["North West", "All categories: Religion", "2011", 7052177],
+    #    ["North West", "Christian", "2011", 4742860],
+    #    ["North West", "Buddhist", "2011", 20695]
+
+    religion_detailed.data_for('Scotland')
+    # RuntimeError: ONS Exception: 404 INTERNAL ERROR: Invalid dimension item code S92000003
+
+    religion_detailed.data_for('Woodlands')
+    # RuntimeError: more than one match, try one of:
+    #
+    # data_for('E05006341 Woodlands') or data_for('E05006341') see http://statistics.data.gov.uk/doc/statistical-geography/E05006341
+    #
+    # data_for('E05008891 Woodlands') or data_for('E05008891') see http://statistics.data.gov.uk/doc/statistical-geography/E05008891
+    #
+    # data_for('E05001234 Woodlands') or data_for('E05001234') see http://statistics.data.gov.uk/doc/statistical-geography/E05001234
+    #
+    # data_for('E05004981 Woodlands') or data_for('E05004981') see http://statistics.data.gov.uk/doc/statistical-geography/E05004981
+
+
+# Contexts
+
+The datastore underneath the ONS OpenAPI is divided into four sections called contexts.
+
+    OnsOpenApi.context_names
+    #=> ["Census", "Socio-Economic", "Economic", "Social"]
+
+    OnsOpenApi.contexts.size
+    #=> 4
+
+The Census context contains data from the 2011 Census in England and Wales.
+
+# Collections
+
+Each context consists of several dataset collections.
+
+    economic = OnsOpenApi.context('Economic')
+    economic.collections.size
+    #=> 26
+
+    census = OnsOpenApi.context('Census')
+    census.collections.size
+    #=> 340
+
+Use `collection_names()` to view a list of collection names:
+
+    puts census.collection_names.select {|n| n[/religion/i]}
+    # DC1202EW Household composition by religion of Household Reference Person (HRP)
+    # DC2107EW Religion by sex by age
+    # DC2201EW Ethnic group by religion
+    # ...
+    # QS208EW Religion
+    # QS210EW Religion (detailed)
+    # ST210EWla Religion (non-UK born short-term residents)
+
+Retrieve a collection using `collection()`. Pass in the collection code, collection name, or collection code and name:
+
+    census.collection('QS210EW')
+    census.collection('Religion (detailed)')
+    census.collection('QS210EW Religion (detailed)')
+
+# Geographical hierarchies
+
+Each collection can be filtered with different geographical hierarchies.
+
+    census = OnsOpenApi.context('Census')
+    religion = census.collection('Religion')
+
+    religion.geography_codes
+    # [
+    #   ["2011STATH", "2011 Statistical Geography Hierarchy"],
+    #   ["2011WARDH", "2011 Administrative Hierarchy"],
+    #   ["2011PCONH", "2011 Westminster Parliamentary Constituency Hierarchy"]
+    # ]
+
+# Listing areas from geography hierarchy
+
+Use `geographies()` to get a hash of geography hierarchies. To get a list of geography items for a hierarchy, say '2011PCONH', do:
+
+    census = OnsOpenApi.context('Census')
+    religion = census.collection('Religion')
+    constituencies = religion.geographies['2011PCONH']
+
+    constituencies.map(&:label)
+    # ["Aberavon", "Aberconwy", "Aldershot", "Aldridge-Brownhills", ...
+
+    constituencies.map(&:item_code)
+    # ["E14000759", "E14000531", "E14000967", "E14000904", ...
+
+To see `area_types` in the hierarchy:
+
+    constituencies.map(&:area_type).map {|a| [a.codename, a.level]}.uniq
+    # [["Westminster Parliamentary Constituency", 3],
+    #  ["Region", 2],
+    #  ["Country", 1],
+    #  ["England and Wales", 0]]
+
+Or for hierarchy '2011WARDH', do:
+
+    areas = religion.geographies['2011WARDH']
+
+    areas.map(&:label)
+    # ["Aldwick East", "West Mersea", "Stowmarket Central", ...
+
+    areas.map {|a| [a.item_code, a.label, a.area_type.codename, a.area_type.level]}
+    # [["E05007576", "Aldwick East", "Electoral Ward/Division ", 7],
+    #  ["E05004144", "West Mersea", "Electoral Ward/Division ", 7],
+    #  ["E05007153", "Stowmarket Central", "Electoral Ward/Division ", 7]], ...
+
+To see `area_types` in the hierarchy:
+
+    areas.map(&:area_type).map {|a| [a.codename, a.level]}.uniq
+    # [["Electoral Ward/Division ", 7],
+    #  ["Electoral Division", 7],
+    #  ["Metropolitan District ", 6],
+    #  ["Council Area", 4],
+    #  ["County", 5],
+    #  ["Non-metropolitan District", 6],
+    #  ["London Borough ", 6],
+    #  ["Unitary Authority", 5],
+    #  ["Metropolitan County", 5],
+    #  ["Country", 3],
+    #  ["Great Britain", 1],
+    #  ["United Kingdom", 0],
+    #  ["Region", 4],
+    #  ["England and Wales", 2],
+    #  ["Inner and Outer London", 5]]
+
+# Data for a geographic area
+
+Use `data_for()` to retrieve data for a geography that matches given label_or_code.
+
+    census = OnsOpenApi.context('Census')
+    religion = census.collection('Religion')
+
+    religion.data_for('England')
+    religion.data_for('Islington S')
+    religion.data_for('E05002040')
+
+# Feedback
+
+Please provide feedback via [GitHub issues](https://github.com/robmckinnon/ons-openapi/issues).
+

data/lib/ons_openapi/classification.rb

@@ -0,0 +1,10 @@
+class OnsOpenApi::Classification
+
+  include Morph
+  include OnsOpenApi::DataHelper
+
+  def classification_detail
+    OnsOpenApi::get(url.first, url.last).classification_detail
+  end
+
+end

data/lib/ons_openapi/collection.rb

@@ -0,0 +1,151 @@
+class OnsOpenApi::Collection
+
+  include Morph
+  include OnsOpenApi::DataHelper
+
+  # Returns title, i.e. "id name"
+  def title
+    [id, name].join(' ')
+  end
+
+  # Returns data as array of arrays, for a geography that matches label_or_code.
+  # e.g. data_for('England'), data_for('Islington S'), data_for('E05002040')
+  # Raises exception if no match or more than one match.
+  def data_for label_or_code
+    if geographies = geography(label_or_code)
+      if geographies.size > 1
+        cmds = geographies.map {|g| "data_for('#{g.title}') or data_for('#{g.item_code}') see http://statistics.data.gov.uk/doc/statistical-geography/#{g.item_code}"}
+        raise "more than one match, try one of:\n\n  #{cmds.join("  \n\n  ") }\n\n"
+      else
+        geo = geographies.first
+        data geo.item_code, geo.geography_code
+      end
+    end
+  end
+
+  # Returns data for given geog_code, geog, and optional JSON-stat command.
+  def data geog_code, geog, stat='.toTable()'
+    @json_stats ||={}
+    @json_stats[geog_code + geog] ||= OnsOpenApi::request("dataset/#{id}",
+        context: context_name,
+        geog: geog,
+        "dm/#{geog}" => geog_code,
+        totals: 'false',
+        jsontype: 'json-stat')
+
+    raw_json_stat = @json_stats[geog_code + geog].gsub("\n", ' ').gsub("'", "").squeeze(' ')
+
+    if raw_json_stat.include?('ns1faultstring')
+      raise "ONS Exception: #{raw_json_stat.gsub(/(<.?ns1XMLFault>)|(<.?ns1faultstring>)/,'')}"
+    elsif raw_json_stat.include?('errorMessage')
+      raise "ONS Error: #{raw_json_stat}"
+    end
+
+    begin
+      table = js_context.eval( %Q| JSONstat( JSON.parse(' #{raw_json_stat} ') ).Dataset(0)#{stat} | )
+    rescue Encoding::UndefinedConversionError => e
+      if e.to_s[/ASCII-8BIT to UTF-8/]
+        raw_json_stat = raw_json_stat.force_encoding('ASCII-8BIT').encode('UTF-8', :invalid => :replace, :undef => :replace, :replace => '?')
+        table = js_context.eval( %Q| JSONstat( JSON.parse(' #{raw_json_stat} ') ).Dataset(0)#{stat} | )
+      else
+        raise "#{e.to_s}: #{raw_json_stat}"
+      end
+    rescue ExecJS::RuntimeError, ExecJS::ProgramError => e
+      raise "#{e.to_s}: #{raw_json_stat}"
+    end
+
+    if table.is_a?(Array) && (index = table[1].index('Segment_1'))
+      table.each {|row| row.delete_at(index)}
+    end
+    table
+  end
+
+  #
+  # Returns array of [geography_code, description] that are supported by this
+  # collection.
+  #
+  # e.g.
+  # 2011WARDH - 2011 Administrative Hierarchy
+  # 2011STATH - 2011 Statistical Geography Hierarchy
+  # 2011PCONH - 2011 Westminster Parliamentary Constituency Hierarchy
+  # 2011HTWARDH - 2011 Census Merged Ward Hierarchy
+  # 2011CMLADH - 2011 Census merged local authority district hierarchy
+  # 2011PARISH - 2011 Parish Hierarchy
+  #
+  def geography_codes
+    gh ||= geographical_hierarchies
+    @geographies_data ||= if gh.respond_to?(:geographical_hierarchy) && gh.geographical_hierarchy
+      url, args = gh.geographical_hierarchy.url
+      OnsOpenApi::get(url, args)
+    elsif gh.respond_to?(:geographical_hierarchies) && gh.geographical_hierarchies
+      url, args = gh.geographical_hierarchies.first.url
+      OnsOpenApi::get(url, args)
+    end
+
+    if @geographies_data
+      list = @geographies_data.geographical_hierarchy_list
+      if list.respond_to?(:geographical_hierarchy) && list.geographical_hierarchy
+        [ [list.geographical_hierarchy.id, list.geographical_hierarchy.name] ]
+      elsif list.respond_to?(:geographical_hierarchies) && list.geographical_hierarchies
+        list.geographical_hierarchies.map{|x| [x.id, x.name]}
+      else
+        []
+      end
+    else
+      []
+    end
+  end
+
+  # Returns geography item that matches given label_or_code.
+  # Raises exception if there is no match.
+  def geography label_or_code
+    if matches = geography_exact_match(label_or_code) || geography_partial_match(label_or_code)
+      matches
+    else
+      raise "no geography match found for: #{label_or_code}"
+    end
+  end
+
+  # Returns collection_detail object.
+  def collection_detail
+    OnsOpenApi::get(url.first, url.last).collection_detail
+  end
+
+  # Returns hash of geography code to list of geography items.
+  def geographies
+    codes = geography_codes.map(&:first)
+    codes.each_with_object({}) do |code, hash|
+      hash[code] = OnsOpenApi.context(context_name).geographies(code)
+    end
+  end
+
+  private
+
+  def geography_exact_match label_or_code
+    matches = []
+    geographies.values.each do |list|
+      found = list.select{|c| (c.label == label_or_code) || (c.item_code == label_or_code) || (c.title == label_or_code) }
+      matches += found unless found.empty?
+    end
+    matches.empty? ? nil : matches.uniq {|m| m.item_code}
+  end
+
+  def geography_partial_match label_or_code
+    matches = []
+    geographies.values.each do |list|
+      found = list.select{|c| c.label[label_or_code] }
+      matches += found unless found.empty?
+    end
+    matches.empty? ? nil : matches.uniq {|m| m.item_code}
+  end
+
+  def js_context
+    unless @js_context
+      jsonstatjs = File.expand_path('../../../vendor/json-stat.max.js', __FILE__)
+      source = open(jsonstatjs).read
+      @js_context = ExecJS.compile(source)
+    end
+    @js_context
+  end
+
+end

data/lib/ons_openapi/concept.rb

@@ -0,0 +1,6 @@
+class OnsOpenApi::Concept
+
+  include Morph
+  include OnsOpenApi::DataHelper
+
+end

data/lib/ons_openapi/connection.rb

@@ -0,0 +1,65 @@
+require 'net/https'
+
+module OnsOpenApi::Connection
+
+  BASE_URI = 'http://data.ons.gov.uk/ons/api/data/'
+  API_KEY = ENV['ONS_APIKEY']
+
+  def get(resource, args={})
+    to_object request(resource, "get", args)
+  end
+
+  def post(resource, args={})
+    to_object request(resource, "post", args)
+  end
+
+  def to_object json
+    json.gsub!('"@', '"')
+    json.gsub!('xml.lang','xml_lang')
+    json.gsub!('"$":','"text":')
+    json.gsub!('"2011WARDH" : {', '"X2011WARDH" : {')
+    json.gsub!('"2011HTWARDH" : {', '"X2011HTWARDH" : {')
+    hash = JSON.parse json
+    Morph.from_hash hash, OnsOpenApi
+  end
+
+  def request_uri(resource, args)
+    unless API_KEY
+      raise 'No ONS OpenAPI key found. Set this environment variable: ONS_APIKEY=<your_ons_openapi_key>'
+    end
+    uri = URI.join(BASE_URI, (resource+'.json').sub('.json.json','.json') )
+
+    args ||= {}
+    args.delete('apikey')
+    args.merge!( apikey: API_KEY )
+    uri.query = args.map { |k,v| "%s=%s" % [URI.encode(k.to_s), URI.encode(v.to_s)] }.join("&") if args
+
+    puts uri.to_s
+    uri
+  end
+
+  def request(resource, method="get", args)
+    uri = request_uri resource, args
+    case method
+    when "get"
+      req = Net::HTTP::Get.new(uri.request_uri)
+    when "post"
+      req = Net::HTTP::Post.new(uri.request_uri)
+    end
+
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = (uri.port == 443)
+
+    res = http.start() { |conn| conn.request(req) }
+    res.body
+  end
+
+end
+
+module OnsOpenApi
+
+  class << self
+    include OnsOpenApi::Connection
+  end
+
+end

data/lib/ons_openapi/context.rb

@@ -0,0 +1,106 @@
+class OnsOpenApi::Context
+
+  include Morph
+
+  class << self
+    def all
+      @contexts ||= OnsOpenApi::get('contexts').context_list.statistical_contexts.map {|x| new x}
+    end
+  end
+
+  def initialize x
+    self.id = x.context_id
+    self.name = x.context_name
+  end
+
+  def concepts
+    @concepts ||= OnsOpenApi::get('concepts', context: @name).concept_list.concepts
+  end
+
+  def collections
+    @collections ||= OnsOpenApi::get('collections', context: @name).collection_list.collections
+    unless @collections.first.respond_to?(:context_name) && @collections.first.context_name
+      @collections.each {|c| c.context_name = @name}
+    end
+    @collections
+  end
+
+  def classifications
+    @classifications ||= OnsOpenApi::get('classifications', context: @name).classification_list.classifications
+  end
+
+  def collection id_or_name
+    collection = collections.detect{|c| (c.id == id_or_name || c.title == id_or_name) }
+
+    unless collection
+      list = collections.select{|c| c.name == id_or_name}
+      if list.size > 1
+        cmds = list.map{|c| [c.id,c.title]}.flatten.map{|n| "collection('#{n}')"}
+        raise "more than one match, try one of:\n\n  #{cmds.join("  \n\n  ") }\n\n"
+      else
+        collection = list.first
+      end
+    end
+
+    collection
+  end
+
+  def concept_names
+    names_for concepts
+  end
+
+  def collection_names
+    names_for collections
+  end
+
+  def classification_names
+    names_for classifications
+  end
+
+  # Returns geography objects for given geography code.
+  #
+  # Parameter +code+ defaults to +'2011WARDH'+ for the 2011 Administrative
+  # Hierarchy, if no +code+ supplied.
+  #
+  # Codes include:
+  # +2011WARDH+ - 2011 Administrative Hierarchy
+  # +2011STATH+ - 2011 Statistical Geography Hierarchy
+  # +2011PCONH+ - 2011 Westminster Parliamentary Constituency Hierarchy
+  # +2011HTWARDH+ - 2011 Census Merged Ward Hierarchy
+  # +2011CMLADH+ - 2011 Census merged local authority district hierarchy
+  # +2011PARISH+ - 2011 Parish Hierarchy
+  def geographies code='2011WARDH'
+    @geographies ||= {}
+    unless @geographies[code]
+      params = { context: @name }
+
+      if code == '2011STATH'
+        params.merge!({ levels: '0,1,2,3,4,5' }) # restrict levels to reduce delay
+      end
+
+      result = OnsOpenApi::get "hierarchies/hierarchy/#{code}", params
+      @geographies[code] = result.geography_list.items.items
+    end
+    @geographies[code].each {|g| g.geography_code = code }
+    @geographies[code]
+  end
+
+  # Returns geography objects from the 2011 Administrative Hierarchy
+  # with area type 'Electoral Division'
+  def electoral_divisions
+    geographies('2011WARDH').select {|z| z.area_type.codename['Electoral Division']}
+  end
+
+  # Returns geography objects from the 2011 Administrative Hierarchy
+  # with area type 'Electoral Ward/Division'
+  def electoral_wards
+    geographies('2011WARDH').select {|z| z.area_type.codename['Electoral Ward/Division']}
+  end
+
+  private
+
+  def names_for list
+    list.map(&:title)
+  end
+
+end

data/lib/ons_openapi/data_helper.rb

@@ -0,0 +1,5 @@
+module OnsOpenApi::DataHelper
+
+  include OnsOpenApi::NameHelper
+  include OnsOpenApi::UrlHelper
+end

data/lib/ons_openapi/dimension.rb

@@ -0,0 +1,46 @@
+class OnsOpenApi::Dimension
+
+  include Morph
+
+  def values
+    ids.each_with_object({}) do |x, h|
+      h[alt_label(x)] = send(method(x))
+    end
+  end
+
+  def labels
+    data = values
+    non_data_keys = role.morph_attributes.values.flatten.map{|x| alt_label x}
+    non_data_keys.each do |k|
+      data.delete(k)
+    end
+    data = data.values.first.category
+
+    key_to_index = data.index.morph_attributes
+    key_to_label = data.label.morph_attributes
+
+    labels = key_to_index.to_a.each_with_object([]) do |k_i, a|
+      if index = k_i[1]
+        key = k_i[0]
+        a[index] = key_to_label[key]
+      end
+    end
+
+    # label = data.label
+    # items = data.category.index
+    # labels = data.category.label
+  end
+
+  private
+
+  def alt_label x
+    x['2011WARDH'] ? 'X2011_WARDH' : x
+    x['2011HTWARDH'] ? 'X2011_HTWARDH' : x
+  end
+
+  def method x
+    x = alt_label x
+    method = Morph::InstanceMethods::Helper.convert_to_morph_method_name x
+  end
+
+end

data/lib/ons_openapi/geographical_hierarchy.rb

@@ -0,0 +1,6 @@
+class OnsOpenApi::GeographicalHierarchy
+
+  include Morph
+  include OnsOpenApi::DataHelper
+
+end

data/lib/ons_openapi/item.rb

@@ -0,0 +1,13 @@
+class OnsOpenApi::Item
+
+  include Morph
+
+  def label
+    labels.labels.first.text
+  end
+
+  def title
+    [item_code, label].join(' ')
+  end
+
+end

data/lib/ons_openapi/name_helper.rb

@@ -0,0 +1,7 @@
+module OnsOpenApi::NameHelper
+
+  def name
+    names.names.first.text
+  end
+
+end

data/lib/ons_openapi/url_helper.rb

@@ -0,0 +1,12 @@
+module OnsOpenApi::UrlHelper
+
+  def url
+    require 'cgi'
+    if respond_to?(:urls) && urls
+      uri = URI.parse urls.urls.detect{|x| x.representation['json'] }.href
+      params = Rack::Utils.parse_query(uri.query)
+      params.delete('apikey')
+      return [uri.path, params]
+    end
+  end
+end