Worldcat::Discovery UMD-Fork

The worldcat-discovery-ruby repository is forked to provide a version of the gem that uses a custom version of spira that includes the fix for Spira Pull Request #50 issue. This UMD-Fork can be removed when the OCLC version can be updated to use a spira version that includes the fix for Pull Request #50.

Using the UMD version

The umd version of the gem will be deployed to the UMD Nexus.

1. Configure the gem source to include the UMD Nexus rubygems group

gem sources --add https://maven.lib.umd.edu/nexus/content/groups/umd-ruby-gems-repository-group/

# Or declare it as a source in Gemfile
source 'https://maven.lib.umd.edu/nexus/content/groups/umd-ruby-gems-repository-group/'

2. Use the gem install command or list the gem in the Gemfile or gemspec file.

UMD Versions

See the releases tab for tags that include a fouth sequence (E.g. 1.2.0.1 - 1.2.0 in the OCLC's worldcat-discovery version and 1 is the umd sub-version).

Deploying to Nexus

1. Build the gem

gem build worldcat-discovery.gemspec

2. Follow the instructions at UMD Nexus Ruby Gems to push to nexus.

Worldcat::Discovery

Ruby gem wrapper around WorldCat Discovery API.

Please Note: This API is not yet in production and this documentation is only published for our group of alpha release testers for feedback purposes only.

Installation

Prior to installing this gem manually as outlined below, you will need to go through the same process for the OCLC::Auth gem for the API key dependency.

$ git clone https://github.com/OCLC-Developer-Network/worldcat-discovery-ruby.git
$ cd worldcat-discovery-ruby
$ bundle install
$ gem build worldcat-discovery.gemspec
$ gem install worldcat-discovery-<VERSION-NUMBER>.gem

Usage

Find a Bibliographic Resource in WorldCat

require 'worldcat/discovery'

wskey = OCLC::Auth::WSKey.new('api-key', 'api-key-secret', :services => ['WorldCatDiscoveryAPI'])
WorldCat::Discovery.configure(wskey, 128807, 128807)

bib = WorldCat::Discovery::Bib.find(255034622)

bib.name         # => "Programming Ruby."
bib.id           # => #<RDF::URI:0x3feb33057c70 URI:http://www.worldcat.org/oclc/255034622>
bib.id.to_s      # => "http://www.worldcat.org/oclc/255034622"
bib.type         # => #<RDF::URI:0x3feb3300fe84 URI:http://schema.org/Book>
bib.type.to_s    # => "http://schema.org/Book"
bib.author       # => <WorldCat::Discovery::Person:70279384406040 @subject: http://viaf.org/viaf/107579098>
bib.author.name  # => "Thomas, David."
bib.contributors.map{|contributor| contributor.name} # => [" Fowler, Chad.", "Hunt, Andrew."]

Search for Bibliographic Resources in WorldCat

require 'worldcat/discovery'

wskey = OCLC::Auth::WSKey.new('api-key', 'api-key-secret', :services => ['WorldCatDiscoveryAPI'])
WorldCat::Discovery.configure(wskey, 128807, 128807)

params = Hash.new
params[:q] = 'programming ruby'
params[:facetFields] = ['itemType:10', 'inLanguage:10']
params[:startNum] = 0
results = WorldCat::Discovery::Bib.search(params)

results.bibs.map {|bib| str = bib.name; str += " (#{bib.date_published})" if bib.date_published; str}
# => ["Programming Ruby. (2008)", "Programming Ruby : the pragmatic programmers' guide (2005)", "The Ruby programming language (2008)", ... ]

Understanding the subclasses

The library contains subclasses for different types of materials that appear within WorldCat. These include:

• Article
• Movie
• Music Album
• Periodical

Article Example

require 'worldcat/discovery'

wskey = OCLC::Auth::WSKey.new('api-key', 'api-key-secret', :services => ['WorldCatDiscoveryAPI'])
WorldCat::Discovery.configure(wskey, 128807, 128807)

bib = WorldCat::Discovery::Bib.find(5131938809)

bib.name            # => "How Much Would US Style Fiscal Integration Buffer European Unemployment and Income Shocks? (A Comparative Empirical Analysis)"
bib.id              # => #<RDF::URI:0x3feb33057c70 URI:http://www.worldcat.org/oclc/5131938809>
bib.id.to_s         # => "http://www.worldcat.org/oclc/5131938809"
bib.type            # => #<RDF::URI:0x3feb3300fe84 URI:http://schema.org/Article>
bib.type.to_s       # => "http://schema.org/Article"
bib.author          # => <WorldCat::Discovery::Person:70279384406040 @subject: http://viaf.org/viaf/107579098>
bib.author.name     # => "Feyrer, James"
bib.contributors.map{|contributor| contributor.name} # => ["Sacerdote, Bruce", "Feyrer, James"]
bib.page_start      # => 125
bib.page_end        # => 128
bib.periodical.name # => "American Economic Review"
bib.volume.volume_number   # => 3
bib.issue.issue_number    # => 103