ddr-core 0.2.1

data/app/models/concerns/ddr/streamable.rb

@@ -0,0 +1,25 @@
+module Ddr
+  module Streamable
+    extend ActiveSupport::Concern
+
+    included do
+      attribute :streamable_media, Ddr::File.optional
+    end
+
+    def streamable_media_type
+      streamable_media&.media_type
+    end
+
+    # This method is used in dul-hydra 'ComponentsController' and ddr-public 'StreamController'
+    def streamable_media_extension
+      if filename = streamable_media&.original_filename
+        ::File.extname(filename)
+      end
+    end
+
+    def streamable_media_path
+      streamable_media&.file&.disk_path
+    end
+
+  end
+end

data/app/models/ddr/admin_set.rb

@@ -0,0 +1,28 @@
+require "active_resource"
+
+module Ddr
+  class AdminSet < ActiveResource::Base
+
+    self.site = ENV["DDR_AUX_API_URL"]
+
+    def self.call(obj)
+      find_by_code(obj.admin_set)
+    rescue ActiveResource::ResourceNotFound => e
+      raise Ddr::NotFoundError, e
+    end
+
+    def self.find_by_code(code)
+      return unless code
+      new get(:find, code: code)
+    end
+
+    def self.keys
+      all.map(&:code)
+    end
+
+    def to_s
+      title
+    end
+
+  end
+end

data/app/models/ddr/attachment.rb

@@ -0,0 +1,14 @@
+module Ddr
+  class Attachment < Resource
+
+    include HasContent
+    include HasExtractedText
+
+    attribute :attached_to_id, Valkyrie::Types::ID.optional
+
+    def attached_to
+      Ddr.query_service.find_by(id: attached_to_id) if attached_to_id
+    end
+
+  end
+end

data/app/models/ddr/collection.rb

@@ -0,0 +1,28 @@
+module Ddr
+  class Collection < Resource
+
+    include HasAttachments
+    include HasChildren
+    include HasStructMetadata
+
+    alias_method :items, :children
+
+    def components_from_solr
+      coll_id = id.id
+      query = Ddr::Index::Query.new do
+        where collection_id: coll_id
+        model 'Ddr::Component'
+      end
+      query.docs
+    end
+
+    def targets
+      Ddr.query_service.find_inverse_references_by(resource: self, property: 'for_collection_id')
+    end
+
+    def publishable?
+      true
+    end
+
+  end
+end

data/app/models/ddr/component.rb

@@ -0,0 +1,31 @@
+module Ddr
+  class Component < Resource
+
+    include Captionable
+    include HasContent
+    include HasExtractedText
+    include HasIntermediateFile
+    include HasMultiresImage
+    include HasParent
+    include HasStructMetadata
+    include Streamable
+
+    alias_method :item_id, :parent_id
+    alias_method :item, :parent
+
+    attribute :target_id, Valkyrie::Types::ID.optional
+
+    def collection
+      self.parent.parent rescue nil
+    end
+
+    def collection_id
+      self.collection.id rescue nil
+    end
+
+    def target
+      Ddr.query_service.find_by(id: target_id) if target_id
+    end
+
+  end
+end

data/app/models/ddr/contact.rb

@@ -0,0 +1,23 @@
+require 'activeresource'
+
+module Ddr
+  class Contact < ActiveResource::Base
+
+    self.site = ENV["DDR_AUX_API_URL"]
+
+    def self.call(slug)
+      new get(:find, slug: slug)
+    rescue ActiveResource::ResourceNotFound => e
+      raise Ddr::NotFoundError, e
+    end
+
+    def self.keys
+      all.map(&:slug)
+    end
+
+    def to_s
+      name
+    end
+
+  end
+end

data/app/models/ddr/digest.rb

@@ -0,0 +1,8 @@
+module Ddr
+  class Digest < Valkyrie::Resource
+
+    attribute :type, Ddr::Files::CHECKSUM_TYPES
+    attribute :value, Valkyrie::Types::Strict::String
+
+  end
+end

data/app/models/ddr/file.rb

