sufia-models 5.0.0.beta1 → 5.0.0.rc1

data/app/models/concerns/sufia/generic_file/characterization.rb

@@ -3,7 +3,7 @@ module Sufia
     module Characterization
       extend ActiveSupport::Concern
       included do
-        contains "characterization", class_name: 'FitsDatastream'
+        has_metadata "characterization", type: FitsDatastream
         has_attributes :mime_type, datastream: :characterization, multiple: false
         has_attributes :format_label, :file_size, :last_modified,
                                         :filename, :original_checksum, :rights_basis,
@@ -45,11 +45,11 @@ module Sufia
         metadata = content.extract_metadata
         characterization.ng_xml = metadata if metadata.present?
         append_metadata
-        self.filename = [content.original_name]
+        self.filename = [self.label]
         save
       end
 
-      # Populate GenericFile's properties with fields from FITS (e.g. Author from pdfs)
+      # Populate descMetadata with fields from FITS (e.g. Author from pdfs)
       def append_metadata
         terms = self.characterization_terms
         Sufia.config.fits_to_desc_mapping.each_pair do |k, v|

data/app/models/concerns/sufia/generic_file/derivatives.rb

@@ -9,15 +9,15 @@ module Sufia
         makes_derivatives do |obj|
           case obj.mime_type
           when *pdf_mime_types
-            obj.transform_file :content, { thumbnail: { format: 'jpg', size: '338x493', datastream: 'thumbnail' } }
+            obj.transform_datastream :content, { thumbnail: { format: 'jpg', size: '338x493', datastream: 'thumbnail' } }
           when *office_document_mime_types
-            obj.transform_file :content, { thumbnail: { format: 'jpg', size: '200x150>', datastream: 'thumbnail' } }, processor: :document
+            obj.transform_datastream :content, { thumbnail: { format: 'jpg', size: '200x150>', datastream: 'thumbnail' } }, processor: :document
           when *audio_mime_types
-            obj.transform_file :content, { mp3: { format: 'mp3', datastream: 'mp3' }, ogg: { format: 'ogg', datastream: 'ogg' } }, processor: :audio
+            obj.transform_datastream :content, { mp3: { format: 'mp3', datastream: 'mp3' }, ogg: { format: 'ogg', datastream: 'ogg' } }, processor: :audio
           when *video_mime_types
-            obj.transform_file :content, { webm: { format: 'webm', datastream: 'webm' }, mp4: { format: 'mp4', datastream: 'mp4' }, thumbnail: { format: 'jpg', datastream: 'thumbnail' } }, processor: :video
+            obj.transform_datastream :content, { webm: { format: 'webm', datastream: 'webm' }, mp4: { format: 'mp4', datastream: 'mp4' }, thumbnail: { format: 'jpg', datastream: 'thumbnail' } }, processor: :video
           when *image_mime_types
-            obj.transform_file :content, { thumbnail: { format: 'jpg', size: '200x150>', datastream: 'thumbnail' } }
+            obj.transform_datastream :content, { thumbnail: { format: 'jpg', size: '200x150>', datastream: 'thumbnail' } }
           end
         end
       end

data/app/models/concerns/sufia/generic_file/full_text_indexing.rb

@@ -4,7 +4,7 @@ module Sufia
       extend ActiveSupport::Concern
 
       included do
-        contains 'full_text'
+        has_file_datastream 'full_text', versionable: false
       end
 
       def append_metadata
@@ -27,7 +27,7 @@ module Sufia
           extracted_text = JSON.parse(resp.body)[''].rstrip
           full_text.content = extracted_text if extracted_text.present?
         rescue => e
-          logger.error("Error extracting content from #{self.id}: #{e.inspect}")
+          logger.error("Error extracting content from #{self.pid}: #{e.inspect}")
         end
     end
   end

data/app/models/concerns/sufia/generic_file/metadata.rb

@@ -4,88 +4,17 @@ module Sufia
       extend ActiveSupport::Concern
 
       included do
