blacklight_unapi 0.0.1rc1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Chris Beer <chris_beer@wgbh.org>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,48 @@
+BlacklightUnapi: unAPI provider plugin for Blacklight
+
+= Description
+
+The BlacklightUnapi plugin provides an unapi endpoint for Blacklight records. unAPI is a tiny HTTP API for the few basic operations necessary to copy discrete, identified content from any kind of web application.
+
+= Requirements
+
+A Rails app using Blacklight >3.x.
+
+= Installation
+
+Add
+
+    gem "blacklight_highlight"
+
+to your Gemfile and run "bundle install".
+
+Then, run "rails generate blacklight_unapi" to install the unAPI configuration and hooks into the CatalogController. 
+
+= Configuration
+
+See ./config/initializers/blacklight_config for unAPI configuration options, where you can list the default set of document formats (which must be available for every document served). By default, this is only OAI Dublin Core.
+
+
+== Injection
+
+This plugin assumes it is in a Blacklight Rails app, uses Blacklight methods, Rails methods, and standard ruby module includes to inject it's behaviors into the app.  
+
+You can turn off this injection if you like, although it will make the plugin less (or non-) functional unless you manually do similar injection. See lib/blacklight_unapi.rb#inject! to see exactly what's going on. 
+
+In any initializer, you can set:
+
+  BlacklightUnapi.omit_inject = true
+
+to turn off all injection. The plugin will be completely non-functional if you do this, of course. But perhaps you could try to re-use some of it's classes in a non-Blacklight, highly hacked Blacklight, or even non-Rails application this way. 
+
+You can also turn off injection of individual components, which could be more useful:
+   
+  BlacklightUnapi.omit_inject = {
+    :routes => false,  
+  }
+
+= Tests
+
+There are none. This is bad I know, sorry. 
+
+

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rake'
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+

data/VERSION

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

data/app/helpers/blacklight_unapi_helper.rb

@@ -0,0 +1,5 @@
+module BlacklightUnapiHelper
+  def render_document_unapi_microformat document, options = {}
+    render :partial =>'unapi/microformat', :locals => {:document => document}.merge(options)
+  end
+end

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

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

data/app/views/unapi/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

@@ -0,0 +1,24 @@
+ # -*- coding: utf-8 -*-
+require File.join(File.dirname(__FILE__), "lib/blacklight_unapi/version")
+
+Gem::Specification.new do |s|
+  s.name = "blacklight_unapi"
+  s.version = BlacklightUnapi::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors = ["Chris Beer"]
+  s.email = ["chris_beer@wgbh.org"]
+  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"
+end
+

data/config/routes.rb

@@ -0,0 +1,5 @@
+# We want to add a new collection action to Catalog, without over-writing
+# # what's already there. This SEEMS to do it. 
+ActionController::Routing::Routes.draw do |map|  
+end
+

data/lib/blacklight_unapi/controller_extension.rb

@@ -0,0 +1,46 @@
+# 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
+  end
+
+  def unapi
+    @export_formats = unapi_default_export_formats
+    @format = params[:format]
+
+    if params[:id]
+      @response, @document = get_solr_response_for_doc_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
+      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   
+    Blacklight.config[:unapi] || {}
+  end
+
+  def unapi_default_export_formats
+    unapi_config
+  end
+
+end

data/lib/blacklight_unapi/engine.rb

@@ -0,0 +1,13 @@
+require 'blacklight'
+require 'blacklight_unapi'
+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/blacklight_unapi/route_sets.rb

@@ -0,0 +1,12 @@
+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/version.rb

@@ -0,0 +1,10 @@
+module BlacklightUnapi
+  unless BlacklightUnapi.const_defined? :VERSION
+    def self.version
+      @version ||= File.read(File.join(File.dirname(__FILE__), '..', '..', 'VERSION')).chomp
+    end
+
+    VERSION = self.version
+  end
+end
+

data/lib/blacklight_unapi/view_helper_extension.rb

@@ -0,0 +1,5 @@
+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/blacklight_unapi.rb

@@ -0,0 +1,20 @@
+# BlacklightUnapi
+
+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/generators/blacklight_unapi/blacklight_unapi_generator.rb

@@ -0,0 +1,35 @@
+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

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: blacklight_unapi
+version: !ruby/object:Gem::Version 
+  hash: 15424031
+  prerelease: 5
+  segments: 
+  - 0
+  - 0
+  - 1
+  - rc
+  - 1
+  version: 0.0.1rc1
+platform: ruby
+authors: 
+- Chris Beer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-08 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: blacklight
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: 
+email: 
+- chris_beer@wgbh.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- app/helpers/blacklight_unapi_helper.rb
+- app/views/unapi/_microformat.html.erb
+- app/views/unapi/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
+has_rdoc: true
+homepage: http://projectblacklight.org/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      hash: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: blacklight
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Blacklight unapi plugin
+test_files: []
+