sufia 4.2.0 → 4.3.1

data/spec/models/file_view_stat_spec.rb

@@ -2,8 +2,9 @@ require 'spec_helper'
 
 RSpec.describe FileViewStat, :type => :model do
   let (:file_id) {"99"}
+  let (:user_id) {123}
   let (:date) {DateTime.new}
-  let (:file_stat) {FileViewStat.create(views:"25", date: date, file_id: file_id)}
+  let (:file_stat) {FileViewStat.create(views:"25", date: date, file_id: file_id, user_id: user_id)}
 
   it "has attributes" do
     expect(file_stat).to respond_to(:views)
@@ -12,6 +13,7 @@ RSpec.describe FileViewStat, :type => :model do
     expect(file_stat.file_id).to eq("99")
     expect(file_stat.date).to eq(date)
     expect(file_stat.views).to eq(25)
+    expect(file_stat.user_id).to eq(user_id)
   end
 
   describe "#get_float_statistics" do
@@ -46,7 +48,7 @@ RSpec.describe FileViewStat, :type => :model do
     describe "cache empty" do
       let (:stats) {
         expect(FileViewStat).to receive(:ga_statistics).and_return(sample_pageview_statistics)
-        FileViewStat.statistics(file_id,Date.today-4.day)
+        FileViewStat.statistics(file_id, Date.today-4.day, user_id)
       }
 
       it "includes cached ga data" do
@@ -55,6 +57,7 @@ RSpec.describe FileViewStat, :type => :model do
 
       it "caches data" do
         expect(FileViewStat.to_flots stats).to include(*view_output)
+        expect(stats.first.user_id).to eq user_id
 
         # at this point all data should be cached
         allow(FileViewStat).to receive(:ga_statistics).with(Date.today, file_id).and_raise("We should not call Google Analytics All data should be cached!")
@@ -79,6 +82,7 @@ RSpec.describe FileViewStat, :type => :model do
       end
 
     end
+
   end
 end
 

data/spec/models/user_spec.rb

@@ -6,8 +6,8 @@ describe User, :type => :model do
     @another_user = FactoryGirl.find_or_create(:archivist)
   end
   after(:all) do
-    @user.delete
-    @another_user.delete
+    @user.destroy
+    @another_user.destroy
   end
   it "should have an email" do
     expect(@user.user_key).to eq("jilluser@example.com")
@@ -25,6 +25,29 @@ describe User, :type => :model do
     expect(@user).to respond_to(:facebook_handle)
     expect(@user).to respond_to(:googleplus_handle)
     expect(@user).to respond_to(:linkedin_handle)
+    expect(@user).to respond_to(:orcid)
+  end
+  describe 'ORCID validation and normalization' do
+    it 'saves when a valid bare ORCID is supplied' do
+      @user.orcid = '0000-0000-1111-2222'
+      expect(@user).to be_valid
+      expect(@user.save).to be true
+    end
+    it 'saves when a valid ORCID URI is supplied' do
+      @user.orcid = 'http://orcid.org/0000-0000-1111-2222'
+      expect(@user).to be_valid
+      expect(@user.save).to be true
+    end
+    it 'normalizes bare ORCIDs to URIs' do
+      @user.orcid = '0000-0000-1111-2222'
+      @user.save
+      expect(@user.orcid).to eq 'http://orcid.org/0000-0000-1111-2222'
+    end
+    it 'marks bad ORCIDs as invalid' do
+      @user.orcid = '000-000-111-222'
+      expect(@user).not_to be_valid
+      expect(@user.save).to be false
+    end
   end
   it "should redefine to_param to make redis keys more recognizable (and useable within Rails URLs)" do
     expect(@user.to_param).to eq("jilluser@example-dot-com")

