ddr-models 3.0.0.alpha.2 → 3.0.0.alpha.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5e64a6ea529a126ced98548f47347d51f25beb2
-  data.tar.gz: f8e1c3cc8ee4fdc79c1bdb3a3ae936c56074e1be
+  metadata.gz: 5ba4e9d42e6784bc59cf386c341006539ff072f1
+  data.tar.gz: 88c2d6e6589785a20228e615a287d8f334cc98f3
 SHA512:
-  metadata.gz: ae6350545f2458891a4bae2baa5ead197a42cec54c3b2c7d5fbd4159a54e4a472e76bda1d667f4c86d8cb6a5a5c06bd36809dacf602310dab7d3143075d1f1b9
-  data.tar.gz: 139e3ea27a1b2e105054d3ce7cc9fb26599004eddeafa7ca591fd3382d336e584e4ebbd1a2bc4463a936a8444bfe65d3203257ad9dcc88dd4ec9959b2eecf696
+  metadata.gz: 41e9ebf75006154ba347dd5fdbc91c44b835990eb46f920c004ce16aed1e9d8637c935d94a4bc1afb4f9924b6ada95da5da6be8e77606fb5bd0251caa69f08a5
+  data.tar.gz: 3959dc747ad83c854ef084b25843177e43601273fd6954aea81a7974730802662230f362e000ddfcc27ab80f75965fa238b932b444f377ca2f8d820d05944fb4

data/.travis.yml

@@ -1,12 +1,15 @@
 language: ruby
 before_install:
   - sudo apt-get install libvips-dev
+  - gem install bundler --version "~> 1.10"
 rvm:
-  - 2.1
+  - 2.1.5
 script: "bundle exec rake ci"
 cache:
-  - bundler
   - apt
 notifications:
   email:
     - lib-drs@duke.edu
+bundler_args: --without production
+jdk:
+  - oraclejdk8

data/lib/ddr/actions/fixity_check.rb

@@ -11,19 +11,22 @@ module Ddr
 
       # Return result of fixity check
       def self._execute(object)
-        Result.new(pid: object.pid).tap do |r|
+        Result.new(id: object.id).tap do |r|
           object.datastreams_to_validate.each do |dsid, ds|
-            r.success &&= ds.dsChecksumValid
-            r.results[dsid] = ds.profile
+            # r.success &&= ds.dsChecksumValid
+            # r.results[dsid] = ds.profile
+            checksum_valid = ds.check_fixity
+            r.success &&= checksum_valid
+            r.results[dsid] = { 'checksum_valid' => checksum_valid }
           end
         end
       end
 
       class Result
-        attr_accessor :pid, :success, :results, :checked_at
+        attr_accessor :id, :success, :results, :checked_at
 
         def initialize(args={})
-          @pid = args[:pid]
+          @id = args[:id]
           @success = args[:success] || true
           @results = args[:results] || {}
           @checked_at = args[:checked_at] || Time.now.utc

data/lib/ddr/auth/ability_definitions/role_based_ability_definitions.rb

@@ -19,7 +19,7 @@ module Ddr
       def permissions(obj)
         case obj
         when Ddr::Models::Base, SolrDocument
-          cached_permissions obj.pid do
+          cached_permissions obj.id do
             obj.effective_permissions(agents)
           end
         when String

data/lib/ddr/auth/grouper_gateway.rb

@@ -1,70 +1,68 @@
 require 'grouper-rest-client'
 require "delegate"
 
-module Ddr
-  module Auth
-    class GrouperGateway < SimpleDelegator
+module Ddr::Auth
+  class GrouperGateway < SimpleDelegator
 
-      SUBJECT_ID_RE = Regexp.new('[^@]+(?=@duke\.edu)')
-      DEFAULT_TIMEOUT = 5
+    SUBJECT_ID_RE = Regexp.new('[^@]+(?=@duke\.edu)')
+    DEFAULT_TIMEOUT = 5
 
-      def self.repository_groups(*args)
-        new.repository_groups(*args)
-      end
+    def self.repository_groups(*args)
+      new.repository_groups(*args)
+    end
 
-      def self.user_groups(*args)
-        new.user_groups(*args)
-      end
-      
-      def initialize
-        super Grouper::Rest::Client::Resource.new(ENV["GROUPER_URL"],
-                                                  user: ENV["GROUPER_USER"],
-                                                  password: ENV["GROUPER_PASSWORD"],
-                                                  timeout: ENV.fetch("GROUPER_TIMEOUT", DEFAULT_TIMEOUT).to_i)
-      end
+    def self.user_groups(*args)
+      new.user_groups(*args)
+    end
 
