nypl_repo 0.0.2 → 0.1.0

data/lib/nypl_repo.rb

@@ -5,13 +5,68 @@ module NyplRepo
    require 'net/http'
    require 'json'
    
-    def initialize(token)
+   #  NyplRepo::Client.new(ENV["API_TOKEN"], {:debug=>true, :server_url => "http://api.nypl/api/v1/"})
+   #
+    def initialize(token, options={})
       @token = token
+      @debug = options[:debug] || false
+      @server_url = options[:server_url] || "http://api.repo.nypl.org/api/v1"
     end
-  
+ 
+    #date format: YYYY-MM-DD
+    #physical_location  i.e "Map%20Division"&field=physicalLocation
+    def get_items_since(query, since_date, until_date)
+      url = @server_url+'/items/search.json?q='+query+'&since='+since_date+'&until='+until_date+'&per_page=500'
+      json = self.get_json(url)
+      results = []
+      result = json["nyplAPI"]["response"]["result"]
+      results << result
+      totalPages = json["nyplAPI"]["request"]["totalPages"].to_i
+      
+      if totalPages >= 2
+        puts "total pages " + totalPages.to_s if @debug
+        (2..totalPages).each do | page |
+          puts "page: "+page.to_s if @debug
+          newurl = url + "&page=#{page}"
+          json = self.get_json(newurl)
+          newresult = json["nyplAPI"]["response"]["result"]
+          results << newresult
+        end
+      end
+      results.flatten!
+     
+      results
+    end
+
+
+    # Given a container uuid, or biblographic uuid, returns a
+    # list of mods uuids. 
+    def get_capture_items(c_uuid)
+      url = "#{@server_url}/items/#{c_uuid}.json?per_page=500"
+      json = self.get_json(url)
+      captures = []
+      capture = json["nyplAPI"]["response"]["capture"]
+      captures << capture
+
+      totalPages = json["nyplAPI"]["request"]["totalPages"].to_i
+      if totalPages >= 2
+        puts "total pages " + totalPages.to_s if @debug
+        (2..totalPages).each do | page |
+          puts "page: "+page.to_s if @debug
+          newurl = url + "&page=#{page}"
+          json = self.get_json(newurl)
+          newcapture = json["nyplAPI"]["response"]["capture"]
+          captures << newcapture
+        end
+      end
+      captures.flatten!
+    
+      captures
+    end
+
     #get the item detail from a uuid
     def get_mods_item(mods_uuid)
-      url = "http://api.repo.nypl.org/api/v1/items/mods/#{mods_uuid}.json"
+      url = "#{@server_url}/items/mods/#{mods_uuid}.json"
       json = self.get_json(url)
       
       item = nil
@@ -25,7 +80,7 @@ module NyplRepo
     #gets the mods uuid of the item, passing in the bibliographic uuid and image_id
     #since there could be many maps for the same item
     def get_mods_uuid(bibl_uuid, image_id)
-     url = "http://api.repo.nypl.org/api/v1/items/#{bibl_uuid}.json?per_page=500"
+     url = "#{@server_url}/items/#{bibl_uuid}.json?per_page=500"
      json = self.get_json(url)
      mods_uuid = nil
    
@@ -40,10 +95,27 @@ module NyplRepo
      return mods_uuid
     end
 
+    # gets the image id for an item based on the the bibliographic uuid (container uuid) and the mods uuid (the actual item)
+    #
+    def get_image_id(bibl_uuid, mods_uuid)
+      url = "#{@server_url}/items/#{bibl_uuid}.json?per_page=500"
+      json = self.get_json(url)
+      image_id = nil
+      
+      json["nyplAPI"]["response"]["capture"].each do | capture|
+      if capture["uuid"] == mods_uuid
+        image_id = capture["imageID"]
+        break
+      end #if
+      end if json["nyplAPI"]["response"]["numResults"].to_i > 0
+
+      return image_id
+    end
+
 
     # get bibliographic container uuid from an image_id
     def get_bibl_uuid(image_id)
-      url = "http://api.repo.nypl.org/api/v1/items/local_image_id/#{image_id}.json"   
+      url = "#{@server_url}/items/local_image_id/#{image_id}.json"   
       json = self.get_json(url)
       bibl_uuid = nil
       if json["nyplAPI"]["response"]["numResults"].to_i > 0
@@ -57,7 +129,7 @@ module NyplRepo
     #get highreslink from an item, matching up the image idi
     #since some bibliographic items may have many maps under them
     def get_highreslink(bibl_uuid, image_id)
-      url = "http://api.repo.nypl.org/api/v1/items/#{bibl_uuid}.json?per_page=500"
+      url = "#{@server_url}/items/#{bibl_uuid}.json?per_page=500"
       json = self.get_json(url)
       
       highreslink = nil
@@ -72,8 +144,20 @@ module NyplRepo
       return highreslink
     end
 
+   
+    #checks the response for error
+    def check_error(json)
+      if json["nyplAPI"]["response"]["headers"]["status"] == "error"
+          msg = "NYPL Repo API Error: " + json["nyplAPI"]["response"]["headers"]["code"] + " "+ json["nyplAPI"]["response"]["headers"]["message"]
+          raise msg
+       end
+
+    end
+ 
 
     def get_json(url)
+      puts "Calling URL: " + url if @debug
+
       uri = URI.parse(url)
       http = Net::HTTP.new(uri.host, uri.port)
 
@@ -83,8 +167,13 @@ module NyplRepo
       body = response.body
       json = JSON.parse(body)
 
+      check_error(json)
+
       return json
     end
 
 end
 end
+
+
+

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: nypl_repo
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
+  prerelease: 
 platform: ruby
 authors:
 - Tim Waters
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-28 00:00:00.000000000 Z
+date: 2014-01-23 00:00:00.000000000 Z
 dependencies: []
 description: A basic library for interacting with the NYPL Digital Collections Repo
   API
@@ -21,25 +22,26 @@ files:
 homepage: https://github.com/timwaters/nypl_repo
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: NYPL Repo API Library
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: d74c2cfe6f6f381876592cc50810d3d01ec4afc3
-  data.tar.gz: 930fea52d656c2d7f16919094a26f380d3456827
-SHA512:
-  metadata.gz: 9c8c9a52ef34d01dd863a850be4ebb4d3f4e0fed5080892aa3aa3863d9b200e6ff49e932feaa679f052028eefe2087c971154e748b15c93cb95c7d024fae7c6c
-  data.tar.gz: f3ff1074e577c66e1c85355556a7c52486f1a08d0f257f602e32bfc19858a10cd99fc18b4df5ade323925640b9aefeb1bdbcfc7c2a76b324c5a79a5fc84ed9ff