commonwealth-vlr-engine 0.0.1

data/lib/generators/commonwealth_vlr_engine/routes_generator.rb

@@ -0,0 +1,39 @@
+require 'rails/generators'
+
+module CommonwealthVlrEngine
+  class RoutesGenerator < Rails::Generators::Base
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc """
+  This generator makes the following changes to your application:
+   1. Injects route declarations into your routes.rb
+   2. Removes default routes from basic Blacklight install.
+  Thank you for installing Commonwealth VLR.
+         """
+
+    # Add CommonwealthVlrEngine to the routes
+    def inject_vlr_routes
+      unless IO.read("config/routes.rb").include?('CommonwealthVlrEngine::Engine')
+        marker = 'Rails.application.routes.draw do'
+        insert_into_file "config/routes.rb", :after => marker do
+          %q{
+
+  root :to => 'pages#home'
+
+  # routes for CommonwealthVlrEngine
+  mount CommonwealthVlrEngine::Engine => '/commonwealth-vlr-engine'
+
+  # user authentication
+  devise_for :users, :controllers => {:omniauth_callbacks => "users/omniauth_callbacks", :registrations => "users/registrations", :sessions => "users/sessions"}
+}
+        end
+
+        bl_root_marker = 'root to: "catalog#index"'
+        gsub_file("config/routes.rb", bl_root_marker, "")
+
+      end
+    end
+
+  end
+end

data/lib/generators/commonwealth_vlr_engine/templates/commonwealth_vlr_engine.css.scss

@@ -0,0 +1,4 @@
+/* this file imports the styles for commonwealth-vlr-engine */
+/* $header_logo_image: 'your_header_logo_file.png'; /* uncomment this line to use local image for header */
+/* $footer_logo_image: 'your_footer_logo_file.png'; /* uncomment this line to use local image for footer */
+@import 'commonwealth-vlr-engine/commonwealth-vlr-engine';

data/lib/generators/commonwealth_vlr_engine/templates/config/contact_emails.yml.sample

@@ -0,0 +1,13 @@
+# stores contact emails for BPL and DC contacts
+
+development:
+  site_admin: site_admin_email_address@example.org
+  image_requests: image_requests_email_address@example.org
+
+test:
+  site_admin: site_admin_email_address@example.org
+  image_requests: image_requests_email_address@example.org
+
+production:
+  site_admin: site_admin_email_address@example.org
+  image_requests: image_requests_email_address@example.org

data/lib/generators/commonwealth_vlr_engine/templates/config/fedora.yml.sample

@@ -0,0 +1,6 @@
+development:
+  url: http://127.0.0.1:8983/fedora
+test: &TEST
+  url: <%= "http://127.0.0.1:#{ENV['TEST_JETTY_PORT'] || 8983}/fedora-test" %>
+production:
+  url: http://your.production.server:8080/fedora

data/lib/generators/commonwealth_vlr_engine/templates/config/geojson_static_file.yml.sample

@@ -0,0 +1,11 @@
+# stores path to static file with GeoJSON FeatureCollection for catalog#map
+# Rails.root.to_s + '/' must be appended by methods calling this value (makes specs easier)
+
+development:
+  filepath: 'lib/assets/static_geojson_catalog-map.json'
+
+test:
+  filepath: 'lib/assets/static_geojson_catalog-map.json'
+
+production:
+  filepath: 'lib/assets/static_geojson_catalog-map.json'

data/lib/generators/commonwealth_vlr_engine/templates/config/google_analytics.yml.sample

@@ -0,0 +1,10 @@
+# stores Google Analytics web property id
+
+development:
+  web_property_id:
+
+test:
+  web_property_id:
+
+production:
+  web_property_id:

data/lib/generators/commonwealth_vlr_engine/templates/config/iiif_server.yml.sample

@@ -0,0 +1,10 @@
+# stores IIIF image server url
+
+development:
+  url: http://iiifserver.example.org/
+
+test:
+  url:
+
+production:
+  url:

