bpluser 0.1.19 → 0.2.0

data/app/models/bpluser/folder.rb

@@ -1,20 +1,31 @@
+# frozen_string_literal: true
+
 module Bpluser
   class Folder < ApplicationRecord
+    MAX_TITLE_LENGTH = 65
+    MAX_DESC_LENGTH = 250
+    VALID_VISIBILITY_OPTS = %w[public private].freeze
+
+    belongs_to :user, inverse_of: :folders, class_name: '::User'
+    has_many :folder_items, inverse_of: :folder, dependent: :destroy, class_name: 'Bpluser::FolderItem'
 
-    belongs_to :user, inverse_of: :folders, class_name: "::User"
-    has_many :folder_items, inverse_of: :folder ,:dependent => :destroy, :class_name => "Bpluser::FolderItem"
+    scope :with_folder_items, -> { includes(:folder_items) }
+    scope :public_list, -> { with_folder_items.where(visibility: 'public').order(updated_at: :desc) }
 
-    validates :user_id, :presence => true
-    #validates :title, :presence => true, :length => {:maximum => 40}
-    validates :title, :presence => true, :length => {:maximum => 65}
-    validates :description, :length => {:maximum => 250}
-    validates :visibility, :inclusion  => {:in => %w(public private)}
+    validates :title, presence: true, length: { maximum: MAX_TITLE_LENGTH }
+    validates :description, length: { maximum: MAX_DESC_LENGTH }
+    validates :visibility, presence: true, inclusion: { in: VALID_VISIBILITY_OPTS }
 
-    #attr_accessible :id, :title, :description, :visibility
+    def folder_item?(document_id)
+      folder_items.exists?(document_id: document_id)
+    end
 
-    def has_folder_item (document_id)
-      self.folder_items.where(document_id: document_id) if self.folder_items.where(document_id: document_id).exists?
+    def public?
+      visibility == 'public'
     end
 
+    def private?
+      visibility == 'private'
+    end
   end
 end

data/app/models/bpluser/folder_item.rb

@@ -1,15 +1,13 @@
+# frozen_string_literal: true
+
 module Bpluser
   class FolderItem < ApplicationRecord
-    #attr_accessible :document_id
-
-    belongs_to :folder, inverse_of: :folder_items, :class_name => "Bpluser::Folder"
+    belongs_to :folder, inverse_of: :folder_items, class_name: 'Bpluser::Folder', touch: true
 
-    validates :folder_id, :presence => true
-    validates :document_id, :presence => true
+    validates :document_id, presence: true
 
     def document
-      SolrDocument.new SolrDocument.unique_key => :document_id
+      SolrDocument.new(SolrDocument.unique_key => document_id) if document_id
     end
-
   end
 end

data/app/models/concerns/bpluser/users.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Bpluser
+  module Users
+    # Changed this to a concern so the modules can resolve better
+    extend ActiveSupport::Concern
+
+    included do
+      include InstanceMethods
+      include Bpluser::Validatable
+
+      devise :database_authenticatable, :registerable, :recoverable, :rememberable, :validatable, :trackable, :omniauthable, omniauth_providers: [:polaris]
+
+      has_many :folders, inverse_of: :user, dependent: :destroy, class_name: 'Bpluser::Folder'
+      has_many :folder_items, through: :folders, class_name: 'Bpluser::FolderItem'
+
+      before_create :set_default_display_name
+    end
+
+    module InstanceMethods
+      # BEGIN INSTANCE METHODS
+      def name
+        email || username || display_name.to_s.titleize
+      end
+
+      alias to_s name
+
+      def user_key
+        send(Devise.authentication_keys.first)
+      end
+
+      def existing_folder_item_for(document_id)
+        get_folder_item(document_id)
+      end
+
+      def get_folder_item(document_id)
+        folder_items.where(document_id: document_id).first if folder_items.exists?(document_id: document_id)
+      end
+
+      private
+
+      def set_default_display_name
+        return if display_name.present?
+
+        return if first_name.blank? && last_name.blank?
+
+        self.display_name = "#{first_name} #{last_name}".strip
+      end
+      # END INSTANCE METHODS
+    end
+
+    # BEGIN CLASS METHODS
+    class_methods do
+      def find_for_polaris_oauth(auth_response)
+        polaris_info_details = auth_response[:info]
+
+        where(provider: auth_response.provider, uid: auth_response.uid).first_or_create do |user|
+          user.provider = auth_response.provider
+          user.uid = auth_response.uid
+          user.username = polaris_info_details[:first_name]
+          user.email = polaris_info_details[:email].presence || ''
+          user.password = Devise.friendly_token[0, 20]
+          user.display_name = "#{polaris_info_details[:first_name]} #{polaris_info_details[:last_name]}"
+          user.first_name = polaris_info_details[:first_name]
+          user.last_name = polaris_info_details[:last_name]
+        end
+      end
+    end
+    # END CLASS METHODS
+  end
+end

