sufia-models 5.0.0.beta1 → 5.0.0.rc1

data/lib/generators/sufia/models/orcid_field_generator.rb

@@ -0,0 +1,19 @@
+require_relative 'abstract_migration_generator'
+
+class Sufia::Models::OrcidFieldGenerator < Sufia::Models::AbstractMigrationGenerator
+  source_root File.expand_path('../templates', __FILE__)
+
+  desc """
+This generator adds a field to hold users' ORCIDs to your application:
+ 1. Creates a database migration if they do not exist in /db/migrate
+       """
+
+  def banner
+    say_status("warning", "ADDING ORCID FIELD TO USER MODEL", :yellow)
+  end
+
+  # Setup the database migration
+  def copy_migrations
+    better_migration_template 'add_orcid_to_users.rb'
+  end
+end

data/lib/generators/sufia/models/proxies_generator.rb

@@ -1,30 +1,12 @@
-# -*- encoding : utf-8 -*-
-require 'rails/generators'
-require 'rails/generators/migration'
-
-class Sufia::Models::ProxiesGenerator < Rails::Generators::Base
-  include Rails::Generators::Migration
+require_relative 'abstract_migration_generator'
 
+class Sufia::Models::ProxiesGenerator < Sufia::Models::AbstractMigrationGenerator
   source_root File.expand_path('../templates', __FILE__)
 
   desc """
 This generator adds proxies and transfers to your application:
  1. Creates several database migrations if they do not exist in /db/migrate
        """
-  # Implement the required interface for Rails::Generators::Migration.
-  # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
-  def self.next_migration_number(path)
-    if @prev_migration_nr
-      @prev_migration_nr += 1
-    else
-      if last_migration = Dir[File.join(path, '*.rb')].sort.last
-        @prev_migration_nr = last_migration.sub(File.join(path, '/'), '').to_i + 1
-      else
-        @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
-      end
-    end
-    @prev_migration_nr.to_s
-  end
 
   def banner
     say_status("warning", "ADDING PROXY/TRANSFER-RELATED SUFIA MODELS", :yellow)
@@ -32,7 +14,6 @@ This generator adds proxies and transfers to your application:
 
   # Setup the database migrations
   def copy_migrations