data/lib/generators/commonwealth_vlr_engine/templates/config/initializers/a_load_commonwealth_vlr_configs.rb

@@ -0,0 +1,14 @@
+# various app-specific config settings
+# use file name "a_load_commonwealth_vlr_configs" so Rails loads this file before other initializers
+
+FEDORA_URL = YAML.load_file(Rails.root.join('config', 'fedora.yml'))[Rails.env]
+
+GOOGLE_ANALYTICS = YAML.load_file(Rails.root.join('config', 'google_analytics.yml'))[Rails.env]
+
+CONTACT_EMAILS = YAML.load_file(Rails.root.join('config', 'contact_emails.yml'))[Rails.env]
+
+IIIF_SERVER = YAML.load_file(Rails.root.join('config', 'iiif_server.yml'))[Rails.env]
+
+GEOJSON_STATIC_FILE = YAML.load_file(Rails.root.join('config', 'geojson_static_file.yml'))[Rails.env]
+
+SECRETS = YAML.load_file(Rails.root.join('config', 'secrets.yml'))[Rails.env]

data/lib/generators/commonwealth_vlr_engine/templates/config/initializers/devise.rb

@@ -0,0 +1,269 @@
+# Use this hook to configure devise mailer, warden hooks and so forth.
+# Many of these configuration options can be set straight in your model.
+Devise.setup do |config|
+
+  # Rails 4 upgrade
+  config.secret_key = SECRETS['devise_secret_key']
+
+  # ==> Mailer Configuration
+  # Configure the e-mail address which will be shown in Devise::Mailer,
+  # note that it will be overwritten if you use your own mailer class with default "from" parameter.
+  config.mailer_sender = CONTACT_EMAILS['site_admin']
+
+  # Configure the class responsible to send e-mails.
+  # config.mailer = "Devise::Mailer"
+
+  # ==> ORM configuration
+  # Load and configure the ORM. Supports :active_record (default) and
+  # :mongoid (bson_ext recommended) by default. Other ORMs may be
+  # available as additional gems.
+  require 'devise/orm/active_record'
+
+  # ==> Configuration for any authentication mechanism
+  # Configure which keys are used when authenticating a user. The default is
+  # just :email. You can configure it to use [:username, :subdomain], so for
+  # authenticating a user, both parameters are required. Remember that those
+  # parameters are used only when authenticating and not when retrieving from
+  # session. If you need permissions, you should implement that in a before filter.
+  # You can also supply a hash where the value is a boolean determining whether
+  # or not authentication should be aborted when the value is not present.
+
+  # fix-login fix!
+  # config.authentication_keys = [ :uid, :provider ]
+  config.authentication_keys = [ :uid ]
+
+  # Configure parameters from the request object used for authentication. Each entry
+  # given should be a request method and it will automatically be passed to the
+  # find_for_authentication method and considered in your model lookup. For instance,
+  # if you set :request_keys to [:subdomain], :subdomain will be used on authentication.
+  # The same considerations mentioned for authentication_keys also apply to request_keys.
+  # config.request_keys = []
+
+  # Configure which authentication keys should be case-insensitive.
+  # These keys will be downcased upon creating or modifying a user and when used
+  # to authenticate or find a user. Default is :email.
+
+  # fix-login fix!
+  # config.case_insensitive_keys = [ :uid, :provider ]
+  config.case_insensitive_keys = [ :uid ]
+
+  # Configure which authentication keys should have whitespace stripped.
+  # These keys will have whitespace before and after removed upon creating or
+  # modifying a user and when used to authenticate or find a user. Default is :email.
+
+  # fix-login fix!
+  # config.strip_whitespace_keys = [ :uid, :provider ]
+  config.strip_whitespace_keys = [ :uid ]
+
+  # Tell if authentication through request.params is enabled. True by default.
+  # It can be set to an array that will enable params authentication only for the
+  # given strategies, for example, `config.params_authenticatable = [:database]` will
+  # enable it only for database (email + password) authentication.
+  # config.params_authenticatable = true
+
+  # Tell if authentication through HTTP Basic Auth is enabled. False by default.
+  # It can be set to an array that will enable http authentication only for the
+  # given strategies, for example, `config.http_authenticatable = [:token]` will
+  # enable it only for token authentication.
+  # config.http_authenticatable = false
+
+  # If http headers should be returned for AJAX requests. True by default.
+  # config.http_authenticatable_on_xhr = true
+
+  # The realm used in Http Basic Authentication. "Application" by default.
+  # config.http_authentication_realm = "Application"
+
+  # It will change confirmation, password recovery and other workflows
+  # to behave the same regardless if the e-mail provided was right or wrong.
+  # Does not affect registerable.
+  # config.paranoid = true
+
+  # By default Devise will store the user in session. You can skip storage for
+  # :http_auth and :token_auth by adding those symbols to the array below.
+  # Notice that if you are skipping storage for all authentication paths, you
+  # may want to disable generating routes to Devise's sessions controller by
+  # passing :skip => :sessions to `devise_for` in your config/routes.rb
+  config.skip_session_storage = [:http_auth]
+
+  # ==> Configuration for :database_authenticatable
+  # For bcrypt, this is the cost for hashing the password and defaults to 10. If
+  # using other encryptors, it sets how many times you want the password re-encrypted.
+  #
+  # Limiting the stretches to just one in testing will increase the performance of
+  # your test suite dramatically. However, it is STRONGLY RECOMMENDED to not use
+  # a value less than 10 in other environments.
+  config.stretches = Rails.env.test? ? 1 : 10
+
+  # Setup a pepper to generate the encrypted password.
+  # config.pepper = "9f1215eee7c0a54ea396a8127aa2b80279e6d60d7df395f39d01ea32db6e073c9617d18c098817a3a60bda550f07feab9ceed36d2f66c9294725d74b3c8b645d"
+
+  # ==> Configuration for :confirmable
+  # A period that the user is allowed to access the website even without
+  # confirming his account. For instance, if set to 2.days, the user will be
+  # able to access the website for two days without confirming his account,
+  # access will be blocked just in the third day. Default is 0.days, meaning
+  # the user cannot access the website without confirming his account.
+  # config.allow_unconfirmed_access_for = 2.days
+
+  # If true, requires any email changes to be confirmed (exactly the same way as
+  # initial account confirmation) to be applied. Requires additional unconfirmed_email
+  # db field (see migrations). Until confirmed new email is stored in
+  # unconfirmed email column, and copied to email column on successful confirmation.
+  config.reconfirmable = true
+
+  # Defines which key will be used when confirming an account
+  # config.confirmation_keys = [ :email ]
+
+  # ==> Configuration for :rememberable
+  # The time the user will be remembered without asking for credentials again.
+  # config.remember_for = 2.weeks
+
+  # If true, extends the user's remember period when remembered via cookie.
+  # config.extend_remember_period = false
+
+  # Options to be passed to the created cookie. For instance, you can set
+  # :secure => true in order to force SSL only cookies.
+  # config.rememberable_options = {}
+
+  # ==> Configuration for :validatable
+  # Range for password length. Default is 6..128.
+
+  # fix-login fix
+  # config.password_length = 6..128
+  config.password_length = 6..128
+
+  # Email regex used to validate email formats. It simply asserts that
+  # an one (and only one) @ exists in the given string. This is mainly
+  # to give user feedback and not to assert the e-mail validity.
+  # config.email_regexp = /\A[^@]+@[^@]+\z/
+
+  # ==> Configuration for :timeoutable
+  # The time you want to timeout the user session without activity. After this
+  # time the user will be asked for credentials again. Default is 30 minutes.
+  # config.timeout_in = 30.minutes
+
+  # If true, expires auth token on session timeout.
+  # config.expire_auth_token_on_timeout = false
+
+  # ==> Configuration for :lockable
+  # Defines which strategy will be used to lock an account.
+  # :failed_attempts = Locks an account after a number of failed attempts to sign in.
+  # :none            = No lock strategy. You should handle locking by yourself.
+  # config.lock_strategy = :failed_attempts
+
+  # Defines which key will be used when locking and unlocking an account
+  # config.unlock_keys = [ :email ]
+
+  # Defines which strategy will be used to unlock an account.
+  # :email = Sends an unlock link to the user email
+  # :time  = Re-enables login after a certain amount of time (see :unlock_in below)
+  # :both  = Enables both strategies
+  # :none  = No unlock strategy. You should handle unlocking by yourself.
+  # config.unlock_strategy = :both
+
+  # Number of authentication tries before locking an account if lock_strategy
+  # is failed attempts.
+  # config.maximum_attempts = 20
+
+  # Time interval to unlock the account if :time is enabled as unlock_strategy.
+  # config.unlock_in = 1.hour
+
+  # ==> Configuration for :recoverable
+  #
+  # Defines which key will be used when recovering the password for an account
+  # config.reset_password_keys = [ :email ]
+
+  # Time interval you can reset your password with a reset password key.
+  # Don't put a too small interval or your users won't have the time to
+  # change their passwords.
+  config.reset_password_within = 6.hours
+
+  # ==> Configuration for :encryptable
+  # Allow you to use another encryption algorithm besides bcrypt (default). You can use
+  # :sha1, :sha512 or encryptors from others authentication tools as :clearance_sha1,
+  # :authlogic_sha512 (then you should set stretches above to 20 for default behavior)
+  # and :restful_authentication_sha1 (then you should set stretches to 10, and copy
+  # REST_AUTH_SITE_KEY to pepper)
+  # config.encryptor = :sha512
+
+  # ==> Configuration for :token_authenticatable
+  # Defines name of the authentication token params key
+  # config.token_authentication_key = :auth_token
+
+  # ==> Scopes configuration
+  # Turn scoped views on. Before rendering "sessions/new", it will first check for
+  # "users/sessions/new". It's turned off by default because it's slower if you
+  # are using only default views.
+  # config.scoped_views = false
+
+  # Configure the default scope given to Warden. By default it's the first
+  # devise role declared in your routes (usually :user).
+  # config.default_scope = :user
+
+  # Set this configuration to false if you want /users/sign_out to sign out
+  # only the current scope. By default, Devise signs out all scopes.
+  # config.sign_out_all_scopes = true
+
+  # ==> Navigation configuration
+  # Lists the formats that should be treated as navigational. Formats like
+  # :html, should redirect to the sign in page when the user does not have
+  # access, but formats like :xml or :json, should return 401.
+  #
+  # If you have any extra navigational formats, like :iphone or :mobile, you
+  # should add them to the navigational formats lists.
+  #
+  # The "*/*" below is required to match Internet Explorer requests.
+  # config.navigational_formats = ["*/*", :html]
+
+  # The default HTTP method used to sign out a resource. Default is :delete.
+  config.sign_out_via = :get
+
+  # ==> OmniAuth
+  # Add a new OmniAuth provider. Check the wiki for more information on setting
+  # up on your models and hooks.
+  # config.omniauth :github, 'APP_ID', 'APP_SECRET', :scope => 'user,public_repo'
+  #config.omniauth :ldap, :title => 'BPL admin ldap',
+  #                :host => Hydra::LDAP.ldap_config[:host],
+  #                :base => Hydra::LDAP.ldap_config[:base],
+  #                :uid => Hydra::LDAP.ldap_config[:uid],
+  #                :port => Hydra::LDAP.ldap_config[:port],
+  #                :bind_dn => Hydra::LDAP.ldap_config[:username],
+  #                :password => Hydra::LDAP.ldap_config[:password]
+
+  # fix-login fix
+  #config.omniauth :password, :title => 'BPL local account login',
+  #                :login_field => :username
+
+  OMNIAUTH_POLARIS_GLOBAL = YAML.load_file(Rails.root.join('config', 'omniauth-polaris.yml'))[Rails.env]
+  config.omniauth :polaris, :title => OMNIAUTH_POLARIS_GLOBAL['title'],
+                  :http_uri => OMNIAUTH_POLARIS_GLOBAL['http_uri'],
+                  :access_key => OMNIAUTH_POLARIS_GLOBAL['access_key'],
+                  :access_id => OMNIAUTH_POLARIS_GLOBAL['access_id'],
+                  :method => OMNIAUTH_POLARIS_GLOBAL['method']
+
+  OMNIAUTH_FACEBOOK_GLOBAL = YAML.load_file(Rails.root.join('config', 'omniauth-facebook.yml'))[Rails.env]
+  config.omniauth :facebook, OMNIAUTH_FACEBOOK_GLOBAL['facebook_key'], OMNIAUTH_FACEBOOK_GLOBAL['facebook_secret'], :scope=>OMNIAUTH_FACEBOOK_GLOBAL['facebook_scope']
+
+  # ==> Warden configuration
+  # If you want to use other strategies, that are not supported by Devise, or
+  # change the failure app, you can configure them inside the config.warden block.
+  #
+  # config.warden do |manager|
+  #   manager.intercept_401 = false
+  #   manager.default_strategies(:scope => :user).unshift :some_external_strategy
+  # end
+
+  # ==> Mountable engine configurations
+  # When using Devise inside an engine, let's call it `MyEngine`, and this engine
+  # is mountable, there are some extra configurations to be taken into account.
+  # The following options are available, assuming the engine is mounted as:
+  #
+  #     mount MyEngine, at: "/my_engine"
+  #
+  # The router that invoked `devise_for`, in the example above, would be:
+  # config.router_name = :my_engine
+  #
+  # When using omniauth, Devise cannot automatically set Omniauth path,
+  # so you need to do it manually. For the users scope, it would be:
+  # config.omniauth_path_prefix = "/my_engine/users/auth"
+end

