rubydora 1.6.3 → 1.7.0

data/lib/rubydora/fedora_url_helpers.rb

@@ -12,6 +12,10 @@ module Rubydora
       "#{base}" + (("?#{options.map { |key, value|  "#{CGI::escape(key.to_s)}=#{CGI::escape(value.to_s)}"}.join("&")  }" if options and not options.empty?) || '')
     end
 
+    def describe_repository_url options = nil
+      url_for("describe", options)
+    end
+
     # Generate a base object REST API endpoint URI
     # @param [String] pid
     # @param [Hash] options to convert to URL parameters
@@ -20,6 +24,10 @@ module Rubydora
       url_for("objects" + (("/#{CGI::escape(pid.to_s.gsub('info:fedora/', ''))}" if pid) || ''), options)
     end
 
+    def new_object_url options = nil
+      object_url "new", options
+    end
+
     # @param [Hash] options to convert to URL parameters
     # @return [String] URI
     def next_pid_url options = nil
@@ -39,7 +47,7 @@ module Rubydora
     # @param [Hash] options to convert to URL parameters
     # @return [String] URI
     def dissemination_url pid, sdef = nil, method = nil, options = nil
-      raise "" unless pid
+      raise ArgumentError, "You must provide a pid" unless pid
       url_for(object_url(pid) + "/methods" +  (("/#{CGI::escape(sdef)}" if sdef) || '') +  (("/#{CGI::escape(method)}" if method) || ''), options)
     end
 
@@ -48,9 +56,20 @@ module Rubydora
     # @param [String] dsid
     # @param [Hash] options to convert to URL parameters
     # @return [String] URI
-    def datastream_url pid, dsid = nil, options = nil
-      raise "" unless pid
-      url_for(object_url(pid) + "/datastreams" + (("/#{CGI::escape(dsid)}" if dsid) || ''), options)
+    def datastream_url pid, dsid, options = nil
+      raise ArgumentError, "You must provide a pid and a dsid" unless pid and dsid
+      url_for(object_url(pid) + "/datastreams/#{CGI::escape(dsid)}", options)
+    end
+
+
+    # Generate a base datastream REST API endpoint URI
+    # @param [String] pid
+    # @param [String] dsid
+    # @param [Hash] options to convert to URL parameters
+    # @return [String] URI
+    def datastreams_url pid, options = nil
+      raise ArgumentError, "You must provide a pid" unless pid
+      url_for(object_url(pid) + "/datastreams", options)
     end
 
     # @param [String] pid

data/lib/rubydora/profile_parser.rb

@@ -0,0 +1,59 @@
+module Rubydora
+  module ProfileParser
+    def self.parse_datastream_profile profile_xml
+      profile_xml.gsub! '<datastreamProfile', '<datastreamProfile xmlns="http://www.fedora.info/definitions/1/0/management/"' unless profile_xml =~ /xmlns=/
+      doc = Nokogiri::XML(profile_xml)
+      h = doc.xpath('/management:datastreamProfile/*', {'management' => "http://www.fedora.info/definitions/1/0/management/"} ).inject({}) do |sum, node|
+                   sum[node.name] ||= []
+                   sum[node.name] << node.text
+                   sum
+                 end.reject { |key, values| values.empty? }
+      h.select { |key, values| values.length == 1 }.each do |key, values|
+        h[key] = values.reject { |x| x.empty? }.first 
+      end
+
+      h['dsSize'] &&= h['dsSize'].to_i rescue h['dsSize']
+      h['dsCreateDate'] &&= Time.parse(h['dsCreateDate']) rescue h['dsCreateDate']
+      h['dsChecksumValid'] &&= h['dsChecksumValid'] == 'true' 
+      h['dsVersionable'] &&= h['dsVersionable'] == 'true' 
+      h.with_indifferent_access
+    end
+
+    def self.parse_object_profile profile_xml
+      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.reject { |key, values| values.empty? }
+      h.select { |key, values| values.length == 1 }.each do |key, values|
+        next if key == "objModels"
+        h[key] = values.reject { |x| x.empty? }.first
+      end
+      h.with_indifferent_access
+    end
+
+    def self.parse_repository_profile profile_xml
+      profile_xml.gsub! '<fedoraRepository', '<fedoraRepository xmlns="http://www.fedora.info/definitions/1/0/access/"' unless profile_xml =~ /xmlns=/
+      doc = Nokogiri::XML(profile_xml)
+      xmlns = { 'access' => "http://www.fedora.info/definitions/1/0/access/"  }
+      h = doc.xpath('/access:fedoraRepository/*', xmlns).inject({}) do |sum, node|
+                   sum[node.name] ||= []
+                   case node.name
+                     when "repositoryPID"
+                       sum[node.name] << Hash[*node.xpath('access:*', xmlns).map { |x| [node.name, node.text]}.flatten]
+                     else
+                       sum[node.name] << node.text
+                   end
+                   sum
+                 end
+      h.with_indifferent_access
+    end
+  end
+end

data/lib/rubydora/repository.rb

@@ -1,10 +1,27 @@
 require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/module/delegation' # This line only needed for rails 3
 
 module Rubydora
   # Fedora Repository object that provides API access
   class Repository
     include ResourceIndex
-    include RestApiClient
+
+    attr_writer :api
+    def api
+      @api ||= driver.new(config)
+    end
+
+    # Eventually driver can decide between Fc3Service and Fc4Service
+    def driver
+      Fc3Service
+    end
+
+    delegate :client, :transaction, :mint, :ingest, :find_objects, :purge_object,
+      :modify_object, :datastreams, :add_datastream, :modify_datastream,
+      :set_datastream_options, :datastream_dissemination, :purge_datastream,
+      :add_relationship, :purge_relationship, :repository_profile,
+      :object_profile, :datastream_profile, :versions_for_datastream,
+      :versions_for_object, :audit_trail, to: :api
 
     # repository configuration (see #initialize)
     attr_reader :config
@@ -24,6 +41,10 @@ module Rubydora
       DigitalObject.find(pid, self)
     end
 
+    def find_or_initialize pid
+      DigitalObject.find_or_initialize(pid, self)
+    end
+
     # High-level access to the Fedora find_objects API
     #
     # @params [String] query
@@ -64,35 +85,12 @@ module Rubydora
     # repository profile (from API-A-LITE data)
     # @return [Hash]
     def profile
-      @profile ||= begin
-        profile_xml = client['describe?xml=true'].get
-        profile_xml.gsub! '<fedoraRepository', '<fedoraRepository xmlns="http://www.fedora.info/definitions/1/0/access/"' unless profile_xml =~ /xmlns=/
-        doc = Nokogiri::XML(profile_xml)
-        xmlns = { 'access' => "http://www.fedora.info/definitions/1/0/access/"  }
-        h = doc.xpath('/access:fedoraRepository/*', xmlns).inject({}) do |sum, node|
-                     sum[node.name] ||= []
-                     case node.name
-                       when "repositoryPID"
-                         sum[node.name] << Hash[*node.xpath('access:*', xmlns).map { |x| [node.name, node.text]}.flatten]
-                       else
-                         sum[node.name] << node.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
+      @profile ||= repository_profile
     end
 
     # @return [Float] repository version
     def version
-      @version ||= profile['repositoryVersion'].to_f rescue nil
+      @version ||= repository_profile['repositoryVersion'].to_f rescue nil
     end
 
     # Raise an error if unable to connect to the API endpoint

data/lib/rubydora/rest_api_client.rb

@@ -9,7 +9,9 @@ module Rubydora
     
     include Rubydora::FedoraUrlHelpers
     extend ActiveSupport::Concern
-    include ActiveSupport::Benchmarkable
+    include ActiveSupport::Benchmarkable    
+    extend Deprecation
+
 
 
     VALID_CLIENT_OPTIONS = [:user, :password, :timeout, :open_timeout, :ssl_client_cert, :ssl_client_key]
@@ -31,10 +33,10 @@ module Rubydora
 
       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}"
+        define_hook "before_#{h}".to_sym
       end
 
-      define_hook "after_ingest"
+      define_hook :after_ingest
       include Transactions
     end
 
@@ -59,6 +61,14 @@ module Rubydora
       end
     end
 
+    def describe options = {}
+      query_options = options.dup
+      query_options[:xml] ||= 'true'
+      client[describe_repository_url(query_options)].get
+    rescue Exception => exception
+      rescue_with_handler(exception) || raise
+    end
+
     # {include:RestApiClient::API_DOCUMENTATION}
     # @param [Hash] options
     # @return [String]
@@ -106,7 +116,12 @@ module Rubydora
     # @return [String]
     def ingest options = {}
       query_options = options.dup
-      pid = query_options.delete(:pid) || 'new'
+      pid = query_options.delete(:pid)
+
+      if pid.nil?
+        return mint_pid_and_ingest options
+      end
+
       file = query_options.delete(:file)
       assigned_pid = client[object_url(pid, query_options)].post((file.dup if file), :content_type => 'text/xml')
       run_hook :after_ingest, :pid => assigned_pid, :file => file, :options => options
@@ -115,6 +130,17 @@ module Rubydora
         rescue_with_handler(exception) || raise
     end
 
+    def mint_pid_and_ingest options = {}
+      query_options = options.dup
+      file = query_options.delete(:file)
+
+      assigned_pid = client[new_object_url(query_options)].post((file.dup if 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}
     # @param [Hash] options
     # @option options [String] :pid
@@ -193,10 +219,16 @@ module Rubydora
       query_options = options.dup
       pid = query_options.delete(:pid)
       dsid = query_options.delete(:dsid)
+      raise ArgumentError, "Missing required parameter :pid" unless pid
+
+      if dsid.nil?
+        #raise ArgumentError, "Missing required parameter :dsid" unless dsid
+        Deprecation.warn(RestApiClient, "Calling Rubydora::RestApiClient#datastream without a :dsid is deprecated, use #datastreams instead")
+        return datastreams(options)
+      end
       query_options[:format] ||= 'xml'
       val = nil
-      message = dsid.nil? ? "Loaded datastream list for #{pid}" : "Loaded datastream profile #{pid}/#{dsid}"
-      benchmark message, :level=>:debug do
+      benchmark "Loaded datastream profile #{pid}/#{dsid}", :level=>:debug do
         val = client[datastream_url(pid, dsid, query_options)].get
       end
 
@@ -208,7 +240,29 @@ module Rubydora
         rescue_with_handler(exception) || raise
     end
 
-    alias_method :datastreams, :datastream
+    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")
+        return datastream(options)
+      end
+      query_options = options.dup
+      pid = query_options.delete(:pid)
+      raise ArgumentError, "Missing required parameter :pid" unless pid
+      query_options[:format] ||= 'xml'
+      val = nil
+      benchmark "Loaded datastream list for #{pid}", :level=>:debug do
+        val = client[datastreams_url(pid, query_options)].get
+      end
+
+      val
+    rescue RestClient::Unauthorized => e
+      logger.error "Unauthorized at #{client.url}/#{datastreams_url(pid, query_options)}"
+      raise e
+    rescue Exception => exception
+        rescue_with_handler(exception) || raise
+
+    end
 
     # {include:RestApiClient::API_DOCUMENTATION}
     # @param [Hash] options

data/lib/rubydora/transactions.rb

@@ -40,22 +40,23 @@ module Rubydora
 
       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'
+          xml = object(pid: options[:pid])
+          profile = ProfileParser.parse_object_profile(xml)
+          append_to_transactions_log :modify_object, :pid => options[:pid], :state => profile[:objState], :ownerId => profile[:objOwnerId], :logMessage => 'reverting'
         end
       end
 
       before_set_datastream_options do |options|
         if Rubydora::Transactions.use_transactions
-          obj = find(options[:pid])
-          ds = obj.datastreams[options[:dsid]]
+          xml = datastream(pid: options[:pid], dsid: options[:dsid])
+          profile = ProfileParser.parse_datastream_profile(xml)
 
           if options[:options][:versionable]
-            append_to_transactions_log :set_datastream_options, :pid => options[:pid], :dsid => options[:dsid], :versionable => ds.versionable
+            append_to_transactions_log :set_datastream_options, :pid => options[:pid], :dsid => options[:dsid], :versionable => profile[:dsVersionable]
           end
 
           if options[:options][:state]
-            append_to_transactions_log :set_datastream_options, :pid => options[:pid], :dsid => options[:dsid], :state => ds.state
+            append_to_transactions_log :set_datastream_options, :pid => options[:pid], :dsid => options[:dsid], :state => profile[:dsState]
           end
         end
       end
@@ -99,7 +100,7 @@ module Rubydora
   class Transaction
     attr_reader :repository
     include Hooks
-    define_hook "after_rollback"
+    define_hook :after_rollback
 
     def initialize repository, &block
       @repository = repository

data/lib/rubydora.rb

@@ -15,6 +15,8 @@ module Rubydora
   autoload :ArrayWithCallback, "rubydora/array_with_callback"
   autoload :Transactions, "rubydora/transactions"
   autoload :AuditTrail, "rubydora/audit_trail"
+  autoload :ProfileParser, "rubydora/profile_parser"
+  autoload :Fc3Service, "rubydora/fc3_service"
 
   require 'csv'
   require 'time'

data/rubydora.gemspec

@@ -23,11 +23,10 @@ Gem::Specification.new do |s|
   s.add_dependency "mime-types"
   s.add_dependency "activesupport"
   s.add_dependency "activemodel"
-  s.add_dependency "hooks"
+  s.add_dependency "hooks", "~> 0.3.0"
   s.add_dependency "deprecation"
 
   s.add_development_dependency("rake")
-  s.add_development_dependency("shoulda")
   s.add_development_dependency("bundler", ">= 1.0.14")
   s.add_development_dependency("rspec")
   s.add_development_dependency("yard")

data/spec/audit_trail_spec.rb

@@ -8,7 +8,7 @@ describe "#audit_trail" do
       @xml = f.read
     end
     @repo = Rubydora::Repository.new
-    @repo.stub(:object_xml).with(hash_including(:pid => 'foo:bar')).and_return(@xml)
+    @repo.api.stub(:object_xml).with(hash_including(:pid => 'foo:bar')).and_return(@xml)
     @test_object = Rubydora::DigitalObject.new('foo:bar', @repo)
   end
   it "should have the correct number of audit records" do

data/spec/lib/datastream_spec.rb

@@ -3,15 +3,15 @@ require 'stringio'
 
 describe Rubydora::Datastream do
   before do
-    @mock_repository = mock(Rubydora::Repository, :config=>{})
-    @mock_object = mock(Rubydora::DigitalObject)
-    @mock_object.stub(:repository => @mock_repository, :pid => 'pid', :new? => false)
+    @mock_repository = Rubydora::Fc3Service.new({})
+    @mock_object = double(Rubydora::DigitalObject)
+    @mock_object.stub(:repository => @mock_repository, :pid => 'pid', :new_record? => false)
   end
 
   describe "stream" do
     subject { Rubydora::Datastream.new @mock_object, 'dsid' }
     before do
-      stub_response = stub()
+      stub_response = double
       stub_response.stub(:read_body).and_yield("one1").and_yield('two2').and_yield('thre').and_yield('four')
       @mock_repository.should_receive(:datastream_dissemination).with(hash_including(:pid => 'pid', :dsid => 'dsid')).and_yield(stub_response) 
       prof = <<-XML
@@ -19,7 +19,7 @@ describe Rubydora::Datastream do
           <dsSize>16</dsSize>
         </datastreamProfile>
       XML
-      subject.profile = prof
+      subject.profile = Rubydora::ProfileParser.parse_datastream_profile(prof)
     end
     it "should send the whold thing" do
       e = subject.stream()
@@ -123,6 +123,10 @@ describe Rubydora::Datastream do
       @datastream.versionable.should be_false
     end
 
+    it "should be the current version" do
+      @datastream.current_version?.should be_true
+    end
+
     # it "should cast versionable to boolean" do
     #   @datastream.profile['versionable'] = 'true'
     #   @datastream.versionable.should be_true
@@ -208,7 +212,7 @@ describe Rubydora::Datastream do
   describe "retrieve" do
     before(:each) do
       @datastream = Rubydora::Datastream.new @mock_object, 'dsid'
-      @mock_repository.should_receive(:datastream).any_number_of_times.and_return <<-XML
+      @mock_repository.stub(:datastream).and_return <<-XML
         <datastreamProfile>
           <dsLocation>some:uri</dsLocation>
           <dsLabel>label</dsLabel>
@@ -257,7 +261,7 @@ describe Rubydora::Datastream do
     describe "for a managed datastream" do
       before(:each) do
         @datastream = Rubydora::Datastream.new @mock_object, 'dsid'
-        @mock_repository.should_receive(:datastream).any_number_of_times.and_return <<-XML
+        @mock_repository.stub(:datastream).and_return <<-XML
           <datastreamProfile>
             <dsLocation>some:uri</dsLocation>
             <dsLabel>label</dsLabel>
@@ -303,7 +307,7 @@ describe Rubydora::Datastream do
 
     describe "for an inline datastream" do
       before(:each) do
-        @mock_repository.should_receive(:datastream).any_number_of_times.and_return <<-XML
+        @mock_repository.stub(:datastream).and_return <<-XML
           <datastreamProfile>
             <dsLocation>some:uri</dsLocation>
             <dsLabel>label</dsLabel>
@@ -331,7 +335,7 @@ describe Rubydora::Datastream do
       subject.stub(:new? => true)
     end
 
-    subject { Rubydora::Datastream.new mock(:pid => 'asdf', :new? => false), 'asdf' }
+    subject { Rubydora::Datastream.new double(:pid => 'asdf', :new? => false), 'asdf' }
     it "should have content if it is persisted" do
       subject.stub(:new? => false)
       subject.should have_content     
@@ -358,7 +362,7 @@ describe Rubydora::Datastream do
   describe "update" do
     before(:each) do
       @datastream = Rubydora::Datastream.new @mock_object, 'dsid'
-      @mock_repository.should_receive(:datastream).any_number_of_times.and_return <<-XML
+      @mock_repository.stub(:datastream).and_return <<-XML
         <datastreamProfile>
           <dsLocation>some:uri</dsLocation>
           <dsLabel>label</dsLabel>
@@ -407,7 +411,7 @@ describe Rubydora::Datastream do
     before(:each) do
       @datastream = Rubydora::Datastream.new @mock_object, 'dsid'
       @datastream.stub :content_changed? => false
-      @mock_repository.should_receive(:datastream).any_number_of_times.and_return <<-XML
+      @mock_repository.stub(:datastream).and_return <<-XML
         <datastreamProfile>
           <dsLocation>some:uri</dsLocation>
           <dsLabel>label</dsLabel>
@@ -439,7 +443,7 @@ describe Rubydora::Datastream do
       before(:each) do
         @datastream = Rubydora::Datastream.new @mock_object, 'dsid'
         @datastream.stub(:new? => false)
-        @mock_repository.should_receive(:datastream_versions).any_number_of_times.and_return <<-XML
+        @mock_repository.stub(:datastream_versions).and_return <<-XML
         <datastreamHistory>
           <datastreamProfile>
             <dsVersionID>dsid.1</dsVersionID>
@@ -466,17 +470,52 @@ describe Rubydora::Datastream do
         Rubydora::Datastream.any_instance.stub(:new? => false)
         @datastream.versions.last.content
       end
+
+      it "should be the current version" do
+        @mock_repository.stub(:datastream).with(hash_including(:pid => 'pid', :dsid => 'dsid')).and_return <<-XML
+          <datastreamProfile>
+            <dsVersionID>dsid.1</dsVersionID>
+            <dsCreateDate>2010-01-02T00:00:00.012Z</dsCreateDate>
+          </datastreamProfile>
+          XML
+        @datastream.current_version?.should be_true
+      end
+
+      it "should be the current version if it's the first version" do
+        @mock_repository.stub(:datastream).with(hash_including(:pid => 'pid', :dsid => 'dsid', :asOfDateTime =>'2010-01-02T00:00:00.012Z')).and_return <<-XML
+          <datastreamProfile>
+            <dsVersionID>dsid.1</dsVersionID>
+            <dsCreateDate>2010-01-02T00:00:00.012Z</dsCreateDate>
+          </datastreamProfile>
+          XML
+        @datastream.versions.first.current_version?.should be_true
+      end
+
+      it "should not be the current version if it's the second version" do
+        @mock_repository.stub(:datastream).with(hash_including(:pid => 'pid', :dsid => 'dsid', :asOfDateTime => '2008-08-05T01:30:05.012Z')).and_return <<-XML
+          <datastreamProfile>
+            <dsVersionID>dsid.0</dsVersionID>
+            <dsCreateDate>2008-08-05T01:30:05.012Z</dsCreateDate>
+          </datastreamProfile>
+          XML
+        @datastream.versions[1].current_version?.should be_false
+      end
     end
     describe "when no versions are found" do
       before(:each) do
         @datastream = Rubydora::Datastream.new @mock_object, 'dsid'
-        @mock_repository.should_receive(:datastream_versions).any_number_of_times.and_return nil
+        @mock_repository.stub(:datastream_versions).and_return nil
       end
 
       it "should have an emptylist of previous versions" do
         @datastream.versions.should be_empty
       end
 
+      it "should be the current version" do
+        @datastream.stub(:new? => false)
+        @datastream.current_version?.should be_true
+      end
+
     end
     
   end
@@ -661,7 +700,7 @@ describe Rubydora::Datastream do
           <dsChecksumValid>true</dsChecksumValid>
         </datastreamProfile>
       XML
-      @datastream.profile = prof
+      @datastream.profile = Rubydora::ProfileParser.parse_datastream_profile(prof)
       @datastream.profile.should == {'dsChecksumValid' =>true}
     end
   end
@@ -670,7 +709,7 @@ describe Rubydora::Datastream do
     describe "with a digital_object that doesn't have a repository" do
       ### see UnsavedDigitalObject in ActiveFedora
       before(:each) do
-        @datastream = Rubydora::Datastream.new stub(:foo), 'dsid'
+        @datastream = Rubydora::Datastream.new double(:foo), 'dsid'
       end
       it "should be empty if the digital_object doesn't have a repository" do
         @datastream.profile.should == {}