sufia-models 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 225e822263154c92055f19c4a792469b2ce46065
-  data.tar.gz: 710dd7bb7969847ac3362645003d0fc8b0533fde
+  metadata.gz: 77e86bd02adbf9fa79ab2de87508dc843d402376
+  data.tar.gz: 0c8fab48b8fce691fd8973a3839b4e0c7c556138
 SHA512:
-  metadata.gz: 43c341a486f46e61218acb3db3b75cf15fc6e981da57517357fb2c483faf8c22358940510e0edb4f52427e58167f4f4a4902dd317630873179bc96ca70c2a909
-  data.tar.gz: a5469d79e6280e930455bfa6b7241e3c467dfc970a704aae4129bab69c0563783ca913ed2022cb5a7ae8e8260ca5e6d9513a7095e9129ae9503574099d035ff6
+  metadata.gz: e1bfec2d18baea1222f4913180e4c20dd58bb1ca6db08de6867c8f1cb802a48ceeb71859d16457aa5662e685df5ab7195c7659e3ed7b69442a10c55bb37b3312
+  data.tar.gz: f9800b7407df366242d621e8316af5db16533dd1e9c2030480ded54514243069827e662de6239c3acfe8a30e04e45548d4d7546c1db4c9ba8abc12aeca3bb5a5

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

@@ -1,6 +1,7 @@
 module Sufia
   module Ability
     extend ActiveSupport::Concern
+
     included do
       self.ability_logic += [:sufia_abilities]
     end
@@ -10,6 +11,19 @@ module Sufia
       featured_work_abilities
       editor_abilities
       stats_abilities
+      proxy_deposit_abilities
+    end
+
+    def proxy_deposit_abilities
+      can :transfer, String do |pid|
+        get_depositor_from_pid(pid) == current_user.user_key
+      end
+      can :create, ProxyDepositRequest if user_groups.include? 'registered'
+      can :accept, ProxyDepositRequest, receiving_user_id: current_user.id, status: 'pending'
+      can :reject, ProxyDepositRequest, receiving_user_id: current_user.id, status: 'pending'
+      # a user who sent a proxy deposit request can cancel it if it's pending.
+      can :destroy, ProxyDepositRequest, sending_user_id: current_user.id, status: 'pending'
+      can :edit, ::User, id: current_user.id
     end
 
     def featured_work_abilities
@@ -30,5 +44,13 @@ module Sufia
     def stats_abilities
       alias_action :stats, to: :read
     end
+
+    private
+
+    def get_depositor_from_pid(pid)
+      ::GenericFile.load_instance_from_solr(pid).depositor
+    rescue
+      nil
+    end
   end
 end

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

@@ -0,0 +1,22 @@
+module Sufia
+  module GenericFile
+    module ProxyDeposit
+      extend ActiveSupport::Concern
+
+      included do
+        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(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: pid, receiving_user: target, sending_user: deposit_user)
+      end
+    end
+  end
+end

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

@@ -19,6 +19,7 @@ module Sufia
     include Sufia::GenericFile::VirusCheck
     include Sufia::GenericFile::ReloadOnSave
     include Sufia::GenericFile::FullTextIndexing
+    include Sufia::GenericFile::ProxyDeposit
     include Hydra::Collections::Collectible
 
     included do

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

@@ -10,6 +10,9 @@ module Sufia
         # 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
 

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

@@ -18,6 +18,15 @@ module Sufia::User
     # Users should be followable
     acts_as_followable
 
+    # Setup accessible (or protected) attributes for your model
+    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
+
     mount_uploader :avatar, AvatarUploader, mount_on: :avatar_file_name
     validates_with AvatarValidator
     has_many :trophies

data/app/models/proxy_deposit_request.rb

@@ -0,0 +1,85 @@
+class ProxyDepositRequest < ActiveRecord::Base
+  include Blacklight::SolrHelper
+  include ActionView::Helpers::UrlHelper
+
+  belongs_to :receiving_user, class_name: 'User'
+  belongs_to :sending_user, class_name: 'User'
+
+  validates :sending_user, :pid, presence: true
+  validate :transfer_to_should_be_a_valid_username
+  validate :sending_user_should_not_be_receiving_user
+  validate :should_not_be_already_part_of_a_transfer
+
+  after_save :send_request_transfer_message
+
+  attr_reader :transfer_to
+
+  def transfer_to=(key)
+    @transfer_to = key
+    self.receiving_user = User.find_by_user_key(key)
+  end
+
+  def transfer_to_should_be_a_valid_username
+    errors.add(:transfer_to, "must be an existing user") unless receiving_user
+  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
+  end
+
+  def should_not_be_already_part_of_a_transfer
+    transfers = ProxyDepositRequest.where(pid: pid)
+    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)
+  end
+
+  def send_request_transfer_message
+    if self.updated_at == self.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}")
+    end
+  end
+
+  def pending?
+    self.status == 'pending'
+  end
+
+  def accepted?
+    self.status == 'accepted'
+  end
+
+  # @param [Boolean] reset (false) should the access controls be reset. This means revoking edit access from the depositor
+  def transfer!(reset = false)
+    Sufia.queue.push(ContentDepositorChangeEventJob.new(pid, receiving_user.user_key, reset))
+    self.status = 'accepted'
+    self.fulfillment_date = Time.now
+    save!
+  end
+
+  def reject!(comment = nil)
+    self.receiver_comment = comment if comment
+    self.status = 'rejected'
+    self.fulfillment_date = Time.now
+    save!
+  end
+
+  def cancel!
+    self.status = 'canceled'
+    self.fulfillment_date = Time.now
+    save!
+  end
+
+  def deleted_file?
+    !GenericFile.exists?(pid)
+  end
+
+  def title
+    return 'file not found' if deleted_file?
+    query = ActiveFedora::SolrService.construct_query_for_pids([pid])
+    solr_response = ActiveFedora::SolrService.query(query, raw: true)
+    SolrDocument.new(solr_response['response']['docs'].first, solr_response).title
+  end
+end

data/app/models/proxy_deposit_rights.rb

@@ -0,0 +1,4 @@
+class ProxyDepositRights < ActiveRecord::Base
+  belongs_to :grantor, class_name: "User"
+  belongs_to :grantee, class_name: "User"
+end

data/app/models/sufia/avatar_uploader.rb

@@ -1,7 +1,7 @@
 class Sufia::AvatarUploader < CarrierWave::Uploader::Base
   include CarrierWave::MiniMagick
   include CarrierWave::Compatibility::Paperclip
-  
+
   version :medium do
     process resize_to_limit: [300, 300]
   end
@@ -11,11 +11,10 @@ class Sufia::AvatarUploader < CarrierWave::Uploader::Base
   end
 
   def default_url
-    "/assets/missing_#{version_name}.png"
+    "missing_#{version_name}.png"
   end
 
   def extension_white_list
     %w(jpg jpeg png gif bmp tif tiff)
   end
-  
 end

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

@@ -17,6 +17,7 @@ This generator makes the following changes to your application:
  5. Generates usage stats config
  6. Installs Blacklight gallery
  7. Runs full-text generator
+ 8. Runs proxies generator
        """
 
   # Implement the required interface for Rails::Generators::Migration.
@@ -55,7 +56,9 @@ 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_featured_works.rb',
+      'create_proxy_deposit_requests.rb',
+      'create_proxy_deposit_rights.rb'
     ].each do |file|
       better_migration_template file
     end
@@ -102,6 +105,11 @@ This generator makes the following changes to your application:
     generate "sufia:models:fulltext"
   end
 
+  # Sets up proxies and transfers
+  def full_text_indexing
+    generate "sufia:models:proxies"
+  end
+
   private
 
   def better_migration_template(file)

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

@@ -0,0 +1,53 @@
+# -*- encoding : utf-8 -*-
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class Sufia::Models::ProxiesGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  desc """
+This generator adds proxies and transfers 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 PROXY/TRANSFER-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_proxy_deposit_rights.rb',
+      'create_proxy_deposit_requests.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/templates/migrations/create_proxy_deposit_requests.rb

@@ -0,0 +1,16 @@
+class CreateProxyDepositRequests < ActiveRecord::Migration
+  def change
+    create_table :proxy_deposit_requests do |t|
+      t.string :pid, null: false
+      t.references :sending_user, null: false
+      t.references :receiving_user, null: false
+      t.datetime :fulfillment_date
+      t.string :status, null: false, default: 'pending'
+      t.text :sender_comment
+      t.text :receiver_comment
+      t.timestamps
+    end
+    add_index :proxy_deposit_requests, :receiving_user_id
+    add_index :proxy_deposit_requests, :sending_user_id
+  end
+end

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

@@ -0,0 +1,11 @@
+class CreateProxyDepositRights < ActiveRecord::Migration
+  def change
+    create_table :proxy_deposit_rights do |t|
+      t.references :grantor
+      t.references :grantee
+      t.timestamps
+    end
+    add_index :proxy_deposit_rights, :grantor_id
+    add_index :proxy_deposit_rights, :grantee_id
+  end
+end

data/lib/sufia/models/engine.rb

@@ -1,4 +1,3 @@
-require 'sufia/models/resque'
 module Sufia
   module Models
     def self.config(&block)
@@ -10,6 +9,7 @@ module Sufia
     end
 
     class Engine < ::Rails::Engine
+      require 'sufia/models/resque'
 
       # Set some configuration defaults
       config.enable_ffmpeg = false

data/lib/sufia/models/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sufia-models
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.1.0
 platform: ruby
 authors:
 - Jeremy Friesen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-28 00:00:00.000000000 Z
+date: 2014-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -296,6 +296,7 @@ files:
 - app/models/concerns/sufia/generic_file/metadata.rb
 - app/models/concerns/sufia/generic_file/mime_types.rb
 - app/models/concerns/sufia/generic_file/permissions.rb
+- app/models/concerns/sufia/generic_file/proxy_deposit.rb
 - app/models/concerns/sufia/generic_file/reload_on_save.rb
 - app/models/concerns/sufia/generic_file/trophies.rb
 - app/models/concerns/sufia/generic_file/versions.rb
@@ -319,6 +320,8 @@ files:
 - app/models/group.rb
 - app/models/local_authority.rb
 - app/models/local_authority_entry.rb
+- app/models/proxy_deposit_request.rb
+- app/models/proxy_deposit_rights.rb
 - app/models/single_use_link.rb
 - app/models/subject_local_authority_entry.rb
 - app/models/sufia/avatar_uploader.rb
@@ -333,6 +336,7 @@ files:
 - config/locales/sufia.en.yml
 - lib/generators/sufia/models/fulltext_generator.rb
 - lib/generators/sufia/models/install_generator.rb
+- lib/generators/sufia/models/proxies_generator.rb
 - lib/generators/sufia/models/templates/config/analytics.yml
 - lib/generators/sufia/models/templates/config/clamav.rb
 - lib/generators/sufia/models/templates/config/mailboxer.rb
@@ -355,6 +359,8 @@ files:
 - 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_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
 - lib/generators/sufia/models/templates/migrations/create_single_use_links.rb
 - lib/generators/sufia/models/templates/migrations/create_tinymce_assets.rb
 - lib/generators/sufia/models/templates/migrations/create_trophies.rb
@@ -399,7 +405,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Models and services for sufia