sufia-models 6.2.0 → 6.3.0

data/app/models/file_download_stat.rb

@@ -2,17 +2,16 @@ class FileDownloadStat < ActiveRecord::Base
   extend Sufia::FileStatUtils
 
   def to_flot
-    [ self.class.convert_date(date), downloads ]
+    [self.class.convert_date(date), downloads]
   end
 
-  def self.statistics file_id, start_date, user_id=nil
+  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
   # see Legato::ProfileMethods.method_name_from_klass
-  def self.ga_statistics start_date, file_id
+  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

@@ -1,8 +1,7 @@
 class FileUsage
-
   attr_accessor :id, :created, :path, :downloads, :pageviews
 
-  def initialize id
+  def initialize(id)
     file = ::GenericFile.find(id)
     user = User.where(email: file.depositor).first
     user_id = user ? user.id : nil
@@ -14,31 +13,31 @@ class FileUsage
     self.pageviews = FileViewStat.to_flots FileViewStat.statistics(id, created, user_id)
   end
 
-  # file.date_uploaded reflects the date the file was uploaded by the user 
-  # and therefore (if available) the date that we want to use for the stats 
-  # file.create_date reflects the date the file was added to Fedora. On data 
-  # migrated from one repository to another the created_date can be later 
+  # file.date_uploaded reflects the date the file was uploaded by the user
+  # and therefore (if available) the date that we want to use for the stats
+  # file.create_date reflects the date the file was added to Fedora. On data
+  # migrated from one repository to another the created_date can be later
   # than the date the file was uploaded.
-  def date_for_analytics(file) 
+  def date_for_analytics(file)
     earliest = Sufia.config.analytic_start_date
     date_uploaded = string_to_date file.date_uploaded
     date_analytics = date_uploaded ? date_uploaded : file.create_date
     return date_analytics if earliest.blank?
-    earliest > date_analytics ? earliest : date_analytics 
+    earliest > date_analytics ? earliest : date_analytics
   end
 
   def string_to_date(date_str)
-    return DateTime.parse(date_str) 
+    return DateTime.parse(date_str)
   rescue ArgumentError, TypeError
     return nil
   end
 
   def total_downloads
-    self.downloads.reduce(0) { |total, result| total + result[1].to_i }
+    downloads.reduce(0) { |total, result| total + result[1].to_i }
   end
 
   def total_pageviews
-    self.pageviews.reduce(0) { |total, result| total + result[1].to_i }
+    pageviews.reduce(0) { |total, result| total + result[1].to_i }
   end
 
   # Package data for visualization using JQuery Flot

data/app/models/file_view_stat.rb

@@ -2,16 +2,16 @@ class FileViewStat < ActiveRecord::Base
   extend Sufia::FileStatUtils
 
   def to_flot
-    [ self.class.convert_date(date), views ]
+    [self.class.convert_date(date), views]
   end
 
-  def self.statistics file_id, start_date, user_id=nil
+  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
   # see Legato::ProfileMethods.method_name_from_klass
-  def self.ga_statistics start_date, file_id
+  def self.ga_statistics(start_date, file_id)
     path = Sufia::Engine.routes.url_helpers.generic_file_path(file_id)
     Sufia::Analytics.profile.sufia__pageview(sort: 'date', start_date: start_date).for_path(path)
   end

data/app/models/follow.rb

@@ -7,6 +7,6 @@ class Follow < ActiveRecord::Base
   belongs_to :follower, polymorphic: true
 
   def block!
-    self.update_attribute(:blocked, true)
+    update_attribute(:blocked, true)
   end
 end

data/app/models/geo_names_resource.rb

@@ -8,11 +8,11 @@ class GeoNamesResource < ActiveResource::Base
   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} }
+    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 } }
   end
 
   def self.find_location(location)
-    return GeoNamesResource.find(:all, params: { q: location, username: "cam156", maxRows: 10})
+    GeoNamesResource.find(:all, params: { q: location, username: "cam156", maxRows: 10 })
   end
 end

data/app/models/group.rb

@@ -1,8 +1,6 @@
 ## This could extend from a module that would make it an ldap group
 class Group
-
-  def self.exists?(cn)
+  def self.exists?(_cn)
     false
   end
-
 end

data/app/models/local_authority.rb

@@ -1,37 +1,35 @@
 class LocalAuthority < ActiveRecord::Base
-
-  # TODO we should add an index on this join table and remove the uniq query
+  # TODO: we should add an index on this join table and remove the uniq query
   has_and_belongs_to_many :domain_terms, -> { uniq }
-  
+
   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 where(name: name).empty?
+    authority = 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|
         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)
-          end
+          next unless statement.predicate == predicate
+          entries << LocalAuthorityEntry.new(local_authority: authority,
+                                             label: statement.object.to_s,
+                                             uri: statement.subject.to_s)
         end
       end
     end
     if LocalAuthorityEntry.respond_to? :import
       LocalAuthorityEntry.import entries
     else
