spotlight-resources-iiif 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2fbc962270af9f8879ad88cb7518450028149e9d
+  data.tar.gz: d1e148ef76b96e482b7813d066880ed914d667b9
+SHA512:
+  metadata.gz: c0d8eb4a499d156fbce45138f8766e73840859ec380e0dcb6f18e66573f448d39caa9de0b2756104e146aa570317c4899f9d5ed53a13cb56cacf1b3623af5141
+  data.tar.gz: 4941537eb392d728e53e34c74bf98054ad984a7519c16af5b890f276fde927cdf2d47675a06f4989e0aa35d1817fe68ad98d6b07f74cbcab1a57273a03af750b

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.internal_test_app/
+/jetty/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+inherit_from: .rubocop_todo.yml
+
+require: rubocop-rspec
+
+AllCops:
+  Exclude:
+    - 'Gemfile'
+    - 'bin/**/*'
+    - 'db/**/*'
+    - 'config/**/*'
+    - '.internal_test_app/**/*'
+    - 'spec/test_app_templates/**/*'
+    - 'spec/spec_helper.rb'
+    - 'vendor/**/*'

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-11-20 13:22:45 -0800 using RuboCop version 0.35.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/.travis.yml

@@ -0,0 +1,15 @@
+notifications:
+  email: false
+
+rvm:
+  - 2.2.3
+
+env:
+  global:
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+
+sudo: false
+language: ruby
+
+script:
+  - bundle exec rake

data/Gemfile

@@ -0,0 +1,30 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in spotlight-resources-iiif.gemspec
+gemspec
+
+# 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
+  Bundler.ui.warn "[EngineCart] Unable to find test application dependencies in #{file}, using placeholder dependencies"
+
+  gem 'rails', ENV['RAILS_VERSION'] if ENV['RAILS_VERSION']
+
+  if ENV['RAILS_VERSION'].nil? || ENV['RAILS_VERSION'] =~ /^4.2/
+    gem 'responders', "~> 2.0"
+    gem 'sass-rails', ">= 5.0"
+  else
+    gem 'sass-rails', "< 5.0"
+  end
+end
+# END ENGINE_CART BLOCK

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2015 The Board of Trustees of the Leland Stanford Junior University.
+
+Licensed 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.

data/README.md

