assembly-utils 1.4.3 → 1.4.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NGFmYmJhZDg0OTg5YzMxYzZlZjZjNWM1OTc0Nzc0MTdiYzI4ZmY5MQ==
+    ZTJlYzhjNWUyMmVmMWZhZWZiODQxMGQ0ZjMyNWZmZTU5YWRmMDU1NQ==
   data.tar.gz: !binary |-
-    ZDU4YTZhODQ3YTkwZTI0N2FkOTRiNDRmM2YxNTlmYzJmMWQwNzg3MA==
+    MDRiY2E2N2I4OWYzOTgyNzVlOTY0OTVkODQ4M2U5ZGJiNGQxOTlkMA==
 SHA512:
   metadata.gz: !binary |-
-    ZGQ1MDdhOGMwMGZjODc3MzNhODAzZWM1ZjZlZDU3NWI3YTVhYjIwYzhmOTAz
-    ZDFlM2M5NzQ1MTNiMGU5NjU1MjY1MTNkNmVmMzFhNzdmMTNkYzc0OWMxYTFh
-    NzZkYzg2NTIxM2NmMDY1MTk1ZmFjNjI2OGMxY2I5N2NlOTcyNTk=
+    OWYzOGE4Njk2NDZlOGY1MmQwZmI0Yjk2YmJmZjhlYWViYzdhNGE1OTgwZjlk
+    N2I3NDI0Mjc2MTk2ZTlmMmZhNWI4OTliMWZiN2E4ZTU2YzFiNzY5OTkxMDE0
+    Zjg4OTVlYjQxNGRkYjBkZmNmNzNmMjQxMTA1NTNhNjNhZTEyMmM=
   data.tar.gz: !binary |-
-    NGNjNTYyODg1ZjYyMWEwYWNmYzRmMGEwYWUwYWZkZDIxNGQ2MjlkYjY1YTc0
-    MGZlOTgyMjFmNTU1MDFmZDg2MjFlZTk2YTQyZjA1MGI5MTE5Mjg5MGZkMzU1
-    NjExY2QyMTZmYjI2ZTVjYzNiNTkwMDZjZTIyMGQ1MjQyMWMwZjI=
+    Y2U1Nzg2MWVkNzA0NDUzYjIyYjVkYjliNmIwMTliZDFmYTFhMDU1NGZlMmUw
+    ZDVlYjRmYTA4ZGQxMmQ3YzQxOTk2MjFmMzRjZjZhMTQzNzkxOTdmNjFkM2Qx
+    YTYwZmRjMTdjNjI4NTA3YmFiY2UyMTcwZjBmY2I3ODY5ZjdjMmU=

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--tag ~type:integration

data/Gemfile

@@ -2,3 +2,4 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in assembly-utils.gemspec
 gemspec
+

data/README.md

