hydra_mediated 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36156e09a192907d270903fb979a2bbe965538f7
+  data.tar.gz: 5592c88347dd12c9c2450aa9c02119db270a02e6
+SHA512:
+  metadata.gz: 0b876c609fd4b828114f5a847008832cb7c6e0e8c642107bf464b6d28f7a779fee9acc424a0ca1c032071d4993d7e16653c41d1a55b19e9bf8991414565bcdd1
+  data.tar.gz: 79970140e57d5c581b3d8562a99f224a70b950ea31c072c3b6e0d2ddff7381acdbbaf41971befdb58678d65b05b5a4011dba0b54baa6c84c08c0d8ba3703500f

data/.gitignore

@@ -0,0 +1,18 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp
+
+jetty
+Gemfile.lock

data/.rspec

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

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+# Please see sufia.gemspec for dependency information.
+gemspec
+
+# Required for doing pagination inside an engine. See https://github.com/amatsuda/kaminari/pull/322
+gem 'kaminari', github: 'harai/kaminari', branch: 'route_prefix_prototype'

data/HYDRA_MEDIATED_VERSION

@@ -0,0 +1 @@
+0.0.1

data/README.md

@@ -0,0 +1,36 @@
+# Goals
+* Prototype an ingest workflow that is potentially useful to several institutions
+* Demonstrate how to rely on sufia-models when creating a new gem
+* Prove (test) the usefulness of sufia-models
+* Use hydra-collections when dealing with sets of object
+* How to use hydra-editor for using metadata
+* Extracting the multi-file upload from sufia
+
+# Setup
+
+in your Gemfile add:
+
+```ruby
+  gem 'hydra_mediated'
+```
+
+```
+rails g blacklight --devise
+rails g hydra:head -f
+rake db:migrate
+
+Add to config/routes.rb before the blacklight routes:
+```ruby
+mount HydraMediated::Engine => '/'
+```
+
+# if you are using rails 3
+```
+rm public/index.html
+```
+
+# if you are using rails 4 pin to a compatible branch of sufia-models
+in the gemfile add
+```ruby
+ gem 'sufia-models', github: 'projecthydra/sufia', branch: 'rails4'
+```

data/Rakefile

@@ -0,0 +1,5 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+#
+require "bundler/gem_tasks"

data/app/assets/javascripts/application.js

@@ -0,0 +1,17 @@
+// 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 vendor/assets/javascripts of plugins, if any, 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
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//
+//= require blacklight/blacklight
+//= require hydra-editor/hydra-editor

data/app/assets/javascripts/items.js.coffee

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/

data/app/assets/stylesheets/application.css

@@ -0,0 +1,14 @@
+/*
+ * 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 vendor/assets/stylesheets of plugins, if any, 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require blacklight
+ *= require hydra-editor/hydra-editor 
+ */

data/app/assets/stylesheets/blacklight.css.scss

@@ -0,0 +1,4 @@
+@import 'bootstrap';
+@import 'bootstrap-responsive';
+
+@import 'blacklight/blacklight';

data/app/assets/stylesheets/items.css.scss

@@ -0,0 +1,3 @@
+// Place all the styles related to the items controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/

data/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+class ApplicationController < ActionController::Base
+  # Adds a few additional behaviors into the application controller 
+   include Blacklight::Controller
+  # Please be sure to impelement current_user and user_session. Blacklight depends on 
+  # these methods in order to perform user specific actions. 
+
+  layout 'blacklight'
+
+  protect_from_forgery
+end

data/app/controllers/catalog_controller.rb

@@ -0,0 +1,165 @@
+# -*- encoding : utf-8 -*-
+require 'blacklight/catalog'
+
+class CatalogController < ApplicationController  
+
+  include Blacklight::Catalog
+  include Hydra::Controller::ControllerBehavior
+  # These before_filters apply the hydra access controls
+  before_filter :enforce_show_permissions, :only=>:show
+  # This applies appropriate access controls to all solr queries
+  CatalogController.solr_search_params_logic += [:add_access_controls_to_solr_params]
+  # This filters out objects that you want to exclude from search results, like FileAssets
+  CatalogController.solr_search_params_logic += [:exclude_unwanted_models]
+
+
+  configure_blacklight do |config|
+    config.default_solr_params = { 
+      :qt => 'search',
+      :rows => 10 
+    }
+
+    # solr field configuration for search results/index views
+    config.index.show_link = 'title_tesim'
+    config.index.record_display_type = 'has_model_ssim'
+
+    # solr field configuration for document/show views
+    config.show.html_title = 'title_tesim'
+    config.show.heading = 'title_tesim'
+    config.show.display_type = 'has_model_ssim'
+
+    # solr fields that will be treated as facets by the blacklight application
+    #   The ordering of the field names is the order of the display
+    #
+    # Setting a limit will trigger Blacklight's 'more' facet values link.
+    # * If left unset, then all facet values returned by solr will be displayed.
+    # * If set to an integer, then "f.somefield.facet.limit" will be added to
+    # solr request, with actual solr request being +1 your configured limit --
+    # you configure the number of items you actually want _tsimed_ in a page.    
+    # * If set to 'true', then no additional parameters will be sent to solr,
+    # but any 'sniffed' request limit parameters will be used for paging, with
+    # paging at requested limit -1. Can sniff from facet.limit or 
+    # f.specific_field.facet.limit solr request params. This 'true' config
+    # can be used if you set limits in :default_solr_params, or as defaults
+    # on the solr side in the request handler itself. Request handler defaults
+    # sniffing requires solr requests to be made with "echoParams=all", for
+    # app code to actually have it echo'd back to see it.  
+    #
+    # :show may be set to false if you don't want the facet to be drawn in the 
+    # facet bar
+    config.add_facet_field solr_name('object_type', :facetable), :label => 'Format' 
+    config.add_facet_field solr_name('pub_date', :facetable), :label => 'Publication Year' 
+    config.add_facet_field solr_name('subject_topic', :facetable), :label => 'Topic', :limit => 20 
+    config.add_facet_field solr_name('language', :facetable), :label => 'Language', :limit => true 
+    config.add_facet_field solr_name('lc1_letter', :facetable), :label => 'Call Number' 
+    config.add_facet_field solr_name('subject_geo', :facetable), :label => 'Region' 
+    config.add_facet_field solr_name('subject_era', :facetable), :label => 'Era'  
+
+    # Have BL send all facet field names to Solr, which has been the default
+    # previously. Simply remove these lines if you'd rather use Solr request
+    # handler defaults, or have no facets.
+    config.default_solr_params[:'facet.field'] = config.facet_fields.keys
+    #use this instead if you don't want to query facets marked :show=>false
+    #config.default_solr_params[:'facet.field'] = config.facet_fields.select{ |k, v| v[:show] != false}.keys
+
+
+    # solr fields to be displayed in the index (search results) view
+    #   The ordering of the field names is the order of the display 
+    config.add_index_field solr_name('title', :stored_searchable, type: :string), :label => 'Title:' 
+    config.add_index_field solr_name('title_vern', :stored_searchable, type: :string), :label => 'Title:' 
+    config.add_index_field solr_name('author', :stored_searchable, type: :string), :label => 'Author:' 
+    config.add_index_field solr_name('author_vern', :stored_searchable, type: :string), :label => 'Author:' 
+    config.add_index_field solr_name('format', :symbol), :label => 'Format:' 
+    config.add_index_field solr_name('language', :stored_searchable, type: :string), :label => 'Language:'
+    config.add_index_field solr_name('published', :stored_searchable, type: :string), :label => 'Published:'
+    config.add_index_field solr_name('published_vern', :stored_searchable, type: :string), :label => 'Published:'
+    config.add_index_field solr_name('lc_callnum', :stored_searchable, type: :string), :label => 'Call number:'
+
+    # solr fields to be displayed in the show (single result) view
+    #   The ordering of the field names is the order of the display 
+    config.add_show_field solr_name('title', :stored_searchable, type: :string), :label => 'Title:' 
+    config.add_show_field solr_name('title_vern', :stored_searchable, type: :string), :label => 'Title:' 
+    config.add_show_field solr_name('subtitle', :stored_searchable, type: :string), :label => 'Subtitle:' 
+    config.add_show_field solr_name('subtitle_vern', :stored_searchable, type: :string), :label => 'Subtitle:' 
+    config.add_show_field solr_name('author', :stored_searchable, type: :string), :label => 'Author:' 
+    config.add_show_field solr_name('author_vern', :stored_searchable, type: :string), :label => 'Author:' 
+    config.add_show_field solr_name('format', :symbol), :label => 'Format:' 
+    config.add_show_field solr_name('url_fulltext_tsim', :stored_searchable, type: :string), :label => 'URL:'
+    config.add_show_field solr_name('url_suppl_tsim', :stored_searchable, type: :string), :label => 'More Information:'
+    config.add_show_field solr_name('language', :stored_searchable, type: :string), :label => 'Language:'
+    config.add_show_field solr_name('published', :stored_searchable, type: :string), :label => 'Published:'
+    config.add_show_field solr_name('published_vern', :stored_searchable, type: :string), :label => 'Published:'
+    config.add_show_field solr_name('lc_callnum', :stored_searchable, type: :string), :label => 'Call number:'
+    config.add_show_field solr_name('isbn', :stored_searchable, type: :string), :label => 'ISBN:'
+
+    # "fielded" search configuration. Used by pulldown among other places.
+    # For supported keys in hash, see rdoc for Blacklight::SearchFields
+    #
+    # Search fields will inherit the :qt solr request handler from
+    # config[:default_solr_parameters], OR can specify a different one
+    # with a :qt key/value. Below examples inherit, except for subject
+    # that specifies the same :qt as default for our own internal
+    # testing purposes.
+    #
+    # The :key is what will be used to identify this BL search field internally,
+    # as well as in URLs -- so changing it after deployment may break bookmarked
+    # urls.  A display label will be automatically calculated from the :key,
+    # or can be specified manually to be different. 
+
+    # This one uses all the defaults set by the solr request handler. Which
+    # solr request handler? The one set in config[:default_solr_parameters][:qt],
+    # since we aren't specifying it otherwise. 
+    
+    config.add_search_field 'all_fields', :label => 'All Fields'
+    
+
+    # Now we see how to over-ride Solr request handler defaults, in this
+    # case for a BL "search field", which is really a dismax aggregate
+    # of Solr search fields. 
+    
+    config.add_search_field('title') do |field|
+      # :solr_local_parameters will be sent using Solr LocalParams
+      # syntax, as eg {! qf=$title_qf }. This is neccesary to use
+      # Solr parameter de-referencing like $title_qf.
+      # See: http://wiki.apache.org/solr/LocalParams
+      field.solr_local_parameters = { 
+        :qf => '$title_qf',
+        :pf => '$title_pf'
+      }
+    end
+    
+    config.add_search_field('author') do |field|
+      field.solr_local_parameters = { 
+        :qf => '$author_qf',
+        :pf => '$author_pf'
+      }
+    end
+    
+    # Specifying a :qt only to show it's possible, and so our internal automated
+    # tests can test it. In this case it's the same as 
+    # config[:default_solr_parameters][:qt], so isn't actually neccesary. 
+    config.add_search_field('subject') do |field|
+      field.qt = 'search'
+      field.solr_local_parameters = { 
+        :qf => '$subject_qf',
+        :pf => '$subject_pf'
+      }
+    end
+
+    # "sort results by" select (pulldown)
+    # label in pulldown is followed by the name of the SOLR field to sort by and
+    # whether the sort is ascending or descending (it must be asc or desc
+    # except in the relevancy case).
+    config.add_sort_field 'score desc, pub_date_dtsi desc, title_tesi asc', :label => 'relevance'
+    config.add_sort_field 'pub_date_dtsi desc, title_tesi asc', :label => 'year'
+    config.add_sort_field 'author_tesi asc, title_tesi asc', :label => 'author'
+    config.add_sort_field 'title_tesi asc, pub_date_dtsi desc', :label => 'title'
+
+    # If there are more than this many search results, no spelling ("did you 
+    # mean") suggestion is offered.
+    config.spell_max = 5
+  end
+
+
+
+end 

data/app/controllers/items_controller.rb

@@ -0,0 +1,34 @@
+class ItemsController < ApplicationController
+  load_and_authorize_resource only: [:new, :create, :upload, :update, :submit, :done]
+
+  def new
+    if Item.available_resource_types.values.include? params[:resource_type]
+      @item = params[:resource_type].constantize.new
+      @item.initialize_fields
+    else
+      raise "Invalid item type"
+    end
+  end
+
+  def create
+    @item.attributes = params[:item]
+    @item.save!
+    redirect_to mediated.upload_item_path(@item)
+  end
+
+  def upload
+  end
+
+  def update
+    @item.attributes = params[:item]
+    @item.save!
+    redirect_to mediated.submit_item_path(@item)
+  end
+
+  def submit
+  end
+
+  def done
+  end
+
+end

data/app/controllers/submissions_controller.rb

@@ -0,0 +1,7 @@
+class SubmissionsController < ApplicationController
+  before_filter :authenticate_user!
+
+  def new
+  end
+
+end

data/app/helpers/application_helper.rb

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

data/app/helpers/items_helper.rb

@@ -0,0 +1,5 @@
+module ItemsHelper
+  def available_collections
+    { 'Special Collection X' => 123, 'Faculty Pre-prints' => 223, 'Faculty Pre-prints' => 223  }
+  end
+end

data/app/models/ability.rb

@@ -0,0 +1,3 @@
+class Ability
+  include Hydra::Mediated::Ability
+end

data/app/models/ead.rb

@@ -0,0 +1,3 @@
+class EAD < ActiveFedora::Base
+  include Hydra::Mediated::Item
+end

data/app/models/etd.rb

@@ -0,0 +1,3 @@
+class ETD < ActiveFedora::Base
+  include Hydra::Mediated::Item
+end

data/app/models/generic.rb

@@ -0,0 +1,3 @@
+class Generic < ActiveFedora::Base
+  include Hydra::Mediated::Item
+end

data/app/models/generic_file.rb

@@ -0,0 +1,3 @@
+class GenericFile < ActiveFedora::Base
+  include Hydra::Mediated::GenericFile
+end

data/app/models/item.rb

@@ -0,0 +1,4 @@
+class Item < ActiveFedora::Base
+  include Hydra::Mediated::Item
+
+end

data/app/models/solr_document.rb

@@ -0,0 +1,33 @@
+# -*- encoding : utf-8 -*-
+class SolrDocument 
+
+  include Blacklight::Solr::Document
+
+  # self.unique_key = 'id'
+  
+  # The following shows how to setup this blacklight document to display marc documents
+  extension_parameters[:marc_source_field] = :marc_display
+  extension_parameters[:marc_format_type] = :marcxml
+  use_extension( Blacklight::Solr::Document::Marc) do |document|
+    document.key?( :marc_display  )
+  end
+  
+  # Email uses the semantic field mappings below to generate the body of an email.
+  SolrDocument.use_extension( Blacklight::Solr::Document::Email )
+  
+  # SMS uses the semantic field mappings below to generate the body of an SMS email.
+  SolrDocument.use_extension( Blacklight::Solr::Document::Sms )
+
+  # DublinCore uses the semantic field mappings below to assemble an OAI-compliant Dublin Core document
+  # Semantic mappings of solr stored fields. Fields may be multi or
+  # single valued. See Blacklight::Solr::Document::ExtendableClassMethods#field_semantics
+  # and Blacklight::Solr::Document#to_semantic_values
+  # Recommendation: Use field names from Dublin Core
+  use_extension( Blacklight::Solr::Document::DublinCore)    
+  field_semantics.merge!(    
+                         :title => "title_display",
+                         :author => "author_display",
+                         :language => "language_facet",
+                         :format => "format"
+                         )
+end