wckbapi 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f19f15da5b7cbb71977b93bb5870013f0d648642
+  data.tar.gz: 34f775ae14fca34bed053bf09f245c3eddb24e81
+SHA512:
+  metadata.gz: 293512bdbd709cd94462d511db5de885177c43740b56440db0662b1ff7c51fcd92bfd6f3f6390755e879292b9ba252173906d241fd6173e97bfdb4b1b46df7e2
+  data.tar.gz: b835b0462aece2a77d9ddd95c3ebbdd8de743fb1f48dfc0a0ddffc99c9f369d0e0992563857ec29e52cbd256a8a4341c22b4bcf2a8b32378aa1880dbb66a5338

data/lib/wckbapi/client.rb

@@ -0,0 +1,245 @@
+require 'uri'
+require 'net/http'
+require 'cgi'
+
+module WCKBAPI 
+
+  # The WCKBAPI::Client object provides a public facing interface to interacting
+  # with the WorldCat Knowledgebank API
+  #
+  #   client = WCKBAPI::Client.new :wskey => [your world cat key], :debug => true|false, :institution_id => [your institution id]
+  # options:
+  #    wskey
+  #
+  #
+  # More information can be found at:
+  #   http://worldcat.org/devnet/wiki/SearchAPIDetails  
+  
+  class Client
+
+    # The constructor which must be passed a valid base url for an oai 
+    # service:
+    #
+    # If you want to see debugging messages on STDERR use:
+    # :debug => true
+    
+    def initialize(options={})
+      @debug = options[:debug]
+      @wskey = options[:wskey]
+      @institution_id = options[:institution_id]
+    end
+
+    # Equivalent to a Identify request. You'll get back a OAI::IdentifyResponse
+    # object which is essentially just a wrapper around a REXML::Document 
+    # for the response.
+    
+    #def OpenSearch(opts={}) 
+    #  @base = URI.parse WORLDCAT_OPENSEARCH
+    #  opts["wskey"] = @wskey
+    #  xml = do_request(opts)
+    #  return OpenSearchResponse.new(xml)
+    #end
+
+    def GetEntry(opts = {})
+       opts[:wskey] = @wskey
+       opts[:alt] = 'json'
+       if opts[:id] == nil
+          @base = URI.parse WORLDCAT_KB_URL + "entries/" + opts[:collection_uid] + "," + opts[:entry_uid]
+          opts.delete(:collection_uid)
+          opts.delete(:entry_uid)
+       else
+	  @base = URI.parse opts[:id]
+	  opts.delete(:id)
+       end
+
+       data = do_request(opts)
+       json = JSON.parse(data)
+       objResult = Result.new()
+       objResult.query = ""
+       objResult.startIndex = 1
+       objResult.totalResults = 1
+       objResult.itemsPerPage = 1
+       objE = Entry.new()
+       objE.load(json)
+       return objResult, Array(objE)
+    end
+
+    def SearchEntries(opts={})
+       opts[:wskey] = @wskey
+       opts[:alt] = 'json'
+       @base = URI.parse WORLDCAT_KB_URL + "entries/search"
+       data = do_request(opts)
+       json = JSON.parse(data)
+       objArray = Array.new()
+       objResult = Result.new()
+       objResult.query = json['os:Query'] 
+       objResult.startIndex = json['os:startIndex'] 
+       objResult.totalResults = json['os:totalResults']
+       objResult.itemsPerPage = json['os:itemsPerPage']
+       json['entries'].each {|item|
+	   objE = Entry.new()
+           objE.load(item)
+	   objArray.push(objE)
+	}
+	return objResult, objArray
+     end
+
+    def SearchProviders(opts={})
+       opts[:type] = 'search'
+       return GetProviderInfo(opts)
+    end
+
+    def GetProviderInfo(opts={})
+       if opts == nil
+         opts = Hash.new()
+       end 
+
+       opts[:wskey] = @wskey
+       opts[:alt] = 'json'
+       if opts[:type] == nil
+          if opts[:collection_uid] == nil
+     	     @base = URI.parse WORLDCAT_KB_URL + "providers"
+          else
+	     @base = URI.parse WORLDCAT_KB_URL + "providers/" + opts[:title]
+	  end
+	  opts.delete(:collection_uid)
+          data = do_request(opts)
+          json = JSON.parse(data)
+          objResult = Result.new()
+	  if json['entries'] != nil
+             objResult.query =json['os:Query'] 
+	     objResult.startIndex =json['os:startIndex'] 
+	     objResult.totalResults = json['os:totalResults'] 
+	     objResult.itemsPerPage = json['os:itemsPerPage']
+
+	     objArray = Array.new()
+	     json['entries'].each {|item|
+		objP = Provider.new()
+		objP.load(item)
+	  	objArray.push(objP)
+	     }
+	     return objResult, objArray
+	  else		
+	     objResult.query = "" 
+	     objResult.startIndex = 1
+	     objResult.totalResults = 1
+	     objResult.itemsPerPage = 1
+
+	     objP = Provider.new()
+	     objP.load(json)
+	     return objResult, Array(objP)
+	  end
+	else 
+	   opts.delete(:type)
+	   @base = URI.parse WORLDCAT_KB_URL + "providers/search"
+	   data = do_request(opts)
+	   json = JSON.parse(data)
+  	   objResult = Result.new()
+	   objResult.query = json['os:Query'] 
+	   objResult.startIndex = json['os:startIndex']
+	   objResult.totalResults = json['os:totalResults']
+	   objResult.itemsPerPage = json['os:itemsPerPage']
+
+	   objArray = Array.new()
+	   json['entries'].each {|item|
+	      objP = Provider.new()
+	      objP.load(item)
+	      objArray.push(objP)
+	   }
+	   return objResult, objArray
+	end
+    end
+
+    def GetCollectionInfo(opts={})
+       opts[:wskey] = @wskey 
+       opts[:alt] = 'json'
+       if opts[:type] == nil
+          if opts[:institution_id] != nil
+             @base = URI.parse WORLDCAT_KB_URL + "collections/" + opts[:collection_uid] + "," + opts[:institution_id]
+          else
+	     @base = URI.parse WORLDCAT_KB_URL + "collections/" + opts[:collection_uid]
+          end
+          opts.delete(:institution_id)
+          opts.delete(:collection_uid)
+          data = do_request(opts)
+          json = JSON.parse(data) 
+ 	  objResult = Result.new()
+	  objResult.query = "" 
+	  objResult.startIndex = 1
+	  objResult.totalResults = 1
+	  objResult.itemsPerPage = 1
+
+	  objC = Collection.new()
+          objC.load(json)
+          return objResult, Array(objC) 
+       else
+	  opts.delete(:type)
+	  @base = URI.parse WORLDCAT_KB_URL + "collections/search"
+          data = do_request(opts)
+          json = JSON.parse(data)
+	  objResult = Result.new()
+	  objResult.query = json['os:Query']
+	  objResult.startIndex = json['os:startIndex']
+	  objResult.totalResults = json['os:totalResults']
+	  objResult.itemsPerPage = json['os:itemsPerPage']
+
+          objArray = Array.new()
+          json['entries'].each {|item|
+	    objC = Collection.new()
+            objC.load(item)
+	    objArray.push(objC)     
+          }
+	  return objResult, objArray
+       end
+    end
+
+    def SearchCollections(opts={})
+        opts[:type] = 'search'
+	return GetCollectionInfo(opts)
+    end
+
+
+    private 
+
+    def do_request(hash)
+      uri = @base.clone
+
+      # build up the query string
+      parts = hash.entries.map do |entry|
+        #key = studly(entry[0].to_s)
+        key = entry[0].to_s
+        value = entry[1]
+        value = CGI.escape(entry[1].to_s)
+        "#{key}=#{value}"
+      end
+      uri.query = parts.join('&')
+      debug("doing request: #{uri.to_s}")
+      puts uri.to_s
+      begin
+        data = Net::HTTP.get(uri)
+        debug("got response: #{data}")
+	return data 
+      rescue SystemCallError=> e
+        #raise WCKBAPI::Exception, 'HTTP level error during WCKBAPI  request: '+e, caller
+      end
+    end
+
+    # convert foo_bar to fooBar thus allowing our ruby code to use
+    # the typical underscore idiom
+    def studly(s)
+      s.gsub(/_(\w)/) do |match|
+        match.sub! '_', ''
+        match.upcase
+      end
+    end
+
+    def debug(msg)
+      $stderr.print("#{msg}\n") if @debug
+    end
+
+     def to_h(default=nil)
+        Hash[ *inject([]) { |a, value| a.push value, default || yield(value) } ]
+     end
+
+  end
+end

