sufia 6.0.0 → 6.1.0

data/config/locales/sufia.en.yml

@@ -133,9 +133,16 @@ en:
     user_profile:
       no_followers: "No one is following you."
       no_following: "You are not following anyone."
+      no_followers_other: "No one is following this user."
+      no_following_other: "This user is not following anyone."
       orcid:
         alt: "ORCID icon"
         label: "ORCID Profile"
+      zotero:
+        alt: "Zotero icon"
+        label: "Zotero Profile"
+        connected: "Connected!"
+        unlinked: "Link with Zotero"
     batch:
       help:
         title: "Filename will be the default title. Please provide a more meaningful title, and filenames will still be preserved by the system."
@@ -162,6 +169,9 @@ en:
       browse_view: "Browse View"
     footer:
       copyright_html: "<strong>Copyright &copy; 2015 Project Hydra</strong> Licensed under the Apache License, Version 2.0"
+    admin:
+      stats:
+        registered: "Registered"
 
   simple_form:
     labels:
@@ -204,4 +214,3 @@ en:
         description: "Usage information for abstract or summary"
         tag: "Usage information for keyword"
         rights: "Usage information for rights"
-

data/config/routes.rb

@@ -1,5 +1,4 @@
 Sufia::Engine.routes.draw do
-
   # Downloads controller route
   resources :homepage, only: 'index'
 
@@ -105,6 +104,21 @@ Sufia::Engine.routes.draw do
   post 'contact' => 'contact_form#create', as: :contact_form_index
   get 'contact' => 'contact_form#new'
 
+  # API routes
+  if Sufia.config.arkivo_api
+    namespace :api do
+      if defined?(Sufia::ArkivoConstraint)
+        constraints Sufia::ArkivoConstraint do
+          resources :items, except: [:index, :edit, :new], defaults: { format: :json }
+        end
+      end
+
+      get 'zotero' => 'zotero#initiate', as: :zotero_initiate
+      get 'zotero/callback' => 'zotero#callback', as: :zotero_callback
+    end
+  end
+
+  # Collections routes
   mount Hydra::Collections::Engine => '/'
 
   # Resque monitoring routes. Don't bother with this route unless Sufia::ResqueAdmin
@@ -117,6 +131,14 @@ Sufia::Engine.routes.draw do
     end
   end
 
+  if defined?(Sufia::StatsAdmin)
+    namespace :admin do
+      constraints Sufia::StatsAdmin do
+        get 'stats' => 'stats#index', as: :stats
+      end
+    end
+  end
+
   resources :content_blocks, only: ['create', 'update']
   get 'featured_researchers' => 'content_blocks#index', as: :featured_researchers
   post '/tinymce_assets' => 'tinymce_assets#create'

data/lib/generators/sufia/admin_stat_generator.rb

@@ -0,0 +1,17 @@
+# -*- encoding : utf-8 -*-
+require 'rails/generators'
+
+class Sufia::AdminStatGenerator < Rails::Generators::Base
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  desc """
+This is a generator for adding Admin Stats into sufia
+       """
+
+  def insert_stats_admin
+    copy_file 'sufia/stats_admin.rb', 'config/initializers/stats_admin.rb'
+  end
+
+end
+

data/lib/generators/sufia/install_generator.rb

