blacklight_unapi 0.0.3 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6740283234ea80abfba733f02e508cfd35baff86
+  data.tar.gz: 9b8db6a9e2f2c0b4a1b9d9ecb1f175cbd8a8dc29
+SHA512:
+  metadata.gz: 0e835a00df8179640536efdb0fc1cabcee3fda776ef5c4e12602671bbf5f000c4c045f1a7321f013d51fee3e9c2ae96189185386f51151479deebbfc9626477b
+  data.tar.gz: 100bf662702734e99c12e126c78109f860f1421a28c2eb42151c4bba673377d828f837e0fe9a6d8275c675f052ea8a9b9004c5dc5113736f823ac62cea75ee60

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+jetty
+spec/internal

data/.travis.yml

@@ -0,0 +1,15 @@
+notifications:
+  email: false
+
+rvm:
+  - 2.1.0
+
+notifications:
+  irc: "irc.freenode.org#blacklight"
+  email:
+      - blacklight-commits@googlegroups.com
+
+env:
+  global:
+    - JRUBY_OPTS="-J-Xms512m -J-Xmx1024m"
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true

data/Gemfile

@@ -0,0 +1,21 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'byebug'
+file = File.expand_path("Gemfile", ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path("../spec/internal", __FILE__))
+if File.exists?(file)
+  puts "Loading #{file} ..." if $DEBUG # `ruby -d` or `bundle -v`
+  instance_eval File.read(file)
+else
+  gem 'rails', ENV['RAILS_VERSION']
+  
+  # explicitly include sass-rails to get compatible sprocket dependencies
+  if ENV['RAILS_VERSION'] and ENV['RAILS_VERSION'] =~ /^4.2/
+    gem 'sass-rails', ">= 5.0.0"
+    gem 'responders', "~> 2.0"
+  else
+    gem 'sass-rails', '< 5.0'
+    gem 'coffee-rails', "~> 4.0.0"
+  end
+end

data/README.rdoc

@@ -18,7 +18,7 @@ Add
 
 to your Gemfile and run "bundle install".
 
-Then, run "rails generate blacklight_unapi" to install the unAPI configuration and hooks into the CatalogController. 
+Then, run "rails generate blacklight_unapi:install" to install the unAPI configuration and hooks into the CatalogController. 
 
 = Configuration
 
