bpluser 0.1.19 → 0.2.0.1

data/config/locales/bpluser.en.yml

@@ -0,0 +1,129 @@
+en:
+  blacklight:
+    bookmarks:
+      collection:
+        add:
+          button: 'Add to Bookmarks'
+      title: 'Bookmarks'
+      description: 'The default folder for creating a list of items.'
+      no_bookmarks: 'This folder does not currently have any items.'
+      add:
+        button: 'Bookmark'
+        success:
+          one: 'Item added to folder.'
+          other: 'Items added to folder.'
+        failure:  'Item could not be added.'
+      remove:
+        button: 'Remove bookmark'
+        success: 'Item removed from folder.'
+        failure: 'Item could not be removed.'
+        action_confirm: 'Remove this item?'
+      clear:
+        action_title: 'Remove all items'
+        action_confirm: 'Are you sure you want to remove all items?'
+        success: 'All items removed.'
+        failure: 'Items could not be removed. Please try again later.'
+      need_login: 'Please log in to create and manage folders.'
+      list_title: 'Your Bookmarks'
+      delete: 'Remove'
+
+    breadcrumb:
+      separator: ' > '
+
+    folders:
+      intro: 'Folders can be used to create, organize, and share your own personal collections of items.'
+      list_title: 'Folders'
+      no_folders: 'You do not currently have any folders.'
+      need_login: 'Please log in to create and view folders.'
+      create:
+        success: 'Folder created.'
+        error:
+          no_title: 'Title cannot be blank.'
+          no_save: 'The folder could not be created. Please try again later.'
+      update:
+        success: 'Folder updated.'
+        error:
+            no_title: 'Title cannot be blank.'
+            no_save: 'The folder could not be updated. Please try again later.'
+      delete:
+        delete: 'Delete folder'
+        success: 'Folder deleted.'
+        confirm: 'Are you sure you want to delete this folder?'
+      edit: 'Edit folder'
+      add_folder: 'Create a New Folder'
+      edit_folder: 'Edit Folder'
+      empty: 'This folder does not currently have any items.'
+      private: 'You do not have access to this folder.'
+      public_list:
+        intro: 'Lists of items created and shared by Digital Commonwealth users.'
+        title: 'Shared Folders'
+      update_items:
+        copy:
+          success: "Items copied to '%{folder_name}' folder."
+          failure: 'Items could not be copied. Make sure the destination folder does not already include the items. If you are still unable to copy the items, please use the Contact link to report the problem.'
+        remove:
+          success: 'Items removed.'
+          failure: 'Items could not be removed. Please try again later.'
+          no_items: 'No items selected!'
+      help:
+        add_items: 'To add items to your folder, click the "Add to Folder" button in the "Tools" section
+                            of the item detail page.'
+
+    folder_items:
+      item_in_folder: 'In Folder'
+      add:
+        button: 'Add to Folder'
+        success: 'Item added to folder.'
+        failure: 'Item could not be added.'
+        submit: 'Add'
+      remove:
+        button: 'Remove from folder'
+        success: 'Item removed from folder.'
+        failure: 'Item could not be removed.'
+      clear:
+        action: 'Remove all items'
+        confirm: 'Are you sure you want to remove all items?'
+        success: 'All items removed.'
+        failure: 'Items could not be removed. Please try again later.'
+
+    header_links:
+      logout: 'Log Out'
+      login: 'Sign Up / Log In'
+      profile: 'Profile'
+      folders: 'Folders'
+      bookmarks: 'Folders'
+      saved_searches: 'Saved Searches'
+      search_history: 'Search History'
+      selected_items: 'Selected Items'
+
+    saved_searches:
+      add:
+        success: 'Successfully saved your search.'
+        failure: 'There was a problem saving your search.'
+      remove:
+        success: 'Search removed.'
+        failure: 'There was a problem removing your search.'
+      clear:
+        action_title: 'Clear All'
+        action_confirm: 'Clear your saved searches?'
+        success: 'Cleared your saved searches.'
+        failure: 'There was a problem clearing your searches.'
+      save: 'Save Search'
+      title: 'Saved Searches'
+      page_title: 'Saved Searches - %{application_name}'
+      intro: 'Saved searches allow you to quickly re-search for items of interest.'
+      need_login: 'Please log in to manage and view your saved searches.'
+      no_searches: "You don't have any saved searches at the moment."
+      list_title: 'Your saved searches'
+      delete: 'Delete this search.'
+
+    search_history:
+      intro: 'View and save your recent searches.'
+      no_history: 'You have no search history for this session yet.'
+
+    tools:
+      copy_to: 'Copy to'
+      remove: 'Remove'
+
+    users:
+      account_heading: 'My Account'

