rubydora 0.5.10 → 0.5.11

data/History.textile

@@ -1,3 +1,23 @@
+h3. 0.5.11
+* Ensure that the base rest resource is insulated from blocks passed to dissemination and datastream_dissemination.
+* Deprecated a behavior for DigitalObject.find that allowed one to call DigitalObject.find for a non-existent object. This will raise an exception in a future rubydora release. Instead, you should use the new DigitalObject.find_or_initialize for that behavior.
+* Use ActiveSupport::Rescuable for the REST API calls.
+* Implement a basic form of "transactions" in Rubydora, intended to be used during testing. It uses the new REST API hooks and knows how to roll-back the different data-changing operations. In some cases, this involves deleting and re-ingesting the previous version of the object (purge, modify datastream, purge datastream), which make it unsuitable for production use, especially with large content datastreams.
+
+At Stanford, we've hooked it into our rspec tests as an around filter:
+bc. RSpec.configure do |config|
+  …
+  config.around(:each) do |example|
+    ActiveFedora::Base.connection_for_pid(0).transaction do |t|
+      example.call
+      t.rollback
+    end
+  end
+end
+
+h3. 0.5.10
+* Support for content_changed? and content_will_change!
+
 h3. 0.5.9
 * Raise exception if it's not 404
 

data/VERSION

@@ -1 +1 @@
-0.5.10
+0.5.11

data/lib/rubydora/digital_object.rb

@@ -16,6 +16,10 @@ module Rubydora
     include Rubydora::ModelsMixin
     include Rubydora::RelationshipsMixin
 
+    extend Deprecation
+
+    self.deprecation_horizon = 'rubydora 0.6'
+
 
     attr_reader :pid
     
@@ -44,7 +48,23 @@ module Rubydora
     # @param [String] pid
     # @param [Rubydora::Repository] context
     def self.find pid, repository = nil, options = {}
