rubydora 0.0.2

data/lib/rubydora/rest_api_client.rb

@@ -0,0 +1,267 @@
+module Rubydora
+
+  # Provide low-level access to the Fedora Commons REST API
+  module RestApiClient
+    # Fedora API documentation available at {https://wiki.duraspace.org/display/FCR30/REST+API}
+    API_DOCUMENTATION = 'https://wiki.duraspace.org/display/FCR30/REST+API'
+    # Create an authorized HTTP client for the Fedora REST API
+    # @param [Hash] config
+    # @option config [String] :url
+    # @option config [String] :user
+    # @option config [String] :password
+    # @return [RestClient::Resource]
+    def client config = {}
+      config = self.config.merge(config)
+      @client ||= RestClient::Resource.new config[:url], :user => config[:user], :password => config[:password]
+    end
+
+    # {include:RestApiClient::API_DOCUMENTATION}
+    # @param [Hash] options
+    # @return [String]
+    def next_pid options = {}
+      options[:format] ||= 'xml'
+      client[url_for(object_url() + "/nextPID", options)].post nil
+    end
+
+    # {include:RestApiClient::API_DOCUMENTATION}
+    # @param [Hash] options
+    # @return [String]
+    def find_objects options = {}
+      raise "" if options[:terms] and options[:query]
+      options[:resultFormat] ||= 'xml'
+
+      client[object_url(nil, options)].get
+    end
+
+    # {include:RestApiClient::API_DOCUMENTATION}
+    # @param [Hash] options
+    # @option options [String] :pid
+    # @return [String]
+    def object options = {}
+      pid = options.delete(:pid)
+      options[:format] ||= 'xml'
+      client[object_url(pid, options)].get
+    end
+
+    # {include:RestApiClient::API_DOCUMENTATION}
+    # @param [Hash] options
+    # @option options [String] :pid
+    # @return [String]
+    def ingest options = {}
+      pid = options.delete(:pid) || 'new'
+      file = options.delete(:file)
+      client[object_url(pid, options)].post file, :content_type => 'text/xml'
+    end
+
+    # {include:RestApiClient::API_DOCUMENTATION}
+    # @param [Hash] options
+    # @option options [String] :pid
+    # @return [String]
+    def modify_object options = {}
+      pid = options.delete(:pid)
+      client[object_url(pid, options)].put nil
+    end
+
+    # {include:RestApiClient::API_DOCUMENTATION}
+    # @param [Hash] options
+    # @option options [String] :pid
+    # @return [String]
+    def purge_object options = {}
+      pid = options.delete(:pid)
+      client[object_url(pid, options)].delete
+    end
+
+    # {include:RestApiClient::API_DOCUMENTATION}
+    # @param [Hash] options
+    # @option options [String] :pid
+    # @return [String]
+    def object_versions options = {}
+      pid = options.delete(:pid)
+      options[:format] ||= 'xml'
+      raise "" unless pid
+      client[url_for(object_url(pid) + "/versions", options)].get
+    end
+
+    # {include:RestApiClient::API_DOCUMENTATION}
+    # @param [Hash] options
+    # @option options [String] :pid
+    # @return [String]
+    def object_xml options = {}
+      pid = options.delete(:pid)
+      raise "" unless pid
+      options[:format] ||= 'xml'
+      client[url_for(object_url(pid) + "/objectXML", options)].get
+    end
+
+    # {include:RestApiClient::API_DOCUMENTATION}
+    # @param [Hash] options
+    # @option options [String] :pid
+    # @option options [String] :dsid
+    # @return [String]
+    def datastream options = {}
+      pid = options.delete(:pid)
+      dsid = options.delete(:dsid)
+      options[:format] ||= 'xml'
+      client[datastream_url(pid, dsid, options)].get
+    end
+
+    alias_method :datastreams, :datastream
+
+    # {include:RestApiClient::API_DOCUMENTATION}
+    # @param [Hash] options
+    # @option options [String] :pid
+    # @option options [String] :dsid
+    # @return [String]
+    def set_datastream_options options = {}
+      pid = options.delete(:pid)
+      dsid = options.delete(:dsid)
+      client[datastream_url(pid, dsid, options)].put nil
+    end
+
+    # {include:RestApiClient::API_DOCUMENTATION}
+    # @param [Hash] options
+    # @option options [String] :pid
+    # @option options [String] :dsid
+    # @return [String]
+    def datastream_versions options = {}
+      pid = options.delete(:pid)
+      dsid = options.delete(:dsid)
+      raise "" unless dsid
+      options[:format] ||= 'xml'
+      client[url_for(datastream_url(pid, dsid) + "/versions", options)].get
+    end
+
+    # {include:RestApiClient::API_DOCUMENTATION}
+    # @param [Hash] options
+    # @option options [String] :pid
+    # @option options [String] :dsid
+    # @return [String]
+    def datastream_dissemination options = {}
+      pid = options.delete(:pid)
+      dsid = options.delete(:dsid)
+      raise "" unless dsid
+      client[url_for(datastream_url(pid, dsid) + "/content", options)].get
+    end
+
+    # {include:RestApiClient::API_DOCUMENTATION}
+    # @param [Hash] options
+    # @option options [String] :pid
+    # @option options [String] :dsid
+    # @return [String]
+    def add_datastream options = {}
+      pid = options.delete(:pid)
+      dsid = options.delete(:dsid)
+      file = options.delete(:file)
+      content_type = options.delete(:content_type) || options[:mimeType] || (MIME::Types.type_for(file.path).first if file.respond_to? :path) || 'text/plain'
+      client[datastream_url(pid, dsid, options)].post file, :content_type => content_type.to_s
+    end
+
+    # {include:RestApiClient::API_DOCUMENTATION}
+    # @param [Hash] options
+    # @option options [String] :pid
+    # @option options [String] :dsid
+    # @return [String]
+    def modify_datastream options = {}
+      pid = options.delete(:pid)
+      dsid = options.delete(:dsid)
+      file = options.delete(:file)
+      content_type = options.delete(:content_type) || options[:mimeType] || (MIME::Types.type_for(file.path).first if file.respond_to? :path) || 'text/plain'
+      client[datastream_url(pid, dsid, options)].put file, :content_type => content_type.to_s
+    end
+
+    # {include:RestApiClient::API_DOCUMENTATION}
+    # @param [Hash] options
+    # @option options [String] :pid
+    # @option options [String] :dsid
+    # @return [String]
+    def purge_datastream options = {}
+      pid = options.delete(:pid)
+      dsid = options.delete(:dsid)
+      client[datastream_url(pid, dsid, options)].delete
+    end
+
+    # {include:RestApiClient::API_DOCUMENTATION}
+    # @param [Hash] options
+    # @option options [String] :pid
+    # @return [String]
+    def relationships options = {}
+      pid = options.delete(:pid) || options[:subject]
+      raise "" unless pid
+      options[:format] ||= 'xml'
+      client[url_for(object_url(pid) + "/relationships", options)].get
+    end
+
+    # {include:RestApiClient::API_DOCUMENTATION}
+    # @param [Hash] options
+    # @option options [String] :pid
+    # @return [String]
+    def add_relationship options = {}
+      pid = options.delete(:pid) || options[:subject]
+      client[url_for(object_url(pid) + "/relationships/new", options)].post nil
+    end
+
+    # {include:RestApiClient::API_DOCUMENTATION}
+    # @param [Hash] options
+    # @option options [String] :pid
+    # @return [String]
+    def purge_relationship options = {}
+      pid = options.delete(:pid) || options[:subject]
+      client[url_for(object_url(pid) + "/relationships", options)].delete
+    end
+
+    # {include:RestApiClient::API_DOCUMENTATION}
+    # @param [Hash] options
+    # @option options [String] :pid
+    # @option options [String] :sdef
+    # @option options [String] :method
+    # @return [String]
+    def dissemination options = {}
+      pid = options.delete(:pid)
+      sdef = options.delete(:sdef)
+      method = options.delete(:method)
+      options[:format] ||= 'xml' unless pid and sdef and method
+      client[dissemination_url(pid,sdef,method,options)].get
+    end
+    
+    private
+
+    # Generate a REST API compatible URI 
+    # @param [String] base base URI
+    # @param [Hash] options to convert to URL parameters
+    # @return [String] URI
+    def url_for base, options = nil
+      return base unless options.is_a? Hash
+      "#{base}" + (("?#{options.map { |key, value|  "#{CGI::escape(key.to_s)}=#{CGI::escape(value.to_s)}"}.join("&")  }" if options and not options.empty?) || '')
+    end
+
+    # Generate a base object REST API endpoint URI
+    # @param [String] pid
+    # @param [Hash] options to convert to URL parameters
+    # @return [String] URI
+    def object_url pid = nil, options = nil
+      url_for("objects" + (("/#{CGI::escape(pid.to_s.gsub('info:fedora/', ''))}" if pid) || ''), options)
+    end
+
+    # Generate a base object dissemination REST API endpoint URI
+    # @param [String] pid
+    # @param [String] sdef
+    # @param [String] method
+    # @param [Hash] options to convert to URL parameters
+    # @return [String] URI
+    def dissemination_url pid, sdef = nil, method = nil, options = nil
+      raise "" unless pid
+      url_for(object_url(pid) + "/methods" +  (("/#{CGI::escape(sdef)}" if sdef) || '') +  (("/#{CGI::escape(method)}" if method) || ''), options)
+    end
+
+    # Generate a base datastream REST API endpoint URI
+    # @param [String] pid
+    # @param [String] dsid
+    # @param [Hash] options to convert to URL parameters
+    # @return [String] URI
+    def datastream_url pid, dsid = nil, options = nil
+      raise "" unless pid
+      url_for(object_url(pid) + "/datastreams" + (("/#{CGI::escape(dsid)}" if dsid) || ''), options)
+    end
+
+  end
+end

data/lib/rubydora.rb

@@ -0,0 +1,46 @@
+# Fedora Commons REST API module
+module Rubydora
+  autoload :Datastream, "rubydora/datastream"
+  autoload :Repository, "rubydora/repository"
+  autoload :ResourceIndex, "rubydora/resource_index"
+  autoload :RestApiClient, "rubydora/rest_api_client"
+  autoload :ModelsMixin, "rubydora/models_mixin"
+  autoload :Ext, "rubydora/ext"
+  autoload :RelationshipsMixin, "rubydora/relationships_mixin"
+  autoload :DigitalObject, "rubydora/digital_object"
+  autoload :ExtensionParameters, "rubydora/extension_parameters"
+  autoload :Callbacks, "rubydora/callbacks"
+  autoload :ArrayWithCallback, "rubydora/array_with_callback"
+
+  require 'fastercsv'
+  require 'restclient'
+  require 'nokogiri'
+
+  # @return [String] version
+  def self.version
+    @version ||= File.read(File.join(File.dirname(__FILE__), '..', 'VERSION')).chomp
+  end
+
+  # version string
+  VERSION = self.version
+
+  # Connect to Fedora Repository
+  # @return Rubydora::Repository
+  def self.connect *args
+    Repository.new *args
+  end
+
+  # Connect to the default Fedora Repository
+  # @return Rubydora::Repository
+  def self.repository
+    @repository ||= self.connect(self.default_config)
+  end
+
+  # Default repository connection information
+  # TODO: read ENV variables?
+  # @return Hash
+  def self.default_config
+    {}
+  end
+
+end

data/rubydora.gemspec

@@ -0,0 +1,104 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rubydora}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Beer"]
+  s.date = %q{2011-04-18}
+  s.description = %q{Fedora Commons REST API ruby library : REQUIRES FCREPO 3.4+}
+  s.email = %q{chris@cbeer.info}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/rubydora.rb",
+    "lib/rubydora/array_with_callback.rb",
+    "lib/rubydora/callbacks.rb",
+    "lib/rubydora/datastream.rb",
+    "lib/rubydora/digital_object.rb",
+    "lib/rubydora/ext.rb",
+    "lib/rubydora/ext/solr.rb",
+    "lib/rubydora/extension_parameters.rb",
+    "lib/rubydora/models_mixin.rb",
+    "lib/rubydora/relationships_mixin.rb",
+    "lib/rubydora/repository.rb",
+    "lib/rubydora/resource_index.rb",
+    "lib/rubydora/rest_api_client.rb",
+    "lib/rubydora/rest_api_client/v33.rb",
+    "rubydora.gemspec",
+    "spec/datastream_spec.rb",
+    "spec/digital_object_spec.rb",
+    "spec/ext_solr_spec.rb",
+    "spec/integration_test_spec.rb",
+    "spec/repository_spec.rb",
+    "spec/resource_index_spec.rb",
+    "spec/rest_api_client_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/cbeer/rubydora}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.3}
+  s.summary = %q{Fedora Commons REST API ruby library}
+  s.test_files = [
+    "spec/datastream_spec.rb",
+    "spec/digital_object_spec.rb",
+    "spec/ext_solr_spec.rb",
+    "spec/integration_test_spec.rb",
+    "spec/repository_spec.rb",
+    "spec/resource_index_spec.rb",
+    "spec/rest_api_client_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<fastercsv>, [">= 0"])
+      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_runtime_dependency(%q<mime-types>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<fastercsv>, [">= 0"])
+      s.add_dependency(%q<rest-client>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<mime-types>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<fastercsv>, [">= 0"])
+    s.add_dependency(%q<rest-client>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<mime-types>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/spec/datastream_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe Rubydora::Datastream do
+  describe "create" do
+    before(:each) do
+      @mock_repository = mock(Rubydora::Repository)
+      @mock_object = mock(Rubydora::DigitalObject)
+      @mock_object.should_receive(:repository).any_number_of_times.and_return(@mock_repository)
+      @mock_object.should_receive(:pid).any_number_of_times.and_return 'pid'
+      @datastream = Rubydora::Datastream.new @mock_object, 'dsid'
+    end
+
+    it "should be new" do
+      @mock_repository.should_receive(:datastream).and_raise("")
+      @datastream.new?.should == true
+    end
+
+    it "should be dirty" do
+      @mock_repository.should_receive(:datastream).and_raise("")
+      @datastream.dirty?.should == true
+    end
+
+    it "should call the appropriate api on save" do
+      @mock_repository.should_receive(:datastream).and_raise("")
+      @mock_repository.should_receive(:add_datastream).with(hash_including(:pid => 'pid', :dsid => 'dsid', :controlGroup => 'M', :dsState => 'A'))
+      @datastream.save
+    end
+
+    it "should be able to override defaults" do
+      @mock_repository.should_receive(:datastream).and_raise("")
+      @mock_repository.should_receive(:add_datastream).with(hash_including(:controlGroup => 'E'))
+      @datastream.controlGroup = 'E'
+      @datastream.save
+    end
+  end
+
+  describe "retrieve" do
+    before(:each) do
+      @mock_repository = mock(Rubydora::Repository)
+      @mock_object = mock(Rubydora::DigitalObject)
+      @mock_object.should_receive(:repository).any_number_of_times.and_return(@mock_repository)
+      @mock_object.should_receive(:pid).any_number_of_times.and_return 'pid'
+      @datastream = Rubydora::Datastream.new @mock_object, 'dsid'
+      @mock_repository.should_receive(:datastream).any_number_of_times.and_return <<-XML
+        <datastreamProfile>
+          <dsLocation>some:uri</dsLocation>
+          <dsLabel>label</dsLabel>
+        </datastreamProfile>
+      XML
+    end
+
+    it "should not be new" do
+      @datastream.new?.should == false
+      @datastream.dirty?.should == false
+    end
+
+    it "should provide attribute defaults from dsProfile" do
+      @datastream.dsLocation.should == 'some:uri'
+      @datastream.dsLabel.should == 'label'
+    end
+
+    it "should mediate access to datastream contents" do
+      @mock_repository.should_receive(:datastream_dissemination).with(hash_including(:pid => 'pid', :dsid => 'dsid')).and_return('asdf') 
+      @datastream.content.should == "asdf"
+    end
+
+
+  end
+
+  describe "update" do
+
+    before(:each) do
+      @mock_repository = mock(Rubydora::Repository)
+      @mock_object = mock(Rubydora::DigitalObject)
+      @mock_object.should_receive(:repository).any_number_of_times.and_return(@mock_repository)
+      @mock_object.should_receive(:pid).any_number_of_times.and_return 'pid'
+      @datastream = Rubydora::Datastream.new @mock_object, 'dsid'
+      @mock_repository.should_receive(:datastream).any_number_of_times.and_return <<-XML
+        <datastreamProfile>
+          <dsLocation>some:uri</dsLocation>
+          <dsLabel>label</dsLabel>
+        </datastreamProfile>
+      XML
+    end
+
+    it "should allow profile attributes to be replaced" do
+      @datastream.dsLabel = "New Label"
+      @datastream.dsLabel.should == "New Label"
+    end
+
+    it "should call the appropriate api with any dirty attributes" do
+      @mock_repository.should_receive(:modify_datastream).with(hash_including(:dsLabel => "New Label"))
+      @datastream.dsLabel = "New Label"
+      @datastream.save
+    end
+
+  end
+
+end
+