@@ -0,0 +1,40 @@
+module Ddr
+  class File < Valkyrie::Resource
+
+    attribute :digest, Valkyrie::Types::Set.of(Ddr::Digest)
+    attribute :file_identifier, Valkyrie::Types::ID
+    attribute :media_type, Valkyrie::Types::Strict::String.optional
+    attribute :original_filename, Valkyrie::Types::Strict::String
+
+    DEFAULT_FILE_EXTENSION = 'bin'
+
+    def content
+      file.read
+    end
+
+    def file
+      Ddr.storage_adapter.find_by(id: file_identifier)
+    end
+
+    def file_created_at
+      ::File::Stat.new(Ddr.storage_adapter.file_path(file_identifier)).ctime
+    end
+
+    def file_size
+      file.size
+    end
+
+    # Return default file extension for file based on MIME type
+    def default_file_extension
+      mimetypes = MIME::Types[media_type]
+      return mimetypes.first.extensions.first unless mimetypes.empty?
+      case media_type
+      when 'application/n-triples'
+        'txt'
+      else
+        DEFAULT_FILE_EXTENSION
+      end
+    end
+
+  end
+end

data/app/models/ddr/item.rb

@@ -0,0 +1,36 @@
+module Ddr
+  class Item < Resource
+
+    include HasChildren
+    include HasParent
+    include HasStructMetadata
+
+    alias_method :collection_id, :parent_id
+    alias_method :collection, :parent
+
+    alias_method :components, :children
+
+    ### DDRevo #####################
+    # TODO: We may want to revisit this alternate implementation once ddr-core is more fully baked
+    # or it may be fine just as it is
+    ### DDRevo #####################
+    def children_having_extracted_text
+      # Ddr::Index::Query.build(self) do |item|
+      #   is_part_of item
+      #   where attached_files_having_content: "extractedText"
+      #   fields :id, :extracted_text
+      # end
+      children.select { |child| child.attached_files_having_content.include?(:extracted_text) }
+    end
+
+    ### DDRevo #####################
+    # TODO: We may want to revisit this alternate implementation once ddr-core is more fully baked
+    # or it may be fine just as it is
+    ### DDRevo #####################
+    def all_text
+      # children_having_extracted_text.docs.map(&:extracted_text).flatten
+      children_having_extracted_text.map { |child| child.extracted_text.content }.to_a.flatten
+    end
+
+  end
+end

data/app/models/ddr/language.rb

@@ -0,0 +1,31 @@
+require "active_resource"
+
+module Ddr
+  class Language < ActiveResource::Base
+
+    self.site = ENV["DDR_AUX_API_URL"]
+
+    def self.call(obj)
+      obj.language.map do |lang|
+        find_by_code(lang)
+      end
+    rescue ActiveResource::ResourceNotFound => e
+      raise Ddr::NotFoundError, e
+    end
+
+    def self.find_by_code(code)
+      return unless code
+      new get(:find, code: code)
+    end
+
+    def self.codes
+      all.map(&:code)
+    end
+
+    def to_s
+      label
+    end
+
+  end
+end
+

data/app/models/ddr/media_type.rb

@@ -0,0 +1,22 @@
+module Ddr
+  class MediaType
+
+    def self.call(file_or_path)
+      path = file_or_path.respond_to?(:path) ? file_or_path.path : file_or_path
+      # Use preferred media type, if available
+      media_type = Ddr.preferred_media_types[(::File.extname(path)).downcase]
+      if !media_type
+        if file_or_path.respond_to?(:content_type)
+          # Rails ActionDispatch::Http::UploadedFile
+          media_type = file_or_path.content_type
+        else
+          # Fall back to first MIME type or default
+          mime_types = MIME::Types.of(path)
+          media_type = mime_types.empty? ? Ddr.default_mime_type : mime_types.first.content_type
+        end
+      end
+      media_type
+    end
+
+  end
+end

data/app/models/ddr/resource.rb

@@ -0,0 +1,94 @@
+module Ddr
+  class Resource < Valkyrie::Resource
+
+    include Describable
+    include Governable
+    include HasAdminMetadata
+    include HasThumbnail
+
+    FILE_FIELDS = %i( caption
+                      content
+                      extracted_text
+                      fits_file
+                      intermediate_file
+                      multires_image
+                      streamable_media
+                      struct_metadata
+                      thumbnail
+                      )
+
+    FILE_FIELDS.each do |field|
+      # Defines "can_have_<field>?" class method
+      define_singleton_method "can_have_#{field}?" do
+        fields.include?(field)
+      end
+
+      delegate "can_have_#{field}?", to: :class
+
+      # Defines "has_<field>?" instance method
+      define_method "has_#{field}?" do
+        send("can_have_#{field}?") && has_file?(field)
+      end
+    end
+
+    def self.attachable_files
+      @attachable_files ||= FILE_FIELDS.select { |f| fields.include?(f) }
+    end
+
+    def self.governable?
+      fields.include? :admin_policy_id
+    end
+
+    def self.captionable?
+      can_have_caption?
+    end
+
+    def self.can_be_streamable?
+      can_have_streamable_media?
+    end
+
+    def self.common_model_name
+      name.split('::').last
+    end
+
+    def self.metadata_fields
+      fields - FILE_FIELDS - reserved_attributes
+    end
+
+    delegate :attachable_files, :common_model_name, :governable?, :captionable?, :can_be_streamable?, to: :class
+
+    alias_method :new_record?, :new_record
+
+    def title_display
+      return title.first if title.present?
+      return identifier.first if identifier.present?
+      return original_filename if respond_to?(:original_filename) && original_filename.present?
+      "[#{id}]"
+    end
+
+    def attached_files_having_content
+      attachable_files.select { |f| has_file?(f) }
+    end
+
+    def has_file?(f)
+      send(f)&.file_identifier.present?
+    end
+
+    def publishable?
+      false
+    end
+
+    def has_admin_policy?
+      governable? && admin_policy_id.present?
+    end
+
+    alias_method :streamable?, :has_streamable_media?
+    alias_method :captioned?, :has_caption?
+
+    # Convenience method for retrieving values of a metadata term
+    def values(term)
+      self.send(term)
+    end
+
+  end
+end