data/lib/wckbapi/collection.rb

@@ -0,0 +1,33 @@
+module WCKBAPI
+
+  class Collection
+    attr_accessor :id, :title, :provider_uid, :provider_name, :avaiable_entries, :selected_entries, :collection_name, :collection_uid, :owner_institution, :source_institution, :status, :dbkey, :source, :open, :collection_type, :uri
+
+    def initialize()
+    end
+    def load(item)
+	@id = item['id']
+   	@title = item['title']
+ 	@provider_uid = item['kb:provider_uid']
+	@provider_name = item['kb:provider_name']
+	@available_entries = item['kb:available_entries']
+	@selected_entries = item['kb:selected_entries']
+	@collection_name = item['kb:collection_name']
+	@collection_uid = item['kb:collection_uid']
+	@owner_institution = item['kb:owner_institution']
+	@source_institution = item['kb:source_institution']
+	@status = item['kb:status']
+	@dbkey = item['kb:dbkey']
+	@source = item['kb:source']
+	@open = item['kb:open']
+	@collection_type = item['kb:collection_type']
+
+        item['links'].each {|t|
+           if t['rel'] == 'via'
+              @uri = t['href']
+              break
+           end
+        }
+    end
+  end
+end

data/lib/wckbapi/entry.rb

@@ -0,0 +1,30 @@
+module WCKBAPI
+
+  class Entry
+    attr_accessor :id, :title, :entry_uid, :entry_status, :bkey, :collection_name, :collection_uid, :provider_uid, :provider_name, :oclcnum, :author, :isbn, :publisher, :coverage, :uri
+
+    def initialize()
+    end
+    def load(item)
+	@id = item['id']
+   	@title = item['title']
+	@entry_uid = item['entry_uid']
+	@entry_status = item['entry_status']
+	@bkey = item['bkey']
+	@collection_name = item['kb:collection_name']
+	@collection_uid = item['kb:collection_uid']
+ 	@provider_uid = item['kb:provider_uid']
+	@provider_name = item['kb:provider_name']
+	@oclcnum = item['kb:oclcnum']
+	@author = item['kb:author']
+	@isbn = item['kb:isbn']
+	@publisher = item['kb:publisher']
+	@coverage = item['kb:coverage']
+  	item['links'].each {|t|
+	   if t['rel'] == 'via'
+	     @uri = t['href']
+	   end 
+	}
+    end
+  end
+end

