sufia-models 0.0.1

data/lib/sufia/models/model_methods.rb

@@ -0,0 +1,39 @@
+# 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/model_methods'
+module Sufia
+  module ModelMethods
+    extend ActiveSupport::Concern
+
+    included do
+      include Hydra::ModelMethods
+    end
+
+    # OVERRIDE to support Hydra::Datastream::Properties which does not
+    #   respond to :depositor_values but :depositor
+    # 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_id)
+      rights_ds = self.datastreams["rightsMetadata"]
+      prop_ds = self.datastreams["properties"]
+
+      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
+  end
+end

data/lib/sufia/models/noid.rb

@@ -0,0 +1,42 @@
+# 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.
+
+module Sufia
+  module Noid
+    def Noid.noidify(identifier)
+      identifier.split(":").last
+    end
+
+    def Noid.namespaceize(identifier)
+      if identifier.start_with?(Noid.namespace)
+        identifier
+      else
+        "#{Noid.namespace}:#{identifier}"
+      end
+    end
+
+    def noid
+      Noid.noidify(self.pid)
+    end
+
+    def normalize_identifier
+      params[:id] = Noid.namespaceize(params[:id])
+    end
+
+    protected
+    def Noid.namespace
+      Sufia::Engine.config.id_namespace
+    end
+  end
+end

data/lib/sufia/models/solr_document_behavior.rb

@@ -0,0 +1,125 @@
+# 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.
+
+# -*- encoding : utf-8 -*-
+module Sufia
+  module SolrDocumentBehavior
+    def title_or_label
+      title || label
+    end
+
+    ##
+    # Give our SolrDocument an ActiveModel::Naming appropriate route_key
+    def route_key
+      get(Solrizer.solr_name('has_model', :symbol)).split(':').last.downcase
+    end
+
+    ##
+    # Offer the source (ActiveFedora-based) model to Rails for some of the
+    # Rails methods (e.g. link_to).
+    # @example
+    #   link_to '...', SolrDocument(:id => 'bXXXXXX5').new => <a href="/dams_object/bXXXXXX5">...</a>
+    def to_model
+      m = ActiveFedora::Base.load_instance_from_solr(id, self)
+      return self if m.class == ActiveFedora::Base
+      m
+    end
+
+    def noid
+      self[Solrizer.solr_name('noid', Sufia::GenericFile.noid_indexer)]
+    end
+
+    def date_uploaded
+      field = self[Solrizer.solr_name("desc_metadata__date_uploaded", :stored_sortable, type: :date)]
+      return unless field.present?
+      begin
+        Date.parse(field).to_formatted_s(:standard)
+      rescue
+        logger.info "Unable to parse date: #{field.first.inspect} for #{self['id']}"
+      end
+    end
+
+    def depositor(default = '')
+      val = Array(self[Solrizer.solr_name("depositor")]).first
+      val.present? ? val : default
+    end
+
+    def title
+      Array(self[Solrizer.solr_name('desc_metadata__title')]).first
+    end
+
+    def description
+      Array(self[Solrizer.solr_name('desc_metadata__description')]).first
+    end
+
+    def label
+      Array(self[Solrizer.solr_name('label')]).first
+    end
+
+    def file_format
+       Array(self[Solrizer.solr_name('file_format')]).first
+    end
+
+    def creator
+      Array(self[Solrizer.solr_name("desc_metadata__creator")]).first
+    end
+
+    def tags
+      Array(self[Solrizer.solr_name("desc_metadata__tag")])
+    end
+
+    def mime_type
+      Array(self[Solrizer.solr_name("mime_type")]).first
+    end
+
+    def read_groups
+      Array(self[Ability.read_group_field])
+    end
+
+    def edit_groups
+      Array(self[Ability.edit_group_field])
+    end
+
+    def edit_people
+      Array(self[Ability.edit_person_field])
+    end
+
+    def public?
+      read_groups.include?('public')
+    end
+
+    def registered?
+      read_groups.include?('registered')
+    end
+
+
+    def pdf?
+      ['application/pdf'].include? self.mime_type
+    end
+
+    def image?
+      ['image/png','image/jpeg', 'image/jpg', 'image/jp2', 'image/bmp', 'image/gif'].include? self.mime_type
+    end
+
+    def video?
+      ['video/mpeg', 'video/mp4', 'video/webm', 'video/x-msvideo', 'video/avi', 'video/quicktime', 'application/mxf'].include? self.mime_type
+    end
+
+    def audio?
+      # audio/x-wave is the mime type that fits 0.6.0 returns for a wav file.
+      # audio/mpeg is the mime type that fits 0.6.0 returns for an mp3 file.
+      ['audio/mp3', 'audio/mpeg', 'audio/x-wave', 'audio/x-wav', 'audio/ogg'].include? self.mime_type
+    end
+  end
+end