data/app/models/concerns/bpluser/validatable.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Bpluser
+  module Validatable
+    extend ActiveSupport::Concern
+
+    included do
+      include InstanceMethods
+
+      validates :uid, presence: true, uniqueness: { scope: :provider, allow_blank: true }, if: :uid_required?
+    end
+
+    # Overrides devise mthods used for validations
+    module InstanceMethods
+      protected
+
+      def uid_required?
+        provider == 'polaris'
+      end
+
+      def email_required?
+        return false if provider == 'polaris'
+
+        super
+      end
+
+      def password_required?
+        return false if provider == 'polaris'
+
+        super
+      end
+    end
+  end
+end

data/app/views/bookmarks/index.html.erb

@@ -0,0 +1,58 @@
+<% @page_title = t('blacklight.bookmarks.page_title', application_name: application_name) %>
+
+<%= javascript_include_tag 'bpluser/folder_tools' %>
+
+<div id="content" class="folder_show_container col-sm-9">
+
+  <div id="breadcrumb">
+    <ul class="breadcrumb">
+      <% if current_user %>
+          <li class="breadcrumb-item">
+            <%= link_to(t('blacklight.users.account_heading'), current_user) %>
+            <span class="divider"><%= t('blacklight.breadcrumb.separator') %></span>
+          </li>
+      <% end %>
+      <li class="breadcrumb-item">
+        <%= link_to(t('blacklight.folders.list_title'), folders_path) %>
+        <span class="divider"><%= t('blacklight.breadcrumb.separator') %></span>
+      </li>
+      <li class="active breadcrumb-item">
+        <%= t('blacklight.bookmarks.title') %>
+      </li>
+    </ul>
+  </div>
+
+<h2><%= t('blacklight.bookmarks.title') %>
+  <% unless !current_or_guest_user || @document_list.blank? %>
+      <small id="folder_tools">
+      </small>
+  <% end %>
+</h2>
+
+  <div id="folder_description">
+    <%= t('blacklight.bookmarks.description') %>
+  </div>
+
+<%- if current_or_guest_user.blank? -%>
+      <div id="empty_folder" class="well">
+        <h5><%= t('blacklight.bookmarks.need_login') %></h5>
+      </div>
+<%- elsif @document_list.blank? -%>
+      <div id="empty_folder" class="well">
+        <h4><%= t('blacklight.bookmarks.no_bookmarks') %></h4>
+        <p><%= t('blacklight.folders.help.add_items') %></p>
+      </div>
+<% else %>
+
+    <%= render 'sort_and_per_page' %>
+
+    <%= form_tag selected_bookmarks_actions_path, :method => :put, :id => "item_actions_form" do %>
+
+        <%= render :partial => 'shared/folder_item_actions' %>
+
+        <%= render_document_index %>
+
+    <% end %>
+    <%= render 'results_pagination' %>
+<% end %>
+</div>

data/app/views/bookmarks/update.js.erb

@@ -0,0 +1 @@
+$('#folder_item_toggle').replaceWith("<%= escape_javascript(render(partial: 'folders/in_folder')) %>")

data/app/views/bpluser/folders/_folder.html.erb

