rubydora 0.5.1 → 0.5.2

data/.gitignore

@@ -43,3 +43,4 @@ Gemfile.lock
 #
 # For vim:
 *.swp
+*.swo

data/History.textile

@@ -1,3 +1,6 @@
+h3. 0.5.2
+* Force checksum query when you call dsChecksumValid, unless it's already in the profile.
+
 h3. 0.5.1
 * symbolize keys that are passed as config options
 

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.5.2

data/lib/rubydora/datastream.rb

@@ -43,7 +43,7 @@ module Rubydora
       }
 
       def dsChecksumValid
-        profile['dsChecksumValid']
+        profile(:validateChecksum=>true)['dsChecksumValid']
       end
     end
 
@@ -140,20 +140,27 @@ module Rubydora
     end
 
     # 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 profile_xml = nil
-      @profile ||= begin
+    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
+      @profile = begin
         options = { :pid => pid, :dsid => dsid }
+        options.merge!(opts)
         options[:asOfDateTime] = asOfDateTime if asOfDateTime
         options[:validateChecksum] = true if repository.config[:validateChecksum]
-        profile_xml ||= repository.datastream(options)
-        self.profile_xml_to_hash(profile_xml)
-
+        self.profile_xml_to_hash(repository.datastream(options))
       rescue
         {}
       end
     end
-    alias_method :profile=, :profile
+
+    def profile= profile_xml
+      @profile = self.profile_xml_to_hash(profile_xml)
+    end
 
     def profile_xml_to_hash profile_xml
       profile_xml.gsub! '<datastreamProfile', '<datastreamProfile xmlns="http://www.fedora.info/definitions/1/0/management/"' unless profile_xml =~ /xmlns=/
@@ -177,6 +184,7 @@ module Rubydora
 
     def versions
       versions_xml = repository.datastream_versions(:pid => pid, :dsid => dsid)
+      return [] if versions_xml.nil?
       versions_xml.gsub! '<datastreamProfile', '<datastreamProfile xmlns="http://www.fedora.info/definitions/1/0/management/"' unless versions_xml =~ /xmlns=/
       doc = Nokogiri::XML(versions_xml)
       doc.xpath('//management:datastreamProfile', {'management' => "http://www.fedora.info/definitions/1/0/management/"} ).map do |ds|

data/lib/rubydora/rest_api_client.rb

@@ -1,3 +1,5 @@
+require 'active_support/core_ext/hash/indifferent_access'
+
 module Rubydora
 
   # Provide low-level access to the Fedora Commons REST API
@@ -181,6 +183,8 @@ module Rubydora
     # @param [Hash] options
     # @option options [String] :pid
     # @option options [String] :dsid
+    # @option options [String] :asOfDateTime
+    # @option options [String] :validateChecksum
     # @return [String]
     def datastream options = {}
       pid = options.delete(:pid)
@@ -228,7 +232,11 @@ module Rubydora
       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 => e
+raise e
         logger.error e.response
         logger.flush if logger.respond_to? :flush
         raise "Error getting versions for datastream #{dsid} for object #{pid}. See logger for details"

data/spec/lib/datastream_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Rubydora::Datastream do
   before do
-    @mock_repository = mock(Rubydora::Repository, :config=>{:validateChecksum=>true})
+    @mock_repository = mock(Rubydora::Repository, :config=>{})
     @mock_object = mock(Rubydora::DigitalObject)
     @mock_object.stub(:repository => @mock_repository, :pid => 'pid')
   end
@@ -47,7 +47,7 @@ describe Rubydora::Datastream do
       @datastream = Rubydora::Datastream.new @mock_object, 'dsid'
     end
     it "should be nil when it hasn't been set" do
-      @mock_repository.should_receive(:datastream).any_number_of_times.and_return <<-XML
+      @mock_repository.should_receive(:datastream).with(hash_including(:validateChecksum => true)).and_return <<-XML
         <datastreamProfile>
         </datastreamProfile>
       XML
@@ -55,7 +55,7 @@ describe Rubydora::Datastream do
     end
 
     it "should be true when it's returned as true" do
-      @mock_repository.should_receive(:datastream).any_number_of_times.and_return <<-XML
+      @mock_repository.should_receive(:datastream).with(hash_including(:validateChecksum => true)).and_return <<-XML
         <datastreamProfile>
           <dsChecksumValid>true</dsChecksumValid>
         </datastreamProfile>
@@ -64,7 +64,7 @@ describe Rubydora::Datastream do
     end
 
     it "should be false when it's returned as false" do
-      @mock_repository.should_receive(:datastream).any_number_of_times.and_return <<-XML
+      @mock_repository.should_receive(:datastream).with(hash_including(:validateChecksum => true)).and_return <<-XML
         <datastreamProfile>
           <dsChecksumValid>false</dsChecksumValid>
         </datastreamProfile>
@@ -187,33 +187,46 @@ describe Rubydora::Datastream do
   end
 
   describe "versions" do
-    before(:each) do
-      @datastream = Rubydora::Datastream.new @mock_object, 'dsid'
-      @mock_repository.should_receive(:datastream_versions).any_number_of_times.and_return <<-XML
-      <datastreamHistory>
-        <datastreamProfile>
-          <dsVersionID>dsid.1</dsVersionID>
-          <dsCreateDate>2010-01-02T00:00:00.012Z</dsCreateDate>
-        </datastreamProfile>
-        <datastreamProfile>
-          <dsVersionID>dsid.0</dsVersionID>
-          <dsCreateDate>2008-08-05T01:30:05.012Z</dsCreateDate>
-        </datastreamProfile>
-      </datastreamHistory>
-      XML
-    end
+    describe "when versions are in the repo" do
+      before(:each) do
+        @datastream = Rubydora::Datastream.new @mock_object, 'dsid'
+        @mock_repository.should_receive(:datastream_versions).any_number_of_times.and_return <<-XML
+        <datastreamHistory>
+          <datastreamProfile>
+            <dsVersionID>dsid.1</dsVersionID>
+            <dsCreateDate>2010-01-02T00:00:00.012Z</dsCreateDate>
+          </datastreamProfile>
+          <datastreamProfile>
+            <dsVersionID>dsid.0</dsVersionID>
+            <dsCreateDate>2008-08-05T01:30:05.012Z</dsCreateDate>
+          </datastreamProfile>
+        </datastreamHistory>
+        XML
+      end
 
-    it "should have a list of previous versions" do
-      @datastream.versions.should have(2).items
-    end
+      it "should have a list of previous versions" do
+        @datastream.versions.should have(2).items
+      end
 
-    it "should access versions as read-only copies" do
-      expect { @datastream.versions.first.label = "asdf" }.to raise_error
+      it "should access versions as read-only copies" do
+        expect { @datastream.versions.first.label = "asdf" }.to raise_error
+      end
+
+      it "should lookup content of datastream using the asOfDateTime parameter" do
+        @mock_repository.should_receive(:datastream_dissemination).with(hash_including(:asOfDateTime => '2008-08-05T01:30:05.012Z'))
+        @datastream.versions.last.content
+      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
+      end
+
+      it "should have an emptylist of previous versions" do
+        @datastream.versions.should be_empty
+      end
 
-    it "should lookup content of datastream using the asOfDateTime parameter" do
-      @mock_repository.should_receive(:datastream_dissemination).with(hash_including(:asOfDateTime => '2008-08-05T01:30:05.012Z'))
-      @datastream.versions.last.content
     end
     
   end
@@ -373,7 +386,62 @@ describe Rubydora::Datastream do
     end
   end
 
+  describe "profile=" do
+    before(:each) do
+      @datastream = Rubydora::Datastream.new @mock_object, 'dsid'
+    end
+    it "should set the profile" do
+      prof = <<-XML
+        <datastreamProfile>
+          <dsChecksumValid>true</dsChecksumValid>
+        </datastreamProfile>
+      XML
+      @datastream.profile = prof
+      @datastream.profile.should == {'dsChecksumValid' =>true}
+    end
+  end
+
   describe "profile" do
+    before(:each) do
+      @datastream = Rubydora::Datastream.new @mock_object, 'dsid'
+    end
+    it "should accept a validateChecksum argument" do
+      @mock_repository.should_receive(:datastream).with(hash_including(:validateChecksum => true)).and_return <<-XML
+        <datastreamProfile>
+          <dsChecksumValid>true</dsChecksumValid>
+        </datastreamProfile>
+      XML
+      @datastream.profile(:validateChecksum=>true).should == {'dsChecksumValid' =>true}
+    end
+    describe "once it has a profile" do
+      it "should use the profile from cache" do
+        @mock_repository.should_receive(:datastream).once.and_return <<-XML
+          <datastreamProfile>
+            <dsChecksumValid>true</dsChecksumValid>
+          </datastreamProfile>
+        XML
+        @datastream.profile().should == {'dsChecksumValid' =>true}
+        #second time should not trigger the mock, which demonstrates that the profile is coming from cache.
+        @datastream.profile().should == {'dsChecksumValid' =>true}
+      end
+      it "should re-fetch and replace the profile when validateChecksum is passed in, and there is no dsChecksumValid in the existing profile" do
+        @mock_repository.should_receive(:datastream).once.and_return <<-XML
+          <datastreamProfile>
+            <dsLabel>The description of the content</dsLabel>
+          </datastreamProfile>
+        XML
+        @mock_repository.should_receive(:datastream).with(hash_including(:validateChecksum => true)).once.and_return <<-XML
+          <datastreamProfile>
+            <dsLabel>The description of the content</dsLabel>
+            <dsChecksumValid>true</dsChecksumValid>
+          </datastreamProfile>
+        XML
+        @datastream.profile().should == {"dsLabel"=>"The description of the content"}
+        @datastream.profile(:validateChecksum=>true).should == {"dsLabel"=>"The description of the content", 'dsChecksumValid' =>true}
+        ## Third time should not trigger a mock, which demonstrates that the profile is coming from cache.
+        @datastream.profile(:validateChecksum=>true)
+      end
+    end
 
   end
 

