sufia 4.2.0 → 4.3.1

data/sufia-models/lib/generators/sufia/models/install_generator.rb

@@ -1,12 +1,7 @@
-# -*- encoding : utf-8 -*-
-require 'rails/generators'
-require 'rails/generators/migration'
-
-class Sufia::Models::InstallGenerator < Rails::Generators::Base
-  include Rails::Generators::Migration
+require_relative 'abstract_migration_generator'
 
+class Sufia::Models::InstallGenerator < Sufia::Models::AbstractMigrationGenerator
   source_root File.expand_path('../templates', __FILE__)
-
   argument     :model_name, type: :string , default: "user"
   desc """
 This generator makes the following changes to your application:
@@ -19,30 +14,15 @@ This generator makes the following changes to your application:
  7. Runs full-text generator
  8. Runs proxies generator
  9. Runs cached stats generator
+10. Runs ORCID field generator
+11. Runs user stats 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", "GENERATING SUFIA MODELS", :yellow)
   end
 
   # Setup the database migrations
   def copy_migrations
-    # Can't get this any more DRY, because we need this order.
     [
       "acts_as_follower_migration.rb",
       "add_social_to_users.rb",
@@ -114,13 +94,13 @@ This generator makes the following changes to your application:
     generate 'sufia:models:cached_stats'
   end
 
-  private
+  # Adds orcid field to user model
+  def orcid_field
+    generate 'sufia:models:orcid_field'
+  end
 
-  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
+  # Adds user stats-related migration & methods
+  def user_stats
+    generate 'sufia:models:user_stats'
   end
 end

data/sufia-models/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/sufia-models/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/sufia-models/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,11 +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)
-
   # If browse-everything has been configured, load the configs.  Otherwise, set to nil.
   begin
     if defined? BrowseEverything

data/sufia-models/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/sufia-models/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/sufia-models/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/sufia-models/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/sufia-models/lib/sufia/models/stats/user_stat_importer.rb

@@ -0,0 +1,85 @@
+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 = {}
+        files_for_user(user).each do |file|
+          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 files_for_user(user)
+      ::GenericFile.where(Solrizer.solr_name('depositor', :symbol) => user.user_key)
+    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/sufia-models/lib/sufia/models/version.rb

@@ -1,5 +1,5 @@
 module Sufia
   module Models
-    VERSION = "4.2.0"
+    VERSION = "4.3.1"
   end
 end

data/sufia-models/lib/tasks/stats_tasks.rake

@@ -0,0 +1,12 @@
+namespace :sufia do
+  namespace :stats do
+
+    desc "Cache file view & download stats for all users"
+    task :user_stats => :environment do
+      require 'sufia/models/stats/user_stat_importer'
+      importer = Sufia::UserStatImporter.new(verbose: true, logging: true)
+      importer.import
+    end
+
+  end
+end

data/sufia.gemspec

@@ -39,7 +39,6 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'hydra-editor', '~> 0.3'
   gem.add_dependency 'hydra-collections', '~> 2.0'
   gem.add_dependency 'bootstrap_form', '~> 2.1'
-  gem.add_dependency 'bootstrap-sass', '< 3.2'
   gem.add_dependency 'blacklight-gallery'
   gem.add_dependency 'breadcrumbs_on_rails', '~>2.3.0'
   gem.add_dependency 'select2-rails'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sufia
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.1
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-25 00:00:00.000000000 Z
+date: 2014-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sufia-models
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.3.1
 - !ruby/object:Gem::Dependency
   name: blacklight_advanced_search
   requirement: !ruby/object:Gem::Requirement
@@ -241,20 +241,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: bootstrap-sass
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: blacklight-gallery
   requirement: !ruby/object:Gem::Requirement
@@ -462,6 +448,7 @@ files:
 - app/assets/images/missing_original.png
 - app/assets/images/missing_thumb.png
 - app/assets/images/old_main_tulips.jpg
+- app/assets/images/orcid.png
 - app/assets/images/progressbar.gif
 - app/assets/images/site_images/bg_body.png
 - app/assets/images/site_images/bg_breadcrumbs.png
@@ -835,7 +822,6 @@ files:
 - app/views/users/_profile_tabs.html.erb
 - app/views/users/_proxies.html.erb
 - app/views/users/_search_form.html.erb
-- app/views/users/_social_media_info.html.erb
 - app/views/users/_trophy_edit.html.erb
 - app/views/users/_user_info.html.erb
 - app/views/users/_user_util_links_extra.html.erb
@@ -968,6 +954,7 @@ files:
 - spec/lib/sufia/messages_spec.rb
 - spec/lib/sufia/readable_permissions_spec.rb
 - spec/lib/sufia/upload_complete_behavior_spec.rb
+- spec/lib/sufia/user_stat_importer_spec.rb
 - spec/lib/sufia/writable_permissions_spec.rb
 - spec/models/ability_spec.rb
 - spec/models/batch_spec.rb
@@ -996,6 +983,7 @@ files:
 - spec/models/solr_document_spec.rb
 - spec/models/trophy_spec.rb
 - spec/models/user_spec.rb
+- spec/models/user_usage_stats_spec.rb
 - spec/routing/featured_works_route_spec.rb
 - spec/routing/ownership_transfers_route_spec.rb
 - spec/routing/route_spec.rb
@@ -1020,6 +1008,7 @@ files:
 - spec/views/collections/_form.html.erb_spec.rb
 - spec/views/collections/_show_descriptions.html.erb_spec.rb
 - spec/views/dashboard/index_spec.rb
+- spec/views/generic_file/_permission_form.html.erb_spec.rb
 - spec/views/generic_file/edit.html.erb_spec.rb
 - spec/views/generic_file/show.html.erb_spec.rb
 - spec/views/generic_file/stats.html.erb_spec.rb
@@ -1069,6 +1058,7 @@ files:
 - sufia-models/app/models/concerns/sufia/model_methods.rb
 - sufia-models/app/models/concerns/sufia/properties_datastream_behavior.rb
 - sufia-models/app/models/concerns/sufia/user.rb
+- sufia-models/app/models/concerns/sufia/user_usage_stats.rb
 - sufia-models/app/models/datastreams/batch_rdf_datastream.rb
 - sufia-models/app/models/datastreams/file_content_datastream.rb
 - sufia-models/app/models/datastreams/fits_datastream.rb
@@ -1093,16 +1083,20 @@ files:
 - sufia-models/app/models/sufia/avatar_uploader.rb
 - sufia-models/app/models/sufia/avatar_validator.rb
 - sufia-models/app/models/sufia/download.rb
+- sufia-models/app/models/sufia/orcid_validator.rb
 - sufia-models/app/models/sufia/pageview.rb
 - sufia-models/app/models/trophy.rb
+- sufia-models/app/models/user_stat.rb
 - sufia-models/app/models/version_committer.rb
 - sufia-models/app/services/sufia/analytics.rb
 - sufia-models/app/services/sufia/id_service.rb
 - sufia-models/app/services/sufia/noid.rb
 - sufia-models/config/locales/sufia.en.yml
+- sufia-models/lib/generators/sufia/models/abstract_migration_generator.rb
 - sufia-models/lib/generators/sufia/models/cached_stats_generator.rb
 - sufia-models/lib/generators/sufia/models/fulltext_generator.rb
 - sufia-models/lib/generators/sufia/models/install_generator.rb
+- sufia-models/lib/generators/sufia/models/orcid_field_generator.rb
 - sufia-models/lib/generators/sufia/models/proxies_generator.rb
 - sufia-models/lib/generators/sufia/models/templates/config/analytics.yml
 - sufia-models/lib/generators/sufia/models/templates/config/clamav.rb
@@ -1121,6 +1115,7 @@ files:
 - sufia-models/lib/generators/sufia/models/templates/migrations/add_groups_to_users.rb
 - sufia-models/lib/generators/sufia/models/templates/migrations/add_ldap_attrs_to_user.rb
 - sufia-models/lib/generators/sufia/models/templates/migrations/add_linkedin_to_users.rb
+- sufia-models/lib/generators/sufia/models/templates/migrations/add_orcid_to_users.rb
 - sufia-models/lib/generators/sufia/models/templates/migrations/add_social_to_users.rb
 - sufia-models/lib/generators/sufia/models/templates/migrations/create_checksum_audit_logs.rb
 - sufia-models/lib/generators/sufia/models/templates/migrations/create_content_blocks.rb
@@ -1133,9 +1128,11 @@ files:
 - sufia-models/lib/generators/sufia/models/templates/migrations/create_single_use_links.rb
 - sufia-models/lib/generators/sufia/models/templates/migrations/create_tinymce_assets.rb
 - sufia-models/lib/generators/sufia/models/templates/migrations/create_trophies.rb
+- sufia-models/lib/generators/sufia/models/templates/migrations/create_user_stats.rb
 - sufia-models/lib/generators/sufia/models/templates/migrations/create_version_committers.rb
 - sufia-models/lib/generators/sufia/models/upgrade400_generator.rb
 - sufia-models/lib/generators/sufia/models/usagestats_generator.rb
+- sufia-models/lib/generators/sufia/models/user_stats_generator.rb
 - sufia-models/lib/sufia/messages.rb
 - sufia-models/lib/sufia/models.rb
 - sufia-models/lib/sufia/models/active_fedora/redis.rb
@@ -1144,6 +1141,7 @@ files:
 - sufia-models/lib/sufia/models/file_content.rb
 - sufia-models/lib/sufia/models/file_content/versions.rb
 - sufia-models/lib/sufia/models/resque.rb
+- sufia-models/lib/sufia/models/stats/user_stat_importer.rb
 - sufia-models/lib/sufia/models/user_local_directory_behavior.rb
 - sufia-models/lib/sufia/models/utils.rb
 - sufia-models/lib/sufia/models/version.rb
@@ -1152,6 +1150,7 @@ files:
 - sufia-models/lib/sufia/permissions/readable.rb
 - sufia-models/lib/sufia/permissions/writable.rb
 - sufia-models/lib/tasks/resque.rake
+- sufia-models/lib/tasks/stats_tasks.rake
 - sufia-models/lib/tasks/sufia-models_tasks.rake
 - sufia-models/sufia-models.gemspec
 - sufia.gemspec
@@ -1321,6 +1320,7 @@ test_files:
 - spec/lib/sufia/messages_spec.rb
 - spec/lib/sufia/readable_permissions_spec.rb
 - spec/lib/sufia/upload_complete_behavior_spec.rb
+- spec/lib/sufia/user_stat_importer_spec.rb
 - spec/lib/sufia/writable_permissions_spec.rb
 - spec/models/ability_spec.rb
 - spec/models/batch_spec.rb
@@ -1349,6 +1349,7 @@ test_files:
 - spec/models/solr_document_spec.rb
 - spec/models/trophy_spec.rb
 - spec/models/user_spec.rb
+- spec/models/user_usage_stats_spec.rb
 - spec/routing/featured_works_route_spec.rb
 - spec/routing/ownership_transfers_route_spec.rb
 - spec/routing/route_spec.rb
@@ -1373,6 +1374,7 @@ test_files:
 - spec/views/collections/_form.html.erb_spec.rb
 - spec/views/collections/_show_descriptions.html.erb_spec.rb
 - spec/views/dashboard/index_spec.rb
+- spec/views/generic_file/_permission_form.html.erb_spec.rb
 - spec/views/generic_file/edit.html.erb_spec.rb
 - spec/views/generic_file/show.html.erb_spec.rb
 - spec/views/generic_file/stats.html.erb_spec.rb