blacklight-oembed 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b343ee31e505b633bc93a0253ebacbffe491075
-  data.tar.gz: 5d8add19811dbcc255b0f03399797abc8a10320f
+  metadata.gz: db9d87b367dffd26913c0d1a57db4a08e2da50b2
+  data.tar.gz: 1544b62ac3ab14deadbd1e11cea9d39563e60dbd
 SHA512:
-  metadata.gz: ba8c5256794843bd1f9335f677e02247826d250801138140211eb55e81d1d5e33873e7f86b2b120f90ce535a28fcca6d80f7e16e4331a1208f8c28a666c4ab60
-  data.tar.gz: c1a24b877ff2b4d6e063d964f45ad36f47c372e0f99bf744a40e8cdc6d4b33c65490215f7aa01dc6cf88e90560ba6c89cddbd5a6f4217bd0ac53cc5db11a151d
+  metadata.gz: b800826445f20a4e9293daf0748e1d6281b972cf102a1cb79353680aec07c1b01b61d230b7f9cd8331ed4a7bb13c0154cc45f77af873f6514a5ecc28e5171072
+  data.tar.gz: c78c6fa174c2da2b4f8ecb434041bad4e8489e40fb7861ea35c65bdd8a4502f545df2214f21d38f902437025fd50dd4569276c830e7451e247f5147d0515f09c

data/.gitignore

@@ -16,4 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 jetty
-spec/internal
+.internal_test_app

data/.travis.yml

@@ -2,17 +2,8 @@ notifications:
   email: false
 
 rvm:
-  - 2.1.0
-  - 2.0.0
-  - 1.9.3
-  - jruby-19mode
-
-notifications:
-  irc: "irc.freenode.org#blacklight"
-  email:
-      - blacklight-commits@googlegroups.com
+  - 2.2.4
 
 env:
   global:
-    - JRUBY_OPTS="-J-Xms512m -J-Xmx1024m"
     - NOKOGIRI_USE_SYSTEM_LIBRARIES=true

data/Gemfile

@@ -3,19 +3,29 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in blacklight-gallery.gemspec
 gemspec
 
-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)
+# BEGIN ENGINE_CART BLOCK
+# engine_cart: 0.8.0
+# engine_cart stanza: 0.8.0
+# the below comes from engine_cart, a gem used to test this Rails engine gem in the context of a Rails app.
+file = File.expand_path("Gemfile", ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path(".internal_test_app", File.dirname(__FILE__)))
+if File.exist?(file)
+  begin
+    eval_gemfile file
+  rescue Bundler::GemfileError => e
+    Bundler.ui.warn '[EngineCart] Skipping Rails application dependencies:'
+    Bundler.ui.warn e.message
+  end
 else
-  gem 'rails', ENV['RAILS_VERSION']
+  Bundler.ui.warn "[EngineCart] Unable to find test application dependencies in #{file}, using placeholder dependencies"
+
+  gem 'rails', ENV['RAILS_VERSION'] if 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.beta1"
+  if ENV['RAILS_VERSION'].nil? || ENV['RAILS_VERSION'] =~ /^4.2/
     gem 'responders', "~> 2.0"
+    gem 'sass-rails', ">= 5.0"
   else
-    gem 'sass-rails'
-    gem 'coffee-rails', "~> 4.0.0"
+    gem 'bootstrap-sass', '< 3.3.5' # 3.3.5 requires sass 3.3, incompatible with sass-rails 4.x
+    gem 'sass-rails', "< 5.0"
   end
-end
+end
+# END ENGINE_CART BLOCK

data/README.md