@@ -0,0 +1,72 @@
+# Assembly Utils Gem
+
+## Overview 
+Ruby gem of methods useful for assembly and accessioning. Contains classes to
+manipulate DOR objects for assembly and accessioning.
+
+## Releases
+
+*   1.0.0 initial release
+*   1.0.1 bug fixes
+*   1.0.2 more bug fixes to use the new druid-tools namespace
+*   1.0.3 add a method to compute staging paths based on changes to Druid gem path computations
+*   1.0.4 add some tests and document methods
+*   1.0.5 add more spec tests and documentation; update `get_staging_path` method to fix a bug
+*   1.0.6 add the ability to delete workflows in the cleanup method, add a new
+    method to fetch and delete all workflows
+*   1.0.7 add a new method to determine if a specific workflow is defined in the APO
+*   1.0.8 add methods to batch import and export objects to/from FOXML
+*   1.0.9 add spec output test data directory to git
+*   1.0.10 lowered required version of dor-services from 3.9.0 to 3.8.0
+*   1.0.11 use `Dor::DigitalStacksService` to calculate stacks directory to cleanup
+*   1.0.12 bugfix on call to `Dor::DigitalStacksService`
+*   1.0.13 update to latest lyberteam devel gems
+*   1.0.14 add new method to re-index item in solr
+*   1.1.0  small updates to some methods to depracate `apo_workflow` checking method
+*   1.1.1  add dor-workflow-service gem and convenience method to auto reset
+    all objects in a specific state back to waiting
+*   1.1.2  allow `reset_workflow_state` to accept a state parameter 
+*   1.1.3  add a reindex method
+*   1.1.4  fixed delete object method to remove from solr too; fix cleanup
+    object method to remove both old and new style druid trees 
+*   1.1.5 add new claim druid method
+*   1.1.6 add new step to remove workflows during `cleanup_object`
+*   1.1.7 change ordering of cleanup steps so if deleting workflow fails, the
+    earlier steps will still run
+*   1.1.8 fix bug in cleanup method during symlink deletion
+*   1.1.9 add remediate-object to the workflow status report; remove some
+    methods around robot usage that aren't needed anymore
+*   1.2.0 add a new method to return an array of druids from a CSV file which contains a "druid" column
+*   1.2.1 add a new method to insert a specific workflow into an object
+*   1.2.2 add a new method to bulk republish a list of druids, and a new
+    parameter to datastreams bulk update to publish after updating
+*   1.2.3 add a new method to check the status of an object (`is_ingested?`)
+*   1.2.4 add some additional methods to check the state of an object
+*   1.2.5-1.2.7  update gemfile to newer version of dor-services gem and other related/dependent gems
+*   1.2.8 add a new constant for technical metadata filename
+*   1.4.1-2 update gems and fix typos
+
+
+## Running tests
+
+You will need to be on the Stanford network or VPNed in to run the
+tests, since it connects to DOR.  To run tests:
+
+```bash
+bundle exec rspec spec
+```
+
+## Deploy new gem
+
+```bash
+gem build assembly-utils.gemspec
+gem push assembly-utils-1.4.1.gem # update version as needed
+```
+
+## Connecting to DOR
+
+Some of the methods require a connection to DOR, which is not provided as part
+of this gem.  In order to connect to DOR, you will need some configuration
+information in your project, along with the certificates for the appropriate
+environment.  Connections for development DOR are provided as part of the gem
+in the 'config' directory and are used in the spec test suite.

data/assembly-utils.gemspec

@@ -27,10 +27,10 @@ Gem::Specification.new do |s|
   
   s.add_dependency 'activesupport'
   s.add_dependency 'activeresource'
-  s.add_dependency 'addressable', '2.3.5'
+  s.add_dependency 'addressable', '2.3.5' # avoids ERROR: lib/addressable/uri.rb:1659:in `normalized_fragment': can't modify frozen Addressable::URI (RuntimeError)
 
   s.add_development_dependency "rake"
-  s.add_development_dependency "rspec", "~> 2.6"
+  s.add_development_dependency "rspec", '~> 3.1'
   s.add_development_dependency "yard"
   
 end

data/config/connect_to_dor.rb

@@ -2,5 +2,5 @@ environment  = ENV['ENVIRONMENT'] ||= 'development'
 GEM_ROOT = File.expand_path(File.dirname(__FILE__) + '/..')
 
 # Environment.
-ENV_FILE = GEM_ROOT + "/config/environments/#{environment}.rb"
-require ENV_FILE
+env_file = GEM_ROOT + "/config/environments/#{environment}.rb"
+require env_file if File.file?(env_file)

data/lib/assembly-utils/utils.rb

@@ -510,7 +510,7 @@ module Assembly
       end  
     end
 
-    # Check if the object is full accessioned and ingested.
+    # Check if the object is fully accessioned and ingested.
     # This method only works when this gem is used in a project that is configured to connect to the workflow service.
     #
     # @param [string] pid the druid to operate on
@@ -523,6 +523,19 @@ module Assembly
       WFS.get_lifecycle(REPO, pid, 'accessioned') ? true : false
     end
 
+    # Check if the object is currently in accessioning
+    # This method only works when this gem is used in a project that is configured to connect to the workflow service.
+    #
+    # @param [string] pid the druid to operate on
+    #
+    # @return [boolean] if object is currently in accessioning
+    # Example:
+    #   Assembly::Utils.in_accessioning?('druid:oo000oo0001')
+    #   > false
+    def self.in_accessioning?(pid)
+      WFS.get_active_lifecycle(REPO, pid, 'submitted') ? true : false
+    end
+    
     # Check if the object is on ingest hold
     # This method only works when this gem is used in a project that is configured to connect to the workflow service.
     #
@@ -548,7 +561,33 @@ module Assembly
     def self.is_submitted?(pid)
       WFS.get_lifecycle(REPO, pid, 'submitted') == nil
     end
