blacklight 3.0pre1

data/.gitignore

@@ -0,0 +1,17 @@
+.DS_Store
+.svn
+coverage.data
+coverage/
+db/*.sqlite3
+db/schema.rb
+jetty/logs/*.log
+jetty/solr/data/*
+log/*
+webrat-*
+config/SolrMarc/*.log*
+rerun.txt
+solr_marc/solrmarc.log
+
+*.log
+.bundle
+Gemfile.lock

data/.gitmodules

@@ -0,0 +1,6 @@
+[submodule "test_app/jetty"]
+	path = test_app/jetty
+	url = git://github.com/projectblacklight/blacklight-jetty.git
+[submodule "test_app/data"]
+	path = test_app/data
+	url = git://github.com/projectblacklight/blacklight-data.git

data/.yardopts

@@ -0,0 +1,4 @@
+--protected
+-
+app/**/*.rb
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Please see blacklight.gemspec for dependency information.
+gemspec

data/LICENSE

@@ -0,0 +1,14 @@
+##########################################################################
+# Copyright 2008 Rector and Visitors of the University of Virginia
+#
+# 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.rdoc

@@ -0,0 +1,168 @@
+Please note: The main Blacklight website is http://projectblacklight.org
+
+=Installing Blacklight
+
+== Some background information
+
+Blacklight is open source discovery software. Libraries (or anyone else) can use Blacklight to enable searching and browsing of their collections online. Blacklight uses the Apache SOLR ( http://lucene.apache.org/solr ) search engine to index and search full text and/or metadata, and Blacklight has a highly configurable Ruby on Rails front-end. Blacklight was originally developed at the University of Virginia Library and is made public under an Apache 2.0 license. 
+
+== Install & Use (With Devise)
+
+Create a new rails 3 application
+
+  $ rails new my_app
+
+Add blacklight to your gem file 
+
+  /my_app/Gemfile
+  ...
+  gem 'blackight'
+
+Install blacklight
+
+  $ rails generate blacklight --devise
+
+Run your database migrations
+
+  $ rake db:migrate
+
+Start up your application
+
+  $ rails server
+
+Visit the catalog at:  http://localhost/catalog
+
+
+== Install and Use (with a custom user authentication system)
+
+Blacklight 3 requires Rails 3.0 or greater.
+
+Add the blacklight gem to your ./Gemfile
+
+  gem 'blacklight'
+
+  $ bundle install
+
+If you have a user model already, the Blacklight generator will connect to it automatically during installation.  However, you will need to make sure the following named routes are included in your /config/routes.rb file:
+
+   match 'new_user_session',          :to => 'Your User Session Controller # Log in action'
+   match 'destroy_user_session',      :to => 'Your User Session Controller # Log Out action'
+
+And you will need to make sure the following helper methods are available:
+
+  current_user   - Which should return a user object that include Blacklight::User
+  user_session   - Which should return a user session
+
+Once these are in place, you can run the Blacklight Installation Generator:
+
+  rails generate blacklight
+
+Execute your migrations, and you should be good to go.
+
+  rake db:migrate
+
+Start up your application
+
+  $ rails server
+
+Visit the catalog at:  http://localhost/catalog
+
+== Setting up a development environment
+
+Checkout the code:
+
+  $ git clone git@github.com:projectblacklight/blacklight.git blacklight
+  $ cd blacklight
+
+(While the rails3 branch is still a seperate branch called 'rails3':)
+  $ git checkout -t origin/rails3
+
+Now create a test bed application inside of Blacklight that will allow you
+to include Blacklight as a gem.
+The test_app directory already exists, and contains a .gitignore file that
+will mean all of the generated code is ingored.  - There are a few directories
+already in palce in test_app that WILL be included in the git repository.  These
+include:
+* test_app/features - which contains cucumber tests for blacklight
+* test_app/spec - rspec tests
+* test_app/jetty - The blacklight Jetty module (discussed later)
+* test_app/data - Another remote module.
+
+To create the rails application:
+
+  $ rails new test_app --skip-test-unit --skip-git
+
+Or if you are using Jruby:
+
+  $ jruby -S rails new test_app -m http://jruby.org/rails3.rb --skip-test-unit --skip-git
+
+Add gem 'blacklight' to the test applications Gemfile:
+
+  gem 'blacklight', :path => '../'
+
+Run bundle install in the test app
+  $ bundle install
+
+Install and configure blacklight (with devise setting)
+  $ rails generate blacklight --devise
+
+Remove index.html - which will allow the routes to take you directly to the catalog page.
+  $ rm public/index.html  (allow us to redirect to catalog)
+
+Migrate your database
+  $ rake db:migrate
+
+Get Solr running somewhere.  If you don't have Solr installed, blacklight comes with a default setup.
+  $ cd blacklight
+  $ git submodule init
+  $ git submodule update
+  $ cd test_app
+  $ rake solr:marc:index_test_data RAILS_ENV=test
+  $ cd jetty
+  $ java -jar start.jar
+
+Start up your Server, and take a test run. (from blacklight/test_app)
+  $ rails server
+  
+Now go check it out, should be running.
+
+== Running the tests
+
+You will need to add some gems to your test_app's Gemfile
+
+   group :development, :test do 
+      gem "rspec"
+      gem "rspec-rails", "~>2.5.0"       
+      gem "cucumber-rails"
+      gem "database_cleaner"  
+      gem "capybara"
+      gem "webrat"
+      gem "aruba"
+   end
+
+Run bundle install
+  
+  $ bundle install
+
+Install cucumber
+
+  $ rails generate cucumber:install
+
+If you haven't yet done this to load the bundled jetty/solr environment and test data in your blacklight checkout, from the blacklight checkout dir:
+  git submodule init
+  git submodule update
+
+Load in the test data
+
+  $ rake solr:marc:index_test_data RAILS_ENV=test
+
+Run the tests
+  
+  $ rake solr:spec 
+  $ rake solr:features
+
+==Pre-requisites
+Whichever method you choose for installation, be sure you have all the pre-requisites in place. You can find these detailed in {PRE-REQUISITES}[https://github.com/projectblacklight/blacklight/wiki/PRE-REQUISITES]
+
+==Running solr
+You'll also want some information about how Blacklight expects Apache SOLR ( http://lucene.apache.org/solr ) to run, which you can find in {README_SOLR}[https://github.com/projectblacklight/blacklight/wiki/README_SOLR]

data/Rakefile

@@ -0,0 +1,9 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'

data/app/controllers/bookmarks_controller.rb

@@ -0,0 +1,98 @@
+# note that while this is mostly restful routing, the #update and #destroy actions
+# take the Solr document ID as the :id, NOT the id of the actual Bookmark action. 
+class BookmarksController < ApplicationController
+    
+  before_filter :verify_user
+  
+  # Beware, :id is the Solr document_id, not the actual Bookmark id.
+  # idempotent, as PUT is supposed to be. 
+  # you can also send a bookmark[title] param, which will be used for simplest case
+  # or fall through display of Bookmark in list. 
+  def update
+    bookmark = current_user.existing_bookmark_for(params[:id])
+    if bookmark
+      #update existing one with new values if present
+      bookmark.attributes = params[:bookmark] if params[:bookmark]
+    else
+      # create new one with values and document_id
+      bookmark = current_user.bookmarks.build(params[:bookmark].merge(:document_id => params[:id]))      
+    end
+    
+    success = bookmark.save
+    
+    unless request.xhr?
+      if bookmark.save
+        flash[:notice] = "Successfully added bookmark."
+      else
+        flash[:error] = "Could not save bookmark."
+      end
+      redirect_to :back
+    else
+      #ajaxy request doesn't need a redirect and shouldn't have flash set
+      render :text => "", :status => (success ? "200" : "500" )
+    end    
+  end
+
+  def index
+    @bookmarks = current_user.bookmarks.paginate :page => params[:page]
+  end
+
+  # For adding a single bookmark, suggest use PUT/#update to 
+  # /bookmarks/$docuemnt_id instead.
+  # But this method, accessed via POST to /bookmarks, can be used for
+  # creating multiple bookmarks at once, by posting with keys
+  # such as bookmarks[n][document_id], bookmarks[n][title]. 
+  # It can also be used for creating a single bookmark by including keys
+  # bookmark[title] and bookmark[document_id], but in that case #update
+  # is simpler. 
+  def create
+    @bookmarks = params[:bookmarks] || []
+    @bookmarks << params[:bookmark] if params[:bookmark]
+    
+    success = true
+    @bookmarks.each do |key, bookmark|
+      success = false unless current_user.bookmarks.create(bookmark)
+    end
+    if @bookmarks.length > 0 && success
+      flash[:notice] = "Successfully added bookmarks."      
+    elsif @bookmarks.length > 0
+      flash[:error] = "There was a problem adding bookmarks"      
+    end
+    
+    redirect_to :back
+  end
+  
+  # Beware, :id is the Solr document_id, not the actual Bookmark id.
+  # idempotent, as DELETE is supposed to be. 
+  def destroy
+    bookmark = current_user.existing_bookmark_for(params[:id])
+    
+    success = (!bookmark) || current_user.bookmarks.delete(bookmark)
+    
+    unless request.xhr?
+      if success
+        flash[:notice] = "Successfully removed bookmark."
+      else
+        flash[:error] = "Sorry, there was a problem removing the bookmark."
+      end 
+      redirect_to :back
+    else
+      # ajaxy request needs no redirect and should not have flash set
+      render :text => "", :status => (success ? "200" : "500")
+    end        
+  end
+  
+  def clear    
+    if current_user.bookmarks.clear
+      flash[:notice] = "Cleared your bookmarks."
+    else
+      flash[:error] = "There was a problem clearing your bookmarks."
+    end
+    redirect_to :action => "index"
+  end
+  
+  protected
+  def verify_user
+    flash[:notice] = "Please log in to manage and view your bookmarks." and raise Blacklight::Exceptions::AccessDenied  unless current_user
+  end
+end

data/app/controllers/feedback_controller.rb

@@ -0,0 +1,37 @@
+class FeedbackController < ApplicationController
+  
+  # http://expressica.com/simple_captcha/
+  # include SimpleCaptcha::ControllerHelpers
+  
+  # show the feedback form
+  def show
+    @errors=[]
+    if request.post?
+      if validate
+        Notifier.feedback(params)
+        redirect_to feedback_complete_path
+      end
+    end
+  end
+  
+  protected
+  
+  # validates the incoming params
+  # returns either an empty array or an array with error messages
+  def validate
+    unless params[:name] =~ /\w+/
+      @errors << 'A valid name is required'
+    end
+    unless params[:email] =~ /\w+@\w+\.\w+/
+      @errors << 'A valid email address is required'
+    end
+    unless params[:message] =~ /\w+/
+      @errors << 'A message is required'
+    end
+    #unless simple_captcha_valid?
+    #  @errors << 'Captcha did not match'
+    #end
+    @errors.empty?
+  end
+  
+end

data/app/controllers/folder_controller.rb

@@ -0,0 +1,49 @@
+class FolderController < ApplicationController
+
+  include Blacklight::SolrHelper
+
+  # fetch the documents that match the ids in the folder
+  def index
+    @response, @documents = get_solr_response_for_field_values("id",session[:folder_document_ids] || [])
+  end
+    
+
+  # add a document_id to the folder. :id of action is solr doc id 
+  def update
+    session[:folder_document_ids] = session[:folder_document_ids] || []
+    session[:folder_document_ids] << params[:id] 
+    # Rails 3 uses a one line notation for setting the flash notice.
+    #    flash[:notice] = "#{params[:title] || "Item"} successfully added to Folder"
+    respond_to do |format|
+      format.html { redirect_to :back, :notice =>  "#{params[:title] || "Item"} successfully added to Folder"}
+      format.js { render :json => session[:folder_document_ids] }
+    end
+  end
+ 
+  # remove a document_id from the folder. :id of action is solr_doc_id
+  def destroy
+    session[:folder_document_ids].delete(params[:id])
+    
+    unless request.xhr?      
+      respond_to do |format|
+        format.html do
+          flash[:notice] = "#{params[:title] || "Item"} successfully removed from selected items"
+          redirect_to :back
+        end
+      end
+    else
+      render :text => "OK"
+    end        
+  end
+ 
+  # get rid of the items in the folder
+  def clear
+    flash[:notice] = "Cleared Selected Items"
+    session[:folder_document_ids] = []
+    respond_to do |format|
+      format.html { redirect_to :back }
+      format.js { render :json => session[:folder_document_ids] }
+    end
+  end
+ 
+end

data/app/controllers/saved_searches_controller.rb

@@ -0,0 +1,45 @@
+class SavedSearchesController < ApplicationController
+  before_filter :verify_user 
+  
+  def index
+    @searches = current_user.searches
+  end
+  
+  def save    
+    current_user.searches << Search.find(params[:id])
+    if current_user.save
+      flash[:notice] = "Successfully saved your search."
+    else
+      flash[:error] = "The was a problem saving your search."
+    end
+    redirect_to :back
+  end
+
+  # Only dereferences the user rather than removing the item in case it
+  # is in the session[:history]
+  def forget
+    if current_user.search_ids.include?(params[:id].to_i) && Search.update(params[:id].to_i, :user_id => nil)
+      flash[:notice] = "Successfully removed that saved search."
+    else
+      flash[:error] = "Couldn't remove that saved search."
+    end
+    redirect_to :back
+  end
+  
+  # Only dereferences the user rather than removing the items in case they
+  # are in the session[:history]
+  def clear    
+    if Search.update_all("user_id = NULL", "user_id = #{current_user.id}")
+      flash[:notice] = "Cleared your saved searches."
+    else
+      flash[:error] = "There was a problem clearing your saved searches."
+    end
+    redirect_to :action => "index"
+  end
+
+
+  protected
+  def verify_user
+    flash[:notice] = "Please log in to manage and view your saved searches." and raise Blacklight::Exceptions::AccessDenied unless current_user
+  end
+end