to_spotlight 0.2.2 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4deb28ad3713576341e26dda6fe4d04c035125f8d7787afab0887344175b02d4
-  data.tar.gz: 3481e5a52599293ab4462e5ec47bb0f80f0e9ae51e0921360c58537640f76a98
+  metadata.gz: 070111e1947b8dfc8761c5733c4e896f196be0e2e35a2d6705a3966fc03d0ced
+  data.tar.gz: 259d653332a734d74c82fcf49ec532803c39c868bf0217bcaea6a429d9c519aa
 SHA512:
-  metadata.gz: d200aad7d3b7a82795c7629655397bc6345406246e863e98d5a3c34a7b5c7aefbc7ae337a325b13690d1888f33aa9408a78a0273e1b48a7bf94939ddca319680
-  data.tar.gz: a3f955886e4d0d015011b7af44b19c8a1507a0c38e09fe77f9841c8673d90ca8470a1188f6128c6a100c768a124b528ff47b117186535a5d048de7e2e7f2dc00
+  metadata.gz: e1295991e10c234798c3b25d8260af0a5f750b1929103d5a7631b6722134c4a63bbac936f491135ff31b0ef86687e360422fcfce2330b8cf702cc17f3cab9e1d
+  data.tar.gz: 1758daf976e1710b890caf97524744c8643c4dd6bd8e839007fc4e69a80d05c301dc5b41c5a6867a5857a9b7b7fbad655d877781ee06e2d5a10654fcba91eadf

data/app/controllers/to_spotlight/spotlight_transfer_controller.rb

@@ -1,7 +1,12 @@
 module ToSpotlight
-  class SpotlightTransferController < ActionController::Base
+  class SpotlightTransferController < ApplicationController
     protect_from_forgery with: :exception
+    before_action :authenticate_user!, except: [:api, :receive]
     skip_before_action :verify_authenticity_token, only: :receive
+    helper_method :default_page_title, :admin_host?, :available_translations, :available_works
+    include ActionView::Helpers::UrlHelper
+    layout 'hyrax/dashboard' if Hyrax
+    before_action :authenticate, except: [:index, :api, :receive]
     require 'json'
     require 'net/http'
 
@@ -20,8 +25,8 @@ module ToSpotlight
     end
 
     def receive
-      return unless params[:token]
-      @transfer = ToSpotlight::SpotlightTransfer.new get_transfer_attributes
+      return unless params[:token] == token
+      @transfer          = ToSpotlight::SpotlightTransfer.new get_transfer_attributes
       @transfer.mappings = params[:mappings]
       if @transfer.save
         render plain: 'Transfer Request Received'
@@ -35,9 +40,9 @@ module ToSpotlight
     end
 
     def approve
-      now = params[:commit].downcase.include?('now')
+      now      = params[:commit].downcase.include?('now')
       transfer = ToSpotlight::SpotlightTransfer.find params[:transfer_id]
-      works = ::ActiveFedora::Base.where member_of_collection_ids_ssim: transfer.collection_id
+      works    = ::ActiveFedora::Base.where member_of_collection_ids_ssim: transfer.collection_id
       mappings = mapping_invert transfer.mappings
       if now
         SpotlightTransferJob.perform_later(works.to_a, mappings, transfer)
@@ -45,14 +50,18 @@ module ToSpotlight
         SpotlightTransferJob.set(wait_until: Date.today.end_of_day)
                             .perform_later(works.to_a, mappings, transfer)
       end
-
+      redirect_to spotlight_transfer_index_path
     end
 
     private
 
+    def token
+      ToSpotlight::Engine.config['hyrax_instances']
+    end
+
     def mapping_invert(hash)
       result = []
-      test   = hash.map { |h| {h['hyrax'] => h['spotlight'].values} }
+      test   = hash.map { |h| { h['hyrax'] => h['spotlight'].values } }
       test.reduce({}, :merge).map { |k, v| v.map { |val| [val, k] } }.each { |a| a.each { |a2| result << a2 } }
       Hash[result]
     end