@@ -0,0 +1,36 @@
+<li class="folders_index_list_item">
+  <h4>
+    <%= link_to folder.title, folder, :class => "folder_title" %>
+    <small class="folder_visibility">
+      <% if folder.public? %>
+        <%= icon('fas', 'eye', class: 'folder-icon', aria: { hidden: true }) %>
+        <span class="visibility_public"><%= folder.visibility %></span>
+      <% else %>
+        <%= icon('fas', 'lock', class: 'folder-icon', aria: { hidden: true }) %>
+        <span class="visibility_private"><%= folder.visibility %></span>
+      <% end %>
+    </small>
+  </h4>
+  <% if current_user %>
+      <!--
+      <div class="delete_folder">
+      <%# link_to icon('fas', 'trash-alt', aria: { hidden: true }),
+                  folder,
+                  method: :delete,
+                  data: { confirm: t('blacklight.folders.delete.confirm') },
+                  title: "delete this folder" %>
+      </div>
+      -->
+  <% end %>
+  <div class="folder_status">
+    <span class="folder_item_count">
+      <%= pluralize(folder.folder_items.length.to_s,'item') %>
+    </span>
+    <span class="folder_updated_at">
+      updated <%= time_ago_in_words(folder.updated_at) %> ago
+    </span>
+  </div>
+  <% if folder.description %>
+      <%= folder.description %>
+  <% end %>
+</li>

data/app/views/catalog/_constraints.html.erb

@@ -0,0 +1,14 @@
+<%# override so we can add save_search partial from Bpluser %>
+<% if Deprecation.silence(Blacklight::RenderConstraintsHelperBehavior) { query_has_constraints? } %>
+  <div id="appliedParams" class="clearfix constraints-container card bg-light">
+    <div class="card-body">
+      <h2 class="sr-only"><%= t('blacklight.search.search_constraints_header') %></h2>
+      <div id="start_over_wrapper">
+        <%= render 'start_over' %>
+        <%= render 'save_search' if current_or_guest_user %>
+      </div>
+      <span class="constraints-label"><%= t('blacklight.search.filters.title') %></span>
+      <%= render_constraints(controller.params != params ? params : search_state) %>
+    </div>
+  </div>
+<% end %>

data/app/views/catalog/_folder_item_control.html.erb

@@ -0,0 +1,52 @@
+<% if current_or_guest_user %>
+  <div class="documentFunctions">
+    <div id="folder_item_toggle">
+      <% if current_user %>
+          <% existing_folders = current_user.folders %>
+          <% existing_folder_item = current_user.existing_folder_item_for(document.id) %>
+      <% else %>
+          <% existing_folders = [] %>
+      <% end %>
+
+      <% unless bookmarked? document || existing_folder_item %>
+        <% if existing_folders.empty? %>
+          <%= form_tag( bookmark_path( document ), method: :put, remote: true) do %>
+            <button class="btn btn-outline-secondary" type="submit">
+                <%= icon('fas', 'folder-plus', class: 'show-tools-icon', aria: { hidden: true }) + ' ' + t('blacklight.folder_items.add.button') %>
+            </button>
+          <% end %>
+        <% else %>
+              <%= form_tag(bookmark_path(document), method: :put, remote: true) do %>
+
+                <div class="btn-group folder-item-control">
+                    <button class="btn btn-outline-secondary" type="submit">
+                        <%= icon('fas', 'folder-plus', class: 'show-tools-icon', aria: { hidden: true }) + ' ' + t('blacklight.folder_items.add.button') %>
+                    </button>
+                    <button id="folder_add_dropdown" class="btn btn-outline-secondary dropdown-toggle dropdown-toggle-split" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+                      <span class="sr-only">Toggle Dropdown</span>
+                    </button>
+                    <div class="dropdown-menu" aria-labelledby="folder_add_dropdown">
+                        <%= link_to t('blacklight.bookmarks.title'),
+                                    bookmark_path(document),
+                                    method: :put,
+                                    class: 'folder_item_add dropdown-item',
+                                    remote: true %>
+
+                        <% existing_folders.each do |folder| %>
+                            <%= link_to folder.title,
+                                        folder_item_path(document, folder_id: folder.id),
+                                        method: :put,
+                                        class: 'folder_item_add dropdown-item',
+                                        remote: true %>
+
+                        <% end %>
+                    </div>
+                </div>
+              <% end %>
+        <% end %>
+      <% else %>
+        <%= render partial: 'folders/in_folder' %>
+      <% end %>
+    </div>
+  </div>
+<% end %>