data/lib/sufia/models/user.rb

@@ -0,0 +1,126 @@
+# 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.
+
+module Sufia::User
+  extend ActiveSupport::Concern
+
+  included do
+    # Adds acts_as_messageable for user mailboxes
+    include Mailboxer::Models::Messageable
+    # Connects this user object to Blacklight's Bookmarks and Folders.
+    include Blacklight::User
+    include Hydra::User
+
+    delegate :can?, :cannot?, :to => :ability
+
+    # set this up as a messageable object
+    acts_as_messageable
+
+    # Users should be able to follow things
+    acts_as_follower
+    # Users should be followable
+    acts_as_followable
+
+    # Setup accessible (or protected) attributes for your model
+    attr_accessible :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
+
+    # Add user avatar (via paperclip library)
+    has_attached_file :avatar, :styles => { medium: "300x300>", thumb: "100x100>" }, :default_url => '/assets/missing_:style.png'
+    validates :avatar, :attachment_content_type => { :content_type => /^image\/(jpg|jpeg|pjpeg|png|x-png|gif)$/ }, :if => Proc.new { |p| p.avatar.file? }
+    validates :avatar, :attachment_size => { :less_than => 2.megabytes }, :if => Proc.new { |p| p.avatar.file? }
+
+  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}
+  end
+
+  def email_address
+    return self.email
+  end
+
+  def name
+    return self.display_name.titleize || self.user_key rescue self.user_key
+  end
+
+  # Redefine this for more intuitive keys in Redis
+  def to_param
+    # hack because rails doesn't like periods in urls.
+    user_key.gsub(/\./, '-dot-')
+  end
+
+  # method needed for trophies
+  def trophies
+    trophies = Trophy.where(:user_id => self.id)
+    return trophies
+  end
+
+  #method to get the trophy ids without the namespace included
+  def trophy_ids
+    trophies.map { |t| "#{Sufia::Engine.config.id_namespace}:#{t.generic_file_id}" }
+  end
+
+  # method needed for messaging
+  def mailboxer_email(obj=nil)
+    return nil
+  end
+
+  # The basic groups method, override or will fallback to Sufia::Ldap::User
+  def groups
+    return self.group_list ? self.group_list.split(";?;") : []
+  end
+
+  def ability
+    @ability ||= Ability.new(self)
+  end
+
+  module ClassMethods
+    def current
+      Thread.current[:user]
+    end
+
+    def current=(user)
+      Thread.current[:user] = user
+    end
+
+    # Override this method if you aren't using email/password
+    def audituser
+      User.find_by_user_key(audituser_key) || User.create!(Devise.authentication_keys.first => audituser_key, password: Devise.friendly_token[0,20])
+    end
+
+    # Override this method if you aren't using email as the userkey
+    def audituser_key
+      'audituser@example.com'
+    end
+
+    # Override this method if you aren't using email/password
+    def batchuser
+      User.find_by_user_key(batchuser_key) || User.create!(Devise.authentication_keys.first => batchuser_key, password: Devise.friendly_token[0,20])
+    end
+
+    # Override this method if you aren't using email as the userkey
+    def batchuser_key
+      'batchuser@example.com'
+    end
+
+    def from_url_component(component)
+      User.find_by_user_key(component.gsub(/-dot-/, '.'))
+    end
+
+  end
+
+end

data/lib/sufia/models/utils.rb

@@ -0,0 +1,36 @@
+# 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.
+
+module Sufia
+  module Utils
+    extend ActiveSupport::Concern
+
+    def retry_unless(number_of_tries, condition, &block)
+      self.class.retry_unless(number_of_tries, condition, &block)
+    end
+
+    module ClassMethods
+      def retry_unless(number_of_tries, condition, &block)
+        raise ArgumentError, "First argument must be an enumerator" unless number_of_tries.is_a? Enumerator
+        raise ArgumentError, "Second argument must be a lambda" unless condition.respond_to? :call
+        raise ArgumentError, "Must pass a block of code to retry" unless block_given?
+        number_of_tries.each do
+          result = block.call
+          return result unless condition.call
+        end
+        raise RuntimeError, "retry_unless could not complete successfully. Try upping the # of tries?"
+      end
+    end
+  end
+end

