hydra-head 4.0.1 → 4.0.2

data/lib/hydra/generic_user_attributes.rb

@@ -1,9 +1,8 @@
+require 'deprecation'
 module Hydra::GenericUserAttributes
+  extend Deprecation
 
-  def self.included(base)
-    ActiveSupport::Deprecation.warn("Hydra::GenericUserAttributes has been deprecated and will be removed no later than release 6.  Use devise or similar.")
-    super
-  end
+  self.deprecation_horizon = 'hydra-head 5.x'
 
   USER_ATTRIBUTES = ['first_name','last_name','full_name','affiliation','photo']
 
@@ -15,14 +14,17 @@ module Hydra::GenericUserAttributes
       def #{m}
         get_user_attribute "#{m}"
       end
+      deprecation_deprecate :#{m}
     EOM
   end
 
+  
   # Retrieves the UserAttribute object for the user.  This defaults to the packaged ActiveRecord object, but can be overwritten with #user_attributes=
   # @return an object containing the user's attributes.  If providing a localized class, be sure to include the default attributes of first_name, last_name, full_name, affiliation and photo.
   def user_attributes
     @user_attributes ||= user_attribute
   end
+  deprecation_deprecate :user_attributes
 
   private
 

data/lib/hydra/model_mixins.rb

@@ -1,3 +1,8 @@
-# will be changed in 5.x so all the model code is autoload-ed
-module Hydra::ModelMixins;end
-Dir[File.join(File.dirname(__FILE__), "model_mixins", "*.rb")].each {|f| require f}
+module Hydra::ModelMixins
+  extend ActiveSupport::Autoload
+  eager_autoload do
+    autoload :ModsObject
+    autoload :CommonMetadata
+    autoload :RightsMetadata
+  end
+end

data/lib/hydra/model_mixins/rights_metadata.rb

