sufia-models 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77e86bd02adbf9fa79ab2de87508dc843d402376
-  data.tar.gz: 0c8fab48b8fce691fd8973a3839b4e0c7c556138
+  metadata.gz: 1400794c267e0bde112c7a4668b7ee6e06e9b327
+  data.tar.gz: 298a15cf5c6e769a2526d81cbb815916d5fe3630
 SHA512:
-  metadata.gz: e1bfec2d18baea1222f4913180e4c20dd58bb1ca6db08de6867c8f1cb802a48ceeb71859d16457aa5662e685df5ab7195c7659e3ed7b69442a10c55bb37b3312
-  data.tar.gz: f9800b7407df366242d621e8316af5db16533dd1e9c2030480ded54514243069827e662de6239c3acfe8a30e04e45548d4d7546c1db4c9ba8abc12aeca3bb5a5
+  metadata.gz: f112d21ca35fef090bbe579b096d758eb17e4c592bc16c40f7f4a2a94c646e9859ce733aadeb9580acacee22495934eed3f764e14701068c2c772fe142a299dc
+  data.tar.gz: 6b8047750da470d340a0a985a3ffdd722b2a09dc6ecf04da43eed32c18e8b9559abaf3a44152144d83bc12d0dfbe01db16a73eaeb4e69b1c346397bb26ca09c9

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

@@ -0,0 +1,35 @@
+module Sufia
+  module FileStatUtils
+
+    def to_flots stats
+      stats.map {|stat| stat.to_flot}
+    end
+
+    def convert_date date_time
+      date_time.to_datetime.to_i * 1000
+    end
+
+    private
+
+    def cached_stats(file_id, start_date, method)
+      stats = self.where(file_id:file_id).order(date: :asc)
+      ga_start_date = stats.size > 0 ? stats[stats.size-1].date + 1.day : start_date.to_date
+      {ga_start_date: ga_start_date, cached_stats: stats.to_a }
+    end
+
+    def combined_stats file_id, start_date, object_method, ga_key
+      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.save unless Date.parse(stat[:date]) == Date.today
+          stats << lstat
+        end
+      end
+      stats
+    end
+
+  end
+end

data/app/models/file_download_stat.rb

@@ -0,0 +1,18 @@
+class FileDownloadStat < ActiveRecord::Base
+  extend Sufia::FileStatUtils
+
+  def to_flot
+    [ self.class.convert_date(date), downloads ]
+  end
+
+  def self.statistics file_id, start_date
+    combined_stats file_id, start_date, :downloads, :totalEvents
+  end
+
+  # Sufia::Download is sent to Sufia::Analytics.profile as #sufia__download
+  # see Legato::ProfileMethods.method_name_from_klass
+  def self.ga_statistics start_date, file_id
+    Sufia::Analytics.profile.sufia__download(sort: 'date', start_date: start_date, end_date: Date.yesterday).for_file(file_id)
+  end
+
+end

data/app/models/file_usage.rb

@@ -8,52 +8,23 @@ class FileUsage
     earliest = Sufia.config.analytic_start_date
     self.created = DateTime.parse(::GenericFile.find(id).create_date)
     self.created = earliest > created ? earliest : created unless earliest.blank?
-    self.downloads = download_statistics
-    self.pageviews = pageview_statistics
+    self.downloads = FileDownloadStat.to_flots FileDownloadStat.statistics(id, created)
+    self.pageviews = FileViewStat.to_flots FileViewStat.statistics(id, created)
   end
 
   def total_downloads
-    self.downloads.map(&:marshal_dump).reduce(0) { |total, result| total + result[:totalEvents].to_i }
+    self.downloads.reduce(0) { |total, result| total + result[1].to_i }
   end
 
   def total_pageviews
-    self.pageviews.map(&:marshal_dump).reduce(0) { |total, result| total + result[:pageviews].to_i }
+    self.pageviews.reduce(0) { |total, result| total + result[1].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 }
+      { label: "Pageviews",  data: pageviews },
+      { label: "Downloads",  data: downloads }
     ]
   end
-
-  private
-
-  # Sufia::Download is sent to Sufia::Analytics.profile as #sufia__download
-  # see Legato::ProfileMethods.method_name_from_klass
-  def download_statistics
-    Sufia::Analytics.profile.sufia__download(sort: 'date', start_date: created).for_file(self.id)
-  end
-
-  # Sufia::Pageview is sent to Sufia::Analytics.profile as #sufia__pageview
-  # see Legato::ProfileMethods.method_name_from_klass
-  def pageview_statistics
-    Sufia::Analytics.profile.sufia__pageview(sort: 'date', start_date: created).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/file_view_stat.rb

@@ -0,0 +1,18 @@
+class FileViewStat < ActiveRecord::Base
+  extend Sufia::FileStatUtils
+
+  def to_flot
+    [ self.class.convert_date(date), views ]
+  end
+
+  def self.statistics file_id, start_date
+    combined_stats file_id, start_date, :views, :pageviews
+  end
+
+  # Sufia::Download is sent to Sufia::Analytics.profile as #sufia__download
+  # see Legato::ProfileMethods.method_name_from_klass
+  def self.ga_statistics start_date, file_id
+    path = Sufia::Engine.routes.url_helpers.generic_file_path(Sufia::Noid.noidify(file_id))
+    Sufia::Analytics.profile.sufia__pageview(sort: 'date', start_date: start_date).for_path(path)
+  end
+end

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

