blacklight-oembed 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db9d87b367dffd26913c0d1a57db4a08e2da50b2
-  data.tar.gz: 1544b62ac3ab14deadbd1e11cea9d39563e60dbd
+  metadata.gz: c83a7f422815420859e82c0093226852c3b5a64e
+  data.tar.gz: ae6b4939e1e3b0c014b035790e3900da36c79c16
 SHA512:
-  metadata.gz: b800826445f20a4e9293daf0748e1d6281b972cf102a1cb79353680aec07c1b01b61d230b7f9cd8331ed4a7bb13c0154cc45f77af873f6514a5ecc28e5171072
-  data.tar.gz: c78c6fa174c2da2b4f8ecb434041bad4e8489e40fb7861ea35c65bdd8a4502f545df2214f21d38f902437025fd50dd4569276c830e7451e247f5147d0515f09c
+  metadata.gz: 54cdaa19c1360b734d11095331ddf6a6b80016caeba9a87c6e2fa85ba4450a3cd3728d16ee41bc414ef7e4b8d4c5479aabb38d46fbeca8f7db7a0e395e531824
+  data.tar.gz: 2f06ae881e04618a07ccaeb41b455be3f4b729bb60c38ea9fe5125db24ab9172c9771db71937027ff417fbf9e5622115c3a34d0ba086171cbfb652bedc26c316

data/.gitignore

@@ -15,5 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-jetty
-.internal_test_app
+.internal_test_app

data/.travis.yml

@@ -2,7 +2,7 @@ notifications:
   email: false
 
 rvm:
-  - 2.2.4
+  - 2.4.2
 
 env:
   global:

data/README.md

@@ -56,6 +56,14 @@ OEmbed::Providers.register(purl_provider)
 
 You need a solr field containing a URL to an embeddable object.
 
+### Additional configurations
+Blacklight OEmbed allows for more configurations. In an initializer, you can add additional params that will be passed through to an OEmbed provider.
+
+```
+# config/initializers/blacklight_oembed.rb
+Blacklight::Oembed::Engine.config.additional_params = [:canvas_index]
+```
+
 ## Contributing
 
 1. Fork it ( http://github.com/sul-dlss/blacklight-oembed/fork )

data/Rakefile

@@ -1,12 +1,10 @@
 require "bundler/gem_tasks"
 
-ZIP_URL = "https://github.com/projectblacklight/blacklight-jetty/archive/v4.10.4.zip"
 APP_ROOT = File.dirname(__FILE__)
 
 require 'rspec/core/rake_task'
 require 'engine_cart/rake_task'
-
-require 'jettywrapper'
+require 'solr_wrapper'
 
 task :default => :ci
 
@@ -24,15 +22,14 @@ task :fixtures => ['engine_cart:generate'] do
 end
 
 desc "Execute Continuous Integration build"
-task :ci => ['jetty:clean', 'engine_cart:generate'] do
+task ci: 'engine_cart:generate' do
 
   ENV['environment'] = "test"
-  jetty_params = Jettywrapper.load_config
-  jetty_params[:startup_wait]= 60
-
-  Jettywrapper.wrap(jetty_params) do
-    Rake::Task['fixtures'].invoke
-    Rake::Task['spec'].invoke
+  SolrWrapper.wrap(port: '8983') do |solr|
+    solr.with_collection(name: 'blacklight-core', dir: File.join(File.expand_path(File.dirname(__FILE__)), 'solr', 'conf')) do
+      Rake::Task['fixtures'].invoke
+      Rake::Task['spec'].invoke
+    end
   end
 end
 
@@ -45,14 +42,7 @@ task :server do
     Rake::Task['engine_cart:generate'].invoke
   end
 
-  unless File.exists? 'jetty'
-    Rake::Task['jetty:clean'].invoke
-  end
-
-  jetty_params = Jettywrapper.load_config
-  jetty_params[:startup_wait]= 60
-
-  Jettywrapper.wrap(jetty_params) do
+  SolrWrapper.wrap(port: '8983')  do
     within_test_app do
       system "rake blacklight:index:seed"
       system "bundle exec rails s"

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

@@ -2,18 +2,28 @@ module Blacklight::Oembed
   class EmbedController < ActionController::Base
 
     def show
-      render json: { html: get_embed_content(params[:url]) }
+      render json: { html: get_embed_content(params[:url], additional_params) }
     end
 
     private
 
-    def get_embed_content url
+    def get_embed_content(url, add_params)
       begin
-        OEmbed::Providers.get(url).html.html_safe
+        OEmbed::Providers.get(url, **add_params).html.html_safe
       rescue OEmbed::NotFound
         response.status = 400
         ""
       end
     end
+
+    ##
+    # Allows for blacklight-oembed users to pass through additional configured
+    # parameters
+    def additional_params
+      params
+        .slice(*Blacklight::Oembed::Engine.config.additional_params)
+        .to_unsafe_h
+        .symbolize_keys
+    end
   end
-end
+end

data/blacklight-oembed.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-its"
   spec.add_development_dependency "rspec-activemodel-mocks"
   spec.add_development_dependency "rspec-collection_matchers"
-  spec.add_development_dependency "jettywrapper"
+  spec.add_development_dependency "solr_wrapper"
   spec.add_development_dependency "engine_cart", "~> 0.8"
   spec.add_development_dependency "capybara"
   spec.add_development_dependency "poltergeist", ">= 1.5.0"

data/lib/blacklight/oembed/engine.rb

@@ -5,6 +5,10 @@ module Blacklight
     class Engine < Rails::Engine
 
       Blacklight::Oembed::Engine.config.render_helper = :render_oembed_tag_async
+      ##
+      # Allows an adopter to pass additional parameters through to an OEmbed
+      # service. Examples of this could include `:canvas_index`, or `:max_width`
+      Blacklight::Oembed::Engine.config.additional_params = []
 
     end
   end

data/lib/blacklight/oembed/version.rb

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

data/solr/conf/_rest_managed.json

@@ -0,0 +1,3 @@
+{
+  "initArgs":{},
+  "managedList":[]}

data/solr/conf/admin-extra.html

@@ -0,0 +1,31 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!-- The content of this page will be statically included into the top
+of the admin page.  Uncomment this as an example to see there the content
+will show up.
+
+<hr>
+<i>This line will appear before the first table</i>
+<tr>
+<td colspan="2">
+This row will be appended to the end of the first table
+</td>
+</tr>
+<hr>
+
+-->

data/solr/conf/elevate.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!-- If this file is found in the config directory, it will only be
+     loaded once at startup.  If it is found in Solr's data
+     directory, it will be re-loaded every commit.
+-->
+
+<elevate>
+ <query text="foo bar">
+  <doc id="1" />
+  <doc id="2" />
+  <doc id="3" />
+ </query>
+ 
+ <query text="ipod">
+   <doc id="MA147LL/A" />  <!-- put the actual ipod at the top -->
+   <doc id="IW-02" exclude="true" /> <!-- exclude this cable -->
+ </query>
+ 
+</elevate>

data/solr/conf/mapping-ISOLatin1Accent.txt

@@ -0,0 +1,246 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Syntax:
+#   "source" => "target"
+#     "source".length() > 0 (source cannot be empty.)
+#     "target".length() >= 0 (target can be empty.)
+
+# example:
+#   "??" => "A"
+#   "\u00C0" => "A"
+#   "\u00C0" => "\u0041"
+#   "??" => "ss"
+#   "\t" => " "
+#   "\n" => ""
+
+# ?? => A
+"\u00C0" => "A"
+
+# ?? => A
+"\u00C1" => "A"
+
+# ?? => A
+"\u00C2" => "A"
+
+# ?? => A
+"\u00C3" => "A"
+
+# ?? => A
+"\u00C4" => "A"
+
+# ?? => A
+"\u00C5" => "A"
+
+# ?? => AE
+"\u00C6" => "AE"
+
+# ?? => C
+"\u00C7" => "C"
+
+# ?? => E
+"\u00C8" => "E"
+
+# ?? => E
+"\u00C9" => "E"
+
+# ?? => E
+"\u00CA" => "E"
+
+# ?? => E
+"\u00CB" => "E"
+
+# ?? => I
+"\u00CC" => "I"
+
+# ?? => I
+"\u00CD" => "I"
+
+# ?? => I
+"\u00CE" => "I"
+
+# ?? => I
+"\u00CF" => "I"
+
+# ?? => IJ
+"\u0132" => "IJ"
+
+# ?? => D
+"\u00D0" => "D"
+
+# ?? => N
+"\u00D1" => "N"
+
+# ?? => O
+"\u00D2" => "O"
+
+# ?? => O
+"\u00D3" => "O"
+
+# ?? => O
+"\u00D4" => "O"
+
+# ?? => O
+"\u00D5" => "O"
+
+# ?? => O
+"\u00D6" => "O"
+
+# ?? => O
+"\u00D8" => "O"
+
+# ?? => OE
+"\u0152" => "OE"
+
+# ??
+"\u00DE" => "TH"
+
+# ?? => U
+"\u00D9" => "U"
+
+# ?? => U
+"\u00DA" => "U"
+
+# ?? => U
+"\u00DB" => "U"
+
+# ?? => U
+"\u00DC" => "U"
+
+# ?? => Y
+"\u00DD" => "Y"
+
+# ?? => Y
+"\u0178" => "Y"
+
+# ?? => a
+"\u00E0" => "a"
+
+# ?? => a
+"\u00E1" => "a"
+
+# ?? => a
+"\u00E2" => "a"
+
+# ?? => a
+"\u00E3" => "a"
+
+# ?? => a
+"\u00E4" => "a"
+
+# ?? => a
+"\u00E5" => "a"
+
+# ?? => ae
+"\u00E6" => "ae"
+
+# ?? => c
+"\u00E7" => "c"
+
+# ?? => e
+"\u00E8" => "e"
+
+# ?? => e
+"\u00E9" => "e"
+
+# ?? => e
+"\u00EA" => "e"
+
+# ?? => e
+"\u00EB" => "e"
+
+# ?? => i
+"\u00EC" => "i"
+
+# ?? => i
+"\u00ED" => "i"
+
+# ?? => i
+"\u00EE" => "i"
+
+# ?? => i
+"\u00EF" => "i"
+
+# ?? => ij
+"\u0133" => "ij"
+
+# ?? => d
+"\u00F0" => "d"
+
+# ?? => n
+"\u00F1" => "n"
+
+# ?? => o
+"\u00F2" => "o"
+
+# ?? => o
+"\u00F3" => "o"
+
+# ?? => o
+"\u00F4" => "o"
+
+# ?? => o
+"\u00F5" => "o"
+
+# ?? => o
+"\u00F6" => "o"
+
+# ?? => o
+"\u00F8" => "o"
+
+# ?? => oe
+"\u0153" => "oe"
+
+# ?? => ss
+"\u00DF" => "ss"
+
+# ?? => th
+"\u00FE" => "th"
+
+# ?? => u
+"\u00F9" => "u"
+
+# ?? => u
+"\u00FA" => "u"
+
+# ?? => u
+"\u00FB" => "u"
+
+# ?? => u
+"\u00FC" => "u"
+
+# ?? => y
+"\u00FD" => "y"
+
+# ?? => y
+"\u00FF" => "y"
+
+# ??? => ff
+"\uFB00" => "ff"
+
+# ??? => fi
+"\uFB01" => "fi"
+
+# ??? => fl
+"\uFB02" => "fl"
+
+# ??? => ffi
+"\uFB03" => "ffi"
+
+# ??? => ffl
+"\uFB04" => "ffl"
+
+# ??? => ft
+"\uFB05" => "ft"
+
+# ??? => st
+"\uFB06" => "st"