@@ -0,0 +1,357 @@
+module Hydra
+  module ModelMixins
+    module RightsMetadata
+
+
+      ## Updates those permissions that are provided to it. Does not replace any permissions unless they are provided
+      # @example
+      #  obj.permissions= [{:name=>"group1", :access=>"discover", :type=>'group'},
+      #  {:name=>"group2", :access=>"discover", :type=>'group'}]
+      def permissions=(params)
+        perm_hash = {'person' => rightsMetadata.individuals, 'group'=> rightsMetadata.groups}
+
+        params.each do |row|
+          if row[:type] == 'user'
+            perm_hash['person'][row[:name]] = row[:access]
+          else
+            perm_hash['group'][row[:name]] = row[:access]
+          end
+        end
+        
+        rightsMetadata.update_permissions(perm_hash)
+      end
+
+
+      ## Returns a list with all the permissions on the object.
+      # @example
+      #  [{:name=>"group1", :access=>"discover", :type=>'group'},
+      #  {:name=>"group2", :access=>"discover", :type=>'group'},
+      #  {:name=>"user2", :access=>"read", :type=>'user'},
+      #  {:name=>"user1", :access=>"edit", :type=>'user'},
+      #  {:name=>"user3", :access=>"read", :type=>'user'}]
+      def permissions
+        (rightsMetadata.groups.map {|x| {:type=>'group', :access=>x[1], :name=>x[0] }} + 
+          rightsMetadata.individuals.map {|x| {:type=>'user', :access=>x[1], :name=>x[0]}})
+
+      end
+    
+      # Return a list of groups that have discover permission
+      def discover_groups
+        rightsMetadata.groups.map {|k, v| k if v == 'discover'}.compact
+      end
+
+      # Grant discover permissions to the groups specified. Revokes discover permission for all other groups.
+      # @param[Array] groups a list of group names
+      # @example
+      #  r.discover_groups= ['one', 'two', 'three']
+      #  r.discover_groups 
+      #  => ['one', 'two', 'three']
+      #
+      def discover_groups=(groups)
+        set_discover_groups(groups, discover_groups)
+      end
+
+      # Grant discover permissions to the groups specified. Revokes discover permission for all other groups.
+      # @param[String] groups a list of group names
+      # @example
+      #  r.discover_groups_string= 'one, two, three'
+      #  r.discover_groups 
+      #  => ['one', 'two', 'three']
+      #
+      def discover_groups_string=(groups)
+        self.discover_groups=groups.split(/[\s,]+/)
+      end
+
+      # Display the groups a comma delimeted string
+      def discover_groups_string
+        self.discover_groups.join(', ')
+      end
+
+      # Grant discover permissions to the groups specified. Revokes discover permission for
+      # any of the eligible_groups that are not in groups.
+      # This may be used when different users are responsible for setting different
+      # groups.  Supply the groups the current user is responsible for as the 
+      # 'eligible_groups'
+      # @param[Array] groups a list of groups
+      # @param[Array] eligible_groups the groups that are eligible to have their discover permssion revoked. 
+      # @example
+      #  r.discover_groups = ['one', 'two', 'three']
+      #  r.discover_groups 
+      #  => ['one', 'two', 'three']
+      #  r.set_discover_groups(['one'], ['three'])
+      #  r.discover_groups
+      #  => ['one', 'two']  ## 'two' was not eligible to be removed
+      #
+      def set_discover_groups(groups, eligible_groups)
+        set_entities(:discover, :group, groups, eligible_groups)
+      end
+
+      def discover_users
+        rightsMetadata.individuals.map {|k, v| k if v == 'discover'}.compact
+      end
+
+      # Grant discover permissions to the users specified. Revokes discover permission for all other users.
+      # @param[Array] users a list of usernames
+      # @example
+      #  r.discover_users= ['one', 'two', 'three']
+      #  r.discover_users 
+      #  => ['one', 'two', 'three']
+      #
+      def discover_users=(users)
+        set_discover_users(users, discover_users)
+      end
+
+      # Grant discover permissions to the groups specified. Revokes discover permission for all other users.
+      # @param[String] users a list of usernames
+      # @example
+      #  r.discover_users_string= 'one, two, three'
+      #  r.discover_users 
+      #  => ['one', 'two', 'three']
+      #
+      def discover_users_string=(users)
+        self.discover_users=users.split(/[\s,]+/)
+      end
+
+      # Display the users as a comma delimeted string
+      def discover_users_string
+        self.discover_users.join(', ')
+      end
+
+      # Grant discover permissions to the users specified. Revokes discover permission for
+      # any of the eligible_users that are not in users.
+      # This may be used when different users are responsible for setting different
+      # users.  Supply the users the current user is responsible for as the 
+      # 'eligible_users'
+      # @param[Array] users a list of users
+      # @param[Array] eligible_users the users that are eligible to have their discover permssion revoked. 
+      # @example
+      #  r.discover_users = ['one', 'two', 'three']
+      #  r.discover_users 
+      #  => ['one', 'two', 'three']
+      #  r.set_discover_users(['one'], ['three'])
+      #  r.discover_users
+      #  => ['one', 'two']  ## 'two' was not eligible to be removed
+      #
+      def set_discover_users(users, eligible_users)
+        set_entities(:discover, :person, users, eligible_users)
+      end
+
+      # Return a list of groups that have discover permission
+      def read_groups
+        rightsMetadata.groups.map {|k, v| k if v == 'read'}.compact
+      end
+
+      # Grant read permissions to the groups specified. Revokes read permission for all other groups.
+      # @param[Array] groups a list of group names
+      # @example
+      #  r.read_groups= ['one', 'two', 'three']
+      #  r.read_groups 
+      #  => ['one', 'two', 'three']
+      #
+      def read_groups=(groups)
+        set_read_groups(groups, read_groups)
+      end
+
+      # Grant read permissions to the groups specified. Revokes read permission for all other groups.
+      # @param[String] groups a list of group names
+      # @example
+      #  r.read_groups_string= 'one, two, three'
+      #  r.read_groups 
+      #  => ['one', 'two', 'three']
+      #
+      def read_groups_string=(groups)
+        self.read_groups=groups.split(/[\s,]+/)
+      end
+
+      # Display the groups a comma delimeted string
+      def read_groups_string
+        self.read_groups.join(', ')
+      end
+
+      # Grant read permissions to the groups specified. Revokes read permission for
+      # any of the eligible_groups that are not in groups.
+      # This may be used when different users are responsible for setting different
+      # groups.  Supply the groups the current user is responsible for as the 
+      # 'eligible_groups'
+      # @param[Array] groups a list of groups
+      # @param[Array] eligible_groups the groups that are eligible to have their read permssion revoked. 
+      # @example
+      #  r.read_groups = ['one', 'two', 'three']
+      #  r.read_groups 
+      #  => ['one', 'two', 'three']
+      #  r.set_read_groups(['one'], ['three'])
+      #  r.read_groups
+      #  => ['one', 'two']  ## 'two' was not eligible to be removed
+      #
+      def set_read_groups(groups, eligible_groups)
+        set_entities(:read, :group, groups, eligible_groups)
+      end
+
+      def read_users
+        rightsMetadata.individuals.map {|k, v| k if v == 'read'}.compact
+      end
+
+      # Grant read permissions to the users specified. Revokes read permission for all other users.
+      # @param[Array] users a list of usernames
+      # @example
+      #  r.read_users= ['one', 'two', 'three']
+      #  r.read_users 
+      #  => ['one', 'two', 'three']
+      #
+      def read_users=(users)
+        set_read_users(users, read_users)
+      end
+
+      # Grant read permissions to the groups specified. Revokes read permission for all other users.
+      # @param[String] users a list of usernames
+      # @example
+      #  r.read_users_string= 'one, two, three'
+      #  r.read_users 
+      #  => ['one', 'two', 'three']
+      #
+      def read_users_string=(users)
+        self.read_users=users.split(/[\s,]+/)
+      end
+
+      # Display the users as a comma delimeted string
+      def read_users_string
+        self.read_users.join(', ')
+      end
+
+      # Grant read permissions to the users specified. Revokes read permission for
+      # any of the eligible_users that are not in users.
+      # This may be used when different users are responsible for setting different
+      # users.  Supply the users the current user is responsible for as the 
+      # 'eligible_users'
+      # @param[Array] users a list of users
+      # @param[Array] eligible_users the users that are eligible to have their read permssion revoked. 
+      # @example
+      #  r.read_users = ['one', 'two', 'three']
+      #  r.read_users 
+      #  => ['one', 'two', 'three']
+      #  r.set_read_users(['one'], ['three'])
+      #  r.read_users
+      #  => ['one', 'two']  ## 'two' was not eligible to be removed
+      #
+      def set_read_users(users, eligible_users)
+        set_entities(:read, :person, users, eligible_users)
+      end
+
+
+      # Return a list of groups that have edit permission
+      def edit_groups
+        rightsMetadata.groups.map {|k, v| k if v == 'edit'}.compact
+      end
+
+      # Grant edit permissions to the groups specified. Revokes edit permission for all other groups.
+      # @param[Array] groups a list of group names
+      # @example
+      #  r.edit_groups= ['one', 'two', 'three']
+      #  r.edit_groups 
+      #  => ['one', 'two', 'three']
+      #
+      def edit_groups=(groups)
+        set_edit_groups(groups, edit_groups)
+      end
+
+      # Grant edit permissions to the groups specified. Revokes edit permission for all other groups.
+      # @param[String] groups a list of group names
+      # @example
+      #  r.edit_groups_string= 'one, two, three'
+      #  r.edit_groups 
+      #  => ['one', 'two', 'three']
+      #
+      def edit_groups_string=(groups)
+        self.edit_groups=groups.split(/[\s,]+/)
+      end
+
+      # Display the groups a comma delimeted string
+      def edit_groups_string
+        self.edit_groups.join(', ')
+      end
+
+      # Grant edit permissions to the groups specified. Revokes edit permission for
+      # any of the eligible_groups that are not in groups.
+      # This may be used when different users are responsible for setting different
+      # groups.  Supply the groups the current user is responsible for as the 
+      # 'eligible_groups'
+      # @param[Array] groups a list of groups
+      # @param[Array] eligible_groups the groups that are eligible to have their edit permssion revoked. 
+      # @example
+      #  r.edit_groups = ['one', 'two', 'three']
+      #  r.edit_groups 
+      #  => ['one', 'two', 'three']
+      #  r.set_edit_groups(['one'], ['three'])
+      #  r.edit_groups
+      #  => ['one', 'two']  ## 'two' was not eligible to be removed
+      #
+      def set_edit_groups(groups, eligible_groups)
+        set_entities(:edit, :group, groups, eligible_groups)
+      end
+
+      def edit_users
+        rightsMetadata.individuals.map {|k, v| k if v == 'edit'}.compact
+      end
+
+      # Grant edit permissions to the groups specified. Revokes edit permission for all other groups.
+      # @param[Array] users a list of usernames
+      # @example
+      #  r.edit_users= ['one', 'two', 'three']
+      #  r.edit_users 
+      #  => ['one', 'two', 'three']
+      #
+      def edit_users=(users)
+        set_edit_users(users, edit_users)
+      end
+
+      # Grant edit permissions to the users specified. Revokes edit permission for
+      # any of the eligible_users that are not in users.
+      # This may be used when different users are responsible for setting different
+      # users.  Supply the users the current user is responsible for as the 
+      # 'eligible_users'
+      # @param[Array] users a list of users
+      # @param[Array] eligible_users the users that are eligible to have their edit permssion revoked. 
+      # @example
+      #  r.edit_users = ['one', 'two', 'three']
+      #  r.edit_users 
+      #  => ['one', 'two', 'three']
+      #  r.set_edit_users(['one'], ['three'])
+      #  r.edit_users
+      #  => ['one', 'two']  ## 'two' was not eligible to be removed
+      #
+      def set_edit_users(users, eligible_users)
+        set_entities(:edit, :person, users, eligible_users)
+      end
+
+
+      private 
+
+      # @param  permission either :discover, :read or :edit
+      # @param  type either :person or :group
+      # @param  values  Values to set
+      # @param  changeable Values we are allowed to change
+      def set_entities(permission, type, values, changeable)
+        g = preserved(type, permission)
+        (changeable - values).each do |entity|
+          #Strip permissions from users not provided
+          g[entity] = 'none'
+        end
+        values.each { |name| g[name] = permission.to_s}
+        rightsMetadata.update_permissions(type.to_s=>g)
+      end
+
+      ## Get those permissions we don't want to change
+      def preserved(type, permission)
+        case permission
+        when :edit
+          g = {}
+        when :read
+          Hash[rightsMetadata.quick_search_by_type(type).select {|k, v| v == 'edit'}]
+        when :discover
+          Hash[rightsMetadata.quick_search_by_type(type).select {|k, v| v == 'discover'}]
+        end
+      end
+
+    end
+  end
+end