@@ -0,0 +1,53 @@
+# -*- encoding : utf-8 -*-
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class Sufia::Models::CachedStatsGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  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)
+  end
+
+  # 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'
+    ].each do |file|
+      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/install_generator.rb

@@ -18,6 +18,7 @@ This generator makes the following changes to your application:
  6. Installs Blacklight gallery
  7. Runs full-text generator
  8. Runs proxies generator
+ 9. Runs cached stats generator
        """
 
   # Implement the required interface for Rails::Generators::Migration.
@@ -56,9 +57,7 @@ This generator makes the following changes to your application:
       'add_linkedin_to_users.rb',
       'create_tinymce_assets.rb',
       'create_content_blocks.rb',
-      'create_featured_works.rb',
-      'create_proxy_deposit_requests.rb',
-      'create_proxy_deposit_rights.rb'
+      'create_featured_works.rb'
     ].each do |file|
       better_migration_template file
     end
@@ -106,10 +105,15 @@ This generator makes the following changes to your application:
   end
 
   # Sets up proxies and transfers
-  def full_text_indexing
+  def proxies
     generate "sufia:models:proxies"
   end
 
+  # Sets up cached usage stats
+  def cached_stats
+    generate 'sufia:models:cached_stats'
+  end
+
   private
 
   def better_migration_template(file)

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

@@ -0,0 +1,12 @@
+class CreateFileDownloadStats < ActiveRecord::Migration
+  def change
+    create_table :file_download_stats do |t|
+      t.datetime :date
+      t.integer :downloads
+      t.string  :file_id
+
+      t.timestamps
+    end
+    add_index :file_download_stats, :file_id
+  end
+end

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

@@ -0,0 +1,12 @@
+class CreateFileViewStats < ActiveRecord::Migration
+  def change
+    create_table :file_view_stats do |t|
+      t.datetime :date
+      t.integer :views
+      t.string  :file_id
+
+      t.timestamps
+    end
+    add_index :file_view_stats, :file_id
+  end
+end

data/lib/sufia/models/version.rb

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

data/sufia-models.gemspec

@@ -42,4 +42,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'google-api-client', '~> 0.7'
   spec.add_dependency 'legato', '~> 0.3'
   spec.add_dependency 'activerecord-import', '~> 0.5'
+  if RUBY_VERSION < '2.1.0'
+    spec.add_dependency 'mini_magick', '< 4'
+  else
+    spec.add_dependency 'mini_magick'
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sufia-models
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Jeremy Friesen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-31 00:00:00.000000000 Z
+date: 2014-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -260,6 +260,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Models and services for sufia
 email:
 - jeremy.n.friesen@gmail.com
@@ -285,6 +299,7 @@ files:
 - app/models/collection.rb
 - app/models/concerns/sufia/ability.rb
 - app/models/concerns/sufia/collection.rb
+- app/models/concerns/sufia/file_stat_utils.rb
 - app/models/concerns/sufia/generic_file.rb
 - app/models/concerns/sufia/generic_file/accessible_attributes.rb
 - app/models/concerns/sufia/generic_file/audit.rb
@@ -313,7 +328,9 @@ files:
 - app/models/datastreams/properties_datastream.rb
 - app/models/domain_term.rb
 - app/models/featured_work.rb
+- app/models/file_download_stat.rb
 - app/models/file_usage.rb
+- app/models/file_view_stat.rb
 - app/models/follow.rb
 - app/models/generic_file.rb
 - app/models/geo_names_resource.rb
@@ -334,6 +351,7 @@ files:
 - app/services/sufia/id_service.rb
 - app/services/sufia/noid.rb
 - config/locales/sufia.en.yml
+- lib/generators/sufia/models/cached_stats_generator.rb
 - lib/generators/sufia/models/fulltext_generator.rb
 - lib/generators/sufia/models/install_generator.rb
 - lib/generators/sufia/models/proxies_generator.rb
@@ -358,6 +376,8 @@ files:
 - lib/generators/sufia/models/templates/migrations/create_checksum_audit_logs.rb
 - lib/generators/sufia/models/templates/migrations/create_content_blocks.rb
 - lib/generators/sufia/models/templates/migrations/create_featured_works.rb
+- lib/generators/sufia/models/templates/migrations/create_file_download_stats.rb
+- lib/generators/sufia/models/templates/migrations/create_file_view_stats.rb
 - lib/generators/sufia/models/templates/migrations/create_local_authorities.rb
 - lib/generators/sufia/models/templates/migrations/create_proxy_deposit_requests.rb
 - lib/generators/sufia/models/templates/migrations/create_proxy_deposit_rights.rb
@@ -405,7 +425,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Models and services for sufia