rubydora 1.8.1 → 1.9.0

data/.travis.yml

@@ -1,12 +1,12 @@
+sudo: false
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1
+  - 2.1.10
+  - 2.2.5
+  - 2.3.1
 
-gemfile:
-  - gemfiles/gemfile.rails3
-  - gemfiles/gemfile.rails4
+jdk:
+  - oraclejdk8
 
 notifications:
   irc: "irc.freenode.org#projecthydra"

data/Gemfile

@@ -1,7 +1,6 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gemspec
 
-gem 'simplecov', :platform => :mri_19
-gem 'simplecov-rcov', :platform => :mri_19
 gem 'jruby-openssl', :platform => :jruby
+gem 'activesupport', '< 5' if RUBY_VERSION < '2.2.2'

data/README.md

@@ -0,0 +1,86 @@
+# rubydora
+[<img src="https://travis-ci.org/projecthydra/rubydora.png?branch=master"
+alt="Build Status" />](https://travis-ci.org/projecthydra/rubydora) [<img
+src="https://badge.fury.io/rb/rubydora.png" alt="Gem Version"
+/>](http://badge.fury.io/rb/rubydora)
+
+Rubydora is a low-level Fedora Commons REST API consumer, providing direct
+access to REST API methods, as well as a primitive ruby abstraction.
+
+## Installation
+
+```bash
+gem install rubydora
+```
+
+## Examples
+
+```
+> repo = Rubydora.connect :url => 'http://localhost:8983/fedora', :user => 'fedoraAdmin', :password => 'fedoraAdmin'
+=> #<Rubydora::Repository:0x101859538 @config={:url=>"http://localhost:8983/fedora", :user=>"fedoraAdmin", :password=>"fedoraAdmin"}> 
+
+> obj = repo.find('test:1')
+=> #<Rubydora::DigitalObject:0x101977230 @pid="test:1", @repository=#<Rubydora::Repository:0x1019beef0 @config={:user=>"fedoraAdmin", :url=>"http://localhost:8983/fedora", :password=>"fedora"}>> 
+
+> obj.new?
+=> true 
+
+> obj = obj.save
+=> #<Rubydora::DigitalObject:0x1017601b8 @pid="test:1", @repository=#<Rubydora::Repository:0x1018e3058 @config={:url=>"http://localhost:8983/fedora", :user=>"fedoraAdmin", :password=>"fedoraAdmin"}, @client=#<RestClient::Resource:0x101882910 @options={:user=>"fedoraAdmin", :password=>"fedoraAdmin"}, @block=nil, @url="http://localhost:8983/fedora">>> 
+
+> obj.profile
+=> {"objDissIndexViewURL"=>"http://localhost:8983/fedora/get/test:1/fedora-system:3/viewMethodIndex", "objLabel"=>"", "objModels"=>"info:fedora/fedora-system:FedoraObject-3.0", "objCreateDate"=>"2011-04-18T13:34:11.285Z", "objOwnerId"=>"fedoraAdmin", "objState"=>"A", "objItemIndexViewURL"=>"http://localhost:8983/fedora/get/test:1/fedora-system:3/viewItemIndex", "objLastModDate"=>"2011-04-18T13:47:30.110Z"} 
+
+> obj.models
+=> ["info:fedora/fedora-system:FedoraObject-3.0"] 
+
+> obj.models << 'info:fedora/test:cmodel'
+=> ["info:fedora/fedora-system:FedoraObject-3.0", "info:fedora/test:cmodel"]
+
+> obj2 = repo.find('test:2')
+=> [...]
+
+> obj1.parts << obj2
+=> [...]
+
+> obj.datastreams
+=> {"DC"=>#<Rubydora::Datastream:0x101860180 @dsid="DC" ...> }
+
+> ds = obj.datastreams['File']
+=> #<Rubydora::Datastream:0x1017f26a8 @dsid="File" ...>
+> ds.controlGroup = 'R'
+=> "R"
+> ds.dsLocation = 'http://example.org/index.html'
+=> "http://example.org/index.html"
+> ds.dsLabel = 'Example redirect datastream'
+=> "Example redirect datastream"
+> ds.mimeType = 'text/html'
+=> "text/html"
+> ds.save 
+=> #<Rubydora::Datastream:0x10177a568 @dsid="File" ...> 
+
+> obj.datastreams
+=> {"DC"=>#<Rubydora::Datastream:0x101860180 @dsid="DC" ..., "File"=>#<Rubydora::Datastream:0x10177a568 @dsid="File" ...>}
+
+> obj.datastreams["File"].delete
+=> true
+> obj.datastreams["File"].new?
+=> true
+```
+
+## Contributing to rubydora
+
+*   Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+*   Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+*   Fork the project
+*   Start a feature/bugfix branch
+*   Commit and push until you are happy with your contribution
+*   Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+*   Please try not to mess with the Rakefile, version, or history. If you want
+    to have your own version, or is otherwise necessary, that is fine, but
+    please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2011 Chris Beer. See LICENSE.txt for further details.
+

data/Rakefile

@@ -1,56 +1,57 @@
 require 'rubygems'
 require 'bundler'
 require 'jettywrapper'
+require 'yard'
 require 'bundler/gem_tasks'
 
+ZIP_URL = 'https://github.com/projecthydra/hydra-jetty/archive/v7.2.0.zip'
+
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
   $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  $stderr.puts 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 
 # Get your spec rake tasks working in RSpec 2.0
-
 require 'rspec/core/rake_task'
 
 desc 'Default: run ci build.'
 task :default => :ci
 
-desc "Run specs"
+desc 'Run specs'
 RSpec::Core::RakeTask.new do |t|
-
-  if ENV['COVERAGE'] and RUBY_VERSION =~ /^1.8/
+  if ENV['COVERAGE'] && RUBY_VERSION =~ /^1.8/
     t.rcov = true
     t.rcov_opts = %w{--exclude spec\/*,gems\/*,ruby\/* --aggregate coverage.data}
   end
 end
 
-require 'yard'
-YARD::Rake::YardocTask.new do |t|
-  t.options = ["--readme", "README.rdoc"]
+YARD::Rake::YardocTask.new do |yt|
+  yt.files   = ['lib/**/*.rb']
+  yt.options = ['--readme', 'README.md']
 end
 
-desc "Open an irb session preloaded with this library"
+desc 'Open an irb session preloaded with this library'
 task :console do
-  sh "irb -rubygems -I lib -r rubydora.rb"
+  sh 'irb -rubygems -I lib -r rubydora.rb'
 end
 
-desc "Execute Continuous Integration build"
+desc 'Execute Continuous Integration build'
 task :ci => 'jetty:clean' do
   unless ENV['environment'] == 'test'
-    exec("rake ci environment=test") 
+    exec('rake ci environment=test')
   end
 
   jetty_params = {
-    :jetty_home => File.expand_path(File.dirname(__FILE__) + '/jetty'),
-    :quiet => false,
-    :jetty_port => ENV['TEST_JETTY_PORT'] || 8983,
-    :solr_home => File.expand_path(File.dirname(__FILE__) + '/jetty/solr'),
-    :fedora_home => File.expand_path(File.dirname(__FILE__) + '/jetty/fedora/default'),
+    :jetty_home   => File.expand_path(File.dirname(__FILE__) + '/jetty'),
+    :quiet        => true,
+    :jetty_port   => ENV['TEST_JETTY_PORT'] || 8983,
+    :solr_home    => File.expand_path(File.dirname(__FILE__) + '/jetty/solr'),
+    :fedora_home  => File.expand_path(File.dirname(__FILE__) + '/jetty/fedora/default'),
     :startup_wait => 90,
-    :java_opts => ['-Xmx256m', '-XX:MaxPermSize=128m']
+    :java_opts    => ['-Xmx256m', '-XX:MaxPermSize=128m']
   }
 
   error = Jettywrapper.wrap(jetty_params) do
@@ -60,14 +61,10 @@ task :ci => 'jetty:clean' do
   raise "test failures: #{error}" if error
 end
 
-
-desc "Execute specs with coverage"
-task :coverage do 
+desc 'Execute specs with coverage'
+task :coverage do
   # Put spec opts in a file named .rspec in root
-  ruby_engine = defined?(RUBY_ENGINE) ? RUBY_ENGINE : "ruby"
+  ruby_engine = defined?(RUBY_ENGINE) ? RUBY_ENGINE : 'ruby'
   ENV['COVERAGE'] = 'true' unless ruby_engine == 'jruby'
-
-
   Rake::Task['spec'].invoke
 end
-

data/VERSION

@@ -1 +1 @@
-1.8.1
+1.9.0

data/lib/rubydora.rb

@@ -23,9 +23,6 @@ module Rubydora
   require 'time'
   require 'hooks'
 
-  if CSV.const_defined? :Reader
-    require 'fastercsv'
-  end
   require 'restclient'
   require 'nokogiri'
 
@@ -35,7 +32,7 @@ module Rubydora
   class << self
     # Connect to Fedora Repository
     # @return Rubydora::Repository
-    def connect *args
+    def connect(*args)
       Repository.new *args
     end
 
@@ -48,7 +45,7 @@ module Rubydora
     # Set the default Fedora Repository
     # @param [Rubydora::Repository] repository
     # @return Rubydora::Repository
-    def repository= repository
+    def repository=(repository)
       @repository = repository
     end
 
@@ -64,6 +61,6 @@ module Rubydora
 
   class FedoraInvalidRequest < RubydoraError; end
 
-  class RecordNotFound < RubydoraError; end 
+  class RecordNotFound < RubydoraError; end
 
 end

data/lib/rubydora/array_with_callback.rb

@@ -1,11 +1,11 @@
 module Rubydora
   ##
-  # This is an attempt to implement an Array-like 
-  # object that calls a method after data is modified  
+  # This is an attempt to implement an Array-like
+  # object that calls a method after data is modified
   class ArrayWithCallback < Array
     ##
     # FIXME: It would be nice to use Rubydora::Callbacks here,
-    # however, this method requires instance-level callbacks 
+    # however, this method requires instance-level callbacks
 
     [:<<, :collect!, :map!, :compact!, :concat, :delete, :delete_at, :delete_if, :pop, :push, :reject!, :replace, :select!, :[]=, :slice!, :uniq! ].each do |method|
       class_eval <<-RUBY
@@ -25,7 +25,7 @@ module Rubydora
     end
 
     # duck-typing Rubydora::Callbacks call_* methods
-    def call_on_change changes = {}
+    def call_on_change(changes = {})
       self.on_change.each do |h|
         h.call(self, changes)
       end

data/lib/rubydora/audit_trail.rb

@@ -5,19 +5,19 @@ module Rubydora::AuditTrail
   end
 
   private
-    
+
   AT_NS = {'audit' => 'info:fedora/fedora-system:def/audit#'}
   FOXML_NS = {'foxml' => 'info:fedora/fedora-system:def/foxml#'}
   AT_XPATH = '/foxml:digitalObject/foxml:datastream[@ID = "AUDIT"]/descendant::audit:auditTrail'
-    
+
   class FedoraAuditTrail
     def initialize(object_xml)
-      @ng_xml = Nokogiri::XML(object_xml).xpath(AT_XPATH, FOXML_NS.merge(AT_NS))  
+      @ng_xml = Nokogiri::XML(object_xml).xpath(AT_XPATH, FOXML_NS.merge(AT_NS))
     end
     def records
-      if !@records
+      unless @records
         @records = []
-        @ng_xml.xpath('.//audit:record', AT_NS).each do |node| 
+        @ng_xml.xpath('.//audit:record', AT_NS).each do |node|
           @records << FedoraAuditRecord.new(node)
         end
       end
@@ -27,7 +27,7 @@ module Rubydora::AuditTrail
       @ng_xml.to_xml
     end
   end
-  
+
   class FedoraAuditRecord
     def initialize(node)
       @record = node
@@ -53,6 +53,6 @@ module Rubydora::AuditTrail
     def justification
       @record.at_xpath('audit:justification', AT_NS).text
     end
-  end    
+  end
 
 end

data/lib/rubydora/callbacks.rb

@@ -1,10 +1,10 @@
 module Rubydora
 
-# Provides class level methods for handling
-# callback methods that alter object instances
+  # Provides class level methods for handling
+  # callback methods that alter object instances
   module Callbacks
     # add callback framework to base class
-    # @param [Class] base 
+    # @param [Class] base
     def self.included(base)
       base.extend ExtendableClassMethods
     end
@@ -19,10 +19,10 @@ module Rubydora
 
       # register callback procs
       # @param [Array<Symbol>] hook name
-      def register_callback *attrs
-        attrs.each do |method_name|  
+      def register_callback(*attrs)
+        attrs.each do |method_name|
           next if methods.include? method_name.to_s
-          instance_eval %Q{
+          instance_eval "
             def #{method_name}(&blk)
               self.hooks[:#{method_name}] ||= []
               self.hooks[:#{method_name}] << blk
@@ -31,9 +31,9 @@ module Rubydora
             def clear_#{method_name}_blocks!
               self.hooks[:#{method_name}] = []
             end
-          }
+          "
 
-          class_eval %Q{
+          class_eval "
             def call_#{method_name}
               self.class.hooks[:#{method_name}] ||= []
               self.class.hooks[:#{method_name}].each do |h|
@@ -41,7 +41,7 @@ module Rubydora
               end
             end
 
-          }
+          "
         end
       end
     end

data/lib/rubydora/datastream.rb

@@ -2,7 +2,7 @@ require 'equivalent-xml'
 module Rubydora
   # This class represents a Fedora datastream object
   # and provides helper methods for creating and manipulating
-  # them. 
+  # them.
   class Datastream
     extend ActiveModel::Callbacks
     define_model_callbacks :save, :create, :destroy
@@ -21,42 +21,41 @@ module Rubydora
 
     define_attribute_methods DS_ATTRIBUTES.keys
 
-    # accessors for datastream attributes 
+    # accessors for datastream attributes
     DS_ATTRIBUTES.each do |attribute, profile_name|
       define_method attribute.to_s do
         var = "@#{attribute.to_s}".to_sym
         if instance_variable_defined?(var)
           instance_variable_get var
         elsif profile.has_key? profile_name.to_s
-           profile[profile_name.to_s]
+          profile[profile_name.to_s]
         else
           default_attributes[attribute.to_sym]
         end
       end
 
-      class_eval %Q{
+      class_eval "
       def #{attribute.to_s}= val
         validate_#{attribute.to_s}!(val) if respond_to?(:validate_#{attribute.to_s}!, true)
         #{attribute.to_s}_will_change! unless val == #{attribute.to_s}
         @#{attribute.to_s} = val
       end
-      }
+      "
     end
 
     DS_READONLY_ATTRIBUTES = [ :dsCreateDate , :dsSize, :dsVersionID ]
     DS_READONLY_ATTRIBUTES.each do |attribute|
-      class_eval %Q{
+      class_eval "
       def #{attribute.to_s}
         @#{attribute} || profile['#{attribute.to_s}'] || default_attributes[:#{attribute}]
       end
-      }
+      "
 
       def dsChecksumValid
         profile(:validateChecksum=>true)['dsChecksumValid']
       end
     end
 
-
     # Create humanized accessors for the DS attribute  (dsState -> state, dsCreateDate -> createDate)
     (DS_ATTRIBUTES.keys + DS_READONLY_ATTRIBUTES).select { |k| k.to_s =~ /^ds/ }.each do |attribute|
       simple_attribute = attribute.to_s.sub(/^ds/, '')
@@ -69,13 +68,12 @@ module Rubydora
       end
     end
 
-
-    def asOfDateTime asOfDateTime = nil
-      if asOfDateTime == nil
+    def asOfDateTime(asOfDateTime = nil)
+      if asOfDateTime.nil?
         return @asOfDateTime
       end
 
-      return self.class.new(@digital_object, dsid, @options.merge(:asOfDateTime => asOfDateTime))
+      self.class.new(@digital_object, dsid, @options.merge(:asOfDateTime => asOfDateTime))
     end
 
     def self.default_attributes
@@ -86,7 +84,7 @@ module Rubydora
       @default_attributes ||= self.class.default_attributes
     end
 
-    def default_attributes= attributes
+    def default_attributes=(attributes)
       @default_attributes = default_attributes.merge attributes
     end
 
@@ -95,11 +93,11 @@ module Rubydora
     # may not already exist in the datastore.
     #
     # Provides `after_initialize` callback for extensions
-    # 
+    #
     # @param [Rubydora::DigitalObject]
     # @param [String] Datastream ID
     # @param [Hash] default attribute values (used esp. for creating new datastreams)
-    def initialize digital_object, dsid, options = {}, default_instance_attributes = {}
+    def initialize(digital_object, dsid, options = {}, default_instance_attributes = {})
       run_callbacks :initialize do
         @digital_object = digital_object
         @dsid = dsid
@@ -119,7 +117,10 @@ module Rubydora
     # Does this datastream already exist?
     # @return [Boolean]
     def new?
-      digital_object.nil? || digital_object.new_record? || profile.empty?
+      digital_object.nil? ||
+        (digital_object.respond_to?(:new_record?) && digital_object.new_record?) ||
+        (digital_object.respond_to?(:new?) && digital_object.new?) ||
+        profile.empty?
     end
 
     # This method is overridden in ActiveFedora, so we didn't
@@ -131,7 +132,7 @@ module Rubydora
     # @param [Boolean] ensure_fetch <true> if true, it will grab the content from the repository if is not already loaded
     # @return [String]
     def local_or_remote_content(ensure_fetch = true)
-      return @content if new? 
+      return @content if new?
 
       @content ||= ensure_fetch ? datastream_content : @datastream_content
 
@@ -169,16 +170,17 @@ module Rubydora
     end
 
     # Set the content of the datastream
-    # @param [String or IO] 
+    # @param [String or IO]
     # @return [String or IO]
-    def content= new_content
+    def content=(new_content)
       raise "Can't change values on older versions" if @asOfDateTime
-       @content = new_content
+      @content = new_content
     end
 
     def content_changed?
       return false if ['E','R'].include? controlGroup
-      return true if new? and !local_or_remote_content(false).blank? # new datastreams must have content
+      return false unless content_loaded?
+      return true if new? && !local_or_remote_content(false).blank? # new datastreams must have content
 
       if controlGroup == "X"
         if self.eager_load_datastream_content
@@ -208,12 +210,16 @@ module Rubydora
       return dsLocation.present? if ['E','R'].include? controlGroup
 
       # type M has content if dsLocation is not empty
-      return true if controlGroup == 'M' and dsLocation.present?
+      return true if controlGroup == 'M' && dsLocation.present?
 
       # if we've set content, then we have content
       behaves_like_io?(@content) || content.present?
     end
 
+    def content_loaded?
+      !@content.nil?
+    end
+
     def empty?
       !has_content?
     end
@@ -222,9 +228,9 @@ module Rubydora
     # it doesn't require holding the entire content in memory. If you specify the from and length
     # parameters it simulates a range request. Unfortunatly Fedora 3 doesn't have range requests,
     # so this method needs to download the whole thing and just seek to the part you care about.
-    # 
-    # @param [Integer] from (bytes) the starting point you want to return. 
-    # 
+    #
+    # @param [Integer] from (bytes) the starting point you want to return.
+    #
     def stream (from = 0, length = nil)
       counter = 0
       Enumerator.new do |blk|
@@ -246,7 +252,7 @@ module Rubydora
                 # At the end of what we beginning of what we need. Write the end of what was read.
                 offset = from - last_counter
                 blk << chunk[offset..-1]
-              else 
+              else
                 # In the middle. We need all of this
                 blk << chunk
               end
@@ -259,18 +265,18 @@ module Rubydora
     # Retrieve the datastream profile as a hash (and cache it)
     # @param opts [Hash] :validateChecksum if you want fedora to validate the checksum
     # @return [Hash] see Fedora #getDatastream documentation for keys
-    def profile opts= {}
+    def profile(opts= {})
       if @profile && !(opts[:validateChecksum] && !@profile.has_key?('dsChecksumValid'))
         ## Force a recheck of the profile if they've passed :validateChecksum and we don't have dsChecksumValid
         return @profile
       end
-      
+
       return @profile = {} unless digital_object.respond_to? :repository
-      
+
       @profile = repository.datastream_profile(pid, dsid, opts[:validateChecksum], asOfDateTime)
     end
 
-    def profile= profile_hash
+    def profile=(profile_hash)
       raise ArgumentError, "Must pass a profile, you passed #{profile_hash.class}" unless profile_hash.kind_of? Hash
       @profile = profile_hash
     end
@@ -285,7 +291,7 @@ module Rubydora
     def current_version?
       return true if new?
       vers = versions
-      return vers.empty? || dsVersionID == vers.first.dsVersionID
+      vers.empty? || dsVersionID == vers.first.dsVersionID
     end
 
     # Add datastream to Fedora
@@ -307,7 +313,7 @@ module Rubydora
       run_callbacks :save do
         raise RubydoraError.new("Unable to save #{self.inspect} without content") unless has_content?
         if new?
-          create 
+          create
         else
           p = repository.modify_datastream(to_api_params.merge({ :pid => pid, :dsid => dsid })) || {}
           reset_profile_attributes
@@ -353,15 +359,13 @@ module Rubydora
       controlGroup == 'X'
     end
 
-    
-
     protected
-    # datastream parameters 
+    # datastream parameters
     # @return [Hash]
     def to_api_params
       h = default_api_params
       valid_changed_attributes = changes.keys.map { |x| x.to_sym }.select { |x| DS_ATTRIBUTES.key? x }
-      valid_changed_attributes += [:content] if content_changed? and !valid_changed_attributes.include? :content
+      valid_changed_attributes += [:content] if content_changed? && !valid_changed_attributes.include?(:content)
       ## if we don't provide a mimeType, application/octet-stream will be used instead
       (valid_changed_attributes | [:mimeType]).each do |attribute|
         h[attribute.to_sym] = send(attribute) unless send(attribute).nil?
@@ -392,7 +396,7 @@ module Rubydora
       digital_object.repository
     end
 
-    def asOfDateTime= val
+    def asOfDateTime=(val)
       @asOfDateTime = val
     end
 
@@ -400,7 +404,7 @@ module Rubydora
       raise "Can't change values on older versions" if @asOfDateTime
     end
 
-    def validate_dsLocation! val
+    def validate_dsLocation!(val)
       URI.parse(val) unless val.nil?
     end
 
@@ -411,7 +415,7 @@ module Rubydora
       obj.is_a?(IO) || (defined?(Rack) && obj.is_a?(Rack::Test::UploadedFile))
     end
 
-    def attribute_will_change! *args
+    def attribute_will_change!(*args)
       check_if_read_only
       super
     end