@@ -26,7 +26,7 @@ See ./config/initializers/blacklight_config for unAPI configuration options, whe
 
 Out of the box, only the OAI Dublin Core XML format is advertised as it can be be automatically generated from the Blacklight "semantic fields" configuration. Other common export formats must be defined within the Blacklight configuration.  Implementors SHOULD customize this list using the [[Blacklight.config[:unapi]|https://github.com/projectblacklight/blacklight/blob/master/config/initializers/blacklight_config.rb#L263]] hash, which is formatted as the [Blacklight::Solr::Document#export_formats](https://github.com/projectblacklight/blacklight/blob/master/lib/blacklight/solr/document.rb#L155) output, e.g.:
 
-    config[:unapi] = {
+    config.unapi = {
       'oai_dc_xml' => { :content_type => 'text/xml' }, 
       'marc' => { :content_type => 'application/marc' },
       'jpg' => { :content_type => 'image/jpg' }  
@@ -69,9 +69,6 @@ Provides a list of object formats available for all objects.
 
 Provides a list of object formats available for the object identified by "IDENTIFIER". The object formats are generated from the Document Extension Framework [Blacklight::Solr::Document#export_formats](https://github.com/projectblacklight/blacklight/blob/master/lib/blacklight/solr/document.rb#L155).
 
-In the future, Blacklight may provide mechanisms within the Document Extension Framework for filtering the list of object formats (see [CODEBASE-301](http://jira.projectblacklight.org/jira/browse/CODEBASE-301)). In the meantime, to filter this list of object formats, implementors are encouraged to override [./app/views/catalog/unapi.xml.builder](https://github.com/projectblacklight/blacklight/blob/master/app/views/catalog/unapi.xml.builder) (or CatalogController#unapi) locally.
-
-
   <?xml version="1.0" encoding="UTF-8"?> 
   <formats id="u1"> 
     <format type="text/plain" name="refworks_marc_txt"/> 

data/Rakefile

@@ -3,3 +3,45 @@ require 'bundler'
 
 Bundler::GemHelper.install_tasks
 
+
+ZIP_URL = "https://github.com/projectblacklight/blacklight-jetty/archive/v4.10.2.zip"
+APP_ROOT = File.dirname(__FILE__)
+
+require 'rspec/core/rake_task'
+require 'engine_cart/rake_task'
+
+require 'jettywrapper'
+
+task :default => :ci
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  
+end
+
+desc "Load fixtures"
+task :fixtures => ['engine_cart:generate'] do
+  within_test_app do
+    system "rake blacklight:solr:seed RAILS_ENV=test"
+    abort "Error running fixtures" unless $?.success?
+  end
+end
+
+desc "Execute Continuous Integration build"
+task :ci => ['jetty:clean', 'engine_cart:generate'] do
+  
+  require 'jettywrapper'
+  jetty_params = {
+    :jetty_home => File.expand_path(File.dirname(__FILE__) + '/jetty'),
+    :quiet => false,
+    :jetty_port => 8888,
+    :solr_home => File.expand_path(File.dirname(__FILE__) + '/jetty/solr'),
+    :startup_wait => 30
+  }
+  
+  error = Jettywrapper.wrap(jetty_params) do
+    Rake::Task['fixtures'].invoke
+    Rake::Task['spec'].invoke
+  end
+  raise "test failures: #{error}" if error
+end

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.1.0

data/app/helpers/blacklight_unapi_helper.rb

@@ -1,5 +1,8 @@
 module BlacklightUnapiHelper
-  def render_document_unapi_microformat document, options = {}
-    render :partial =>'unapi/microformat', :locals => {:document => document}.merge(options)
+  def inject_auto_discovery_link_tag
+    content_for(:head) do
+      auto_discovery_link_tag(:unapi, unapi_url, type: 'application/xml',  rel: 'unapi-server', title: 'unAPI' )
+    end unless @injected_auto_discovery_link_tag
+    @injected_auto_discovery_link_tag = true
   end
 end

data/app/views/catalog/_microformat_default.html.erb

@@ -0,0 +1,2 @@
+<% inject_auto_discovery_link_tag %>
+<%= content_tag :abbr, '', class: 'unapi-id', title: document.id %>

data/app/views/catalog/formats.xml.builder

@@ -0,0 +1,6 @@
+xml.instruct!
+xml.formats(({id: @document.id} if @document) || {}) do
+  @export_formats.each do |shortname, meta|
+    xml.format name: shortname, type: meta[:content_type]
+  end
+end

data/blacklight_unapi.gemspec

@@ -6,19 +6,25 @@ Gem::Specification.new do |s|
   s.version = BlacklightUnapi::VERSION
   s.platform = Gem::Platform::RUBY
   s.authors = ["Chris Beer"]
-  s.email = ["chris_beer@wgbh.org"]
+  s.email = ["chris@cbeer.info"]
   s.homepage    = "http://projectblacklight.org/"
   s.summary = "Blacklight unapi plugin"
 
-  s.rubyforge_project = "blacklight"
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
 
-  s.add_dependency "rails", "~> 3.0"
-  s.add_dependency "blacklight", "> 3.2"
+  s.add_dependency "rails"
+  s.add_dependency "blacklight", "~> 5.0"
+  
+  s.add_development_dependency "bundler", "~> 1.5"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec-rails", "~> 3.1"
+  s.add_development_dependency "jettywrapper"
+  s.add_development_dependency "engine_cart"
+  s.add_development_dependency "capybara"
+  s.add_development_dependency "poltergeist", ">= 1.5.0"
 end
 

data/config/routes.rb

@@ -1,5 +1,4 @@
-# We want to add a new collection action to Catalog, without over-writing
-# # what's already there. This SEEMS to do it. 
-BlacklightUnapi::Engine.routes.draw do
+Rails.application.routes.draw do
+  get 'unapi', to: "catalog#unapi", as: 'unapi'
 end
 

data/lib/blacklight_unapi.rb

@@ -2,19 +2,8 @@
 
 module BlacklightUnapi
   autoload :ControllerExtension, 'blacklight_unapi/controller_extension'
-  autoload :ViewHelperExtension, 'blacklight_unapi/view_helper_extension'
-  autoload :RouteSets, 'blacklight_unapi/route_sets'
 
   require 'blacklight_unapi/version'
   require 'blacklight_unapi/engine'
 
-  @omit_inject = {}
-
-  def self.omit_inject=(value)
-    value = Hash.new(true) if value == true
-    @omit_inject = value      
-  end
-
-  def self.omit_inject ; @omit_inject ; end
-  
 end

data/lib/blacklight_unapi/controller_extension.rb

@@ -1,46 +1,32 @@
 # Meant to be applied on top of a controller that implements
 # Blacklight::SolrHelper. 
 module BlacklightUnapi::ControllerExtension
-  def self.included(some_class)
-    some_class.helper_method :unapi_config
-    some_class.helper BlacklightUnapiHelper
-    some_class.helper BlacklightUnapi::ViewHelperExtension
-    some_class.before_filter do
-      extra_head_content << view_context.auto_discovery_link_tag(:unapi, unapi_url, {:type => 'application/xml',  :rel => 'unapi-server', :title => 'unAPI' })
-    end
+  extend ActiveSupport::Concern
+
+  included do
+    helper BlacklightUnapiHelper
   end
 
   def unapi
-    @export_formats = unapi_default_export_formats
+    @export_formats = blacklight_config.unapi
     @format = params[:format]
 
     if params[:id]
-      @response, @document = get_solr_response_for_doc_id
+      @response, @document = get_solr_response_for_doc_id params[:id]
       @export_formats = @document.export_formats
     end
 	 	
-    unless @format
-      render 'unapi/formats.xml.builder', :layout => false and return
-    end
-
-	 	
-    respond_to do |format|
-      format.all do
-        send_data @document.export_as(@format), :type => @document.export_formats[@format][:content_type], :disposition => 'inline' if @document.will_export_as @format
+    if params[:format]
+      respond_to do |format|
+        format.all do
+          if @document.will_export_as @format
+            send_data @document.export_as(@format), type: @document.export_formats[@format][:content_type], disposition: 'inline'
+          end
+        end
       end
-    end
-  end
-
-  # Uses Blacklight.config, needs to be modified when
-  # that changes to be controller-based. This is the only method
-  # in this plugin that accesses Blacklight.config, single point
-  # of contact. 
-  def unapi_config   
-    self.blacklight_config[:unapi] || {}
-  end
-
-  def unapi_default_export_formats
-    unapi_config
+    else
+      render template: 'catalog/formats.xml'
+    end 	
   end
 
 end

data/lib/blacklight_unapi/engine.rb

@@ -4,10 +4,6 @@ require 'rails'
 
 module BlacklightUnapi
   class Engine < Rails::Engine
-    config.to_prepare do
-      unless BlacklightUnapi.omit_inject[:routes]
-        Blacklight::Routes.send(:include, BlacklightUnapi::RouteSets)
-      end
-    end
+
   end
 end

data/lib/generators/blacklight_unapi/install_generator.rb

@@ -0,0 +1,38 @@
+require 'rails/generators'
+
+
+module BlacklightUnapi
+  class Install < Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+    
+
+    argument :controller_name, :type => :string, :default => "CatalogController"
+
+    def inject_catalog_controller_extension
+      file_path = "app/controllers/#{controller_name.underscore}.rb"
+      if File.exists? file_path
+        inject_into_file file_path, :after => "include Blacklight::Catalog" do
+          "\n  include BlacklightUnapi::ControllerExtension\n"
+        end
+      end
+    end
+
+    def inject_unapi_configuration
+      insert_into_file 'app/controllers/catalog_controller.rb', :after => "config.spell_max = 5\n" do <<-EOF
+
+    # Add documents to the list of object formats that are supported for all objects.
+    # This parameter is a hash, identical to the Blacklight::Solr::Document#export_formats 
+    # output; keys are format short-names that can be exported. Hash includes:
+    #    :content-type => mime-content-type
+      
+    config.unapi = {
+      'oai_dc_xml' => { :content_type => 'text/xml' } 
+    }
+    config.index.partials << 'microformat'
+    config.show.partials << 'microformat'
+EOF
+      end
+    end
+  end
+end

data/spec/features/integration_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe "Unapi", type: :feature do
+  
+  it "should have an abbr tag for the unapi id" do
+    visit catalog_index_path(q: 'medicine')
+
+    expect(page).to have_selector 'abbr.unapi-id'
+  end
+
+  it "should have an autodiscovery link" do
+    visit catalog_index_path(q: 'medicine')
+    expect(page).to have_selector 'link[rel="unapi-server"]', visible: false
+  end
+  
+  it "should have unapi formats content" do
+    visit unapi_path
+    expect(page).to have_selector "format[name='oai_dc_xml']"
+  end
+  
+  it "should have unapi document-specific formats content" do
+    visit unapi_path id: 2008308201
+    expect(page).to have_selector "format[name='oai_dc_xml']"
+    expect(page).to have_selector "format[name='dc_xml']"
+    expect(page).to have_selector "format[name='xml']"
+  end
+  
+  it "should deliver the document format" do
+    visit unapi_path id: 2008308201, format: 'xml'
+    expect(page).to have_selector 'dc'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+ENV["RAILS_ENV"] ||= 'test'
+
+require 'engine_cart'
+EngineCart.load_application!
+
+require 'rspec/rails'
+
+require 'capybara/poltergeist'
+Capybara.javascript_driver = :poltergeist
+
+require 'blacklight'
+require 'blacklight_unapi'
+
+RSpec.configure do |c|
+  c.infer_spec_type_from_file_location!
+end

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+
+class TestAppGenerator < Rails::Generators::Base
+  source_root File.expand_path("../../../../test_app_templates", __FILE__)
+  
+  def remove_index 
+    remove_file "public/index.html"
+  end
+  
+  def run_blacklight_generator
+    say_status("warning", "GENERATING BL", :yellow)       
+    
+    Bundler.with_clean_env do
+      run "bundle install"
+    end
+    
+    generate 'blacklight:install'
+  end
+  
+  def run_gallery_install
+    generate 'blacklight_unapi:install'
+  end
+  
+end

metadata

@@ -1,93 +1,192 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_unapi
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-24 00:00:00.000000000 Z
+date: 2015-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: blacklight
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: jettywrapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: engine_cart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
 description: 
 email:
-- chris_beer@wgbh.org
+- chris@cbeer.info
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
 - app/helpers/blacklight_unapi_helper.rb
-- app/views/unapi/_microformat.html.erb
-- app/views/unapi/formats.xml.builder
+- app/views/catalog/_microformat_default.html.erb
+- app/views/catalog/formats.xml.builder
 - blacklight_unapi.gemspec
 - config/routes.rb
 - lib/blacklight_unapi.rb
 - lib/blacklight_unapi/controller_extension.rb
 - lib/blacklight_unapi/engine.rb
-- lib/blacklight_unapi/route_sets.rb
 - lib/blacklight_unapi/version.rb
-- lib/blacklight_unapi/view_helper_extension.rb
-- lib/generators/blacklight_unapi/blacklight_unapi_generator.rb
+- lib/generators/blacklight_unapi/install_generator.rb
+- spec/features/integration_spec.rb
+- spec/spec_helper.rb
+- spec/test_app_templates/lib/generators/test_app_generator.rb
 homepage: http://projectblacklight.org/
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: blacklight
-rubygems_version: 1.8.24
+rubyforge_project: 
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Blacklight unapi plugin
-test_files: []
+test_files:
+- spec/features/integration_spec.rb
+- spec/spec_helper.rb
+- spec/test_app_templates/lib/generators/test_app_generator.rb

data/app/views/unapi/_microformat.html.erb

@@ -1 +0,0 @@
-<%= content_tag :abbr, '', :class => 'unapi-id', :title => document.id %>

data/app/views/unapi/formats.xml.builder

@@ -1,6 +0,0 @@
-xml.instruct!
-xml.formats(({:id => @document.id} if @document) || {}) do
-  @export_formats.each do |shortname, meta|
-    xml.format :name => shortname, :type => meta[:content_type]
-  end
-end

data/lib/blacklight_unapi/route_sets.rb

@@ -1,12 +0,0 @@
-module BlacklightUnapi
-  module RouteSets
-    protected
-    def catalog
-      add_routes do |options|
-        match 'catalog/unapi', :to => "catalog#unapi", :as => 'unapi'
-      end
-
-      super
-    end
-  end
-end

data/lib/blacklight_unapi/view_helper_extension.rb

@@ -1,5 +0,0 @@
-module BlacklightUnapi::ViewHelperExtension
-  def render_document_partial doc, action_name, *args
-    (super(doc, action_name, *args) + render_document_unapi_microformat(doc)).html_safe
-  end
-end

data/lib/generators/blacklight_unapi/blacklight_unapi_generator.rb

@@ -1,35 +0,0 @@
-require 'rails/generators'
-require 'rails/generators/base'
-require 'rails/generators/migration'
-
-class BlacklightUnapiGenerator < Rails::Generators::Base
-  include Rails::Generators::Migration
-  source_root File.expand_path('../templates', __FILE__)
-  
-
-  argument :controller_name, :type => :string, :default => "CatalogController"
-
-  def inject_catalog_controller_extension
-    file_path = "app/controllers/#{controller_name.underscore}.rb"
-    if File.exists? file_path
-      inject_into_file file_path, :after => "include Blacklight::Catalog" do
-        "\n  include BlacklightUnapi::ControllerExtension\n"
-      end
-    end
-  end
-
-  def inject_unapi_configuration
-    insert_into_file 'config/initializers/blacklight_config.rb', :after => "config[:spell_max] = 5\n" do <<EOF
-
-  # Add documents to the list of object formats that are supported for all objects.
-  # This parameter is a hash, identical to the Blacklight::Solr::Document#export_formats 
-  # output; keys are format short-names that can be exported. Hash includes:
-  #    :content-type => mime-content-type
-    
-  config[:unapi] = {
-    'oai_dc_xml' => { :content_type => 'text/xml' } 
-  }
-EOF
-    end
-  end
-end