ddr-models 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae8bdb54bb6fa40f55f7a5af6ea116cecc9f4905
+  data.tar.gz: 6feec1443beefcc7f05d05ed51d5f0f0fdf653aa
+SHA512:
+  metadata.gz: 39366ec688860ce4ef4b06e0a38e7f3462e9fb855b06d9eaa747944aa8897dd879b49b6ce7d77f9ef6aa20aaea527c920226a48694189198815e855ee08c9b61
+  data.tar.gz: 38282725b45d3461d246a821f14c3d2a39b408749817edb0e89396b5e84d35b5b68eb040d0d0db8f7af9729067cc5edea9b6c781600a203030482b330a8e1a1f

data/LICENSE.txt

@@ -0,0 +1,12 @@
+Copyright (c) 2014, Duke University
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,5 @@
+# Ddr::Models
+
+[![Build Status](https://travis-ci.org/duke-libraries/ddr-models.svg?branch=develop)](https://travis-ci.org/duke-libraries/ddr-models)
+
+Hydra models for the Duke Digital Repository.

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+APP_ROOT = File.dirname(__FILE__)
+
+JETTY_CONFIG = { 
+	jetty_home: File.join(APP_ROOT, "jetty"),
+	jetty_port: 8983,
+	startup_wait: 45,
+	quiet: true,
+	java_opts: ["-Xmx256m", "-XX:MaxPermSize=128m"]
+}
+
+require 'rspec/core/rake_task'
+require 'jettywrapper'
+
+Jettywrapper.instance.base_path = APP_ROOT
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new(:spec => ["app:db:migrate", "app:db:test:prepare"])
+
+desc "Run the CI build"
+task :ci => ["jetty:clean"] do
+  Jettywrapper.wrap(JETTY_CONFIG) do
+    Rake::Task['spec'].invoke
+  end
+end
+
+task :default => :spec

data/app/models/attachment.rb

@@ -0,0 +1,7 @@
+class Attachment < Ddr::Models::Base
+
+  include Ddr::Models::HasContent
+  
+  belongs_to :attached_to, property: :is_attached_to, class_name: 'ActiveFedora::Base'
+  
+end

data/app/models/collection.rb

@@ -0,0 +1,54 @@
+class Collection < Ddr::Models::Base
+  
+  include Hydra::AdminPolicyBehavior
+  
+  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'
+  
+  alias_method :items, :children
+  alias_method :item_ids, :child_ids
+  
+  validates_presence_of :title
+  
+  def components_from_solr
+    outer = Ddr::IndexFields::IS_PART_OF
+    inner = Ddr::IndexFields::INTERNAL_URI
+    where = ActiveFedora::SolrService.construct_query_for_rel(:is_member_of_collection => internal_uri)
+    query = "{!join to=#{outer} from=#{inner}}#{where}"
+    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
+  
+  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
+  
+  def default_license=(new_license)
+    raise ArgumentError unless new_license.is_a?(Hash)
+    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
+  
+  def default_entities_for_permission(type, access)
+    default_permissions.collect { |p| p[:name] if p[:type] == type and p[:access] == access }.compact
+  end
+  
+  ["discover", "read", "edit"].each do |access|
+    ["user", "group"].each do |type|
+      define_method("default_#{access}_#{type}s") { default_entities_for_permission(type, access) }
+    end
+  end
+
+end

data/app/models/component.rb

@@ -0,0 +1,15 @@
+class Component < Ddr::Models::Base
+ 
+  include Ddr::Models::HasContent
+
+  belongs_to :parent, :property => :is_part_of, :class_name => 'Item'
+  belongs_to :target, :property => :has_external_target, :class_name => 'Target'
+
+  alias_method :item, :parent
+  alias_method :item=, :parent=
+
+  def collection
+    self.parent.parent rescue nil
+  end
+
+end

data/app/models/item.rb

@@ -0,0 +1,19 @@
+class Item < Ddr::Models::Base
+  
+  include Ddr::Models::HasContentMetadata
+  include Ddr::Models::HasChildren
+
+  has_many :children, property: :is_part_of, class_name: 'Component'
+  belongs_to :parent, property: :is_member_of_collection, class_name: 'Collection'
+
+  alias_method :components, :children
+  alias_method :component_ids, :child_ids
+
+  alias_method :parts, :children
+  alias_method :part_ids, :child_ids
+
+  alias_method :collection, :parent
+  alias_method :collection_id, :parent_id
+  alias_method :collection=, :parent=
+    
+end

data/app/models/solr_document.rb

@@ -0,0 +1,36 @@
+# -*- encoding : utf-8 -*-
+class SolrDocument 
+
+  include Blacklight::Solr::Document
+
+  # self.unique_key = 'id'
+  
+  # The following shows how to setup this blacklight document to display marc documents
+  # extension_parameters[:marc_source_field] = :marc_display
+  # extension_parameters[:marc_format_type] = :marcxml
+  # use_extension( Blacklight::Solr::Document::Marc) do |document|
+  #   document.key?( :marc_display  )
+  # end
+  
+  # Email uses the semantic field mappings below to generate the body of an email.
+  SolrDocument.use_extension( Blacklight::Solr::Document::Email )
+  
+  # SMS uses the semantic field mappings below to generate the body of an SMS email.
+  SolrDocument.use_extension( Blacklight::Solr::Document::Sms )
+
+  # DublinCore uses the semantic field mappings below to assemble an OAI-compliant Dublin Core document
+  # Semantic mappings of solr stored fields. Fields may be multi or
+  # single valued. See Blacklight::Solr::Document::ExtendableClassMethods#field_semantics
+  # and Blacklight::Solr::Document#to_semantic_values
+  # Recommendation: Use field names from Dublin Core
+  use_extension( Blacklight::Solr::Document::DublinCore)    
+  field_semantics.merge!(    
+                         :title => "title_display",
+                         :author => "author_display",
+                         :language => "language_facet",
+                         :format => "format"
+                         )
+
+  include Ddr::Models::SolrDocument
+
+end

data/app/models/target.rb

@@ -0,0 +1,8 @@
+class Target < Ddr::Models::Base
+
+  include Ddr::Models::HasContent
+
+  has_many :components, property: :has_external_target, class_name: 'Component'
+  belongs_to :collection, property: :is_external_target_for, class_name: 'Collection'
+
+end

data/config/initializers/active_fedora_base.rb

@@ -0,0 +1,77 @@
+module ActiveFedora
+  class Base
+
+    def can_have_attachments?
+      has_association? :attachments
+    end
+
+    def has_attachments?
+      can_have_attachments? && attachments.size > 0
+    end
+
+    def can_have_children?
+      has_association? :children
+    end
+
+    def has_children?
+      can_have_children? and children.size > 0
+    end
+
+    def can_have_content?
+      datastreams.include? "content"
+    end
+    
+    def has_content?
+      can_have_content? && content.has_content?
+    end
+
+    def has_content_metadata?
+      self.is_a?(DulHydra::HasContentMetadata) && self.datastreams[Ddr::Datastreams::CONTENT_METADATA].has_content?
+    end
+
+    def describable?
+      self.is_a? Ddr::Models::Describable
+    end
+
+    def governable?
+      has_association? :admin_policy
+    end
+
+    def has_admin_policy?
+      governable? && admin_policy.present?
+    end
+
+    def has_rights_metadata?
+      ds = self.datastreams[Ddr::Datastreams::RIGHTS_METADATA]
+      ds && ds.size && ds.size > 0
+    end
+    
+    def can_have_thumbnail?
+      datastreams.include? "thumbnail"
+    end
+
+    def has_thumbnail?
+      can_have_thumbnail? && thumbnail.has_content?
+    end
+
+    def safe_id
+      id.sub(/:/, "-")
+    end
+
+    # For duck-typing with SolrDocument
+    def active_fedora_model
+      self.class.to_s
+    end
+
+    def controller_name
+      active_fedora_model.tableize
+    end
+
+    protected
+
+    def has_association? assoc
+      !association(assoc).nil?
+    end
+
+  end
+end

data/config/initializers/active_fedora_datastream.rb

@@ -0,0 +1,5 @@
+module ActiveFedora
+  class Datastream
+    include Ddr::Datastreams::DatastreamBehavior
+  end
+end

data/config/initializers/ddr.rb

@@ -0,0 +1,8 @@
+Ddr::Models.configure do |config|
+
+  config.external_file_store = ENV['EXTERNAL_FILE_STORE']
+  config.external_file_subpath_pattern = ENV['EXTERNAL_FILE_SUBPATH_PATTERN'] || "--"
+  config.noid_template = "2.reeddeeddk"
+  config.minter_statefile = Rails.env.test? ? "/tmp/minter-state" : ENV['MINTER_STATEFILE']
+
+end

data/config/initializers/devise.rb

@@ -0,0 +1,245 @@
+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'
+
+  # ==> 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|
+    # :superuser scope
+    manager.serialize_into_session(:superuser) { |superuser| superuser.id }
+    manager.serialize_from_session(:superuser) { |id| User.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