sufia-models 0.0.1

data/app/models/datastreams/generic_file_rdf_datastream.rb

@@ -0,0 +1,75 @@
+# Copyright © 2012 The Pennsylvania State University
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class GenericFileRdfDatastream < ActiveFedora::NtriplesRDFDatastream
+  map_predicates do |map|
+    map.part_of(:to => "isPartOf", :in => RDF::DC)
+    map.contributor(:in => RDF::DC) do |index|
+      index.as :stored_searchable, :facetable
+    end
+    map.creator(:in => RDF::DC) do |index|
+      index.as :stored_searchable, :facetable
+    end
+    map.title(:in => RDF::DC) do |index|
+      index.as :stored_searchable
+    end
+    map.description(:in => RDF::DC) do |index|
+      index.type :text
+      index.as :stored_searchable
+    end
+    map.publisher(:in => RDF::DC) do |index|
+      index.as :stored_searchable, :facetable
+    end
+    map.date_created(:to => "created", :in => RDF::DC) do |index|
+      index.as :stored_searchable
+    end
+    map.date_uploaded(:to => "dateSubmitted", :in => RDF::DC) do |index|
+      index.type :date
+      index.as :stored_sortable
+    end
+    map.date_modified(:to => "modified", :in => RDF::DC) do |index|
+      index.type :date
+      index.as :stored_sortable
+    end
+    map.subject(:in => RDF::DC) do |index|
+      index.as :stored_searchable, :facetable
+    end
+    map.language(:in => RDF::DC) do |index|
+      index.as :stored_searchable, :facetable
+    end
+    map.rights(:in => RDF::DC) do |index|
+      index.as :stored_searchable
+    end
+    map.resource_type(:to => "type", :in => RDF::DC) do |index|
+      index.as :stored_searchable, :facetable
+    end
+    map.identifier(:in => RDF::DC) do |index|
+      index.as :stored_searchable
+    end
+    map.based_near(:in => RDF::FOAF) do |index|
+      index.as :stored_searchable, :facetable
+    end
+    map.tag(:to => "relation", :in => RDF::DC) do |index|
+      index.as :stored_searchable, :facetable
+    end
+    map.related_url(:to => "seeAlso", :in => RDF::RDFS)
+  end
+  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
+end

data/app/models/datastreams/paranoid_rights_datastream.rb

@@ -0,0 +1,37 @@
+# Copyright © 2012 The Pennsylvania State University
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'hydra/datastream/rights_metadata'
+# subclass built-in Hydra RightsDatastream and build in extra model-level validation
+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') }}
+  ]
+
+  def validate(object)
+    valid = true
+    VALIDATIONS.each do |validation|
+      if validation[:condition].call(object)
+        object.errors[validation[:key]] ||= []
+        object.errors[validation[:key]] << validation[:message]
+        valid = false
+      end
+    end
+    return valid
+  end
+end

data/app/models/datastreams/properties_datastream.rb

@@ -0,0 +1,33 @@
+# Copyright © 2012 The Pennsylvania State University
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# 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.proxy_depositor path: 'proxyDepositor', :index_as=>:symbol
+  end
+
+  def self.xml_template
+    builder = Nokogiri::XML::Builder.new do |xml|
+      xml.fields
+    end
+    builder.doc
+  end
+end

data/app/models/domain_term.rb

@@ -0,0 +1,18 @@
+# Copyright © 2012 The Pennsylvania State University
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class DomainTerm < ActiveRecord::Base
+  attr_accessible :model, :term
+  has_and_belongs_to_many :local_authorities, :uniq=> true 
+end

data/app/models/follow.rb

@@ -0,0 +1,28 @@
+# Copyright © 2012 The Pennsylvania State University
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+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
+
+  def block!
+    self.update_attribute(:blocked, true)
+  end
+
+end

data/app/models/generic_file.rb

