hybridge 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 331386a91eca4135d11c45829ea74731c3a4bc80
+  data.tar.gz: f9df4cbab4cf1f84d86692c412e712206cd1dcf2
+SHA512:
+  metadata.gz: 579b65a48bd2a06cf659b4d38df519f349a5e60f6f14160884c93dd288f4db80c13b1604866f90a523989d87cbe38cfd37cce2c6bc0f81a2a86299e3aee0dae3
+  data.tar.gz: eab5b900ac1ca6599940155f18d7a67bb235f61b5c7efc96bb742c183196219b93b7efe055b19ba2e0fdf46bf6ea501e608784375895cb51f0924cbc6762dec9

data/LICENSE.txt

@@ -0,0 +1,202 @@
+                                 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 2018 University of Houston
+   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/README.md

@@ -0,0 +1,48 @@
+# HyBridge
+
+HyBridge is a ruby gem to ingest a batch of digital objects into the Samvera [Hyku](https://github.com/samvera-labs/hyku) application.
+
+Part of the [Bridge2Hyku](https://bridge2hyku.github.io/) project.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hybridge', git: 'https://github.com/Bridge2Hyku/hybridge'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install hybridge
+
+Finally:
+
+    $ rails g hybridge:install
+
+### Hyku Settings
+
+Add the following to your Hyku settings file in `config/settings.yml` or `config/settings/<environment>.yml`
+
+```ruby
+hybridge:
+  filesystem: /path/to/ingest/packages
+```
+
+The HyBridge filesystem is the location where ingest packages will be stored for use in HyBridge. Create directories in the HyBridge filesystem location for every Multi tenant domain/repository installed using the repositories CNAME. Example: `/path/to/ingest/packages/myrepository.example.com`
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+TODO: Write development processes here
+
+## License
+
+**[Apache-2.0](LICENSE)**

data/Rakefile

@@ -0,0 +1,36 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Hybridge'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/config/hybridge_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/hybridge .js
+//= link_directory ../stylesheets/hybridge .css

data/app/assets/javascripts/hybridge/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/javascripts/hybridge/ingest.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/hybridge/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/hybridge/ingest.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/hybridge/application_controller.rb

@@ -0,0 +1,5 @@
+module Hybridge
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/hybridge/ingest_controller.rb

@@ -0,0 +1,95 @@
+require_dependency "hybridge/application_controller"
+
+module Hybridge
+  class IngestController < Hyrax::MyController
+    include Hyrax::Breadcrumbs
+    before_action :set_current_account, :authenticate_user!
+    skip_before_action :require_active_account!
+
+    delegate :title, :id, to: :solr_document
+
+    def index
+      add_breadcrumbs
+      @packages = packages('csv')
+      @processing = packages('processing', true)
+      @processed = packages('processed', true)
+      @collections = collections
+    end
+
+    def perform
+      if params[:package_id].nil?
+        flash[:error] = "Unable to find selected file in source directory. Please contact your System Administrator"
+      else
+        params[:package_id].each do | package |
+          package_location = staged!(File.join(location, package))
+          next if package_location.nil?
+          collection_id = params[:collection_id][package]
+          Hybridge::IngestPackageJob.perform_later(package_location, collection_id, current_user)
+        end
+        flash[:notice] = "Successfully started the ingest process. This can take awhile"
+      end
+      redirect_to hybridge.root_path
+    end
+
+    private
+    
+    def add_breadcrumbs
+      add_breadcrumb t(:'hyrax.controls.home'), main_app.root_path
+      add_breadcrumb t(:'hyrax.dashboard.breadcrumbs.admin'), hyrax.dashboard_path
+      add_breadcrumb t(:'hybridge.admin.sidebar.ingest'), hybridge.root_path
+    end
+
+    def set_current_account
+      @account = Site.account rescue nil
+    end
+
+    def location
+      if @account.nil?
+        Settings.hybridge.filesystem
+      else
+        File.join(Settings.hybridge.filesystem, @account.cname)
+      end
+    end
+
+    def packages(ext, hideext=false)
+      files = Dir.glob(location + "/**/*.#{ext}")
+      base_path = Pathname.new(location)
+      files = files.collect do |file|
+        path = Pathname.new(file).relative_path_from(base_path)
+        if hideext
+          path = "#{File.dirname(path)}/#{File.basename(path, ".#{ext}")}"
+        end
+        path
+      end
+    end
+
+    def staged!(filename)
+      if !File.file?(filename)
+        flash[:error] = "Unable to find #{package}. Please contact your System Administrator for assistance"
+        return nil
+      end
+      new_filename = filename + '.staged'
+      File.rename(filename, new_filename)
+      new_filename
+    end
+
+    def collections
+      colls = []
+      response = self.repository.search(collection_search_builder)
+      response.docs.each do |document|
+        colls << {
+          id: document.id,
+          title: document.title.first || document.title
+        }
+      end
+      colls
+    end
+
+    private
+
+      def collection_search_builder
+        Hyrax::CollectionSearchBuilder.new(self).rows(1000).with_access(:edit)
+      end
+
+  end
+end

data/app/helpers/hybridge/application_helper.rb

@@ -0,0 +1,4 @@
+module Hybridge
+  module ApplicationHelper
+  end
+end

data/app/helpers/hybridge/ingest_helper.rb

@@ -0,0 +1,4 @@
+module Hybridge
+  module IngestHelper
+  end
+end

data/app/jobs/hybridge/application_job.rb

@@ -0,0 +1,4 @@
+module Hybridge
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/jobs/hybridge/ingest_package_job.rb

@@ -0,0 +1,10 @@
+require 'hybridge/batch'
+module Hybridge
+  class IngestPackageJob < ApplicationJob
+    queue_as Hyrax.config.ingest_queue_name
+
+    def perform(package_location, collection_id, current_user)
+      Hybridge::Batch::Ingest.new(package_location, collection_id, current_user)
+    end
+  end
+end

data/app/mailers/hybridge/application_mailer.rb

@@ -0,0 +1,6 @@
+module Hybridge
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/hybridge/application_record.rb

@@ -0,0 +1,5 @@
+module Hybridge
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/hybridge/ingest/index.html.erb

@@ -0,0 +1,90 @@
+<%= form_tag hybridge.perform_path do %>
+<div class="col-xs-12 main-header">
+  <h1><span class="fa fa-magic"></span> HyBridge Ingest</h1>
+  <div class="pull-right">
+    <%= button_tag("Ingest Selected", type: "submit", class: "btn btn-large btn-primary") %>
+  </div>
+</div>
+<div class="row">
+  <div class="col-md-12">
+    <div class="panel panel-default">
+      <div class="panel-heading">
+        <h2 class="panel-title h2">Ready</h2>
+        <span>Select csv packages to ingest</span>
+      </div>
+      <div class="panel-body">
+        <table class="table table-condensed">
+          <thead>
+            <th scope="col">Select</th>
+            <th scope="col">Filename</th>
+            <th scope="col" class="text-right">Collection</th>
+          </thead>
+          <tbody>
+            <% @packages.each do |package| %>
+              <tr>
+                <td class="col-md-1">
+                  <label for="package_id_">
+                    <%= check_box_tag 'package_id[]', package %>
+                  </label>
+                </td>
+                <td class="col-md-7"><%= package %></td>
+                <td class="col-md-4 text-right">
+                  <label for="collection_id">
+                    <%= select_tag "collection_id[#{package}]", options_for_select(@collections.collect {|c| [ c[:title], c[:id] ] }), {:include_blank => '', :class => 'form-control select optional'} %>
+                  </label>
+                </td>
+              </tr>
+            <% end %>
+          </tbody>
+        </table>
+      </div>
+    </div>
+  </div>
+</div>
+<% end %>
+<div class="row">
+  <div class="col-md-12">
+    <div class="panel panel-default">
+      <div class="panel-heading">
+        <h2 class="panel-title h2">Processing</h2>
+      </div>
+      <div class="panel-body">
+        <table class="table table-condensed">
+          <thead>
+            <th scope="col">Filename</th>
+          </thead>
+          <tbody>
+            <% @processing.each do |package| %>
+              <tr>
+                <td class="col-md-11"><%= package %></td>
+              </tr>
+            <% end %>
+          </tbody>
+        </table>
+      </div>
+    </div>
+  </div>
+</div>
+<div class="row">
+  <div class="col-md-12">
+    <div class="panel panel-default">
+      <div class="panel-heading">
+        <h2 class="panel-title h2">Complete</h2>
+      </div>
+      <div class="panel-body">
+        <table class="table table-condensed">
+          <thead>
+            <th scope="col">Filename</th>
+          </thead>
+          <tbody>
+            <% @processed.each do |package| %>
+              <tr>
+                <td class="col-md-11"><%= package %></td>
+              </tr>
+            <% end %>
+          </tbody>
+        </table>
+      </div>
+    </div>
+  </div>
+</div>

data/app/views/hybridge/ingest/perform.html.erb

@@ -0,0 +1 @@
+<h1>Processing</h1>

data/app/views/layouts/hybridge/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Hybridge</title>
+  <%= stylesheet_link_tag    "hybridge/application", media: "all" %>
+  <%= javascript_include_tag "hybridge/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/locales/hybridge.en.yml

@@ -0,0 +1,5 @@
+en:
+  hybridge:
+    admin:
+      sidebar:
+        ingest: "HyBridge Ingest"

data/config/routes.rb

@@ -0,0 +1,6 @@
+Hybridge::Engine.routes.draw do
+  get 'ingest/index'
+  match '/perform', to: "ingest#perform", via: :post
+
+  root to: "ingest#index"
+end

data/lib/generators/hybridge/install/install_generator.rb

@@ -0,0 +1,23 @@
+class Hybridge::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  
+  def inject_routes
+    insert_into_file "config/routes.rb", after: ".draw do" do
+      %(\n  mount Hybridge::Engine => '/hybridge'\n)
+    end
+  end
+
+  def inject_dashboard_link
+    file_path = "app/views/hyrax/dashboard/_sidebar.html.erb"
+    if File.file?(file_path)
+      insert_into_file file_path, after: /menu\.nav_link\(hyrax\.my_works_path.*?<% end %>/m do
+        "\n\n  <%= menu.nav_link(hybridge.root_path,\n" \
+        "                        also_active_for: hyrax.dashboard_works_path) do %>\n" \
+        "    <span class=\"fa fa-magic\"></span> <span class=\"sidebar-action-text\"><%= t('hybridge.admin.sidebar.ingest') %></span>\n" \
+        "  <% end %>\n"
+      end
+    end
+    copy_file "sidebar/_repository_content.html.erb", "app/views/hyrax/dashboard/sidebar/_repository_content.html.erb"
+  end
+
+end

data/lib/generators/hybridge/install/templates/sidebar/_repository_content.html.erb

@@ -0,0 +1,16 @@
+<li class="h5"><%= t('hyrax.admin.sidebar.repository_objects') %></li>
+
+<%= menu.nav_link(hyrax.my_collections_path,
+                  also_active_for: hyrax.dashboard_collections_path) do %>
+  <span class="fa fa-folder-open" aria-hidden="true"></span> <span class="sidebar-action-text"><%= t('hyrax.admin.sidebar.collections') %></span>
+<% end %>
+
+<%= menu.nav_link(hyrax.my_works_path,
+                  also_active_for: hyrax.dashboard_works_path) do %>
+  <span class="fa fa-file" aria-hidden="true"></span> <span class="sidebar-action-text"><%= t('hyrax.admin.sidebar.works') %></span>
+<% end %>
+
+<%= menu.nav_link(hybridge.root_path,
+                  also_active_for: hyrax.dashboard_works_path) do %>
+  <span class="fa fa-magic"></span> <span class="sidebar-action-text"><%= t('hybridge.admin.sidebar.ingest') %></span>
+<% end %>

data/lib/hybridge.rb

@@ -0,0 +1,5 @@
+require "hybridge/engine"
+
+module Hybridge
+  # Your code goes here...
+end

data/lib/hybridge/batch.rb

@@ -0,0 +1,8 @@
+require 'hybridge/batch/ingest'
+require 'hybridge/batch/entry'
+
+module Hybridge
+  module Batch
+    class Error < ::Exception; end
+  end
+end

data/lib/hybridge/batch/entry.rb

@@ -0,0 +1,107 @@
+module Hybridge
+  module Batch
+    class Entry
+
+      def initialize(work, files, collection_id, current_user, package_location)
+        @work = work
+        @files = files
+        @collection_id = collection_id
+        @current_user = current_user
+        @package_location = package_location
+
+        process!
+      end
+
+      def process!
+        work_type = @work["Object Type"].constantize.new
+        work_form = ("Hyrax::" + @work["Object Type"] + "Form").constantize
+
+        work_attributes = field_attributes(work_form, work_type)
+
+        missing = work_form.required_fields - work_attributes.keys
+        if !missing.empty?
+          message = "Missing required fields: #{missing.map{|m| m.to_s.inspect}.join(', ')} for '#{work_attributes[:title].first}'"
+          Hyrax::MessengerService.deliver(User.batch_user, @current_user, message, "HyBridge Warning: Missing required fields")
+        end
+
+        env = Hyrax::Actors::Environment.new(work_type, Ability.new(@current_user), work_attributes)
+        work_actor = Hyrax::CurationConcern.actor.create(env)
+
+        process_files! work_type unless @files.nil?
+      end
+
+      def field_attributes(work_form, work_type)
+        data = {}
+        @work.each do |key, attribute|
+          field_sym = field_to_sym(key)
+          if (field_sym.nil? || attribute.nil? || attribute.empty? || key.to_s.include?("Object Type") || !work_form.terms.include?(field_sym))
+            next
+          elsif(field_sym.id2name == "based_near")
+            data[:based_near_attributes] = based_near_attributes(attribute.split("; "))
+          elsif(field_sym.id2name == "rights_statement")
+            active = Hyrax.config.rights_statement_service_class.new.active?(attribute) rescue false
+            if active
+              data[field_sym] = attribute
+            else
+              message = "Invalid/Inactive Rights Statement URL '#{attribute}' for '#{data[:title].first.to_s}'"
+              Hyrax::MessengerService.deliver(User.batch_user, @current_user, message, "HyBridge Warning: Invalid/Inactive Rights Statement URL")
+            end
+          elsif(work_type.send(field_sym).nil?)
+            data[field_sym] = attribute
+          else
+            data[field_sym] = attribute.split "; "
+          end
+
+          if !@collection_id.nil? && !@collection_id.empty?
+            data[:member_of_collections_attributes] = {"0" => { "id" => @collection_id, "_destroy" => "false" }}
+          end
+          
+        end
+        data
+      end
+
+      def based_near_attributes(values)
+        based_near_values = {}
+        values.each_with_index do |value, index|
+          based_near_values[index.to_s] = { "id" => value, "_destroy" => "" }
+        end
+        based_near_values
+      end
+
+      def file_location(filename)
+        File.join(@package_location, filename)
+      end
+
+      def process_files!(work_type)
+        work_permissions = work_type.permissions.map(&:to_hash)
+        @files.each do |file_object|
+          file_path = file_location(file_object["Filename"])
+          if !File.file?(file_path)
+            message = "Unable to find file '#{file_object["Filename"]}' for '#{work_type[:title].first.to_s}'"
+            Hyrax::MessengerService.deliver(User.batch_user, @current_user, message, "HyBridge Warning: Missing file")
+            next
+          end
+
+          file_actor = Hyrax::Actors::FileSetActor.new(FileSet.create, @current_user)
+          file_actor.create_metadata
+          file_actor.create_content(File.new(file_path))
+          file_actor.attach_to_work(work_type)
+          file_actor.file_set.permissions_attributes = work_permissions
+        end
+      end
+
+      def field_to_sym(field)
+        if field.downcase == "abstract or summary"
+          field = "description"
+        elsif field.downcase == "abstract / summary"
+          field = "description"
+        elsif field.downcase == "location"
+          field = "based_near"
+        end
+
+        field.downcase.strip.gsub(/\s/,'_').to_sym
+      end
+
+    end
+  end
+end

data/lib/hybridge/batch/ingest.rb

@@ -0,0 +1,76 @@
+module Hybridge
+  module Batch
+    class Ingest
+
+      def initialize(file, collection_id, current_user)
+        @file = file
+        @collection_id = collection_id
+        @current_user = current_user
+        load!
+      end
+
+      def load!
+
+        return unless staged? || processing?
+
+        processing!
+        @works = []
+        @files = {}
+        good_work = false
+
+        @csv = CSV.parse(File.read(@file), headers: true, encoding: 'utf-8').map(&:to_hash)
+        @csv.each do |row|
+          type = row.first.last
+          if type.nil?
+            good_work = false
+            next
+          elsif Hyrax.config.registered_curation_concern_types.include? type
+            good_work = true
+            row.delete("Filename")
+            @works << row
+            @files[@works.length] = []
+          elsif type.include? "File"
+            if good_work
+              row.delete("Object Type")
+              @files[@works.length] << row
+            end
+          else
+            good_work = false
+            message = "Unknown work type '#{type}'"
+            Hyrax::MessengerService.deliver(User.batch_user, @current_user, message, "HyBridge Warning: Unknown work type")
+          end
+        end
+
+        @works.each_with_index do |work, index|
+          Entry.new(work, @files[index+1], @collection_id, @current_user, File.dirname(@file))
+        end
+        processed!
+      end
+
+      def processing!
+        new_file = Pathname(@file).sub_ext '' + ".processing"
+        File.rename(@file, new_file) unless File.file?(new_file)
+        @file = new_file
+      end
+
+      def processed!
+        new_file = Pathname(@file).sub_ext '' + ".processed"
+        File.rename(@file, new_file)
+        @file = new_file
+      end
+
+      def processing?
+        File.file?(Pathname(@file).sub_ext '' + ".processing")
+      end
+
+      def processed?
+        File.file?(Pathname(@file).sub_ext '' + ".processed")
+      end
+
+      def staged?
+        File.file?(Pathname(@file).sub_ext '' + ".staged")
+      end
+
+    end
+  end
+end

data/lib/hybridge/engine.rb

@@ -0,0 +1,5 @@
+module Hybridge
+  class Engine < ::Rails::Engine
+    isolate_namespace Hybridge
+  end
+end

data/lib/hybridge/version.rb

@@ -0,0 +1,3 @@
+module Hybridge
+  VERSION = '1.0.0'
+end

data/lib/tasks/hybridge_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :hybridge do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: hybridge
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Leroy Vallejo
+- Sean Watkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: An ingest tool for Samvera Hyku and Hyrax repositories.
+email:
+- llvallejo@uh.edu
+- slwatkins@uh.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/config/hybridge_manifest.js
+- app/assets/javascripts/hybridge/application.js
+- app/assets/javascripts/hybridge/ingest.js
+- app/assets/stylesheets/hybridge/application.css
+- app/assets/stylesheets/hybridge/ingest.css
+- app/controllers/hybridge/application_controller.rb
+- app/controllers/hybridge/ingest_controller.rb
+- app/helpers/hybridge/application_helper.rb
+- app/helpers/hybridge/ingest_helper.rb
+- app/jobs/hybridge/application_job.rb
+- app/jobs/hybridge/ingest_package_job.rb
+- app/mailers/hybridge/application_mailer.rb
+- app/models/hybridge/application_record.rb
+- app/views/hybridge/ingest/index.html.erb
+- app/views/hybridge/ingest/perform.html.erb
+- app/views/layouts/hybridge/application.html.erb
+- config/locales/hybridge.en.yml
+- config/routes.rb
+- lib/generators/hybridge/install/install_generator.rb
+- lib/generators/hybridge/install/templates/sidebar/_repository_content.html.erb
+- lib/hybridge.rb
+- lib/hybridge/batch.rb
+- lib/hybridge/batch/entry.rb
+- lib/hybridge/batch/ingest.rb
+- lib/hybridge/engine.rb
+- lib/hybridge/version.rb
+- lib/tasks/hybridge_tasks.rake
+homepage: https://github.com/Bridge2Hyku/HyBridge
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.1
+signing_key: 
+specification_version: 4
+summary: HyBridge is a ingest tool for use in Samvera Hyku and Hyrax repositories.
+test_files: []