dbla 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/LICENSE +20 -0
- data/Rakefile +34 -0
- data/app/assets/javascripts/dbla/application.js +13 -0
- data/app/assets/stylesheets/dbla/application.css +15 -0
- data/app/controllers/dbla/application_controller.rb +4 -0
- data/app/helpers/dbla/application_helper.rb +4 -0
- data/app/views/layouts/dbla/application.html.erb +14 -0
- data/config/routes.rb +2 -0
- data/lib/dbla.rb +15 -0
- data/lib/dbla/abstract_response.rb +54 -0
- data/lib/dbla/document_presenter.rb +111 -0
- data/lib/dbla/engine.rb +5 -0
- data/lib/dbla/repository.rb +45 -0
- data/lib/dbla/response.rb +16 -0
- data/lib/dbla/routes.rb +44 -0
- data/lib/dbla/search_builder_behavior.rb +4 -0
- data/lib/dbla/version.rb +3 -0
- data/lib/generators/dbla/models_generator.rb +19 -0
- data/lib/generators/dbla/routes_generator.rb +20 -0
- data/lib/generators/dbla/search_builder_generator.rb +20 -0
- data/lib/generators/dbla/templates/collection.rb +45 -0
- data/lib/generators/dbla/templates/item.rb +45 -0
- data/lib/generators/dbla/templates/search_builder.rb +3 -0
- data/lib/tasks/dbla_key.rake +57 -0
- data/spec/dbla_spec.rb +7 -0
- data/spec/dummy/README.rdoc +28 -0
- data/spec/dummy/Rakefile +6 -0
- data/spec/dummy/app/assets/javascripts/application.js +13 -0
- data/spec/dummy/app/assets/stylesheets/application.css +15 -0
- data/spec/dummy/app/controllers/application_controller.rb +5 -0
- data/spec/dummy/app/helpers/application_helper.rb +2 -0
- data/spec/dummy/app/views/layouts/application.html.erb +14 -0
- data/spec/dummy/bin/bundle +3 -0
- data/spec/dummy/bin/rails +4 -0
- data/spec/dummy/bin/rake +4 -0
- data/spec/dummy/config.ru +4 -0
- data/spec/dummy/config/application.rb +23 -0
- data/spec/dummy/config/boot.rb +5 -0
- data/spec/dummy/config/database.yml +25 -0
- data/spec/dummy/config/environment.rb +5 -0
- data/spec/dummy/config/environments/development.rb +37 -0
- data/spec/dummy/config/environments/production.rb +78 -0
- data/spec/dummy/config/environments/test.rb +39 -0
- data/spec/dummy/config/initializers/assets.rb +8 -0
- data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
- data/spec/dummy/config/initializers/cookies_serializer.rb +3 -0
- data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
- data/spec/dummy/config/initializers/inflections.rb +16 -0
- data/spec/dummy/config/initializers/mime_types.rb +4 -0
- data/spec/dummy/config/initializers/session_store.rb +3 -0
- data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
- data/spec/dummy/config/locales/en.yml +23 -0
- data/spec/dummy/config/routes.rb +4 -0
- data/spec/dummy/config/secrets.yml +22 -0
- data/spec/dummy/db/test.sqlite3 +0 -0
- data/spec/dummy/log/test.log +0 -0
- data/spec/dummy/public/404.html +67 -0
- data/spec/dummy/public/422.html +67 -0
- data/spec/dummy/public/500.html +66 -0
- data/spec/dummy/public/favicon.ico +0 -0
- data/spec/spec_helper.rb +11 -0
- metadata +215 -0
@@ -0,0 +1,20 @@
|
|
1
|
+
module Dbla
|
2
|
+
class RoutesGenerator < Rails::Generators::Base
|
3
|
+
|
4
|
+
source_root File.expand_path('../templates', __FILE__)
|
5
|
+
|
6
|
+
argument :controller_name , type: :string , default: "catalog"
|
7
|
+
|
8
|
+
desc """
|
9
|
+
This generator makes the following changes to your application:
|
10
|
+
1. Adds routes for your controller
|
11
|
+
"""
|
12
|
+
|
13
|
+
def inject_blacklight_routes
|
14
|
+
# These will end up in routes.rb file in reverse order
|
15
|
+
# we add em, since each is added at the top of file.
|
16
|
+
# we want "root" to be FIRST for optimal url generation.
|
17
|
+
route("Dbla::Routes.for(self, :#{controller_name})")
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
@@ -0,0 +1,20 @@
|
|
1
|
+
require 'rails/generators'
|
2
|
+
|
3
|
+
module Dbla
|
4
|
+
class SearchBuilderGenerator < Rails::Generators::Base
|
5
|
+
include Rails::Generators::Migration
|
6
|
+
|
7
|
+
source_root File.expand_path('../templates', __FILE__)
|
8
|
+
|
9
|
+
argument :model_name, :type => :string , :default => "search_builder"
|
10
|
+
|
11
|
+
desc """
|
12
|
+
This generator makes the following changes to your application:
|
13
|
+
1. Creates a blacklight search builder in your /app/models directory
|
14
|
+
"""
|
15
|
+
def create_search_builder
|
16
|
+
template "search_builder.rb", "app/models/#{model_name}.rb"
|
17
|
+
end
|
18
|
+
|
19
|
+
end
|
20
|
+
end
|
@@ -0,0 +1,45 @@
|
|
1
|
+
# -*- encoding : utf-8 -*-
|
2
|
+
class Collection
|
3
|
+
|
4
|
+
include Blacklight::Solr::Document
|
5
|
+
# The following shows how to setup this blacklight document to display marc documents
|
6
|
+
extension_parameters[:marc_source_field] = :marc_display
|
7
|
+
extension_parameters[:marc_format_type] = :marcxml
|
8
|
+
use_extension( Blacklight::Solr::Document::Marc) do |document|
|
9
|
+
document.key?( :marc_display )
|
10
|
+
end
|
11
|
+
|
12
|
+
field_semantics.merge!(
|
13
|
+
:title => "title_display",
|
14
|
+
:author => "author_display",
|
15
|
+
:language => "language_facet",
|
16
|
+
:format => "format"
|
17
|
+
)
|
18
|
+
|
19
|
+
|
20
|
+
|
21
|
+
# self.unique_key = 'id'
|
22
|
+
|
23
|
+
# Email uses the semantic field mappings below to generate the body of an email.
|
24
|
+
SolrDocument.use_extension( Blacklight::Document::Email )
|
25
|
+
|
26
|
+
# SMS uses the semantic field mappings below to generate the body of an SMS email.
|
27
|
+
SolrDocument.use_extension( Blacklight::Document::Sms )
|
28
|
+
|
29
|
+
# DublinCore uses the semantic field mappings below to assemble an OAI-compliant Dublin Core document
|
30
|
+
# Semantic mappings of solr stored fields. Fields may be multi or
|
31
|
+
# single valued. See Blacklight::Document::SemanticFields#field_semantics
|
32
|
+
# and Blacklight::Document::SemanticFields#to_semantic_values
|
33
|
+
# Recommendation: Use field names from Dublin Core
|
34
|
+
use_extension( Blacklight::Document::DublinCore)
|
35
|
+
|
36
|
+
def has? f, *values
|
37
|
+
# these are shenanigans to find a nested field
|
38
|
+
if f.is_a? String and f.index('/')
|
39
|
+
f = f.split('/')
|
40
|
+
f.inject(self) {|m,v| (m || {})[v]}
|
41
|
+
else
|
42
|
+
super
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
@@ -0,0 +1,45 @@
|
|
1
|
+
# -*- encoding : utf-8 -*-
|
2
|
+
class Item
|
3
|
+
|
4
|
+
include Blacklight::Solr::Document
|
5
|
+
# The following shows how to setup this blacklight document to display marc documents
|
6
|
+
extension_parameters[:marc_source_field] = :marc_display
|
7
|
+
extension_parameters[:marc_format_type] = :marcxml
|
8
|
+
use_extension( Blacklight::Solr::Document::Marc) do |document|
|
9
|
+
document.key?( :marc_display )
|
10
|
+
end
|
11
|
+
|
12
|
+
field_semantics.merge!(
|
13
|
+
:title => "title_display",
|
14
|
+
:author => "author_display",
|
15
|
+
:language => "language_facet",
|
16
|
+
:format => "format"
|
17
|
+
)
|
18
|
+
|
19
|
+
|
20
|
+
|
21
|
+
# self.unique_key = 'id'
|
22
|
+
|
23
|
+
# Email uses the semantic field mappings below to generate the body of an email.
|
24
|
+
SolrDocument.use_extension( Blacklight::Document::Email )
|
25
|
+
|
26
|
+
# SMS uses the semantic field mappings below to generate the body of an SMS email.
|
27
|
+
SolrDocument.use_extension( Blacklight::Document::Sms )
|
28
|
+
|
29
|
+
# DublinCore uses the semantic field mappings below to assemble an OAI-compliant Dublin Core document
|
30
|
+
# Semantic mappings of solr stored fields. Fields may be multi or
|
31
|
+
# single valued. See Blacklight::Document::SemanticFields#field_semantics
|
32
|
+
# and Blacklight::Document::SemanticFields#to_semantic_values
|
33
|
+
# Recommendation: Use field names from Dublin Core
|
34
|
+
use_extension( Blacklight::Document::DublinCore)
|
35
|
+
|
36
|
+
def has? f, *values
|
37
|
+
# these are shenanigans to find a nested field
|
38
|
+
if f.is_a? String and f.index('/')
|
39
|
+
f = f.split('/')
|
40
|
+
f.inject(self) {|m,v| (m || {})[v]}
|
41
|
+
else
|
42
|
+
super
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
@@ -0,0 +1,57 @@
|
|
1
|
+
# -*- encoding : utf-8 -*-
|
2
|
+
require 'net/http'
|
3
|
+
module Dbla
|
4
|
+
module ApiKey
|
5
|
+
RESOURCE = 'http://api.dp.la/v2/api_key/'.freeze
|
6
|
+
USAGE = {
|
7
|
+
get: " rake Dbla:key:get email=YOUR.EMAIL@SERVER.ORG",
|
8
|
+
config: " rake Dbla:key:config key=YOURKEY000000000000000000000000",
|
9
|
+
report: " rake Dbla:key:report",
|
10
|
+
}
|
11
|
+
def self.usage(key=:all)
|
12
|
+
puts "Usage:"
|
13
|
+
USAGE.select {|k,v| k == key || key == :all}.each{|k,v| puts v}
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
17
|
+
namespace :Dbla do
|
18
|
+
namespace :key do
|
19
|
+
task get: :environment do
|
20
|
+
if ENV['email']
|
21
|
+
uri = URI(RESOURCE + email)
|
22
|
+
Net::HTTP.start(uri.host, uri.port) do |http|
|
23
|
+
request = Net::HTTP::Post.new uri
|
24
|
+
response = http.request request
|
25
|
+
puts response.body
|
26
|
+
puts "after receiving your api key run:"
|
27
|
+
Dbla::ApiKey.usage(:config)
|
28
|
+
open(Dbla.config_path,'w') do |blob|
|
29
|
+
blob.write YAML.dump('api_email' => ENV['email'],'url' =>'http://api.dp.la/v2/')
|
30
|
+
end
|
31
|
+
end
|
32
|
+
else
|
33
|
+
Dbla::ApiKey.usage(:get)
|
34
|
+
end
|
35
|
+
end
|
36
|
+
task report: :environment do
|
37
|
+
if File.exists? Dbla.config_path
|
38
|
+
Dbla.config.each {|k,v| puts "#{k}: #{v}"}
|
39
|
+
else
|
40
|
+
puts "no config found at #{Dbla.config_path}"
|
41
|
+
Dbla::ApiKey.usage(:report)
|
42
|
+
end
|
43
|
+
end
|
44
|
+
task config: :environment do
|
45
|
+
if ENV['key']
|
46
|
+
open(Dbla.config_path,'a') do |blob|
|
47
|
+
blob.write YAML.dump('api_key' => ENV['key'])
|
48
|
+
end
|
49
|
+
else
|
50
|
+
Dbla::ApiKey.usage(:config)
|
51
|
+
end
|
52
|
+
end
|
53
|
+
task usage: :environment do
|
54
|
+
Dbla::ApiKey.usage
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
data/spec/dbla_spec.rb
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
== README
|
2
|
+
|
3
|
+
This README would normally document whatever steps are necessary to get the
|
4
|
+
application up and running.
|
5
|
+
|
6
|
+
Things you may want to cover:
|
7
|
+
|
8
|
+
* Ruby version
|
9
|
+
|
10
|
+
* System dependencies
|
11
|
+
|
12
|
+
* Configuration
|
13
|
+
|
14
|
+
* Database creation
|
15
|
+
|
16
|
+
* Database initialization
|
17
|
+
|
18
|
+
* How to run the test suite
|
19
|
+
|
20
|
+
* Services (job queues, cache servers, search engines, etc.)
|
21
|
+
|
22
|
+
* Deployment instructions
|
23
|
+
|
24
|
+
* ...
|
25
|
+
|
26
|
+
|
27
|
+
Please feel free to use a different markup language if you do not plan to run
|
28
|
+
<tt>rake doc:app</tt>.
|
data/spec/dummy/Rakefile
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
// This is a manifest file that'll be compiled into application.js, which will include all the files
|
2
|
+
// listed below.
|
3
|
+
//
|
4
|
+
// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
|
5
|
+
// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
|
6
|
+
//
|
7
|
+
// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
|
8
|
+
// compiled file.
|
9
|
+
//
|
10
|
+
// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
|
11
|
+
// about supported directives.
|
12
|
+
//
|
13
|
+
//= require_tree .
|
@@ -0,0 +1,15 @@
|
|
1
|
+
/*
|
2
|
+
* This is a manifest file that'll be compiled into application.css, which will include all the files
|
3
|
+
* listed below.
|
4
|
+
*
|
5
|
+
* Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
|
6
|
+
* or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
|
7
|
+
*
|
8
|
+
* You're free to add application-wide styles to this file and they'll appear at the bottom of the
|
9
|
+
* compiled file so the styles you add here take precedence over styles defined in any styles
|
10
|
+
* defined in the other CSS/SCSS files in this directory. It is generally better to create a new
|
11
|
+
* file per style scope.
|
12
|
+
*
|
13
|
+
*= require_tree .
|
14
|
+
*= require_self
|
15
|
+
*/
|
@@ -0,0 +1,14 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<title>Dummy</title>
|
5
|
+
<%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track' => true %>
|
6
|
+
<%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
|
7
|
+
<%= csrf_meta_tags %>
|
8
|
+
</head>
|
9
|
+
<body>
|
10
|
+
|
11
|
+
<%= yield %>
|
12
|
+
|
13
|
+
</body>
|
14
|
+
</html>
|
data/spec/dummy/bin/rake
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
require File.expand_path('../boot', __FILE__)
|
2
|
+
|
3
|
+
require 'rails/all'
|
4
|
+
|
5
|
+
Bundler.require(*Rails.groups)
|
6
|
+
require "dbla"
|
7
|
+
|
8
|
+
module Dummy
|
9
|
+
class Application < Rails::Application
|
10
|
+
# Settings in config/environments/* take precedence over those specified here.
|
11
|
+
# Application configuration should go into files in config/initializers
|
12
|
+
# -- all .rb files in that directory are automatically loaded.
|
13
|
+
|
14
|
+
# Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
|
15
|
+
# Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
|
16
|
+
# config.time_zone = 'Central Time (US & Canada)'
|
17
|
+
|
18
|
+
# The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
|
19
|
+
# config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
|
20
|
+
# config.i18n.default_locale = :de
|
21
|
+
end
|
22
|
+
end
|
23
|
+
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# SQLite version 3.x
|
2
|
+
# gem install sqlite3
|
3
|
+
#
|
4
|
+
# Ensure the SQLite 3 gem is defined in your Gemfile
|
5
|
+
# gem 'sqlite3'
|
6
|
+
#
|
7
|
+
default: &default
|
8
|
+
adapter: sqlite3
|
9
|
+
pool: 5
|
10
|
+
timeout: 5000
|
11
|
+
|
12
|
+
development:
|
13
|
+
<<: *default
|
14
|
+
database: db/development.sqlite3
|
15
|
+
|
16
|
+
# Warning: The database defined as "test" will be erased and
|
17
|
+
# re-generated from your development database when you run "rake".
|
18
|
+
# Do not set this db to the same as development or production.
|
19
|
+
test:
|
20
|
+
<<: *default
|
21
|
+
database: db/test.sqlite3
|
22
|
+
|
23
|
+
production:
|
24
|
+
<<: *default
|
25
|
+
database: db/production.sqlite3
|
@@ -0,0 +1,37 @@
|
|
1
|
+
Rails.application.configure do
|
2
|
+
# Settings specified here will take precedence over those in config/application.rb.
|
3
|
+
|
4
|
+
# In the development environment your application's code is reloaded on
|
5
|
+
# every request. This slows down response time but is perfect for development
|
6
|
+
# since you don't have to restart the web server when you make code changes.
|
7
|
+
config.cache_classes = false
|
8
|
+
|
9
|
+
# Do not eager load code on boot.
|
10
|
+
config.eager_load = false
|
11
|
+
|
12
|
+
# Show full error reports and disable caching.
|
13
|
+
config.consider_all_requests_local = true
|
14
|
+
config.action_controller.perform_caching = false
|
15
|
+
|
16
|
+
# Don't care if the mailer can't send.
|
17
|
+
config.action_mailer.raise_delivery_errors = false
|
18
|
+
|
19
|
+
# Print deprecation notices to the Rails logger.
|
20
|
+
config.active_support.deprecation = :log
|
21
|
+
|
22
|
+
# Raise an error on page load if there are pending migrations.
|
23
|
+
config.active_record.migration_error = :page_load
|
24
|
+
|
25
|
+
# Debug mode disables concatenation and preprocessing of assets.
|
26
|
+
# This option may cause significant delays in view rendering with a large
|
27
|
+
# number of complex assets.
|
28
|
+
config.assets.debug = true
|
29
|
+
|
30
|
+
# Adds additional error checking when serving assets at runtime.
|
31
|
+
# Checks for improperly declared sprockets dependencies.
|
32
|
+
# Raises helpful error messages.
|
33
|
+
config.assets.raise_runtime_errors = true
|
34
|
+
|
35
|
+
# Raises error for missing translations
|
36
|
+
# config.action_view.raise_on_missing_translations = true
|
37
|
+
end
|
@@ -0,0 +1,78 @@
|
|
1
|
+
Rails.application.configure do
|
2
|
+
# Settings specified here will take precedence over those in config/application.rb.
|
3
|
+
|
4
|
+
# Code is not reloaded between requests.
|
5
|
+
config.cache_classes = true
|
6
|
+
|
7
|
+
# Eager load code on boot. This eager loads most of Rails and
|
8
|
+
# your application in memory, allowing both threaded web servers
|
9
|
+
# and those relying on copy on write to perform better.
|
10
|
+
# Rake tasks automatically ignore this option for performance.
|
11
|
+
config.eager_load = true
|
12
|
+
|
13
|
+
# Full error reports are disabled and caching is turned on.
|
14
|
+
config.consider_all_requests_local = false
|
15
|
+
config.action_controller.perform_caching = true
|
16
|
+
|
17
|
+
# Enable Rack::Cache to put a simple HTTP cache in front of your application
|
18
|
+
# Add `rack-cache` to your Gemfile before enabling this.
|
19
|
+
# For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
|
20
|
+
# config.action_dispatch.rack_cache = true
|
21
|
+
|
22
|
+
# Disable Rails's static asset server (Apache or nginx will already do this).
|
23
|
+
config.serve_static_assets = false
|
24
|
+
|
25
|
+
# Compress JavaScripts and CSS.
|
26
|
+
config.assets.js_compressor = :uglifier
|
27
|
+
# config.assets.css_compressor = :sass
|
28
|
+
|
29
|
+
# Do not fallback to assets pipeline if a precompiled asset is missed.
|
30
|
+
config.assets.compile = false
|
31
|
+
|
32
|
+
# Generate digests for assets URLs.
|
33
|
+
config.assets.digest = true
|
34
|
+
|
35
|
+
# `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
|
36
|
+
|
37
|
+
# Specifies the header that your server uses for sending files.
|
38
|
+
# config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
|
39
|
+
# config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
|
40
|
+
|
41
|
+
# Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
|
42
|
+
# config.force_ssl = true
|
43
|
+
|
44
|
+
# Set to :debug to see everything in the log.
|
45
|
+
config.log_level = :info
|
46
|
+
|
47
|
+
# Prepend all log lines with the following tags.
|
48
|
+
# config.log_tags = [ :subdomain, :uuid ]
|
49
|
+
|
50
|
+
# Use a different logger for distributed setups.
|
51
|
+
# config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
|
52
|
+
|
53
|
+
# Use a different cache store in production.
|
54
|
+
# config.cache_store = :mem_cache_store
|
55
|
+
|
56
|
+
# Enable serving of images, stylesheets, and JavaScripts from an asset server.
|
57
|
+
# config.action_controller.asset_host = "http://assets.example.com"
|
58
|
+
|
59
|
+
# Ignore bad email addresses and do not raise email delivery errors.
|
60
|
+
# Set this to true and configure the email server for immediate delivery to raise delivery errors.
|
61
|
+
# config.action_mailer.raise_delivery_errors = false
|
62
|
+
|
63
|
+
# Enable locale fallbacks for I18n (makes lookups for any locale fall back to
|
64
|
+
# the I18n.default_locale when a translation cannot be found).
|
65
|
+
config.i18n.fallbacks = true
|
66
|
+
|
67
|
+
# Send deprecation notices to registered listeners.
|
68
|
+
config.active_support.deprecation = :notify
|
69
|
+
|
70
|
+
# Disable automatic flushing of the log to improve performance.
|
71
|
+
# config.autoflush_log = false
|
72
|
+
|
73
|
+
# Use default logging formatter so that PID and timestamp are not suppressed.
|
74
|
+
config.log_formatter = ::Logger::Formatter.new
|
75
|
+
|
76
|
+
# Do not dump schema after migrations.
|
77
|
+
config.active_record.dump_schema_after_migration = false
|
78
|
+
end
|