samvera-persona 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0aa7c2fad1a3516b6b8bb4ecfc1f14776fa335e6eb65a5f887ec98715b87ffe6
+  data.tar.gz: 75329f5fdad449b9cdab5ea5670d977378b44c5ba1136963fd5a079a23ecc319
+SHA512:
+  metadata.gz: 38e0864ea45f01aeae073ada221be4635dfc9119c233e1e1d54c971d352bcfb54fc01e033958d1778997474823978f10ad3c0960ac81467236e2915a8f652f42
+  data.tar.gz: 6088ba72b26cd6fee6995f86f95fd50a23a70bd8ccac0d3e702ebfafb47dad09657db73749c7f2b3e51913dae7b25c3a7c41aeeb7e840822a548addeb89e64ce

data/LICENSE

@@ -0,0 +1,205 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2012 Penn State University
+   Copyright 2013 University of Notre Dame, Northwestern University, and Data Curation Experts
+   Copyright 2014 Data Curation Experts
+   Additional copyright may be held by others, as reflected in the commit log
+
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/Rakefile

@@ -0,0 +1,33 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Samvera::Persona'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/app/controllers/concerns/samvera/persona/avalon_auth.rb

@@ -0,0 +1,20 @@
+module Samvera
+  module Persona
+    module AvalonAuth
+      extend ActiveSupport::Concern
+      included do
+        before_action :auth
+      end
+
+      def auth
+        if current_user.nil?
+          flash[:notice] = "You need to login to manage users"
+          redirect_to main_app.new_user_session_path
+        elsif cannot? :manage, User
+          flash[:notice] = "You do not have permission to manage users"
+          redirect_to main_app.root_path
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/samvera/persona/becomes_behavior.rb

@@ -0,0 +1,10 @@
+module Samvera
+  module Persona
+    module BecomesBehavior
+      extend ActiveSupport::Concern
+      included do
+        impersonates :user
+      end
+    end
+  end
+end

data/app/controllers/samvera/persona/users_controller.rb