-        contains "content", class_name: 'FileContentDatastream'
-        contains "thumbnail"
-
-        property :label, predicate: ::RDF::DC.title, multiple: false
-
-        property :depositor, predicate: ::RDF::URI.new("http://id.loc.gov/vocabulary/relators/dpt"), multiple: false do |index|
-          index.as :symbol, :stored_searchable
-        end
-
-        property :relative_path, predicate: ::RDF::URI.new('http://scholarsphere.psu.edu/ns#relativePath'), multiple: false
-
-        property :import_url, predicate: ::RDF::URI.new('http://scholarsphere.psu.edu/ns#importUrl'), multiple: false do |index|
-          index.as :symbol
-        end
-
-        property :part_of, predicate: ::RDF::DC.isPartOf
-        property :resource_type, predicate: ::RDF::DC.type do |index|
-          index.as :stored_searchable, :facetable
-        end
-        property :title, predicate: ::RDF::DC.title do |index|
-          index.as :stored_searchable, :facetable
-        end
-        property :creator, predicate: ::RDF::DC.creator do |index|
-          index.as :stored_searchable, :facetable
-        end
-        property :contributor, predicate: ::RDF::DC.contributor do |index|
-          index.as :stored_searchable, :facetable
-        end
-        property :description, predicate: ::RDF::DC.description do |index|
-          index.type :text
-          index.as :stored_searchable
-        end
-        property :tag, predicate: ::RDF::DC.relation do |index|
-          index.as :stored_searchable, :facetable
-        end
-        property :rights, predicate: ::RDF::DC.rights do |index|
-          index.as :stored_searchable
-        end
-        property :publisher, predicate: ::RDF::DC.publisher do |index|
-          index.as :stored_searchable, :facetable
-        end
-        property :date_created, predicate: ::RDF::DC.created do |index|
-          index.as :stored_searchable
-        end
-        property :date_uploaded, predicate: ::RDF::DC.dateSubmitted, multiple: false do |index|
-          index.type :date
-          index.as :stored_sortable
-        end
-        property :date_modified, predicate: ::RDF::DC.modified, multiple: false do |index|
-          index.type :date
-          index.as :stored_sortable
-        end
-        property :subject, predicate: ::RDF::DC.subject do |index|
-          index.as :stored_searchable, :facetable
-        end
-        property :language, predicate: ::RDF::DC.language do |index|
-          index.as :stored_searchable, :facetable
-        end
-        property :identifier, predicate: ::RDF::DC.identifier do |index|
-          index.as :stored_searchable
-        end
-        property :based_near, predicate: ::RDF::FOAF.based_near do |index|
-          index.as :stored_searchable, :facetable
-        end
-        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
-          LocalAuthority.register_vocabulary(self, "subject", "lc_subjects")
-          LocalAuthority.register_vocabulary(self, "language", "lexvo_languages")
-          LocalAuthority.register_vocabulary(self, "tag", "lc_genres")
-        rescue
-          puts "tables for vocabularies missing"
-        end
+        has_metadata "descMetadata", type: GenericFileRdfDatastream
+        has_metadata "properties", type: PropertiesDatastream
+        has_file_datastream "content", type: FileContentDatastream
+        has_file_datastream "thumbnail"
+
+        has_attributes :relative_path, :depositor, :import_url, datastream: :properties, multiple: false
+        has_attributes :date_uploaded, :date_modified, datastream: :descMetadata, multiple: false
+        has_attributes :related_url, :based_near, :part_of, :creator,
+                                    :contributor, :title, :tag, :description, :rights,
+                                    :publisher, :date_created, :subject,
+                                    :resource_type, :identifier, :language, datastream: :descMetadata, multiple: true
       end
 
       # Add a schema.org itemtype

data/app/models/concerns/sufia/generic_file/proxy_deposit.rb

@@ -4,27 +4,18 @@ module Sufia
       extend ActiveSupport::Concern
 
       included do
-        property :proxy_depositor, predicate: ::RDF::URI.new('http://scholarsphere.psu.edu/ns#proxyDepositor'), multiple: false do |index|
-          index.as :symbol
-        end
-
-        # This value is set when a user indicates they are depositing this for someone else
-        property :on_behalf_of, predicate: ::RDF::URI.new('http://scholarsphere.psu.edu/ns#onBehalfOf'), multiple: false do |index|
-          index.as :symbol
-        end
-
+        has_attributes :proxy_depositor, :on_behalf_of, datastream: :properties, multiple: false
         after_create :create_transfer_request
       end
 
-
       def create_transfer_request
-        Sufia.queue.push(ContentDepositorChangeEventJob.new(id, on_behalf_of)) if on_behalf_of.present?
+        Sufia.queue.push(ContentDepositorChangeEventJob.new(pid, on_behalf_of)) if on_behalf_of.present?
       end
 
       def request_transfer_to(target)
         raise ArgumentError, "Must provide a target" unless target
         deposit_user = ::User.find_by_user_key(depositor)
-        ProxyDepositRequest.create!(pid: id, receiving_user: target, sending_user: deposit_user)
+        ProxyDepositRequest.create!(pid: pid, receiving_user: target, sending_user: deposit_user)
       end
     end
   end

data/app/models/concerns/sufia/generic_file/reload_on_save.rb