data/lib/hydra/models/file_asset.rb

@@ -19,7 +19,7 @@ module Hydra
 
       # Returns a human readable filesize appropriate for the given number of bytes (ie. automatically chooses 'bytes','KB','MB','GB','TB')
       # Based on a bit of python code posted here: http://blogmag.net/blog/read/38/Print_human_readable_file_size
-      # @param [Numeric] file size in bits
+      # @param [Numeric] num file size in bits
       def bits_to_human_readable(num)
           ['bytes','KB','MB','GB','TB'].each do |x|
             if num < 1024.0

data/lib/hydra/mods_dataset.rb

@@ -1,14 +1,17 @@
 # @deprecated -- this will be removed in 5.x release
 require "uva/mods_index_methods"
+require 'deprecation'
 module Hydra
+  extend Deprecation
+
+  self.deprecation_horizon = 'hydra-head 5.x'
 
   class ModsDataset < ActiveFedora::NokogiriDatastream
     include Hydra::CommonModsIndexMethods
 
     def initialize(digital_object, dsid, options={})
-      ActiveSupport::Deprecation.warn("Hydra::ModsDataset has been deprecated. Use Hydra::Datastream::ModsDataset instead")
+      Deprecation.warn("Hydra::ModsDataset has been deprecated. Use Hydra::Datastream::ModsDataset instead")
       super
