rubydora 0.4.0pre1 → 0.4.0

data/VERSION

@@ -1 +1 @@
-0.4.0pre1
+0.4.0

data/lib/rubydora/fedora_url_helpers.rb

@@ -0,0 +1,114 @@
+module Rubydora
+  module FedoraUrlHelpers
+    # Fedora API documentation available at {https://wiki.duraspace.org/display/FCR30/REST+API}
+    API_DOCUMENTATION = 'https://wiki.duraspace.org/display/FCR30/REST+API'
+    
+    # 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, options = nil
+      url_for("objects" + (("/#{CGI::escape(pid.to_s.gsub('info:fedora/', ''))}" if pid) || ''), options)
+    end
+
+    # @param [Hash] options to convert to URL parameters
+    # @return [String] URI
+    def next_pid_url options = nil
+      url_for("objects/nextPID", options)
+    end
+
+    # @param [Hash] options to convert to URL parameters
+    # @return [String] URI
+    def find_objects_url options = nil
+      url_for("objects", 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
+
+    # @param [String] pid
+    # @param [String] dsid
+    # @param [Hash] options to convert to URL parameters
+    # @return [String] URI
+    def datastream_content_url pid, dsid = nil, options = nil
+      url_for(datastream_url(pid, dsid) +  "/content", options)
+    end
+
+    # @param [String] pid
+    # @param [String] dsid
+    # @param [Hash] options to convert to URL parameters
+    # @return [String] URI
+    def datastream_history_url pid, dsid = nil, options = nil
+      url_for(datastream_url(pid, dsid) +  "/history", options)
+    end
+
+    # @param [String] pid
+    # @param [Hash] options to convert to URL parameters
+    # @return [String] URI
+    def validate_object_url pid, options = nil
+      url_for(object_url(pid) + "/validate", options)
+    end
+
+    # @param [String] pid
+    # @param [Hash] options to convert to URL parameters
+    # @return [String] URI
+    def export_object_url pid, options = nil
+      url_for(object_url(pid) + "/export", options)
+    end
+
+    # @param [String] pid
+    # @param [Hash] options to convert to URL parameters
+    # @return [String] URI
+    def object_versions_url pid, options = nil
+      url_for(object_url(pid) + "/versions", options)
+    end
+
+    # @param [String] pid
+    # @param [Hash] options to convert to URL parameters
+    # @return [String] URI
+    def object_xml_url pid, options = nil
+      url_for(object_url(pid) + "/objectXML", options)
+    end
+
+    # @param [String] pid
+    # @param [Hash] options to convert to URL parameters
+    # @return [String] URI
+    def object_relationship_url pid, options = nil
+      url_for(object_url(pid) + "/relationships", options)
+    end
+
+    # @param [String] pid
+    # @param [Hash] options to convert to URL parameters
+    # @return [String] URI
+    def new_object_relationship_url pid, options = nil
+      url_for(object_relationship_url(pid) + "/new", options)
+    end
+  end
+end

data/lib/rubydora/rest_api_client.rb

@@ -2,8 +2,9 @@ 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'
+    
+    include Rubydora::FedoraUrlHelpers
+
     VALID_CLIENT_OPTIONS = [:user, :password, :timeout, :open_timeout, :ssl_client_cert, :ssl_client_key]
     # Create an authorized HTTP client for the Fedora REST API
     # @param [Hash] config
@@ -30,9 +31,10 @@ module Rubydora
     def next_pid options = {}
       options[:format] ||= 'xml'
       begin
-        return client[url_for(object_url() + "/nextPID", options)].post nil
+        return client[next_pid_url(options)].post nil
       rescue => e
         logger.error e.response
+        logger.flush if logger.respond_to? :flush
         raise "Error getting nextPID. See logger for details"
       end
     end
@@ -45,13 +47,14 @@ module Rubydora
       options[:resultFormat] ||= 'xml'
 
       begin
-        resource = client[object_url(nil, options)]
+        resource = client[find_objects_url(options)]
         if block_given?
           resource.options[:block_response] = block_response
         end 
         return resource.get
       rescue => e
         logger.error e.response
+        logger.flush if logger.respond_to? :flush
         raise "Error finding objects. See logger for details"
       end
     end
@@ -69,6 +72,7 @@ module Rubydora
         raise e
       rescue => e
         logger.error e.response
+        logger.flush if logger.respond_to? :flush
         raise "Error getting object #{pid}. See logger for details"
       end
     end
@@ -84,10 +88,25 @@ module Rubydora
         return client[object_url(pid, options)].post file, :content_type => 'text/xml'
       rescue => e
         logger.error e.response
+        logger.flush if logger.respond_to? :flush
         raise "Error ingesting object #{pid}. See logger for details"
       end
     end
 
+    # {include:RestApiClient::API_DOCUMENTATION}
+    # @param [Hash] options
+    # @option options [String] :pid
+    # @return [String]
+    def export options = {}
+      pid = options.delete(:pid)
+      begin
+        return client[export_object_url(pid, options)].get
+      rescue => e
+        logger.error e.response
+        raise "Error exporting object #{pid}. See logger for details"
+      end
+    end
+
     # {include:RestApiClient::API_DOCUMENTATION}
     # @param [Hash] options
     # @option options [String] :pid
@@ -98,6 +117,7 @@ module Rubydora
         return client[object_url(pid, options)].put nil
       rescue => e
         logger.error e.response
+        logger.flush if logger.respond_to? :flush
         raise "Error modifying object #{pid}. See logger for details"
       end
     end
@@ -114,6 +134,7 @@ module Rubydora
         raise e
       rescue => e
         logger.error e.response
+        logger.flush if logger.respond_to? :flush
         raise "Error purging object #{pid}. See logger for details"
       end
     end
@@ -127,9 +148,10 @@ module Rubydora
       options[:format] ||= 'xml'
       raise "" unless pid
       begin
-        return client[url_for(object_url(pid) + "/versions", options)].get
+        return client[object_versions_url(pid, options)].get
       rescue => e
         logger.error e.response
+        logger.flush if logger.respond_to? :flush
         raise "Error getting versions for object #{pid}. See logger for details"
       end
     end
@@ -143,9 +165,10 @@ module Rubydora
       raise "" unless pid
       options[:format] ||= 'xml'
       begin
-        return client[url_for(object_url(pid) + "/objectXML", options)].get
+        return client[object_xml_url(pid, options)].get
       rescue => e
         logger.error e.response
+        logger.flush if logger.respond_to? :flush
         raise "Error getting objectXML for object #{pid}. See logger for details"
       end
     end
@@ -165,6 +188,7 @@ module Rubydora
         raise e
       rescue => e
         logger.error e.response
+        logger.flush if logger.respond_to? :flush
         raise "Error getting datastream '#{dsid}' for object #{pid}. See logger for details"
       end
     end
@@ -183,6 +207,7 @@ module Rubydora
         return client[datastream_url(pid, dsid, options)].put nil
       rescue => e
         logger.error e.response
+        logger.flush if logger.respond_to? :flush
         raise "Error setting datastream options on #{dsid} for object #{pid}. See logger for details"
       end
     end
@@ -198,9 +223,10 @@ module Rubydora
       raise ArgumentError, "Must supply dsid" unless dsid
       options[:format] ||= 'xml'
       begin
-        return client[url_for(datastream_url(pid, dsid) + "/history", options)].get
+        return client[datastream_history_url(pid, dsid, options)].get
       rescue => e
         logger.error e.response
+        logger.flush if logger.respond_to? :flush
         raise "Error getting versions for datastream #{dsid} for object #{pid}. See logger for details"
       end
     end
@@ -219,7 +245,7 @@ module Rubydora
       method ||= :get
       raise self.class.name + "#datastream_dissemination requires a DSID" unless dsid
       begin
-        resource = client[url_for(datastream_url(pid, dsid) + "/content", options)]
+        resource = client[datastream_content_url(pid, dsid, options)]
         if block_given?
           resource.options[:block_response] = block_response
         end
@@ -228,6 +254,7 @@ module Rubydora
         raise e
       rescue => e
         logger.error e.response
+        logger.flush if logger.respond_to? :flush
         raise "Error getting dissemination for datastream #{dsid} for object #{pid}. See logger for details"
       end
     end
@@ -246,6 +273,7 @@ module Rubydora
         return client[datastream_url(pid, dsid, options)].post file, :content_type => content_type.to_s, :multipart => true
       rescue => e
         logger.error e.response
+        logger.flush if logger.respond_to? :flush
         raise "Error adding datastream #{dsid} for object #{pid}. See logger for details"
       end
     end
@@ -271,6 +299,7 @@ module Rubydora
         return client[datastream_url(pid, dsid, options)].put(file, rest_client_options)
       rescue => e
         logger.error e.response
+        logger.flush if logger.respond_to? :flush
         raise "Error modifying datastream #{dsid} for #{pid}. See logger for details"
       end
     end
@@ -287,6 +316,7 @@ module Rubydora
         client[datastream_url(pid, dsid, options)].delete
       rescue => e
         logger.error e.response
+        logger.flush if logger.respond_to? :flush
         raise "Error purging datastream #{dsid} for #{pid}. See logger for details"
       end
     end
@@ -300,9 +330,10 @@ module Rubydora
       raise "" unless pid
       options[:format] ||= 'xml'
       begin
-        return client[url_for(object_url(pid) + "/relationships", options)].get
+        return client[object_relationship_url(pid, options)].get
       rescue => e
         logger.error e.response
+        logger.flush if logger.respond_to? :flush
         raise "Error getting relationships for #{pid}. See logger for details"
       end
     end
@@ -314,9 +345,10 @@ module Rubydora
     def add_relationship options = {}
       pid = options.delete(:pid) || options[:subject]
       begin
-        return client[url_for(object_url(pid) + "/relationships/new", options)].post nil
+        return client[new_object_relationship_url(pid, options)].post nil
       rescue => e
         logger.error e.response
+        logger.flush if logger.respond_to? :flush
         raise "Error adding relationship for #{pid}. See logger for details"
       end
     end
@@ -328,9 +360,10 @@ module Rubydora
     def purge_relationship options = {}
       pid = options.delete(:pid) || options[:subject]
       begin
-        return client[url_for(object_url(pid) + "/relationships", options)].delete
+        return client[object_relationship_url(pid, options)].delete
       rescue => e
         logger.error e.response
+        logger.flush if logger.respond_to? :flush
         raise "Error purging relationships for #{pid}. See logger for details"
       end
     end
@@ -354,47 +387,9 @@ module Rubydora
         return resource.get
       rescue => e
         logger.error e.response
+        logger.flush if logger.respond_to? :flush
         raise "Error getting dissemination for #{pid}. See logger for details"
       end
     end
-    
-    # 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

@@ -5,6 +5,7 @@ module Rubydora
   autoload :Datastream, "rubydora/datastream"
   autoload :Repository, "rubydora/repository"
   autoload :ResourceIndex, "rubydora/resource_index"
+  autoload :FedoraUrlHelpers, "rubydora/fedora_url_helpers"
   autoload :RestApiClient, "rubydora/rest_api_client"
   autoload :Soap, "rubydora/soap"
   autoload :ModelsMixin, "rubydora/models_mixin"

data/spec/lib/rest_api_client_spec.rb

@@ -72,6 +72,11 @@ describe Rubydora::RestApiClient do
     @mock_repository.ingest :pid => 'mypid'
   end
 
+  it "export" do
+     RestClient::Request.should_receive(:execute).with(hash_including(:url => "http://example.org/objects/mypid/export"))
+    @mock_repository.export :pid => 'mypid'
+  end
+
   it "modify_object" do
      RestClient::Request.should_receive(:execute) do |params|
        params.should have_key(:url)

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: rubydora
 version: !ruby/object:Gem::Version
-  version: 0.4.0pre1
-  prerelease: 5
+  version: 0.4.0
+  prerelease: 
 platform: ruby
 authors:
 - Chris Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-29 00:00:00.000000000 Z
+date: 2012-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastercsv
-  requirement: &70158854103660 !ruby/object:Gem::Requirement
+  requirement: &2155958160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70158854103660
+  version_requirements: *2155958160
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70158854103200 !ruby/object:Gem::Requirement
+  requirement: &2155956720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70158854103200
+  version_requirements: *2155956720
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70158854102700 !ruby/object:Gem::Requirement
+  requirement: &2155955480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70158854102700
+  version_requirements: *2155955480
 - !ruby/object:Gem::Dependency
   name: mime-types
-  requirement: &70158854102180 !ruby/object:Gem::Requirement
+  requirement: &2155953580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70158854102180
+  version_requirements: *2155953580
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70158854101740 !ruby/object:Gem::Requirement
+  requirement: &2155952300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70158854101740
+  version_requirements: *2155952300
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70158854101320 !ruby/object:Gem::Requirement
+  requirement: &2155951480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70158854101320
+  version_requirements: *2155951480
 - !ruby/object:Gem::Dependency
   name: savon
-  requirement: &70158854117240 !ruby/object:Gem::Requirement
+  requirement: &2155950780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70158854117240
+  version_requirements: *2155950780
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70158854116180 !ruby/object:Gem::Requirement
+  requirement: &2155966020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70158854116180
+  version_requirements: *2155966020
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70158854115100 !ruby/object:Gem::Requirement
+  requirement: &2155962840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70158854115100
+  version_requirements: *2155962840
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70158854112280 !ruby/object:Gem::Requirement
+  requirement: &2155960880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: 1.0.14
   type: :development
   prerelease: false
-  version_requirements: *70158854112280
+  version_requirements: *2155960880
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70158854111780 !ruby/object:Gem::Requirement
+  requirement: &2155960000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70158854111780
+  version_requirements: *2155960000
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70158854111220 !ruby/object:Gem::Requirement
+  requirement: &2155959220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +142,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70158854111220
+  version_requirements: *2155959220
 - !ruby/object:Gem::Dependency
   name: jettywrapper
-  requirement: &70158854110800 !ruby/object:Gem::Requirement
+  requirement: &2155974620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,7 +153,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70158854110800
+  version_requirements: *2155974620
 description: ! 'Fedora Commons REST API ruby library : REQUIRES FCREPO 3.4+'
 email:
 - chris@cbeer.info
@@ -177,6 +177,7 @@ files:
 - lib/rubydora/ext/model_loader.rb
 - lib/rubydora/ext/solr.rb
 - lib/rubydora/extension_parameters.rb
+- lib/rubydora/fedora_url_helpers.rb
 - lib/rubydora/models_mixin.rb
 - lib/rubydora/relationships_mixin.rb
 - lib/rubydora/repository.rb
@@ -211,13 +212,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 142486579625571647
+      hash: -3967539369509241218
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
+      segments:
+      - 0
+      hash: -3967539369509241218
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10