ddr-models 2.3.2 → 2.4.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c40588942cc626434d5d5bc410f991abfa7812ef
-  data.tar.gz: 4d3493e03aabe5491942e1b25d0736e5716c8a3a
+  metadata.gz: b1f085bb5aae0c19afb4bb644fd674800bce2a9e
+  data.tar.gz: 11d41a2e56d71b9087d5cc8d7154f52c86a2f28c
 SHA512:
-  metadata.gz: c1a5295caad330a619c2c6098f02a8b1d97bceba0381dae6d0c9302529b3b12cac4429f896a4c38f06fdc5b75b69a173f59c4246b432f6f035059ef755c4240a
-  data.tar.gz: adcd58ffd35e5718ecc65aa5125c90c7930ee2b5b6061125db15c5fc41f5315f97a8e3b88a9f25369c850a3734d5357f47df954a3794ec8e94d66a737b78d37c
+  metadata.gz: 50dd901a973431067800bbbbc33f1f4b9fb2fd8f1a53eb6797132197b410bccefdf9a6f5d6d5717d6c03441e0bded2e4e0ce59e5394e929f1b26d2809194c0bc
+  data.tar.gz: 587d288987202fd4c8f9375bdd4d37e1bcc044ac11573a76d7b84730618ee2cbd234f0c4cb7e8e845ec8b69711c468ac824f5640de47822981aaa0ffaa353dac

data/.travis.yml

@@ -7,6 +7,5 @@ script: "bundle exec rake ci"
 cache:
   - bundler
   - apt
-notifications:
-  email:
-    - lib-drs@duke.edu
+env:
+  - DDR_AUX_API_URL=http://localhost:3000/api

data/ddr-models.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib", "app/models"]
 
   s.add_dependency "rails", "~> 4.1.6"
+  s.add_dependency "activeresource"
   s.add_dependency "active-fedora", "~> 7.0"
   s.add_dependency "hydra-core", "~> 7.2"
   s.add_dependency "hydra-validations", "~> 0.5"
@@ -30,7 +31,6 @@ Gem::Specification.new do |s|
   s.add_dependency "rdf-vocab", "~> 0.8"
   s.add_dependency "net-ldap", "~> 0.11"
   s.add_dependency "cancancan", "~> 1.12"
-  s.add_dependency "ddr-aux-client", "~> 1.2", ">= 1.2.2"
   s.add_dependency "ddr-antivirus", "~> 2.1.1"
 
   s.add_development_dependency "bundler", "~> 1.7"

data/lib/ddr/auth.rb

@@ -1,6 +1,7 @@
 module Ddr
   module Auth
     extend ActiveSupport::Autoload
+    extend Deprecation
 
     autoload :Ability
     autoload :AbilityDefinitions
@@ -58,22 +59,25 @@ module Ddr
 
     # Group of which everyone (including anonymous users) is a member
     def self.everyone_group
-      warn "[DEPRECATION] `Ddr::Auth.everyone_group` is deprecated." \
-           " Use `Ddr::Auth::Groups::PUBLIC` instead."
+      Deprecation.warn(Ddr::Auth,
+                       "`Ddr::Auth.everyone_group` is deprecated and will be removed in ddr-models 3.0." \
+                       " Use `Ddr::Auth::Groups::PUBLIC` instead.")
       Groups::PUBLIC
     end
 
     # Group of authenticated users
     def self.authenticated_users_group
-      warn "[DEPRECATION] `Ddr::Auth.authenticated_users_group` is deprecated." \
-           " Use `Ddr::Auth::Groups::REGISTERED` instead."
+      Deprecation.warn(Ddr::Auth,
+                       "`Ddr::Auth.authenticated_users_group` is deprecated and will be removed in ddr-models 3.0." \
+                       " Use `Ddr::Auth::Groups::REGISTERED` instead.")
       Groups::REGISTERED
     end
 
     def self.const_missing(name)
       if name == :Superuser
-        warn "[DEPRECATION] `Ddr::Auth::Superuser` is deprecated." \
-             " Use `Ddr::Auth::SuperuserAbility` instead."
+        Deprecation.warn(Ddr::Auth,
+                         "`Ddr::Auth::Superuser` is deprecated and will be removed in ddr-models 3.0." \
+                         " Use `Ddr::Auth::SuperuserAbility` instead.")
         return SuperuserAbility
       end
       super