data/lib/sufia/models/version.rb

@@ -0,0 +1,5 @@
+module Sufia
+  module Models
+    VERSION = "0.0.1"
+  end
+end

data/lib/tasks/sufia-models_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :sufia-models do
+#   # Task goes here
+# end

data/sufia-models.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sufia/models/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sufia-models"
+  spec.version       = Sufia::Models::VERSION
+  spec.authors       = [
+    "Jeremy Friesen",
+  ]
+  spec.email         = [
+    "jeremy.n.friesen@gmail.com",
+  ]
+  spec.description   = %q{Models and services for sufia}
+  spec.summary       = %q{Models and services for sufia}
+  spec.homepage      = "https://github.com/projecthydra/sufia-models"
+  spec.license       = "Apache"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "rails", "~> 3.2.13"
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: sufia-models
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jeremy Friesen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+description: Models and services for sufia
+email:
+- jeremy.n.friesen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- app/models/batch.rb
+- app/models/checksum_audit_log.rb
+- app/models/contact_form.rb
+- app/models/datastreams/batch_rdf_datastream.rb
+- app/models/datastreams/file_content_datastream.rb
+- app/models/datastreams/fits_datastream.rb
+- app/models/datastreams/generic_file_rdf_datastream.rb
+- app/models/datastreams/paranoid_rights_datastream.rb
+- app/models/datastreams/properties_datastream.rb
+- app/models/domain_term.rb
+- app/models/follow.rb
+- app/models/generic_file.rb
+- app/models/geo_names_resource.rb
+- app/models/group.rb
+- app/models/local_authority.rb
+- app/models/local_authority_entry.rb
+- app/models/single_use_link.rb
+- app/models/subject_local_authority_entry.rb
+- app/models/trophy.rb
+- app/models/version_committer.rb
+- lib/sufia/models.rb
+- lib/sufia/models/active_fedora/redis.rb
+- lib/sufia/models/active_record/redis.rb
+- lib/sufia/models/engine.rb
+- lib/sufia/models/file_content.rb
+- lib/sufia/models/file_content/extract_metadata.rb
+- lib/sufia/models/file_content/versions.rb
+- lib/sufia/models/generic_file.rb
+- lib/sufia/models/generic_file/actions.rb
+- lib/sufia/models/generic_file/audit.rb
+- lib/sufia/models/generic_file/characterization.rb
+- lib/sufia/models/generic_file/export.rb
+- lib/sufia/models/generic_file/permissions.rb
+- lib/sufia/models/generic_file/thumbnail.rb
+- lib/sufia/models/id_service.rb
+- lib/sufia/models/jobs/audit_job.rb
+- lib/sufia/models/jobs/batch_update_job.rb
+- lib/sufia/models/jobs/characterize_job.rb
+- lib/sufia/models/jobs/content_delete_event_job.rb
+- lib/sufia/models/jobs/content_deposit_event_job.rb
+- lib/sufia/models/jobs/content_new_version_event_job.rb
+- lib/sufia/models/jobs/content_restored_version_event_job.rb
+- lib/sufia/models/jobs/content_update_event_job.rb
+- lib/sufia/models/jobs/event_job.rb
+- lib/sufia/models/jobs/ffmpeg_transcode_job.rb
+- lib/sufia/models/jobs/resolrize_job.rb
+- lib/sufia/models/jobs/transcode_audio_job.rb
+- lib/sufia/models/jobs/transcode_video_job.rb
+- lib/sufia/models/jobs/unzip_job.rb
+- lib/sufia/models/jobs/user_edit_profile_event_job.rb
+- lib/sufia/models/jobs/user_follow_event_job.rb
+- lib/sufia/models/jobs/user_unfollow_event_job.rb
+- lib/sufia/models/model_methods.rb
+- lib/sufia/models/noid.rb
+- lib/sufia/models/solr_document_behavior.rb
+- lib/sufia/models/user.rb
+- lib/sufia/models/utils.rb
+- lib/sufia/models/version.rb
+- lib/tasks/sufia-models_tasks.rake
+- sufia-models.gemspec
+homepage: https://github.com/projecthydra/sufia-models
+licenses:
+- Apache
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Models and services for sufia
+test_files: []