sufia 3.7.2 → 4.0.0.beta1

data/sufia-models/app/models/datastreams/properties_datastream.rb

@@ -1,18 +1,4 @@
 # properties datastream: catch-all for info that didn't have another home.  Particularly depositor.
 class PropertiesDatastream < ActiveFedora::OmDatastream
-  set_terminology do |t|
-    t.root(:path=>"fields" ) 
-    # This is where we put the user id of the object depositor -- impacts permissions/access controls
-    t.depositor :index_as=>[:stored_searchable]
-    # This is where we put the relative path of the file if submitted as a folder
-    t.relative_path
-    t.import_url path: 'importUrl', :index_as=>:symbol
-  end
-
-  def self.xml_template
-    builder = Nokogiri::XML::Builder.new do |xml|
-      xml.fields
-    end
-    builder.doc
-  end
+  include Sufia::PropertiesDatastreamBehavior
 end

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

@@ -0,0 +1,22 @@
+class FeaturedWork < ActiveRecord::Base
+  FEATURE_LIMIT = 5
+  validate :count_within_limit, on: :create
+  validates :order, inclusion: { in: Proc.new{ 0..FEATURE_LIMIT } }
+
+  default_scope { order(:order) }
+
+  def count_within_limit
+    unless FeaturedWork.can_create_another?
+      errors.add(:base, "Limited to #{FEATURE_LIMIT} featured works.")
+    end
+  end
+
+  attr_accessor :generic_file_solr_document
+
+  class << self
+    def can_create_another?
+      FeaturedWork.count < FEATURE_LIMIT
+    end
+  end
+end
+

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

@@ -0,0 +1,9 @@
+module Sufia
+  class Pageview
+    extend Legato::Model
+
+    metrics :pageviews
+    dimensions :date
+    filter :for_path, &lambda { |path| contains(:pagePath, path) }
+  end
+end

data/sufia-models/app/services/sufia/usage_statistics.rb

@@ -0,0 +1,73 @@
+require 'google/api_client'
+require 'oauth2'
+require 'legato'
+
+module Sufia
+  module UsageStatistics
+    # Loads configuration options from config/analytics.yml. Expected structure:
+    # `analytics:`
+    # `  app_name: GOOGLE_OAUTH_APP_NAME`
+    # `  app_version: GOOGLE_OAUTH_APP_VERSION`
+    # `  privkey_path: GOOGLE_OAUTH_PRIVATE_KEY_PATH`
+    # `  privkey_secret: GOOGLE_OAUTH_PRIVATE_KEY_SECRET`
+    # `  client_email: GOOGLE_OAUTH_CLIENT_EMAIL`
+    # @return [Hash] A hash containing five keys: 'app_name', 'app_version', 'client_email', 'privkey_path', 'privkey_secret'
+    def self.config
+      @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
+      scope = 'https://www.googleapis.com/auth/analytics.readonly'
+      client = Google::APIClient.new(application_name: self.config['app_name'],
+        application_version: self.config['app_version'])
+      key = Google::APIClient::PKCS12.load_key(self.config['privkey_path'],
+        self.config['privkey_secret'])
+      service_account = Google::APIClient::JWTAsserter.new(self.config['client_email'], scope,
+        key)
+      client.authorization = service_account.authorize
+      oauth_client = OAuth2::Client.new('', '', {
+          authorize_url: 'https://accounts.google.com/o/oauth2/auth',
+          token_url: 'https://accounts.google.com/o/oauth2/token'})
+      OAuth2::AccessToken.new(oauth_client, client.authorization.access_token)
+    end
+
+    # Return a user object linked to a Google Analytics account
+    # @return [Legato::User] A user account wit GA access
+    def self.user
+      Legato::User.new(self.token)
+    end
+
+    # Return a Google Analytics profile matching specified ID
+    # @ return [Legato::Management::Profile] A user profile associated with GA
+    def self.profile
+      self.user.profiles.detect do |profile|
+        profile.web_property_id == Sufia.config.google_analytics_id
+      end
+    end
+  end
+end