data/lib/ddr/auth/group.rb

@@ -4,6 +4,7 @@ module Ddr
   module Auth
     # Wraps a String
     class Group < SimpleDelegator
+      extend Deprecation
 
       attr_reader :rule
 
@@ -32,7 +33,7 @@ module Ddr
       end
 
       def to_agent
-        warn "[DEPRECATION] `#{self.class.name}#to_agent` is deprecated. Use `#{self.class.name}#agent instead."
+        Deprecation.warn(self.class, "`to_agent` is deprecated. Use `agent` instead.")
         agent
       end
 

data/lib/ddr/auth/grouper_gateway.rb

@@ -4,14 +4,15 @@ require "delegate"
 module Ddr
   module Auth
     class GrouperGateway < SimpleDelegator
+      extend Deprecation
 
       SUBJECT_ID_RE = Regexp.new('[^@]+(?=@duke\.edu)')
       DEFAULT_TIMEOUT = 5
 
       def self.const_missing(name)
         if name == :REPOSITORY_GROUP_FILTER
-          warn "[DEPRECATION] The constant `#{name}` is deprecated and will be removed in ddr-models 3.0." \
-               " Use `Ddr::Auth.repository_group_filter` instead."
+          Deprecation.warn(self, "The constant `#{name}` is deprecated and will be removed in ddr-models 3.0." \
+                                 " Use `Ddr::Auth.repository_group_filter` instead.")
           return Ddr::Auth.repository_group_filter
         end
         super
@@ -47,8 +48,8 @@ module Ddr
 
       # @deprecated Use {#repository_groups} instead.
       def repository_group_names
-        warn "[DEPRECATION] `Ddr::Auth::GrouperGateway#repository_group_names` is deprecated." \
-             " Use `#repository_groups` instead."
+        Deprecation.warn(self.class, "`Ddr::Auth::GrouperGateway#repository_group_names` is deprecated." \
+                                     " Use `#repository_groups` instead.")
         repository_groups
       end
 
@@ -83,8 +84,8 @@ module Ddr
 
       # @deprecated Use {#user_groups} instead.
       def user_group_names(user)
-        warn "[DEPRECATION] `Ddr::Auth::GrouperGateway#user_group_names` is deprecated." \
-             " Use `#user_groups` instead."
+        Deprecation.warn(self.class, "`Ddr::Auth::GrouperGateway#user_group_names` is deprecated." \
+                                     " Use `#user_groups` instead.")
         user_groups(user)
       end
 

data/lib/ddr/auth/permissions.rb

@@ -1,5 +1,6 @@
 module Ddr::Auth
   class Permissions
+    extend Deprecation
 
     READ         = :read
     DOWNLOAD     = :download
@@ -14,7 +15,7 @@ module Ddr::Auth
 
     def self.const_missing(name)
       if name == :EDIT
-        warn "[DEPRECATION] `EDIT` is deprecated. Use `UPDATE` instead."
+        Deprecation.warn(self, "`EDIT` is deprecated. Use `UPDATE` instead.")
         return UPDATE
       end
       super

data/lib/ddr/auth/roles.rb

@@ -1,6 +1,7 @@
 module Ddr::Auth
   module Roles
     extend ActiveSupport::Autoload
+    extend Deprecation
 
     autoload :DetachedRoleSet
     autoload :PropertyRoleSet
@@ -20,8 +21,8 @@ module Ddr::Auth
 
       def const_missing(name)
         if name == :ArrayRoleSet
-          warn "[DEPRECATION] `Ddr::Auth::Roles::ArrayRoleSet` is deprecated." \
-               " Use `Ddr::Auth::Roles::DetachedRoleSet` instead."
+          Deprecation.warn(Ddr::Auth::Roles, "`Ddr::Auth::Roles::ArrayRoleSet` is deprecated." \
+                                             " Use `Ddr::Auth::Roles::DetachedRoleSet` instead.")
           DetachedRoleSet
         else
           super

data/lib/ddr/auth/roles/role_set.rb

@@ -1,5 +1,6 @@
 module Ddr::Auth
   module Roles
+    extend Deprecation
     #
     # Wraps a set of Roles
     #
@@ -21,8 +22,8 @@ module Ddr::Auth
       end
 
       def granted