@@ -66,31 +75,21 @@ module ToSpotlight
     end
 
     def curated_fields
-      {"common_fields" => (work_fields - excluded_fields - field_differences), "differences" => field_differences}
+      {
+        common_fields: (work_fields - excluded_fields - field_differences),
+        differences: field_differences
+      }
     end
 
     def work_fields
-      curated_works.map { |work| work.constantize.new.attributes.keys }.flatten.uniq
-       #%w[id head tail depositor title date_uploaded date_modified state
-       #  proxy_depositor on_behalf_of arkivo_checksum owner alternative_title
-       #  edition geographic_coverage coordinates chronological_coverage extent
-       #  additional_physical_characteristics has_format physical_repository
-       #  collection provenance provider sponsor genre format
-       #  archival_item_identifier fonds_title fonds_creator fonds_description
-       #  fonds_identifier is_referenced_by date_digitized transcript
-       #  technical_note year label relative_path import_url creator part_of
-       #  resource_type contributor description keyword license rights_statement
-       #  publisher date_created subject language identifier based_near
-       #  related_url bibliographic_citation source access_control_id
-       #  representative_id thumbnail_id rendering_ids admin_set_id
-       #  embargo_id lease_id]
+      @work_fields ||= curated_works.map { |work| work.constantize.new.attributes.keys }.flatten.uniq
     end
 
     def excluded_fields
       %w[id title head tail state proxy_depositor on_behalf_of arkivo_checksum label
-         relative_path import_url part_of resource_type access_control_id
-         representative_id thumbnail_id rendering_ids admin_set_id embargo_id
-         lease_id]
+       relative_path import_url part_of resource_type access_control_id
+       representative_id thumbnail_id rendering_ids admin_set_id embargo_id
+       lease_id]
     end
 
     def field_differences
@@ -108,7 +107,7 @@ module ToSpotlight
     end
 
     def intersect a_of_a
-      eval a_of_a.map{|a| a.inspect}.join(' & ')
+      eval a_of_a.map { |a| a.inspect }.join(' & ')
     end
 
     def get_transfer_attributes
@@ -118,5 +117,24 @@ module ToSpotlight
                                        :spotlight_url)
     end
 
+      #helpers
+    def available_works
+      @available_works ||= Hyrax::QuickClassificationQuery.new(current_user).authorized_models
+    end
+
+    def default_page_title
+      'Spotlight Transfer'
+    end
+
+    def admin_host?
+      false unless Settings.multitenancy.enabled rescue nil
+    end
+
+    def available_translations
+      {
+        'en' => 'English',
+        'fr' => 'French'
+      }
+    end
   end
 end

data/app/jobs/to_spotlight/spotlight_transfer_job.rb

@@ -3,9 +3,9 @@ module ToSpotlight
     queue_as :default
 
     def perform(works, mappings, transfer)
-      base_url = ::Account.where(tenant: Apartment::Tenant.current).first.cname
+      base_url    = ::Account.where(tenant: Apartment::Tenant.current).first.cname
       csv_headers = %w[url full_title_tesim] + mappings.keys + %w[children]
-      csv_array = [csv_headers.join(',')]
+      csv_array   = [csv_headers.join(',')]
       #items = []
       works.each do |wk|
         #if comp
@@ -16,7 +16,7 @@ module ToSpotlight
         #  next if wk.file_set_ids.length>1
         #end
         #index += 1
-        comp = false #wk.file_set_ids.length > 1
+        comp     = false #wk.file_set_ids.length > 1
         children = []
         if comp
           index = wk.ordered_file_set_ids.length * -1
@@ -29,8 +29,8 @@ module ToSpotlight
 
         doc = ::SolrDocument.find wk.id
 