data/app/views/catalog/_save_search.html.erb

@@ -0,0 +1,8 @@
+<%# if current_user %>
+<% if current_or_guest_user %>
+  <%= link_to t('blacklight.saved_searches.save'),
+              save_search_path(session[:history].first),
+              method: :put,
+              id: 'saveSearchLink',
+              class: 'catalog_saveSearchLink btn btn-sm btn-outline-secondary' %>
+<% end %>

data/app/views/devise/confirmations/new.html.erb

@@ -0,0 +1,14 @@
+<div class="col-sm-12">
+<h2>Resend confirmation instructions</h2>
+
+<%= form_for(resource, as: resource_name, url: confirmation_path(resource_name), html: { method: :post }) do |f| %>
+  <%= devise_error_messages! %>
+
+  <div><%= f.label :email %><br />
+  <%= f.email_field :email, autofocus: true %></div>
+
+  <div><%= f.submit "Resend confirmation instructions" %></div>
+<% end %>
+
+<%= render "devise/shared/links" %>
+</div>

data/app/views/devise/mailer/reset_password_instructions.html.erb

@@ -0,0 +1,13 @@
+<p>Hello <%= @resource.email %>!</p>
+
+<p>We recently received a request to change your password. Click the link below to get started:</p>
+
+<p><%= link_to 'Change my password', edit_user_password_url(reset_password_token: @token) %></p>
+
+<p>If you did not request a password change, then please ignore this email.</p>
+<p>(Your password won't be changed until you click the link above and create a new one.)</p>
+<p>If you have any questions, please <%= link_to t('blacklight.pages.contact.title'),  feedback_url %>.</p>
+<p>Thanks,<br/>
+Digital Commonwealth<br/>
+  <%= link_to 'https://www.digitalcommonwealth.org/', 'https://www.digitalcommonwealth.org/' %>
+</p>

data/app/views/devise/passwords/edit.html.erb

@@ -0,0 +1,32 @@
+<div class="col-sm-9">
+  <h2>Change your password</h2>
+
+  <%= form_for(resource,
+               as: resource_name,
+               url: user_password_path,
+               html: { method: :put, id: 'password_edit', role: 'form' }) do |f| %>
+    <%= render partial: 'devise/shared/error_messages', resource: resource %>
+    <%= f.hidden_field :reset_password_token %>
+
+      <div class="form-group row">
+        <label class="col-sm-2 col-form-label" for="inputPassword">New password</label>
+        <div class="col-sm-4">
+          <%= f.password_field :password, autofocus: true, autocomplete: 'off', class: 'form-control' %>
+        </div>
+      </div>
+      <div class="form-group row">
+        <label class="col-sm-2 col-form-label" for="inputPassword">Confirm new password</label>
+        <div class="col-sm-4">
+          <%= f.password_field :password_confirmation, autocomplete: 'off', class: 'form-control' %>
+        </div>
+      </div>
+      <div class="form-group row">
+        <div class="offset-sm-2 col-sm-6">
+          <%= f.submit 'Change password', class: 'btn btn-primary' %>
+          <%= link_to 'Cancel', root_path, class: 'btn btn-secondary' %>
+        </div>
+      </div>
+  <% end %>
+
+<%# render "devise/shared/links" %>
+</div>

data/app/views/devise/passwords/new.html.erb

@@ -0,0 +1,30 @@
+<div class="col-sm-9">
+  <h2>Forgot your password?</h2>
+
+  <p>Enter your email address below and we'll send you a message with instructions on how to reset your password.</p>
+
+  <%= form_for(resource,
+               as: resource_name,
+               url: user_password_path,
+               html: { method: :post,
+                       id: 'password_reset_request',
+                       role: 'form' }) do |f| %>
+    <%= render partial: 'devise/shared/error_messages', resource: resource %>
+
+    <div class="form-group row">
+      <label class="col-sm-2 col-form-label" for="inputEmail">Email</label>
+      <div class="col-sm-4">
+        <%= f.text_field :email, autofocus: true, class: 'form-control' %>
+      </div>
+    </div>
+
+    <div class="form-group row">
+      <div class="offset-sm-2 col-sm-4">
+        <%= f.submit 'Send password reset instructions', :class => 'btn btn-primary' %>
+      </div>
+    </div>
+
+  <% end %>
+
+<%# render "devise/shared/links" %>
+</div>

data/app/views/devise/registrations/edit.html.erb

@@ -0,0 +1,82 @@
+<div class="row">
+  <div class="col-sm-9">
+
+    <div id="breadcrumb">
+      <ul class="breadcrumb">
+        <li class="breadcrumb-item">
+          <%= link_to(t('blacklight.users.account_heading'), current_user) %>
+          <span class="divider"><%= t('blacklight.breadcrumb.separator') %></span>
+        </li>
+        <li class="active breadcrumb-item">
+          <%= t('devise.registrations.edit') %>
+        </li>
+      </ul>
+    </div>
+
+    <h2><%= t('devise.registrations.edit') %></h2>
+
+    <div id="edit_account_wrapper">
+
+      <%= form_for(resource, as: resource_name, url: registration_path(resource_name), html: { method: :put, role: 'form' }) do |f| %>
+        <%= render partial: 'devise/shared/error_messages', resource: resource %>
+        <div class="form-group row">
+          <%= f.label 'First Name', class: 'col-form-label col-sm-2' %>
+          <div class="col-sm-4">
+            <%= f.text_field :first_name, autofocus: true, class: 'form-control' %>
+          </div>
+        </div>
+        <div class="form-group row">
+          <%= f.label 'Last Name', class: 'col-form-label col-sm-2' %>
+          <div class="col-sm-4">
+            <%= f.text_field :last_name, class: 'form-control' %>
+          </div>
+        </div>
+        <div class="form-group row">
+          <%= f.label :email, class: 'col-form-label col-sm-2' %>
+          <div class="col-sm-4">
+            <%= f.email_field :email, class: 'form-control' %>
+          </div>
+        </div>
+        <div class="form-group row">
+          <%= f.label t('devise.registrations.password.new'), class: 'col-form-label col-sm-2' %>
+          <div class="col-sm-4">
+            <%= f.password_field :password, class: 'form-control', autocomplete: 'off' %>
+            <span class="form-text">(leave blank if you don't want to change your password)</span>
+          </div>
+        </div>
+        <div class="form-group row">
+          <%= f.label t('devise.registrations.password.new_confirm'), class: 'col-form-label col-sm-2' %>
+          <div class="col-sm-4">
+            <%= f.password_field :password_confirmation, class: 'form-control', autocomplete: 'off' %>
+          </div>
+        </div>
+        <div class="form-group row">
+          <%= f.label t('devise.registrations.password.old'), class: 'col-form-label col-sm-2' %>
+          <div class="col-sm-4">
+            <%= f.password_field :current_password, class: 'form-control', autocomplete: 'off' %>
+            <span class="form-text">(we need your current password to confirm your changes)</span>
+          </div>
+        </div>
+        <div class="form-group row">
+          <div class="offset-sm-2 col-sm-6">
+            <%= f.submit 'Update my account', class: 'btn btn-primary' %>
+            <%= link_to 'Cancel changes', current_user, class: 'btn btn-secondary' %>
+          </div>
+        </div>
+      <% end %>
+    </div>
+  </div>
+  <div class="col-sm-3 sidebar-right">
+    <div id="cancel_account">
+      <h5>Actually, I want to cancel my account...</h5>
+      <ul>
+        <li>
+          <%= link_to "Cancel my account",
+                      user_registration_path(resource),
+                      data: { confirm: 'Are you sure? Any bookmarks, folders, or searches you have created will be deleted.' },
+                      method: :delete %>
+        </li>
+      </ul>
+    </div>
+  </div>
+</div>

data/app/views/devise/registrations/new.html.erb

@@ -0,0 +1,45 @@
+<div class="col-sm-12">
+<h2>Sign up</h2>
+
+  <div id="signup_wrapper">
+    <%= form_for(resource, as: resource_name, url: registration_path(resource_name), html: { method: :post, role: 'form' }) do |f| %>
+      <%= render partial: 'devise/shared/error_messages', resource: resource %>
+      <div class="form-group row">
+        <label class="col-sm-2 col-form-label" for="inputFirstName">First name</label>
+        <div class="col-sm-4">
+          <%= f.text_field :first_name, autofocus: true, class: 'form-control' %>
+        </div>
+      </div>
+      <div class="form-group row">
+        <label class="col-sm-2 col-form-label" for="inputLastName">Last name</label>
+        <div class="col-sm-4">
+          <%= f.text_field :last_name, class: 'form-control' %>
+        </div>
+      </div>
+      <div class="form-group row">
+        <label class="col-sm-2 col-form-label" for="inputEmail">Email</label>
+        <div class="col-sm-4">
+          <%= f.text_field :email, class: 'form-control' %>
+        </div>
+      </div>
+      <div class="form-group row">
+        <label class="col-sm-2 col-form-label" for="inputPassword">Password</label>
+        <div class="col-sm-4">
+          <%= f.password_field :password, autocomplete: 'off', class: 'form-control' %>
+        </div>
+      </div>
+      <div class="form-group row">
+        <label class="col-sm-2 col-form-label" for="inputPassword">Re-enter password</label>
+        <div class="col-sm-4">
+          <%= f.password_field :password_confirmation, autocomplete: 'off', class: 'form-control' %>
+        </div>
+      </div>
+      <div class="form-group row">
+        <div class="offset-sm-2 col-sm-4">
+          <%= f.submit 'Sign up', class: 'btn btn-primary' %>
+          <%= link_to 'Cancel', root_path, class: 'btn btn-secondary' %>
+        </div>
+      </div>
+    <% end %>
+  </div>
+</div>

data/app/views/devise/sessions/new.html.erb

@@ -0,0 +1,72 @@
+<div class="row">
+  <div class="col-sm-9">
+    <h2>Sign in</h2>
+
+    <div id="signin_wrapper">
+
+      <%= form_for(resource,
+                   as: resource_name,
+                   url: user_session_path,
+                   html: { method: :post, role: 'form' }) do |f| %>
+
+        <div class="form-group row">
+          <label class="col-sm-2 col-form-label" for="user_uid">Email</label>
+          <div class="col-sm-4">
+            <%= f.text_field :email, class: 'form-control' %>
+          </div>
+        </div>
+        <div class="form-group row">
+          <label class="col-sm-2 col-form-label" for="user_password">Password</label>
+          <div class="col-sm-4">
+            <%= f.password_field :password, class: 'form-control' %>
+            <span class="form-text">
+                <%- if devise_mapping.recoverable? && controller_name != 'passwords' %>
+                  <%= link_to 'Forgot your password?', new_password_path(resource_name) %>
+                <% end -%>
+              </span>
+          </div>
+        </div>
+        <% if devise_mapping.rememberable? -%>
+          <div class="form-group row">
+            <div class="form-check offset-sm-2 col-sm-6">
+              <%= f.check_box :remember_me, class: 'form-check-input' %>
+              <label id="remember_me" class="form-check-label">
+                Remember me on this device
+              </label>
+            </div>
+          </div>
+
+        <% end -%>
+        <div class="form-group row">
+          <div class="offset-sm-2 col-sm-4">
+            <%# f.submit "Sign in" %>
+            <button type="submit" class="btn btn-primary">
+              <span>Sign in</span>
+            </button>
+          </div>
+        </div>
+
+      <% end %>
+
+      <div id="alt_signins">
+        <%= link_to(image_tag('commonwealth-vlr-engine/bplLoginButton.png',
+                              alt: 'Log in with your BPL library card',
+                              class: 'alt_signin_btn'),
+                     user_polaris_omniauth_authorize_path, method: :post) %>
+      </div>
+
+      <%= render 'devise/shared/links' %>
+
+    </div>
+  </div>
+  <div class="col-sm-3">
+    <div id="why_log_in">
+      <h5>Why sign in?</h5>
+      <ul>
+        <li>Create customized collections of your favorite items</li>
+        <li>Save important searches</li>
+        <li>Keep track of your search history</li>
+      </ul>
+    </div>
+  </div>
+</div>