-    # Can't get this any more DRY, because we need this order.
     [
       'create_proxy_deposit_rights.rb',
       'create_proxy_deposit_requests.rb'
@@ -40,14 +21,4 @@ This generator adds proxies and transfers to your application:
       better_migration_template file
     end
   end
-
-  private
-
-  def better_migration_template(file)
-    begin
-      migration_template "migrations/#{file}", "db/migrate/#{file}"
-    rescue Rails::Generators::Error => e
-      say_status("warning", e.message, :yellow)
-    end
-  end
 end

data/lib/generators/sufia/models/templates/config/sufia.rb

@@ -93,6 +93,9 @@ Sufia.config do |config|
   # Specify a Google Analytics tracking ID to gather usage statistics
   # config.google_analytics_id = 'UA-99999999-1'
 
+  # Specify a date you wish to start collecting Google Analytic statistics for.
+  # config.analytic_start_date = DateTime.new(2014,9,10)
+
   # Where to store tempfiles, leave blank for the system temp directory (e.g. /tmp)
   # config.temp_file_base = '/home/developer1'
 
@@ -108,16 +111,6 @@ Sufia.config do |config|
   # Specify how many seconds back from the current time that we should show by default of the user's activity on the user's dashboard
   # config.activity_to_show_default_seconds_since_now = 24*60*60
 
-  # Specify a date you wish to start collecting Google Analytic statistics for.
-  # Leaving it blank will set the start date to when ever the file was uploaded by
-  # NOTE: if you have always sent analytics to GA for downloads and page views leave this commented out
-  # config.analytic_start_date = DateTime.new(2014,9,10)
-  #
-  # Method of converting pids into URIs for storage in Fedora
-  # config.translate_uri_to_id = lambda { |uri| uri.to_s.split('/')[-1] }
-  # config.translate_id_to_uri = lambda { |id|
-  #      "#{ActiveFedora.fedora.host}#{ActiveFedora.fedora.base_path}/#{Sufia::Noid.treeify(id)}" }
-
   # If browse-everything has been configured, load the configs.  Otherwise, set to nil.
   begin
     if defined? BrowseEverything

data/lib/generators/sufia/models/templates/migrations/add_orcid_to_users.rb

@@ -0,0 +1,5 @@
+class AddOrcidToUsers < ActiveRecord::Migration
+  def change
+    add_column :users, :orcid, :string
+  end
+end

data/lib/generators/sufia/models/templates/migrations/create_user_stats.rb

@@ -0,0 +1,19 @@
+class CreateUserStats < ActiveRecord::Migration
+  def change
+    create_table :user_stats do |t|
+      t.integer :user_id
+      t.datetime :date
+      t.integer :file_views
+      t.integer :file_downloads
+
+      t.timestamps
+    end
+
+    add_column :file_view_stats, :user_id, :integer
+    add_column :file_download_stats, :user_id, :integer
+
+    add_index :user_stats, :user_id
+    add_index :file_view_stats, :user_id
+    add_index :file_download_stats, :user_id
+  end
+end

data/lib/generators/sufia/models/upgrade400_generator.rb

@@ -1,13 +1,8 @@
-# -*- encoding : utf-8 -*-
-require 'rails/generators'
-require 'rails/generators/migration'
-
-class Sufia::Models::Upgrade400Generator < Rails::Generators::Base
-  include Rails::Generators::Migration
+require_relative 'abstract_migration_generator'
 
+class Sufia::Models::Upgrade400Generator < Sufia::Models::AbstractMigrationGenerator
   source_root File.expand_path('../templates', __FILE__)
 
-  argument     :model_name, type: :string , default: "user"
   desc """
 This generator for upgrading sufia-models from 3.7.2 to 4.0 makes the following changes to your application:
  1. Creates several database migrations if they do not exist in /db/migrate
@@ -16,28 +11,12 @@ This generator for upgrading sufia-models from 3.7.2 to 4.0 makes the following
  4. Runs full-text generator
        """
 
-  # Implement the required interface for Rails::Generators::Migration.
-  # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
-  def self.next_migration_number(path)
-    if @prev_migration_nr
-      @prev_migration_nr += 1
-    else
-      if last_migration = Dir[File.join(path, '*.rb')].sort.last
-        @prev_migration_nr = last_migration.sub(File.join(path, '/'), '').to_i + 1
-      else
-        @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
-      end
-    end
-    @prev_migration_nr.to_s
-  end
-
   def banner
     say_status("warning", "UPGRADING SUFIA MODELS", :yellow)
   end
 
   # Setup the database migrations
   def copy_migrations
-    # Can't get this any more DRY, because we need this order.
     [
       'create_tinymce_assets.rb',
       'create_content_blocks.rb',
@@ -72,14 +51,4 @@ This generator for upgrading sufia-models from 3.7.2 to 4.0 makes the following
   def full_text_indexing
     generate "sufia:models:fulltext"
   end
-
-  private
-
-  def better_migration_template(file)
-    begin
-      migration_template "migrations/#{file}", "db/migrate/#{file}"
-    rescue Rails::Generators::Error => e
-      say_status("warning", e.message, :yellow)
-    end
-  end
 end

data/lib/generators/sufia/models/user_stats_generator.rb

@@ -0,0 +1,31 @@
+require_relative 'abstract_migration_generator'
+
+class Sufia::Models::UserStatsGenerator < Sufia::Models::AbstractMigrationGenerator
+  source_root File.expand_path('../templates', __FILE__)
+  argument :model_name, type: :string , default: "user"
+
+  desc """
+This generator adds usage stats methods to the user model in your application:
+       """
+
+  def banner
+    say_status("warning", "ADDING USER STATS-RELATED ABILITIES TO SUFIA MODELS", :yellow)
+  end
+
+  # Setup the database migrations
+  def copy_migrations
+    better_migration_template 'create_user_stats.rb'
+  end
+
+  def add_stats_mixin_to_user_model
+    file_path = "app/models/#{model_name.underscore}.rb"
+
+    if File.exists?(file_path)
+      inject_into_file file_path, after: /include Sufia\:\:User.*$/ do
+        "\n  include Sufia::UserUsageStats"
+      end
+    else
+      puts "     \e[31mFailure\e[0m  Sufia requires a user object. This generator assumes that the model is defined in the file #{file_path}, which does not exist.  If you used a different name, please re-run the generator and provide that name as an argument. Such as \b  rails g sufia:models:user_stats client"
+    end
+  end
+end

data/lib/sufia/models/engine.rb

@@ -31,10 +31,6 @@ module Sufia
       # Defaulting analytic start date to when ever the file was uploaded by leaving it blank
       config.analytic_start_date = nil
 
-      config.translate_uri_to_id = lambda { |uri| uri.to_s.split('/')[-1] }
-      config.translate_id_to_uri = lambda { |id|
-        "#{ActiveFedora.fedora.host}#{ActiveFedora.fedora.base_path}/#{Sufia::Noid.treeify(id)}" }
-
       config.autoload_paths += %W(
         #{config.root}/app/models/datastreams
       )
@@ -62,15 +58,10 @@ module Sufia
       end
 
       initializer 'configure' do
-        Sufia.config.tap do |c|
-          Hydra::Derivatives.ffmpeg_path    = c.ffmpeg_path
-          Hydra::Derivatives.temp_file_base = c.temp_file_base
-          Hydra::Derivatives.fits_path      = c.fits_path
-          Hydra::Derivatives.enable_ffmpeg  = c.enable_ffmpeg
-
-          ActiveFedora::Base.translate_uri_to_id = c.translate_uri_to_id
-          ActiveFedora::Base.translate_id_to_uri = c.translate_id_to_uri
-        end
+        Hydra::Derivatives.ffmpeg_path    = Sufia.config.ffmpeg_path
+        Hydra::Derivatives.temp_file_base = Sufia.config.temp_file_base
+        Hydra::Derivatives.fits_path      = Sufia.config.fits_path
+        Hydra::Derivatives.enable_ffmpeg  = Sufia.config.enable_ffmpeg
       end
     end
   end

data/lib/sufia/models/file_content/versions.rb

@@ -1,27 +1,23 @@
 module Sufia
   module FileContent
     module Versions
-      extend ActiveSupport::Concern
-
-      included do
-        has_many_versions
+      def get_version(version_id)
+        self.versions.select { |v| v.versionID == version_id}.first
       end
 
       def latest_version
-        versions.last.label unless versions.empty?
+        self.versions.first
       end
 
       def version_committer(version)
-        vc = VersionCommitter.where(version_id: version)
+        vc = VersionCommitter.where(obj_id: version.pid,
+                                    datastream_id: version.dsid,
+                                    version_id: version.versionID)
         return vc.empty? ? nil : vc.first.committer_login
       end
 
-      def save
-        super.tap do |passing|
-          create_version if passing
-        end
-      end
-      
+
     end
   end
 end
+

data/lib/sufia/models/stats/user_stat_importer.rb

@@ -0,0 +1,89 @@
+module Sufia
+  class UserStatImporter
+
+    def initialize(options={})
+      @verbose = options[:verbose]
+      @logging = options[:logging]
+    end
+
+    def import
+      log_message('Begin import of User stats.')
+      ::User.find_each do |user|
+        start_date = date_since_last_cache(user)
+
+        stats = {}
+        file_ids_for_user(user).each do |file_id|
+          view_stats = FileViewStat.statistics(file_id, start_date, user.id)
+          stats = tally_results(view_stats, :views, stats)
+
+          dl_stats = FileDownloadStat.statistics(file_id, start_date, user.id)
+          stats = tally_results(dl_stats, :downloads, stats)
+        end
+
+        create_or_update_user_stats(stats, user)
+      end
+      log_message('User stats import complete.')
+    end
+
+
+private
+
+    def date_since_last_cache(user)
+      last_cached_stat = UserStat.where(user_id: user.id).order(date: :asc).last
+
+      if last_cached_stat
+        last_cached_stat.date + 1.day
+      else
+        Sufia.config.analytic_start_date
+      end
+    end
+
+    def file_ids_for_user(user)
+      ids = []
+      ::GenericFile.find_in_batches("#{Solrizer.solr_name('depositor', :symbol)}:\"#{user.user_key}\"", fl:"id") do |group|
+        ids.concat group.map { |doc| doc["id"] }
+      end
+      ids
+    end
+
+    # For each date, add the view and download counts for this
+    # file to the view & download sub-totals for that day.
+    # The resulting hash will look something like this:
+    # {"2014-11-30 00:00:00 UTC" => {:views=>2, :downloads=>5},
+    #  "2014-12-01 00:00:00 UTC" => {:views=>4, :downloads=>4}}
+    def tally_results(file_stats, stat_name, total_stats)
+      file_stats.each do |stats|
+        # Exclude the stats from today since it will only be a partial day's worth of data
+        break if stats.date == Date.today
+
+        date_key = stats.date.to_s
+        old_count = total_stats[date_key] ? total_stats[date_key].fetch(stat_name) { 0 } : 0
+        new_count = old_count + stats.method(stat_name).call
+
+        old_values = total_stats[date_key] || {}
+        total_stats.store(date_key, old_values)
+        total_stats[date_key].store(stat_name, new_count)
+      end
+      total_stats
+    end
+
+    def create_or_update_user_stats(stats, user)
+      stats.each do |date_string, data|
+        date = Time.zone.parse(date_string)
+
+        user_stat = UserStat.where(user_id: user.id).where(date: date).first
+        user_stat ||= UserStat.new(user_id: user.id, date: date)
+
+        user_stat.file_views = data[:views] || 0
+        user_stat.file_downloads = data[:downloads] || 0
+        user_stat.save!
+      end
+    end
+
+    def log_message(message)
+      puts message if @verbose
+      Rails.logger.info "#{self.class}: #{message}" if @logging
+    end
+
+  end
+end

data/lib/sufia/models/version.rb

@@ -1,5 +1,5 @@
 module Sufia
   module Models
-    VERSION = "5.0.0.beta1"
+    VERSION = "5.0.0.rc1"
   end
 end

data/lib/sufia/permissions/writable.rb

@@ -8,50 +8,32 @@ module Sufia
       include Hydra::AccessControls::Visibility
 
       included do
+        has_metadata "rightsMetadata", type: ParanoidRightsDatastream
         validate :paranoid_permissions
       end
 
       def paranoid_permissions
-        valid = true
-        VALIDATIONS.each do |validation|
-          if validation[:condition].call(self)
-            errors[validation[:key]] ||= []
-            errors[validation[:key]] << validation[:message]
-            valid = false
-          end
-        end
-        return valid
-      end
-
-      VALIDATIONS = [
-        {key: :edit_users, message: 'Depositor must have edit access', condition: lambda { |obj| !obj.edit_users.include?(obj.depositor) }},
-        {key: :edit_groups, message: 'Public cannot have edit access', condition: lambda { |obj| obj.edit_groups.include?('public') }},
-        {key: :edit_groups, message: 'Registered cannot have edit access', condition: lambda { |obj| obj.edit_groups.include?('registered') }}
-      ]
-
-
-      def clear_permissions!
-        self.permissions = []
+        # let the rightsMetadata ds make this determination
+        # - the object instance is passed in for easier access to the props ds
+        rightsMetadata.validate(self)
       end
 
       ## Updates those permissions that are provided to it. Does not replace any permissions unless they are provided
-      # def permissions=(params)
-      #   raise "Fixme #{params}"
-      #   perm_hash = permission_hash
-      #   params[:new_user_name].each { |name, access| perm_hash['person'][name] = access } if params[:new_user_name].present?
-      #   params[:new_group_name].each { |name, access| perm_hash['group'][name] = access } if params[:new_group_name].present?
+      def permissions=(params)
+        perm_hash = permission_hash
+        params[:new_user_name].each { |name, access| perm_hash['person'][name] = access } if params[:new_user_name].present?
+        params[:new_group_name].each { |name, access| perm_hash['group'][name] = access } if params[:new_group_name].present?
 
-      #   params[:user].each { |name, access| perm_hash['person'][name] = access} if params[:user]
-      #   params[:group].each { |name, access| perm_hash['group'][name] = access if ['read', 'edit'].include?(access)} if params[:group]
+        params[:user].each { |name, access| perm_hash['person'][name] = access} if params[:user]
+        params[:group].each { |name, access| perm_hash['group'][name] = access if ['read', 'edit'].include?(access)} if params[:group]
 
-      #   # rightsMetadata.update_permissions(perm_hash)
-      # end
+        rightsMetadata.update_permissions(perm_hash)
+      end
 
-      # def permissions
-      #   raise "Fixme "
-      #   perms = super
-      #   perms.map {|p| { name: p.name, access: p.access, type:p.type } }
-      # end
+      def permissions
+        perms = super
+        perms.map {|p| { name: p.name, access: p.access, type:p.type } }
+      end
 
       private