data/sufia-models/config/locales/sufia.en.yml

@@ -1,6 +1,5 @@
 en:
   sufia:
-    product_name:       "ScholarSphere"
-    institution_name:   "Penn State"
-    institution_name_full: "The Pennsylvania State University"                                                
-
+    product_name:       "Sufia"
+    institution_name:   "Institution Name"
+    institution_name_full: "The Institution Name"

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

@@ -15,6 +15,7 @@ This generator makes the following changes to your application:
  3. Creates the sufia.rb configuration file
  4. Adds Sufia::SolrDocumentBehavior to app/models/solr_document.rb
  5. Generates mailboxer
+ 6. Generates usage stats config
        """
 
   # Implement the required interface for Rails::Generators::Migration.
@@ -32,6 +33,10 @@ This generator makes the following changes to your application:
     @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.
@@ -46,7 +51,10 @@ This generator makes the following changes to your application:
       "add_groups_to_users.rb",
       "create_local_authorities.rb",
       "create_trophies.rb",
-      'add_linkedin_to_users.rb'
+      'add_linkedin_to_users.rb',
+      'create_tinymce_assets.rb',
+      'create_content_blocks.rb',
+      'create_featured_works.rb'
     ].each do |file|
       better_migration_template file
     end
@@ -66,19 +74,22 @@ This generator makes the following changes to your application:
   end
 
   def create_configuration_files
-    copy_file "config/sufia.rb", "config/initializers/sufia.rb"
-    copy_file "config/redis.yml", "config/redis.yml"
-    copy_file "config/redis_config.rb", "config/initializers/redis_config.rb"
-    copy_file "config/resque_admin.rb", "config/initializers/resque_admin.rb"
-    copy_file "config/resque_config.rb", "config/initializers/resque_config.rb"
+    inject_into_file 'config/initializers/mime_types.rb',
+                     "\nMime::Type.register 'application/x-endnote-refer', :endnote",
+                     { :after => /# Mime::Type.register_alias "text\/html", :iphone/, :verbose => false }
+    copy_file 'config/sufia.rb', 'config/initializers/sufia.rb'
+    copy_file 'config/redis.yml', 'config/redis.yml'
+    copy_file 'config/redis_config.rb', 'config/initializers/redis_config.rb'
+    copy_file 'config/resque_admin.rb', 'config/initializers/resque_admin.rb'
+    copy_file 'config/resque_config.rb', 'config/initializers/resque_config.rb'
   end
 
   # Add behaviors to the SolrDocument model
   def inject_sufia_solr_document_behavior
     file_path = "app/models/solr_document.rb"
     if File.exists?(file_path)
-      inject_into_class file_path, "SolrDocument" do
-        "  # Adds Sufia behaviors to the SolrDocument.\n" +
+      inject_into_file file_path, after: /include Blacklight::Solr::Document.*$/ do
+        "\n  # Adds Sufia behaviors to the SolrDocument.\n" +
           "  include Sufia::SolrDocumentBehavior\n"
       end
     else
@@ -90,6 +101,10 @@ This generator makes the following changes to your application:
     generate "mailboxer:install"
   end
 
+  def configure_usage_stats
+    generate 'sufia:models:usagestats'
+  end
+
   private
 
   def better_migration_template(file)

data/sufia-models/lib/generators/sufia/models/templates/config/analytics.yml

@@ -0,0 +1,9 @@
+#
+# To integrate your app with Google Analytics, uncomment the lines below and add your API key information.
+#
+# analytics:
+#   :app_name: GOOGLE_OAUTH_APP_NAME
+#   :app_version: GOOGLE_OAUTH_APP_VERSION
+#   :privkey_path: GOOGLE_OAUTH_PRIVATE_KEY_PATH
+#   :privkey_secret: GOOGLE_OAUTH_PRIVATE_KEY_SECRET
+#   :client_email: GOOGLE_OAUTH_CLIENT_EMAIL

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

@@ -0,0 +1,6 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone
+Mime::Type.register 'application/x-endnote-refer', :endnote

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

@@ -60,9 +60,11 @@ Sufia.config do |config|
 
   config.queue = Sufia::Resque::Queue
 
-  # Map hostnames onto Google Analytics tracking IDs
-  # config.google_analytics_id = 'UA-99999999-1'
+  # Enable displaying usage statistics in the UI
+  config.usage_statistics = true
 
+  # Specify a Google Analytics tracking ID to gather usage statistics
+  # config.google_analytics_id = 'UA-99999999-1'
 
   # Where to store tempfiles, leave blank for the system temp directory (e.g. /tmp)
   # config.temp_file_base = '/home/developer1'
@@ -76,6 +78,13 @@ Sufia.config do |config|
   # Specify the path to the file characterization tool:
   # config.fits_path = "fits.sh"
 
+  # If browse-everything has been configured, load the configs.  Otherwise, set to nil.
+  begin
+    config.browse_everything = BrowseEverything.config
+  rescue Errno::ENOENT
+    config.browse_everything = nil
+  end
+
 end
 
 Date::DATE_FORMATS[:standard] = "%m/%d/%Y"

data/sufia-models/lib/generators/sufia/models/templates/migrations/create_content_blocks.rb

@@ -0,0 +1,10 @@
+class CreateContentBlocks < ActiveRecord::Migration
+  def change
+    create_table :content_blocks do |t|
+      t.string :name
+      t.text :value
+      t.timestamps
+    end
+    add_index :content_blocks, :name, unique: true
+  end
+end

data/sufia-models/lib/generators/sufia/models/templates/migrations/create_featured_works.rb

@@ -0,0 +1,12 @@
+class CreateFeaturedWorks < ActiveRecord::Migration
+  def change
+    create_table :featured_works do |t|
+      t.integer :order, default: 5
+      t.string :generic_file_id
+
+      t.timestamps
+    end
+    add_index :featured_works, :generic_file_id
+    add_index :featured_works, :order
+  end
+end

data/sufia-models/lib/generators/sufia/models/templates/migrations/create_tinymce_assets.rb

@@ -0,0 +1,8 @@
+class CreateTinymceAssets < ActiveRecord::Migration
+  def change
+    create_table :tinymce_assets do |t|
+      t.string :file
+      t.timestamps
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# -*- encoding : utf-8 -*-
+require 'rails/generators'
+
+class Sufia::Models::UsagestatsGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  desc """
+This generator makes the following changes to your application:
+ 1. Generates usage stats config
+       """
+
+  def banner
+    say_status("warning", "GENERATING SUFIA USAGE STATS", :yellow)
+  end
+
+  def create_configuration_file
+    copy_file 'config/analytics.yml', 'config/analytics.yml'
+  end
+end

data/sufia-models/lib/sufia/ability.rb

@@ -0,0 +1,34 @@
+module Sufia
+  module Ability
+    extend ActiveSupport::Concern
+    included do
+      self.ability_logic += [:sufia_abilities]
+    end
+
+    def sufia_abilities
+      generic_file_abilities
+      featured_work_abilities
+      editor_abilities
+      stats_abilities
+    end
+
+    def featured_work_abilities
+      can [:create, :destroy, :update], FeaturedWork if user_groups.include? 'admin'
+    end
+
+    def generic_file_abilities
+      can :create, GenericFile if user_groups.include? 'registered'
+    end
+
+    def editor_abilities
+      if user_groups.include? 'admin'
+        can :create, TinymceAsset
+        can :update, ContentBlock
+      end
+    end
+
+    def stats_abilities
+      alias_action :stats, to: :read
+    end
+  end
+end

data/sufia-models/lib/sufia/models/engine.rb

@@ -21,7 +21,7 @@ module Sufia
       config.id_namespace = "sufia"
       config.fits_path = "fits.sh"
       config.enable_contact_form_delivery = false
-      config.dropbox_api_key = nil
+      config.browse_everything = nil
       config.enable_local_ingest = nil
       config.queue = Sufia::Resque::Queue
 
@@ -44,7 +44,6 @@ module Sufia
         require 'activerecord-import'
         require 'hydra/derivatives'
         require 'sufia/models/model_methods'
-        require 'sufia/models/noid'
         require 'sufia/models/file_content'
         require 'sufia/models/file_content/versions'
         require 'sufia/models/generic_file/audit'
@@ -55,8 +54,11 @@ module Sufia
         require 'sufia/models/generic_file/thumbnail'
         require 'sufia/models/generic_file'
         require 'sufia/models/user_local_directory_behavior'
-        require 'sufia/models/id_service'
         require 'sufia/models/solr_document_behavior'
+        require 'sufia/noid'
+        require 'sufia/id_service'
+        require 'sufia/usage_statistics'
+        require 'sufia/pageview'
       end
 
       initializer 'configure' do

data/sufia-models/lib/sufia/models/generic_file.rb

@@ -8,6 +8,7 @@ module Sufia
     autoload :WebForm, 'sufia/models/generic_file/web_form'
     autoload :AccessibleAttributes, 'sufia/models/generic_file/accessible_attributes'
     autoload :Trophies, 'sufia/models/generic_file/trophies'
+    autoload :Featured, 'sufia/models/generic_file/featured'
     autoload :Metadata, 'sufia/models/generic_file/metadata'
     autoload :Versions, 'sufia/models/generic_file/versions'
     autoload :VirusCheck, 'sufia/models/generic_file/virus_check'
@@ -23,6 +24,7 @@ module Sufia
     include Sufia::GenericFile::WebForm
     include Sufia::GenericFile::Derivatives
     include Sufia::GenericFile::Trophies
+    include Sufia::GenericFile::Featured
     include Sufia::GenericFile::Metadata
     include Sufia::GenericFile::Versions
     include Sufia::GenericFile::VirusCheck
@@ -76,7 +78,7 @@ module Sufia
     # to each file when it is done uploading.  The Batch object is not created
     # until all objects are done uploading and the user is redirected to
     # BatchController#edit.  Therefore, we must handle the case where
-    # self.batch_id is set but self.batch returns nil. 
+    # self.batch_id is set but self.batch returns nil.
     # This can get a major overhaul with ActiveFedora 7
     def related_files
       relateds = begin
@@ -96,7 +98,7 @@ module Sufia
     end
 
     def to_solr(solr_doc={}, opts={})
-      super(solr_doc, opts)
+      solr_doc = super(solr_doc, opts)
       solr_doc[Solrizer.solr_name('label')] = self.label
       solr_doc[Solrizer.solr_name('noid', Sufia::GenericFile.noid_indexer)] = noid
       solr_doc[Solrizer.solr_name('file_format')] = file_format

data/sufia-models/lib/sufia/models/generic_file/export.rb

@@ -22,7 +22,7 @@ module Sufia
           '%[' => [:date_modified],
           '%9' => [:resource_type],
           '%~' => Application.config.application_name,
-          '%W' => 'Penn State University'
+          '%W' => t('sufia.institution_name')
         }
         text = []
         text << "%0 GenericFile"
@@ -32,7 +32,7 @@ module Sufia
           else
             values = self.send(mapping[0]) if self.respond_to? mapping[0]
             values = mapping[1].call(values) if mapping.length == 2
-            values = [values] unless values.is_a? Array
+            values = Array(values)
           end
           next if values.empty? or values.first.nil?
           spaced_values = values.join("; ")
@@ -64,7 +64,7 @@ module Sufia
           values = self.send(element)
           next if values.empty? or values.first.nil?
           values.each do |value|
-            export_text << "rft.#{kev}=#{CGI::escape(value)}"
+            export_text << "rft.#{kev}=#{CGI::escape(value.to_s)}"
           end
         end
         export_text.join('&') unless export_text.blank?