@@ -0,0 +1,18 @@
+# add this in here until we can use a version of Active Fedora that contains this ability
+module Sufia
+  module GenericFile
+    module ReloadOnSave
+
+      attr_writer :reload_on_save
+
+      def reload_on_save?
+        !!@reload_on_save
+      end
+
+      def refresh
+        self.reload if reload_on_save?
+      end
+    end
+  end
+end
+

data/app/models/concerns/sufia/generic_file/versions.rb

@@ -5,7 +5,10 @@ module Sufia
         version = content.latest_version
         # content datastream not (yet?) present
         return if version.nil?
-        VersionCommitter.create(version_id: version.to_s, committer_login: user.user_key)
+        VersionCommitter.create(obj_id: version.pid,
+                                datastream_id: version.dsid,
+                                version_id: version.versionID,
+                                committer_login: user.user_key)
       end
 
     end

data/app/models/concerns/sufia/generic_file/web_form.rb

@@ -9,22 +9,15 @@ module Sufia
 
       def remove_blank_assertions
         terms_for_editing.each do |key|
-          if self[key] == ['']
-            self[key] = []
-            changed_attributes.delete(key) if attribute_was(key) == []
-          end
+          self[key] = nil if self[key] == ['']
         end
       end
 
       # override this method if you need to initialize more complex RDF assertions (b-nodes)
       def initialize_fields
-        terms_for_editing.select { |key| self[key].blank? }.each do |key|
+        terms_for_editing.each do |key|
           # if value is empty, we create an one element array to loop over for output
-          if self.class.multiple?(key)
-            self[key] = ['']
-          else
-            self[key] = ''
-          end
+          self[key] = [''] if self[key].empty?
         end
       end
 
@@ -47,10 +40,10 @@ module Sufia
 
       def to_jq_upload
         return {
-          "name" => title,
-          "size" => file_size,
+          "name" => self.title,
+          "size" => self.file_size,
           "url" => "/files/#{noid}",
-          "thumbnail_url" => id,
+          "thumbnail_url" => self.pid,
           "delete_url" => "deleteme", # generic_file_path(id: id),
           "delete_type" => "DELETE"
         }

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

@@ -8,25 +8,23 @@ module Sufia
 
     # OVERRIDE to support Hydra::Datastream::Properties which does not
     #   respond to :depositor_values but :depositor
-    # Adds metadata about the depositor to the asset and ads +depositor_id+ to
-    # its individual edit permissions.
+    # Adds metadata about the depositor to the asset
+    # Most important behavior: if the asset has a rightsMetadata datastream, this method will add +depositor_id+ to its individual edit permissions.
+
     def apply_depositor_metadata(depositor)
+      rights_ds = self.datastreams["rightsMetadata"]
+      prop_ds = self.datastreams["properties"]
       depositor_id = depositor.respond_to?(:user_key) ? depositor.user_key : depositor
 
-      self.edit_users += [depositor_id]
-      self.depositor = depositor_id
+      rights_ds.update_indexed_attributes([:edit_access, :person]=>depositor_id) unless rights_ds.nil?
+      prop_ds.depositor = depositor_id unless prop_ds.nil?
 
       return true
     end
 
     def to_s
-      if title.present?
-        Array(title).join(" | ")
-      elsif label.present?
-        Array(label).join(" | ")
-      else
-        "No Title"
-      end
+      return Array(title).join(" | ") if title.present?
+      label || "No Title"
     end
 
   end

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

@@ -0,0 +1,32 @@
+module Sufia
+  module PropertiesDatastreamBehavior
+    extend ActiveSupport::Concern
+
+    included do
+      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: [:symbol, :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
+        t.proxy_depositor path: 'proxyDepositor', index_as: :symbol
+        # This value is set when a user indicates they are depositing this for someone else
+        t.on_behalf_of path: 'onBehalfOf', index_as: :symbol
+      end
+    end
+
+    module ClassMethods
+      def xml_template
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.fields
+        end
+        builder.doc
+      end
+    end
+
+    def prefix
+      ""
+    end
+  end
+end

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

@@ -18,33 +18,55 @@ 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
+
+  # Populate user instance with attributes from remote system (e.g., LDAP)
+  # There is no default implementation -- override this in your application
+  def populate_attributes
   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
@@ -55,13 +77,13 @@ module Sufia::User
 
   def trophy_files
     trophies.map do |t|
-      ::GenericFile.load_instance_from_solr(t.generic_file_id)
+      ::GenericFile.load_instance_from_solr(Sufia::Noid.namespaceize(t.generic_file_id))
     end
   end
 
   # 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 +107,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 +143,5 @@ module Sufia::User
     def from_url_component(component)
       User.find_by_user_key(component.gsub(/-dot-/, '.'))
     end
-
   end
-
 end

data/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