-      entries.each { |e| e.save! }
+      entries.each(&:save!)
     end
   end
 
   def self.harvest_tsv(name, sources, opts = {})
-    return unless self.where(name: name).empty?
-    authority = self.create(name: name)
+    return unless where(name: name).empty?
+    authority = create(name: name)
     prefix = opts.fetch(:prefix, "")
     entries = []
     sources.each do |uri|
@@ -47,12 +45,12 @@ class LocalAuthority < ActiveRecord::Base
     if LocalAuthorityEntry.respond_to? :import
       LocalAuthorityEntry.import entries
     else
-      entries.each { |e| e.save! }
+      entries.each(&:save!)
     end
   end
 
   def self.register_vocabulary(model, term, name)
-    authority = self.find_by_name(name)
+    authority = find_by_name(name)
     return if authority.blank?
     model = model.to_s.sub(/RdfDatastream$/, '').underscore.pluralize
     domain_term = DomainTerm.find_or_create_by(model: model, term: term)
@@ -62,25 +60,25 @@ class LocalAuthority < ActiveRecord::Base
 
   def self.entries_by_term(model, term, query)
     return if query.empty?
-    lowQuery = query.downcase
+    low_query = query.downcase
     hits = []
-    # move lc_subject into it's own table since being part of the usual structure caused it to be too slow.  
-    # When/if we move to having multiple dictionaries for subject we will need to also do a check for the appropriate dictionary. 
-    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}
-        end
-    else 
+    # move lc_subject into it's own table since being part of the usual structure caused it to be too slow.
+    # When/if we move to having multiple dictionaries for subject we will need to also do a check for the appropriate dictionary.
+    if term == 'subject' && model == 'generic_files' # and local_authoritiy = lc_subject
+      sql = SubjectLocalAuthorityEntry.where("lowerLabel like ?", "#{low_query}%").select("label, uri").limit(25).to_sql
+      SubjectLocalAuthorityEntry.find_by_sql(sql).each do |hit|
+        hits << { uri: hit.uri, label: hit.label }
+      end
+    else
       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
+        authorities = dterm.local_authorities.collect(&:id).uniq
+        sql = LocalAuthorityEntry.where("local_authority_id in (?)", authorities).where("lower(label) like ?", "#{low_query}%").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
-    return hits
+    hits
   end
 end

data/app/models/proxy_deposit_request.rb

@@ -24,31 +24,31 @@ class ProxyDepositRequest < ActiveRecord::Base
   end
 
   def sending_user_should_not_be_receiving_user
-    errors.add(:sending_user, 'must specify another user to receive the file') if receiving_user and receiving_user.user_key == sending_user.user_key
+    errors.add(:sending_user, 'must specify another user to receive the file') if receiving_user && receiving_user.user_key == sending_user.user_key
   end
 
   def should_not_be_already_part_of_a_transfer
     transfers = ProxyDepositRequest.where(generic_file_id: generic_file_id, status: 'pending')
-    errors.add(:open_transfer, 'must close open transfer on the file before creating a new one') unless transfers.blank? || ( transfers.count == 1 && transfers[0].id == self.id)
+    errors.add(:open_transfer, 'must close open transfer on the file before creating a new one') unless transfers.blank? || (transfers.count == 1 && transfers[0].id == id)
   end
 
   def send_request_transfer_message
-    if self.updated_at == self.created_at
+    if updated_at == created_at
       message = "#{link_to(sending_user.name, Sufia::Engine.routes.url_helpers.profile_path(sending_user.user_key))} wants to transfer a file to you. Review all <a href='#{Sufia::Engine.routes.url_helpers.transfers_path}'>transfer requests</a>"
       User.batchuser.send_message(receiving_user, message, "Ownership Change Request")
-      else
-        message = "Your transfer request was #{status}."
-        message = message + " Comments: #{receiver_comment}" if !receiver_comment.blank?
-        User.batchuser.send_message(sending_user, message, "Ownership Change #{status}")
+    else
+      message = "Your transfer request was #{status}."
+      message += " Comments: #{receiver_comment}" unless receiver_comment.blank?
+      User.batchuser.send_message(sending_user, message, "Ownership Change #{status}")
     end
   end
 
   def pending?
-    self.status == 'pending'
+    status == 'pending'
   end
 
   def accepted?
-    self.status == 'accepted'
+    status == 'accepted'
   end
 
   # @param [Boolean] reset (false) should the access controls be reset. This means revoking edit access from the depositor

data/app/models/single_use_link.rb

@@ -1,42 +1,34 @@
 class SingleUseLink < ActiveRecord::Base
-
   validate :expiration_date_cannot_be_in_the_past
   validate :cannot_be_destroyed
 
   after_initialize :set_defaults
 