data/config/routes.rb

@@ -1,3 +1,24 @@
-Bpluser::Engine.routes.draw do
-  post 'sdf', :to => 'api#sdf', :as => 'sdf_request'
+# frozen_string_literal: true
+
+Rails.application.routes.draw do
+  devise_for :users, controllers: { omniauth_callbacks: 'users/omniauth_callbacks', registrations: 'users/registrations', sessions: 'users/sessions' }
+
+  # folders
+  resources :folders
+  get 'folders/public', to: 'folders#public_list', as: 'public_folders'
+  delete 'folder/:id/clear', to: 'folder_items#clear', as: 'clear_folder_items'
+  put 'folder/:id/item_actions', to: 'folder_items_actions#folder_item_actions', as: 'selected_folder_items_actions'
+
+  # folder items
+  resources :folder_items
+
+  # user account management (not login/auth)
+  resources :users, only: [:show]
+
+  # saved searches -- no longer provided by blacklight >= 7
+  get 'saved_searches', to: 'saved_searches#index', as: 'saved_searches'
+  put 'saved_searches/save/:id', to: 'saved_searches#save', as: 'save_search'
+  post 'saved_searches/forget/:id', to: 'saved_searches#forget'
+  delete 'saved_searches/forget/:id', to: 'saved_searches#forget', as: 'forget_search'
+  delete 'saved_searches/clear', to: 'saved_searches#clear', as: 'clear_saved_searches'
 end

data/lib/bpluser/controller.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# Filters added to this controller apply to all controllers in local app
+# this module is mixed-in to local app's ApplicationController on installation.
+module Bpluser
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+      include InstanceMethods
+      after_action :store_location
+    end
+
+    module InstanceMethods
+      EXCLUDE_PATHS = %w[
+        /users/auth
+        /users/sign_in
+        /users/sign_up
+        /users/password
+        /users/password/new
+        /users/password/edit
+        /users/confirmation
+        /users/sign_out
+      ].freeze
+      # redirect after login to previous non-login page
+      # TODO figure out why it doesn't work for Polaris
+      def store_location
+        # Don't store if ajax call or fullpath doesn't include segments in EXCLUDE_PATHS const
+        return if !request.get? || request.xhr? || EXCLUDE_PATHS.any? { |exclude_path| request.fullpath.include?(exclude_path) }
+
+        store_location_for(:user, request.fullpath)
+      end
+
+      def after_sign_in_path_for(resource_or_scope)
+        stored_location_for(resource_or_scope) || root_path
+      end
+
+      private
+
+      ##
+      # adds behavior to Blacklight::Controller#transfer_guest_user_actions_to_current_user
+      # so folders are transferred in addition to searches and bookmarks
+      def transfer_guest_user_actions_to_current_user
+        return unless respond_to?(:current_user) && respond_to?(:guest_user) && current_user && guest_user
+
+        guest_user.folders.with_folder_items.find_each do |folder|
+          target_folder = current_user.folders.where(title: folder.title).first
+          target_folder ||= current_user.folders.create!(title: folder.title, description: folder.description, visibility: folder.visibility)
+
+          folder.folder_items.find_each do |item_to_add|
+            next if target_folder.folder_item?(item_to_add.document_id)
+
+            target_folder.folder_items.create!(document_id: item_to_add.document_id)
+          end
+        end
+
+        super
+      end
+    end
+  end
+end

data/lib/bpluser/devise_guests_override.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Bpluser
+  module DeviseGuestsOverride
+    # DEPRECATED changing devise to use email keys instead of uid authentication keys makes this no longer needed
+    extend ActiveSupport::Concern
+
+    included do
+      include InstanceMethods
+    end
+
+    module InstanceMethods
+      private
+
+      def guest_uid_authentication_key(key)
+        key &&= nil unless key.to_s.match?(/^guest/)
+        key || "guest_#{guest_user_unique_suffix}@example.com"
+      end
+    end
+  end
+end

data/lib/bpluser/engine.rb

@@ -1,6 +1,32 @@
-require 'devise'
+# frozen_string_literal: true
+
 module Bpluser
   class Engine < ::Rails::Engine
     isolate_namespace Bpluser
