rubydora 0.5.3 → 0.5.4

data/History.textile

@@ -1,3 +1,11 @@
+h3. 0.5.4
+* Query Benchmarking 
+* Custom exception classes
+
+h3. 0.5.3
+* Issue 11, cast versionable strings to boolean 
+* Allow versionable to be set to false 
+
 h3. 0.5.2
 * Force checksum query when you call dsChecksumValid, unless it's already in the profile.
 

data/VERSION

@@ -1 +1 @@
-0.5.3
+0.5.4

data/lib/rubydora/rest_api_client.rb

@@ -6,6 +6,7 @@ module Rubydora
   module RestApiClient
     
     include Rubydora::FedoraUrlHelpers
+    include ActiveSupport::Benchmarkable
 
     VALID_CLIENT_OPTIONS = [:user, :password, :timeout, :open_timeout, :ssl_client_cert, :ssl_client_key]
     # Create an authorized HTTP client for the Fedora REST API
@@ -38,10 +39,10 @@ module Rubydora
       options[:format] ||= 'xml'
       begin
         return client[next_pid_url(options)].post nil
-      rescue => e
+      rescue RestClient::InternalServerError => e
         logger.error e.response
         logger.flush if logger.respond_to? :flush
-        raise "Error getting nextPID. See logger for details"
+        raise FedoraInvalidRequest, "Error getting nextPID. See logger for details"
       end
     end
 
@@ -49,7 +50,7 @@ module Rubydora
     # @param [Hash] options
     # @return [String]
     def find_objects options = {}, &block_response
-      raise "" if options[:terms] and options[:query]
+      raise ArgumentError,"Cannot have both :terms and :query parameters" if options[:terms] and options[:query]
       options[:resultFormat] ||= 'xml'
 
       begin
@@ -58,10 +59,10 @@ module Rubydora
           resource.options[:block_response] = block_response
         end 
         return resource.get
-      rescue => e
+      rescue RestClient::InternalServerError => e
         logger.error e.response
         logger.flush if logger.respond_to? :flush
-        raise "Error finding objects. See logger for details"
+        raise FedoraInvalidRequest, "Error finding objects. See logger for details"
       end
     end
 
@@ -76,10 +77,10 @@ module Rubydora
         return client[object_url(pid, options)].get
       rescue RestClient::ResourceNotFound => e
         raise e
-      rescue => e
+      rescue RestClient::InternalServerError => e
         logger.error e.response
         logger.flush if logger.respond_to? :flush
-        raise "Error getting object #{pid}. See logger for details"
+        raise FedoraInvalidRequest, "Error getting object #{pid}. See logger for details"
       end
     end
 
@@ -92,10 +93,13 @@ module Rubydora
       file = options.delete(:file)
       begin
         return client[object_url(pid, options)].post file, :content_type => 'text/xml'
-      rescue => e
+      rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH => e
+        logger.error "Unable to connect to Fedora at #{@client.url}"
+        raise e
+      rescue RestClient::InternalServerError => e
         logger.error e.response
         logger.flush if logger.respond_to? :flush
-        raise "Error ingesting object #{pid}. See logger for details"
+        raise FedoraInvalidRequest, "Error ingesting object #{pid}. See logger for details"
       end
     end
 
@@ -107,9 +111,9 @@ module Rubydora
       pid = options.delete(:pid)
       begin
         return client[export_object_url(pid, options)].get
-      rescue => e
+      rescue RestClient::InternalServerError => e
         logger.error e.response
-        raise "Error exporting object #{pid}. See logger for details"
+        raise FedoraInvalidRequest, "Error exporting object #{pid}. See logger for details"
       end
     end
 
@@ -121,10 +125,10 @@ module Rubydora
       pid = options.delete(:pid)
       begin
         return client[object_url(pid, options)].put nil
-      rescue => e
+      rescue RestClient::InternalServerError => e
         logger.error e.response
         logger.flush if logger.respond_to? :flush
-        raise "Error modifying object #{pid}. See logger for details"
+        raise FedoraInvalidRequest, "Error modifying object #{pid}. See logger for details"
       end
     end
 
@@ -138,10 +142,10 @@ module Rubydora
         return client[object_url(pid, options)].delete
       rescue RestClient::ResourceNotFound => e
         raise e
-      rescue => e
+      rescue RestClient::InternalServerError => e
         logger.error e.response
         logger.flush if logger.respond_to? :flush
-        raise "Error purging object #{pid}. See logger for details"
+        raise FedoraInvalidRequest, "Error purging object #{pid}. See logger for details"
       end
     end
 
@@ -152,13 +156,13 @@ module Rubydora
     def object_versions options = {}
       pid = options.delete(:pid)
       options[:format] ||= 'xml'
-      raise "" unless pid
+      raise ArgumentError, "Must have a pid" unless pid
       begin
         return client[object_versions_url(pid, options)].get
