ddr-models 2.0.1 → 2.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da77038c15e029fe70bc14ba3b2fa9013606e66a
-  data.tar.gz: 59a3733d31c8cf61c4d4fe680037ae57a343cb0e
+  metadata.gz: cb4f77d35e8d4b3d23267f2f32b6176f935d547d
+  data.tar.gz: 15ac1cebb4342dde18d4e8bfab92749c69805add
 SHA512:
-  metadata.gz: 8d63141d8f4cda552f720a20887419c90beb1a2e41b5b6c5bee08fda01d259b2286b85af4a45caa93576371d3498613d55a9d12cae2999dc97c278bf0cd37454
-  data.tar.gz: 131bd338a0a2190c604ce92b945f2e2a220f2beadbd94fe442e1b93a6435f1ab9d8c52a51ab6ebc377014315bbc47316ce81eea5fd285a37106d6eba50f6a7b6
+  metadata.gz: 706dafc8320ac5bf5ae153fc963368c143b2a7ad0dbac3a1155751102b3398016a575dc4449c46753bdc45a568ff6872fe5d3526e21323cc0d15c7207af504f5
+  data.tar.gz: 0309ef94db398e32ec350c0671108e5d5cca3406ad65ab71325da2eddc0581e3d7e788dee29767381b875859c204d5b5a705cee8b73ebee907f4789a36ce7462

data/README.md