-  def create_for_path path
-    self.class.create itemId: itemId, path: path
+  def create_for_path(path)
+    self.class.create(itemId: itemId, path: path)
   end
 
   def expired?
     DateTime.now > expires
   end
 
-
   def to_param
     downloadKey
   end
 
   protected
 
-  def expiration_date_cannot_be_in_the_past
-    if expired?
-       errors.add(:expires, "can't be in the past")
+    def expiration_date_cannot_be_in_the_past
+      errors.add(:expires, "can't be in the past") if expired?
     end
-  end
 
-  def cannot_be_destroyed
-    if destroyed?
-      errors[:base] << "Single Use Link has already been used"
+    def cannot_be_destroyed
+      errors[:base] << "Single Use Link has already been used" if destroyed?
     end
-  end
 
-  def set_defaults
-    if new_record?
-      self.expires ||= DateTime.now.advance(hours:24)
-      self.downloadKey ||= (Digest::SHA2.new << rand(1000000000).to_s).to_s
+    def set_defaults
+      return unless new_record?
+      self.expires ||= DateTime.now.advance(hours: 24)
+      self.downloadKey ||= (Digest::SHA2.new << rand(1_000_000_000).to_s).to_s
     end
-  end
-
 end

data/app/models/sufia/download.rb

@@ -4,6 +4,6 @@ module Sufia
 
     metrics :totalEvents
     dimensions :eventCategory, :eventAction, :eventLabel, :date
-    filter :for_file, &lambda {|id| matches(:eventLabel, id)}
-  end 
+    filter :for_file, &->(id) { matches(:eventLabel, id) }
+  end
 end

data/app/models/sufia/pageview.rb

@@ -4,6 +4,6 @@ module Sufia
 
     metrics :pageviews
     dimensions :date
-    filter :for_path, &lambda { |path| contains(:pagePath, path) }
+    filter :for_path, &->(path) { contains(:pagePath, path) }
   end
 end

data/app/models/trophy.rb

@@ -2,9 +2,7 @@ class Trophy < ActiveRecord::Base
   validate :count_within_limit, on: :create
 
   def count_within_limit
-    if Trophy.where(user_id:self.user_id).count >= 5
-      errors.add(:base, "Exceeded trophy limit")
-    end
+    return if Trophy.where(user_id: user_id).count < 5
+    errors.add(:base, "Exceeded trophy limit")
   end
 end
-

data/app/services/sufia/analytics.rb

@@ -20,29 +20,28 @@ module Sufia
     # @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 = Google::APIClient.new(application_name: config['app_name'],
+                                     application_version: config['app_version'])
+      key = Google::APIClient::PKCS12.load_key(config['privkey_path'],
+                                               config['privkey_secret'])
+      service_account = Google::APIClient::JWTAsserter.new(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'})
+      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)
+      Legato::User.new(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|
+      user.profiles.detect do |profile|
         profile.web_property_id == Sufia.config.google_analytics_id
       end
     end

data/app/services/sufia/generic_file_audit_service.rb

@@ -11,12 +11,12 @@ module Sufia
     def human_readable_audit_status
       stat = audit_stat
       case stat
-        when 0
-          'failing'
-        when 1
-          'passing'
-        else
-          stat
+      when 0
+        'failing'
+      when 1
+        'passing'
+      else
+        stat
       end
     end
 
@@ -27,8 +27,8 @@ module Sufia
       audit_content([])
     end
 
-
     private
+
       def audit_content(log)
         if generic_file.content.has_versions?
           audit_file_versions("content", log)
@@ -37,9 +37,9 @@ module Sufia
         end
       end
 
-      def audit_file_versions file, log
+      def audit_file_versions(file, log)
         generic_file.attached_files[file].versions.all.each do |version|
-          log << audit_file(file, version.uri,  version.label)
+          log << audit_file(file, version.uri, version.label)
         end
         log
       end
@@ -59,7 +59,7 @@ module Sufia
         audit_results = audit.collect { |result| result["pass"] }
 
         # check how many non runs we had
-        non_runs = audit_results.reduce(0) { |sum, value| value == NO_RUNS ? sum += 1 : sum }
+        non_runs = audit_results.reduce(0) { |sum, value| value == NO_RUNS ? sum + 1 : sum }
         if non_runs == 0
           audit_results.reduce(true) { |sum, value| sum && value }
         elsif non_runs < audit_results.length
@@ -76,7 +76,7 @@ module Sufia
       def audit_stat_by_id
         audit_results = ChecksumAuditLog.logs_for(generic_file.id, "content").collect { |result| result["pass"] }
 
-        if audit_results.length >  0
+        if audit_results.length > 0
           audit_results.reduce(true) { |sum, value| sum && value }
         else
           'Audits have not yet been run on this file.'
@@ -102,6 +102,5 @@ module Sufia
       def days_since_last_audit(latest_audit)
         (DateTime.now - latest_audit.updated_at.to_date).to_i
       end
-
   end
 end