sufia-models 4.0.0.beta2 → 4.0.0.beta3

data/app/models/datastreams/generic_file_rdf_datastream.rb

@@ -51,6 +51,12 @@ class GenericFileRdfDatastream < ActiveFedora::NtriplesRDFDatastream
   property :related_url, predicate: RDF::RDFS.seeAlso do |index|
     index.as :stored_searchable
   end
+  property :bibliographic_citation, predicate: RDF::DC.bibliographicCitation do |index|
+    index.as :stored_searchable
+  end
+  property :source, predicate: RDF::DC.source do |index|
+    index.as :stored_searchable
+  end
 
   # TODO: Move this somewhere more appropriate
   begin

data/app/models/datastreams/paranoid_rights_datastream.rb

@@ -3,9 +3,9 @@ class ParanoidRightsDatastream < Hydra::Datastream::RightsMetadata
   use_terminology Hydra::Datastream::RightsMetadata
 
   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') }}
+    {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 validate(object)

data/app/models/file_usage.rb

@@ -0,0 +1,53 @@
+class FileUsage
+
+  attr_accessor :id, :created, :path, :downloads, :pageviews
+
+  def initialize id
+    self.id = id
+    self.path = Sufia::Engine.routes.url_helpers.generic_file_path(Sufia::Noid.noidify(id))
+    self.created = DateTime.parse(::GenericFile.find(id).create_date)
+    self.downloads = download_statistics
+    self.pageviews = pageview_statistics
+  end
+
+  def total_downloads
+    self.downloads.map(&:marshal_dump).reduce(0) { |total, result| total + result[:totalEvents].to_i }
+  end
+
+  def total_pageviews
+    self.pageviews.map(&:marshal_dump).reduce(0) { |total, result| total + result[:pageviews].to_i }
+  end
+  
+  # Package data for visualization using JQuery Flot 
+  def to_flot
+    [
+      { label: "Pageviews",  data: pageviews_to_flot },
+      { label: "Downloads",  data: downloads_to_flot }
+    ]
+  end
+
+  private
+
+  def download_statistics
+    Sufia::Analytics.profile.download(sort: 'date').for_file(self.id)
+  end
+
+  def pageview_statistics
+    Sufia::Analytics.profile.pageview(sort: 'date').for_path(self.path)
+  end
+
+  def pageviews_to_flot values = Array.new
+    self.pageviews.map(&:marshal_dump).map do |result_hash|
+      values << [ (Date.parse(result_hash[:date]).to_time.to_i * 1000), result_hash[:pageviews].to_i ]
+    end
+    return values
+  end
+
+  def downloads_to_flot values = Array.new
+    self.downloads.map(&:marshal_dump).map do |result_hash|
+      values << [ (Date.parse(result_hash[:date]).to_time.to_i * 1000), result_hash[:totalEvents].to_i ]
+    end
+    return values
+  end
+
+end

data/app/models/follow.rb

@@ -1,14 +1,12 @@
 class Follow < ActiveRecord::Base
-
   extend ActsAsFollower::FollowerLib
   extend ActsAsFollower::FollowScopes
 
   # NOTE: Follows belong to the "followable" interface, and also to followers
-  belongs_to :followable, :polymorphic => true
-  belongs_to :follower,   :polymorphic => true
+  belongs_to :followable, polymorphic: true
+  belongs_to :follower, polymorphic: true
 
   def block!
     self.update_attribute(:blocked, true)
   end
-
 end

data/app/models/geo_names_resource.rb

@@ -2,19 +2,17 @@ class GeoNamesResource < ActiveResource::Base
   self.site = "http://api.geonames.org/"
   self.element_name = "searchJSON"
   self.collection_name = "searchJSON"
- 
+
   def self.collection_path(prefix_options = {}, query_options = nil)
-    super(prefix_options, query_options).gsub(/\.json|\.xml/, "") 
+    super(prefix_options, query_options).gsub(/\.json|\.xml/, "")
   end
 
   def self.instantiate_collection(collection, original_params = {}, prefix_options = {})
       col = super(collection["geonames"], original_params, prefix_options)
-      col.map! {|item|  { label: item.name+ (item.adminName1 ? ", " + item.adminName1 : "")+", " + item.countryName, value: item.name+ (item.adminName1 ? ", " + item.adminName1 : "")+", " + item.countryName} }
-      return col      
+      col.map! { |item| { label: item.name + (item.adminName1 ? ", " + item.adminName1 : "") + ", " + item.countryName, value: item.name + (item.adminName1 ? ", " + item.adminName1 : "") + ", " + item.countryName} }
   end
- 
+
   def self.find_location(location)
-    return GeoNamesResource.find(:all, :params => { :q =>location, :username=>"cam156", :maxRows=>10})
+    return GeoNamesResource.find(:all, params: { q: location, username: "cam156", maxRows: 10})
   end
-  
 end

data/app/models/local_authority.rb

@@ -6,18 +6,18 @@ class LocalAuthority < ActiveRecord::Base
   has_many :local_authority_entries
 
   def self.harvest_rdf(name, sources, opts = {})
-    return unless self.where(:name => name).empty?
-    authority = self.create(:name => name)
+    return unless self.where(name: name).empty?
+    authority = self.create(name: name)
     format = opts.fetch(:format, :ntriples)
     predicate = opts.fetch(:predicate, RDF::SKOS.prefLabel)
     entries = []
     sources.each do |uri|
-      RDF::Reader.open(uri, :format => format) do |reader|
+      RDF::Reader.open(uri, format: format) do |reader|
         reader.each_statement do |statement|
           if statement.predicate == predicate
-            entries << LocalAuthorityEntry.new(:local_authority => authority,
-                                               :label => statement.object.to_s,
-                                               :uri => statement.subject.to_s)
+            entries << LocalAuthorityEntry.new(local_authority: authority,
+                                               label: statement.object.to_s,
+                                               uri: statement.subject.to_s)
           end
         end
       end
@@ -30,17 +30,17 @@ class LocalAuthority < ActiveRecord::Base
   end
 
   def self.harvest_tsv(name, sources, opts = {})
-    return unless self.where(:name => name).empty?
-    authority = self.create(:name => name)
+    return unless self.where(name: name).empty?
+    authority = self.create(name: name)
     prefix = opts.fetch(:prefix, "")
     entries = []
     sources.each do |uri|
       open(uri) do |f|
         f.each_line do |tsv|
           fields = tsv.split(/\t/)
-          entries << LocalAuthorityEntry.new(:local_authority => authority,
-                                             :uri => "#{prefix}#{fields[0]}/",
-                                             :label => fields[2])
+          entries << LocalAuthorityEntry.new(local_authority: authority,
+                                             uri: "#{prefix}#{fields[0]}/",
+                                             label: fields[2])
         end
       end
     end
@@ -69,15 +69,15 @@ class LocalAuthority < ActiveRecord::Base
     if (term == 'subject' && model == 'generic_files') # and local_authoritiy = lc_subject 
         sql = SubjectLocalAuthorityEntry.where("lowerLabel like ?", "#{lowQuery}%").select("label, uri").limit(25).to_sql
         SubjectLocalAuthorityEntry.find_by_sql(sql).each do |hit|
-          hits << {:uri => hit.uri, :label => hit.label}
+          hits << {uri: hit.uri, label: hit.label}
         end
     else 
-      dterm = DomainTerm.where(:model => model, :term => term).first
+      dterm = DomainTerm.where(model: model, term: term).first
       if dterm
         authorities = dterm.local_authorities.collect(&:id).uniq      
         sql = LocalAuthorityEntry.where("local_authority_id in (?)", authorities).where("lower(label) like ?", "#{lowQuery}%").select("label, uri").limit(25).to_sql
         LocalAuthorityEntry.find_by_sql(sql).each do |hit|
-          hits << {:uri => hit.uri, :label => hit.label}
+          hits << {uri: hit.uri, label: hit.label}
         end
       end
     end

data/app/models/single_use_link.rb

@@ -6,7 +6,7 @@ class SingleUseLink < ActiveRecord::Base
   after_initialize :set_defaults
 
   def create_for_path path
-    self.class.create :itemId => itemId, :path => path
+    self.class.create itemId: itemId, path: path
   end
 
   def expired?

data/app/models/sufia/download.rb

@@ -0,0 +1,9 @@
+module Sufia
+  class Download
+    extend Legato::Model
+
+    metrics :totalEvents
+    dimensions :eventCategory, :eventAction, :eventLabel, :date
+    filter :for_file, &lambda {|id| matches(:eventLabel, id)}
+  end 
+end

data/app/models/trophy.rb

@@ -1,5 +1,5 @@
 class Trophy < ActiveRecord::Base
-  validate :count_within_limit, :on => :create
+  validate :count_within_limit, on: :create
 
   def count_within_limit
     if Trophy.where(user_id:self.user_id).count >= 5

data/app/services/sufia/{usage_statistics.rb → analytics.rb}

@@ -3,7 +3,7 @@ require 'oauth2'
 require 'legato'
 
 module Sufia
-  module UsageStatistics
+  module Analytics
     # Loads configuration options from config/analytics.yml. Expected structure:
     # `analytics:`
     # `  app_name: GOOGLE_OAUTH_APP_NAME`
@@ -16,29 +16,6 @@ module Sufia
       @config ||= YAML.load(File.read(File.join(Rails.root, 'config', 'analytics.yml')))['analytics']
     end
 
-    # Convert query results into json for plotting in JQuery Flot
-    # @param [Legato::Query] A Legato query object containing the results
-    # @return [Array] An array of arrays represented in JSON: `[[1388563200000,4],[1388649600000,8],...]`
-    def self.as_flot_json(ga_results)
-      # Convert Legato query to hash
-      results_list = ga_results.map(&:marshal_dump)
-      # Results should look like: [[DATE_INT, NUM_HITS], ...]
-      values = results_list.map do |result_hash|
-        result_hash[:date] = Date.parse(result_hash[:date]).to_time.to_i * 1000
-        result_hash[:pageviews] = result_hash[:pageviews].to_i
-        result_hash.values
-      end
-
-      values.to_json
-    end
-
-    # Calculate total pageviews based on query results
-    # @param [Legato::Query] A Legato query object containing the results
-    # @return [Fixnum] An integer representing how many pageviews were recorded
-    def self.total_pageviews(ga_results)
-      ga_results.map(&:marshal_dump).reduce(0) { |total, result| total + result[:pageviews].to_i }
-    end
-
     # Generate an OAuth2 token for Google Analytics
     # @return [OAuth2::AccessToken] An OAuth2 access token for GA
     def self.token

data/app/services/sufia/id_service.rb

@@ -7,7 +7,7 @@ module Sufia
       Sufia.config.noid_template
     end
 
-    @minter = ::Noid::Minter.new(:template => noid_template)
+    @minter = ::Noid::Minter.new(template: noid_template)
     @pid = $$
     @namespace = Sufia.config.id_namespace
     @semaphore = Mutex.new
@@ -32,7 +32,7 @@ module Sufia
       File.open(Sufia.config.minter_statefile, File::RDWR|File::CREAT, 0644) do |f|
         f.flock(File::LOCK_EX)
         yaml = YAML::load(f.read)
-        yaml = {:template => noid_template} unless yaml
+        yaml = {template: noid_template} unless yaml
         minter = ::Noid::Minter.new(yaml)
         pid = "#{@namespace}:#{minter.mint}"
         f.rewind

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

@@ -7,7 +7,7 @@ class Sufia::Models::InstallGenerator < Rails::Generators::Base
 
   source_root File.expand_path('../templates', __FILE__)
 
-  argument     :model_name, :type => :string , :default => "user"
+  argument     :model_name, type: :string , default: "user"
   desc """
 This generator makes the following changes to your application:
  1. Creates several database migrations if they do not exist in /db/migrate
@@ -104,6 +104,10 @@ This generator makes the following changes to your application:
     generate 'sufia:models:usagestats'
   end
 
+  def install_blacklight_gallery
+    generate "blacklight_gallery:install"
+  end
+
   private
 
   def better_migration_template(file)
@@ -113,5 +117,4 @@ This generator makes the following changes to your application:
       say_status("warning", e.message, :yellow)
     end
   end
-
 end

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

@@ -1,3 +1,3 @@
 ActionMailer::Base.smtp_settings = {
-  :address                  => "smtp.psu.edu"
+  address: "smtp.psu.edu"
 }

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

@@ -2,8 +2,8 @@
 Sufia.config do |config|
 
   config.fits_to_desc_mapping= {
-    :file_title => :title,
-    :file_author => :creator
+    file_title: :title,
+    file_author: :creator
   }
 
   # Specify a different template for your repositories unique identifiers
@@ -61,7 +61,9 @@ Sufia.config do |config|
   config.queue = Sufia::Resque::Queue
 
   # Enable displaying usage statistics in the UI
-  config.usage_statistics = true
+  # Defaults to FALSE
+  # Requires a Google Analytics id and OAuth2 keyfile.  See README for more info
+  config.analytics = false
 
   # Specify a Google Analytics tracking ID to gather usage statistics
   # config.google_analytics_id = 'UA-99999999-1'

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

@@ -1,14 +1,14 @@
 class ActsAsFollowerMigration < ActiveRecord::Migration
   def self.up
-    create_table :follows, :force => true do |t|
-      t.references :followable, :polymorphic => true, :null => false
-      t.references :follower,   :polymorphic => true, :null => false
-      t.boolean :blocked, :default => false, :null => false
+    create_table :follows, force: true do |t|
+      t.references :followable, polymorphic: true, null: false
+      t.references :follower,   polymorphic: true, null: false
+      t.boolean :blocked, default: false, null: false
       t.timestamps
     end
 
-    add_index :follows, ["follower_id", "follower_type"],     :name => "fk_follows"
-    add_index :follows, ["followable_id", "followable_type"], :name => "fk_followables"
+    add_index :follows, ["follower_id", "follower_type"],     name: "fk_follows"
+    add_index :follows, ["followable_id", "followable_type"], name: "fk_followables"
   end
 
   def self.down

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

@@ -9,12 +9,11 @@ class CreateChecksumAuditLogs < ActiveRecord::Migration
       t.string :actual_result
       t.timestamps
     end
-    add_index :checksum_audit_logs, [:pid, :dsid], :name=>'by_pid_and_dsid', :order => {:created_at => "DESC" }
-
+    add_index :checksum_audit_logs, [:pid, :dsid], name: 'by_pid_and_dsid', order: {created_at: "DESC" }
   end
 
   def self.down
-    remove_index(:checksum_audit_logs, :name => 'by_pid_and_dsid')
+    remove_index(:checksum_audit_logs, name: 'by_pid_and_dsid')
     drop_table :checksum_audit_logs
   end
 end

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

@@ -1,37 +1,37 @@
 class CreateLocalAuthorities < ActiveRecord::Migration
   def self.up
-    create_table :local_authority_entries, :force => true do |t|
+    create_table :local_authority_entries, force: true do |t|
       t.integer :local_authority_id
       t.string :label
       t.string :uri
     end
 
-    create_table :local_authorities, :force => true do |t|
-      t.string :name, :unique => true
+    create_table :local_authorities, force: true do |t|
+      t.string :name, unique: true
     end
 
-    create_table :domain_terms, :force => true do |t|
+    create_table :domain_terms, force: true do |t|
       t.string :model
       t.string :term
     end
 
-    create_table :domain_terms_local_authorities, :id => false do |t|
-      t.integer :domain_term_id, :foreign_key => true
-      t.integer :local_authority_id, :foreign_key => true
+    create_table :domain_terms_local_authorities, id: false do |t|
+      t.integer :domain_term_id, foreign_key: true
+      t.integer :local_authority_id, foreign_key: true
     end
 
-    create_table :subject_local_authority_entries, :force => true  do |t|
+    create_table :subject_local_authority_entries, force: true  do |t|
       t.string :label
       t.string :lowerLabel
       t.string :url
     end
 
-    add_index :local_authority_entries, [:local_authority_id, :label], :name => 'entries_by_term_and_label'
-    add_index :local_authority_entries, [:local_authority_id, :uri], :name => 'entries_by_term_and_uri'
-    add_index :domain_terms, [:model, :term], :name => 'terms_by_model_and_term'
-    add_index :domain_terms_local_authorities, [:local_authority_id, :domain_term_id], :name => 'dtla_by_ids1'
-    add_index :domain_terms_local_authorities, [:domain_term_id, :local_authority_id], :name => 'dtla_by_ids2'
-    add_index :subject_local_authority_entries, [:lowerLabel], :name => 'entries_by_lower_label'
+    add_index :local_authority_entries, [:local_authority_id, :label], name: 'entries_by_term_and_label'
+    add_index :local_authority_entries, [:local_authority_id, :uri], name: 'entries_by_term_and_uri'
+    add_index :domain_terms, [:model, :term], name: 'terms_by_model_and_term'
+    add_index :domain_terms_local_authorities, [:local_authority_id, :domain_term_id], name: 'dtla_by_ids1'
+    add_index :domain_terms_local_authorities, [:domain_term_id, :local_authority_id], name: 'dtla_by_ids2'
+    add_index :subject_local_authority_entries, [:lowerLabel], name: 'entries_by_lower_label'
   end
 
   def self.down
@@ -40,11 +40,11 @@ class CreateLocalAuthorities < ActiveRecord::Migration
     drop_table :domain_terms
     drop_table :domain_terms_local_authorities
     drop_table :subject_local_authority_entries
-    remove_index :local_authority_entries, :name => "entries_by_term_and_label"
-    remove_index :local_authority_entries, :name => "entries_by_term_and_uri"
-    remove_index :domain_terms, :name => "terms_by_model_and_term"
-    remove_index :subject_local_authority_entries, :name => 'entries_by_lower_label'
-    remove_index :domain_terms_local_authorities, :name => 'dtla_by_ids1'
-    remove_index :domain_terms_local_authorities, :name => 'dtla_by_ids2'
+    remove_index :local_authority_entries, name: "entries_by_term_and_label"
+    remove_index :local_authority_entries, name: "entries_by_term_and_uri"
+    remove_index :domain_terms, name: "terms_by_model_and_term"
+    remove_index :subject_local_authority_entries, name: 'entries_by_lower_label'
+    remove_index :domain_terms_local_authorities, name: 'dtla_by_ids1'
+    remove_index :domain_terms_local_authorities, name: 'dtla_by_ids2'
   end
 end

data/lib/sufia/ability.rb

@@ -17,7 +17,7 @@ module Sufia
     end
 
     def generic_file_abilities
-      can :create, GenericFile if user_groups.include? 'registered'
+      can :create, [GenericFile, Collection] if user_groups.include? 'registered'
     end
 
     def editor_abilities