+
+    config.generators do |g|
+      g.orm :active_record
+      g.test_framework :rspec, fixture: true
+      g.fixture_replacement :factory_bot
+      g.factory_bot dir: 'spec/factories'
+    end
+
+    if Rails.env.development? || Rails.env.test?
+      begin
+        require 'factory_bot_rails'
+        config.factory_bot.definition_file_paths << File.expand_path('../../spec/factories/bpluser', __dir__)
+      rescue LoadError
+        warn 'Factory Bot Rails Not installed!'
+      end
+    end
+
+    # initializer 'bpluser.add_devise_guests_overrides', before: 'devise_guests.add_helpers' do
+    #   DeviseGuests::Controllers::Helpers.include(Bpluser::DeviseGuestsOverride)
+    # end
+
+    # as of sprockets >= 4 have to explicitly declare each file
+    initializer 'bpluser.assets.precompile' do |app|
+      app.config.assets.precompile << 'bpluser_manifest.js'
+    end
   end
 end

data/lib/bpluser/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bpluser
-  VERSION = "0.1.19".freeze
+  VERSION = '0.2.0.1'
 end

data/lib/bpluser.rb

@@ -1,19 +1,25 @@
-begin
-  require 'base64'
-  require 'cgi'
-  require 'openssl'
-  require 'rest_client'
-  require 'active_support/concern' unless defined? ActiveSupport::Concern
-  require 'active_fedora' unless defined? ActiveFedora
-  require 'hydra-ldap' unless defined? Hydra::LDAP
-rescue LoadError => e
-  raise "One more more depndencies have not been installed please install the gem referred to in this error #{e.message}"
-end
+# frozen_string_literal: true
+
+require 'base64'
+require 'cgi'
+require 'active_support'
+require 'active_support/concern'
+require 'blacklight'
+require 'devise'
+require 'devise-guests'
+require 'omniauth'
+require 'omniauth-polaris'
+require 'omniauth/rails_csrf_protection'
+require 'openssl'
+require 'rsolr'
+
+require 'bpluser/version'
+require 'bpluser/controller'
+require 'bpluser/devise_guests_override'
 require 'bpluser/engine'
-module Bpluser
-  autoload :Routes, 'bpluser/routes'
 
-  def self.add_routes(router, options = {})
-    Bpluser::Routes.new(router, options).draw
+module Bpluser
+  def self.root
+    Bpluser::Engine.root
   end
 end

data/lib/generators/bpluser/controller_generator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Bpluser
+  class ControllerGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    def inject_application_controller_behavior
+      target_file = 'app/controllers/application_controller.rb'
+      return unless File.read(target_file).include?('Bpluser::Controller')
+
+      marker = 'include Blacklight::Controller'
+      insert_into_file target_file, after: marker do
+        "\ninclude Bpluser::Controller"
+      end
+    end
+
+    def add_folders_show_tool
+      target_file = 'app/controllers/catalog_controller.rb'
+      return unless File.read(target_file).include?('folder_item_control')
+
+      marker = 'configure_blacklight do |config|'
+      insert_into_file target_file, after: marker do
+        "\nconfig.add_show_tools_partial :folder_items, partial: 'folder_item_control'"
+      end
+    end
+  end
+end

