r4digitalnz 1.0

data/README

@@ -0,0 +1,21 @@
+= Ruby 4 Digital NZ
+
+Ruby 4 Digital NZ is an interface to the Digital NZ public API. See http://www.digitalnz.org/developer
+
+The rubyforge project : http://r4digitalnz.rubyforge.org
+
+You will require an api key to use this gem. See http://www.digitalnz.org/developer/getting-started/
+
+= Installation
+Type this in a console (you might need to be superuser)
+ gem install r4digitalnz
+
+= Usage
+
+ require 'rubygems'
+ require 'r4digitalnz'
+
+ api_key = "your_api_key"
+ @digitalNZ = DigitalNZ.new api_key
+ r = @digitalNZ.search "Karori photograph", :num_results => 5, :start => 10
+

data/TODO

@@ -0,0 +1,2 @@
+== General
+* Facets with Active Resource style interface

data/copying.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2009 Henry Maddocks
+
+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/lib/r4digitalnz.rb

@@ -0,0 +1,149 @@
+require 'net/http'
+require 'cgi'
+
+require 'rubygems'
+require 'json'
+require 'active_support'
+
+module R4DigitalNZ
+  class APIException < StandardError; end
+
+  class DigitalNZ    
+      def initialize api_key
+          @api_key = api_key
+          @debug = false
+      end
+    
+      def search query, options = {}
+        command = "/records/v1.json/?api_key=#{@api_key}&search_text=#{CGI.escape query}"
+        unless options.nil?
+          o = options.collect do |k,v|
+              "&#{k.to_s}=#{v}"
+          end
+          command += o.to_s
+        end
+
+        SearchResult.new JSON.parse(send(command))
+      end
+    
+      def meta_data id
+          command = "/records/v1/#{id}.xml/?api_key=#{@api_key}"
+          res = send(command)
+          MetaData.new(Hash.from_xml(res))
+      end
+    
+      def content_partners
+          command = "/content_partners/v1.json/?api_key=#{@api_key}"
+          send command
+      end
+
+      private
+      def send command
+        p command if @debug
+        dnz_url = URI.parse "http://api.digitalnz.org/"
+      
+        @client = Net::HTTP.new dnz_url.host, dnz_url.port
+        res = @client.get(command)
+        p "#{res.code}: #{res.body}" if @debug
+        case res.code.to_i
+        when 200
+          res.body
+        when 404
+          raise APIException, res.code
+        else
+          raise APIException, "#{res.code}: #{res.body}"
+        end
+      end
+
+  end
+  
+  class SearchResult
+    include Enumerable
+    
+    attr :num_results_requested
+    attr :result_count
+    attr :start
+    
+    def initialize res
+      @num_results_requested = res['num_results_requested']
+      @result_count = res['result_count']
+      @start = res['start']
+      
+      @results = res["results"].collect do |r|
+        Result.new r
+      end
+    end
+    
+    def each
+      @results.each {|r| yield r}
+    end
+    
+    def [] index
+      @results[index]
+    end
+  end
+
+  class Result
+    attr_accessor :title
+    attr_accessor :category
+    attr_accessor :content_provider
+    attr_accessor :date
+    attr_accessor :description
+    attr_accessor :display_url
+    attr_accessor :id
+    attr_accessor :metadata_url
+    attr_accessor :source_url
+    attr_accessor :thumbnail_url
+    attr_accessor :syndication_date
+    
+    def initialize res
+      res.each do |k,v|
+        self.send("#{k.gsub('-', '_').to_sym}=", v)
+      end
+    end
+  
+  end
+
+  class Section
+    attr :id
+    attr :mime_type
+    attr :mdtype
+    
+    def initialize hash
+      @id = hash['ID']
+      @mime_type = hash['mdWrap']['MIMETYPE']
+      @mdtype = hash['mdWrap']['MDTYPE']
+      
+      hash['mdWrap']['xmlData'].each do |k,v|
+          (class << self; self;end).class_eval do
+            define_method(k.to_sym) { v }
+          end      
+      end
+
+    end
+  end
+
+  class MetaData
+    include Enumerable
+    
+    attr :objid
+    attr :profile
+  
+    def initialize hash
+      @objid = hash['mets']['OBJID']
+      @profile = hash['mets']['PROFILE']
+      @sections = hash['mets']['dmdSec'].collect do |s|
+        Section.new s
+      end
+    end
+  
+    def each
+      @sections.each {|s| yield s}
+    end
+    
+    def section section_id
+      self.find {|s| s.id == section_id}
+    end
+  end
+
+end # R4DigitalNZ