data/spec/models/user_usage_stats_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Sufia::UserUsageStats do
+  subject { FactoryGirl.create(:user) }
+
+  describe 'with cached stats' do
+    let!(:stat_1_day_ago) { UserStat.create!(user_id: subject.id, date: 1.days.ago, file_views: 3, file_downloads: 2) }
+    let!(:stat_2_days_ago) { UserStat.create!(user_id: subject.id, date: 2.days.ago, file_views: 2, file_downloads: 1) }
+
+    let!(:someone_elses_user_id) { subject.id + 1 }
+    let!(:not_my_stat) { UserStat.create!(user_id: someone_elses_user_id, date: 2.days.ago, file_views: 10, file_downloads: 11) }
+
+    describe '#total_file_views' do
+      it 'returns the total file views for that user' do
+        expect(subject.total_file_views).to eq 5
+      end
+    end
+
+    describe '#total_file_downloads' do
+      it 'returns the total file downloads for that user' do
+        expect(subject.total_file_downloads).to eq 3
+      end
+    end
+  end
+
+  describe 'with empty cache' do
+    describe '#total_file_views' do
+      it 'returns the total file views for that user' do
+        expect(subject.total_file_views).to eq 0
+      end
+    end
+
+    describe '#total_file_downloads' do
+      it 'returns the total file downloads for that user' do
+        expect(subject.total_file_downloads).to eq 0
+      end
+    end
+  end
+end

data/spec/views/dashboard/index_spec.rb

@@ -12,6 +12,8 @@ describe "dashboard/index.html.erb", :type => :view do
     allow(@user).to receive(:all_following).and_return(["magneto"])
     allow(@user).to receive(:followers).and_return(["wolverine","storm"])
     allow(@user).to receive(:can_receive_deposits_from).and_return([])
+    allow(@user).to receive(:total_file_views).and_return(1)
+    allow(@user).to receive(:total_file_downloads).and_return(3)
     allow(controller).to receive(:current_user).and_return(@user)
     allow(view).to receive(:number_of_files).and_return("15")
     allow(view).to receive(:number_of_collections).and_return("3")
@@ -62,6 +64,8 @@ describe "dashboard/index.html.erb", :type => :view do
       expect(@sidebar).to include '<span class="badge">2</span>'
       expect(@sidebar).to include '<span class="badge">15</span>'
       expect(@sidebar).to include '<span class="badge">3</span>'
+      expect(@sidebar).to include '<span class="badge-optional">1</span> View'
+      expect(@sidebar).to include '<span class="badge-optional">3</span> Downloads'
     end
 
     it "should show the statistics before the profile" do

data/spec/views/generic_file/_permission_form.html.erb_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe 'generic_files/_permission_form.html.erb', :type => :view do
+  let(:gf) {
+    stub_model(GenericFile, noid: '123',
+        depositor: 'bob',
+        resource_type: ['Dataset'])
+  }
+
+  before do
+    allow(controller).to receive(:current_user).and_return(stub_model(User))
+  end
+
+  it "should draw the permissions form without error" do
+    render partial: 'generic_files/permission_form.html.erb',  locals: {gf: gf}
+    expect(rendered).to have_css("input#new_user_name_skel")
+  end
+
+end

data/spec/views/generic_file/show.html.erb_spec.rb

@@ -73,7 +73,7 @@ describe 'generic_files/show.html.erb', :type => :view do
         contributors = @item.properties['contributor']
         expect(contributors.count).to eq(2)
         contributor = contributors.first
-        expect(contributor.type).to eq('http://schema.org/Agent')
+        expect(contributor.type).to eq('http://schema.org/Person')
         expect(contributor.properties['name'].first).to eq('Tweedledee')
       end
 
@@ -81,7 +81,7 @@ describe 'generic_files/show.html.erb', :type => :view do
         creators = @item.properties['creator']
         expect(creators.count).to eq(2)
         creator = creators.first
-        expect(creator.type).to eq('http://schema.org/Agent')
+        expect(creator.type).to eq('http://schema.org/Person')
         expect(creator.properties['name'].first).to eq('Doe, John')
       end
 

data/sufia-models/app/models/concerns/sufia/file_stat_utils.rb

@@ -17,13 +17,13 @@ module Sufia
       {ga_start_date: ga_start_date, cached_stats: stats.to_a }
     end
 
-    def combined_stats file_id, start_date, object_method, ga_key
+    def combined_stats file_id, start_date, object_method, ga_key, user_id=nil
       stat_cache_info = cached_stats( file_id, start_date, object_method)
       stats = stat_cache_info[:cached_stats]
       if stat_cache_info[:ga_start_date] < Date.today
         ga_stats =  ga_statistics(stat_cache_info[:ga_start_date], file_id)
         ga_stats.each do |stat|