data/spec/lib/rest_api_client_spec.rb

@@ -167,9 +167,15 @@ describe Rubydora::RestApiClient do
     @mock_repository.set_datastream_options :pid => 'mypid', :dsid => 'aaa', :aparam => true 
   end
 
-  it "datastream_versions" do
-     RestClient::Request.should_receive(:execute).with(hash_including(:url => "http://example.org/objects/mypid/datastreams/aaa/history?format=xml"))
-    @mock_repository.datastream_versions :pid => 'mypid', :dsid => 'aaa'
+  describe "datastream_versions" do
+    it "should be successful" do
+       RestClient::Request.should_receive(:execute).with(hash_including(:url => "http://example.org/objects/mypid/datastreams/aaa/history?format=xml")).and_return("expected result")
+      @mock_repository.datastream_versions(:pid => 'mypid', :dsid => 'aaa').should == 'expected result'
+    end
+    it "should not break when fedora doesn't have datastream history" do
+       RestClient::Request.should_receive(:execute).with(hash_including(:url => "http://example.org/objects/mypid/datastreams/aaa/history?format=xml")).and_raise(RestClient::ResourceNotFound)
+      @mock_repository.datastream_versions(:pid => 'mypid', :dsid => 'aaa').should be_nil
+    end
   end
 
   it "datastream_history" do

metadata

@@ -1,216 +1,166 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rubydora
-version: !ruby/object:Gem::Version 
-  hash: 9
+version: !ruby/object:Gem::Version
+  version: 0.5.2
   prerelease: 
-  segments: 
-  - 0
-  - 5
-  - 1
-  version: 0.5.1
 platform: ruby
-authors: 
+authors:
 - Chris Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-24 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
-  requirement: *id001
-  type: :runtime
+date: 2012-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: fastercsv
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &70365343748360 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
-  requirement: *id002
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
+  prerelease: false
+  version_requirements: *70365343748360
+- !ruby/object:Gem::Dependency
   name: rest-client
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &70365343747580 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
-  requirement: *id003
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
+  prerelease: false
+  version_requirements: *70365343747580
+- !ruby/object:Gem::Dependency
   name: nokogiri
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &70365343746620 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
-  requirement: *id004
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
+  prerelease: false
+  version_requirements: *70365343746620
+- !ruby/object:Gem::Dependency
   name: mime-types
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: &70365343776580 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
-  requirement: *id005
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
+  prerelease: false
+  version_requirements: *70365343776580
+- !ruby/object:Gem::Dependency
   name: activesupport
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  requirement: &70365343776040 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
-  requirement: *id006
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
+  prerelease: false
+  version_requirements: *70365343776040
+- !ruby/object:Gem::Dependency
   name: activemodel
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  requirement: &70365343775300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
-  requirement: *id007
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
+  prerelease: false
+  version_requirements: *70365343775300
+- !ruby/object:Gem::Dependency
   name: savon
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id008 !ruby/object:Gem::Requirement 
+  requirement: &70365343774660 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  requirement: *id008
-  type: :development
+  version_requirements: *70365343774660
+- !ruby/object:Gem::Dependency
   name: rake
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id009 !ruby/object:Gem::Requirement 
+  requirement: &70365343774200 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
-  requirement: *id009
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
+  prerelease: false
+  version_requirements: *70365343774200
+- !ruby/object:Gem::Dependency
   name: shoulda
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id010 !ruby/object:Gem::Requirement 
+  requirement: &70365343773680 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 1
-        - 0
-        - 14
-        version: 1.0.14
-  prerelease: false
-  requirement: *id010
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
+  prerelease: false
+  version_requirements: *70365343773680
+- !ruby/object:Gem::Dependency
   name: bundler
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id011 !ruby/object:Gem::Requirement 
+  requirement: &70365343773080 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
-  requirement: *id011
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.14
   type: :development
+  prerelease: false
+  version_requirements: *70365343773080
+- !ruby/object:Gem::Dependency
   name: rspec
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id012 !ruby/object:Gem::Requirement 
+  requirement: &70365343772660 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
-  requirement: *id012
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
+  prerelease: false
+  version_requirements: *70365343772660
+- !ruby/object:Gem::Dependency
   name: yard
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id013 !ruby/object:Gem::Requirement 
+  requirement: &70365343772120 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
-  requirement: *id013
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
+  prerelease: false
+  version_requirements: *70365343772120
+- !ruby/object:Gem::Dependency
   name: jettywrapper
-description: "Fedora Commons REST API ruby library : REQUIRES FCREPO 3.4+"
-email: 
+  requirement: &70365343771420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70365343771420
+description: ! 'Fedora Commons REST API ruby library : REQUIRES FCREPO 3.4+'
+email:
 - chris@cbeer.info
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .gitmodules
 - Gemfile
@@ -251,38 +201,35 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/cbeer/rubydora
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -1071574168413423455
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -1071574168413423455
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Fedora Commons REST API ruby library
-test_files: 
+test_files:
 - spec/lib/datastream_spec.rb
 - spec/lib/digital_object_spec.rb
 - spec/lib/ext_model_loader_spec.rb