-    
+
+    # Check if the updates are allowed on the object
+    # This method only works when this gem is used in a project that is configured to connect to the workflow service.
+    #
+    # @param [string] pid the druid to operate on
+    #
+    # @return [boolean] if object can be versioned and updated   
+    # Example:
+    #   Assembly::Utils.updates_allowed?('druid:oo000oo0001')
+    #   > false 
+    def self.updates_allowed?(pid)
+      !self.in_accessioning?(pid) && self.is_ingested?(pid)
+    end
+
+    # Check if versioning is required for the object
+    # This method only works when this gem is used in a project that is configured to connect to the workflow service.
+    #
+    # @param [string] pid the druid to operate on
+    #
+    # @return [boolean] if object requires versioning
+    # Example:
+    #   Assembly::Utils.versioning_required?('druid:oo000oo0001')
+    #   > false     
+    def self.versioning_required?(pid)
+      !((!self.is_ingested?(pid) && self.ingest_hold?(pid)) || (!self.is_ingested?(pid) && !self.is_submitted?(pid))) 
+    end
+        
     # Reset the workflow states for a list of druids given a list of workflow names and steps.
     # Provide a list of druids in an array, and a hash containing workflow names (e.g. 'assemblyWF' or 'accessionWF') as the keys, and arrays of steps
     # as the corresponding values (e.g. ['checksum-compute','jp2-create']) and they will all be reset to "waiting".

data/lib/assembly-utils/version.rb

@@ -3,6 +3,6 @@ module Assembly
   # Main Utils class
   class Utils
     # Project version number    
-    VERSION = "1.4.3"
+    VERSION = "1.4.4"
   end
 end

data/spec/utils_spec.rb

@@ -1,53 +1,53 @@
 require 'spec_helper'
 
 describe Assembly::Utils do
-  
+
   it "should compute the correct staging path given a druid" do
     path=Assembly::Utils.get_staging_path('aa000aa0001')
-    path.should == 'aa/000/aa/0001'
+    expect(path).to eq('aa/000/aa/0001')
   end
 
   it "should compute the correct staging path given a druid and a pre-pend path" do
     path=Assembly::Utils.get_staging_path('aa000aa0001','/tmp')
-    path.should == '/tmp/aa/000/aa/0001'
+    expect(path).to eq('/tmp/aa/000/aa/0001')
   end
 
   it "should symbolize hash keys correctly" do
-    result=Assembly::Utils.symbolize_keys({'foo'=>'bar','ppuff'=>'doofus'}) 
-    result.should == {:foo=>'bar',:ppuff=>'doofus'}
+    result=Assembly::Utils.symbolize_keys({'foo'=>'bar','ppuff'=>'doofus'})
+    expect(result).to eq({:foo=>'bar',:ppuff=>'doofus'})
   end
 
   it "should symbolize hash values correctly" do
     result=Assembly::Utils.values_to_symbols!({'foo'=>'bar','ppuff'=>'doofus'})
-    result.should == {'foo'=>:bar,'ppuff'=>:doofus}
+    expect(result).to eq({'foo'=>:bar,'ppuff'=>:doofus})
   end
-  
+
   it "should return a blank string if a file is not found to read in" do
     bogus_filename='crap/dude'
-    Assembly::Utils.read_file(bogus_filename).should == ''
+    expect(Assembly::Utils.read_file(bogus_filename)).to eq('')
   end
 
   it "should return a string with the file content if the file is found" do
     progress_filename='spec/test_data/test_log.yaml'
-    Assembly::Utils.read_file(progress_filename).should =~ /:pid: druid:bg598tg6338/
+    expect(Assembly::Utils.read_file(progress_filename)).to match(/:pid: druid:bg598tg6338/)
   end
-  
+
   it "should read in a list of completed druids from a progress log file" do
     progress_filename='spec/test_data/test_log.yaml'
-    druids=Assembly::Utils.get_druids_from_log(progress_filename)   
-    druids.should == ['druid:bc006dj2846','druid:bg598tg6338']
+    druids=Assembly::Utils.get_druids_from_log(progress_filename)
+    expect(druids).to eq(['druid:bc006dj2846','druid:bg598tg6338'])
   end
 
   it "should read in a list of failed druids from a progress log file" do
     progress_filename='spec/test_data/test_log.yaml'
-    druids=Assembly::Utils.get_druids_from_log(progress_filename,false)   
-    druids.should == ['druid:bh634sp8073']
+    druids=Assembly::Utils.get_druids_from_log(progress_filename,false)
+    expect(druids).to eq(['druid:bh634sp8073'])
   end
