Join GitHub today
GitHub is home to over 20 million developers working together to host and review code, manage projects, and build software together.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
|Failed to load latest commit information.|
= ruby-oai == DESCRIPTION ruby-oai is a Open Archives Protocol for Metadata Harvesting (OAI-PMH[http://openarchives.org]) library for Ruby. If you're not familiar with OAI-PMH[http://openarchives.org] it is the most used protocol for sharing metadata between digital library repositories. The OAI-PMH[http://openarchives.org] spec defines six verbs (Identify, ListIdentifiers, ListRecords, GetRecords, ListSets, ListMetadataFormat) used for discovery and sharing of metadata. The ruby-oai gem includes a client library, a server/provider library and a interactive harvesting shell. === client The OAI client library is used for harvesting metadata from repositories. For example to initiate a ListRecords request to pubmed you can: require 'oai' client = OAI::Client.new 'http://www.pubmedcentral.gov/oai/oai.cgi' for record in client.list_records puts record.metadata end See OAI::Client for more details === provider The OAI provider library handles serving local content to other clients. Setting up a simple provider: class MyProvider < Oai::Provider repository_name 'My little OAI provider' repository_url 'http://localhost/provider' record_prefix 'oai:localhost' admin_email 'root@localhost' # String or Array source_model MyModel.new # Subclass of OAI::Provider::Model end See OAI::Provider for more details === interactive harvester The OAI-PMH[http://openarchives.org] client shell allows OAI Harvesting to be configured in an interactive manner. Typing 'oai' on the command line starts the shell. After initial configuration, the shell can be used to manage harvesting operations. See OAI::Harvester::Shell for more details == INSTALLATION Normally the best way to install oai is from rubyforge using the gem command line tool: % gem install oai If you're reading this you've presumably got the tarball or zip distribution. So you'll need to: % rake package % gem install pkg/oai-x.y.z.gem Where x.y.z is the version of the gem that was generated. == TODO * consolidate response classes used by provider and client * automatic validation of metadata schemas * email the authors with your suggestions == AUTHORS - Ed Summers <firstname.lastname@example.org> - William Groppe <email@example.com> - Terry Reese <firstname.lastname@example.org>