blacklight_dpla 0.0.1.dev1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 North Carolina State University
+
+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.markdown

@@ -0,0 +1,38 @@
+# Blacklight DPLA
+
+A quick start to a Blacklight application using some of the content from
+the DPLA Platform.
+
+# Usage
+
+1. Follow the [Blacklight Quickstart guide](https://github.com/projectblacklight/blacklight/wiki/Quickstart)
+  up through step 5 (installing Solr under jetty).
+2. Update your Blacklight application's Gemfile with `gem 'blacklight_dpla'` 
+  and `bundle install`
+3. Run the generator `rails g blacklight_dpla`
+4. In a new terminal, start Solr `cd jetty && java -jar start.jar`
+5. Index some data using the rake task `rake dpla:load_query["internet"]`. In
+  place of "internet" you can enter any keyword query.
+6. Start your new Blacklight-powered DPLA application `rails s` and visit the
+  address it is started on (usually http://localhost:3000).
+
+The indexing rake task can be run multiple times to pull in other data to you 
+Blacklight app.
+
+
+# What the generator does
+
+When you run `rails g blacklight_dpla` it does the following:
+
+1. Updates `app/controllers/catalog_controller.rb` with configuration for 
+  appropriate facets, show view values, and field list.
+2. Updates the Solr configuration so that all *_facet fields are stored by default.
+3. TODO: Updates `app/views/catalog/_home_text.html.erb` with help text.
+
+# Author
+
+Jason Ronallo
+
+# Copyright
+
+Copyright © 2012 North Carolina State University. See MIT-LICENSE for details.

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BlacklightDpla'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/views/catalog/_show_partials/_mp3.html.erb

@@ -0,0 +1,10 @@
+<audio controls="controls">
+  <source src="<%= document['audio_format_mp3_display'].first %>" type="audio/mpeg" />
+</audio>
+
+<p>
+  <a href="<%= document['audio_format_mp3_display'].first %>">Download MP3</a>
+</p>
+
+
+<%= render :partial => '/catalog/show_default', :locals => {:document => document} %>

data/lib/blacklight_dpla/api.rb

@@ -0,0 +1,15 @@
+module BlacklightDpla
+  class Api
+    include HTTParty
+    base_uri 'api.dp.la'
+    
+    def simple_search(keyword, start = 0, limit = 25)
+      options = {:query => 
+        {:search_type => 'keyword', :query => keyword,
+        :limit => limit, :start => start}
+      }
+      response = self.class.get('/dev/item/', options)
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/blacklight_dpla/solr_doc.rb

@@ -0,0 +1,32 @@
+module BlacklightDpla
+  class SolrDoc
+    
+    def self.index_docs_from_response(response)
+      response['docs'].each do |doc|
+        solr_doc = BlacklightDpla::SolrDoc.from_response_doc doc
+        pp solr_doc
+        pp Blacklight.solr.add solr_doc
+      end
+      pp Blacklight.solr.commit
+    end
+    
+    def self.from_response_doc(doc)
+      solr_doc = {}
+      doc.keys.each do |key|
+        if SOLR_MAPPING.keys.include? key
+          case key
+          when 'audio_format_mp3'
+            m3u = HTTParty.get(doc[key])
+            mp3 = m3u.split.first
+            solr_doc[SOLR_MAPPING[key]] = mp3
+            solr_doc['format'] = 'mp3'
+          else
+            solr_doc[SOLR_MAPPING[key]] = doc[key]
+          end
+        end
+      end
+      solr_doc
+    end
+    
+  end
+end

data/lib/blacklight_dpla/version.rb

@@ -0,0 +1,3 @@
+module BlacklightDpla
+  VERSION = "0.0.1.dev1"
+end

data/lib/blacklight_dpla.rb

@@ -0,0 +1,25 @@
+require 'httparty'
+module BlacklightDpla
+  class Engine < Rails::Engine
+    
+  end
+  
+  SOLR_MAPPING = {
+    'subject' => :subject_topic_facet,
+    'data_source' => :data_source_facet,
+    'format' => :format,
+    'date' => :date_facet,
+    'creator' => :creator_facet,
+    'id' => :id,
+    'title' => :title_display,
+    'language' => :language_facet,
+    'checkouts' => :checkouts_facet,
+    'content_link' => :content_link_display,
+    'audio_format_mp3' => :audio_format_mp3_display,
+    'id_isbn' => :isbn_display
+  }
+  
+end
+
+require 'blacklight_dpla/api'
+require 'blacklight_dpla/solr_doc'

data/lib/generators/blacklight_dpla_generator.rb

@@ -0,0 +1,27 @@
+class BlacklightDplaGenerator < Rails::Generators::Base
+  source_root File.expand_path("../templates", __FILE__)
+  
+  desc "Blacklight DPLA Generator"
+  
+  def update_blacklight_config_facets
+    blacklight_dpla_config = File.read(File.expand_path("../templates/blacklight_dpla_config.rb", __FILE__))
+    insert_into_file 'app/controllers/catalog_controller.rb', blacklight_dpla_config, 
+      :after => "configure_blacklight do |config|\n"
+  end
+  
+  def update_blacklight_config_default_solr_params
+    insert_into_file 'app/controllers/catalog_controller.rb', %Q{\n      :fl => '*', # blacklight_dpla generated code},
+      :after => "config.default_solr_params = {"
+  end
+  
+  def update_solr_dynamic_facets_config
+    gsub_file 'jetty/solr/conf/schema.xml', '<dynamicField name="*_facet" type="string" indexed="true" stored="false" multiValued="true" />',
+      '<dynamicField name="*_facet" type="string" indexed="true" stored="true" multiValued="true" />'
+  end
+  
+  def change_default_app_name
+    insert_into_file 'app/helpers/application_helper.rb', "\n  def application_name\n    'Blacklight DPLA'\n  end\n",
+      :after => 'module ApplicationHelper'
+  end
+  
+end

data/lib/generators/templates/_home_text.html.erb

@@ -0,0 +1,9 @@
+<h3>Welcome!</h3>
+<p>To modify this text to your specifications, copy this file located in the blacklight plugin directory:<br/>
+&nbsp;&nbsp;&nbsp;<%= Blacklight.root %>/app/views/catalog/_home_text.html.erb</p>
+<p>to your top level rails app:<br/>
+&nbsp;&nbsp;&nbsp;<%= Rails.root %>/app/views/catalog/_home_text.html.erb</p>
+Note that you will need to create the 'catalog' directory under views.
+
+<h2>TODO Blacklight DPLA related information</h2>
+<p>TODO Blacklight DPLA</p>

data/lib/generators/templates/blacklight_dpla_config.rb

@@ -0,0 +1,15 @@
+
+    ## blacklight_dpla generated code BEGIN
+    config.add_facet_field 'subject_facet', :label => 'Subject', :limit => 10
+    config.add_facet_field 'creator_facet', :label => 'Creator', :limit => 10
+    config.add_facet_field 'date_facet', :label => 'Date', :limit => 10
+    config.add_facet_field 'checkouts_facet', :label => 'Checkouts', :limit => 10
+    config.add_facet_field 'data_source_facet', :label => 'Data Source', :limit => 10
+    
+    config.add_show_field 'content_link_display', :label => 'Content Link:'
+    config.add_show_field 'data_source_facet', :label => 'Data Source:'
+    config.add_show_field 'date_facet', :label => 'Date:'
+    config.add_show_field 'creator_facet', :label => 'Creator:'
+    config.add_show_field 'checkouts_facet', :label => 'Checkouts:'
+    ## blacklight_dpla generated code END
+    

data/lib/tasks/blacklight_dpla_tasks.rake

@@ -0,0 +1,22 @@
+# desc "Explaining what the task does"
+# task :blacklight_dpla do
+#   # Task goes here
+# end
+require 'pp'
+namespace :dpla do
+  desc 'load DPLA records from query'
+  task :load_query, [:query] => [:environment] do |t, args|
+    query_term = args[:query]
+    # determine how many matches there are
+    response = BlacklightDpla::Api.new.simple_search(query_term, 0, 0)
+    puts response['num_found']
+    # how many batches of 100 do we need to retrieve?
+    num_times = (response['num_found'] / 100.0).ceil
+    # interate over batches of 100 and index them
+    num_times.times do |i|
+      start = i * 100
+      response = BlacklightDpla::Api.new.simple_search(query_term, start, 100)
+      BlacklightDpla::SolrDoc.index_docs_from_response(response)
+    end    
+  end
+end

data/test/api_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+class BlacklightDplaApiTest < ActiveSupport::TestCase
+  
+  setup do
+    @api = BlacklightDpla::Api.new
+  end
+  
+  test "get API response" do
+    response = @api.simple_search('internet', 0, 1)
+    assert response
+  end
+  
+  test "limit set correctly" do
+    response = @api.simple_search('internet', 0, 3)
+    assert_equal '3', response['limit']
+  end
+  
+  test 'documents returned equals limit set' do
+    response = @api.simple_search('internet', 0, 2)
+    assert_equal 2, response['docs'].length
+  end
+  
+  test 'start set correctly' do
+    response = @api.simple_search('internet', 5, 1)
+    assert_equal '5', response['start']
+  end
+  
+end

data/test/blacklight_dpla_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class BlacklightDplaTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, BlacklightDpla
+  end
+    
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.