-        line_hash = {}
-        line_hash['url'] = "http://#{base_url}/concern/#{underscore_name(wk)}/#{wk.id}/manifest.json" #url
+        line_hash                     = {}
+        line_hash['url']              = "http://#{base_url}/concern/#{underscore_name(wk)}/#{wk.id}/manifest.json" #url
         line_hash['full_title_tesim'] = (doc.title.length > 1 ? doc.title.join('; ') : doc.title.first) #full_title_tesim
 
         mappings.each do |skey, field|
@@ -39,30 +39,30 @@ module ToSpotlight
 
         line_hash['children'] = children.join('|')
 
-        csv_array << line_hash.values_at(*csv_headers).map { |cell| cell = '' if cell.nil?; "\"#{cell.gsub("\"","\"\"")}\"" }.join(',')
+        csv_array << line_hash.values_at(*csv_headers).map { |cell| cell = '' if cell.nil?; "\"#{cell.gsub("\"", "\"\"")}\"" }.join(',')
 
       end
 
       dir = Rails.root.join('public', 'uploads', 'csvs')
       Dir.mkdir(dir) unless Dir.exist?(dir)
-      time = DateTime.now.strftime('%s')
+      time     = DateTime.now.strftime('%s')
       filename = "spotlight_export-#{time}.csv"
       File.open(dir.join(filename), 'wb') do |file|
         file.write(csv_array.join("\n"))
       end
       res = post_response URI("#{transfer.spotlight_url}/from_hyrax/receive"),
-                          csv_url:    "https://#{base_url}/uploads/csvs/#{filename}",
-                          transfer:   transfer.attributes.slice(:user, :exhibit), #only allow user+exhibit
-                          token:      'secret_token'
+                          csv_url:  "https://#{base_url}/uploads/csvs/#{filename}",
+                          transfer: transfer.attributes.slice(:user, :exhibit), #only allow user+exhibit
+                          token: 'secret_token'
 
     end
 
-    def post_response uri, options={}
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true
+    def post_response uri, options = {}
+      http             = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl     = true
       http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      request = Net::HTTP::Post.new(uri.request_uri, 'Content-Type' => 'application/json')
-      request.body = options.to_json
+      request          = Net::HTTP::Post.new(uri.request_uri, 'Content-Type' => 'application/json')
+      request.body     = options.to_json
       http.request(request)
     end
 

data/app/views/to_spotlight/spotlight_transfer/_default_group.html.erb

@@ -9,7 +9,7 @@
   </thead>
   <tbody>
   <% transfers.each do |transfer| %>
-      <%= render 'list_transfers', transfer: transfer %>
+    <%= render 'list_transfers', transfer: transfer %>
   <% end %>
   </tbody>
 </table>

data/app/views/to_spotlight/spotlight_transfer/_list_transfers.html.erb

@@ -7,10 +7,10 @@
   <td><%= transfer.collection_title %></td>
 
   <td>
-    <%= form_tag to_spotlight.approve_path, method: :post, class: "form-inline" do %>
+    <%= form_tag main_app.to_spotlight_approve_path, method: :post, class: "form-inline" do %>
       <%= hidden_field_tag 'transfer_id', transfer.id %>
       <%= submit_tag "Run Tonight", class: 'btn btn-primary' %>
-    <% end %><%= form_tag to_spotlight.approve_path, method: :post, class: "form-inline" do %>
+    <% end %><%= form_tag main_app.to_spotlight_approve_path, method: :post, class: "form-inline" do %>
       <%= hidden_field_tag 'transfer_id', transfer.id %>
       <%= submit_tag "Run Now", class: 'btn btn-primary' %>
     <% end %>

data/app/views/to_spotlight/spotlight_transfer/_transfers_list.html.erb

@@ -1,4 +1,4 @@
-<% # container for all batches in index view -%>
+<% # container for all batches in index view  -%>
 <div class="table-responsive" id="transfers">
   <%= render 'default_group', transfers: @transfers %>
 </div>