data/lib/wckbapi/provider.rb

@@ -0,0 +1,18 @@
+module WCKBAPI
+
+  class Provider
+    attr_accessor :id, :title, :provider_uid, :provider_name, :avaiable_entries, :selected_entries, :available_collections
+
+    def initialize()
+    end
+    def load(item)
+	@id = item['id']
+   	@title = item['title']
+ 	@provider_uid = item['kb:provider_uid']
+	@provider_name = item['kb:provider_name']
+	@available_entries = item['kb:available_entries']
+	@selected_entries = item['kb:selected_entries']
+	@available_collections = item['kb:available_collections']
+    end
+  end
+end

data/lib/wckbapi/result.rb

@@ -0,0 +1,9 @@
+module WCKBAPI
+
+  class Result
+    attr_accessor :query, :startIndex, :totalResults, :itemsPerPage
+
+    def initialize()
+    end
+  end
+end

data/lib/wckbapi.rb

@@ -0,0 +1,10 @@
+require 'wckbapi/client'
+require 'wckbapi/collection'
+require 'wckbapi/provider'
+require 'wckbapi/entry'
+require 'wckbapi/result'
+require 'nokogiri'
+require 'json'
+
+WORLDCAT_OPENSEARCH = 'http://www.worldcat.org/webservices/catalog/search/opensearch'
+WORLDCAT_KB_URL = 'http://www.worldcat.org/webservices/kb/rest/'

data/test.rb