-          lstat = self.new file_id:file_id, date: stat[:date], object_method => stat[ga_key]
+          lstat = self.new file_id: file_id, date: stat[:date], object_method => stat[ga_key], user_id: user_id
           lstat.save unless Date.parse(stat[:date]) == Date.today
           stats << lstat
         end
@@ -32,4 +32,4 @@ module Sufia
     end
 
   end
-end
+end

data/sufia-models/app/models/concerns/sufia/user.rb

@@ -18,33 +18,50 @@ module Sufia::User
     # Users should be followable
     acts_as_followable
 
-    # Setup accessible (or protected) attributes for your model
+    # Set up proxy-related relationships
     has_many :proxy_deposit_requests, foreign_key: 'receiving_user_id'
-
     has_many :deposit_rights_given, foreign_key: 'grantor_id', class_name: 'ProxyDepositRights', dependent: :destroy
     has_many :can_receive_deposits_from, through: :deposit_rights_given, source: :grantee
-
     has_many :deposit_rights_received, foreign_key: 'grantee_id', class_name: 'ProxyDepositRights', dependent: :destroy
     has_many :can_make_deposits_for, through: :deposit_rights_received, source: :grantor
 
+    # Validate and normalize ORCIDs
+    validates_with OrcidValidator
+    after_validation :normalize_orcid
+
+    # Set up user profile avatars
     mount_uploader :avatar, AvatarUploader, mount_on: :avatar_file_name
     validates_with AvatarValidator
+
     has_many :trophies
     attr_accessor :update_directory
   end
 
+  # Coerce the ORCID into URL format
+  def normalize_orcid
+    # Skip normalization if:
+    #   1. validation has already flagged the ORCID as invalid
+    #   2. the orcid field is blank
+    #   3. the orcid is already in its normalized form
+    return if self.errors[:orcid].first.present? || self.orcid.blank? || self.orcid.starts_with?('http://orcid.org/')
+    bare_orcid = /\d{4}-\d{4}-\d{4}-\d{4}/.match(self.orcid).string
+    self.orcid = "http://orcid.org/#{bare_orcid}"
+  end
+
   # Format the json for select2 which requires just an id and a field called text.
   # If we need an alternate format we should probably look at a json template gem
   def as_json(opts = nil)
-    {id: user_key, text: display_name ? "#{display_name} (#{user_key})" : user_key}
+    { id: user_key, text: display_name ? "#{display_name} (#{user_key})" : user_key }
   end
 
   def email_address
-    return self.email
+    self.email
   end
 
   def name
-    return self.display_name.titleize || self.user_key rescue self.user_key
+    self.display_name.titleize || raise
+  rescue
+    self.user_key
   end
 
   # Redefine this for more intuitive keys in Redis
@@ -61,7 +78,7 @@ module Sufia::User
 
   # method needed for messaging
   def mailboxer_email(obj=nil)
-    return nil
+    nil
   end
 
   # The basic groups method, override or will fallback to Sufia::Ldap::User
@@ -85,7 +102,9 @@ module Sufia::User
       [:email, :login, :display_name, :address, :admin_area,
         :department, :title, :office, :chat_id, :website, :affiliation,
         :telephone, :avatar, :group_list, :groups_last_update, :facebook_handle,
-        :twitter_handle, :googleplus_handle, :linkedin_handle, :remove_avatar]
+        :twitter_handle, :googleplus_handle, :linkedin_handle, :remove_avatar,
+        :orcid
+      ]
     end
 
     def current
@@ -119,7 +138,5 @@ module Sufia::User
     def from_url_component(component)
       User.find_by_user_key(component.gsub(/-dot-/, '.'))
     end
-
   end
-
 end

data/sufia-models/app/models/concerns/sufia/user_usage_stats.rb

@@ -0,0 +1,15 @@
+module Sufia::UserUsageStats
+
+  def stats
+    @stats ||= UserStat.where(user_id: id).order(date: :asc)
+  end
+
+  def total_file_views
+    stats.reduce(0) { |total, stat| total + stat.file_views }
+  end
+
+  def total_file_downloads
+    stats.reduce(0) { |total, stat| total + stat.file_downloads }
+  end
+
+end