-      # List of all grouper groups for the repository
-      def repository_groups(raw = false)
-        repo_groups = groups(REPOSITORY_GROUP_FILTER)
-        if ok?
-          return repo_groups if raw
-          repo_groups.map do |g|
-            Group.new(g["name"], label: g["displayExtension"])
-          end
-        else
-          []
+    def initialize
+      super Grouper::Rest::Client::Resource.new(ENV["GROUPER_URL"],
+                                                user: ENV["GROUPER_USER"],
+                                                password: ENV["GROUPER_PASSWORD"],
+                                                timeout: ENV.fetch("GROUPER_TIMEOUT", DEFAULT_TIMEOUT).to_i)
+    end
+
+    # List of all grouper groups for the repository
+    def repository_groups(raw = false)
+      repo_groups = groups(Ddr::Auth.repository_group_filter)
+      if ok?
+        return repo_groups if raw
+        repo_groups.map do |g|
+          Group.new(g["name"], label: g["displayExtension"])
         end
+      else
+        []
       end
+    end
 
-      def user_groups(user, raw = false)
-        groups = []
-        subject_id = user.principal_name.scan(SUBJECT_ID_RE).first
-        return groups unless subject_id
-        begin
-          request_body = {
-            "WsRestGetGroupsRequest" => {
-              "subjectLookups" => [{"subjectIdentifier" => subject_id}]
-            }
+    def user_groups(user, raw = false)
+      groups = []
+      subject_id = user.principal_name.scan(SUBJECT_ID_RE).first
+      return groups unless subject_id
+      begin
+        request_body = {
+          "WsRestGetGroupsRequest" => {
+            "subjectLookups" => [{"subjectIdentifier" => subject_id}]
           }
-          # Have to use :call b/c grouper-rest-client :subjects method doesn't support POST
-          response = call("subjects", :post, request_body)
-          if ok?
-            result = response["WsGetGroupsResults"]["results"].first
-            # Have to manually filter results b/c Grouper WS version 1.5 does not support filter parameter
-            if result && result["wsGroups"]
-              groups = result["wsGroups"].select { |g| g["name"] =~ /^#{REPOSITORY_GROUP_FILTER}/ }
-            end
+        }
+        # Have to use :call b/c grouper-rest-client :subjects method doesn't support POST
+        response = call("subjects", :post, request_body)
+        if ok?
+          result = response["WsGetGroupsResults"]["results"].first
+          # Have to manually filter results b/c Grouper WS version 1.5 does not support filter parameter
+          if result && result["wsGroups"]
+            groups = result["wsGroups"].select { |g| g["name"] =~ /^#{REPOSITORY_GROUP_FILTER}/ }
           end
-        rescue StandardError => e
-          # XXX Should we raise a custom exception?
-          Rails.logger.error e
-        end
-        return groups if raw
-        groups.map do |g|
-          Group.new(g["name"], label: g["displayExtension"])
         end
+      rescue StandardError => e
+        # XXX Should we raise a custom exception?
+        Rails.logger.error e
+      end
+      return groups if raw
+      groups.map do |g|
+        Group.new(g["name"], label: g["displayExtension"])
       end
-
     end
+
   end
 end

data/lib/ddr/datastreams/datastream_behavior.rb

@@ -1,83 +1,82 @@
-module Ddr
-  module Datastreams
-    module DatastreamBehavior
+module Ddr::Datastreams
+  module DatastreamBehavior
+    extend Deprecation
 
-      DEFAULT_FILE_EXTENSION = "bin"
-      STRFTIME_FORMAT = "%Y-%m-%dT%H:%M:%S.%LZ"
+    DEFAULT_FILE_EXTENSION = "bin"
+    STRFTIME_FORMAT = "%Y-%m-%dT%H:%M:%S.%LZ"
 
-      def dsid
-        warn "[DEPRECATION] `dsid` is no longer a datastream/file method." \
-             " Use `File.basename(id)`."
-        if id
-          ::File.basename(id)
-        end
+    def dsid
+      Deprecation.warn(DatastreamBehavior,
+                       "`dsid` is no longer a datastream/file method. Use `File.basename(id)`.")
+      if id
+        ::File.basename(id)
       end
+    end
 
-      def dsCreateDate
-        warn "[DEPRECATION] `dsCreateDate` is no longer a datastream/file method." \
-             " Use `create_date` instead."
-        create_date
-      end
+    def dsCreateDate
+      Deprecation.warn(DatastreamBehavior,
+                       "`dsCreateDate` is no longer a datastream/file method. Use `create_date` instead.")
+      create_date
+    end
 
-      def validate_checksum!(checksum_value, checksum_type=nil)
-        raise Ddr::Models::Error, "Checksum cannot be validated on new datastream." if new_record?
-        raise Ddr::Models::Error, "Checksum cannot be validated on unpersisted content." if content_changed?
-        raise Ddr::Models::ChecksumInvalid, "The repository internal checksum validation failed." unless check_fixity
-        algorithm = checksum_type || checksum.algorithm
-        calculated_checksum = if algorithm == checksum.algorithm
-                                checksum.value
-                              else
-                                content_digest(algorithm)
-                              end
-        if checksum_value == calculated_checksum
-          "The checksum #{algorithm}:#{checksum_value} is valid for datastream #{dsid}."
-        else
-          raise Ddr::Models::ChecksumInvalid, "The checksum #{algorithm}:#{checksum_value} is not valid for datastream #{dsid}."
-        end
+    def validate_checksum!(checksum_value, checksum_type=nil)
+      raise Ddr::Models::Error, "Checksum cannot be validated on new datastream." if new_record?
+      raise Ddr::Models::Error, "Checksum cannot be validated on unpersisted content." if content_changed?
+      raise Ddr::Models::ChecksumInvalid, "The repository internal checksum validation failed." unless check_fixity
+      algorithm = checksum_type || checksum.algorithm
+      calculated_checksum = if algorithm == checksum.algorithm
+                              checksum.value
+                            else
+                              content_digest(algorithm)
+                            end
+      if checksum_value == calculated_checksum
+        "The checksum #{algorithm}:#{checksum_value} is valid for datastream #{dsid}."
+      else
+        raise Ddr::Models::ChecksumInvalid, "The checksum #{algorithm}:#{checksum_value} is not valid for datastream #{dsid}."
       end
+    end
 
-      def create_date_string
-        dsCreateDate.strftime(STRFTIME_FORMAT) if dsCreateDate
-      end
+    def create_date_string
+      dsCreateDate.strftime(STRFTIME_FORMAT) if dsCreateDate
+    end
 
-      def content_digest(algorithm)
-        Ddr::Utils.digest(content, algorithm)
-      end
+    def content_digest(algorithm)
+      Ddr::Utils.digest(content, algorithm)
+    end
 
-      # Return default file extension for datastream based on MIME type
-      def default_file_extension
-        mimetypes = MIME::Types[mime_type]
-        return mimetypes.first.extensions.first unless mimetypes.empty?
-        case mime_type
-        when 'application/n-triples'
-          'txt'
-        else
-          DEFAULT_FILE_EXTENSION
-        end
+    # Return default file extension for datastream based on MIME type
+    def default_file_extension
+      mimetypes = MIME::Types[mime_type]
+      return mimetypes.first.extensions.first unless mimetypes.empty?
+      case mime_type
+      when 'application/n-triples'
+        'txt'
+      else
+        DEFAULT_FILE_EXTENSION
       end
+    end
 
-      def default_file_prefix
-        (id && id.gsub(/\//, "_")) || "NEW"
-      end
+    def default_file_prefix
+      (id && id.gsub(/\//, "_")) || "NEW"
+    end
 
-      # Return default file name
-      def default_file_name
-        [ default_file_prefix, default_file_extension ].join(".")
-      end
+    # Return default file name
+    def default_file_name
+      [ default_file_prefix, default_file_extension ].join(".")
+    end
 
-      def tempfile(prefix: nil, suffix: nil)
-        if empty?
-          raise Ddr::Models::Error, "Refusing to create tempfile for empty datastream!"
-        end
-        prefix ||= default_file_prefix + "--"
-        suffix ||= "." + default_file_extension
-        Tempfile.open [prefix, suffix], encoding: Encoding::ASCII_8BIT do |f|
-          f.write(content)
-          f.close
-          yield f
-        end
+    def tempfile(prefix: nil, suffix: nil)
+      if empty?
+        raise Ddr::Models::Error, "Refusing to create tempfile for empty datastream!"
+      end
+      prefix ||= default_file_prefix + "--"
+      suffix ||= "." + default_file_extension
+      Tempfile.open [prefix, suffix], encoding: Encoding::ASCII_8BIT do |f|
+        f.write(content)
+        f.close
+        yield f
       end
-
     end
+
   end
 end

data/lib/ddr/events/event.rb

@@ -45,7 +45,7 @@ module Ddr
       # Scopes
 
       def self.for_object(obj)
-        for_pid(obj.pid)
+        for_pid(obj.id)
       end
 
       def self.for_pid(pid)
@@ -92,7 +92,7 @@ module Ddr
 
       def object=(obj)
         raise ArgumentError, "Can't set to new object" if obj.new_record?
-        self.pid = obj.pid
+        self.pid = obj.id
         @object = obj
       end
 

data/lib/ddr/events/fixity_check_event.rb

@@ -17,10 +17,11 @@ module Ddr
         result = notification.payload[:result] # FixityCheck::Result instance
         detail = [DETAIL_PREAMBLE]
         result.results.each do |dsid, dsProfile|
-          validation = dsProfile["dsChecksumValid"] ? VALID : INVALID
+          # validation = dsProfile["dsChecksumValid"] ? VALID : INVALID
+          validation = dsProfile["checksum_valid"] ? VALID : INVALID
           detail << DETAIL_TEMPLATE % {dsid: dsid, validation: validation}
         end
-        create(pid: result.pid,
+        create(pid: result.id,
                event_date_time: notification.time,
                outcome: result.success ? SUCCESS : FAILURE,
                detail: detail.join("\n")

data/lib/ddr/index/fields.rb

@@ -18,6 +18,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
+    ATTACHED_FILES              = Field.new :attached_files, solr_name: "attached_files_ss"
     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/managers/derivatives_manager.rb

@@ -19,7 +19,7 @@ module Ddr
             # - object already has this derivative (need to delete or replace it)
             # - the derivative can be generated for this object
           if derivative.class.has_derivative?(object) || derivative.class.generatable?(object)
-            schedule == SCHEDULE_NOW ? update_derivative(derivative) : Resque.enqueue(DerivativeJob, object.pid, derivative_to_update)
+            schedule == SCHEDULE_NOW ? update_derivative(derivative) : Resque.enqueue(DerivativeJob, object.id, derivative_to_update)
           end
         end
       end
@@ -38,7 +38,7 @@ module Ddr
 
       def generate_derivative(derivative)
         ActiveSupport::Notifications.instrument(Ddr::Notifications::UPDATE,
-                                                pid: object.pid,
+                                                pid: object.id,
                                                 summary: "Generate #{derivative.class.name} derivative"
                                                 ) do |payload|
           derivative.generate!(object)
@@ -47,7 +47,7 @@ module Ddr
 
       def delete_derivative(derivative)
         ActiveSupport::Notifications.instrument(Ddr::Notifications::UPDATE,
-                                                pid: object.pid,
+                                                pid: object.id,
                                                 summary: "Delete derivative #{derivative.class.name}"
                                                 ) do |payload|
           derivative.delete!(object)

data/lib/ddr/managers/permanent_id_manager.rb

@@ -21,13 +21,13 @@ module Ddr
       end
 
       def assign_later
-        Resque.enqueue(AssignmentJob, object.pid)
+        Resque.enqueue(AssignmentJob, object.id)
       end
 
       def assign
         raise Ddr::Models::Error, "Permanent ID already assigned." if object.permanent_id
         ActiveSupport::Notifications.instrument(Ddr::Notifications::UPDATE,
-                                                pid: object.pid,
+                                                pid: object.id,
                                                 software: SOFTWARE,
                                                 summary: ASSIGN_EVENT_SUMMARY
                                                 ) do |payload|

data/lib/ddr/models.rb

@@ -32,6 +32,8 @@ module Ddr
 
     autoload :AccessControllable
     autoload :AdminSet
+    autoload :AttachedFileProfile
+    autoload :AttachedFilesProfile
     autoload :Base
     autoload :ChecksumInvalid, 'ddr/models/error'
     autoload :ContentModelError, 'ddr/models/error'
@@ -51,9 +53,11 @@ module Ddr
     autoload :HasStructMetadata
     autoload :HasThumbnail
     autoload :Indexing
+    autoload :ObjectApi
     autoload :SolrDocument
     autoload :StructDiv
     autoload :Structure
+    autoload :UrlSafeId
     autoload :YearFacet
 
     autoload_under "licenses" do
@@ -67,8 +71,7 @@ module Ddr
     autoload_under "metadata" do
       autoload :DescriptiveMetadata
       autoload :Metadata
-      autoload :MetadataMapper
-      autoload :MetadataMappers
+      autoload :MetadataMapping
       autoload :MetadataTerm
       autoload :MetadataVocabulary
       autoload :MetadataVocabularies