fcrepo_admin 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzVjNjI2ZGM3M2YxMDVhZjU4MjBlZTU2OWY0NjYzMTlmNjBlZWI5ZQ==
+  data.tar.gz: !binary |-
+    ZjIxN2E2MGZkYjgzZTZlNDkxY2U2MmE0Mzk1MDEzODhlZDFhMjkyMw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NjgzYWExYWEyOWM1NzA5N2EwN2FkMjE3YzJmMTY2NjU2MDBiNTRiNTk3NTY0
+    NzBlNzVhOTIxNmFiN2ViOTY3ZmJmNmViNzgzNWIwMjZmZTBmODc5YzQ2MjJh
+    YjkyYjE3YzczZjk3YjFlMjgxYTZkOWMxMDE0MTBlYTI3N2Q2ZjM=
+  data.tar.gz: !binary |-
+    YThhYWMzZjU5MjhjZjk3NjMyYmZlMWJkZTIzYTJmODdkYzZhZDFiYzUwMjZl
+    N2I3NTQyYmM3ZjQ5MDc0ODg1ODY0MzEzNTE5ZDQxODhmYTY4MmZlYzA0MTZj
+    NTg0NjhmMTg5YWM0NGJkZWM5NzM5YmNlMTc2NmE0MDk1ZDJkMjc=

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle
+Gemfile.lock
+pkg
+spec/internal/db/*.sqlite3
+spec/internal/log/*.log
+spec/internal/jetty
+spec/internal/tmp
+spec/internal/.sass-cache
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'devise'

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) Duke University.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    1. Redistributions of source code must retain the above copyright notice,
+       this list of conditions and the following disclaimer.
+
+    2. Redistributions in binary form must reproduce the above copyright notice,
+       this list of conditions and the following disclaimer in the documentation
+       and/or other materials provided with the distribution.
+
+    3. Neither the name of Duke University nor the names of its contributors may
+       be used to endorse or promote products derived from this software without
+       specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.rdoc

@@ -0,0 +1,75 @@
+== Hydra Administrative Tool for a Fedora Repository
+
+A Rails engine providing an administrative interface to a Fedora Commons repository built on the Hydra project framework.
+
+=== Status
+
+This project is at an early stage of development.  It should be considered experimental and not ready for production deployment.
+
+=== Requirements
+
+fcrepo_admin is designed for installation on hydra-head 6.0.0 or higher.  
+See https://github.com/projecthydra/hydra-head/wiki/Installation-Prerequisites.
+
+=== Installation
+
+(In the future, we hope to automate some of these tasks with a generator.)
+
+* Add to gemfile
+
+    gem 'fcrepo_admin'
+
+  Then <code>bundle install</code>
+
+* Run the Blacklight and Hydra generators (if this is a new Rails app, not an existing Hydra head)
+
+    rails g blacklight --devise
+    rails g hydra:head -f
+    rake db:migrate
+    rails g hydra:jetty  # if you need a development copy of jetty with solr and fedora
+
+* Mount the engine
+
+  In config/routes.rb add this line:
+
+    mount FcrepoAdmin::Engine => '/admin', :as=> 'fcrepo_admin'
+
+  You may replace <code>'/admin'</code> with any mount point (except perhaps <code>'/catalog'</code>), 
+  including <code>'/'</code>. All routes include <code>objects</code> as a subpath.
+
+* Extend the SolrDocument model
+  
+  In app/models/solr_document.rb add this line:
+
+    use_extension FcrepoAdmin::SolrDocumentExtension
+
+  (This may only be necessary if customizing the catalog show page as indicated below.)
+
+* Add Javascript
+  
+  In app/assets/javascripts/application.js add this line: 
+
+    //= require bootstrap-tab
+
+* Add CSS
+
+  In app/assets/stylesheets/application.css add this line:
+
+    //= require fcrepo_admin/fcrepo_admin
+
+* Customize catalog show page (optional)
+
+  If you would like to add Fedora object information to the catalog show page, 
+  copy the partial <code>app/views/catalog/_show_default.html.erb</code> from the Blacklight 
+  gem to your application, then add to the bottom of the file:
+
+    <%= render :partial => 'fcrepo_admin/catalog/show', :locals => {:document => document} %>
+
+  Use Blacklight's config options in CatalogController to control the basic content on the show page 
+  (HTML title, page title, and list of the fields/values at the top of the page).
+
+=== License
+
+See the LICENSE file in the root directory of the project for copyright and license information.
+
+Licenses for code copied from other projects will be included in source files as required.

data/Rakefile

@@ -0,0 +1,22 @@
+#!/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/internal/Rakefile", __FILE__)
+load 'rails/tasks/engine.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

data/app/controllers/fcrepo_admin/audit_trail_controller.rb

@@ -0,0 +1,17 @@
+module FcrepoAdmin
+  class AuditTrailController < ApplicationController
+
+    include FcrepoAdmin::ControllerBehavior
+
+    before_filter :load_and_authz_object
+  
+    def index
+      # XXX Update when new version of ActiveFedora released
+      @audit_trail = @object.respond_to?(:audit_trail) ? @object.audit_trail : @object.inner_object.audit_trail
+      if params[:download]
+        send_data @audit_trail.to_xml, :disposition => 'inline', :type => 'text/xml'
+      end
+    end
+  
+  end
+end

data/app/controllers/fcrepo_admin/datastreams_controller.rb

@@ -0,0 +1,29 @@
+require 'mime/types'
+
+module FcrepoAdmin
+  class DatastreamsController < ApplicationController
+    
+    include FcrepoAdmin::ControllerBehavior
+
+    TEXT_MIME_TYPES = ['application/xml', 'application/rdf+xml', 'application/json']
+
+    before_filter :load_and_authz_object
+
+    def index
+      # @object loaded and authz'd by before_filter
+    end
+  
+    def show
+      @datastream = @object.datastreams[params[:id]]
+      @inline = @datastream.mimeType.start_with?('text/') || TEXT_MIME_TYPES.include?(@datastream.mimeType)
+    end
+
+    def download
+      @datastream = @object.datastreams[params[:id]]
+      mimetypes = MIME::Types[@datastream.mimeType]
+      send_data @datastream.content, :disposition => 'attachment', :type => @datastream.mimeType, :filename => "#{@datastream.pid.sub(/:/, '_')}_#{@datastream.dsid}.#{mimetypes.first.extensions.first}"        
+    end
+
+  end
+end
+

data/app/controllers/fcrepo_admin/objects_controller.rb

@@ -0,0 +1,14 @@
+module FcrepoAdmin
+  class ObjectsController < ApplicationController
+    
+    PROPERTIES = [:owner_id, :state, :create_date, :modified_date, :label]
+
+    def show
+      @object = ActiveFedora::Base.find(params[:id], :cast => true)
+      authorize! :read, @object
+      @properties = {}
+      PROPERTIES.each { |p| @properties[p] = @object.send(p) }
+    end
+
+  end
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/app/views/fcrepo_admin/audit_trail/index.html.erb

@@ -0,0 +1,34 @@
+<h1><%= @object.pid %></h1>
+
+<h3><%= t("fcrepo_admin.audit_trail.title") %></h3>
+
+<p>
+	<%= link_to t("fcrepo_admin.audit_trail.download"), "#{fcrepo_admin.object_audit_trail_index_path(@object)}?download=true", :class => "btn btn-primary" %>
+</p>
+
+<table class="table table-bordered table-condensed table-striped">
+	<thead>
+		<tr>
+			<th scope="col"><%= t("fcrepo_admin.audit_trail.record.id") %></th>
+			<th scope="col"><%= t("fcrepo_admin.audit_trail.record.process_type") %></th>
+			<th scope="col"><%= t("fcrepo_admin.audit_trail.record.action") %></th>
+			<th scope="col"><%= t("fcrepo_admin.audit_trail.record.component_id") %></th>
+			<th scope="col"><%= t("fcrepo_admin.audit_trail.record.responsibility") %></th>
+			<th scope="col"><%= t("fcrepo_admin.audit_trail.record.date") %></th>
+			<th scope="col"><%= t("fcrepo_admin.audit_trail.record.justification") %></th>
+		</tr>
+	</thead>
+	<tbody>
+		<% @audit_trail.records.each do |record| %>
+		<tr>
+			<td><%= record.id %></td>
+			<td><%= record.process_type %></td>
+			<td><%= record.action %></td>
+			<td><%= record.component_id %></td>
+			<td><%= record.responsibility %></td>
+			<td><%= record.date %></td>
+			<td><%= record.justification %></td>
+		</tr>
+		<% end %>
+	</tbody>
+</table>

data/app/views/fcrepo_admin/catalog/_datastreams.html.erb

@@ -0,0 +1,19 @@
+<h3><%= t("fcrepo_admin.datastream.title").pluralize %></h3>
+<table class="table table-bordered table-condensed">
+  <thead>
+    <tr>
+	  <th scope="col"><%= t("fcrepo_admin.datastream.id") %></th>
+	  <th scope="col"><%= t("fcrepo_admin.datastream.label") %></th>
+	  <th scope="col"><%= t("fcrepo_admin.datastream.mimetype") %></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% datastreams.reject { |dsid, dsProfile| dsProfile.empty? }.each do |dsid, dsProfile| %>
+    <tr>
+	  <td><%= link_to dsid, fcrepo_admin.object_datastream_path(pid, dsid) %></td>
+	  <td><%= dsProfile["dsLabel"] %></td>
+	  <td><%= dsProfile["dsMIME"] %></td>
+    </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/fcrepo_admin/catalog/_show.html.erb

@@ -0,0 +1,2 @@
+<%= render :partial => 'fcrepo_admin/catalog/datastreams', :locals => {:datastreams => document.datastreams, :pid => document.id} %>
+<%= render :partial => 'fcrepo_admin/objects/more_info', :locals => {:pid => document.id} %>

data/app/views/fcrepo_admin/datastreams/_content.html.erb

@@ -0,0 +1,12 @@
+<div id="fcrepo-admin-dscontent">
+<% if inline %>
+  <pre class="prettyprint pre-scrollable"><%= datastream.content %></pre>
+<% else %>
+  <p>
+    <%= t("fcrepo_admin.datastream.content_not_text") %>.
+  </p>
+<% end %>
+  <p>
+    <%= link_to t("fcrepo_admin.datastream.download"), fcrepo_admin.download_object_datastream_path(datastream.pid, datastream.dsid), :class => "btn btn-primary" %>
+  </p>
+</div>

data/app/views/fcrepo_admin/datastreams/_datastreams.html

@@ -0,0 +1,18 @@
+<table class="table table-bordered table-condensed">
+  <thead>
+    <tr>
+	  <th scope="col"><%= t("fcrepo_admin.datastreams.header.id") %></th>
+	  <th scope="col"><%= t("fcrepo_admin.datastreams.header.label") %></th>
+	  <th scope="col"><%= t("fcrepo_admin.datastreams.header.mimetype") %></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% datastreams.reject { |dsid, ds| ds.profile.empty? }.each do |dsid, ds| %>
+    <tr>
+	  <td><%= link_to dsid, fcrepo_admin.object_datastream_path(ds.pid, dsid) %></td>
+	  <td><%= ds.profile["dsLabel"] %></td>
+	  <td><%= ds.profile["dsMIME"] %></td>
+    </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/fcrepo_admin/datastreams/_profile.html.erb

@@ -0,0 +1,10 @@
+<div id="fcrepo-admin-dsprofile">
+  <table class="table table-bordered table-condensed table-striped">
+	<% datastream.profile.each do |key, value| %>
+	<tr>
+	  <th scope="row"><%= t("fcrepo_admin.datastream.profile.#{key}") %></th>
+	  <td><%= value.blank? ? " " : value %></td>
+	</tr>
+	<% end %>
+  </table>
+</div>

data/app/views/fcrepo_admin/datastreams/index.html.erb

@@ -0,0 +1,4 @@
+<h1><%= @object.pid %></h1>
+
+<h3><%= t("fcrepo_admin.datastreams.title") %></h3>
+<%= render :partial => 'datastreams', :locals => {:datastreams => @object.datastreams} %>

data/app/views/fcrepo_admin/datastreams/show.html.erb

@@ -0,0 +1,22 @@
+<h1><%= @datastream.pid %></h1>
+
+<h3><%= t("fcrepo_admin.datastream.title") %>: <%= @datastream.dsid %></h3>
+
+<div class="document">
+
+  <div class="tabbable">
+    <ul class="nav nav-tabs">
+      <li class="active"><a href="#tab1" data-toggle="tab"><%= t("fcrepo_admin.datastream.tabs.content") %></a></li>
+      <li><a href="#tab2" data-toggle="tab"><%= t("fcrepo_admin.datastream.tabs.profile") %></a></li>
+    </ul>
+    <div class="tab-content">
+      <div class="tab-pane active" id="tab1">
+		<%= render :partial => 'content', :locals => {:datastream => @datastream, :inline => @inline} %>
+      </div>
+      <div class="tab-pane" id="tab2">
+		<%= render :partial => 'profile', :locals => {:datastream => @datastream} %>
+      </div>
+    </div>
+  </div>
+
+</div>

data/app/views/fcrepo_admin/objects/_more_info.html.erb

@@ -0,0 +1,6 @@
+<h3><%= t("fcrepo_admin.object.more_info") %></h3>
+<ul>
+  <li>
+    <%= link_to t("fcrepo_admin.audit_trail.title"), fcrepo_admin.object_audit_trail_index_path(pid) %>
+  </li>
+</ul>

data/app/views/fcrepo_admin/objects/_properties.html.erb

@@ -0,0 +1,8 @@
+<table class="table table-bordered table-condensed">
+  <% properties.each do |key, value| %>
+    <tr>
+	  <th scope="row"><%= t("fcrepo_admin.object.properties.keys.#{key}") %></th>
+	  <td><%= value %></td>
+    </tr>
+  <% end %>
+</table>

data/app/views/fcrepo_admin/objects/show.html.erb

@@ -0,0 +1,18 @@
+<h1><%= @object.pid %></h1>
+
+<div class="tabbable">
+  <ul class="nav nav-tabs">
+    <li class="active"><a href="#tab1" data-toggle="tab"><%= t("fcrepo_admin.object.tabs.datastreams") %></a></li>
+    <li><a href="#tab2" data-toggle="tab"><%= t("fcrepo_admin.object.tabs.properties") %></a></li>
+  </ul>
+  <div class="tab-content">
+    <div class="tab-pane active" id="tab1">
+	  <%= render :partial => 'fcrepo_admin/datastreams/datastreams', :locals => {:datastreams => @object.datastreams} %>
+    </div>
+    <div class="tab-pane" id="tab2">
+	  <%= render :partial => 'properties', :locals => {:properties => @properties} %>
+    </div>
+  </div>
+</div>
+
+<%= render :partial => 'more_info', :locals => {:pid => @object.pid} %>

data/config/locales/fcrepo_admin.en.yml

@@ -0,0 +1,55 @@
+en:
+  fcrepo_admin:
+    object:
+      more_info: 'More Information'
+      tabs:
+        datastreams: 'Datastreams'
+        properties: 'Properties'
+      properties:
+        title: 'Properties'
+        keys:
+          owner_id: 'Owner ID'
+          state: 'State'
+          create_date: 'Create Date'
+          modified_date: 'Modified Date'
+          label: 'Label'
+    audit_trail: 
+      title: 'Audit Trail'
+      download: 'Download'
+      record:
+        id: 'Record ID'
+        process_type: 'Process Type'
+        action: 'Action'
+        component_id: 'Component ID'
+        responsibility: 'Responsibility'
+        date: 'Date'
+        justification: 'Justification'
+    datastreams:
+      title: 'Datastreams'
+      header:
+        id: 'Datastream ID'
+        label: 'Label'
+        mimetype: 'MIME Type'
+    datastream:
+      title: 'Datastream'
+      tabs:
+        content: 'Content'
+        profile: 'Profile'
+      download: 'Download'
+      content_not_text: 'The datastream content is not text'
+      profile:
+        dsLabel: 'Label'
+        dsMIME: 'MIME Type'
+        dsVersionID: 'Version'
+        dsCreateDate: 'Create Date'
+        dsState: 'State'
+        dsFormatURI: 'Format URI'
+        dsControlGroup: 'Control Group'
+        dsSize: 'Size'
+        dsVersionable: 'Versionable'
+        dsInfoType: 'Info Type'
+        dsLocation: 'Location'
+        dsLocationType: 'Location Type'
+        dsChecksumType: 'Checksum Type'
+        dsChecksum: 'Checksum'
+