@@ -0,0 +1,16 @@
+# Copyright © 2012 The Pennsylvania State University
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+class GenericFile < ActiveFedora::Base
+  include Sufia::GenericFile
+end

data/app/models/geo_names_resource.rb

@@ -0,0 +1,34 @@
+# Copyright © 2012 The Pennsylvania State University
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+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/, "") 
+  end 
+ 
+  def self.instantiate_collection(collection, prefix_options = {})
+      col = super(collection["geonames"],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      
+  end
+ 
+  def self.find_location(location)
+    return GeoNamesResource.find(:all, :params => { :q =>location, :username=>"cam156", :maxRows=>10})
+  end
+  
+end

data/app/models/group.rb

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

data/app/models/local_authority.rb

@@ -0,0 +1,93 @@
+# Copyright © 2012 The Pennsylvania State University
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'rdf'
+require 'rdf/rdfxml'
+
+class LocalAuthority < ActiveRecord::Base
+  attr_accessible :name
+  has_and_belongs_to_many :domain_terms, :uniq=> true 
+  has_many :local_authority_entries
+
+  def self.harvest_rdf(name, sources, opts = {})
+    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|
+        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
+        end
+      end
+    end
+    LocalAuthorityEntry.import entries
+  end
+
+  def self.harvest_tsv(name, sources, opts = {})
+    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])
+        end
+      end
+    end
+    LocalAuthorityEntry.import entries
+  end
+
+  def self.register_vocabulary(model, term, name)
+    authority = self.find_by_name(name)
+    return if authority.blank?
+    model = model.to_s.sub(/RdfDatastream$/, '').underscore.pluralize
+    domain_term = DomainTerm.find_or_create_by_model_and_term(:model => model, :term => term)
+    return if domain_term.local_authorities.include? authority
+    domain_term.local_authorities << authority
+  end
+
+  def self.entries_by_term(model, term, query)
+    return if query.empty?
+    lowQuery = 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 
+      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}
+        end
+      end
+    end
+    return hits
+  end
+end

data/app/models/local_authority_entry.rb

@@ -0,0 +1,18 @@
+# Copyright © 2012 The Pennsylvania State University
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class LocalAuthorityEntry < ActiveRecord::Base
+  belongs_to :local_authority
+  attr_accessible :local_authority, :label, :uri
+end

data/app/models/single_use_link.rb

@@ -0,0 +1,26 @@
+class SingleUseLink < ActiveRecord::Base
+
+  attr_accessible :downloadKey, :expires, :itemId, :path
+
+    
+  
+  def self.create_show(item_id)
+     create_path(item_id, Sufia::Engine.routes.url_helpers.generic_file_path(item_id) )     
+  end
+
+  def self.create_download(item_id)
+     create_path(item_id, Sufia::Engine.routes.url_helpers.download_path(item_id) )
+  end
+  
+  def expired?
+     now = DateTime.now
+     return (now > expires)
+  end
+  
+  protected
+  def self.create_path(itemId, path)
+     expires = DateTime.now.advance(hours:24)
+     key = Digest::SHA2.new << DateTime.now.to_f.to_s      
+     return create({downloadKey:key.to_s, expires:expires, path:path, itemId:itemId} )
+  end
+end

data/app/models/subject_local_authority_entry.rb

@@ -0,0 +1,16 @@
+# Copyright © 2012 The Pennsylvania State University
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class SubjectLocalAuthorityEntry < ActiveRecord::Base
+end

data/app/models/trophy.rb

@@ -0,0 +1,12 @@
+class Trophy < ActiveRecord::Base
+  attr_accessible :generic_file_id, :user_id
+
+  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
+  end
+end
+

data/app/models/version_committer.rb

@@ -0,0 +1,17 @@
+# Copyright © 2012 The Pennsylvania State University
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class VersionCommitter < ActiveRecord::Base
+  attr_accessible :obj_id, :datastream_id, :version_id, :committer_login
+end