rubydora 0.0.2

data/Gemfile

@@ -0,0 +1,25 @@
+source "http://rubygems.org"
+
+gem "fastercsv"
+gem "rest-client"
+gem "nokogiri"
+gem "mime-types"
+
+group :soap do
+  gem "soap4r"
+end
+
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+  gem "rspec"
+  gem "yard"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Chris Beer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,77 @@
+= 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
+
+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

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rubydora"
+  gem.homepage = "http://github.com/cbeer/rubydora"
+  gem.license = "MIT"
+  gem.summary = %Q{Fedora Commons REST API ruby library}
+  gem.description = %Q{Fedora Commons REST API ruby library : REQUIRES FCREPO 3.4+}
+  gem.email = "chris@cbeer.info"
+  gem.authors = ["Chris Beer"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+# Get your spec rake tasks working in RSpec 2.0
+
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end
+
+desc "Generate code coverage"
+require "rcov/rcovtask"
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec', '--exclude', 'gems/*']
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rubydora #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/rubydora/array_with_callback.rb

@@ -0,0 +1,34 @@
+module Rubydora
+  ##
+  # 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 
+
+    [:<<, :collect!, :map!, :compact!, :concat, :delete, :delete_at, :delete_if, :pop, :push, :reject!, :replace, :select!, :[]=, :slice!, :uniq! ].each do |method|
+      class_eval <<-RUBY
+        def #{method.to_s} *args, &blk
+          old = self.dup
+          res = super(*args, &blk)
+          call_on_change({:+ => self - old, :- => old - self})
+          res
+        end
+      RUBY
+    end
+
+    # duck-typing Rubydora::Callbacks @hooks and accessor
+    def on_change
+      @hooks ||= {}
+      @hooks[:on_change] ||= []
+    end
+
+    # duck-typing Rubydora::Callbacks call_* methods
+    def call_on_change changes = {}
+      self.on_change.each do |h|
+        h.call(self, changes)
+      end
+    end
+  end
+end

data/lib/rubydora/callbacks.rb

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

data/lib/rubydora/datastream.rb

@@ -0,0 +1,152 @@
+module Rubydora
+  # This class represents a Fedora datastream object
+  # and provides helper methods for creating and manipulating
+  # them. 
+  class Datastream
+    include Rubydora::Callbacks
+    register_callback :after_initialize
+    include Rubydora::ExtensionParameters
+
+    attr_reader :digital_object, :dsid
+
+    # mapping datastream attributes (and api parameters) to datastream profile names
+    DS_ATTRIBUTES = {:controlGroup => :dsControlGroup, :dsLocation => :dsLocation, :altIDs => nil, :dsLabel => :dsLabel, :versionable => :dsVersionable, :dsState => :dsState, :formatURI => :dsFormatURI, :checksumType => :dsChecksumType, :checksum => :dsChecksum, :mimeType => :dsMIME, :logMessage => nil, :ignoreContent => nil, :lastModifiedDate => nil, :file => nil}
+    
+    # accessors for datastream attributes 
+    DS_ATTRIBUTES.each do |attribute, profile_name|
+      class_eval %Q{
+        def #{attribute.to_s}
+          @#{attribute.to_s} || profile['#{profile_name.to_s}']
+        end
+
+        attr_writer :#{attribute.to_s}
+      }
+    end
+
+    ##
+    # Initialize a Rubydora::Datastream object, which may or
+    # 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 = {}
+      @digital_object = digital_object
+      @dsid = dsid
+      options.each do |key, value|
+        self.send(:"#{key}=", value)
+      end
+
+      call_after_initialize
+    end
+
+    # Does this datastream already exist?
+    # @return [Boolean]
+    def new?
+      profile.nil?
+    end
+
+    # Retrieve the content of the datastream (and cache it)
+    # @return [String]
+    def content
+      @content ||= repository.datastream_dissemination :pid => digital_object.pid, :dsid => dsid
+    end
+    alias_method :read, :content
+
+    def content= content
+       @file = content
+       @content = content.dup
+       @content &&= @content.read if @content.respond_to? :read
+       @content &&= @content.to_s if @content.respond_to? :read
+    end
+
+    # Retrieve the datastream profile as a hash (and cache it)
+    # @return [Hash] see Fedora #getDatastream documentation for keys
+    def profile
+      @profile ||= begin
+        profile_xml = repository.datastream(:pid => digital_object.pid, :dsid => dsid)
+        profile_xml.gsub! '<datastreamProfile', '<datastreamProfile xmlns="http://www.fedora.info/definitions/1/0/access/"' unless profile_xml =~ /xmlns=/
+        doc = Nokogiri::XML(profile_xml)
+        h = doc.xpath('/access:datastreamProfile/*', {'access' => "http://www.fedora.info/definitions/1/0/access/"} ).inject({}) do |sum, node|
+                     sum[node.name] ||= []
+                     sum[node.name] << node.text
+                     sum
+                   end
+        h.select { |key, value| value.length == 1 }.each do |key, value|
+          h[key] = value.first
+        end
+
+        h
+      rescue
+         nil
+      end
+    end
+
+    # Has this datastream been modified, but not yet saved?
+    # @return [Boolean]
+    def dirty?
+      DS_ATTRIBUTES.any? { |attribute, profile_name| instance_variable_defined?("@#{attribute.to_s}") } || new?
+    end
+
+    # Add datastream to Fedora
+    # @return [Rubydora::Datastream]
+    def create
+      repository.add_datastream to_api_params.merge({ :pid => digital_object.pid, :dsid => dsid })
+      reset_profile_attributes
+      Datastream.new(digital_object, dsid)
+    end
+
+    # Modify or save the datastream
+    # @return [Rubydora::Datastream]
+    def save
+      return create if new?
+      repository.modify_datastream to_api_params.merge({ :pid => digital_object.pid, :dsid => dsid })
+      reset_profile_attributes
+      Datastream.new(digital_object, dsid)
+    end
+
+    # Purge the datastream from Fedora
+    # @return [Rubydora::Datastream] `self`
+    def delete
+      repository.purge_datastream(:pid => digital_object.pid, :dsid => dsid) unless self.new?
+      digital_object.datastreams.delete(dsid)
+      reset_profile_attributes
+      self
+    end
+
+    protected
+    # datastream parameters 
+    # @return [Hash]
+    def to_api_params
+      h = default_api_params
+      DS_ATTRIBUTES.each do |attribute, profile_name|
+        h[attribute] = instance_variable_get("@#{attribute.to_s}") if instance_variable_defined?("@#{attribute.to_s}")
+      end
+
+      h
+    end
+
+    # default datastream parameters
+    # @return [Hash]
+    def default_api_params
+      { :controlGroup => 'M', :dsState => 'A', :checksumType => 'DISABLED', :versionable => true}
+    end
+
+    # reset all profile attributes
+    # @return [Hash]
+    def reset_profile_attributes
+      @profile = nil
+      DS_ATTRIBUTES.each do |attribute, profile_name|
+        instance_variable_set("@#{attribute.to_s}", nil) if instance_variable_defined?("@#{attribute.to_s}")
+      end
+    end
+
+    # repository reference from the digital object
+    # @return [Rubydora::Repository]
+    def repository
+      digital_object.repository
+    end
+  end
+end

data/lib/rubydora/digital_object.rb

@@ -0,0 +1,190 @@
+module Rubydora
+
+  # This class represents a Fedora object and provides
+  # helpers for managing attributes, datastreams, and
+  # relationships. 
+  #
+  # Using the extension framework, implementors may 
+  # provide additional functionality to this base 
+  # implementation.
+  class DigitalObject
+    include Rubydora::Callbacks
+    register_callback :after_initialize
+    include Rubydora::ExtensionParameters
+    include Rubydora::ModelsMixin
+    include Rubydora::RelationshipsMixin
+
+
+    attr_reader :pid
+    
+    # mapping object parameters to profile elements
+    OBJ_ATTRIBUTES = {:state => :objState, :ownerId => :objOwnerId, :label => :objLabel, :logMessage => nil, :lastModifiedDate => :objLastModDate }
+      
+    OBJ_ATTRIBUTES.each do |attribute, profile_name|
+      class_eval <<-RUBY
+      def #{attribute.to_s}
+        @#{attribute.to_s} || profile['#{profile_name.to_s}']
+      end
+                     
+      attr_writer :#{attribute.to_s}
+
+      RUBY
+    end
+
+    # find an existing fedora object
+    # TODO: raise an error if the object does not yet exist
+    # @param [String] pid
+    # @param [Rubydora::Repository] context
+    def self.find pid, repository = nil
+      DigitalObject.new pid, repository
+    end
+
+    # create a new fedora object (see also DigitalObject#save)
+    # @param [String] pid
+    # @param [Hash] options
+    # @param [Rubydora::Repository] context
+    def self.create pid, options = {}, repository = nil
+      repository ||= Rubydora.repository
+      repository.ingest(options.merge(:pid => pid))
+      DigitalObject.new pid, repository
+    end
+
+    ##
+    # Initialize a Rubydora::DigitalObject, which may or
+    # may not already exist in the data store.
+    #
+    # Provides `after_initialize` callback for extensions
+    # 
+    # @param [String] pid
+    # @param [Rubydora::Repository] repository context
+    # @param [Hash] options default attribute values (used esp. for creating new datastreams
+    def initialize pid, repository = nil, options = {}
+      @pid = pid
+      @repository = repository
+
+      options.each do |key, value|
+        self.send(:"#{key}=", value)
+      end
+
+      call_after_initialize
+    end
+
+    ##
+    # Return a full uri pid (for use in relations, etc
+    def uri
+      return pid if pid =~ /.+\/.+/
+      "info:fedora/#{pid}"
+    end
+    alias_method :fqpid, :uri
+
+    # Does this object already exist?
+    # @return [Boolean]
+    def new?
+      self.profile.nil?
+    end
+
+    # Retrieve the object profile as a hash (and cache it)
+    # @return [Hash] see Fedora #getObject documentation for keys
+    def profile
+      @profile ||= begin
+        profile_xml = repository.object(:pid => pid)
+        profile_xml.gsub! '<objectProfile', '<objectProfile xmlns="http://www.fedora.info/definitions/1/0/access/"' unless profile_xml =~ /xmlns=/
+        doc = Nokogiri::XML(profile_xml)
+        h = doc.xpath('/access:objectProfile/*', {'access' => "http://www.fedora.info/definitions/1/0/access/"} ).inject({}) do |sum, node|
+                     sum[node.name] ||= []
+                     sum[node.name] << node.text
+
+                     if node.name == "objModels"
+                       sum[node.name] = node.xpath('access:model', {'access' => "http://www.fedora.info/definitions/1/0/access/"}).map { |x| x.text }
+                     end
+
+                     sum
+                   end
+        h.select { |key, value| value.length == 1 }.each do |key, value|
+          next if key == "objModels"
+          h[key] = value.first
+        end
+
+        h
+      rescue  
+        nil
+      end
+    end
+
+    # List of datastreams
+    # @return [Array<Rubydora::Datastream>] 
+    def datastreams
+      @datastreams ||= begin
+        h = Hash.new { |h,k| h[k] = Datastream.new self, k }                
+        datastreams_xml = repository.datastreams(:pid => pid)
+        datastreams_xml.gsub! '<objectDatastreams', '<objectDatastreams xmlns="http://www.fedora.info/definitions/1/0/access/"' unless datastreams_xml =~ /xmlns=/
+        doc = Nokogiri::XML(datastreams_xml)
+        doc.xpath('//access:datastream', {'access' => "http://www.fedora.info/definitions/1/0/access/"}).each { |ds| h[ds['dsid']] = Datastream.new self, ds['dsid'] }
+        h
+      rescue RestClient::ResourceNotFound
+        h = Hash.new { |h,k| h[k] = Datastream.new self, k }                
+      end
+    end
+
+    # persist the object to Fedora, either as a new object 
+    # by modifing the existing object
+    #
+    # also will save all `:dirty?` datastreams that already exist 
+    # new datastreams must be directly saved
+    # 
+    # @return [Rubydora::DigitalObject] a new copy of this object
+    def save
+      if self.new?
+        repository.ingest to_api_params.merge(:pid => pid)
+      else                       
+        p = to_api_params
+        repository.modify_object p.merge(:pid => pid) unless p.empty?
+      end
+
+      self.datastreams.select { |dsid, ds| ds.dirty? }.reject {|dsid, ds| ds.new? }.each { |dsid, ds| ds.save }
+      DigitalObject.new(pid, repository)
+    end
+
+    # Purge the object from Fedora
+    # @return [Rubydora::DigitalObject] `self`
+    def delete
+      repository.purge_object(:pid => pid)
+      reset_profile_attributes
+      self
+    end
+
+    # repository reference from the digital object
+    # @return [Rubydora::Repository]
+    def repository
+      @repository ||= Rubydora.repository
+    end
+
+    protected
+    # datastream parameters 
+    # @return [Hash]
+    def to_api_params
+      h = default_api_params
+      OBJ_ATTRIBUTES.each do |attribute, profile_name|
+        h[attribute] = instance_variable_get("@#{attribute.to_s}") if instance_variable_defined?("@#{attribute.to_s}")
+      end
+
+      h
+    end
+
+    # default datastream parameters
+    # @return [Hash]
+    def default_api_params
+      { }
+    end
+
+    # reset all profile attributes
+    # @return [Hash]
+    def reset_profile_attributes
+      @profile = nil
+      OBJ_ATTRIBUTES.each do |attribute, profile_name|
+        instance_variable_set("@#{attribute.to_s}", nil) if instance_variable_defined?("@#{attribute.to_s}")
+      end
+    end
+
+  end
+end