@@ -1,7 +1,7 @@
 # Blacklight::Oembed
 [![Gem Version](https://badge.fury.io/rb/blacklight-oembed.svg)](http://badge.fury.io/rb/blacklight-oembed)
 
-Oembed views for Blacklight search results
+blacklight-oembed adds [OEmbed](http://oembed.info) displays for Blacklight's search results views.
 
 ## Installation
 
@@ -19,17 +19,46 @@ Or install it yourself as:
 
 ## Usage
 
-Run the gallery generator:
+Run the blacklight-oembed generator:
 
     $ rails g blacklight_oembed:install
 
-## Screenshot
+The generator will provide reasonable defaults and inject oembed configuration into your `CatalogController`.
 
-![Screenshot](docs/screen_shot.png)
+In your solr index, you need a field containing the URL to an oembeddable object. `blacklight-oembed` will use that URL to render the oembed viewer on your `catalog#show` page. The name of the field can be configured in your Blacklight configuration:
+
+```
+# app/controllers/catalog_controller
+class CatalogController
+...
+    configure_blacklight do |config|
+        # these are generated into your configuration by the install generator.
+        config.show.oembed_field = :oembed_url_ssm
+        config.show.partials.insert(1, :oembed)
+    end
+...
+end
+```
+
+In an initializer, you may want to register additional oembed providers for the [`ruby-oembed`](https://github.com/judofyr/ruby-oembed), e.g.:
+
+```
+# config/initializers/oembed_providers
+require 'oembed'
+
+OEmbed::providers.register_all
+
+purl_provider = OEmbed::Provider.new("http://purl.stanford.edu/embed.{format}?&hide_title=true")
+purl_provider << "http://purl.stanford.edu/*"
+OEmbed::Providers.register(purl_provider)
+```
+
+
+You need a solr field containing a URL to an embeddable object.
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/blacklight-oembed/fork )
+1. Fork it ( http://github.com/sul-dlss/blacklight-oembed/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -1,6 +1,6 @@
 require "bundler/gem_tasks"
 
-ZIP_URL = "https://github.com/projectblacklight/blacklight-jetty/archive/v4.10.2.zip"
+ZIP_URL = "https://github.com/projectblacklight/blacklight-jetty/archive/v4.10.4.zip"
 APP_ROOT = File.dirname(__FILE__)
 
 require 'rspec/core/rake_task'
@@ -18,7 +18,7 @@ end
 desc "Load fixtures"
 task :fixtures => ['engine_cart:generate'] do
   within_test_app do
-      system "rake blacklight:solr:seed RAILS_ENV=test"
+      system "rake blacklight:index:seed RAILS_ENV=test"
       abort "Error running fixtures" unless $?.success?
   end
 end
@@ -54,7 +54,7 @@ task :server do
 
   Jettywrapper.wrap(jetty_params) do
     within_test_app do
-      system "rake blacklight:solr:seed"
+      system "rake blacklight:index:seed"
       system "bundle exec rails s"
     end
   end

data/app/controllers/blacklight/oembed/embed_controller.rb

@@ -1,8 +1,8 @@
 module Blacklight::Oembed
-  class EmbedController < ActionController::Metal 
+  class EmbedController < ActionController::Base
+
     def show
-      self.content_type  = "application/json"
-      self.response_body = { html: get_embed_content(params[:url]) }.to_json
+      render json: { html: get_embed_content(params[:url]) }
     end
 
     private
@@ -11,7 +11,7 @@ module Blacklight::Oembed
       begin
         OEmbed::Providers.get(url).html.html_safe
       rescue OEmbed::NotFound
-        self.status = 400
+        response.status = 400
         ""
       end
     end

data/blacklight-oembed.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rails"
-  spec.add_dependency "blacklight", "~> 5.0"
+  spec.add_dependency "blacklight", ">= 5.0", "< 7"
   spec.add_dependency "bootstrap-sass", "~> 3.0"
   spec.add_dependency "ruby-oembed"
 
@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-activemodel-mocks"
   spec.add_development_dependency "rspec-collection_matchers"
   spec.add_development_dependency "jettywrapper"
-  spec.add_development_dependency "engine_cart"
+  spec.add_development_dependency "engine_cart", "~> 0.8"
   spec.add_development_dependency "capybara"
   spec.add_development_dependency "poltergeist", ">= 1.5.0"
 end

data/lib/blacklight/oembed/version.rb

@@ -1,5 +1,5 @@
 module Blacklight
   module Oembed
-    VERSION = "0.0.4"
+    VERSION = '0.1.0'
   end
 end

data/spec/controllers/embed_controller_spec.rb

@@ -3,6 +3,9 @@ require 'spec_helper'
 describe Blacklight::Oembed::EmbedController do
   routes { Blacklight::Oembed::Engine.routes }
   describe "show" do
+
+    render_views
+
     before do
       Blacklight::Oembed::Engine.config.render_helper = :render_oembed_tag_embed
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-oembed
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-24 00:00:00.000000000 Z
+date: 2016-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,16 +28,22 @@ dependencies:
   name: blacklight
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: bootstrap-sass
   requirement: !ruby/object:Gem::Requirement
@@ -168,16 +174,16 @@ dependencies:
   name: engine_cart
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -258,7 +264,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Oembed display for Blacklight