@@ -0,0 +1,100 @@
+module Samvera
+  class Persona::UsersController < ApplicationController
+    # include Hyrax based theme and admin only connection
+    begin
+      if defined?(Avalon)
+        include Samvera::Persona::AvalonAuth
+      end
+      include Hyrax::Admin::UsersControllerBehavior
+    rescue NameError
+      before_action :authenticate_user!
+    end
+
+    before_action :load_user, only: [:edit, :update, :destroy]
+    before_action :app_view_path
+    # NOTE: User creation/invitations handled by devise_invitable
+    def index
+      # Hyrax derivitives have breadcrumbs, Avalon does not
+      if defined?(add_breadcrumb)
+        add_breadcrumb t(:'hyrax.controls.home'), main_app.root_path
+        add_breadcrumb t(:'hyrax.dashboard.breadcrumbs.admin'), hyrax.dashboard_path
+        add_breadcrumb t(:'samvera.persona.users.index.title'), main_app.persona_users_path
+      end
+
+      @presenter = Samvera::Persona::UsersPresenter.new
+    end
+
+    # GET /persona/users/1/edit
+    def edit
+      # Hyrax derivitives have breadcrumbs, Avalon does not
+      if defined?(add_breadcrumb)
+        add_breadcrumb t(:'hyrax.controls.home'), main_app.root_path
+        add_breadcrumb t(:'hyrax.admin.sidebar.users'), main_app.persona_users_path
+        add_breadcrumb @user.display_name, main_app.edit_persona_user_path(@user)
+      end
+    end
+
+    # PATCH/PUT persona/users/1
+    # PATCH/PUT persona/users/1.json
+    def update
+      # required for settings form to submit when password is left blank
+      if params[:user][:password].blank?
+        params[:user].delete(:password)
+        params[:user].delete(:password_confirmation)
+      end
+
+      respond_to do |format|
+        if @user.update_attributes(user_params)
+          @user.save
+
+          format.html { redirect_to main_app.persona_users_path, notice: 'User was successfully updated.' }#move to locales
+          format.json { render :show, status: :ok }
+        else
+          format.html { render :edit }
+          format.json { render json: @user.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    # Become a user
+    def impersonate
+      user = User.find(params[:id])
+      impersonate_user(user)
+      redirect_to main_app.root_path
+    end
+
+    def stop_impersonating
+      stop_impersonating_user
+      redirect_to main_app.persona_users_path, notice: t('.become.over')
+    end
+
+    # Delete a user from the site
+    def destroy
+      #TODO update hyku user.destroy to do roles.destroy_all instead
+      if @user.present? && @user.destroy
+        redirect_to main_app.persona_users_path, notice: t('.success', user: @user)
+      else
+        redirect_to main_app.persona_users_path flash: { error: t('.failure', user: @user) }
+      end
+    end
+
+    private
+
+    def load_user
+      if User.respond_to?(:from_url_component)
+        @user = User.from_url_component(params[:id])
+      else
+        @user = User.find(params[:id])
+      end
+    end
+
+    def app_view_path
+      my_engine_root = Samvera::Persona::Engine.root.to_s
+      prepend_view_path "#{my_engine_root}/app/views/#{Rails.application.class.parent_name.downcase}"
+    end
+
+    def user_params
+      params.require(:user).permit(:email, :username, :password, :password_confirmation, :is_superadmin, :facebook_handle, :twitter_handle, :googleplus_handle, :display_name, :address, :department, :title, :office, :chat_id, :website, :affiliation, :telephone, :avatar, :group_list, :linkedin_handle, :orcid, :arkivo_token, :arkivo_subscription, :zotero_token, :zotero_userid, :preferred_locale, role_ids: [])
+    end
+  end
+end

data/app/controllers/test_controller.rb

@@ -0,0 +1,4 @@
+class TestController < ApplicationController
+  def index
+  end
+end

data/app/helpers/samvera/persona/application_helper.rb

@@ -0,0 +1,13 @@
+module Samvera
+  module Persona
+    module ApplicationHelper
+      def root_path
+        main_app.root_path
+      end
+
+      def root_url
+        main_app.root_url
+      end
+    end
+  end
+end

data/app/models/concerns/samvera/persona/soft_delete_behavior.rb

@@ -0,0 +1,10 @@
+module Samvera
+  module Persona
+    module SoftDeleteBehavior
+      extend ActiveSupport::Concern
+      included do
+        acts_as_paranoid
+      end
+    end
+  end
+end

data/app/models/concerns/samvera/persona/username_behavior.rb

@@ -0,0 +1,26 @@
+module Samvera
+  module Persona
+    module UsernameBehavior 
+      extend ActiveSupport::Concern
+      included do
+        before_create :check_for_mandatory
+      end
+
+      def check_for_mandatory
+        if self.respond_to?(:username)
+          if self.email.present? && self.username.blank?
+            self.username = self.email
+          end
+        end
+
+        if self.respond_to?(:uid)
+          if self.email.present? && self.uid.blank?
+            self.uid = self.email
+          end
+        end
+
+        true
+      end
+    end
+  end
+end

data/app/presenters/samvera/persona/users_presenter.rb

@@ -0,0 +1,41 @@
+module Samvera
+  module Persona
+    class UsersPresenter
+      # @return [Array] an array of Users
+      def users
+        @users ||= search
+      end
+
+      # @return [Number] quantity of users excluding the system users and guest_users
+      def user_count
+        users.count
+      end
+
+      # @return [Array] an array of user roles
+      def user_roles(user)
+        user.groups
+      end
+
+      def last_accessed(user)
+        user.respond_to?(:last_sign_in_at) && user.last_sign_in_at ? user.last_sign_in_at : user.created_at
+      end
+
+      # return [Boolean] true if the devise trackable module is enabled.
+      def show_last_access?
+        return @show_last_access unless @show_last_access.nil?
+        @show_last_access = ::User.devise_modules.include?(:trackable)
+      end
+
+      private
+
+        # Returns a list of users excluding the system users and guest_users
+      def search
+        if ::User.respond_to?(:registered)
+          ::User.registered.without_system_accounts
+        else
+          ::User.all
+        end
+      end
+    end
+  end
+end

data/app/views/avalon/samvera/persona/users/_form.html.erb

@@ -0,0 +1,63 @@
+<%#
+Copyright 2011-2018, The Trustees of Indiana University and Northwestern
+  University.  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed
+  under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+  CONDITIONS OF ANY KIND, either express or implied. See the License for the
+  specific language governing permissions and limitations under the License.
+---  END LICENSE_HEADER BLOCK  ---
+%>
+<%= form_for(@user, url: main_app.persona_user_path(@user), method: "put", html: { class: 'form' } ) do |f| %>
+
+  <div class="panel-body">
+    <% if @user.errors.any? %>
+      <div id="error_explanation" class="alert alert-danger">
+        <p><%= pluralize(@user.errors.count, "error") %> prohibited this user from being saved:</p>
+        <ul>
+          <% @user.errors.messages.each do |key, messages| %>
+            <li><%= key %> &quot;<%= @user.errors&.details[key]&.first&.[](:value) %>&quot; <%= messages.join(' and ') %></li>
+          <% end %>
+        </ul>
+      </div>
+    <% end %>
+
+    <div class="form-group">
+      <%= f.label :email %><br />
+      <%= f.email_field :email, autofocus: true, autocomplete: "email", class: 'form-control' %>
+    </div>
+
+    <% if f.object.respond_to?(:username) %>      
+      <div class="form-group">
+        <%= f.label :username %><br />
+        <%= f.text_field :username, class: 'form-control' %>
+      </div>
+    <% end %>
+
+    <div class="form-group">
+      <%= f.label :password %> <i>(leave blank if you don't want to change it)</i><br />
+      <%= f.password_field :password, autocomplete: "off", class: 'form-control' %>
+      <% if @minimum_password_length %>
+        <br />
+        <em><%= @minimum_password_length %> characters minimum</em>
+      <% end %>
+    </div>
+
+    <div class="form-group">
+      <%= f.label :password_confirmation %><br />
+      <%= f.password_field :password_confirmation, autocomplete: "off", class: 'form-control' %>
+    </div>
+
+    <div class="actions">
+      <%= f.submit "Update", class: 'btn btn-primary' %>
+      <%= link_to 'Cancel', main_app.persona_users_path, class: 'btn btn-default action-cancel' %>
+    </div>
+  </div>
+<% end %>
+
+

data/app/views/avalon/samvera/persona/users/_index_title.html.erb

@@ -0,0 +1 @@
+<h2><span class="fa fa-user"></span> <%= t('.title') %></h2>

data/app/views/avalon/samvera/persona/users/edit.html.erb

@@ -0,0 +1,7 @@
+<div class="container">
+  <div class="row col-md-9 col-lg-8">
+    <h3><span class="fa fa-gears"></span> Editing <%= @user.email %></h3>
+
+    <%= render 'form' %>
+  </div>
+</div>

data/app/views/samvera/persona/users/_form.html.erb

@@ -0,0 +1,25 @@
+<div class="form-inputs">
+  <%= f.input :display_name, label: 'Display Name' %> 
+  <%= f.input :email, hint: '' %>
+  <%= f.input :is_superadmin, as: :boolean %> 
+  <%= f.input :password, hint: 'Only if creating or changing' %>
+  <%= f.input :facebook_handle %> 
+  <%= f.input :twitter_handle %> 
+  <%= f.input :googleplus_handle %> 
+  <%= f.input :address %> 
+  <%= f.input :department %> 
+  <%= f.input :title, hint: '' %> 
+  <%= f.input :office %> 
+  <%= f.input :chat_id %> 
+  <%= f.input :website %> 
+  <%= f.input :affiliation %> 
+  <%= f.input :telephone %> 
+  <%= f.input :avatar %> 
+  <%= f.input :group_list %> 
+  <%= f.input :linkedin_handle %> 
+  <%= f.input :orcid %> 
+  <%= f.input :arkivo_token %> 
+  <%= f.input :arkivo_subscription %> 
+  <%= f.input :preferred_locale %> 
+</div>
+

data/app/views/samvera/persona/users/_index_title.html.erb

@@ -0,0 +1,3 @@
+<% provide :page_header do %>
+  <h1><span class="fa fa-user"></span> <%= t('.title') %></h1>
+<% end %>

data/app/views/samvera/persona/users/edit.html.erb

@@ -0,0 +1,29 @@
+<% content_for :page_header do %>
+  <h1><span class="fa fa-gears"></span> <%= t(".header") %></h1>
+<% end %>
+
+<div class="row">
+  <div class="col-md-12">
+    <div class="panel panel-default user-form">
+      <%= simple_form_for @user, url: main_app.persona_user_path(@user), html: { class: 'form' } do |f| %>
+        <div class="panel-body">
+          <% if @user.errors.any? %>
+            <div id="error_explanation" class="alert alert-danger">
+              <h2><%= pluralize(@user.errors.count, "error") %> prohibited this user from being saved:</h2>
+              <ul>
+                <% @user.errors.messages.each do |key, messages| %>
+                  <li><%= key %> &quot;<%= @user.errors&.details[key]&.first&.[](:value) %>&quot; <%= messages.join(' and ') %></li>
+                <% end %>
+              </ul>
+            </div>
+          <% end %>
+
+          <%= render 'form', user: @user, f: f %>
+
+          <%= f.submit class: 'btn btn-primary' %>
+          <%= link_to t('edit_form.cancel'), main_app.persona_users_path, class: 'btn btn-link action-cancel' %>
+        </div>
+      <% end %>
+    </div>
+  </div>
+</div>