-      rescue => e
+      rescue RestClient::InternalServerError => e
         logger.error e.response
         logger.flush if logger.respond_to? :flush
-        raise "Error getting versions for object #{pid}. See logger for details"
+        raise FedoraInvalidRequest, "Error getting versions for object #{pid}. See logger for details"
       end
     end
 
@@ -168,14 +172,14 @@ module Rubydora
     # @return [String]
     def object_xml options = {}
       pid = options.delete(:pid)
-      raise "" unless pid
+      raise ArgumentError, "Missing required parameter :pid" unless pid
       options[:format] ||= 'xml'
       begin
         return client[object_xml_url(pid, options)].get
-      rescue => e
+      rescue RestClient::InternalServerError => e
         logger.error e.response
         logger.flush if logger.respond_to? :flush
-        raise "Error getting objectXML for object #{pid}. See logger for details"
+        raise FedoraInvalidRequest, "Error getting objectXML for object #{pid}. See logger for details"
       end
     end
 
@@ -191,13 +195,21 @@ module Rubydora
       dsid = options.delete(:dsid)
       options[:format] ||= 'xml'
       begin
-        return client[datastream_url(pid, dsid, options)].get
+        val = nil
+        message = dsid.nil? ? "Loaded datastream list for #{pid}" : "Loaded datastream #{pid}/#{dsid}"
+        benchmark message, :level=>:debug do
+          val = client[datastream_url(pid, dsid, options)].get
+        end
+        return val
+      rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH => e
+        logger.error "Unable to connect to Fedora at #{@client.url}"
+        raise e
       rescue RestClient::ResourceNotFound => e
         raise e
-      rescue => e
+      rescue RestClient::InternalServerError => e
         logger.error e.response
         logger.flush if logger.respond_to? :flush
-        raise "Error getting datastream '#{dsid}' for object #{pid}. See logger for details"
+        raise FedoraInvalidRequest, "Error getting datastream '#{dsid}' for object #{pid}. See logger for details"
       end
     end
 
@@ -213,10 +225,10 @@ module Rubydora
       dsid = options.delete(:dsid)
       begin
         return client[datastream_url(pid, dsid, options)].put nil
-      rescue => e
+      rescue RestClient::InternalServerError => 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"
+        raise FedoraInvalidRequest, "Error setting datastream options on #{dsid} for object #{pid}. See logger for details"
       end
     end
 
@@ -235,11 +247,10 @@ module Rubydora
       rescue RestClient::ResourceNotFound => e
         #404 Resource Not Found: No datastream history could be found. There is no datastream history for the digital object "changeme:1" with datastream ID of "descMetadata
         return nil
-      rescue => e
-raise e
+      rescue RestClient::InternalServerError => 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"
+        raise FedoraInvalidRequest, "Error getting versions for datastream #{dsid} for object #{pid}. See logger for details"
       end
     end
 
@@ -264,10 +275,10 @@ raise e
         return resource.send(method)
       rescue RestClient::ResourceNotFound => e
         raise e
-      rescue => e
+      rescue RestClient::InternalServerError => 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"
+        raise FedoraInvalidRequest, "Error getting dissemination for datastream #{dsid} for object #{pid}. See logger for details"
       end
     end
 
@@ -283,10 +294,10 @@ raise e
       content_type = options.delete(:content_type) || options[:mimeType] || (MIME::Types.type_for(file.path).first if file.respond_to? :path) || 'application/octet-stream'
       begin
         return client[datastream_url(pid, dsid, options)].post file, :content_type => content_type.to_s, :multipart => true
-      rescue => e
+      rescue RestClient::InternalServerError => e
         logger.error e.response
         logger.flush if logger.respond_to? :flush
-        raise "Error adding datastream #{dsid} for object #{pid}. See logger for details"
+        raise FedoraInvalidRequest, "Error adding datastream #{dsid} for object #{pid}. See logger for details"
       end
     end
 
@@ -309,10 +320,10 @@ raise e
 
       begin
         return client[datastream_url(pid, dsid, options)].put(file, rest_client_options)
-      rescue => e
+      rescue RestClient::InternalServerError => e
         logger.error e.response
         logger.flush if logger.respond_to? :flush
-        raise "Error modifying datastream #{dsid} for #{pid}. See logger for details"
+        raise FedoraInvalidRequest, "Error modifying datastream #{dsid} for #{pid}. See logger for details"
       end
     end
 
@@ -326,10 +337,10 @@ raise e
       dsid = options.delete(:dsid)
       begin
         client[datastream_url(pid, dsid, options)].delete
-      rescue => e
+      rescue RestClient::InternalServerError => e
         logger.error e.response
         logger.flush if logger.respond_to? :flush
-        raise "Error purging datastream #{dsid} for #{pid}. See logger for details"
+        raise FedoraInvalidRequest, "Error purging datastream #{dsid} for #{pid}. See logger for details"
       end
     end
 