data/lib/generators/commonwealth_vlr_engine/templates/config/initializers/secret_token.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+
+Rails.application.config.secret_key_base = SECRETS['secret_key_base']

data/lib/generators/commonwealth_vlr_engine/templates/config/locales/blacklight.en.yml

@@ -0,0 +1,44 @@
+# this file contains site-specific values
+en:
+
+  blacklight:
+
+    application_name: 'Totally Awesome Library Digital Collections'
+    application_desc: 'This site provides access to materials of historical interest from this totally awesome library.'
+
+    email:
+          reply_to: 'reply_to_email_address@exmaple.org'
+          record_mailer:
+            name: 'Totally Awesome Library'
+            email: 'reply_to_email_address@exmaple.org'
+          text:
+            subject: 'Totally Awesome Library E-mail: link to item'
+
+    feedback:
+          text:
+            subject: 'Totally Awesome Library Digital Collections: contact email'
+
+    footer:
+          address: '123 Main Street, Anywhere, MA 01234'
+    
+    home:
+          banner:
+            center_text: 'Explore historical collections from this totally awesome library.'
+          browse:
+            maps:
+              enabled: true
+            collections:
+              enabled: true
+            institutions:
+              enabled: false
+            formats:
+              enabled: true
+          context:
+            about:
+              title: 'About This Site'
+              text: 'This site provides access to materials of historical interest from this totally awesome library.'
+            news:
+              title: 'News & Announcements'
+              rss_link: 'http://awesomelibrary.org/blog?feed=rss2'
+              blog_title: 'This Awesome Library Blog'
+              blog_url: 'https://awesomelibrary.org/blog'