data/config/routes.rb

@@ -1,6 +1,6 @@
-ToSpotlight::Engine.routes.draw do
-  get 'api/:request_type' => 'spotlight_transfer#api'
-  post 'receive' => 'spotlight_transfer#receive'
-  get 'index' => 'spotlight_transfer#index'
-  post 'approve' => 'spotlight_transfer#approve'
+Rails.application.routes.draw do
+  get '/to_spotlight/api/:request_type' => 'to_spotlight/spotlight_transfer#api', as: 'to_spotlight_api'
+  post '/to_spotlight/receive' => 'to_spotlight/spotlight_transfer#receive'
+  get '/to_spotlight' => 'to_spotlight/spotlight_transfer#index', as: 'to_spotlight_index'
+  post '/to_spotlight/approve' => 'to_spotlight/spotlight_transfer#approve'
 end

data/lib/generators/install/install_generator.rb

@@ -0,0 +1,21 @@
+class ToSpotlight::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def inject_content_dm_yml
+    copy_file('config/to_spotlight.yml', 'config/to_spotlight.yml') unless File.file?('config/to_spotlight.yml')
+  end
+
+  def inject_dashboard_link
+    file_path = 'app/views/hyrax/dashboard/sidebar/_tasks.html.erb'
+    if File.file?(file_path)
+      insert_into_file file_path, before: /[ \t]*<% if can\? :manage, User %>/m do
+        "                 \n<% if can? :review, :submissions %>\n" \
+        "							   <%= menu.nav_link(main_app.to_spotlight_index_path) do %>\n" \
+        "							   <span class=\"fa fa-flag\" aria-hidden=\"true\"></span> <span class=\"sidebar-action-text\"><%= t('Spotlight Transfers') %></span>\n" \
+        "							   <% end %>\n\n"
+      end
+    else
+      copy_file 'sidebar/_tasks.html.erb', 'app/views/hyrax/dashboard/sidebar/_tasks.html.erb'
+    end
+  end
+end

data/lib/generators/install/templates/config/to_spotlight.yml

@@ -0,0 +1 @@
+secret_token: 'rftvgyuhwefhcgyvuryweudijxoschdufygvebhqwdijloschvugbeiofhqdijlcnhqeljcmjioeql328r9hdfec3h'

data/lib/generators/install/templates/sidebar/_tasks.html.erb

@@ -0,0 +1,41 @@
+<li class="h5"><%= t('hyrax.admin.sidebar.tasks') %></li>
+
+<% if can? :review, :submissions %>
+  <%= menu.nav_link(hyrax.admin_workflows_path) do %>
+    <span class="fa fa-flag" aria-hidden="true"></span>
+    <span class="sidebar-action-text"><%= t('hyrax.admin.sidebar.workflow_review') %></span>
+  <% end %>
+<% end %>
+
+<% if can? :review, :submissions %>
+  <%= menu.nav_link(main_app.to_spotlight_index_path) do %>
+    <span class="fa fa-flag" aria-hidden="true"></span>
+    <span class="sidebar-action-text"><%= t('Spotlight Transfers') %></span>
+  <% end %>
+<% end %>
+
+<% if can? :manage, User %>
+  <%= menu.nav_link(hyrax.admin_users_path) do %>
+    <span class="fa fa-user" aria-hidden="true"></span>
+    <span class="sidebar-action-text"><%= t('hyrax.admin.sidebar.users') %></span>
+  <% end %>
+<% end %>
+
+<% if can? :manage, Hyku::Group %>
+  <%= menu.nav_link(main_app.admin_groups_path) do %>
+    <span class="fa fa-users"></span>
+    <span class="sidebar-action-text"><%= t('hyrax.admin.sidebar.manage_groups') %></span>
+  <% end %>
+<% end %>
+
+<% if can? :read, :admin_dashboard %>
+  <%= menu.nav_link(hyrax.embargoes_path) do %>
+    <span class="fa fa-flag" aria-hidden="true"></span>
+    <span class="sidebar-action-text"><%= t('hyrax.embargoes.index.manage_embargoes') %></span>
+  <% end %>
+
+  <%= menu.nav_link(hyrax.leases_path) do %>
+    <span class="fa fa-flag" aria-hidden="true"></span>
+    <span class="sidebar-action-text"><%= t('hyrax.leases.index.manage_leases') %></span>
+  <% end %>
+<% end %>