@@ -19,13 +19,15 @@ module Sufia
          """
 
     def run_required_generators
+      say_status("info", "GENERATING BLACKLIGHT", :blue)
       generate "blacklight:install --devise"
+      say_status("info", "GENERATING HYDRA", :blue)
       generate "hydra:head -f"
       generate "sufia:models:install"
     end
 
     def banner
-      say_status("warning", "GENERATING SUFIA", :yellow)
+      say_status("info", "GENERATING SUFIA", :blue)
     end
 
     def insert_abilities
@@ -40,7 +42,7 @@ module Sufia
       file_path = "app/controllers/application_controller.rb"
       if File.exists?(file_path)
         insert_into_file file_path, after: 'include Blacklight::Controller' do
-          "  \n# Adds Sufia behaviors into the application controller \n" +
+          "  \n# Adds Sufia behaviors into the application controller (#{controller_name}) \n" +
           "  include Sufia::Controller\n"
         end
         gsub_file file_path, "layout 'blacklight'", "layout 'sufia-one-column'"
@@ -70,7 +72,6 @@ module Sufia
                 '//= require_tree .', '//= require sufia'
     end
 
-
     def tinymce_config
       copy_file "config/tinymce.yml", "config/tinymce.yml"
     end
@@ -109,5 +110,9 @@ module Sufia
       generate "blacklight_gallery:install"
     end
 
+    def install_admin_stats
+      generate "sufia:admin_stat"
+    end
+
   end
 end

data/{sufia-models/lib/generators/sufia/models/templates/config/resque_admin.rb → lib/generators/sufia/templates/sufia/stats_admin.rb}

@@ -1,10 +1,10 @@
+# -*- coding: utf-8 -*-
 module Sufia
-  class ResqueAdmin
+  class StatsAdmin
     def self.matches?(request)
       current_user = request.env['warden'].user
       return false if current_user.blank?
-      # TODO code a group here that makes sense
-      #current_user.groups.include? 'umg/up.dlt.scholarsphere-admin'
+      current_user.groups.include? 'admin'
     end
   end
 end

data/lib/generators/sufia/upgrade400_generator.rb

@@ -21,7 +21,7 @@ This generator for upgrading sufia from 3.7.2 to 4.0 makes the following changes
        """
 
   def banner
-    say_status("warning", "UPGRADING SUFIA", :yellow)
+    say_status("info", "UPGRADING SUFIA", :blue)
   end
 
   # The engine routes have to come after the devise routes so that /users/sign_in will work
@@ -42,7 +42,7 @@ This generator for upgrading sufia from 3.7.2 to 4.0 makes the following changes
     file_path = "app/controllers/catalog_controller.rb"
     if File.exists?(file_path)
       insert_into_file file_path, after: 'include Hydra::Controller::ControllerBehavior' do
-        "\n  # Adds Sufia behaviors to the catalog controller\n" +
+        "\n  # Adds Sufia behaviors to the catalog controller (#{controller_name})\n" +
         "  include Sufia::Catalog\n"
       end
     else

data/lib/sufia.rb

@@ -8,6 +8,9 @@ require "sufia/version"
 require 'blacklight'
 require 'blacklight_advanced_search'
 require 'sufia/models'
+require 'sufia/inflections'
+require 'sufia/arkivo'
+require 'sufia/zotero'
 
 require 'rails_autolink'
 require 'font-awesome-rails'

data/lib/sufia/arkivo.rb

@@ -0,0 +1,11 @@
+require 'sufia/arkivo/config'
+require 'sufia/arkivo/schema_validator'
+require 'sufia/arkivo/metadata_munger'
+require 'sufia/arkivo/actor'
+require 'sufia/arkivo/create_subscription_job'
+
+module Sufia
+  module Arkivo
+    VERSION = Sufia::VERSION
+  end
+end

data/lib/sufia/arkivo/actor.rb

@@ -0,0 +1,95 @@
+require 'base64'
+require 'tempfile'
+
+# Ugly monkeypatch to make Tempfiles quack like UploadedFiles
+Tempfile.class_eval do
+  attr_accessor :original_filename, :content_type
+end
+
+module Sufia
+  module Arkivo
+    class Actor
+      attr_reader :user, :item
+
+      def initialize(user, item)
+        @user = user
+        @item = item
+      end
+
+      def create_file_from_item
+        batch = Batch.create
+        file_actor = Sufia::GenericFile::Actor.new(::GenericFile.new, user)
+        file_actor.create_metadata(batch.id)
+        store_checksum(file_actor.generic_file)
+        file_actor.create_content(file, item['file']['filename'], file_path, item['file']['contentType'])
+        BatchUpdateJob.new(user.user_key, batch.id, item['metadata']['title'], attributes, default_visibility).run
+        file_actor.generic_file
+      end
+
+      def update_file_from_item(gf)
+        file_actor = Sufia::GenericFile::Actor.new(gf, user)
+        reset_metadata(file_actor)
+        file_actor.update_metadata(attributes, default_visibility)
+        store_checksum(file_actor.generic_file)
+        file_actor.update_content(file, file_path)
+        file_actor.generic_file
+      end
+
+      def destroy_file(gf)
+        gf.destroy
+      end
+
+      private
+
+        def reset_metadata(actor)
+          actor.generic_file.tap do |gf|
+            gf.resource_type = []
+            gf.title = []
+            gf.rights = []
+            gf.tag = []
+            gf.creator = []
+            gf.description = []
+            gf.publisher = []
+            gf.date_created = []
+            gf.based_near = []
+            gf.identifier = []
+            gf.related_url = []
+            gf.language = []
+            gf.contributor = []
+          end
+        end
+
+        def store_checksum(gf)
+          gf.arkivo_checksum = item['file']['md5']
+        end
+
+        def default_visibility
+          'open'
+        end
+
+        def attributes
+          Sufia::Arkivo::MetadataMunger.new(item['metadata']).call
+        end
+
+        def file_path
+          'content'
+        end
+
+        def file
+          extract_file_from_item
+        end
+
+        def extract_file_from_item
+          encoded = item['file']['base64']
+          content = Base64.decode64(encoded)
+          tmp = Tempfile.new(item['file']['md5'], { encoding: Encoding::UTF_8 })
+          tmp.binmode
+          tmp.original_filename = item['file']['filename']
+          tmp.content_type = item['file']['contentType']
+          tmp.write(content)
+          tmp.rewind
+          tmp
+        end
+    end
+  end
+end

data/lib/sufia/arkivo/config.rb

@@ -0,0 +1,11 @@
+module Sufia
+  module Arkivo
+    def self.config
+      @config ||= YAML.load(ERB.new(IO.read(File.join(Rails.root, 'config', 'arkivo.yml'))).result).with_indifferent_access[Rails.env]
+    end
+
+    def self.new_subscription_url
+      '/api/subscription'
+    end
+  end
+end

data/lib/sufia/arkivo/create_subscription_job.rb

@@ -0,0 +1,67 @@
+module Sufia
+  module Arkivo
+    class SubscriptionError < RuntimeError
+    end
+
+    class CreateSubscriptionJob
+      attr_reader :user
+
+      def queue_name
+        :arkivo_subscription
+      end
+
+      def initialize(user_key)
+        @user = ::User.find_by_user_key(user_key)
+        validate_user!
+      end
+
+      def run
+        # post json to API
+        response = post_to_api
+        # parse results
+        subscription_path = response.headers['Location']
+        # create subscription
+        user.arkivo_subscription = subscription_path
+        user.save
+      end
+
+      private
+
+      def logger
+        ActiveFedora::Base.logger
+      end
+
+      def validate_user!
+        log_and_raise('User not found') if user.blank?
+        log_and_raise('User does not have an Arkivo token') if user.arkivo_token.blank?
+        log_and_raise('User has not yet connected with Zotero') if user.zotero_userid.blank?
+        log_and_raise('User already has a subscription') if user.arkivo_subscription.present?
+      end
+
+      def log_and_raise(message)
+        logger.error "*** Arkivo error: #{message}: #{user}"
+        raise SubscriptionError.new(message)
+      end
+
+      def post_to_api
+        Faraday.new(url: Sufia::Arkivo.config[:url]).post do |request|
+          request.url Sufia::Arkivo.new_subscription_url
+          request.headers['Content-Type'] = 'application/json'
+          request.body = new_subscription_json
+        end
+      end
+
+      def new_subscription_json
+        {
+          url: Sufia::Zotero.publications_url(@user.zotero_userid),
+          plugins: [
+            {
+              name: "sufia",
+              options: { token: @user.arkivo_token }
+            }
+          ]
+        }.to_json
+      end
+    end
+  end
+end