-      self.new pid, repository, options
+      obj = self.new pid, repository, options
+      if obj.new?
+        Deprecation.warn(Rubydora::DigitalObject, "DigitalObject.find called 
+          for an object that doesn't exist. In #{Rubydora::DigitalObject.deprecation_horizon},
+          this behavior will raise an exception. Use
+          DigitalObject.new or DigitalObject.find_or_initialize instead.")
+      end
+
+      obj
+    end
+
+    # find or initialize a Fedora object
+    # @param [String] pid
+    # @param [Rubydora::Repository] repository context
+    # @param [Hash] options default attribute values (used esp. for creating new datastreams
+    def self.find_or_initialize *args
+      self.new *args
     end
 
     # create a new fedora object (see also DigitalObject#save)
@@ -258,10 +278,6 @@ module Rubydora
       raise "Can't change values on older versions" if @asOfDateTime
     end
 
-    def check_if_read_only
-      raise "Can't change values on older versions" if @asOfDateTime
-    end
-
     private
     def attribute_will_change! *args
       check_if_read_only

data/lib/rubydora/rest_api_client.rb

@@ -1,4 +1,7 @@
 require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/class'
+require 'active_support/core_ext/module'
+require 'hooks'
 
 module Rubydora
 
@@ -6,17 +9,42 @@ module Rubydora
   module RestApiClient
     
     include Rubydora::FedoraUrlHelpers
+    extend ActiveSupport::Concern
     include ActiveSupport::Benchmarkable
 
+
     VALID_CLIENT_OPTIONS = [:user, :password, :timeout, :open_timeout, :ssl_client_cert, :ssl_client_key]
+
+    included do
+      include ActiveSupport::Rescuable
+
+
+      rescue_from RestClient::InternalServerError do |e|
+        logger.error e.response
+        logger.flush if logger.respond_to? :flush
+        raise FedoraInvalidRequest, "See logger for details"
+      end
+
+      rescue_from Errno::ECONNREFUSED, Errno::EHOSTUNREACH do |exception|
+        logger.error "Unable to connect to Fedora at #{@client.url}"
+        raise exception
+      end
+
+      include Hooks
+      [:ingest, :modify_object, :purge_object, :set_datastream_options, :add_datastream, :modify_datastream, :purge_datastream, :add_relationship, :purge_relationship].each do |h|
+        define_hook "before_#{h}"
+      end
+
+      define_hook "after_ingest"
+      include Transactions
+    end
+
     # Create an authorized HTTP client for the Fedora REST API
     # @param [Hash] config
     # @option config [String] :url
     # @option config [String] :user
     # @option config [String] :password
     # @return [RestClient::Resource]
-
-
     #TODO trap for these errors specifically: RestClient::Request::Unauthorized, Errno::ECONNREFUSED
     def client config = {}
       client_config = self.config.merge(config)
@@ -37,13 +65,9 @@ module Rubydora
     # @return [String]
     def next_pid options = {}
       options[:format] ||= 'xml'
-      begin
-        return client[next_pid_url(options)].post nil
-      rescue RestClient::InternalServerError => e
-        logger.error e.response
-        logger.flush if logger.respond_to? :flush
-        raise FedoraInvalidRequest, "Error getting nextPID. See logger for details"
-      end
+      client[next_pid_url(options)].post nil
+    rescue Exception => exception
+      rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
@@ -53,17 +77,13 @@ module Rubydora
       raise ArgumentError,"Cannot have both :terms and :query parameters" if options[:terms] and options[:query]
       options[:resultFormat] ||= 'xml'
 
-      begin
-        resource = client[find_objects_url(options)]
-        if block_given?
-          resource.options[:block_response] = block_response
-        end 
-        return resource.get
-      rescue RestClient::InternalServerError => e
-        logger.error e.response
-        logger.flush if logger.respond_to? :flush
-        raise FedoraInvalidRequest, "Error finding objects. See logger for details"
-      end
+      resource = client[find_objects_url(options)]
+      if block_given?
+        resource.options[:block_response] = block_response
+      end 
+      return resource.get
+    rescue Exception => exception
+      rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
@@ -73,15 +93,9 @@ module Rubydora
     def object options = {}
       pid = options.delete(:pid)
       options[:format] ||= 'xml'
-      begin
-        return client[object_url(pid, options)].get
-      rescue RestClient::ResourceNotFound => e
-        raise e
-      rescue RestClient::InternalServerError => e
-        logger.error e.response
-        logger.flush if logger.respond_to? :flush
-        raise FedoraInvalidRequest, "Error getting object #{pid}. See logger for details"
-      end
+      client[object_url(pid, options)].get
+    rescue Exception => exception
+        rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
@@ -91,16 +105,11 @@ module Rubydora
     def ingest options = {}
       pid = options.delete(:pid) || 'new'
       file = options.delete(:file)
-      begin
-        return client[object_url(pid, options)].post file, :content_type => 'text/xml'
-      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 FedoraInvalidRequest, "Error ingesting object #{pid}. See logger for details"
-      end
+      assigned_pid = client[object_url(pid, options)].post file, :content_type => 'text/xml'
+      run_hook :after_ingest, :pid => assigned_pid, :file => file, :options => options
+      assigned_pid
+    rescue Exception => exception
+        rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
@@ -109,12 +118,9 @@ module Rubydora
     # @return [String]
     def export options = {}
       pid = options.delete(:pid)
-      begin
-        return client[export_object_url(pid, options)].get
-      rescue RestClient::InternalServerError => e
-        logger.error e.response
-        raise FedoraInvalidRequest, "Error exporting object #{pid}. See logger for details"
-      end
+      client[export_object_url(pid, options)].get
+    rescue Exception => exception
+        rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
@@ -123,13 +129,10 @@ module Rubydora
     # @return [String]
     def modify_object options = {}
       pid = options.delete(:pid)
-      begin
-        return client[object_url(pid, options)].put nil
-      rescue RestClient::InternalServerError => e
-        logger.error e.response
-        logger.flush if logger.respond_to? :flush
-        raise FedoraInvalidRequest, "Error modifying object #{pid}. See logger for details"
-      end
+      run_hook :before_modify_object, :pid => pid, :options => options
+      client[object_url(pid, options)].put nil
+    rescue Exception => exception
+        rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
@@ -138,15 +141,10 @@ module Rubydora
     # @return [String]
     def purge_object options = {}
       pid = options.delete(:pid)
-      begin
-        return client[object_url(pid, options)].delete
-      rescue RestClient::ResourceNotFound => e
-        raise e
-      rescue RestClient::InternalServerError => e
-        logger.error e.response
-        logger.flush if logger.respond_to? :flush
-        raise FedoraInvalidRequest, "Error purging object #{pid}. See logger for details"
-      end
+      run_hook :before_purge_object, :pid => pid, :options => options
+      client[object_url(pid, options)].delete
+    rescue Exception => exception
+        rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
@@ -157,13 +155,9 @@ module Rubydora
       pid = options.delete(:pid)
       options[:format] ||= 'xml'
       raise ArgumentError, "Must have a pid" unless pid
-      begin
-        return client[object_versions_url(pid, options)].get
-      rescue RestClient::InternalServerError => e
-        logger.error e.response
-        logger.flush if logger.respond_to? :flush
-        raise FedoraInvalidRequest, "Error getting versions for object #{pid}. See logger for details"
-      end
+      client[object_versions_url(pid, options)].get
+    rescue Exception => exception
+        rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
@@ -174,13 +168,9 @@ module Rubydora
       pid = options.delete(:pid)
       raise ArgumentError, "Missing required parameter :pid" unless pid
       options[:format] ||= 'xml'
-      begin
-        return client[object_xml_url(pid, options)].get
-      rescue RestClient::InternalServerError => e
-        logger.error e.response
-        logger.flush if logger.respond_to? :flush
-        raise FedoraInvalidRequest, "Error getting objectXML for object #{pid}. See logger for details"
-      end
+      client[object_xml_url(pid, options)].get
+    rescue Exception => exception
+        rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
@@ -194,26 +184,18 @@ module Rubydora
       pid = options.delete(:pid)
       dsid = options.delete(:dsid)
       options[:format] ||= 'xml'
-      begin
-        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 RestClient::Unauthorized => e
-        logger.error "Unauthorized at #{client.url}/#{datastream_url(pid, dsid, options)}"
-        raise e
-      rescue RestClient::InternalServerError => e
-        logger.error e.response
-        logger.flush if logger.respond_to? :flush
-        raise FedoraInvalidRequest, "Error getting datastream '#{dsid}' for object #{pid}. See logger for details"
+      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
+
+      val
+    rescue RestClient::Unauthorized => e
+      logger.error "Unauthorized at #{client.url}/#{datastream_url(pid, dsid, options)}"
+      raise e
+    rescue Exception => exception
+        rescue_with_handler(exception) || raise
     end
 
     alias_method :datastreams, :datastream
@@ -226,13 +208,10 @@ module Rubydora
     def set_datastream_options options = {}
       pid = options.delete(:pid)
       dsid = options.delete(:dsid)
-      begin
-        return client[datastream_url(pid, dsid, options)].put nil
-      rescue RestClient::InternalServerError => e
-        logger.error e.response
-        logger.flush if logger.respond_to? :flush
-        raise FedoraInvalidRequest, "Error setting datastream options on #{dsid} for object #{pid}. See logger for details"
-      end
+      run_hook :before_set_datastream_options, :pid => pid, :dsid => dsid, :options => options
+      client[datastream_url(pid, dsid, options)].put nil
+    rescue Exception => exception
+        rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
@@ -245,16 +224,12 @@ module Rubydora
       dsid = options.delete(:dsid)
       raise ArgumentError, "Must supply dsid" unless dsid
       options[:format] ||= 'xml'
-      begin
-        return client[datastream_history_url(pid, dsid, options)].get
-      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 RestClient::InternalServerError => e
-        logger.error e.response
-        logger.flush if logger.respond_to? :flush
-        raise FedoraInvalidRequest, "Error getting versions for datastream #{dsid} for object #{pid}. See logger for details"
-      end
+      client[datastream_history_url(pid, dsid, options)].get
+    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 Exception => exception
+        rescue_with_handler(exception) || raise
     end
 
     alias_method :datastream_history, :datastream_versions
@@ -270,19 +245,14 @@ module Rubydora
       method = options.delete(:method)
       method ||= :get
       raise self.class.name + "#datastream_dissemination requires a DSID" unless dsid
-      begin
+      if block_given?
+        resource = safe_subresource(datastream_content_url(pid, dsid, options), :block_response => block_response)
+      else
         resource = client[datastream_content_url(pid, dsid, options)]
-        if block_given?
-          resource.options[:block_response] = block_response
-        end
-        return resource.send(method)
-      rescue RestClient::ResourceNotFound => e
-        raise e
-      rescue RestClient::InternalServerError => e
-        logger.error e.response
-        logger.flush if logger.respond_to? :flush
-        raise FedoraInvalidRequest, "Error getting dissemination for datastream #{dsid} for object #{pid}. See logger for details"
       end
+      resource.send(method)
+    rescue Exception => exception
+        rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
@@ -295,13 +265,10 @@ module Rubydora
       dsid = options.delete(:dsid)
       file = options.delete(:content)
       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 RestClient::InternalServerError => e
-        logger.error e.response
-        logger.flush if logger.respond_to? :flush
-        raise FedoraInvalidRequest, "Error adding datastream #{dsid} for object #{pid}. See logger for details"
-      end
+      run_hook :before_add_datastream, :pid => pid, :dsid => dsid, :file => file, :options => options
+      client[datastream_url(pid, dsid, options)].post file, :content_type => content_type.to_s, :multipart => true
+    rescue Exception => exception
+        rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
@@ -321,13 +288,11 @@ module Rubydora
         rest_client_options[:content_type] = content_type
       end
 
-      begin
-        return client[datastream_url(pid, dsid, options)].put(file, rest_client_options)
-      rescue RestClient::InternalServerError => e
-        logger.error e.response
-        logger.flush if logger.respond_to? :flush
-        raise FedoraInvalidRequest, "Error modifying datastream #{dsid} for #{pid}. See logger for details"
-      end
+      run_hook :before_modify_datastream, :pid => pid, :dsid => dsid, :file => file, :content_type => content_type, :options => options
+      client[datastream_url(pid, dsid, options)].put(file, rest_client_options)
+
+    rescue Exception => exception
+        rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
@@ -338,13 +303,10 @@ module Rubydora
     def purge_datastream options = {}
       pid = options.delete(:pid)
       dsid = options.delete(:dsid)
-      begin
-        client[datastream_url(pid, dsid, options)].delete
-      rescue RestClient::InternalServerError => e
-        logger.error e.response
-        logger.flush if logger.respond_to? :flush
-        raise FedoraInvalidRequest, "Error purging datastream #{dsid} for #{pid}. See logger for details"
-      end
+      run_hook :before_purge_datastream, :pid => pid, :dsid => dsid
+      client[datastream_url(pid, dsid, options)].delete
+    rescue Exception => exception
+        rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
@@ -355,13 +317,9 @@ module Rubydora
       pid = options.delete(:pid) || options[:subject]
       raise ArgumentError, "Missing required parameter :pid" unless pid
       options[:format] ||= 'xml'
-      begin
-        return client[object_relationship_url(pid, options)].get
-      rescue RestClient::InternalServerError => e
-        logger.error e.response
-        logger.flush if logger.respond_to? :flush
-        raise FedoraInvalidRequest, "Error getting relationships for #{pid}. See logger for details"
-      end
+      client[object_relationship_url(pid, options)].get
+    rescue Exception => exception
+        rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
@@ -370,13 +328,10 @@ module Rubydora
     # @return [String]
     def add_relationship options = {}
       pid = options.delete(:pid) || options[:subject]
-      begin
-        return client[new_object_relationship_url(pid, options)].post nil
-      rescue RestClient::InternalServerError => e
-        logger.error e.response
-        logger.flush if logger.respond_to? :flush
-        raise FedoraInvalidRequest, "Error adding relationship for #{pid}. See logger for details"
-      end
+      run_hook :before_add_relationship, :pid => pid, :options => options
+      client[new_object_relationship_url(pid, options)].post nil
+    rescue Exception => exception
+        rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
@@ -385,13 +340,10 @@ module Rubydora
     # @return [String]
     def purge_relationship options = {}
       pid = options.delete(:pid) || options[:subject]
-      begin
-        return client[object_relationship_url(pid, options)].delete
-      rescue RestClient::InternalServerError => e
-        logger.error e.response
-        logger.flush if logger.respond_to? :flush
-        raise FedoraInvalidRequest, "Error purging relationships for #{pid}. See logger for details"
-      end
+      run_hook :before_purge_relationship, :pid => pid, :options => options
+      client[object_relationship_url(pid, options)].delete
+    rescue Exception => exception
+        rescue_with_handler(exception) || raise
     end
 
     # {include:RestApiClient::API_DOCUMENTATION}
@@ -405,16 +357,26 @@ module Rubydora
       sdef = options.delete(:sdef)
       method = options.delete(:method)
       options[:format] ||= 'xml' unless pid and sdef and method
-      begin
+      if block_given?
+        resource = safe_subresource(dissemination_url(pid,sdef,method,options), :block_response => block_response)
+      else
         resource = client[dissemination_url(pid,sdef,method,options)]
-        if block_given?
-          resource.options[:block_response] = block_response
-        end
-        return resource.get
-      rescue RestClient::InternalServerError => e
-        logger.error e.response
-        logger.flush if logger.respond_to? :flush
-        raise FedoraInvalidRequest, "Error getting dissemination for #{pid}. See logger for details"
+      end
+      resource.get
+
+    rescue Exception => exception
+        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
+      block = client.block
+      if block
+        client.class.new(url, options, &block)
+      else
+        client.class.new(url, options)
       end
     end
   end

data/lib/rubydora/transactions.rb

@@ -0,0 +1,159 @@
+module Rubydora
+  # Extremely basic (and naive) 'transaction' support for Rubydora. This isn't
+  # really intended to be used in a production-like situation -- more for 
+  # rolling back (small) changes during testing.
+  module Transactions
+    extend ActiveSupport::Concern
+
+    class << self
+      attr_accessor :use_transactions
+    end
+
+    included do
+      after_ingest do |options|
+        append_to_transactions_log :ingest, options if Rubydora::Transactions.use_transactions
+      end
+
+      before_purge_object do |options|
+        append_to_transactions_log :purge_object, :pid => options[:pid], :foxml => export(:pid => options[:pid], :context => :archive) if Rubydora::Transactions.use_transactions
+      end
+
+      before_modify_datastream do |options|
+        append_to_transactions_log :modify_datastream, :pid => options[:pid], :foxml => export(:pid => options[:pid], :context => :archive) if Rubydora::Transactions.use_transactions
+      end
+
+      before_purge_datastream do |options|
+        append_to_transactions_log :purge_datastream, :pid => options[:pid], :foxml => export(:pid => options[:pid], :context => :archive) if Rubydora::Transactions.use_transactions
+      end
+
+      before_add_datastream do |options|
+        append_to_transactions_log :add_datastream, options if Rubydora::Transactions.use_transactions
+      end
+
+      before_add_relationship do |options|
+        append_to_transactions_log :add_relationship, options if Rubydora::Transactions.use_transactions
+      end
+
+      before_purge_relationship do |options|
+        append_to_transactions_log :purge_relationship, options if Rubydora::Transactions.use_transactions
+      end
+
+      before_modify_object do |options|
+        if Rubydora::Transactions.use_transactions
+          obj = find(options[:pid])
+          append_to_transactions_log :modify_object, :pid => options[:pid], :state => obj.state, :ownerId => obj.ownerId, :logMessage => 'reverting'
+        end
+      end
+
+      before_set_datastream_options do |options|
+        if Rubydora::Transactions.use_transactions
+          obj = find(options[:pid])
+          ds = obj.datastreams[options[:dsid]]
+
+          if options[:options][:versionable]
+            append_to_transactions_log :set_datastream_options, :pid => options[:pid], :dsid => options[:dsid], :versionable => ds.versionable
+          end
+
+          if options[:options][:state]
+            append_to_transactions_log :set_datastream_options, :pid => options[:pid], :dsid => options[:dsid], :state => ds.state
+          end
+        end
+      end
+
+    end
+    
+
+    # Start a transaction
+    def transaction &block
+      Transaction.new self, &block
+      self.transactions_log.clear
+    end
+
+    # Unshift a transaction entry onto the transaction logs.
+    # We want these entries in reverse-chronological order
+    # for ease of undoing..
+    def append_to_transactions_log *args
+      return unless Rubydora::Transactions.use_transactions
+      transactions_log.unshift(args)
+    end
+
+    # The repository transaction log.
+    def transactions_log
+      @log ||= []
+    end
+  end
+
+  class Transaction
+    attr_reader :repository
+    def initialize repository, &block
+      @repository = repository
+      with_transactions(&block)
+    end
+
+    def with_transactions &block
+      old_state = Rubydora::Transactions.use_transactions
+      Rubydora::Transactions.use_transactions = true
+
+      yield(self)
+
+      Rubydora::Transactions.use_transactions = old_state
+    end
+
+    def without_transactions &block
+      old_state = Rubydora::Transactions.use_transactions
+      Rubydora::Transactions.use_transactions = false
+
+      yield(self)
+
+      Rubydora::Transactions.use_transactions = old_state
+    end
+
+    # Roll-back transactions by reversing their outcomes 
+    # (or, in some cases, re-ingesting the object at the 
+    # previous state.
+    def rollback
+      without_transactions do
+      repository.transactions_log.delete_if do |(method, options)|
+
+        begin
+          case method
+            when :ingest
+              repository.purge_object :pid => options[:pid]
+
+            when :modify_object
+              repository.modify_object options
+
+            when :add_datastream
+              repository.purge_datastream :pid => options[:pid], :dsid => options[:dsid]
+
+            when :add_relationship
+              repository.purge_relationship options[:options].merge(:pid => options[:pid])
+
+            when :purge_relationship
+              repository.add_relationship options[:options].merge(:pid => options[:pid])
+
+            when :purge_object
+              repository.ingest :pid => options[:pid], :file => options[:foxml]
+
+            when :set_datastream_options
+              repository.set_datastream_options options
+
+            when :modify_datastream
+              repository.purge_object :pid => options[:pid] rescue nil
+              repository.ingest :pid => options[:pid], :file => options[:foxml]
+
+            when :purge_datastream
+              repository.purge_object :pid => options[:pid] rescue nil
+              repository.ingest :pid => options[:pid], :file => options[:foxml]
+          end
+        rescue
+          # no-op
+        end
+
+      end
+      end
+      true
+    end
+  end
+
+end

data/lib/rubydora.rb

@@ -1,5 +1,6 @@
 # Fedora Commons REST API module
 require 'active_model'
+require 'deprecation'
 
 module Rubydora
   autoload :Datastream, "rubydora/datastream"
@@ -15,6 +16,7 @@ module Rubydora
   autoload :ExtensionParameters, "rubydora/extension_parameters"
   autoload :Callbacks, "rubydora/callbacks"
   autoload :ArrayWithCallback, "rubydora/array_with_callback"
+  autoload :Transactions, "rubydora/transactions"
 
 
   require 'csv'

data/rubydora.gemspec

@@ -23,6 +23,8 @@ Gem::Specification.new do |s|
   s.add_dependency "activesupport"
   s.add_dependency "activemodel"
   s.add_dependency "savon"
+  s.add_dependency "hooks"
+  s.add_dependency "deprecation"
 
   s.add_development_dependency("rake")
   s.add_development_dependency("shoulda")

data/spec/lib/integration_test_spec.rb

@@ -15,6 +15,23 @@ describe "Integration testing against a live Fedora repository", :integration =>
     @repository.ping.should == true
   end
 
+  it "should ingest from foxml" do
+    @repository.find('changeme:n').delete rescue nil
+    pid = @repository.ingest :pid => 'changeme:n'
+
+    pid.should == 'changeme:n'
+
+    obj = @repository.find(pid)
+    obj.should_not be_new
+  end
+
+  it "should ingest from foxml" do
+    pid = @repository.ingest :pid => 'new'
+
+    obj = @repository.find(pid)
+    obj.should_not be_new
+    @repository.find(pid).delete rescue nil
+  end
 
   it "should create an object" do
     obj = @repository.find('test:1')
@@ -138,6 +155,101 @@ describe "Integration testing against a live Fedora repository", :integration =>
     obj.datastreams["my_ds"].mimeType.should == "application/x-text"
   end
 
+  describe "with transactions" do
+    it "should work on ingest" do
+       @repository.find('transactions:1').delete rescue nil
+
+       @repository.transaction do |t|
+         obj = @repository.find('transactions:1')
+         obj.save
+
+         t.rollback
+       end
+
+       obj = @repository.find('transactions:1')
+       obj.should be_new
+    end
+
+    it "should work on purge" do
+       @repository.find('transactions:1').delete rescue nil
+
+       obj = @repository.find('transactions:1')
+       obj.save
+
+       @repository.transaction do |t|
+         obj.delete
+
+         t.rollback
+       end
+
+       obj = @repository.find('transactions:1')
+       obj.should_not be_new
+    end
+
+    it "should work on datastreams" do
+       @repository.find('transactions:1').delete rescue nil
+
+       obj = @repository.find('transactions:1')
+       obj.save
+
+       ds = obj.datastreams['datastream_to_delete']
+       ds.content = 'asdf'
+       ds.save
+
+       ds2 = obj.datastreams['datastream_to_change']
+       ds2.content = 'asdf'
+       ds2.save
+
+       ds3 = obj.datastreams['datastream_to_change_properties']
+       ds3.content = 'asdf'
+       ds3.versionable = true
+       ds3.dsState = 'I'
+       ds3.save
+
+       @repository.transaction do |t|
+         ds.delete
+
+         ds2.content = '1234'
+         ds2.save
+
+         @repository.set_datastream_options :pid => obj.pid, :dsid => 'datastream_to_change_properties', :state => 'A'
+         @repository.set_datastream_options :pid => obj.pid, :dsid => 'datastream_to_change_properties', :versionable => false
+
+         ds4 = obj.datastreams['datastream_to_create']
+         ds4.content = 'asdf'
+         ds4.save
+
+         t.rollback
+       end
+
+       obj = @repository.find('transactions:1')
+       obj.datastreams.keys.should_not include('datsatream_to_create')
+       obj.datastreams.keys.should include('datastream_to_delete')
+       obj.datastreams['datastream_to_change'].content.should == 'asdf'
+       obj.datastreams['datastream_to_change_properties'].versionable.should == true
+       obj.datastreams['datastream_to_change_properties'].dsState.should == 'I'
+    end
+
+    it "should work on relationships" do
+       @repository.find('transactions:1').delete rescue nil
+
+       obj = @repository.find('transactions:1')
+       obj.save
+       @repository.add_relationship :subject => obj.pid, :predicate => 'uri:asdf', :object => 'fedora:object'
+
+       ds = obj.datastreams['RELS-EXT'].content
+
+       @repository.transaction do |t|
+         @repository.purge_relationship :subject => obj.pid, :predicate => 'uri:asdf', :object => 'fedora:object'
+         @repository.add_relationship :subject => obj.pid, :predicate => 'uri:qwerty', :object => 'fedora:object'
+
+         t.rollback
+
+       end
+       obj = @repository.find('transactions:1')
+       obj.datastreams['RELS-EXT'].content.should == ds
+    end
+  end
 
   describe "object versions" do
     it "should have versions" do

data/spec/lib/rest_api_client_spec.rb

@@ -1,15 +1,52 @@
 require 'spec_helper' 
-require 'loggable'
 
 describe Rubydora::RestApiClient do
+  class FakeException < Exception
+
+  end
   class MockRepository
     include Rubydora::RestApiClient
     include Loggable
 
-
     attr_accessor :config
   end
 
+
+
+  describe "exception handling" do
+  
+    shared_examples "RestClient error handling" do
+      subject { 
+        mock_repository = MockRepository.new
+        mock_repository.config = { :url => 'http://example.org' }
+
+        mock_repository
+      }
+
+      it "should replace a RestClient exception with a Rubydora one" do
+        subject.stub_chain(:client, :[], :get).and_raise RestClient::InternalServerError.new
+        subject.stub_chain(:client, :[], :put).and_raise RestClient::InternalServerError.new
+        subject.stub_chain(:client, :[], :delete).and_raise RestClient::InternalServerError.new
+        subject.stub_chain(:client, :[], :post).and_raise RestClient::InternalServerError.new
+        expect { subject.send(method, :pid => 'fake:pid', :dsid => 'my_dsid') }.to raise_error Rubydora::FedoraInvalidRequest
+      end
+    end
+
+    [:next_pid, :find_objects, :object, :ingest, :export, :modify_object, :purge_object, :object_versions, :object_xml, :datastream, :datastreams, :set_datastream_options, :datastream_versions, :datastream_history, :datastream_dissemination, :add_datastream, :modify_datastream, :purge_datastream, :relationships, :add_relationship, :purge_relationship, :dissemination].each do |method|
+
+      class_eval %Q{
+    describe "##{method}" do
+      it_behaves_like "RestClient error handling"
+      let(:method) { '#{method}' }
+    end
+      }
+    end
+
+  end
+
+
+
+
   before(:each) do
     @fedora_user = 'fedoraAdmin'
     @fedora_password = 'fedoraAdmin'

data/spec/lib/transactions_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+
+describe Rubydora::Transactions do
+  
+
+  subject { 
+    Rubydora::Repository.any_instance.stub(:version).and_return(100)
+    repository = Rubydora::Repository.new :url => 'http://example.org'
+  }
+
+
+  describe "#rollback" do
+    it "ingest" do
+      subject.client.stub_chain(:[], :post).and_return 'asdf'
+      subject.should_receive(:purge_object).with(hash_including(:pid => 'asdf'))
+
+      subject.transaction do |t|
+
+        subject.ingest :pid => 'asdf', :file => '<a />'
+
+        t.rollback
+      end
+    end
+
+    it "modify_object" do
+      subject.client.stub_chain(:[], :put).and_return 'asdf'
+
+      mock_object = double('Rubydora::DigitalObject', :state => 'A', :ownerId => '567', :logMessage => 'dfghj')
+      subject.should_receive(:find).with('asdf').and_return mock_object
+      
+
+      subject.transaction do |t|
+        subject.modify_object :pid => 'asdf', :state => 'I', :ownerId => '123', :logMessage => 'changing asdf'
+
+        subject.should_receive(:modify_object).with(hash_including(:pid => 'asdf', :state => 'A', :ownerId => '567', :logMessage => 'reverting'))
+        t.rollback
+      end
+    end
+
+    it "purge_object" do
+      subject.client.stub_chain(:[], :delete)
+
+      subject.should_receive(:export).with(hash_including(:pid => 'asdf', :context => :archive)).and_return '<xml />'
+      subject.should_receive(:ingest).with(hash_including(:pid => 'asdf', :file => '<xml />'))
+
+      subject.transaction do |t|
+        subject.purge_object :pid => 'asdf'
+
+        t.rollback
+      end
+    end
+
+    it "add_datastream" do
+      subject.client.stub_chain(:[], :post)
+      subject.should_receive(:purge_datastream).with(hash_including(:pid => 'asdf', :dsid => 'mydsid'))
+
+      subject.transaction do |t|
+        subject.add_datastream :pid => 'asdf', :dsid => 'mydsid'
+
+        t.rollback
+      end
+    end
+
+    it "modify_datastream" do
+      subject.client.stub_chain(:[], :put)
+
+      subject.should_receive(:export).with(hash_including(:pid => 'asdf', :context => :archive)).and_return '<xml />'
+      subject.should_receive(:ingest).with(hash_including(:pid => 'asdf', :file => '<xml />'))
+
+      subject.transaction do |t|
+        subject.modify_datastream :pid => 'asdf', :dsid => 'mydsid'
+
+        t.rollback
+      end
+    end
+
+    it "set_datastream_options" do
+      subject.client.stub_chain(:[], :put)
+
+      mock_object = double('Rubydora::DigitalObject')
+      mock_object.stub_chain(:datastreams, :[], :versionable).and_return(false)
+      subject.should_receive(:find).with('asdf').and_return mock_object
+
+      subject.transaction do |t|
+        subject.set_datastream_options :pid => 'asdf', :dsid => 'mydsid', :versionable => true
+
+        subject.should_receive(:set_datastream_options).with(hash_including(:pid => 'asdf', :versionable => false, :dsid => 'mydsid'))
+
+        t.rollback
+      end
+    end
+
+    it "purge_datastream" do
+      subject.client.stub_chain(:[], :delete)
+
+      subject.should_receive(:export).with(hash_including(:pid => 'asdf', :context => :archive)).and_return '<xml />'
+      subject.should_receive(:ingest).with(hash_including(:pid => 'asdf', :file => '<xml />'))
+
+      subject.transaction do |t|
+        subject.purge_datastream :pid => 'asdf', :dsid => 'mydsid'
+
+        t.rollback
+      end
+    end
+
+    it "add_relationship" do
+      subject.client.stub_chain(:[], :post)
+      subject.should_receive(:purge_relationship).with(hash_including(:subject => 'subject', :predicate => 'predicate', :object => 'object'))
+
+      subject.transaction do |t|
+        subject.add_relationship :subject => 'subject', :predicate => 'predicate', :object => 'object'
+        t.rollback
+      end
+    end
+
+    it "purge_relationship" do
+      subject.client.stub_chain(:[], :delete)
+      subject.should_receive(:add_relationship).with(hash_including(:subject => 'subject', :predicate => 'predicate', :object => 'object'))
+
+      subject.transaction do |t|
+        subject.purge_relationship :subject => 'subject', :predicate => 'predicate', :object => 'object'
+        t.rollback
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -11,6 +11,7 @@ if ENV['COVERAGE'] and RUBY_VERSION =~ /^1.9/
 end
 
 require 'rspec/autorun'
+require 'loggable'
 require 'rubydora'
 
 RSpec.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubydora
 version: !ruby/object:Gem::Version
-  version: 0.5.10
+  version: 0.5.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-25 00:00:00.000000000 Z
+date: 2012-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastercsv
@@ -123,6 +123,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hooks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: deprecation
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -251,6 +283,7 @@ files:
 - lib/rubydora/rest_api_client.rb
 - lib/rubydora/rest_api_client/v33.rb
 - lib/rubydora/soap.rb
+- lib/rubydora/transactions.rb
 - lib/rubydora/version.rb
 - rubydora.gemspec
 - spec/lib/datastream_spec.rb
@@ -263,6 +296,7 @@ files:
 - spec/lib/resource_index_spec.rb
 - spec/lib/rest_api_client_spec.rb
 - spec/lib/soap_spec.rb
+- spec/lib/transactions_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/cbeer/rubydora
 licenses: []
@@ -299,5 +333,6 @@ test_files:
 - spec/lib/resource_index_spec.rb
 - spec/lib/rest_api_client_spec.rb
 - spec/lib/soap_spec.rb
+- spec/lib/transactions_spec.rb
 - spec/spec_helper.rb
 has_rdoc: