blacklight_google_analytics 0.0.1.pre1

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.md

@@ -0,0 +1,61 @@
+# Blacklight Google Analytics
+
+A gem plugin which adds support for Google Analytics and event tracking to a 
+[Blacklight](http://projectblacklight.org/) Rails application.
+
+# Installation
+
+1. Install [Blacklight](https://github.com/projectblacklight/blacklight) using the
+  [Quickstart guide](https://github.com/projectblacklight/blacklight/wiki/Quickstart).
+2. Add `gem 'blacklight_google_analytics'` to your `Gemfile`
+3. Run the generator: `rails g blacklight_google_analytics`. This adds an initializer
+  (see next step) and adds a couple lines to `app/assets/javascripts/application.js`.
+4. Edit `config/initializers/blacklight_google_analytics.rb` to include your own Google Web id.
+  You will need a [Google Analytics account](http://www.google.com/analytics/) and
+  profile. You will not need to copy in the async snippet. You will need to
+  verify your profile.
+
+# Usage
+
+Google Analytics tracking code is only turned on in production. Both page tracking
+and Blacklight-specific event tracking is turned on.
+
+In development Google Analytics tracking is turned off. Tracking parameters are
+sent to the browser's console to allow you to see what parameters will
+be sent to Google Analytics for various actions. 
+
+Here's an example of event tracking. This is the output to the browser console 
+when clicking on the Format facet,
+selecting the "Book" facet value, and then removing it:
+
+```
+["facets", "collapse_expand", "Format"]
+["facets", "Format", "Book"]
+["facets", "Format", "[remove]"]
+```
+
+These parameters are the category, action, and label according to the Google
+Analytics [event tracking documentation](http://code.google.com/apis/analytics/docs/tracking/eventTrackerGuide.html).
+This event tracking information shows up in Google Analytics under Content > Events.
+
+# Customizing Blacklight for event tracking
+
+You can add other links (e.g. `a` elements) to the page and they will be tracked
+automatically. If you give your link an `id` attribute, that will be used for
+the category. Otherwise, the id of the first parent element with an id attribute 
+will be used as the category.
+
+You may also add your own jQuery click handlers to add more event tracking. 
+Look at the current handlers to see how to set up a tracking event and enable
+console.log in development.
+
+# Author
+
+Jason Ronallo
+
+Based on [code from Brian Cray](http://briancray.com/2009/12/29/understanding-user-behavior-google-analytics-event-tracking-jquery/).
+
+# 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    = 'BlacklightGoogleAnalytics'
+  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/assets/javascripts/blacklight_google_analytics.js.erb

@@ -0,0 +1,77 @@
+$(function () {
+  
+  BlacklightGoogleAnalytics = {}
+  
+  // Necessary to leave some time for the async GA code to run before the browser
+  // stops javascript execution and sends the user to the new page.
+  BlacklightGoogleAnalytics.pause = function(){
+    // pause to allow google script to run before going to new page
+		var date = new Date();
+		var curDate = null;
+		do {
+			curDate = new Date();
+		} while(curDate-date < 300);
+  }
+  
+  BlacklightGoogleAnalytics.console_log_error = function(err, values){
+    <% if Rails.env == 'development' %>
+    // good place to log in development
+    console.log(err);
+    console.log(values);
+    <% end %>
+  }
+  
+  BlacklightGoogleAnalytics.this_or_parent_id = function(that){
+    if (that.get(0).id.length > 0){
+      var identifier = that.get(0).id;
+    } else {
+      var identifier = that.parents('[id]:first').get(0).id;
+    }
+    return identifier;
+  }
+  
+	// all links get tracked
+  $('a').click(function () {
+		// tell analytics to save event
+		try {
+      var identifier = BlacklightGoogleAnalytics.this_or_parent_id($(this));  
+      // for facets we make the action the facet heading
+      if (identifier === 'facets') {
+        var action = $(this).parents("div:first").find("h3:first").text();
+      } else {
+        var action = 'clicked';
+      }      
+      var label = ($(this).text() || $(this).children('img:first').attr('alt'));
+			_gaq.push(['_trackEvent', identifier, action, label]);
+		} catch (err) {
+      BlacklightGoogleAnalytics.console_log_error(err, [identifier, action, label]);
+    }
+    BlacklightGoogleAnalytics.pause();		
+	}); 
+  
+  $('input,select').click(function(){
+    try {
+      var identifier = BlacklightGoogleAnalytics.this_or_parent_id($(this));  
+      var action = 'clicked';
+      var label = $(this).val();
+      _gaq.push(['_trackEvent', identifier, action, label]);
+    } catch (err){
+      BlacklightGoogleAnalytics.console_log_error(err, [identifier, action, label]);
+    }
+    BlacklightGoogleAnalytics.pause();
+  });
+ 
+  
+  //facet expand/collapse
+  $('#facets h3').live('click', function(){
+    var label = $(this).text();
+    var heading_values = ['facets', 'collapse_expand', label];
+    try{
+      _gaq.push(['_trackEvent'].concat(heading_values));
+    } catch(err) {  
+      BlacklightGoogleAnalytics.console_log_error(err, heading_values);
+    }
+  });
+    
+  
+});

data/app/assets/javascripts/google_analytics.js.erb

@@ -0,0 +1,11 @@
+<% if Rails.env == 'production' %>
+var _gaq = _gaq || [];
+_gaq.push(['_setAccount', '<%= BlacklightGoogleAnalytics.web_property_id %>']);
+_gaq.push(['_trackPageview']);
+
+(function() {
+  var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+  ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+  var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+})();
+<% end %>

data/lib/blacklight_google_analytics/version.rb

@@ -0,0 +1,3 @@
+module BlacklightGoogleAnalytics
+  VERSION = "0.0.1.pre1"
+end

data/lib/blacklight_google_analytics.rb

@@ -0,0 +1,11 @@
+require 'blacklight_google_analytics/version'
+
+module BlacklightGoogleAnalytics
+  
+  mattr_accessor :web_property_id
+  
+  class Engine < Rails::Engine
+    
+  end
+  
+end

data/lib/generators/blacklight_google_analytics_generator.rb

@@ -0,0 +1,23 @@
+class BlacklightGoogleAnalyticsGenerator < Rails::Generators::Base
+  source_root File.expand_path("../templates", __FILE__)
+  
+  desc "Blacklight Google Analytics Generator"    
+  
+  def create_blacklight_google_analytics_initializer
+    initializer "blacklight_google_analytics.rb", 
+      "# Change to your Google Web id \nBlacklightGoogleAnalytics.web_property_id = 'UA-XXXXX-X'"
+  end
+  
+  def add_javascripts_to_applicationjs  
+    application_js = 'app/assets/javascripts/application.js'
+    if !File.exists? application_js
+      create_file application_js
+    end
+    append_to_file application_js,
+      "\n//= require blacklight_google_analytics\n//= require google_analytics"
+  end
+  
+  def show_readme      
+    readme "README" if behavior == :invoke
+  end
+end

data/lib/generators/templates/README

@@ -0,0 +1 @@
+Edit `config/initializers/blacklight_google_analytics.rb` to include your own Google Web id.

data/lib/tasks/blacklight_google_analytics_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :blacklight_google_analytics do
+#   # Task goes here
+# end

data/test/blacklight_google_analytics_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class BlacklightGoogleAnalyticsTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, BlacklightGoogleAnalytics
+  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.

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,22 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//
+// Required by Blacklight
+//= require jquery-ui
+//= require blacklight/blacklight
+//= require_tree .
+
+//= require blacklight_google_analytics
+//= require google_analytics

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,20 @@
+/*
+ * Required by Blacklight:
+ *= require 'jquery/ui-lightness/jquery-ui-1.8.1.custom.css'
+ *
+ * This is the default theme. You can modify many of the settings 
+ * by editing your local app/assets/stylesheets/blacklight_themes/standard.css
+ *= require 'blacklight_themes/standard'         
+ *
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+*/

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/config/application.rb

@@ -0,0 +1,60 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require
+require "blacklight_google_analytics"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    # config.active_record.whitelist_attributes = true
+
+    # Enable the asset pipeline
+    config.assets.enabled = true    
+    # Default SASS Configuration, check out https://github.com/rails/sass-rails for details
+    config.assets.compress = !Rails.env.development?
+
+
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end
+