-  
+
   it "should read in a YAML configuration file and turn it into a hash" do
     config_filename='spec/test_data/local_dev_revs.yaml'
-    config=Assembly::Utils.load_config(config_filename)   
-    config['progress_log_file'].should == 'tmp/progress_revs.yaml'
+    config=Assembly::Utils.load_config(config_filename)
+    expect(config['progress_log_file']).to eq('tmp/progress_revs.yaml')
   end
 
   ###################################################################################
@@ -63,56 +63,56 @@ describe Assembly::Utils do
       remove_files(TEST_OUTPUT_DIR)
       delete_test_object
     end
-        
-    it "should find druids by source ID" do
-      Dor::SearchService.should_receive(:query_by_id).with('testing-assembly-utils-gem').and_return TEST_PID
+
+    it "should find druids by source ID", :type =>'integration' do
+      expect(Dor::SearchService).to receive(:query_by_id).with('testing-assembly-utils-gem').and_return TEST_PID
       druids=Assembly::Utils.get_druids_by_sourceid(['testing-assembly-utils-gem'])
-      druids.should == [TEST_PID]
+      expect(druids).to eq([TEST_PID])
     end
-  
-    it "should replace the datastream of an object" do
+
+    it "should replace the datastream of an object", :type =>'integration' do
       new_content="<xml><tag>stuff</tag></xml>"
       datastream="test"
       druids=[TEST_PID]
       Assembly::Utils.replace_datastreams(druids,datastream,new_content)
       obj = Dor::Item.find(TEST_PID)
-      obj.datastreams[datastream].content.should =~ /<tag>stuff<\/tag>/
+      expect(obj.datastreams[datastream].content).to match(/<tag>stuff<\/tag>/)
     end
 
-    it "should search and replace the datastream of an object" do
+    it "should search and replace the datastream of an object", :type =>'integration' do
       find_content="stuff"
       replace_content="new"
       datastream="test"
       druids=[TEST_PID]
       Assembly::Utils.update_datastreams(druids,datastream,find_content,replace_content)
       obj = Dor::Item.find(TEST_PID)
-      obj.datastreams[datastream].content.should =~ /<tag>new<\/tag>/
+      expect(obj.datastreams[datastream].content).to match(/<tag>new<\/tag>/)
     end
-  
-    it "should export a PID to FOXML" do
-      File.exists?(File.join(TEST_OUTPUT_DIR,"#{TEST_PID_FILENAME}.foxml.xml")).should be false
+
+    it "should export a PID to FOXML", :type =>'integration' do
+      expect(File.exists?(File.join(TEST_OUTPUT_DIR,"#{TEST_PID_FILENAME}.foxml.xml"))).to be false
       Dir.mkdir(TEST_OUTPUT_DIR) unless Dir.exists?(TEST_OUTPUT_DIR)
       Assembly::Utils.export_objects(TEST_PID,TEST_OUTPUT_DIR)
-      File.exists?(File.join(TEST_OUTPUT_DIR,"#{TEST_PID_FILENAME}.foxml.xml")).should be true
+      expect(File.exists?(File.join(TEST_OUTPUT_DIR,"#{TEST_PID_FILENAME}.foxml.xml"))).to be true
+    end
+
+    it "should return nil when the workflow state is not found in an object", :type =>'integration' do
+      expect(Assembly::Utils.get_workflow_status(TEST_PID,'assemblyWF','jp2-create')).to be_nil
     end
-  
-    it "should return nil when the workflow state is not found in an object" do
-      Assembly::Utils.get_workflow_status(TEST_PID,'assemblyWF','jp2-create').should be_nil
+
+    it "should indicate if the specified workflow is defined in an APO object", :type =>'integration' do
+      expect(Assembly::Utils.apo_workflow_defined?(TEST_APO_OBJECT,'accessionWF')).to be true
+      expect(Assembly::Utils.apo_workflow_defined?(TEST_APO_OBJECT,'accessioning')).to be true
     end
-  
-    it "should indicate if the specified workflow is defined in an APO object" do
-      Assembly::Utils.apo_workflow_defined?(TEST_APO_OBJECT,'accessionWF').should be true
-      Assembly::Utils.apo_workflow_defined?(TEST_APO_OBJECT,'accessioning').should be true
+
+    it "should indicate if the specified workflow is not defined in an APO object", :type =>'integration' do
+      expect(Assembly::Utils.apo_workflow_defined?(TEST_APO_OBJECT,'crapsticks')).to be false
     end
 