data/lib/generators/bpluser/devise_generator.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Bpluser
+  class DeviseGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    desc 'DeviseGenerator Bpluser'
+
+    argument :devise_initializer, type: :string, default: 'config/initializers/devise.rb'
+
+    def keys
+      gsub_file(devise_initializer, /^[\s#]*config.authentication_keys[^\n]*/,
+                '  config.authentication_keys = [:email]')
+      gsub_file(devise_initializer, /^[\s#]*config.case_insensitive_keys[^\n]*/,
+                '  config.case_insensitive_keys = [:email]')
+      gsub_file(devise_initializer, /^[\s#]*config.strip_whitespace_keys[^\n]*/,
+                '  config.strip_whitespace_keys = [:email]')
+    end
+
+    def sign_out
+      gsub_file(devise_initializer, /^[\s#]*config.sign_out_via[^\n]*/,
+                '  config.sign_out_via = :get')
+    end
+
+    def omniauth
+      return if File.read(devise_initializer).include?('config.omniauth')
+
+      marker = '# ==> Warden configuration'
+      insert_into_file devise_initializer, before: marker do
+        "config.omniauth :polaris, title: OMNIAUTH_POLARIS_GLOBAL['title']," \
+          "\n                  http_uri: OMNIAUTH_POLARIS_GLOBAL['http_uri']," \
+          "\n                  access_key: OMNIAUTH_POLARIS_GLOBAL['access_key']," \
+          "\n                  access_id: OMNIAUTH_POLARIS_GLOBAL['access_id']," \
+          "\n                  method: OMNIAUTH_POLARIS_GLOBAL['method']\n\n"
+      end
+    end
+  end
+end

data/lib/generators/bpluser/install_generator.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Bpluser
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    desc 'InstallGenerator Bpluser'
+
+    def verify_blacklight_installed
+      return if File.read('app/controllers/application_controller.rb').include?('include Blacklight::Controller')
+
+      say_status('info', 'BLACKLIGHT NOT INSTALLED; GENERATING BLACKLIGHT', :blue)
+      generate 'blacklight:install --devise'
+    end
+
+    def verify_devise_installed
+      user_model = 'app/models/user.rb'
+      return if !File.file?(user_model) || File.read(user_model).include?('devise')
+
+      generate 'blacklight:user --devise'
+    end
+
+    def copy_yml_files
+      %w[omniauth-polaris].each do |yml|
+        source_dest = "config/#{yml}.yml"
+        copy_file source_dest, source_dest unless File.file?(source_dest)
+      end
+    end
+
+    def copy_locale
+      copy_file 'config/locales/devise.en.yml', 'config/locales/devise.en.yml'
+    end
+
+    def insert_to_user_model
+      generate 'bpluser:user'
+    end
+
+    def copy_migrations
+      rake 'bpluser:install:migrations'
+    end
+
+    def copy_update_migrations
+      rake 'bpluser:update:migrations'
+    end
+
+    def configure_devise
+      generate 'bpluser:devise'
+    end
+
+    def insert_to_controllers
+      generate 'bpluser:controller'
+    end
+
+    def bundle_install
+      Bundler.with_clean_env do
+        run 'bundle install'
+      end
+    end
+  end
+end

data/lib/generators/bpluser/templates/config/locales/devise.en.yml

@@ -0,0 +1,53 @@
+en:
+  devise:
+    failure:
+      already_authenticated: 'You are already signed in.'
+      unauthenticated: 'You need to sign in or sign up before continuing.'
+      unconfirmed: 'You have to confirm your account before continuing.'
+      locked: 'Your account is locked.'
+      invalid: 'Invalid email or password.'
+      invalid_token: 'Invalid authentication token.'
+      timeout: 'Your session expired, please sign in again to continue.'
+      inactive: 'Your account was not activated yet.'
+    sessions:
+      signed_in: ''
+      signed_out: ''
+    passwords:
+      send_instructions: 'You will receive an email with instructions about how to reset your password in a few minutes.'
+      updated: 'Your password was changed successfully. You are now signed in.'
+      updated_not_active: 'Your password was changed successfully.'
+      send_paranoid_instructions: "If your email address exists in our database, you will receive a password recovery link at your email address in a few minutes."
+      no_token: "You can't access this page without a password reset email. If you did use the link from a password reset email, please make sure you used the full URL provided."
+    confirmations:
+      send_instructions: 'You will receive an email with instructions about how to confirm your account in a few minutes.'
+      send_paranoid_instructions: 'If your email address exists in our database, you will receive an email with instructions about how to confirm your account in a few minutes.'
+      confirmed: 'Your account was successfully confirmed. You are now signed in.'
+    registrations:
+      edit: 'Edit My Account'
+      password:
+        new: 'New password'
+        new_confirm: 'New password confirmation'
+        old: 'Current password'
+      sign_up: "Sign up."
+      signed_up: 'Welcome! You can now access your bookmarks, folders, and searches using the menu at the top right.'
+      signed_up_but_unconfirmed: 'A message with a confirmation link has been sent to your email address. Please open the link to activate your account.'
+      signed_up_but_inactive: 'You have signed up successfully. However, we could not sign you in because your account is not yet activated.'
+      signed_up_but_locked: 'You have signed up successfully. However, we could not sign you in because your account is locked.'
+      updated: 'You updated your account successfully.'
+      update_needs_confirmation: "You updated your account successfully, but we need to verify your new email address. Please check your email and click on the confirm link to finalize confirming your new email address."
+      destroyed: 'Your account was successfully cancelled.'
+    unlocks:
+      send_instructions: 'You will receive an email with instructions about how to unlock your account in a few minutes.'
+      unlocked: 'Your account has been unlocked successfully. Please sign in to continue.'
+      send_paranoid_instructions: 'If your account exists, you will receive an email with instructions about how to unlock it in a few minutes.'
+    omniauth_callbacks:
+      # success: 'Successfully authenticated from %{kind} account.'
+      success: 'You are now signed in.'
+      failure: 'Could not authenticate you from %{kind} because "%{reason}".'
+    mailer:
+      confirmation_instructions:
+        subject: 'Digital Commonwealth - Confirmation instructions'
+      reset_password_instructions:
+        subject: 'Digital Commonwealth - Reset password instructions'
+      unlock_instructions:
+        subject: 'Digital Commonwealth - Unlock Instructions'

data/lib/generators/bpluser/templates/config/omniauth-polaris.yml

@@ -1,20 +1,15 @@
-test:
+default: &default
   title: BPL Polaris Login
-  http_uri: http://blah.org/PAPIService/REST/public/v1/1000/100/1/patron/
-  access_key: F9998888-A000-1111-C22C-CC3333BB4444
-  access_id: API
-  method: GET
+  http_uri: <%= ENV.fetch('POLARIS_URI', '') %>
+  access_key: <%= ENV.fetch('POLARIS_KEY', '') %>
+  access_id: <%= ENV.fetch('POLARIS_ID', '') %>
+  method: POST
 
 development:
-  title: BPL Polaris Login
-  http_uri: http://blah.org/PAPIService/REST/public/v1/1000/100/1/patron/
-  access_key: F9998888-A000-1111-C22C-CC3333BB4444
-  access_id: API
-  method: GET
+  <<: *default
+
+test:
+  <<: *default
 
 production:
-  title: BPL Polaris Login
-  http_uri: http://blah.org/PAPIService/REST/public/v1/1000/100/1/patron/
-  access_key: F9998888-A000-1111-C22C-CC3333BB4444
-  access_id: API
-  method: GET
+  <<: *default

data/lib/generators/bpluser/templates/models/user.rb

@@ -1,10 +1,9 @@
+# frozen_string_literal: true
+
 class User < ApplicationRecord
-  # Connects this user object to Hydra behaviors.
-  include Hydra::User
   # Connects this user object to Blacklights Bookmarks.
   include Blacklight::User
   # Connects this user object to the BPL omniauth service
   include Bpluser::Concerns::User
-  self.table_name = "users"
-
+  self.table_name = 'users'
 end

data/lib/generators/bpluser/user_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Bpluser
+  class UserGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    desc 'UserGenerator Bpluser'
+
+    argument :user_model_path, type: :string, default: 'app/models/user.rb'
+
+    def insert_into_users
+      return if File.read(user_model_path).include?('Bpluser')
+
+      insert_into_file user_model_path, after: 'include Blacklight::User' do
+        "\n\n  # Adds Bpluser core funtionality" \
+          "\n  include Bpluser::Users" \
+          "\n  self.table_name = 'users'\n"
+      end
+    end
+  end
+end

data/lib/tasks/bpluser_tasks.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # desc "Explaining what the task does"
 # task :bpluser do
 #   # Task goes here
@@ -6,5 +8,30 @@
 # APP_ROOT = File.expand_path("../..", __FILE__)
 
 namespace :bpluser do
+  namespace :update do
+    desc 'Copy over the updated migrations needed for new version'
+    task migrations: :environment do
+      ENV['MIGRATIONS_PATH'] = 'db/update_migrate'
+
+      if Rake::Task.task_defined?('bpluser:install:migrations')
+        Rake::Task['bpluser:install:migrations'].invoke
+      else
+        Rake::Task['app:bpluser:install:migrations'].invoke
+      end
+    end
+  end
 
+  namespace :test_index do
+    desc 'Put sample data into test app solr'
+    task seed: :environment do
+      require 'yaml'
+      docs = YAML.safe_load(File.open(File.join(File.join(Bpluser.root,
+                                                          'spec',
+                                                          'fixtures',
+                                                          'sample_solr_documents.yml'))))
+      conn = Blacklight.default_index.connection
+      conn.add docs
+      conn.commit
+    end
+  end
 end