ons_openapi 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7478d7a40489fbc9f28fb75fff66c252dafdecc4
-  data.tar.gz: 6635ce15b7e02d542703ec04265d77486dd44d6c
+  metadata.gz: 9e9b0ecd250e85250822dd7168ec4ea3e672f570
+  data.tar.gz: d80fa1a605559bcc970c3fa52650e0651c7b091a
 SHA512:
-  metadata.gz: 8a50990151e4ce9c4312bad08388caf5031c712f2dafff8ad4c823eadc4bb67e138010bcb2996f650ff9c3edb0e4e36652c8738573fb125a0223b3ba72aabe95
-  data.tar.gz: d4c57a354e13b6674527d8eaf16b42204447eb1ba4e95fa12195b2dbe78c08a38f9e8cda98af8eb550d87e2c72b895eefe199d3d38eb28e7d75ffe789abdae8e
+  metadata.gz: 695be3534ff8af36cbdfcfcb011925dacacdb14c2b82d080857620a5a56d42b28b5d7f88a3e4d7770ee506245b01e92a5c8f92255abd3189c5e256fade3dac73
+  data.tar.gz: 9414cda40c2b2098ad4e980fd274f8ef08baaecfbcdd1cac157d914e911c64c075760157816eaf4a18c354364d3d4868a154bdf32ea5922d4f1752af5ee310f3

data/lib/ons_openapi.rb

@@ -29,7 +29,7 @@ require 'open-uri'
 # See README for usage documentation.
 module OnsOpenApi
 
-  VERSION = "0.1.1" unless defined? OnsOpenApi::VERSION
+  VERSION = "0.1.2" unless defined? OnsOpenApi::VERSION
 
   class << self
 
@@ -62,4 +62,3 @@ require File.dirname(__FILE__) + '/ons_openapi/dimension'
 require File.dirname(__FILE__) + '/ons_openapi/value'
 require File.dirname(__FILE__) + '/ons_openapi/geographical_hierarchy'
 require File.dirname(__FILE__) + '/ons_openapi/item'
-

data/lib/ons_openapi/collection.rb

@@ -11,6 +11,7 @@ class OnsOpenApi::Collection
   # 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
@@ -65,12 +66,14 @@ class OnsOpenApi::Collection
   # 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
+  # 2014WARDH - 2014 Administrative Hierarchy
+  # 2011WARDH - 2011 Administrative Hierarchy
   # 2011PARISH - 2011 Parish Hierarchy
+  # 2011PCONH - 2011 Westminster Parliamentary Constituency Hierarchy
+  # 2011NAWH - 2011 National Assembley for Wales Electoral Hierarchy
+  # 2013HEALTHH - 2013 Health Area Hierarchy
+  # 2011BUAH - 2011 Built-up area hierarchy
   #
   def geography_codes
     gh ||= geographical_hierarchies

data/lib/ons_openapi/context.rb

@@ -59,42 +59,56 @@ class OnsOpenApi::Context
 
   # Returns geography objects for given geography code.
   #
-  # Parameter +code+ defaults to +'2011WARDH'+ for the 2011 Administrative
+  # Parameter +code+ defaults to +'2014WARDH'+ for the 2014 Administrative
   # Hierarchy, if no +code+ supplied.
   #
+  # Option +levels+ defaults to +'0,1,2,3,4,5,6,7'+. You can specify levels,
+  # e.g. geographies('2011WARDH', levels: '0,1,2,3,4,5')
+  #
   # Codes include:
   # +2011WARDH+ - 2011 Administrative Hierarchy
+  # +2012WARDH+ - 2012 Administrative Hierarchy
+  # +2013WARDH+ - 2013 Administrative Hierarchy
+  # +2014WARDH+ - 2014 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'
+  def geographies code='2011WARDH', option={ levels: '0,1,2,3,4,5,6,7' }
     @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
-
+    levels = if code == '2011STATH' && option[:levels][/6|7|8|9/] # restrict levels to reduce delay
+               '0,1,2,3,4,5'
+             else # hierarchies require levels param be set
+               option[:levels]
+             end
+
+    key = [code, levels].join('-')
+    unless @geographies[key]
+      params = { context: @name, levels: levels }
       result = OnsOpenApi::get "hierarchies/hierarchy/#{code}", params
-      @geographies[code] = result.geography_list.items.items
+      @geographies[key] = result.geography_list.items.items
     end
-    @geographies[code].each {|g| g.geography_code = code }
-    @geographies[code]
+    @geographies[key].each {|g| g.geography_code = code }
+    @geographies[key]
   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']}
+  # Returns geography objects from the given Administrative Hierarchy
+  # with area type 'Electoral Division'.
+  #
+  # Parameter +code+ defaults to +'2014WARDH'+ for the 2014 Administrative
+  # Hierarchy, if no +code+ supplied.
+  def electoral_divisions code='2014WARDH'
+    geographies(code).select {|z| z.area_type.codename['Electoral Division']}
   end
 
-  # Returns geography objects from the 2011 Administrative Hierarchy
+  # Returns geography objects from the given Administrative Hierarchy
   # with area type 'Electoral Ward/Division'
-  def electoral_wards
-    geographies('2011WARDH').select {|z| z.area_type.codename['Electoral Ward/Division']}
+  #
+  # Parameter +code+ defaults to +'2014WARDH'+ for the 2014 Administrative
+  # Hierarchy, if no +code+ supplied.
+  def electoral_wards code='2014WARDH'
+    geographies(code).select {|z| z.area_type.codename['Electoral Ward/Division']}
   end
 
   private

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: ons_openapi
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Rob McKinnon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-17 00:00:00.000000000 Z
+date: 2016-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: morph
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.8'
 - !ruby/object:Gem::Dependency
   name: execjs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.5'
 description: Ruby wrapper around the ONS OpenAPI making easy to quickly retrieve data.
@@ -113,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper around the ONS OpenAPI - the UK Office of National Statistics's