@@ -0,0 +1,41 @@
+[![Build Status](https://travis-ci.org/sul-dlss/spotlight-resources-iiif.svg?branch=master)](https://travis-ci.org/sul-dlss/spotlight-resources-iiif) [![Coverage Status](https://coveralls.io/repos/sul-dlss/spotlight-resources-iiif/badge.svg?branch=master&service=github)](https://coveralls.io/github/sul-dlss/spotlight-resources-iiif?branch=master) [![Dependency Status](https://gemnasium.com/sul-dlss/spotlight-resources-iiif.svg)](https://gemnasium.com/sul-dlss/spotlight-resources-iiif) [![Gem Version](https://badge.fury.io/rb/spotlight-resources-iiif.png)](http://badge.fury.io/rb/spotlight-resources-iiif)
+
+# Spotlight::Resources::Iiif
+
+Spotlight Resource Indexer for IIIF manifests or collections.  A Rails engine gem for use in the blacklight-spotlight Rails engine gem.
+
+## Installation
+
+Add this line to your blacklight-spotlight Rails application's Gemfile:
+
+```ruby
+gem 'spotlight-resources-iiif'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spotlight-resources-iiif
+
+## Usage
+
+This is a Rails engine gem to be used along with blacklight-spotlight, another Rails engine gem used to build exhibits sites while leveraging the blacklight Rails engine gem.
+
+This gem adds a new "Repository Item" form to your Spotlight application. This form allows curators to input one or more URLs to a IIIF Manifest or collection, and the contents of the feed will be harvested as new items in the Spotlight exhibit.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sul-dlss/spotlight-resources-iiif.
+
+## Contributing
+
+1. Fork it (https://help.github.com/articles/fork-a-repo/)
+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`)
+5. Create a new Pull Request (https://help.github.com/articles/using-pull-requests/)
+
+

data/Rakefile

@@ -0,0 +1,77 @@
+require 'bundler/setup'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.options = ['-l'] # run lint cops only
+end
+
+ZIP_URL = "https://github.com/projectblacklight/blacklight-jetty/archive/v4.10.4.zip"
+require 'jettywrapper'
+
+require 'engine_cart/rake_task'
+EngineCart.fingerprint_proc = EngineCart.rails_fingerprint_proc
+
+require 'exhibits_solr_conf'
+
+desc 'Run tests in generated test Rails app with generated Solr instance running'
+task ci: ['engine_cart:generate', 'jetty:clean', 'exhibits:configure_solr'] do
+  ENV['environment'] = 'test'
+  jetty_params = Jettywrapper.load_config
+  jetty_params[:startup_wait] = 60
+
+  Jettywrapper.wrap(jetty_params) do
+    # run the tests
+    Rake::Task['spec'].invoke
+  end
+end
+
+task default: [:ci, :rubocop]
+
+desc 'Run generated test Rails app with generated Solr instance running'
+task :server do
+  Rake::Task['engine_cart:generate'].invoke
+
+  unless File.exist? 'jetty'
+    Rake::Task['jetty:clean'].invoke
+    Rake::Task['exhibits:configure_solr'].invoke
+  end
+
+  jetty_params = Jettywrapper.load_config
+  jetty_params[:startup_wait]= 30
+
+  Jettywrapper.wrap(jetty_params) do
+    within_test_app do
+      system "bundle exec rails s"
+    end
+  end
+end
+
+require 'yard'
+require 'yard/rake/yardoc_task'
+begin
+  project_root = File.expand_path(File.dirname(__FILE__))
+  doc_dest_dir = File.join(project_root, 'doc')
+
+  YARD::Rake::YardocTask.new(:doc) do |yt|
+    yt.files = Dir.glob(File.join(project_root, 'lib', '**', '*.rb')) +
+               [File.join(project_root, 'README.md')]
+    yt.options = ['--output-dir', doc_dest_dir, '--readme', 'README.md', '--title', 'Stanford-Mods Documentation']
+  end
+rescue LoadError
+  desc "Generate YARD Documentation"
+  task :doc do
+    abort "Please install the YARD gem to generate rdoc."
+  end
+end

data/app/models/spotlight/resources/iiif_harvester.rb

@@ -0,0 +1,10 @@
+module Spotlight::Resources
+  # harvest Images from IIIF Manifest and turn them into a Spotlight::Resource
+  class IiifHarvester < Spotlight::Resource
+    self.weight = -5000
+
+    after_save :harvest_resources
+
+
+  end
+end

data/app/views/spotlight/resources/iiif/_manifest.html.erb

@@ -0,0 +1,9 @@
+<%= bootstrap_form_for([current_exhibit, @resource], layout: :horizontal, label_col: 'col-md-2', control_col: 'col-sm-6 col-md-6', html: { class: 'item-upload-form', multipart: true } ) do |f| %>
+  <%= f.text_field :url, help: t('.url-field.help'), label: t('.manifest') %>
+  <div class="form-actions">
+    <div class="primary-actions">
+      <%= cancel_link @resource, :back, class: 'btn btn-default' %>
+      <%= f.submit t('.add_item'), class: 'btn btn-primary' %>
+    </div>
+  </div>
+<% end %>

data/app/views/spotlight/resources/iiif/_tabbed_form.html.erb

@@ -0,0 +1,18 @@
+<div role="tabpanel" class="item-upload-tabs">
+  <ul class="nav nav-tabs" role="tablist">
+    <% Spotlight::Resources::Iiif::Engine.config.resource_partials.each_with_index do |p, i| %>
+      <% name = p.split('/').last %>
+      <li role="presentation" class="<%= "active" if i ==0 %>">
+        <%= link_to t(".#{name}"), "##{name}", role: 'tab', 'data-toggle' => 'tab', 'aria-controls' => 'single' %>
+      </li>
+    <% end %>
+  </ul>
+  <div class="tab-content">
+    <% Spotlight::Resources::Iiif::Engine.config.resource_partials.each_with_index do |p, i| %>
+      <% name = p.split('/').last %>
+      <%= content_tag :div, id: name, role: 'tabpanel', class: "tab-pane #{"active" if i == 0}" do %>
+        <%= render p %>
+      <% end %>
+    <% end %>
+  </div>
+</div>

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "spotlight/resources/iiif"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/jetty.yml

@@ -0,0 +1,6 @@
+default:
+  jetty_port: 8983
+test:
+  jetty_port: <%= ENV['TEST_JETTY_PORT'] || 8888 %>
+  jetty_home: <%= ENV['TEST_JETTY_PATH'] || File.expand_path(File.join('..', 'jetty'), __FILE__) %>
+  startup_wait: 15

data/config/locales/spotlight-resources-iiif.en.yml

@@ -0,0 +1,11 @@
+en:
+  spotlight:
+    resources:
+      iiif:
+        tabbed_form:
+          manifest: "IIIF Manifest"
+        manifest:
+          manifest: "Manifest"
+          add_item: "Add IIIF manifest URLs"
+          url-field:
+            help: "Add the URL of a IIIF manifest."

data/lib/spotlight/resources/iiif.rb

@@ -0,0 +1,9 @@
+require "spotlight/resources/iiif/version"
+
+module Spotlight
+  module Resources
+    module Iiif
+      require 'spotlight/resources/iiif/engine'
+    end
+  end
+end

data/lib/spotlight/resources/iiif/engine.rb

@@ -0,0 +1,12 @@
+require 'spotlight/engine'
+
+module Spotlight::Resources::Iiif
+  class Engine < ::Rails::Engine
+    Spotlight::Resources::Iiif::Engine.config.resource_partials = ['spotlight/resources/iiif/manifest']
+    initializer 'spotlight.resources.iiif.initialize' do
+      Spotlight::Engine.config.resource_providers << Spotlight::Resources::IiifHarvester
+      Spotlight::Engine.config.new_resource_partials ||= []
+      Spotlight::Engine.config.new_resource_partials << 'spotlight/resources/iiif/tabbed_form'
+    end
+  end
+end

data/lib/spotlight/resources/iiif/version.rb

@@ -0,0 +1,7 @@
+module Spotlight
+  module Resources
+    module Iiif
+      VERSION = "0.0.1"
+    end
+  end
+end

data/spotlight-resources-iiif.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spotlight/resources/iiif/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spotlight-resources-iiif"
+  spec.version       = Spotlight::Resources::Iiif::VERSION
+  spec.authors       = ["Naomi Dushay"]
+  spec.email         = ["ndushay@stanford.edu"]
+
+  spec.summary       = 'Spotlight Resource Indexer for IIIF manifests or collections.'
+  spec.homepage      = "https://github.com/sul-dlss/spotlight-resources-iiif"
+  spec.license       = 'Apache-2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "blacklight-spotlight"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency 'capybara'
+  spec.add_development_dependency 'factory_girl', '~> 4.5'
+  spec.add_development_dependency 'database_cleaner', '~> 1.3'
+#  spec.add_development_dependency 'poltergeist', '>= 1.5.0' # for js testing using phantomjs
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "engine_cart"
+  spec.add_development_dependency "jettywrapper"
+  spec.add_development_dependency 'exhibits_solr_conf'
+  # FIXME: we shouldn't need explicit sitemap_generator dependency here as it should come with spotlight
+  #   but travis fails without it (though tests run fine locally)
+  # cbeer:  "we’re injecting the dependency into the host app. maybe we’re just
+  #   missing a `bundle install` somewhere to fix that up"
+  spec.add_development_dependency 'sitemap_generator'
+end

metadata

@@ -0,0 +1,276 @@
+--- !ruby/object:Gem::Specification
+name: spotlight-resources-iiif
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naomi Dushay
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: blacklight-spotlight
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: engine_cart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jettywrapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: exhibits_solr_conf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sitemap_generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- ndushay@stanford.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/models/spotlight/resources/iiif_harvester.rb
+- app/views/spotlight/resources/iiif/_manifest.html.erb
+- app/views/spotlight/resources/iiif/_tabbed_form.html.erb
+- bin/console
+- bin/setup
+- config/jetty.yml
+- config/locales/spotlight-resources-iiif.en.yml
+- lib/spotlight/resources/iiif.rb
+- lib/spotlight/resources/iiif/engine.rb
+- lib/spotlight/resources/iiif/version.rb
+- spotlight-resources-iiif.gemspec
+homepage: https://github.com/sul-dlss/spotlight-resources-iiif
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Spotlight Resource Indexer for IIIF manifests or collections.
+test_files: []
+has_rdoc: