hyrax 2.0.0.beta1 → 2.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5939c7dfed45843b17856611c64ffc82ee4cd492
-  data.tar.gz: d21b1da8507c09373ac8d9b3e0075df873301bad
+  metadata.gz: b1cd321b1dc4e68407d13358c574ce8fe0a0d5c9
+  data.tar.gz: 92530f677f3c9cedb6d6c88446437cf9742596a1
 SHA512:
-  metadata.gz: 742c2367eaf3138530f3bf644003664e86e63b20b8a4ccd5905197fc0ee9da9aa7bdb7f6b72f9a991fdbf7d4f434a9d5d215a83de258ac661dd0dbe251fc1b32
-  data.tar.gz: 819f25b0076a067f2dce5e621ead98d4f2511e61cc0f1a2756a9034512564023772016779e46edeef48f1f787e63c20a5f06f631fc3b3a3669f509d1a7cf88ec
+  metadata.gz: a7aad9a39bc1ff847e9e40ddcdbe7c3eebd24a115ba5967b84cf1482e9225f87f29435a65a19ad4c10f39b4fe4401612ad92dc2d30a42ae4da5df249291c4574
+  data.tar.gz: 740acb400efae6271442fdca1b88506f86cfccbbd6efff94c2a2e1641c78d3fad59d79841c527f2393dd1478632c8ce1098d33c0aa978167e333d94801695434

data/README.md