data/app/models/ddr/rights_statement.rb

@@ -0,0 +1,25 @@
+require "active_resource"
+
+module Ddr
+  class RightsStatement < ActiveResource::Base
+
+    self.site = ENV["DDR_AUX_API_URL"]
+
+    def self.call(obj)
+      if obj.rights.present?
+        new get(:find, url: obj.rights.first)
+      end
+    rescue ActiveResource::ResourceNotFound => e
+      raise Ddr::NotFoundError, e
+    end
+
+    def self.keys
+      all.map(&:url)
+    end
+
+    def to_s
+      title
+    end
+
+  end
+end

data/app/models/ddr/target.rb

@@ -0,0 +1,17 @@
+module Ddr
+  class Target < Resource
+
+    include HasContent
+
+    attribute :for_collection_id, Valkyrie::Types::ID.optional
+
+    def for_collection
+      Ddr.query_service.find_by(id: for_collection_id) if for_collection_id
+    end
+
+    def components
+      Ddr.query_service.find_inverse_references_by(resource: self, property: 'target_id')
+    end
+
+  end
+end

data/config/initializers/devise.rb

@@ -0,0 +1,262 @@
+require 'devise'
+
+# Use this hook to configure devise mailer, warden hooks and so forth.
+# Many of these configuration options can be set straight in your model.
+Devise.setup do |config|
+
+  # Given the modules that we implement, this shouldn't be used, but Devise >= 3.1 requires it,
+  # so a random value should suffice.
+  config.secret_key = SecureRandom.hex(64)
+
+  # ==> Mailer Configuration
+  # Configure the e-mail address which will be shown in Devise::Mailer,
+  # note that it will be overwritten if you use your own mailer class with default "from" parameter.
+  config.mailer_sender = "lib-drs@duke.edu"
+
+  # Configure the class responsible to send e-mails.
+  # config.mailer = "Devise::Mailer"
+
+  # ==> ORM configuration
+  # Load and configure the ORM. Supports :active_record (default) and
+  # :mongoid (bson_ext recommended) by default. Other ORMs may be
+  # available as additional gems.
+  require 'devise/orm/active_record'
+
+  # ==> Configuration for any authentication mechanism
+  # Configure which keys are used when authenticating a user. The default is
+  # just :email. You can configure it to use [:username, :subdomain], so for
+  # authenticating a user, both parameters are required. Remember that those
+  # parameters are used only when authenticating and not when retrieving from
+  # session. If you need permissions, you should implement that in a before filter.
+  # You can also supply a hash where the value is a boolean determining whether
+  # or not authentication should be aborted when the value is not present.
+  config.authentication_keys = [ :username ]
+
+  # Configure parameters from the request object used for authentication. Each entry
+  # given should be a request method and it will automatically be passed to the
+  # find_for_authentication method and considered in your model lookup. For instance,
+  # if you set :request_keys to [:subdomain], :subdomain will be used on authentication.
+  # The same considerations mentioned for authentication_keys also apply to request_keys.
+  # config.request_keys = []
+
+  # Configure which authentication keys should be case-insensitive.
+  # These keys will be downcased upon creating or modifying a user and when used
+  # to authenticate or find a user. Default is :email.
+  config.case_insensitive_keys = [ :username ]
+
+  # Configure which authentication keys should have whitespace stripped.
+  # These keys will have whitespace before and after removed upon creating or
+  # modifying a user and when used to authenticate or find a user. Default is :email.
+  config.strip_whitespace_keys = [ :username ]
+
+  # Tell if authentication through request.params is enabled. True by default.
+  # It can be set to an array that will enable params authentication only for the
+  # given strategies, for example, `config.params_authenticatable = [:database]` will
+  # enable it only for database (email + password) authentication.
+  config.params_authenticatable = [:database]
+
+  # Tell if authentication through HTTP Basic Auth is enabled. False by default.
+  # It can be set to an array that will enable http authentication only for the
+  # given strategies, for example, `config.http_authenticatable = [:token]` will
+  # enable it only for token authentication.
+  # config.http_authenticatable = false
+
+  # If http headers should be returned for AJAX requests. True by default.
+  # config.http_authenticatable_on_xhr = true
+
+  # The realm used in Http Basic Authentication. "Application" by default.
+  # config.http_authentication_realm = "Application"
+
+  # It will change confirmation, password recovery and other workflows
+  # to behave the same regardless if the e-mail provided was right or wrong.
+  # Does not affect registerable.
+  # config.paranoid = true
+
+  # By default Devise will store the user in session. You can skip storage for
+  # :http_auth and :token_auth by adding those symbols to the array below.
+  # Notice that if you are skipping storage for all authentication paths, you
+  # may want to disable generating routes to Devise's sessions controller by
+  # passing :skip => :sessions to `devise_for` in your config/routes.rb
+  config.skip_session_storage = [:http_auth]
+
+  # ==> Configuration for :database_authenticatable
+  # For bcrypt, this is the cost for hashing the password and defaults to 10. If
+  # using other encryptors, it sets how many times you want the password re-encrypted.
+  #
+  # Limiting the stretches to just one in testing will increase the performance of
+  # your test suite dramatically. However, it is STRONGLY RECOMMENDED to not use
+  # a value less than 10 in other environments.
+  config.stretches = Rails.env.test? ? 1 : 10
+
+  # Setup a pepper to generate the encrypted password.
+  # config.pepper = "37669e0c50042b93e63f790c4102864bace2ee0a30eecad6fca7d490f3124d855d8bc6d2978e5500fb266aab2b8c8003d9f202a1f23e4c2c8e8f105b7c46a68f"
+
+  # ==> Configuration for :confirmable
+  # A period that the user is allowed to access the website even without
+  # confirming his account. For instance, if set to 2.days, the user will be
+  # able to access the website for two days without confirming his account,
+  # access will be blocked just in the third day. Default is 0.days, meaning
+  # the user cannot access the website without confirming his account.
+  # config.allow_unconfirmed_access_for = 2.days
+
+  # If true, requires any email changes to be confirmed (exactly the same way as
+  # initial account confirmation) to be applied. Requires additional unconfirmed_email
+  # db field (see migrations). Until confirmed new email is stored in
+  # unconfirmed email column, and copied to email column on successful confirmation.
+  config.reconfirmable = true
+
+  # Defines which key will be used when confirming an account
+  config.confirmation_keys = [ :username ]
+
+  # ==> Configuration for :rememberable
+  # The time the user will be remembered without asking for credentials again.
+  # config.remember_for = 2.weeks
+
+  # If true, extends the user's remember period when remembered via cookie.
+  # config.extend_remember_period = false
+
+  # Options to be passed to the created cookie. For instance, you can set
+  # :secure => true in order to force SSL only cookies.
+  # config.rememberable_options = {}
+
+  # ==> Configuration for :validatable
+  # Range for password length. Default is 6..128.
+  # config.password_length = 6..128
+
+  # Email regex used to validate email formats. It simply asserts that
+  # an one (and only one) @ exists in the given string. This is mainly
+  # to give user feedback and not to assert the e-mail validity.
+  # config.email_regexp = /\A[^@]+@[^@]+\z/
+
+  # ==> Configuration for :timeoutable
+  # The time you want to timeout the user session without activity. After this
+  # time the user will be asked for credentials again. Default is 30 minutes.
+  # config.timeout_in = 30.minutes
+
+  # If true, expires auth token on session timeout.
+  # config.expire_auth_token_on_timeout = false
+
+  # ==> Configuration for :lockable
+  # Defines which strategy will be used to lock an account.
+  # :failed_attempts = Locks an account after a number of failed attempts to sign in.
+  # :none            = No lock strategy. You should handle locking by yourself.
+  # config.lock_strategy = :failed_attempts
+
+  # Defines which key will be used when locking and unlocking an account
+  config.unlock_keys = [ :username ]
+
+  # Defines which strategy will be used to unlock an account.
+  # :email = Sends an unlock link to the user email
+  # :time  = Re-enables login after a certain amount of time (see :unlock_in below)
+  # :both  = Enables both strategies
+  # :none  = No unlock strategy. You should handle unlocking by yourself.
+  # config.unlock_strategy = :both
+
+  # Number of authentication tries before locking an account if lock_strategy
+  # is failed attempts.
+  # config.maximum_attempts = 20
+
+  # Time interval to unlock the account if :time is enabled as unlock_strategy.
+  # config.unlock_in = 1.hour
+
+  # ==> Configuration for :recoverable
+  #
+  # Defines which key will be used when recovering the password for an account
+  config.reset_password_keys = [ :username ]
+
+  # Time interval you can reset your password with a reset password key.
+  # Don't put a too small interval or your users won't have the time to
+  # change their passwords.
+  config.reset_password_within = 6.hours
+
+  # ==> Configuration for :encryptable
+  # Allow you to use another encryption algorithm besides bcrypt (default). You can use
+  # :sha1, :sha512 or encryptors from others authentication tools as :clearance_sha1,
+  # :authlogic_sha512 (then you should set stretches above to 20 for default behavior)
+  # and :restful_authentication_sha1 (then you should set stretches to 10, and copy
+  # REST_AUTH_SITE_KEY to pepper)
+  # config.encryptor = :sha512
+
+  # ==> Configuration for :token_authenticatable
+  # Defines name of the authentication token params key
+  # config.token_authentication_key = :auth_token
+
+  # ==> Scopes configuration
+  # Turn scoped views on. Before rendering "sessions/new", it will first check for
+  # "users/sessions/new". It's turned off by default because it's slower if you
+  # are using only default views.
+  # config.scoped_views = false
+
+  # Configure the default scope given to Warden. By default it's the first
+  # devise role declared in your routes (usually :user).
+  # config.default_scope = :user
+
+  # Set this configuration to false if you want /users/sign_out to sign out
+  # only the current scope. By default, Devise signs out all scopes.
+  # config.sign_out_all_scopes = true
+
+  # ==> Navigation configuration
+  # Lists the formats that should be treated as navigational. Formats like
+  # :html, should redirect to the sign in page when the user does not have
+  # access, but formats like :xml or :json, should return 401.
+  #
+  # If you have any extra navigational formats, like :iphone or :mobile, you
+  # should add them to the navigational formats lists.
+  #
+  # The "*/*" below is required to match Internet Explorer requests.
+  # config.navigational_formats = ["*/*", :html]
+
+  # The default HTTP method used to sign out a resource. Default is :delete.
+  config.sign_out_via = :get
+
+  # ==> OmniAuth
+  # Add a new OmniAuth provider. Check the wiki for more information on setting
+  # up on your models and hooks.
+  # config.omniauth :github, 'APP_ID', 'APP_SECRET', :scope => 'user,public_repo'
+
+  # Shibboleth
+  # Explicit require is needed here for devise to find strategy
+  require "omniauth-shibboleth"
+  config.omniauth :shibboleth, {
+    request_type: :header,
+    uid_field: lambda { |rpm| rpm.call("eppn") || rpm.call("duDukeID") },
+    name_field: "displayName",
+    info_fields: {
+      email: "mail",
+      first_name: "givenName",
+      last_name: "sn",
+      nickname: "eduPersonNickname"
+    },
+    extra_fields: ["duDukeID"],
+  }
+
+  # ==> Warden configuration
+  # If you want to use other strategies, that are not supported by Devise, or
+  # change the failure app, you can configure them inside the config.warden block.
+  #
+  # config.warden do |manager|
+    # manager.intercept_401 = false
+    # manager.default_strategies(:scope => :user).unshift :remote_user_authenticatable
+  # end
+
+  config.warden do |manager|
+    manager.failure_app = Ddr::Auth::FailureApp
+    # :superuser scope
+    manager.serialize_into_session(:superuser) { |superuser| superuser.id }
+    manager.serialize_from_session(:superuser) { |id| Devise.mappings[:user].to.find(id) }
+  end
+
+  # ==> Mountable engine configurations
+  # When using Devise inside an engine, let's call it `MyEngine`, and this engine
+  # is mountable, there are some extra configurations to be taken into account.
+  # The following options are available, assuming the engine is mounted as:
+  #
+  #     mount MyEngine, at: "/my_engine"
+  #
+  # The router that invoked `devise_for`, in the example above, would be:
+  # config.router_name = :my_engine
+  #
+  # When using omniauth, Devise cannot automatically set Omniauth path,
+  # so you need to do it manually. For the users scope, it would be:
+  # config.omniauth_path_prefix = "/my_engine/users/auth"
+end