-        warn "[DEPRECATION] `granted` is deprecated." \
-             " Use the RoleSet object directly (#{caller.first})."
+        Deprecation.warn(self.class, "`granted` is deprecated." \
+                                     " Use the RoleSet object directly.")
         self
       end
 

data/lib/ddr/datastreams/administrative_metadata_datastream.rb

@@ -46,6 +46,9 @@ module Ddr
       property :ead_id,
                predicate: Ddr::Vocab::Asset.eadId
 
+      property :aspace_id,
+               predicate: Ddr::Vocab::Asset.archivesSpaceId
+
     end
   end
 end

data/lib/ddr/derivatives/png_generator.rb

@@ -9,7 +9,7 @@ module Ddr
       end
 
       def generate
-        command = "convert #{Ddr::Utils.file_path(source)} #{options} png:#{Ddr::Utils.file_path(output)}"
+        command = "convert #{Ddr::Utils.file_path(source)}[0] #{options} png:#{Ddr::Utils.file_path(output)}"
         out, err, s = Open3.capture3(command)
         GeneratorResult.new(out, err, s)
       end

data/lib/ddr/index/fields.rb

@@ -1,7 +1,16 @@
 module Ddr::Index
   module Fields
+    extend Deprecation
 
-    include LegacyLicenseFields
+    def self.const_missing(name)
+      if const = LegacyLicenseFields.const_get(name)
+        Deprecation.warn(Ddr::Index::Fields,
+                         "The constant `#{name}` is deprecated and will be removed in ddr-models 3.0.")
+        const
+      else
+        super
+      end
+    end
 
     def self.get(name)
       const_get(name.to_s.upcase, false)
@@ -20,6 +29,7 @@ module Ddr::Index
     ACTIVE_FEDORA_MODEL         = Field.new :active_fedora_model, :stored_sortable
     ADMIN_SET                   = Field.new :admin_set, :stored_sortable
     ADMIN_SET_FACET             = Field.new :admin_set_facet, :facetable
+    ASPACE_ID                   = Field.new :aspace_id, :stored_sortable
     BOX_NUMBER_FACET            = Field.new :box_number_facet, :facetable
     COLLECTION_FACET            = Field.new :collection_facet, :facetable
     COLLECTION_URI              = Field.new :collection_uri, :symbol

data/lib/ddr/index/filter.rb

@@ -13,10 +13,11 @@ module Ddr::Index
 
     def where(conditions)
       clauses = conditions.map do |field, value|
-        if value.respond_to?(:each)
-          QueryClause.or_values(field, *value)
+        values = Array(value)
+        if values.size > 1
+          QueryClause.or_values(field, values)
         else
-          QueryClause.term(field, value)
+          QueryClause.term(field, values.first)
         end
       end
       raw *clauses

data/lib/ddr/index/legacy_license_fields.rb

@@ -1,8 +1,6 @@
 module Ddr::Index
   module LegacyLicenseFields
 
-    warn "[DEPRECATION] `Ddr::Index::LegacyLicenseFields` is deprecated and will be removed from ddr-models 3.0."
-
     DEFAULT_LICENSE_DESCRIPTION = Field.new :default_license_description, type: :string
     DEFAULT_LICENSE_TITLE       = Field.new :default_license_title, type: :string
     DEFAULT_LICENSE_URL         = Field.new :default_license_url, type: :string

data/lib/ddr/index/query_clause.rb

@@ -29,8 +29,8 @@ module Ddr::Index
         negative field, PRESENT
       end
 
-      def or_values(field, *values)
-        build field, QueryValue.or_values(*values)
+      def or_values(field, values)
+        build field, QueryValue.or_values(values)
       end
 
       def before(field, date_time)

data/lib/ddr/index/query_value.rb

@@ -6,9 +6,12 @@ module Ddr::Index
         RSolr.solr_escape(value)
       end
 
-      def or_values(*values)
-        value = values.map { |v| build(v) }.join(" OR ")
-        "(#{value})"
+      # @param values [Enumerable<String>]
+      def or_values(values)
+        unless values.is_a?(::Enumerable) && values.present?
+          raise ArgumentError, "`#{self.name}.or_values` requires a non-empty enumerable of strings."
+        end
+        "(%s)" % values.map { |value| build(value) }.join(" OR ")
       end
     end
 

data/lib/ddr/jobs.rb