@@ -36,6 +36,7 @@ Jump in: [![Slack Status](http://slack.samvera.org/badge.svg)](http://slack.samv
     * [Start background workers](#start-background-workers)
     * [Create default administrative set](#create-default-administrative-set)
     * [Generate a work type](#generate-a-work-type)
+    * [Enable notifications](#enable-notifications)
   * [Managing a Hyrax\-based app](#managing-a-hyrax-based-app)
     * [Toggling features](#toggling-features)
   * [License](#license)
@@ -62,7 +63,7 @@ The Samvera community is here to help. Please see our [support guide](./.github/
 # Getting started
 
 This document contains instructions specific to setting up an app with __Hyrax
-v2.0.0.alpha__. If you are looking for instructions on installing a different
+v2.0.0.beta2__. If you are looking for instructions on installing a different
 version, be sure to select the appropriate branch or tag from the drop-down
 menu above.
 
@@ -159,7 +160,7 @@ NOTE: The steps need to be done in order to create a new Hyrax based app.
 Generate a new Rails application using the template.
 
 ```
-rails _5.0.5_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v2.0.0.beta1/template.rb
+rails _5.0.5_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v2.0.0.beta2/template.rb
 ```
 
 Generating a new Rails application using Hyrax's template above takes cares of a number of steps for you, including:
@@ -244,6 +245,16 @@ rails generate hyrax:work My/MovingImage
 
 You may wish to [customize your work type](https://github.com/samvera/hyrax/wiki/Customizing-your-work-types) now that it's been generated.
 
+## Enable notifications
+
+Hyrax 2 uses a WebSocket-based user notifications system, which requires Redis. To enable user notifications, make sure that you have configured ActionCable to use Redis as the adapter in your application's `config/cable.yml`. E.g., for the `development` Rails environment:
+
+``` yaml
+development:
+  adapter: redis
+  url: redis://localhost:6379
+```
+
 # Managing a Hyrax-based app
 
 The [Hyrax Management Guide](https://github.com/samvera/hyrax/wiki/Hyrax-Management-Guide) provides tips for how to manage, customize, and enhance your Hyrax application, including guidance specific to:

data/app/actors/hyrax/actors/file_set_actor.rb

@@ -12,17 +12,25 @@ module Hyrax
 
       # @!group Asynchronous Operations
 
-      # Spawns asynchronous IngestJob
-      # Called from FileSetsController, AttachFilesToWorkJob, ImportURLJob, IngestLocalFileJob
+      # Spawns asynchronous IngestJob unless ingesting from URL
+      # Called from FileSetsController, AttachFilesToWorkJob, IngestLocalFileJob, ImportUrlJob
       # @param [Hyrax::UploadedFile, File, ActionDigest::HTTP::UploadedFile] file the file uploaded by the user
       # @param [Symbol, #to_s] relation
       # @return [IngestJob, FalseClass] false on failure, otherwise the queued job
-      def create_content(file, relation = :original_file)
+      def create_content(file, relation = :original_file, from_url: false)
         # If the file set doesn't have a title or label assigned, set a default.
         file_set.label ||= label_for(file)
         file_set.title = [file_set.label] if file_set.title.blank?
         return false unless file_set.save # Need to save to get an id
-        IngestJob.perform_later(wrapper!(file: file, relation: relation))
+        if from_url
+          # If ingesting from URL, don't spawn an IngestJob; instead
+          # reach into the FileActor and run the ingest with the file instance in
+          # hand. Do this because we don't have the underlying UploadedFile instance
+          file_actor = build_file_actor(relation)
+          file_actor.ingest_file(wrapper!(file: file, relation: relation))
+        else
+          IngestJob.perform_later(wrapper!(file: file, relation: relation))
+        end
       end
 
       # Spawns asynchronous IngestJob with user notification afterward
@@ -33,17 +41,6 @@ module Hyrax
         IngestJob.perform_later(wrapper!(file: file, relation: relation), notification: true)
       end
 
-      # Spawns async ImportUrlJob to attach remote file to fileset
-      # @param [#to_s] url
-      # @return [IngestUrlJob] the queued job
-      # @todo Remove as it appears to be untested and not called
-      def import_url(url)
-        file_set.update(import_url: url.to_s)
-        operation = Hyrax::Operation.create!(user: user, operation_type: "Attach File")
-        ImportUrlJob.perform_later(file_set, operation)
-      end
-      deprecation_deprecate import_url: "appears to be untested and not used, and will be removed unless an issue/PR is submitted verifying otherwise"
-
       # @!endgroup
 
       # Adds the appropriate metadata, visibility and relationships to file_set

data/app/assets/javascripts/hyrax.js

@@ -37,11 +37,16 @@
 //= require webcomponentsjs/0.5.4/CustomElements.min
 //= require time-elements
 
+//= require action_cable
+
 //= require hyrax/monkey_patch_turbolinks
+//= require hyrax/fileupload
+// Provide AMD module support
+//= require almond
+//= require hyrax/notification
 //= require hyrax/app
 //= require hyrax/config
 //= require hyrax/initialize
-//= require hyrax/fileupload
 //= require hyrax/trophy
 //= require hyrax/facets
 //= require hyrax/featured_works
@@ -59,8 +64,6 @@
 //= require hyrax/dashboard_actions
 //= require hyrax/batch
 //= require hyrax/flot_stats
-// Provide AMD module support
-//= require almond
 //= require hyrax/admin/admin_set_controls
 //= require hyrax/admin/admin_set/group_participants
 //= require hyrax/admin/admin_set/registered_users
@@ -73,8 +76,6 @@
 //= require hyrax/admin/graphs
 //= require hyrax/save_work
 //= require hyrax/permissions
-//= require hyrax/notification
-//= require hyrax/notifications
 //= require hyrax/autocomplete
 //= require hyrax/autocomplete/default
 //= require hyrax/autocomplete/work

data/app/assets/javascripts/hyrax/{app.js → app.js.erb}

@@ -40,7 +40,6 @@ Hyrax = {
       var controls = new CollectionControls($('#collection-controls'));
     },
 
-
     // Pretty graphs on the dashboard page
     adminStatisticsGraphs: function() {
         var AdminGraphs = require('hyrax/admin/graphs');
@@ -87,13 +86,18 @@ Hyrax = {
         new PermissionsControl($("#collection_permissions"), 'tmpl-collection-grant');
     },
 
-    // Polling for user notifications. This is displayed in the navbar.
-    notifications: function () {
-        var Notifications = require('hyrax/notifications');
-        $('[data-update-poll-url]').each(function () {
-            var interval = $(this).data('update-poll-interval');
-            var url = $(this).data('update-poll-url');
-            new Notifications(url, interval);
+    // ActionCable for user notifications. This is displayed in the navbar.
+    notifications: function() {
+        var consumer = ActionCable.createConsumer("<%= Hyrax::Engine.routes.url_helpers.notifications_endpoint_path %>");
+        consumer.subscriptions.create("Hyrax::NotificationsChannel", {
+            connected: function(data) {
+                this.perform("update_locale", { locale: $('html').attr('lang') });
+            },
+
+            received: function(data) {
+                var Notification = require('hyrax/notification');
+                new Notification($('.notify-number')).update(data.notifications_count, data.notifications_label);
+            }
         });
     },
 

data/app/assets/javascripts/hyrax/notification.es6

@@ -1,37 +1,25 @@
-// This is the notification widget on the page
-
-export default class {
-  constructor(dom_obj) {
-    this.dom_obj = dom_obj;
-    this.counter = dom_obj.find('.count');
+export default class Notification {
+  /**
+   * Initializes the notification widget on the page and allows
+   * updating of the notification count and notification label
+   *
+   * @param {jQuery} element the notification widget
+   */
+  constructor(element) {
+    this.element = element
+    this.counter = element.find('.count')
   }
 
-  setCount(count) {
-    this.counter.html(count);
-    if (count == 0) {
-      this.noNotifications()
-    } else {
-      this.hasNotifications(count)
-    }
-  }
+  update(count, label) {
+    this.element.attr('aria-label', label)
+    this.counter.html(count)
 
-  // set the styles for no unread notifications
-  noNotifications () {
+    if (count === 0) {
       this.counter.addClass('invisible')
-      this.dom_obj.prop('aria-label', this.notificationsLabel(0))
-  }
-
-  // set the styles for having unread notifications
-  hasNotifications (size) {
-    this.counter.removeClass('invisible')
-    this.dom_obj.prop('aria-label', this.notificationsLabel(size))
-  }
-
-  notificationsLabel(size) {
-    if (size == 0)
-      return "You have no unread notifications"
-    if (size == 1)
-      return "You have one unread notification"
-    return `You have %{size} unread notifications`
+    }
+    else {
+      this.counter.removeClass('invisible')
+      this.counter.addClass('label-danger').removeClass('label-default')
+    }
   }
 }

data/app/channels/hyrax/application_cable/channel.rb

@@ -0,0 +1,6 @@
+module Hyrax
+  module ApplicationCable
+    class Channel < ActionCable::Channel::Base
+    end
+  end
+end

data/app/channels/hyrax/application_cable/connection.rb

@@ -0,0 +1,30 @@
+module Hyrax
+  module ApplicationCable
+    class Connection < ActionCable::Connection::Base
+      identified_by :current_user
+
+      def connect
+        self.current_user = find_verified_user
+      end
+
+      private
+
+        def find_verified_user
+          user = ::User.find_by(id: user_id)
+          if user
+            user
+          else
+            reject_unauthorized_connection
+          end
+        end
+
+        def user_id
+          session['warden.user.user.key'][0][0]
+        end
+
+        def session
+          cookies.encrypted[Rails.application.config.session_options[:key]]
+        end
+    end
+  end
+end

data/app/channels/hyrax/notifications_channel.rb

@@ -0,0 +1,15 @@
+module Hyrax
+  class NotificationsChannel < ApplicationCable::Channel
+    def subscribed
+      stream_for current_user
+    end
+
+    def unsubscribed
+      stop_all_streams
+    end
+
+    def update_locale(data)
+      current_user.update(preferred_locale: data['locale'])
+    end
+  end
+end

data/app/controllers/hyrax/depositors_controller.rb

@@ -38,8 +38,8 @@ module Hyrax
       def send_proxy_depositor_added_messages(grantor, grantee)
         message_to_grantee = "#{grantor.name} has assigned you as a proxy depositor"
         message_to_grantor = "You have assigned #{grantee.name} as a proxy depositor"
-        ::User.batch_user.send_message(grantor, message_to_grantor, "Proxy Depositor Added")
-        ::User.batch_user.send_message(grantee, message_to_grantee, "Proxy Depositor Added")
+        Hyrax::MessengerService.deliver(::User.batch_user, grantor, message_to_grantor, "Proxy Depositor Added")
+        Hyrax::MessengerService.deliver(::User.batch_user, grantee, message_to_grantee, "Proxy Depositor Added")
       end
   end
 end

data/app/controllers/hyrax/notifications_controller.rb

@@ -8,6 +8,8 @@ module Hyrax
       add_breadcrumb t(:'hyrax.dashboard.breadcrumbs.admin'), hyrax.dashboard_path
       add_breadcrumb t(:'hyrax.admin.sidebar.notifications'), hyrax.notifications_path
       @messages = user_mailbox.inbox
+      # Update the notifications now that there are zero unread
+      StreamNotificationsJob.perform_later(current_user)
     end
 
     def delete_all

data/app/controllers/hyrax/users_controller.rb

@@ -16,13 +16,6 @@ module Hyrax
       @presenter = Hyrax::UserProfilePresenter.new(user, current_ability)
     end
 
-    def notifications_number
-      @notify_number = 0
-      return if action_name == "index" && controller_name == "mailbox"
-      return unless user_signed_in?
-      @notify_number = current_user.mailbox.inbox(unread: true).count
-    end
-
     private
 
       # TODO: this should move to a service.

data/app/helpers/hyrax/hyrax_helper_behavior.rb

@@ -54,6 +54,23 @@ module Hyrax
       user_agent.include? 'Chrome'
     end
 
+    # @param [User] user
+    def render_notifications(user:)
+      mailbox = UserMailbox.new(user)
+      unread_notifications = mailbox.unread_count
+      link_to(hyrax.notifications_path,
+              'aria-label' => mailbox.label(params[:locale]),
+              class: 'notify-number') do
+        capture do
+          concat content_tag(:span, '', class: 'fa fa-bell')
+          concat "\n"
+          concat content_tag(:span,
+                             unread_notifications,
+                             class: count_classes_for(unread_notifications))
+        end
+      end
+    end
+
     # @param [ProxyDepositRequest] req
     def show_transfer_request_title(req)
       if req.deleted_work? || req.canceled?
@@ -233,6 +250,16 @@ module Hyrax
         request.user_agent || ''
       end
 
+      def count_classes_for(unread_count)
+        'count label '.tap do |classes|
+          classes << if unread_count.zero?
+                       'invisible label-default'
+                     else
+                       'label-danger'
+                     end
+        end
+      end
+
       # rubocop:disable Metrics/MethodLength
       def search_action_for_dashboard
         case params[:controller]

data/app/jobs/import_url_job.rb

@@ -20,6 +20,8 @@ class ImportUrlJob < Hyrax::ApplicationJob
     operation.performing!
     user = User.find_by_user_key(file_set.depositor)
     uri = URI(file_set.import_url)
+    # @todo Use Hydra::Works::AddExternalFileToFileSet instead of manually
+    #       copying the file here. This will be gnarly.
     copy_remote_file(uri) do |f|
       # reload the FileSet once the data is copied since this is a long running task
       file_set.reload
@@ -27,7 +29,7 @@ class ImportUrlJob < Hyrax::ApplicationJob
       # FileSetActor operates synchronously so that this tempfile is available.
       # If asynchronous, the job might be invoked on a machine that did not have this temp file on its file system!
       # NOTE: The return status may be successful even if the content never attaches.
-      if Hyrax::Actors::FileSetActor.new(file_set, user).create_content(f)
+      if Hyrax::Actors::FileSetActor.new(file_set, user).create_content(f, from_url: true)
         operation.success!
       else
         # send message to user on download failure

data/app/jobs/stream_notifications_job.rb

@@ -0,0 +1,10 @@
+class StreamNotificationsJob < Hyrax::ApplicationJob
+  def perform(users)
+    Array.wrap(users).each do |user|
+      mailbox = UserMailbox.new(user)
+      Hyrax::NotificationsChannel.broadcast_to(user,
+                                               notifications_count: mailbox.unread_count,
+                                               notifications_label: mailbox.label)
+    end
+  end
+end

data/app/models/proxy_deposit_request.rb

@@ -90,13 +90,13 @@ class ProxyDepositRequest < ActiveRecord::Base
       user_link = link_to(sending_user.name, Hyrax::Engine.routes.url_helpers.user_path(sending_user.user_key))
       transfer_link = link_to('transfer requests', Hyrax::Engine.routes.url_helpers.transfers_path)
       message = "#{user_link} wants to transfer a work to you. Review all #{transfer_link}"
-      User.batch_user.send_message(receiving_user, message, "Ownership Change Request")
+      Hyrax::MessengerService.deliver(::User.batch_user, receiving_user, message, "Ownership Change Request")
     end
 
     def send_request_transfer_message_as_part_of_update
       message = "Your transfer request was #{status}."
       message += " Comments: #{receiver_comment}" if receiver_comment.present?
-      User.batch_user.send_message(sending_user, message, "Ownership Change #{status}")
+      Hyrax::MessengerService.deliver(::User.batch_user, sending_user, message, "Ownership Change #{status}")
     end
 
   public

data/app/models/user_mailbox.rb

@@ -10,6 +10,21 @@ class UserMailbox
     messages.each { |m| m.mark_as_read(user) }
   end
 
+  def unread_count
+    user.mailbox.inbox(unread: true).count
+  end
+
+  def label(locale_from_params = nil)
+    case unread_count
+    when 0
+      I18n.t("hyrax.toolbar.notifications.zero", locale: locale_from_params || preferred_locale)
+    when 1
+      I18n.t("hyrax.toolbar.notifications.one", locale: locale_from_params || preferred_locale)
+    else
+      I18n.t("hyrax.toolbar.notifications.many", count: unread_count, locale: locale_from_params || preferred_locale)
+    end
+  end
+
   def delete_all
     user.mailbox.inbox.each do |msg|
       delete_message(msg)
@@ -32,6 +47,10 @@ class UserMailbox
       msg.move_to_trash(msg.participants[1])
     end
 
+    def preferred_locale
+      user.preferred_locale || I18n.default_locale
+    end
+
     def empty_trash(user)
       user.mailbox.trash.each do |conv|
         conv.messages.each do |notify|