@@ -23,7 +23,6 @@ ddr-models has several runtime dependencies that are independently configurable:
 
 - [active_fedora](https://github.com/projecthydra/active_fedora)
 - [hydra-head](https://github.com/projecthydra/hydra-head)
-- [ddr-antivirus](https://github.com/duke-libraries/ddr-antivirus)
 - [devise](https://github.com/plataformatec/devise)
 - [omniauth-shibboleth](https://github.com/toyokazu/omniauth-shibboleth)
 - [ezid-client](https://github.com/duke-libaries/ezid-client)
@@ -36,23 +35,18 @@ ddr-models configuration options:
 
 #### User model
 
-Include `Ddr::Auth::User` in `app/models/user.rb` and remove content inserted by Hydra, Blacklight and Devise generators:
+Include `Ddr::Auth::User` in `app/models/user.rb` and remove content inserted by Hydra and Devise generators:
 
 ```ruby
 class User
   include Ddr::Auth::User
   #
-  # Remove content inserted by Hydra, Blacklight, or Devise generators --
-  # it's provided by Ddr::Auth::User.
-  #
-  # include Blacklight::User
+  # REMOVE:
   # include Hydra::User
   # devise :database_authenticatable [...]
   #
-  # ... as well as any methods.
-  #
-  # You can add custom methods for the app as needed.
-  #
+  # DO NOT REMOVE:
+  # Blacklight::User
 end
 ```
 
@@ -71,20 +65,28 @@ Change the class like so:
 ```ruby
 class Ability < Ddr::Auth::Ability
   #
-  # Ddr::Auth::Ability includes Hydra::PolicyAwareAbility
+  # REMOVE:
   # include Hydra::Ability
   #
-  # Add custom methods here as needed to Ability.ability_logic:
-  #
-  # self.ability_logic += [:my_ability]
+  # Add "ability definitions" -- i.e., subclasses of Ddr::Auth::AbilityDefinitions.
   #
-  # def my_ability
-  #   # whatever
-  # end
+  # self.ability_definitions += [ ... ]
   #
 end
 ```
 
+#### Controller
+
+`Ddr::Auth::RoleBasedAccessControlsEnforcement` overrides `current_ability`, `gated_discovery_filters` and `enforce_show_permissions`, so most likely it should be included in `ApplicationController`.
+
+```ruby
+class ApplicationController < ActionController::Base
+
+  include Ddr::Auth::RoleBasedAccessControlsEnforcement
+
+end
+```
+
 #### SolrDocument model
 
 Include `Ddr::Models::SolrDocument` in `app/models/solr_document.rb`
@@ -100,6 +102,10 @@ class SolrDocument
 end
 ```
 
+#### Auxiliary Web Services
+
+In order to use the auxiliary web services, set the `DDR_AUX_API_URL` environment variable.  You may wish to install the [ddr-aux](https://github.com/duke-libraries/ddr-aux) app locally and run it.
+
 #### Migrations
 
 Install the ddr-models migrations:

data/app/models/collection.rb

@@ -8,21 +8,6 @@ class Collection < Ddr::Models::Base
   include Ddr::Models::HasChildren
   include Ddr::Models::HasAttachments
 
-  has_attributes :default_license_title,
-    datastream: Ddr::Datastreams::DEFAULT_RIGHTS,
-    at: [:license, :title],
-    multiple: false
-
-  has_attributes :default_license_description,
-    datastream: Ddr::Datastreams::DEFAULT_RIGHTS,
-    at: [:license, :description],
-    multiple: false
-
-  has_attributes :default_license_url,
-    datastream: Ddr::Datastreams::DEFAULT_RIGHTS,
-    at: [:license, :url],
-    multiple: false
-
   has_many :children, property: :is_member_of_collection, class_name: 'Item'
   has_many :targets, property: :is_external_target_for, class_name: 'Target'
 
@@ -37,31 +22,12 @@ class Collection < Ddr::Models::Base
   #
   # @return A lazy enumerator of SolrDocuments.
   def components_from_solr
-    query = "#{Ddr::IndexFields::COLLECTION_URI}:#{RSolr.solr_escape(internal_uri)}"
+    query = "#{Ddr::Index::Fields::COLLECTION_URI}:#{RSolr.solr_escape(internal_uri)}"
     filter = ActiveFedora::SolrService.construct_query_for_rel(:has_model => Component.to_class_uri)
     results = ActiveFedora::SolrService.query(query, fq: filter, rows: 100000)
     results.lazy.map {|doc| SolrDocument.new(doc)}
   end
 
-  # Returns the license attributes provided as default values for objects
-  # governed by the Collection.
-  #
-  # @return [Hash] the attributes, `:title`, `:description`, and `:url`.
-  def default_license
-    if default_license_title.present? or default_license_description.present? or default_license_url.present?
-      {title: default_license_title, description: default_license_description, url: default_license_url}
-    end
-  end
-
-  # Sets the default license attributes for objects governed by the Collection.
-  def default_license=(new_license)
-    raise ArgumentError unless new_license.is_a?(Hash) # XXX don't do this - not duck-typeable
-    l = new_license.with_indifferent_access
-    self.default_license_title = l[:title]
-    self.default_license_description = l[:description]
-    self.default_license_url = l[:url]
-  end
-
   # Returns a list of entities (either users or groups) having a default access
   # level on objects governed by the Collection.
   #

data/ddr-models.gemspec

@@ -22,7 +22,6 @@ Gem::Specification.new do |s|
   s.add_dependency "active-fedora", "~> 7.0"
   s.add_dependency "hydra-core", "~> 7.2"
   s.add_dependency "hydra-validations", "~> 0.5"
-  s.add_dependency "ddr-antivirus", "~> 1.3.1"
   s.add_dependency "devise", "~> 3.4"
   s.add_dependency "omniauth-shibboleth", "~> 1.2.0"
   s.add_dependency "grouper-rest-client"
@@ -31,6 +30,8 @@ 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.1"
+  s.add_dependency "ddr-antivirus", "2.0.0"
 
   s.add_development_dependency "bundler", "~> 1.7"
   s.add_development_dependency "rake"

data/lib/ddr/actions.rb

@@ -3,6 +3,7 @@ module Ddr
     extend ActiveSupport::Autoload
 
     autoload :FixityCheck
+    autoload :VirusCheck
 
   end
 end

data/lib/ddr/actions/virus_check.rb

@@ -0,0 +1,28 @@
+require "open3"
+require "ostruct"
+require "shellwords"
+
+module Ddr::Actions
+  class VirusCheck
+
+    # @return [Hash] result data
+    # @raises [Ddr::Antivirus::VirusFoundError]
+    def self.call(file_path)
+      unless File.exist?(file_path)
+        raise Error, "File not found: #{file_path}"
+      end
+      result = {}
+      begin
+        scan_result = Ddr::Antivirus.scan(file_path)
+      rescue Ddr::Antivirus::ScannerError => e
+        result[:exception] = [e.class.name, e.to_s]
+        scan_result = e.result
+      end
+      result[:event_date_time] = scan_result.scanned_at
+      result[:software]        = scan_result.version
+      result[:detail]          = scan_result.output
+      result
+    end
+
+  end
+end

data/lib/ddr/auth.rb

@@ -102,5 +102,9 @@ module Ddr
       "::Ability"
     end
 
+    mattr_accessor :repository_group_filter do
+      ENV["REPOSITORY_GROUP_FILTER"]
+    end
+
   end
 end

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

@@ -8,11 +8,13 @@ module Ddr
       # Datastreams not listed cannot be downloaded, except of
       # course by the :manage ability.
       DATASTREAM_DOWNLOAD_ABILITIES = {
-        Ddr::Datastreams::CONTENT        => :download,
-        Ddr::Datastreams::DESC_METADATA  => :read,
-        Ddr::Datastreams::EXTRACTED_TEXT => :read,
-        Ddr::Datastreams::MULTIRES_IMAGE => :read,
-        Ddr::Datastreams::THUMBNAIL      => :read,
+        Ddr::Datastreams::CONTENT         => :download,
+        Ddr::Datastreams::DESC_METADATA   => :read,
+        Ddr::Datastreams::EXTRACTED_TEXT  => :download,
+        Ddr::Datastreams::FITS            => :read,
+        Ddr::Datastreams::MULTIRES_IMAGE  => :read,
+        Ddr::Datastreams::STRUCT_METADATA => :read,
+        Ddr::Datastreams::THUMBNAIL       => :read,
       }.freeze
 
       def call

data/lib/ddr/auth/grouper_gateway.rb

@@ -5,10 +5,18 @@ module Ddr
   module Auth
     class GrouperGateway < SimpleDelegator
 
-      REPOSITORY_GROUP_FILTER = "duke:library:repository:ddr:"
       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."
+          return Ddr::Auth.repository_group_filter
+        end
+        super
+      end
+
       def self.repository_groups(*args)
         new.repository_groups(*args)
       end

data/lib/ddr/auth/permissions.rb

@@ -7,9 +7,10 @@ module Ddr::Auth
     UPDATE       = :update
     REPLACE      = :replace
     ARRANGE      = :arrange
+    AUDIT        = :audit
     GRANT        = :grant
 
-    ALL = [ READ, DOWNLOAD, ADD_CHILDREN, UPDATE, REPLACE, ARRANGE, GRANT ]
+    ALL = [ READ, DOWNLOAD, ADD_CHILDREN, UPDATE, REPLACE, ARRANGE, AUDIT, GRANT ]
 
     def self.const_missing(name)
       if name == :EDIT

data/lib/ddr/auth/role_based_access_controls_enforcement.rb

@@ -21,11 +21,11 @@ module Ddr
       def policy_role_policies
         @policy_role_policies ||= Array.new.tap do |uris|
           filters = current_ability.agents.map do |agent|
-            "#{Ddr::IndexFields::POLICY_ROLE}:\"#{agent}\""
+            "#{Ddr::Index::Fields::POLICY_ROLE}:\"#{agent}\""
           end.join(" OR ")
-          query = "#{Ddr::IndexFields::ACTIVE_FEDORA_MODEL}:Collection AND (#{filters})"
-          results = ActiveFedora::SolrService.query(query, rows: Collection.count, fl: Ddr::IndexFields::INTERNAL_URI)
-          results.each_with_object(uris) { |r, memo| memo << r[Ddr::IndexFields::INTERNAL_URI] }
+          query = "#{Ddr::Index::Fields::ACTIVE_FEDORA_MODEL}:Collection AND (#{filters})"
+          results = ActiveFedora::SolrService.query(query, rows: Collection.count, fl: Ddr::Index::Fields::INTERNAL_URI)
+          results.each_with_object(uris) { |r, memo| memo << r[Ddr::Index::Fields::INTERNAL_URI] }
         end
       end
 
@@ -38,7 +38,7 @@ module Ddr
 
       def resource_role_filters
         current_ability.agents.map do |agent|
-          ActiveFedora::SolrService.raw_query(Ddr::IndexFields::RESOURCE_ROLE, agent)
+          ActiveFedora::SolrService.raw_query(Ddr::Index::Fields::RESOURCE_ROLE, agent)
         end.join(" OR ")
       end
 

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

@@ -14,7 +14,8 @@ module Ddr
           "Editor",
           "The Editor role conveys reponsibility for managing the content, " \
           "description and structural arrangement of a resource.",
-          Permissions::ALL - [ Permissions::GRANT ]
+          [ Permissions::READ, Permissions::DOWNLOAD, Permissions::ADD_CHILDREN,
+            Permissions::UPDATE, Permissions::REPLACE, Permissions::ARRANGE ]
         )
 
         METADATA_EDITOR = RoleType.new(

data/lib/ddr/datastreams.rb

@@ -10,8 +10,8 @@ module Ddr
     DEFAULT_RIGHTS = "defaultRights"
     DESC_METADATA = "descMetadata"
     EXTRACTED_TEXT = "extractedText"
+    FITS = "fits".freeze
     MULTIRES_IMAGE = "multiresImage"
-    PROPERTIES = "properties"
     RELS_EXT = "RELS-EXT"
     RIGHTS_METADATA = "rightsMetadata"
     STRUCT_METADATA = "structMetadata"
@@ -28,9 +28,9 @@ module Ddr
     autoload :AdministrativeMetadataDatastream
     autoload :DatastreamBehavior
     autoload :DescriptiveMetadataDatastream
+    autoload :FitsDatastream
     autoload :MetadataDatastream
     autoload :PlainTextDatastream
-    autoload :PropertiesDatastream
     autoload :StructuralMetadataDatastream
 
   end

data/lib/ddr/datastreams/administrative_metadata_datastream.rb

@@ -4,31 +4,44 @@ module Ddr
   module Datastreams
     class AdministrativeMetadataDatastream < MetadataDatastream
 
-      property :permanent_id, predicate: Ddr::Vocab::Asset.permanentId
+      property :permanent_id,
+               predicate: Ddr::Vocab::Asset.permanentId
 
-      property :permanent_url, predicate: Ddr::Vocab::Asset.permanentUrl
+      property :permanent_url,
+               predicate: Ddr::Vocab::Asset.permanentUrl
 
-      property :original_filename, predicate: Ddr::Vocab::PREMIS.hasOriginalName do |index|
+      property :original_filename,
+               predicate: Ddr::Vocab::PREMIS.hasOriginalName do |index|
         index.as :stored_sortable
       end
 
-      property :workflow_state, predicate: Ddr::Vocab::Asset.workflowState
+      property :workflow_state,
+               predicate: Ddr::Vocab::Asset.workflowState
 
-      Ddr::Vocab::Roles::LEGACY_ROLES.each do |legacy_role|
-        property legacy_role, predicate: Ddr::Vocab::Roles.send(legacy_role) do |index|
-          index.as :symbol
-        end
-      end
+      property :access_role,
+               predicate: Ddr::Vocab::Roles.hasRole,
+               class_name: Ddr::Auth::Roles::Role
+
+      property :local_id,
+               predicate: RDF::Vocab::Identifiers.local
+
+      property :admin_set,
+               predicate: Ddr::Vocab::Asset.adminSet
 
-      property :access_role, predicate: Ddr::Vocab::Roles.hasRole, class_name: Ddr::Auth::Roles::Role
+      property :display_format,
+               predicate: Ddr::Vocab::Display.format
 
-      property :local_id, predicate: RDF::Vocab::Identifiers.local
+      property :research_help_contact,
+               predicate: Ddr::Vocab::Contact.assistance
 
-      property :admin_set, predicate: Ddr::Vocab::Asset.adminSet
+      property :depositor,
+               predicate: RDF::Vocab::MARCRelators.dpt
 
-      property :display_format, predicate: Ddr::Vocab::Display.format
+      property :doi,
+               predicate: RDF::Vocab::Identifiers.doi
 
-      property :research_help_contact, predicate: Ddr::Vocab::Contact.assistance
+      property :license,
+               predicate: RDF::DC.license
 
     end
   end

data/lib/ddr/datastreams/datastream_behavior.rb

@@ -90,6 +90,19 @@ module Ddr
         [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
+      end
+
     end
   end
 end

data/lib/ddr/datastreams/fits_datastream.rb

@@ -0,0 +1,88 @@
+module Ddr::Datastreams
+  class FitsDatastream < ActiveFedora::OmDatastream
+
+    FITS_XMLNS = "http://hul.harvard.edu/ois/xml/ns/fits/fits_output".freeze
+    FITS_SCHEMA = "http://hul.harvard.edu/ois/xml/xsd/fits/fits_output.xsd".freeze
+
+    EXIFTOOL = "Exiftool"
+
+    set_terminology do |t|
+      t.root(path: "fits",
+             xmlns: FITS_XMLNS,
+             schema: FITS_SCHEMA)
+      t.version(path: {attribute: "version"})
+      t.timestamp(path: {attribute: "timestamp"})
+      t.identification {
+        t.identity {
+          t.mimetype(path: {attribute: "mimetype"})
+          t.format_label(path: {attribute: "format"})
+          t.version
+          t.externalIdentifier
+          t.pronom_identifier(path: "externalIdentifier", attributes: {type: "puid"})
+        }
+      }
+      t.fileinfo {
+        t.size
+        t.creatingApplicationName
+        t.created
+        t.lastmodified
+      }
+      t.filestatus {
+        t.valid
+        t.well_formed(path: "well-formed")
+      }
+      t.metadata {
+        t.image {
+          t.imageWidth
+          t.imageHeight
+          t.colorSpace
+        }
+        t.document {
+          # TODO - configure to get from Tika?
+          # t.encoding
+        }
+        t.text
+        t.audio
+        t.video
+      }
+
+      ## proxy terms
+      # identification / identity
+      t.media_type           proxy: [:identification, :identity, :mimetype]
+      t.format_label         proxy: [:identification, :identity, :format_label]
+      t.format_version       proxy: [:identification, :identity, :version]
+      t.pronom_identifier    proxy: [:identification, :identity, :pronom_identifier]
+      # filestatus
+      t.valid                proxy: [:filestatus, :valid]
+      t.well_formed          proxy: [:filestatus, :well_formed]
+      # fileinfo
+      t.created              proxy: [:fileinfo, :created]
+      t.creating_application proxy: [:fileinfo, :creatingApplicationName]
+      t.extent               proxy: [:fileinfo, :size]
+      # image metadata
+      t.image_width          proxy: [:metadata, :image, :imageWidth]
+      t.image_height         proxy: [:metadata, :image, :imageHeight]
+      t.color_space          proxy: [:metadata, :image, :colorSpace]
+    end
+
+    def self.xml_template
+      builder = Nokogiri::XML::Builder.new do |xml|
+        xml.fits("xmlns"=>FITS_XMLNS,
+                 "xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance",
+                 "xsi:schemaLocation"=>"http://hul.harvard.edu/ois/xml/ns/fits/fits_output http://hul.harvard.edu/ois/xml/xsd/fits/fits_output.xsd")
+      end
+      builder.doc
+    end
+
+    def prefix
+      "fits__"
+    end
+
+    def modified
+      ng_xml
+        .xpath("//fits:fileinfo/fits:lastmodified[@toolname != '#{EXIFTOOL}']", fits: FITS_XMLNS)
+        .map(&:text)
+    end
+
+  end
+end