-    it "should indicate if the specified workflow is not defined in an APO object" do
-      Assembly::Utils.apo_workflow_defined?(TEST_APO_OBJECT,'crapsticks').should be false
+    it "should indicate if the specified object is not an APO", :type =>'integration' do
+      expect{Assembly::Utils.apo_workflow_defined?(TEST_PID,'crapsticks')}.to raise_error
     end
 
-    it "should indicate if the specified object is not an APO" do
-      lambda{Assembly::Utils.apo_workflow_defined?(TEST_PID,'crapsticks')}.should raise_error 
-    end  
-  
   end
-  
-end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: assembly-utils
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.4.4
 platform: ruby
 authors:
 - Peter Mangiafico
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-23 00:00:00.000000000 Z
+date: 2015-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -157,14 +157,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -189,10 +189,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .rvmrc.example
 - Gemfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - assembly-utils.gemspec
 - bin/console

data/README.rdoc

@@ -1,57 +0,0 @@
-= Assembly Utils Gem
-
-==Overview 
-Ruby gem of methods useful for assembly and accessioning. Contains classes to manipulate DOR objects for assembly and accessioning.
-
-==Releases
-
-- 1.0.0 initial release
-- 1.0.1 bug fixes
-- 1.0.2 more bug fixes to use the new druid-tools namespace
-- 1.0.3 add a method to compute staging paths based on changes to Druid gem path computations
-- 1.0.4 add some tests and document methods
-- 1.0.5 add more spec tests and documentation; update get_staging_path method to fix a bug
-- 1.0.6 add the ability to delete workflows in the cleanup method, add a new method to fetch and delete all workflows
-- 1.0.7 add a new method to determine if a specific workflow is defined in the APO
-- 1.0.8 add methods to batch import and export objects to/from FOXML
-- 1.0.9 add spec output test data directory to git
-- 1.0.10 lowered required version of dor-services from 3.9.0 to 3.8.0
-- 1.0.11 use Dor::DigitalStacksService to calculate stacks directory to cleanup
-- 1.0.12 bugfix on call to Dor::DigitalStacksService
-- 1.0.13 update to latest lyberteam devel gems
-- 1.0.14 add new method to re-index item in solr
-- 1.1.0  small updates to some methods to depracate apo_workflow checking method
-- 1.1.1  add dor-workflow-service gem and convenience method to auto reset all objects in a specific state back to waiting
-- 1.1.2  allow reset_workflow_state to accept a state parameter 
-- 1.1.3  add a reindex method
-- 1.1.4  fixed delete object method to remove from solr too; fix cleanup object method to remove both old and new style druid trees 
-- 1.1.5 add new claim druid method
-- 1.1.6 add new step to remove workflows during cleanup_object
-- 1.1.7 change ordering of cleanup steps so if deleting workflow fails, the earlier steps will still run
-- 1.1.8 fix bug in cleanup method during symlink deletion
-- 1.1.9 add remediate-object to the workflow status report; remove some methods around robot usage that aren't needed anymore
-- 1.2.0 add a new method to return an array of druids from a CSV file which contains a "druid" column
-- 1.2.1 add a new method to insert a specific workflow into an object
-- 1.2.2 add a new method to bulk republish a list of druids, and a new parameter to datastreams bulk update to publish after updating
-- 1.2.3 add a new method to check the status of an object (is_ingested?)
-- 1.2.4 add some additional methods to check the state of an object
-- 1.2.5-1.2.7  update gemfile to newer version of dor-services gem and other related/dependent gems
-- 1.2.8 add a new constant for technical metadata filename
-- 1.4.1-2 update gems and fix typos
-
-==Running tests
-
-You will need to be on the Stanford network (not wifi) or VPNed in to run the tests, since it connects to DOR.  To run the tests
-
-bundle exec rspec spec
-
-==Deploy new gem
-
-gem build assembly-utils.gemspec
-gem push assembly-utils-1.4.1.gem # update version as needed
-
-==Connecting to DOR
-
-Some of the methods require a connection to DOR, which is not provided as part of this gem.  In order to connect to DOR, you will need
-some configuration information in your project, along with the certificates for the appropriate environment.  Connections for development DOR
-are provided as part of the gem in the 'config' directory and are used in the spec test suite.