@@ -0,0 +1,112 @@
+require 'rubygems'
+require 'wckbapi'
+
+client = WCKBAPI::Client.new :wskey => 'WUg1y65bNZbtvxa6E8ieROEKf2Hy7fjNDZatpRVViG4cUAyBaPsI18fPSR0SBQk8torAxvR3dxsw5uwe'
+
+objR, objc = client.GetCollectionInfo(:collection_uid => 'NPG.journals')
+puts "Collection Info: \n"
+puts "Title: " + objc[0].title
+puts "Collection_uid: " + objc[0].collection_uid
+
+
+puts "\n"
+puts "******************* Collection Info ******************"
+objR, objc = client.GetCollectionInfo(:collection_uid => 'BMC.openAccess', 
+				:institution_id => '128807',
+				:type => 'search')
+
+puts "Collection Info (enum):\n"
+puts "Number of results: " + objR.totalResults.to_s + "\n"
+objc.each {|i|
+  puts "Title: " + i.title + "\n"
+  puts "Collection_uid: " + i.collection_uid + "\n"
+  puts "\n"
+} 
+
+puts "\n" 
+puts "******************* Collection Info Search **************"
+objR, objc = client.GetCollectionInfo(:institution_id => '128807', 
+			        :title => 'S%', 
+			        :type => 'search')
+
+puts "Collection Info Search (enum):\n"
+puts "Number of Results: " + objR.totalResults.to_s + "\n"
+objc.each {|i|
+  puts "Title: " + i.title + "\n"
+  puts "Collection_uid: " + i.collection_uid + "\n"
+  puts "\n"
+}
+
+puts "\n"
+puts "********************** SearchCollections ***************"
+objR, objc = client.SearchCollections(:institution_id => "128807", 
+				:title => 'S%')
+
+puts "Search Collection (enum):\n"
+puts "Number of Results: " + objR.totalResults.to_s + "\n"
+objc.each {|i|
+  puts "Title: " + i.title + "\n"
+  puts "Collection_uid: " + i.collection_uid + "\n"
+  puts "\n"
+}
+
+puts "\n"
+puts "*********************** Retrieve Providers *************"
+objR, objP = client.GetProviderInfo()
+objP.each {|i|
+  puts "Title: " + i.title + "\n"
+  puts "id: " + i.id + "\n"
+}
+
+puts "\n"
+puts "********************** Retrieve Providers **"
+objR, objP = client.GetProviderInfo(:title => 'BioOne')
+objP.each {|i|
+  puts "Title: " + i.title + "\n"
+  puts "id: " + i.id + "\n"
+}
+
+puts "\n"
+puts "********************** Retrieve Providers Search ********"
+objR, objP = client.SearchProviders(:institution_id => 128807)
+puts "Number of Results: " + objR.totalResults.to_s + "\n"
+objP.each {|i|
+  puts "Title: " + i.title + "\n"
+  puts "id: " + i.id + "\n"
+}
+
+puts "\n"
+puts "********************** Return and entry *****************"
+objR, objE = client.GetEntry(:collection_uid => 'ebrary.humanities',
+		       :entry_uid => '5639208')
+
+objE.each {|i|
+  puts "Title: " + i.title + "\n"
+  puts "id: " + i.id + "\n"
+}
+
+puts "\n"
+puts "********************* Return entry with entry id *******"
+
+objR, objE = client.GetEntry(:id => 'http://worldcat.org/webservices/kb/rest/entries/ebrary.humanities,5639208')
+objE.each {|i|
+  puts "Title: " + i.title + "\n"
+  puts "id: " + i.id + "\n"
+}
+
+puts "\n"
+
+puts "\n"
+puts "********************* Search Entries *******************"
+objR, objE = client.SearchEntries(:institution_id => '128807',
+			    :title => '"B%"')
+
+puts "Number of Results: " + objR.totalResults.to_s + "\n"
+objE.each {|i|
+  puts "Title: " + i.title + "\n"
+  puts "id: " + i.id + "\n"
+}
+
+puts "\n\n"
+
+puts "finished with tests"

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: wckbapi
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Terry Reese
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-05 00:00:00.000000000 Z
+dependencies: []
+description: This component provides a ruby component for processing the Knowledge
+  Base API provided by OCLC.  Users interested in using this component will need to
+  have an API key available from OCLC.
+email: reese.2179@osu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/wckbapi.rb
+- lib/wckbapi/client.rb
+- lib/wckbapi/collection.rb
+- lib/wckbapi/entry.rb
+- lib/wckbapi/provider.rb
+- lib/wckbapi/result.rb
+- test.rb
+homepage: 
+licenses:
+- Public Domain
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Ruby component for processing the WorldCat KB API
+test_files:
+- test.rb