blacklight_oembed 0.0.2

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,42 @@
+BlacklightOembed: oEmbed provider plugin for Blacklight
+
+= Description
+
+The BlacklightOembed plugin provides an oembed endpoint for Blacklight records. oEmbed is a format for allowing an embedded representation of a URL on third party sites. The simple API allows a website to display embedded content (such as photos or videos) when a user posts a link to that resource, without having to parse the resource directly. [http://oembed.com/](http://oembed.com/)
+
+= Requirements
+
+A Rails app using Blacklight >3.x.
+
+= Installation
+
+Add
+
+    gem "blacklight_oembed"
+
+to your Gemfile and run "bundle install".
+
+Then, run "rails generate blacklight_oembed" to install the oEmbed configuration and hooks into the CatalogController. 
+
+= Configuration
+
+See ./config/initializers/blacklight_config for oEmbed configuration options, where you can list the default set of document formats (which must be available for every document served).
+
+== 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_oembed.rb#inject! to see exactly what's going on. 
+
+In any initializer, you can set:
+
+  BlacklightOembed.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:
+   
+  BlacklightOembed.omit_inject = {
+    :routes => false,  
+  }
+

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler::GemHelper.install_tasks

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/app/views/catalog/_oembed_partials/_default.html.erb

@@ -0,0 +1,3 @@
+<iframe src="<%= embed_catalog_url(:id => document[:id]) %>">
+
+</iframe>

data/app/views/oembed/_autodiscovery_link.html.erb

@@ -0,0 +1,2 @@
+<%= tag :link, :rel => 'alternate', :type => 'text/xml+oembed', :title => 'oEmbed Profile', :href => oembed_url(:format => 'xml', :url => url_for()) %>
+<%= tag :link, :rel => 'alternate', :type => 'text/json+oembed', :title => 'oEmbed Profile', :href => oembed_url(:format => 'json', :url => url_for()) %>

data/app/views/oembed/oembed.html.erb

@@ -0,0 +1 @@
+<%= @oembed[:html] %>

data/app/views/oembed/oembed.xml.builder

@@ -0,0 +1,7 @@
+xml.instruct!
+
+xml.oembed do
+  @oembed.each do |key, value|
+    xml.tag! key, value
+  end
+end

data/blacklight_oembed.gemspec

@@ -0,0 +1,24 @@
+ # -*- coding: utf-8 -*-
+require File.join(File.dirname(__FILE__), "lib/blacklight_oembed/version")
+
+Gem::Specification.new do |s|
+  s.name = "blacklight_oembed"
+  s.version = BlacklightOembed::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors = ["Chris Beer"]
+  s.email = ["chris_beer@wgbh.org"]
+  s.homepage    = "http://projectblacklight.org/"
+  s.summary = "Blacklight oembed 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,3 @@
+BlacklightOembed::Engine.routes.draw do
+
+end

data/lib/blacklight_oembed/controller_extension.rb

@@ -0,0 +1,37 @@
+# Meant to be applied on top of a controller that implements
+# Blacklight::SolrHelper. 
+module BlacklightOembed::ControllerExtension
+  def self.included(some_class)
+    some_class.helper_method :oembed_config
+    some_class.before_filter do
+      extra_head_content << render_to_string(:partial => 'oembed/autodiscovery_link.html')
+    end
+  end
+
+  def oembed
+    url = Rails.application.routes.recognize_path(URI.parse(params[:url]).path,:method=>:get)
+    @response, @document = get_solr_response_for_doc_id(url[:id])
+
+    @oembed = @document.to_oembed({:provider_name => @template.application_name, :provider_url => @template.root_url})
+
+    @oembed.select { |key,value| value.is_a? Proc }.each do |key, value|
+      @oembed[key] = value.call(self)
+    end
+
+    respond_to do |format|
+      format.html { render 'oembed/oembed', :layout => false }
+      format.xml { render 'oembed/oembed' }
+      format.json { render :json => @oembed.to_json }
+    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 oembed_config   
+    Blacklight.config[:oembed] || {}
+  end
+
+end

data/lib/blacklight_oembed/engine.rb

@@ -0,0 +1,13 @@
+require 'blacklight'
+require 'blacklight_oembed'
+require 'rails'
+
+module BlacklightOembed
+  class Engine < Rails::Engine
+    config.to_prepare do
+      unless BlacklightOembed.omit_inject[:routes]
+        Blacklight::Routes.send(:include, BlacklightOembed::RouteSets)
+      end
+    end
+  end
+end

data/lib/blacklight_oembed/route_sets.rb

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

data/lib/blacklight_oembed/solr/document/oembed.rb

@@ -0,0 +1,18 @@
+module BlacklightOembed::Solr::Document::Oembed
+  def self.extended(document)
+    BlacklightOembed::Solr::Document::Oembed.register_export_formats( document )
+  end
+
+  def self.register_export_formats(document)
+  end
+
+  def to_oembed(oembed)
+    semantic_values = self.to_semantic_values
+    ({
+      :version => '1.0',
+      :type =>' link',
+      :title => semantic_values[:title],
+      :author_name => semantic_values[:author],
+    }).merge(oembed)
+  end
+end

data/lib/blacklight_oembed/solr/document/oembed_rich.rb

@@ -0,0 +1,30 @@
+module BlacklightOembed::Solr::Document::OembedRich
+  def self.extended(document)
+    BlacklightOembed::Solr::Document::OembedRich.register_export_formats( document )
+  end
+
+  def self.register_export_formats(document)
+  end
+
+  def to_oembed(oembed)
+    semantic_values = self.to_semantic_values
+    ({
+      :version => '1.0',
+      :type => oembed_type,
+      :provider_name => '',
+      :provider_url => '',
+      :title => semantic_values[:title],
+      :author_name => semantic_values[:author],
+      :html => (Proc.new do |controller| 
+        template = controller.instance_variable_get("@template"); 
+        template.with_format(:html) { 
+          template.render_document_partial(self, 'oembed') 
+        } 
+      end)
+    }).merge(oembed)
+  end
+
+  def oembed_type
+    'rich'
+  end
+end

data/lib/blacklight_oembed/solr/document.rb

@@ -0,0 +1,4 @@
+module BlacklightOembed::Solr::Document
+  autoload :Oembed, 'blacklight_oembed/solr/document/oembed'
+  autoload :OembedRich, 'blacklight_oembed/solr/document/oembed_rich'
+end

data/lib/blacklight_oembed/solr.rb

@@ -0,0 +1,4 @@
+module BlacklightOembed::Solr
+  autoload :Document, 'blacklight_oembed/solr/document'
+
+end

data/lib/blacklight_oembed/version.rb

@@ -0,0 +1,10 @@
+module BlacklightOembed
+  unless BlacklightOembed.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_oembed.rb

@@ -0,0 +1,20 @@
+# BlacklightOembed
+
+module BlacklightOembed
+  autoload :ControllerExtension, 'blacklight_oembed/controller_extension'
+  autoload :Solr, 'blacklight_oembed/solr'
+  autoload :RouteSets, 'blacklight_oembed/route_sets'
+
+  require 'blacklight_oembed/version'
+  require 'blacklight_oembed/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

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: blacklight_oembed
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Chris Beer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2156048820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156048820
+- !ruby/object:Gem::Dependency
+  name: blacklight
+  requirement: &2156047800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156047800
+description: 
+email:
+- chris_beer@wgbh.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- app/views/catalog/_oembed_partials/_default.html.erb
+- app/views/oembed/_autodiscovery_link.html.erb
+- app/views/oembed/oembed.html.erb
+- app/views/oembed/oembed.xml.builder
+- blacklight_oembed.gemspec
+- config/routes.rb
+- lib/blacklight_oembed.rb
+- lib/blacklight_oembed/controller_extension.rb
+- lib/blacklight_oembed/engine.rb
+- lib/blacklight_oembed/route_sets.rb
+- lib/blacklight_oembed/solr.rb
+- lib/blacklight_oembed/solr/document.rb
+- lib/blacklight_oembed/solr/document/oembed.rb
+- lib/blacklight_oembed/solr/document/oembed_rich.rb
+- lib/blacklight_oembed/version.rb
+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
+      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.10
+signing_key: 
+specification_version: 3
+summary: Blacklight oembed plugin
+test_files: []