data/lib/sufia/arkivo/metadata_munger.rb

@@ -0,0 +1,51 @@
+module Sufia
+  module Arkivo
+    CREATOR_TYPES = ['author', 'interviewer', 'director', 'scriptwriter',
+      'inventor', 'composer', 'cartographer', 'programmer', 'artist',
+      'bookAuthor'
+    ]
+
+    CONTRIBUTOR_TYPES = ['contributor', 'editor', 'translator', 'seriesEditor',
+      'interviewee', 'producer', 'castMember', 'sponsor', 'counsel',
+      'attorneyAgent', 'recipient', 'performer', 'wordsBy', 'commenter',
+      'presenter', 'guest', 'podcaster', 'reviewedAuthor', 'cosponsor'
+    ]
+
+    class MetadataMunger
+      def initialize(metadata)
+        @metadata = metadata
+      end
+
+      def call
+        munged = {}
+
+        # First, normalize camelCase symbols to underscore strings
+        @metadata.each do |key, value|
+          munged[key.to_s.underscore] = Array(value)
+        end
+
+        # Then, rename the url key to related_url
+        munged['related_url'] = munged.delete('url') if munged['url']
+
+        # Then, rename the tags key to tag
+        munged['tag'] = munged.delete('tags') if munged['tags']
+
+        # Then, normalize creator names
+        munged_creators = munged['creators'].each do |entry|
+          next if entry['name']
+          entry['name'] = "#{entry.delete('lastName')}, #{entry.delete('firstName')}".strip
+        end
+
+        # Then, parse creators and contributors out
+        creator_names = munged_creators.select { |c| Sufia::Arkivo::CREATOR_TYPES.include? c['creatorType'] }.map { |c| c['name'] }
+        contributor_names = munged_creators.select { |c| Sufia::Arkivo::CONTRIBUTOR_TYPES.include? c['creatorType'] }.map { |c| c['name'] }
+        munged['creator'] = creator_names unless creator_names.blank?
+        munged['contributor'] = contributor_names unless contributor_names.blank?
+
+        # And remove the original creators array
+        munged.delete('creators') if munged['creators']
+        munged
+      end
+    end
+  end
+end

data/lib/sufia/arkivo/schema_validator.rb

@@ -0,0 +1,55 @@
+require 'json-schema'
+
+module Sufia
+  module Arkivo
+    ITEM_SCHEMA = {
+      type: 'object',
+      properties: {
+        token: { type: 'string', required: true },
+        metadata: {
+          type: 'object',
+          required: true,
+          properties: {
+            title: { type: 'string', required: true },
+            rights: { type: 'string', required: true },
+            resourceType: { type: 'string' },
+            description: { type: 'string' },
+            publisher: { type: 'string' },
+            dateCreated: { type: 'string' },
+            basedNear: { type: 'string' },
+            identifier: { type: 'string' },
+            url: { type: 'string' },
+            language: { type: 'string' }
+          }
+        },
+        file: {
+          type: 'object',
+          required: true,
+          properties: {
+            base64: { type: 'string', required: true },
+            md5: { type: 'string', required: true },
+            filename: { type: 'string', required: true },
+            contentType: { type: 'string', required: true }
+          }
+        }
+      }
+    }
+
+    class InvalidItem < RuntimeError
+    end
+
+    class SchemaValidator
+      attr_reader :item
+
+      def initialize(item)
+        @item = item
+      end
+
+      def call
+        JSON::Validator.validate!(Sufia::Arkivo::ITEM_SCHEMA, item, version: :draft3)
+      rescue JSON::Schema::ValidationError => exception
+        raise Sufia::Arkivo::InvalidItem.new(exception.message)
+      end
+    end
+  end
+end