rubydora 1.8.1 → 1.9.0

data/lib/rubydora/relationships_mixin.rb

@@ -1,6 +1,6 @@
 module Rubydora
   #
-  # This model inject RELS-EXT-based helper methods 
+  # This model inject RELS-EXT-based helper methods
   # for Fedora objects
   #
   module RelationshipsMixin
@@ -32,9 +32,9 @@ module Rubydora
     # generate accessor methods for each RELS_EXT property
     def self.included(base)
 
-        # FIXME: ugly, but functional..
-        RELS_EXT.each do |name, property|
-          base.class_eval <<-RUBY
+      # FIXME: ugly, but functional..
+      RELS_EXT.each do |name, property|
+        base.class_eval <<-RUBY
             def #{name.to_s} args = {}
               relationships[:#{name}] = nil if args.delete(:refetch)
               relationships[:#{name}] ||= relationship('#{property}', args)
@@ -49,9 +49,9 @@ module Rubydora
               arr
             end
           RUBY
-        end
+      end
     end
-          
+
     ##
     # Provides an accessor to the `predicate` RELS-EXT relationship
     # Using ArrayWithCallback, will commit any changes to Fedora
@@ -60,14 +60,13 @@ module Rubydora
     # @param [Hash] args
     # @option args [Array] :values if nil, will query the resource index for related objects
     # @return [ArrayWithCallback<Rubydora::DigitalObject>] an array that will call the #relationship_changed callback when values are modified
-    def relationship predicate, args = {}
+    def relationship(predicate, args = {})
       arr = ArrayWithCallback.new(args[:values] || repository.find_by_sparql_relationship(fqpid, predicate))
-      arr.on_change << lambda { |arr, diff| relationship_changed(predicate, diff, arr) } 
+      arr.on_change << lambda { |arr, diff| relationship_changed(predicate, diff, arr) }
 
       arr
     end
 
-
     ##
     # Given a predicate and a diff between before and after states
     # commit the appropriate changes to Fedora
@@ -77,24 +76,24 @@ module Rubydora
     # @option diff [Hash] :+ additions
     # @option diff [Hash] :- deletions
     # @param [Array] arr the current relationship state
-    def relationship_changed predicate, diff, arr = []
+    def relationship_changed(predicate, diff, arr = [])
       diff[:+] ||= []
       diff[:-] ||= []
 
-      diff[:+].each do |o| 
+      diff[:+].each do |o|
         add_relationship(predicate, o)
-      end        
+      end
 
-      diff[:-].each do |o| 
+      diff[:-].each do |o|
         purge_relationship(predicate, o)
-      end        
+      end
     end
 
     # Add a relationship for this object
     # @param [String] predicate
     # @param [String, Rubydora::DigitalObject] object
     # @return self
-    def add_relationship predicate, object
+    def add_relationship(predicate, object)
       obj_uri = (( object.fqpid if object.respond_to? :fqpid ) || ( object.uri if object.respond_to? :uri ) || (object.to_s if object.respond_to? :to_s?) || object )
       repository.add_relationship :subject => fqpid, :predicate => predicate, :object => obj_uri
       self
@@ -104,7 +103,7 @@ module Rubydora
     # @param [String] predicate
     # @param [String, Rubydora::DigitalObject] object
     # @return self
-    def purge_relationship predicate, object
+    def purge_relationship(predicate, object)
       obj_uri = (( object.fqpid if object.respond_to? :fqpid ) || ( object.uri if object.respond_to? :uri ) || (object.to_s if object.respond_to? :to_s?) || object )
       repository.purge_relationship :subject => fqpid, :predicate => predicate, :object => obj_uri
     end

data/lib/rubydora/repository.rb

@@ -31,18 +31,18 @@ module Rubydora
     # @option options [String] :user
     # @option options [String] :password
     # @option options [Boolean] :validateChecksum
-    def initialize options = {}, api = nil
+    def initialize(options = {}, api = nil)
       @config = options.symbolize_keys
       @api = api if api
       check_repository_version!
     end
 
     # {include:DigitalObject.find}
-    def find pid
+    def find(pid)
       DigitalObject.find(pid, self)
     end
 
-    def find_or_initialize pid
+    def find_or_initialize(pid)
       DigitalObject.find_or_initialize(pid, self)
     end
 
@@ -51,22 +51,22 @@ module Rubydora
     # @params [String] query
     # @params [Hash] options
     # @yield [DigitalObject] Yield a DigitalObject for each search result, skipping forbidden objects
-    def search query, options = {}, &block
+    def search(query, options = {}, &block)
       return to_enum(:search, query, options).to_a unless block_given?
-      
-      sessionToken = nil 
+
+      sessionToken = nil
       doc = nil
 
-      begin 
+      begin
         sessionOptions = {}
-        sessionOptions[:sessionToken] = sessionToken unless sessionToken.nil? or sessionToken.blank?
+        sessionOptions[:sessionToken] = sessionToken unless sessionToken.nil? || sessionToken.blank?
 
         response = self.find_objects(options.merge(:query => query, :resultFormat => 'xml', :pid => true).merge(sessionOptions))
 
         doc = Nokogiri::XML(response)
         doc.xpath('//xmlns:objectFields/xmlns:pid', doc.namespaces).each do |pid|
           begin
-            obj = self.find(pid.text);
+            obj = self.find(pid.text)
           rescue RestClient::Unauthorized
             next
           end
@@ -74,12 +74,12 @@ module Rubydora
         end
 
         sessionToken = doc.xpath('//xmlns:listSession/xmlns:token', doc.namespaces).text
-      end until sessionToken.nil? or sessionToken.empty? or doc.xpath('//xmlns:resultList/xmlns:objectFields', doc.namespaces).empty?
+      end until sessionToken.nil? || sessionToken.empty? || doc.xpath('//xmlns:resultList/xmlns:objectFields', doc.namespaces).empty?
 
     end
 
     # {include:DigitalObject.create}
-    def create pid, options = {}
+    def create(pid, options = {})
       DigitalObject.create(pid, options = {}, self)
     end
 

data/lib/rubydora/resource_index.rb

@@ -5,45 +5,41 @@ module Rubydora
   module ResourceIndex
     # Find new objects using a sparql query
     # @param [String] query SPARQL query
-    # @param [Hash] options 
+    # @param [Hash] options
     # @option options [String] :binding the SPARQL binding name to create new objects from
     # @return [Array<Rubydora::DigitalObject>]
-    def find_by_sparql query, options = { :binding => 'pid' }
+    def find_by_sparql(query, options = { :binding => 'pid' })
       return to_enum(:find_by_sparql, query, options).to_a unless block_given?
 
-      self.sparql(query).each do |x| 
+      self.sparql(query).each do |x|
         obj = self.find(x[options[:binding]]) rescue nil
         yield obj if obj
       end
     end
 
     # Find new objects by their relationship to a subject
-    # @param [String] subject Subject URI 
+    # @param [String] subject Subject URI
     # @param [String] predicate Predicate URI
     # @return [Array<Rubydora::DigitalObject>]
-    def find_by_sparql_relationship subject, predicate
+    def find_by_sparql_relationship(subject, predicate)
       find_by_sparql <<-RELSEXT
         SELECT ?pid FROM <#ri> WHERE {
-          <#{subject}> <#{predicate}> ?pid 
+          <#{subject}> <#{predicate}> ?pid
         }
       RELSEXT
     end
 
     # Run a raw SPARQL query and return a FasterCSV object
     # @param [String] query SPARQL query
-    # @return [FasterCSV::Table]
-    def sparql query
-      if CSV.const_defined? :Reader
-        FasterCSV.parse(self.risearch(query), :headers => true)
-      else
-        CSV.parse(self.risearch(query), :headers => true)
-      end
+    # @return [CSV::Table]
+    def sparql(query)
+      CSV.parse(self.risearch(query), :headers => true)
     end
 
     # Run a raw query against the Fedora risearch resource index
     # @param [String] query
     # @param [Hash] options
-    def risearch query, options = {}
+    def risearch(query, options = {})
       request_params = { :dt => 'on', :format => 'CSV', :lang => 'sparql', :limit => nil, :query => query, :type => 'tuples' }.merge(options)
 
       self.client['risearch'].post request_params

data/lib/rubydora/rest_api_client.rb

@@ -6,10 +6,10 @@ module Rubydora
 
   # Provide low-level access to the Fedora Commons REST API
   module RestApiClient
-    
+
     include Rubydora::FedoraUrlHelpers
     extend ActiveSupport::Concern
-    include ActiveSupport::Benchmarkable    
+    include ActiveSupport::Benchmarkable
     extend Deprecation
 
     DEFAULT_CONTENT_TYPE = "application/octet-stream"
@@ -19,7 +19,6 @@ module Rubydora
     included do
       include ActiveSupport::Rescuable
 
-
       rescue_from RestClient::InternalServerError do |e|
         if Rubydora.logger
           Rubydora.logger.error e.response
@@ -49,13 +48,13 @@ module Rubydora
     # @option config [String] :password
     # @return [RestClient::Resource]
     #TODO trap for these errors specifically: RestClient::Request::Unauthorized, Errno::ECONNREFUSED
-    def client config = {}
+    def client(config = {})
       client_config = self.config.merge(config)
       client_config.symbolize_keys!
-      if config.empty? or @config_hash.nil? or (client_config.hash == @config_hash)
+      if config.empty? || @config_hash.nil? || (client_config.hash == @config_hash)
         @config_hash = client_config.hash
         url = client_config[:url]
-        client_config.delete_if { |k,v| not VALID_CLIENT_OPTIONS.include?(k) }
+        client_config.delete_if { |k,v| !VALID_CLIENT_OPTIONS.include?(k) }
         client_config[:open_timeout] ||= client_config[:timeout]
         @client ||= RestClient::Resource.new(url, client_config)
       else
@@ -63,7 +62,7 @@ module Rubydora
       end
     end
 
-    def describe options = {}
+    def describe(options = {})
       query_options = options.dup
       query_options[:xml] ||= 'true'
       client[describe_repository_url(query_options)].get
@@ -74,7 +73,7 @@ module Rubydora
     # {include:RestApiClient::API_DOCUMENTATION}
     # @param [Hash] options
     # @return [String]
-    def next_pid options = {}
+    def next_pid(options = {})
       query_options = options.dup
       query_options[:format] ||= 'xml'
       client[next_pid_url(query_options)].post nil
@@ -85,15 +84,15 @@ module Rubydora
     # {include:RestApiClient::API_DOCUMENTATION}
     # @param [Hash] options
     # @return [String]
-    def find_objects options = {}, &block_response
+    def find_objects(options = {}, &block_response)
       query_options = options.dup
-      raise ArgumentError,"Cannot have both :terms and :query parameters" if query_options[:terms] and query_options[:query]
+      raise ArgumentError,"Cannot have both :terms and :query parameters" if query_options[:terms] && query_options[:query]
       query_options[:resultFormat] ||= 'xml'
 
       resource = client[find_objects_url(query_options)]
       if block_given?
         resource.query_options[:block_response] = block_response
-      end 
+      end
       return resource.get
     rescue Exception => exception
       rescue_with_handler(exception) || raise
@@ -103,20 +102,20 @@ module Rubydora
     # @param [Hash] options
     # @option options [String] :pid
     # @return [String]
-    def object options = {}
+    def object(options = {})
       query_options = options.dup
       pid = query_options.delete(:pid)
       query_options[:format] ||= 'xml'
       client[object_url(pid, query_options)].get
     rescue Exception => exception
-        rescue_with_handler(exception) || raise
+      rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
     # @param [Hash] options
     # @option options [String] :pid
     # @return [String]
-    def ingest options = {}
+    def ingest(options = {})
       query_options = options.dup
       pid = query_options.delete(:pid)
 
@@ -129,10 +128,10 @@ module Rubydora
       run_hook :after_ingest, :pid => assigned_pid, :file => file, :options => options
       assigned_pid
     rescue Exception => exception
-        rescue_with_handler(exception) || raise
+      rescue_with_handler(exception) || raise
     end
 
-    def mint_pid_and_ingest options = {}
+    def mint_pid_and_ingest(options = {})
       query_options = options.dup
       file = query_options.delete(:file)
 
@@ -140,74 +139,74 @@ module Rubydora
       run_hook :after_ingest, :pid => assigned_pid, :file => file, :options => options
       assigned_pid
     rescue Exception => exception
-        rescue_with_handler(exception) || raise
+      rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
     # @param [Hash] options
     # @option options [String] :pid
     # @return [String]
-    def export options = {}
+    def export(options = {})
       query_options = options.dup
       pid = query_options.delete(:pid)
       raise ArgumentError, "Must have a pid" unless pid
       client[export_object_url(pid, query_options)].get
     rescue Exception => exception
-        rescue_with_handler(exception) || raise
+      rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
     # @param [Hash] options
     # @option options [String] :pid
     # @return [String]
-    def modify_object options = {}
+    def modify_object(options = {})
       query_options = options.dup
       pid = query_options.delete(:pid)
       run_hook :before_modify_object, :pid => pid, :options => options
       ProfileParser.canonicalize_date_string(client[object_url(pid, query_options)].put(nil))
     rescue Exception => exception
-        rescue_with_handler(exception) || raise
+      rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
     # @param [Hash] options
     # @option options [String] :pid
     # @return [String]
-    def purge_object options = {}
+    def purge_object(options = {})
       query_options = options.dup
       pid = query_options.delete(:pid)
       run_hook :before_purge_object, :pid => pid, :options => options
       client[object_url(pid, query_options)].delete
     rescue Exception => exception
-        rescue_with_handler(exception) || raise
+      rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
     # @param [Hash] options
     # @option options [String] :pid
     # @return [String]
-    def object_versions options = {}
+    def object_versions(options = {})
       query_options = options.dup
       pid = query_options.delete(:pid)
       query_options[:format] ||= 'xml'
       raise ArgumentError, "Must have a pid" unless pid
       client[object_versions_url(pid, query_options)].get
     rescue Exception => exception
-        rescue_with_handler(exception) || raise
+      rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
     # @param [Hash] options
     # @option options [String] :pid
     # @return [String]
-    def object_xml options = {}
+    def object_xml(options = {})
       query_options = options.dup
       pid = query_options.delete(:pid)
       raise ArgumentError, "Missing required parameter :pid" unless pid
       query_options[:format] ||= 'xml'
       client[object_xml_url(pid, query_options)].get
     rescue Exception => exception
-        rescue_with_handler(exception) || raise
+      rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
@@ -217,7 +216,7 @@ module Rubydora
     # @option options [String] :asOfDateTime
     # @option options [String] :validateChecksum
     # @return [String]
-    def datastream options = {}
+    def datastream(options = {})
       query_options = options.dup
       pid = query_options.delete(:pid)
       dsid = query_options.delete(:dsid)
@@ -239,10 +238,10 @@ module Rubydora
       Rubydora.logger.error "Unauthorized at #{client.url}/#{datastream_url(pid, dsid, query_options)}" if Rubydora.logger
       raise e
     rescue Exception => exception
-        rescue_with_handler(exception) || raise
+      rescue_with_handler(exception) || raise
     end
 
-    def datastreams options = {}
+    def datastreams(options = {})
       unless options[:dsid].nil?
         #raise ArgumentError, "Missing required parameter :dsid" unless dsid
         Deprecation.warn(RestApiClient, "Calling Rubydora::RestApiClient#datastreams with a :dsid is deprecated, use #datastream instead")
@@ -262,7 +261,7 @@ module Rubydora
       Rubydora.logger.error "Unauthorized at #{client.url}/#{datastreams_url(pid, query_options)}" if Rubydora.logger
       raise e
     rescue Exception => exception
-        rescue_with_handler(exception) || raise
+      rescue_with_handler(exception) || raise
 
     end
 
@@ -271,14 +270,14 @@ module Rubydora
     # @option options [String] :pid
     # @option options [String] :dsid
     # @return [String]
-    def set_datastream_options options = {}
+    def set_datastream_options(options = {})
       query_options = options.dup
       pid = query_options.delete(:pid)
       dsid = query_options.delete(:dsid)
       run_hook :before_set_datastream_options, :pid => pid, :dsid => dsid, :options => options
       client[datastream_url(pid, dsid, query_options)].put nil
     rescue Exception => exception
-        rescue_with_handler(exception) || raise
+      rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
@@ -286,7 +285,7 @@ module Rubydora
     # @option options [String] :pid
     # @option options [String] :dsid
     # @return [String]
-    def datastream_versions options = {}
+    def datastream_versions(options = {})
       query_options = options.dup
       pid = query_options.delete(:pid)
       dsid = query_options.delete(:dsid)
@@ -297,7 +296,7 @@ module Rubydora
       #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 Exception => exception
-        rescue_with_handler(exception) || raise
+      rescue_with_handler(exception) || raise
     end
 
     alias_method :datastream_history, :datastream_versions
@@ -307,7 +306,7 @@ module Rubydora
     # @option options [String] :pid
     # @option options [String] :dsid
     # @return [String]
-    def datastream_dissemination options = {}, &block_response
+    def datastream_dissemination(options = {}, &block_response)
       query_options = options.dup
       pid = query_options.delete(:pid)
       dsid = query_options.delete(:dsid)
@@ -325,7 +324,7 @@ module Rubydora
       end
       val
     rescue Exception => exception
-        rescue_with_handler(exception) || raise
+      rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
@@ -333,7 +332,7 @@ module Rubydora
     # @option options [String] :pid
     # @option options [String] :dsid
     # @return [String]
-    def add_datastream options = {}
+    def add_datastream(options = {})
       query_options = options.dup
       pid = query_options.delete(:pid)
       dsid = query_options.delete(:dsid)
@@ -344,7 +343,7 @@ module Rubydora
       file.rewind if file.respond_to?(:rewind)
       ProfileParser.parse_datastream_profile(client[datastream_url(pid, dsid, query_options)].post(str, :content_type => content_type.to_s, :multipart => true))
     rescue Exception => exception
-        rescue_with_handler(exception) || raise
+      rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
@@ -352,7 +351,7 @@ module Rubydora
     # @option options [String] :pid
     # @option options [String] :dsid
     # @return [String]
-    def modify_datastream options = {}
+    def modify_datastream(options = {})
       query_options = options.dup
       pid = query_options.delete(:pid)
       dsid = query_options.delete(:dsid)
@@ -370,7 +369,7 @@ module Rubydora
       ProfileParser.parse_datastream_profile(client[datastream_url(pid, dsid, query_options)].put(str, rest_client_options))
 
     rescue Exception => exception
-        rescue_with_handler(exception) || raise
+      rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
@@ -378,54 +377,54 @@ module Rubydora
     # @option options [String] :pid
     # @option options [String] :dsid
     # @return [String]
-    def purge_datastream options = {}
+    def purge_datastream(options = {})
       query_options = options.dup
       pid = query_options.delete(:pid)
       dsid = query_options.delete(:dsid)
       run_hook :before_purge_datastream, :pid => pid, :dsid => dsid
       client[datastream_url(pid, dsid, query_options)].delete
     rescue Exception => exception
-        rescue_with_handler(exception) || raise
+      rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
     # @param [Hash] options
     # @option options [String] :pid
     # @return [String]
-    def relationships options = {}
+    def relationships(options = {})
       query_options = options.dup
       pid = query_options.delete(:pid) || query_options[:subject]
       raise ArgumentError, "Missing required parameter :pid" unless pid
       query_options[:format] ||= 'xml'
       client[object_relationship_url(pid, query_options)].get
     rescue Exception => exception
-        rescue_with_handler(exception) || raise
+      rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
     # @param [Hash] options
     # @option options [String] :pid
     # @return [String]
-    def add_relationship options = {}
+    def add_relationship(options = {})
       query_options = options.dup
       pid = query_options.delete(:pid) || query_options[:subject]
       run_hook :before_add_relationship, :pid => pid, :options => options
       client[new_object_relationship_url(pid, query_options)].post nil
     rescue Exception => exception
-        rescue_with_handler(exception) || raise
+      rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
     # @param [Hash] options
     # @option options [String] :pid
     # @return [String]
-    def purge_relationship options = {}
+    def purge_relationship(options = {})
       query_options = options.dup
       pid = query_options.delete(:pid) || query_options[:subject]
       run_hook :before_purge_relationship, :pid => pid, :options => options
       client[object_relationship_url(pid, query_options)].delete
     rescue Exception => exception
-        rescue_with_handler(exception) || raise
+      rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
@@ -434,12 +433,12 @@ module Rubydora
     # @option options [String] :sdef
     # @option options [String] :method
     # @return [String]
-    def dissemination options = {}, &block_response
+    def dissemination(options = {}, &block_response)
       query_options = options.dup
       pid = query_options.delete(:pid)
       sdef = query_options.delete(:sdef)
       method = query_options.delete(:method)
-      query_options[:format] ||= 'xml' unless pid and sdef and method
+      query_options[:format] ||= 'xml' unless pid && sdef && method
       if block_given?
         resource = safe_subresource(dissemination_url(pid,sdef,method,query_options), :block_response => block_response)
       else
@@ -448,10 +447,10 @@ module Rubydora
       resource.get
 
     rescue Exception => exception
-        rescue_with_handler(exception) || raise
+      rescue_with_handler(exception) || raise
 
     end
-    
+
     def safe_subresource(subresource, options=Hash.new)
       url = client.concat_urls(client.url, subresource)
       options = client.options.dup.merge! options