data/lib/to_spotlight/engine.rb

@@ -3,10 +3,26 @@ module ToSpotlight
     isolate_namespace ToSpotlight
     initializer :append_migrations do |app|
       unless app.root.to_s.match root.to_s
-        config.paths["db/migrate"].expanded.each do |expanded_path|
-          app.config.paths["db/migrate"] << expanded_path
+        config.paths['db/migrate'].expanded.each do |expanded_path|
+          app.config.paths['db/migrate'] << expanded_path
         end
       end
     end
+
+    class << self
+
+      def config
+        file = File.open(File.join(::Rails.root, '/config/from_hyrax.yml'))
+        @config ||= YAML.safe_load(file)
+      end
+
+      # loads a yml file with the configuration options
+      #
+      # @param file [String] path to the yml file
+      #
+      def load_config(file)
+        @config = YAML.load_file(file)
+      end
+    end
   end
 end

data/lib/to_spotlight/version.rb

@@ -1,3 +1,3 @@
 module ToSpotlight
-  VERSION = '0.2.2'.freeze
+  VERSION = '0.2.7'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: to_spotlight
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.7
 platform: ruby
 authors:
 - sephirothkod
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-04 00:00:00.000000000 Z
+date: 2020-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -64,14 +64,14 @@ files:
 - app/views/to_spotlight/spotlight_transfer/_default_group.html.erb
 - app/views/to_spotlight/spotlight_transfer/_list_transfers.html.erb
 - app/views/to_spotlight/spotlight_transfer/_select.html.erb
-- app/views/to_spotlight/spotlight_transfer/_tabs.html.erb
 - app/views/to_spotlight/spotlight_transfer/_transfers_list.html.erb
-- app/views/to_spotlight/spotlight_transfer/approve.html.erb
 - app/views/to_spotlight/spotlight_transfer/index.html.erb
 - app/views/to_spotlight/spotlight_transfer/receive.html.erb
-- config/application.rb
 - config/routes.rb
 - db/migrate/20200310153953_create_to_spotlight_spotlight_transfers.rb
+- lib/generators/install/install_generator.rb
+- lib/generators/install/templates/config/to_spotlight.yml
+- lib/generators/install/templates/sidebar/_tasks.html.erb
 - lib/tasks/to_spotlight_tasks.rake
 - lib/to_spotlight.rb
 - lib/to_spotlight/engine.rb

data/app/views/to_spotlight/spotlight_transfer/_tabs.html.erb

@@ -1,5 +0,0 @@
-<ul class="nav nav-tabs" id="my_nav" role="navigation">
-  <li<%= ' class="active"'.html_safe %>>
-    <%= link_to "All CSV Batches", to_spotlight.index_path %>
-  </li>
-</ul>

data/app/views/to_spotlight/spotlight_transfer/approve.html.erb

@@ -1,7 +0,0 @@
-<h1>ToSpotlight#approve</h1>
-<p>Find me in app/views/to_spotlight/to_spotlight/approve.html.erb</p>
-<%= params.inspect %>
-
-<br/>
-
-<%#= @res.body %>

data/config/application.rb

@@ -1,10 +0,0 @@
-module ToSpotlight
-  class Application < Rails::Application
-    config.middleware.insert_before 0, Rack::Cors do
-      allow do
-        origins '*'
-        resource '/to_spotlight/api/*', headers: :any, methods: %i[get post options]
-      end
-    end
-  end
-end