data/rakefile

@@ -0,0 +1,36 @@
+require 'rake/testtask'
+require 'rake/rdoctask'
+#require 'rake/packagetask'
+require 'rake/gempackagetask'
+
+
+Rake::TestTask.new 'test' do |t|
+    t.pattern = 'test/**/test*.rb'
+end
+
+spec = Gem::Specification.new do |s|
+  s.summary = "An interface to the Digital NZ public API."
+  s.description = "An interface to the Digital NZ public API. See http://www.digitalnz.org/"
+  s.name = "r4digitalnz"
+  s.author = "Henry Maddocks"
+  s.email =  "henry.maddocks@gmail.com"
+  s.homepage = "http://r4digitalnz.rubyforge.org"
+  s.rubyforge_project = "r4digitalnz"
+  s.version = 1.0
+  s.files = FileList["lib/r4digitalnz.rb", "copying.txt", "README", "TODO", "rakefile", "test/*.rb"].to_a
+  s.test_files = FileList["test/*.rb"].to_a
+  s.add_dependency('json', '>=1.1.6')
+  s.add_dependency('activesupport', '>=2.1.0')
+  s.requirements = ['JSON', 'Active Support']
+end
+
+Rake::RDocTask.new do |rd|
+  rd.rdoc_files.include "README", "lib/flickraw.rb", "TODO"
+  rd.options << "--inline-source"
+end
+
+Rake::GemPackageTask.new spec do |p|
+  p.need_tar_gz = true
+end
+
+task 'default' => ['test']

data/test/data.rb

@@ -0,0 +1,317 @@
+$mets = {"mets"=>
+  {"xmlns:xlink"=>"http://www.w3.org/1999/xlink",
+   "xsi:schemaLocation"=>
+    "http://www.loc.gov/METS/ http://www.loc.gov/standards/mets/mets.xsd",
+   "PROFILE"=>"GDL-NLNZ",
+   "dmdSec"=>
+    [{"mdWrap"=>
+       {"xmlData"=>
+         {"format"=>" 1 b&w original negative(s). Glass negative..",
+          "coverage"=>["Karori Road", "1882/1883"],
+          "title"=>
+           "Karori Road, Karori, Wellington, soon after it was constructed",
+          "rights"=>
+           ["http://timeframes.natlib.govt.nz/logicrouter/servlet/LogicRouter?OUTPUTXSL=help-using.xslt",
+            "Alexander Turnbull Library"],
+          "relation"=>"PA-Group-00076",
+          "date"=>"[ca 1882/3]",
+          "type"=>"StillImage",
+          "xmlns:dc"=>"http://www.example.com/example",
+          "description"=>
+           "Karori Road, Karori, Wellington, soon after it was constructed, circa 1882/3. Photograph taken by William Williams.",
+          "identifier"=>["1/2-140324-G", "timeframes:26617"]},
+        "MIMETYPE"=>"text/xml",
+        "MDTYPE"=>"DC"},
+      "ID"=>"dc"},
+     {"mdWrap"=>
+       {"xmlData"=>
+         {"category"=>"Images",
+          "content_partner"=>"Alexander Turnbull Library",
+          "xmlns:dnz"=>"http://www.example.com/example",
+          "rights"=>"Some rights reserved",
+          "object_url"=>
+           "http://digital.natlib.govt.nz/get/23442?profile=access",
+          "rights_url"=>
+           "http://timeframes.natlib.govt.nz/logicrouter/servlet/LogicRouter?OUTPUTXSL=help-using.xslt",
+          "landing_url"=>
+           "http://timeframes.natlib.govt.nz/logicrouter/servlet/LogicRouter?PAGE=object&OUTPUTXSL=object.xslt&pm_RC=REPO02DB&pm_OI=26617&pm_GT=Y&pm_IAC=Y&api_1=GET_OBJECT_XML&num_result=0&Object_Layout=viewimage_object",
+          "thumbnail_url"=>
+           "http://digital.natlib.govt.nz/get/23442?profile=thumb",
+          "collection"=>"Timeframes"},
+        "MIMETYPE"=>"text/xml",
+        "MDTYPE"=>"OTHER"},
+      "ID"=>"dnz"}],
+   "OBJID"=>"timeframes:26617",
+   "xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance",
+   "xmlns"=>"http://www.loc.gov/METS/"}}
+   
+$data = {"results"=>
+  [{"metadata_url"=>"http://api.digitalnz.org/records/v1/71382",
+    "category"=>"Images",
+    "title"=>"Karori Road, Karori, Wellington, soon after it was constructed",
+    "content_provider"=>"Alexander Turnbull Library",
+    "source_url"=>"http://api.digitalnz.org/records/v1/71382/source",
+    "syndication_date"=>"2009-03-25T03:40:14.023Z",
+    "id"=>"71382",
+    "date"=>"",
+    "thumbnail_url"=>"http://digital.natlib.govt.nz/get/23442?profile=thumb",
+    "description"=>
+     "Karori Road, Karori, Wellington, soon after it was constructed, circa 1882/3. Photograph taken by...",
+    "display_url"=>
+     "http://timeframes.natlib.govt.nz/logicrouter/servlet/LogicRouter?PAGE=object&OUTPUTXSL=object.xslt&pm_RC=REPO02DB&pm_OI=26617&pm_GT=Y&pm_IAC=Y&api_1=GET_OBJECT_XML&num_result=0&Object_Layout=viewimage_object"},
+   {"metadata_url"=>"http://api.digitalnz.org/records/v1/98664",
+    "category"=>"Images",
+    "title"=>"Karori Normal School children counting cars",
+    "content_provider"=>"Alexander Turnbull Library",
+    "source_url"=>"http://api.digitalnz.org/records/v1/98664/source",
+    "syndication_date"=>"2009-03-25T04:40:21.017Z",
+    "id"=>"98664",
+    "date"=>"",
+    "thumbnail_url"=>"http://digital.natlib.govt.nz/get/71704?profile=thumb",
+    "description"=>
+     "Karori Normal School Children counting cars on Karori Road. Photographed by an Evening Post staff...",
+    "display_url"=>
+     "http://timeframes.natlib.govt.nz/logicrouter/servlet/LogicRouter?PAGE=object&OUTPUTXSL=object.xslt&pm_RC=REPO02DB&pm_OI=75493&pm_GT=Y&pm_IAC=Y&api_1=GET_OBJECT_XML&num_result=0&Object_Layout=viewimage_object"},
+   {"metadata_url"=>"http://api.digitalnz.org/records/v1/63515",
+    "category"=>"Images",
+    "title"=>"Karori reservoir in Wellington",
+    "content_provider"=>"Alexander Turnbull Library",
+    "source_url"=>"http://api.digitalnz.org/records/v1/63515/source",
+    "syndication_date"=>"2009-03-25T03:20:19.860Z",
+    "id"=>"63515",
+    "date"=>"",
+    "thumbnail_url"=>"http://digital.natlib.govt.nz/get/8563?profile=thumb",
+    "description"=>
+     "Karori reservoir in Karori, Wellington. Photograph taken by Sydney Charles Smith between 1912 and...",
+    "display_url"=>
+     "http://timeframes.natlib.govt.nz/logicrouter/servlet/LogicRouter?PAGE=object&OUTPUTXSL=object.xslt&pm_RC=REPO02DB&pm_OI=14104&pm_GT=Y&pm_IAC=Y&api_1=GET_OBJECT_XML&num_result=0&Object_Layout=viewimage_object"},
+   {"metadata_url"=>"http://api.digitalnz.org/records/v1/95241",
+    "category"=>"Images",
+    "title"=>"Karori Cemetery, Wellington",
+    "content_provider"=>"Alexander Turnbull Library",
+    "source_url"=>"http://api.digitalnz.org/records/v1/95241/source",
+    "syndication_date"=>"2009-03-25T04:30:27.850Z",
+    "id"=>"95241",
+    "date"=>"",
+    "thumbnail_url"=>"http://digital.natlib.govt.nz/get/36425?profile=thumb",
+    "description"=>
+     "Karori Cemetery, Wellington, circa 1910, photographed by Isaac Henry Bowen Jeffares.",
+    "display_url"=>
+     "http://timeframes.natlib.govt.nz/logicrouter/servlet/LogicRouter?PAGE=object&OUTPUTXSL=object.xslt&pm_RC=REPO02DB&pm_OI=60914&pm_GT=Y&pm_IAC=Y&api_1=GET_OBJECT_XML&num_result=0&Object_Layout=viewimage_object"},
+   {"metadata_url"=>"http://api.digitalnz.org/records/v1/110244",
+    "category"=>"Images",
+    "title"=>"Karori, Wellington",
+    "content_provider"=>"Alexander Turnbull Library",
+    "source_url"=>"http://api.digitalnz.org/records/v1/110244/source",
+    "syndication_date"=>"2009-03-25T05:10:13.230Z",
+    "id"=>"110244",
+    "date"=>"1910-01-01T00:00:00.000Z",
+    "thumbnail_url"=>"http://digital.natlib.govt.nz/get/77497?profile=thumb",
+    "description"=>
+     "Karori, Wellington, circa 1910. Shows a woman standing on the road by a house. Spiers' coaches are...",
+    "display_url"=>
+     "http://timeframes.natlib.govt.nz/logicrouter/servlet/LogicRouter?PAGE=object&OUTPUTXSL=object.xslt&pm_RC=REPO02DB&pm_OI=82826&pm_GT=Y&pm_IAC=Y&api_1=GET_OBJECT_XML&num_result=0&Object_Layout=viewimage_object"},
+   {"metadata_url"=>"http://api.digitalnz.org/records/v1/101403",
+    "category"=>"Images",
+    "title"=>"Trolley bus depot site at Karori",
+    "content_provider"=>"Alexander Turnbull Library",
+    "source_url"=>"http://api.digitalnz.org/records/v1/101403/source",
+    "syndication_date"=>"2009-03-25T04:50:12.877Z",
+    "id"=>"101403",
+    "date"=>"",
+    "thumbnail_url"=>"http://digital.natlib.govt.nz/get/62520?profile=thumb",
+    "description"=>
+     "Karori trolley bus depot site in the foreground looking south towards Karori Road and a large part of...",
+    "display_url"=>
+     "http://timeframes.natlib.govt.nz/logicrouter/servlet/LogicRouter?PAGE=object&OUTPUTXSL=object.xslt&pm_RC=REPO02DB&pm_OI=68276&pm_GT=Y&pm_IAC=Y&api_1=GET_OBJECT_XML&num_result=0&Object_Layout=viewimage_object"},
+   {"metadata_url"=>"http://api.digitalnz.org/records/v1/70640",
+    "category"=>"Images",
+    "title"=>"Ngaio, or possibly Karori, Wellington",
+    "content_provider"=>"Alexander Turnbull Library",
+    "source_url"=>"http://api.digitalnz.org/records/v1/70640/source",
+    "syndication_date"=>"2009-03-25T03:40:10.737Z",
+    "id"=>"70640",
+    "date"=>"1910-01-01T00:00:00.000Z",
+    "thumbnail_url"=>"http://digital.natlib.govt.nz/get/29366?profile=thumb",
+    "description"=>
+     "Ngaio, or possibly Karori, Wellington, circa 1910. Photographer unidentified.",
+    "display_url"=>
+     "http://timeframes.natlib.govt.nz/logicrouter/servlet/LogicRouter?PAGE=object&OUTPUTXSL=object.xslt&pm_RC=REPO02DB&pm_OI=25580&pm_GT=Y&pm_IAC=Y&api_1=GET_OBJECT_XML&num_result=0&Object_Layout=viewimage_object"},
+   {"metadata_url"=>"http://api.digitalnz.org/records/v1/123870",
+    "category"=>"Images",
+    "title"=>"The Karori Store (1893)",
+    "content_provider"=>"New Zealand Electronic Text Centre",
+    "source_url"=>"http://api.digitalnz.org/records/v1/123870/source",
+    "syndication_date"=>"2009-03-25T05:40:14.475Z",
+    "id"=>"123870",
+    "date"=>"2005-01-02T13:00:00.000Z",
+    "thumbnail_url"=>
+     "http://www.nzetc.org/etexts/ManLife/ManLife_P005a(w150).jpg",
+    "description"=>
+     "[Black and white photograph of the the Karori General Store and Bakery]",
+    "display_url"=>
+     "http://www.nzetc.org/tm/scholarly/ManLife-fig-ManLife_P005a.html"},
+   {"metadata_url"=>"http://api.digitalnz.org/records/v1/58939",
+    "category"=>"Images",
+    "title"=>
+     "Overlooking the Karori Reservoir and surrounding area, Karori, Wellington",
+    "content_provider"=>"Alexander Turnbull Library",
+    "source_url"=>"http://api.digitalnz.org/records/v1/58939/source",
+    "syndication_date"=>"2009-03-25T03:10:19.955Z",
+    "id"=>"58939",
+    "date"=>"",
+    "thumbnail_url"=>"http://digital.natlib.govt.nz/get/19081?profile=thumb",
+    "description"=>
+     "Overlooking the Karori Reservoir and surrounding area, Karori, Wellington, circa 1880s. Photograph...",
+    "display_url"=>
+     "http://timeframes.natlib.govt.nz/logicrouter/servlet/LogicRouter?PAGE=object&OUTPUTXSL=object.xslt&pm_RC=REPO02DB&pm_OI=7762&pm_GT=Y&pm_IAC=Y&api_1=GET_OBJECT_XML&num_result=0&Object_Layout=viewimage_object"},
+   {"metadata_url"=>"http://api.digitalnz.org/records/v1/62361",
+    "category"=>"Images",
+    "title"=>"Karori Reservoir and surrounding grounds, Karori, Wellington",
+    "content_provider"=>"Alexander Turnbull Library",
+    "source_url"=>"http://api.digitalnz.org/records/v1/62361/source",
+    "syndication_date"=>"2009-03-25T03:20:13.630Z",
+    "id"=>"62361",
+    "date"=>"",
+    "thumbnail_url"=>"http://digital.natlib.govt.nz/get/23750?profile=thumb",
+    "description"=>
+     "Karori Reservoir, including valve tower, and surrounding grounds, Karori, Wellington, photographed by...",
+    "display_url"=>
+     "http://timeframes.natlib.govt.nz/logicrouter/servlet/LogicRouter?PAGE=object&OUTPUTXSL=object.xslt&pm_RC=REPO02DB&pm_OI=12458&pm_GT=Y&pm_IAC=Y&api_1=GET_OBJECT_XML&num_result=0&Object_Layout=viewimage_object"},
+   {"metadata_url"=>"http://api.digitalnz.org/records/v1/64611",
+    "category"=>"Images",
+    "title"=>"Men standing with a horse and cart outside Karori Store, Karori",
+    "content_provider"=>"Alexander Turnbull Library",
+    "source_url"=>"http://api.digitalnz.org/records/v1/64611/source",
+    "syndication_date"=>"2009-03-25T03:20:25.273Z",
+    "id"=>"64611",
+    "date"=>"",
+    "thumbnail_url"=>"http://digital.natlib.govt.nz/get/21060?profile=thumb",
+    "description"=>
+     "Men standing with a horse and cart outside Karori Store, Karori. Taken by an unidentified...",
+    "display_url"=>
+     "http://timeframes.natlib.govt.nz/logicrouter/servlet/LogicRouter?PAGE=object&OUTPUTXSL=object.xslt&pm_RC=REPO02DB&pm_OI=15433&pm_GT=Y&pm_IAC=Y&api_1=GET_OBJECT_XML&num_result=0&Object_Layout=viewimage_object"},
+   {"metadata_url"=>"http://api.digitalnz.org/records/v1/61161",
+    "category"=>"Images",
+    "title"=>
+     "New school building, Karori Normal School - Photograph taken by Jo Head",
+    "content_provider"=>"Alexander Turnbull Library",
+    "source_url"=>"http://api.digitalnz.org/records/v1/61161/source",
+    "syndication_date"=>"2009-03-25T03:20:07.129Z",
+    "id"=>"61161",
+    "date"=>"",
+    "thumbnail_url"=>"http://digital.natlib.govt.nz/get/71703?profile=thumb",
+    "description"=>
+     "Karori Normal School children sitting in front of their new school building, Karori, Wellington, New...",
+    "display_url"=>
+     "http://timeframes.natlib.govt.nz/logicrouter/servlet/LogicRouter?PAGE=object&OUTPUTXSL=object.xslt&pm_RC=REPO02DB&pm_OI=75711&pm_GT=Y&pm_IAC=Y&api_1=GET_OBJECT_XML&num_result=0&Object_Layout=viewimage_object"},
+   {"metadata_url"=>"http://api.digitalnz.org/records/v1/102568",
+    "category"=>"Images",
+    "title"=>"Pet fawn",
+    "content_provider"=>"Alexander Turnbull Library",
+    "source_url"=>"http://api.digitalnz.org/records/v1/102568/source",
+    "syndication_date"=>"2009-03-25T04:50:18.362Z",
+    "id"=>"102568",
+    "date"=>"",
+    "thumbnail_url"=>"http://digital.natlib.govt.nz/get/66563?profile=thumb",
+    "description"=>
+     "Pet fawn at Karori, Wellington photographed December 1951 by an Evening Post photographer.",
+    "display_url"=>
+     "http://timeframes.natlib.govt.nz/logicrouter/servlet/LogicRouter?PAGE=object&OUTPUTXSL=object.xslt&pm_RC=REPO02DB&pm_OI=69467&pm_GT=Y&pm_IAC=Y&api_1=GET_OBJECT_XML&num_result=0&Object_Layout=viewimage_object"},
+   {"metadata_url"=>"http://api.digitalnz.org/records/v1/73093",
+    "category"=>"Images",
+    "title"=>
+     "Chapel of Futuna, Karori, Wellington - Photograph taken by Phil Reid",
+    "content_provider"=>"Alexander Turnbull Library",
+    "source_url"=>"http://api.digitalnz.org/records/v1/73093/source",
+    "syndication_date"=>"2009-03-25T03:40:21.818Z",
+    "id"=>"73093",
+    "date"=>"",
+    "thumbnail_url"=>"http://digital.natlib.govt.nz/get/45302?profile=thumb",
+    "description"=>
+     "Exterior view of the Chapel of Futuna in Karori, Wellington. Photograph taken circa 29 May 1986 by...",
+    "display_url"=>
+     "http://timeframes.natlib.govt.nz/logicrouter/servlet/LogicRouter?PAGE=object&OUTPUTXSL=object.xslt&pm_RC=REPO02DB&pm_OI=75565&pm_GT=Y&pm_IAC=Y&api_1=GET_OBJECT_XML&num_result=0&Object_Layout=viewimage_object"},
+   {"metadata_url"=>"http://api.digitalnz.org/records/v1/88550",
+    "category"=>"Images",
+    "title"=>"Diana Pope at polling booth, Karori",
+    "content_provider"=>"Alexander Turnbull Library",
+    "source_url"=>"http://api.digitalnz.org/records/v1/88550/source",
+    "syndication_date"=>"2009-03-25T04:20:14.904Z",
+    "id"=>"88550",
+    "date"=>"",
+    "thumbnail_url"=>"http://digital.natlib.govt.nz/get/30732?profile=thumb",
+    "description"=>
+     "Diana Pope, holding stuffed toys, outside a polling booth in Karori, photographed 27 October 1990 by...",
+    "display_url"=>
+     "http://timeframes.natlib.govt.nz/logicrouter/servlet/LogicRouter?PAGE=object&OUTPUTXSL=object.xslt&pm_RC=REPO02DB&pm_OI=52668&pm_GT=Y&pm_IAC=Y&api_1=GET_OBJECT_XML&num_result=0&Object_Layout=viewimage_object"},
+   {"metadata_url"=>"http://api.digitalnz.org/records/v1/97210",
+    "category"=>"Images",
+    "title"=>"Karori school, Wellington, damaged by Wahine storm",
+    "content_provider"=>"Alexander Turnbull Library",
+    "source_url"=>"http://api.digitalnz.org/records/v1/97210/source",
+    "syndication_date"=>"2009-03-25T04:40:13.075Z",
+    "id"=>"97210",
+    "date"=>"",
+    "thumbnail_url"=>"http://digital.natlib.govt.nz/get/35066?profile=thumb",
+    "description"=>
+     "Prefab classroom at Karori School, Wellington, destroyed by the Wahine storm, photographed 11 April...",
+    "display_url"=>
+     "http://timeframes.natlib.govt.nz/logicrouter/servlet/LogicRouter?PAGE=object&OUTPUTXSL=object.xslt&pm_RC=REPO02DB&pm_OI=75412&pm_GT=Y&pm_IAC=Y&api_1=GET_OBJECT_XML&num_result=0&Object_Layout=viewimage_object"},
+   {"metadata_url"=>"http://api.digitalnz.org/records/v1/97211",
+    "category"=>"Images",
+    "title"=>"Karori school, Wellington, damaged by Wahine storm",
+    "content_provider"=>"Alexander Turnbull Library",
+    "source_url"=>"http://api.digitalnz.org/records/v1/97211/source",
+    "syndication_date"=>"2009-03-25T04:40:13.078Z",
+    "id"=>"97211",
+    "date"=>"",
+    "thumbnail_url"=>"http://digital.natlib.govt.nz/get/72816?profile=thumb",
+    "description"=>
+     "Prefab classroom at Karori School, Wellington, destroyed by the Wahine storm, photographed 11 April...",
+    "display_url"=>
+     "http://timeframes.natlib.govt.nz/logicrouter/servlet/LogicRouter?PAGE=object&OUTPUTXSL=object.xslt&pm_RC=REPO02DB&pm_OI=75413&pm_GT=Y&pm_IAC=Y&api_1=GET_OBJECT_XML&num_result=0&Object_Layout=viewimage_object"},
+   {"metadata_url"=>"http://api.digitalnz.org/records/v1/99877",
+    "category"=>"Images",
+    "title"=>"Tram barn, Karori",
+    "content_provider"=>"Alexander Turnbull Library",
+    "source_url"=>"http://api.digitalnz.org/records/v1/99877/source",
+    "syndication_date"=>"2009-03-25T04:50:05.629Z",
+    "id"=>"99877",
+    "date"=>"",
+    "thumbnail_url"=>"http://digital.natlib.govt.nz/get/55388?profile=thumb",
+    "description"=>
+     "The construction site for the tram barn in Karori photographed in 1950 by an Evening Post...",
+    "display_url"=>
+     "http://timeframes.natlib.govt.nz/logicrouter/servlet/LogicRouter?PAGE=object&OUTPUTXSL=object.xslt&pm_RC=REPO02DB&pm_OI=66726&pm_GT=Y&pm_IAC=Y&api_1=GET_OBJECT_XML&num_result=0&Object_Layout=viewimage_object"},
+   {"metadata_url"=>"http://api.digitalnz.org/records/v1/101866",
+    "category"=>"Images",
+    "title"=>"Lawn cemetery at Karori",
+    "content_provider"=>"Alexander Turnbull Library",
+    "source_url"=>"http://api.digitalnz.org/records/v1/101866/source",
+    "syndication_date"=>"2009-03-25T04:50:15.301Z",
+    "id"=>"101866",
+    "date"=>"",
+    "thumbnail_url"=>"http://digital.natlib.govt.nz/get/64401?profile=thumb",
+    "description"=>
+     "The lawn cemetery at Karori in Wellington photographed circa 7 Sep 1951 by an Evening Post staff...",
+    "display_url"=>
+     "http://timeframes.natlib.govt.nz/logicrouter/servlet/LogicRouter?PAGE=object&OUTPUTXSL=object.xslt&pm_RC=REPO02DB&pm_OI=68752&pm_GT=Y&pm_IAC=Y&api_1=GET_OBJECT_XML&num_result=0&Object_Layout=viewimage_object"},
+   {"metadata_url"=>"http://api.digitalnz.org/records/v1/101867",
+    "category"=>"Images",
+    "title"=>"Lawn cemetery at Karori",
+    "content_provider"=>"Alexander Turnbull Library",
+    "source_url"=>"http://api.digitalnz.org/records/v1/101867/source",
+    "syndication_date"=>"2009-03-25T04:50:15.304Z",
+    "id"=>"101867",
+    "date"=>"",
+    "thumbnail_url"=>"http://digital.natlib.govt.nz/get/64402?profile=thumb",
+    "description"=>
+     "The lawn cemetery at Karori in Wellington photographed circa 7 Sep 1951 by an Evening Post staff...",
+    "display_url"=>
+     "http://timeframes.natlib.govt.nz/logicrouter/servlet/LogicRouter?PAGE=object&OUTPUTXSL=object.xslt&pm_RC=REPO02DB&pm_OI=68753&pm_GT=Y&pm_IAC=Y&api_1=GET_OBJECT_XML&num_result=0&Object_Layout=viewimage_object"}],
+ "num_results_requested"=>20,
+ "result_count"=>232,
+ "start"=>0,
+ "api_call"=>
+  "http://api.digitalnz.org/records/v1.json/?api_key=85be61818d438f9a821a4da98836e8f0&search_text=Karori+photograph"}

data/test/test.rb

@@ -0,0 +1,81 @@
+require 'test/unit'
+require 'r4digitalnz'
+
+include R4DigitalNZ
+
+class Test_DigitalNZ < Test::Unit::TestCase
+  def setup
+    api_key = "your_api_key"
+    @digitalNZ = DigitalNZ.new api_key
+  end
+  
+  def test_simple_search
+    assert_nothing_raised do 
+      r = @digitalNZ.search "Karori photograph"
+      assert_equal 20, r.num_results_requested
+      assert_equal 232, r.result_count
+      assert_equal 0, r.start
+      assert_equal "71382", r[0].id
+    end
+  end
+
+  def test_result
+    data = {"metadata_url"=>"http://api.digitalnz.org/records/v1/71382", "category"=>"Images", "title"=>"Karori Road, Karori, Wellington, soon after it was constructed", "content_provider"=>"Alexander Turnbull Library", "source_url"=>"http://api.digitalnz.org/records/v1/71382/source", "syndication_date"=>"2009-03-25T03:40:14.023Z", "id"=>"71382", "date"=>"", "thumbnail_url"=>"http://digital.natlib.govt.nz/get/23442?profile=thumb", "description"=>"Karori Road, Karori, Wellington, soon after it was constructed, circa 1882/3. Photograph taken by...", "display_url"=>"http://timeframes.natlib.govt.nz/logicrouter/servlet/LogicRouter?PAGE=object&OUTPUTXSL=object.xslt&pm_RC=REPO02DB&pm_OI=26617&pm_GT=Y&pm_IAC=Y&api_1=GET_OBJECT_XML&num_result=0&Object_Layout=viewimage_object"}
+    
+    r = Result.new data
+    
+    assert_equal "Karori Road, Karori, Wellington, soon after it was constructed", r.title
+    assert_equal "Alexander Turnbull Library", r.content_provider
+  end
+  
+  def test_api_key_exception
+    digitalNZ = DigitalNZ.new "badkey"
+    assert_raise APIException do
+        digitalNZ.search "Karori photograph"
+    end
+  end
+  
+  def test_search_with_options
+    r = @digitalNZ.search "Karori photograph", :num_results => 5, :start => 10
+    assert_equal 5, r.num_results_requested
+    assert_equal 232, r.result_count
+    assert_equal 10, r.start
+
+    assert_equal "64611", r[0].id
+  end
+  
+  def test_search_enumerable
+    require 'test/data.rb'
+    s = SearchResult.new $data
+    assert s.respond_to? :collect
+    
+    assert_not_nil s.find {|r| r.title.include?('Futuna')}
+
+    ids = ["71382", "98664", "63515", "95241", "110244", "101403", "70640", "123870", "58939", "62361", "64611", "61161", "102568", "73093", "88550", "97210", "97211", "99877", "101866", "101867"]
+    assert_equal ids, s.collect { |d| d.id}
+  end
+  
+  def test_metadata
+    require 'test/data.rb'
+        
+    meta_data = MetaData.new $mets
+#    assert_equal 2, meta_data.sections.length
+    
+    assert_equal "timeframes:26617", meta_data.objid
+    assert_equal 'GDL-NLNZ', meta_data.profile
+
+    section = meta_data.section 'dc'
+    assert_equal 'dc', section.id
+    assert_equal 'text/xml', section.mime_type
+    assert_equal 'DC', section.mdtype
+    assert_equal ["Karori Road", "1882/1883"], section.coverage
+    assert_equal "StillImage", section.type
+    
+    assert !section.respond_to?(:rights_url)
+    assert meta_data.section('dnz').respond_to?(:rights_url)
+  end
+  
+  def test_content_partners
+    assert @digitalNZ.content_partners.include? "Unknown origin"
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: r4digitalnz
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- Henry Maddocks
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-06 00:00:00 +12:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.6
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+description: An interface to the Digital NZ public API. See http://www.digitalnz.org/
+email: henry.maddocks@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/r4digitalnz.rb
+- copying.txt
+- README
+- TODO
+- rakefile
+- test/data.rb
+- test/test.rb
+has_rdoc: true
+homepage: http://r4digitalnz.rubyforge.org
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: 
+- JSON
+- Active Support
+rubyforge_project: r4digitalnz
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: An interface to the Digital NZ public API.
+test_files: 
+- test/data.rb
+- test/test.rb