@@ -339,14 +350,14 @@ raise e
     # @return [String]
     def relationships options = {}
       pid = options.delete(:pid) || options[:subject]
-      raise "" unless pid
+      raise ArgumentError, "Missing required parameter :pid" unless pid
       options[:format] ||= 'xml'
       begin
         return client[object_relationship_url(pid, options)].get
-      rescue => e
+      rescue RestClient::InternalServerError => e
         logger.error e.response
         logger.flush if logger.respond_to? :flush
-        raise "Error getting relationships for #{pid}. See logger for details"
+        raise FedoraInvalidRequest, "Error getting relationships for #{pid}. See logger for details"
       end
     end
 
@@ -358,10 +369,10 @@ raise e
       pid = options.delete(:pid) || options[:subject]
       begin
         return client[new_object_relationship_url(pid, options)].post nil
-      rescue => e
+      rescue RestClient::InternalServerError => e
         logger.error e.response
         logger.flush if logger.respond_to? :flush
-        raise "Error adding relationship for #{pid}. See logger for details"
+        raise FedoraInvalidRequest, "Error adding relationship for #{pid}. See logger for details"
       end
     end
 
@@ -373,10 +384,10 @@ raise e
       pid = options.delete(:pid) || options[:subject]
       begin
         return client[object_relationship_url(pid, options)].delete
-      rescue => e
+      rescue RestClient::InternalServerError => e
         logger.error e.response
         logger.flush if logger.respond_to? :flush
-        raise "Error purging relationships for #{pid}. See logger for details"
+        raise FedoraInvalidRequest, "Error purging relationships for #{pid}. See logger for details"
       end
     end
 
@@ -397,10 +408,10 @@ raise e
           resource.options[:block_response] = block_response
         end
         return resource.get
-      rescue => e
+      rescue RestClient::InternalServerError => e
         logger.error e.response
         logger.flush if logger.respond_to? :flush
-        raise "Error getting dissemination for #{pid}. See logger for details"
+        raise FedoraInvalidRequest, "Error getting dissemination for #{pid}. See logger for details"
       end
     end
   end

data/lib/rubydora.rb

@@ -54,4 +54,10 @@ module Rubydora
     {:validateChecksum=>false}
   end
 
+  class RubydoraError < StandardError
+  end
+
+  class FedoraInvalidRequest < RubydoraError
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubydora
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-27 00:00:00.000000000 Z
+date: 2012-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastercsv
-  requirement: &70207867601020 !ruby/object:Gem::Requirement
+  requirement: &70336833980200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70207867601020
+  version_requirements: *70336833980200
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70207867611180 !ruby/object:Gem::Requirement
+  requirement: &70336833973900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70207867611180
+  version_requirements: *70336833973900
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70207867610600 !ruby/object:Gem::Requirement
+  requirement: &70336833994120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70207867610600
+  version_requirements: *70336833994120
 - !ruby/object:Gem::Dependency
   name: mime-types
-  requirement: &70207867609920 !ruby/object:Gem::Requirement
+  requirement: &70336833991880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70207867609920
+  version_requirements: *70336833991880
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70207867609280 !ruby/object:Gem::Requirement
+  requirement: &70336833989860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70207867609280
+  version_requirements: *70336833989860
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70207867607060 !ruby/object:Gem::Requirement
+  requirement: &70336833987740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70207867607060
+  version_requirements: *70336833987740
 - !ruby/object:Gem::Dependency
   name: savon
-  requirement: &70207867604800 !ruby/object:Gem::Requirement
+  requirement: &70336834009180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70207867604800
+  version_requirements: *70336834009180
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70207867631520 !ruby/object:Gem::Requirement
+  requirement: &70336834008120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70207867631520
+  version_requirements: *70336834008120
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70207867628840 !ruby/object:Gem::Requirement
+  requirement: &70336834006880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70207867628840
+  version_requirements: *70336834006880
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70207867644580 !ruby/object:Gem::Requirement
+  requirement: &70336834005220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: 1.0.14
   type: :development
   prerelease: false
-  version_requirements: *70207867644580
+  version_requirements: *70336834005220
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70207867643500 !ruby/object:Gem::Requirement
+  requirement: &70336834001740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70207867643500
+  version_requirements: *70336834001740
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70207867642360 !ruby/object:Gem::Requirement
+  requirement: &70336834022680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +142,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70207867642360
+  version_requirements: *70336834022680
 - !ruby/object:Gem::Dependency
   name: jettywrapper
-  requirement: &70207867637120 !ruby/object:Gem::Requirement
+  requirement: &70336834021440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,7 +153,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70207867637120
+  version_requirements: *70336834021440
 description: ! 'Fedora Commons REST API ruby library : REQUIRES FCREPO 3.4+'
 email:
 - chris@cbeer.info
@@ -213,7 +213,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4404235495484812155
+      hash: -1588477717339381900
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -222,10 +222,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4404235495484812155
+      hash: -1588477717339381900
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Fedora Commons REST API ruby library