@@ -2,8 +2,12 @@ module Ddr
   module Jobs
     extend ActiveSupport::Autoload
 
-    autoload :PermanentId
     autoload :FitsFileCharacterization
+    autoload :FixityCheck
+    autoload :Job
+    autoload :PermanentId
+    autoload :Queue
+    autoload :UpdateIndex
 
     autoload_at 'ddr/jobs/permanent_id' do
       autoload :MakeUnavailable

data/lib/ddr/jobs/fits_file_characterization.rb

@@ -1,50 +1,12 @@
-require 'open3'
-
 module Ddr::Jobs
   class FitsFileCharacterization
+    extend Job
 
     @queue = :file_characterization
 
-    EVENT_SUMMARY = 'FITS characterization of content file'.freeze
-
     def self.perform(pid)
       obj = ActiveFedora::Base.find(pid)
-      tmp_filename = Ddr::Utils::sanitize_filename(obj.original_filename) || obj.content.default_file_name
-      Dir.mktmpdir(nil, Ddr::Models.tempdir) do |dir|
-        infile = create_temp_infile(dir, tmp_filename, obj.content.content)
-        fits_output, err, status = Open3.capture3(fits_command, '-i', infile)
-        if status.success? && fits_output.present?
-          obj.reload
-          obj.fits.content = fits_output
-          obj.save!
-        end
-        notify_event(pid, err, status)
-      end
-    end
-
-    def self.fits_command
-      File.join(Ddr::Models.fits_home, 'fits.sh')
-    end
-
-    def self.fits_version
-      `#{fits_command} -v`.strip
-    end
-
-    private
-
-    def self.create_temp_infile(dir, tmp_filename, content)
-      temp_infile = File.join(dir, tmp_filename)
-      File.open(temp_infile, 'wb') do |f|
-        f.write content
-      end
-      temp_infile
-    end
-
-    def self.notify_event(pid, err, status)
-      details = status.success? ? nil : err
-      event_args = { pid: pid, summary: EVENT_SUMMARY, software:  "fits #{fits_version}", detail: details }
-      event_args[:outcome] = status.success? ? Ddr::Events::Event::SUCCESS : Ddr::Events::Event::FAILURE
-      Ddr::Notifications.notify_event(:update, event_args)
+      Ddr::Models::FileCharacterization.call(obj)
     end
 
   end

data/lib/ddr/jobs/fixity_check.rb

@@ -0,0 +1,13 @@
+module Ddr::Jobs
+  class FixityCheck
+    extend Job
+
+    @queue = :fixity
+
+    def self.perform(id)
+      obj = ActiveFedora::Base.find(id)
+      obj.fixity_check
+    end
+
+  end
+end

data/lib/ddr/jobs/job.rb

@@ -0,0 +1,36 @@
+require "resque"
+
+module Ddr::Jobs
+  module Job
+
+    def self.extended(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      # @return [Array<String>] list of object ids queued for this job type.
+      # @note Assumes that the object_id is the first argument of the .perform method.
+      def queued_object_ids(**args)
+        args[:type] = self
+        __queue__.jobs(**args).map { |job| job["args"].first }
+      end
+
+      protected
+
+      def method_missing(name, *args, &block)
+        # If .queue method not defined, do the right thing
+        if name == :queue
+          return Resque.queue_from_class(self)
+        end
+        super
+      end
+
+      private
+
+      def __queue__
+        Queue.new(queue)
+      end
+    end
+
+  end
+end

data/lib/ddr/jobs/queue.rb

@@ -0,0 +1,27 @@
+require "resque"
+
+module Ddr::Jobs
+  class Queue
+
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def size
+      Resque.size(name)
+    end
+
+    # @return [Array<Hash>] jobs in the queue, optionally filtered by type,
+    #   start position, and count.
+    def jobs(type: nil, start: 0, count: nil)
+      jobs = Resque.peek(name, start, count || size)
+      if type
+        jobs.select! { |job| job["class"] == type.to_s }
+      end
+      jobs
+    end
+
+  end
+end

data/lib/ddr/jobs/update_index.rb

@@ -0,0 +1,13 @@
+module Ddr::Jobs
+  class UpdateIndex
+    extend Job
+
+    @queue = :index
+
+    def self.perform(id)
+      obj = ActiveFedora::Base.find(id)
+      obj.update_index
+    end
+
+  end
+end