data/sufia-models/app/models/file_download_stat.rb

@@ -5,8 +5,8 @@ class FileDownloadStat < ActiveRecord::Base
     [ self.class.convert_date(date), downloads ]
   end
 
-  def self.statistics file_id, start_date
-    combined_stats file_id, start_date, :downloads, :totalEvents
+  def self.statistics file_id, start_date, user_id=nil
+    combined_stats file_id, start_date, :downloads, :totalEvents, user_id
   end
 
   # Sufia::Download is sent to Sufia::Analytics.profile as #sufia__download

data/sufia-models/app/models/file_usage.rb

@@ -3,13 +3,17 @@ class FileUsage
   attr_accessor :id, :created, :path, :downloads, :pageviews
 
   def initialize id
+    file = ::GenericFile.find(id)
+    user = User.where(email: file.depositor).first
+    user_id = user ? user.id : nil
+
     self.id = id
     self.path = Sufia::Engine.routes.url_helpers.generic_file_path(Sufia::Noid.noidify(id))
     earliest = Sufia.config.analytic_start_date
-    self.created = DateTime.parse(::GenericFile.find(id).create_date)
+    self.created = DateTime.parse(file.create_date)
     self.created = earliest > created ? earliest : created unless earliest.blank?
-    self.downloads = FileDownloadStat.to_flots FileDownloadStat.statistics(id, created)
-    self.pageviews = FileViewStat.to_flots FileViewStat.statistics(id, created)
+    self.downloads = FileDownloadStat.to_flots FileDownloadStat.statistics(id, created, user_id)
+    self.pageviews = FileViewStat.to_flots FileViewStat.statistics(id, created, user_id)
   end
 
   def total_downloads

data/sufia-models/app/models/file_view_stat.rb

@@ -5,8 +5,8 @@ class FileViewStat < ActiveRecord::Base
     [ self.class.convert_date(date), views ]
   end
 
-  def self.statistics file_id, start_date
-    combined_stats file_id, start_date, :views, :pageviews
+  def self.statistics file_id, start_date, user_id=nil
+    combined_stats file_id, start_date, :views, :pageviews, user_id
   end
 
   # Sufia::Download is sent to Sufia::Analytics.profile as #sufia__download

data/sufia-models/app/models/sufia/orcid_validator.rb

@@ -0,0 +1,8 @@
+module Sufia
+  class OrcidValidator < ActiveModel::Validator
+    def validate(record)
+      return if record.orcid.blank?
+      record.errors.add(:orcid, 'must be a string of 19 characters, e.g., "0000-0000-0000-0000"') unless /\d{4}-\d{4}-\d{4}-\d{4}/.match(record.orcid)
+    end
+  end
+end

data/sufia-models/app/models/user_stat.rb

@@ -0,0 +1,2 @@
+class UserStat < ActiveRecord::Base
+end

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

@@ -0,0 +1,30 @@
+# -*- encoding : utf-8 -*-
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class Sufia::Models::AbstractMigrationGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  # 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
+
+  protected
+
+  def better_migration_template(file)
+    migration_template "migrations/#{file}", "db/migrate/#{file}"
+  rescue Rails::Generators::Error => e
+    say_status("warning", e.message, :yellow)
+  end
+end

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

@@ -1,30 +1,12 @@
-# -*- encoding : utf-8 -*-
-require 'rails/generators'
-require 'rails/generators/migration'
-
-class Sufia::Models::CachedStatsGenerator < Rails::Generators::Base
-  include Rails::Generators::Migration
+require_relative 'abstract_migration_generator'
 
+class Sufia::Models::CachedStatsGenerator < Sufia::Models::AbstractMigrationGenerator
   source_root File.expand_path('../templates', __FILE__)
 
   desc """
 This generator adds the ability to cache usage stats 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 STATS CACHING-RELATED SUFIA MODELS", :yellow)
@@ -32,7 +14,6 @@ This generator adds the ability to cache usage stats to your application:
 
   # Setup the database migrations
   def copy_migrations
-    # Can't get this any more DRY, because we need this order.
     [
       'create_file_view_stats.rb',
       'create_file_download_stats.rb'
@@ -40,14 +21,4 @@ This generator adds the ability to cache usage stats 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