-
     end
 
     set_terminology do |t|

data/lib/hydra/rights_metadata.rb

@@ -126,14 +126,14 @@ class RightsMetadata < ActiveFedora::NokogiriDatastream
   end
   
   # Updates permissions for all of the persons and groups in a hash
-  # @param ex. {"group"=>{"group1"=>"discover","group2"=>"edit"}, "person"=>{"person1"=>"read","person2"=>"discover"}}
+  # @param params  ex. {"group"=>{"group1"=>"discover","group2"=>"edit"}, "person"=>{"person1"=>"read","person2"=>"discover"}}
   # Currently restricts actor type to group or person.  Any others will be ignored
   def update_permissions(params)
     params.fetch("group", {}).each_pair {|group_id, access_level| self.permissions({"group"=>group_id}, access_level)}
     params.fetch("person", {}).each_pair {|group_id, access_level| self.permissions({"person"=>group_id}, access_level)}
   end
   
-  # @param [Symbol] symbol (either :group or :person)
+  # @param [Symbol] type (either :group or :person)
   # @return 
   # This method limits the response to known access levels.  Probably runs a bit faster than .permissions().
   def quick_search_by_type(type)

data/lib/hydra/superuser_attributes.rb

@@ -1,18 +1,19 @@
 # @deprecated no longer doing permissions this way.  Will be removed no later than release 6.x
+require 'deprecation'
 module Hydra::SuperuserAttributes
+  extend Deprecation
 
-  def self.included(base)
-    ActiveSupport::Deprecation.warn("Hydra::SuperuserAttributes has been deprecated and will be removed no later than release 6.  Use devise or similar.")
-    super
-  end
+  self.deprecation_horizon = 'hydra-head 5.x'
 
   def can_be_superuser?
     Superuser.find_by_user_id(self.id) ? true : false
   end
+  deprecation_deprecate :can_be_superuser?
 
   def is_being_superuser?(session=nil)
     return false if session.nil?
     session[:superuser_mode] ? true : false
   end
+  deprecation_deprecate :is_being_superuser?
 
-end
+end