blacklight_unapi 0.0.1rc1 → 0.0.1

data/README.rdoc

@@ -4,6 +4,8 @@ BlacklightUnapi: unAPI provider plugin for Blacklight
 
 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.
 
+unAPI is a tiny HTTP API any web application may use to co-publish discretely identified objects in both HTML pages and disparate bare object formats. It consists of three parts: an identifier microformat, an HTML autodiscovery link, and three HTTP interface functions, two of which have a standardized response format. [http://unapi.info/](http://unapi.info/).
+
 = Requirements
 
 A Rails app using Blacklight >3.x.
@@ -12,7 +14,7 @@ A Rails app using Blacklight >3.x.
 
 Add
 
-    gem "blacklight_highlight"
+    gem "blacklight_unapi"
 
 to your Gemfile and run "bundle install".
 
@@ -20,8 +22,15 @@ Then, run "rails generate blacklight_unapi" to install the unAPI configuration a
 
 = 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.
+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).
+
+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] = {
+      'oai_dc_xml' => { :content_type => 'text/xml' }, 
+      'marc' => { :content_type => 'application/marc' },
+      'jpg' => { :content_type => 'image/jpg' }  
+    }
 
 == Injection
 
@@ -41,8 +50,51 @@ You can also turn off injection of individual components, which could be more us
     :routes => false,  
   }
 
-= Tests
+== API Requests
+
+=== /catalog/unapi 
+
+Provides a list of object formats available for all objects. 
+
+
+  <?xml version="1.0" encoding="UTF-8"?> 
+  <formats> 
+    <format type="text/xml" name="oai_dc_xml"/> 
+  </formats> 
+
+
+  Source: [[http://demo.projectblacklight.org/catalog/unapi]]
+
+=== /catalog/unapi?id=IDENTIFIER 
+
+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"/> 
+    <format type="text/xml" name="dc_xml"/> 
+    <format type="application/x-endnote-refer" name="endnote"/> 
+    <format type="application/xml" name="xml"/> 
+    <format type="text/xml" name="oai_dc_xml"/> 
+    <format type="application/marc" name="marc"/> 
+    <format type="application/x-openurl-ctx-kev" name="openurl_ctx_kev"/> 
+    <format type="application/marcxml+xml" name="marcxml"/> 
+  </formats> 
+
+
+  Source:  [[http://demo.projectblacklight.org/catalog/unapi?id=u1]]
+
+=== /catalog/unapi?id=IDENTIFIER&format=FORMAT 
+
+Provides the raw "FORMAT" representation for the object identified by "IDENTIFIER"
+
+
+  <oai_dc:dc xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd"     xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/" xmlns:dc="http://purl.org/dc/elements/1.1/"   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><dc:language>English</dc:language><dc:title>The book of the dance in the   20th century selections from the Jane Bourne Parton collection of books on the dance</dc:title><dc:format>Book</dc:format>  </oai_dc:dc>
+
 
-There are none. This is bad I know, sorry. 
+  Source:   [[http://demo.projectblacklight.org/catalog/unapi?id=u1&format=oai_dc_xml]]
 
 

data/VERSION

@@ -1 +1 @@
-0.0.1rc1
+0.0.1

metadata

@@ -1,64 +1,46 @@
---- !ruby/object:Gem::Specification 
+--- !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
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Chris Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-08 00:00:00 -04:00
+date: 2011-09-28 00:00:00.000000000 -04:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rails
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2156358920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: blacklight
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2156358920
+- !ruby/object:Gem::Dependency
+  name: blacklight
+  requirement: &2156358460 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *2156358460
 description: 
-email: 
+email:
 - chris_beer@wgbh.org
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
@@ -78,38 +60,26 @@ files:
 has_rdoc: true
 homepage: http://projectblacklight.org/
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      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:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: blacklight
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Blacklight unapi plugin
 test_files: []
-