impressionist 1.0.1 → 1.1.0

data/.gitignore

@@ -0,0 +1,11 @@
+*~
+*.DS_Store
+/coverage
+/pkg
+/rdoc
+/test_app/db/schema.rb
+/test_app/db/migrate/*_create_impressions_table.rb
+/test_app/doc
+/test_app/test
+/test_app/vendor
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+before_install: gem install bundler
+before_script: "cd test_app && bundle install && ./script/rails generate impressionist && bundle exec rake db:migrate && cd .."
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode

data/CHANGELOG.rdoc

@@ -16,4 +16,4 @@
 * @widget.unique_impression_count now uses request_hash.  This was incorrectly stated in the README, since it was using ip_address.  The README is correct as a result of the method change.
 
 == 0.2.4 (2011-02-17)
-* Fix issue #1 - action_name and controller_name were not being logged for impressionist method inside action
+* Fix issue #1 - action_name and controller_name were not being logged for impressionist method inside action

data/Gemfile

@@ -1,24 +1,13 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
-group :development do
-  gem "shoulda", ">= 0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.1"
-  gem "rcov", ">= 0"
+platforms :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter'
+  gem 'jdbc-sqlite3'
+  gem 'jruby-openssl'
 end
 
-group :test do
-  gem 'systemu'
-  gem "rspec"
-  gem "rspec-rails"
-  gem "mongrel", "1.2.0.pre2"
-  gem 'capybara'
-  gem 'database_cleaner'
-  gem 'cucumber-rails'
-  gem 'cucumber'
-  gem 'spork'
-  gem 'launchy'
-  gem 'autotest-notification'
-  gem 'httpclient'
+platforms :ruby, :mswin, :mingw do
+  gem 'sqlite3'
 end
 
+gemspec

data/README.md

@@ -1,29 +1,30 @@
 ![Impressionist Logo](https://github.com/charlotte-ruby/impressionist/raw/master/logo.png)
 
+[![Build Status](https://secure.travis-ci.org/charlotte-ruby/impressionist.png?branch=master)](http://travis-ci.org/charlotte-ruby/impressionist)
+
 impressionist
 =============
 
 A lightweight plugin that logs impressions per action or manually per model
 
-I would not call this a stable plugin yet, although I have been running it in prod with no problems.  Use at your own risk ;-)
-------------------------------------------------------------------------------------------------------------------------------
+--------------------------------------------------------------------------------
 
 What does this thing do?
 ------------------------
-Logs an impression... and I use that term loosely.  It can log page impressions (technically action impressions), but it is not limited to that.
-You can log impressions multiple times per request.  And you can also attach it to a model.  The goal of this project is to provide customizable
-stats that are immediately accessible in your application as opposed to using G Analytics and pulling data using their API.  You can attach custom
-messages to impressions.  No reporting yet.. this thingy just creates the data.
+Logs an impression... and I use that term loosely.  It can log page impressions
+(technically action impressions), but it is not limited to that. You can log
+impressions multiple times per request.  And you can also attach it to a model.
+The goal of this project is to provide customizable stats that are immediately
+accessible in your application as opposed to using Google Analytics and pulling
+data using their API.  You can attach custom messages to impressions.  No
+reporting yet.. this thingy just creates the data.
 
 What about bots?
 ----------------
-They are ignored.  1200 known bots have been added to the ignore list as of Feb 1, 2011.  Impressionist uses this list:
+They are ignored.  1200 known bots have been added to the ignore list as of
+February 1, 2011.  Impressionist uses this list:
 http://www.user-agents.org/allagents.xml
 
-Which versions of Rails and Ruby is this compatible with?
----------------------------------------------------------
-Rails 3.0.4 and Ruby 1.9.2 (also tested on REE 1.8.7) - Sorry, but you need to upgrade if you are using Rails 2.  You know you want to anyways.. all the cool kids are doing it ;-)
-
 Installation
 ------------
 Add it to your Gemfile
@@ -73,46 +74,70 @@ Usage
           impressionist :actions=>[:show,:index]
         end
 
-3. Make your models impressionable.  This allows you to attach impressions to an AR model instance.  Impressionist will automatically log the Model name (based on action_name) and the id (based on params[:id]), but in order to get the count of impressions (example: @widget.impression_count), you will need to make your model impressionalble
+3. Make your models impressionable.  This allows you to attach impressions to
+   an AR model instance.  Impressionist will automatically log the Model name
+   (based on action_name) and the id (based on params[:id]), but in order to
+   get the count of impressions (example: @widget.impression_count), you will
+   need to make your model impressionalble
 
         class Widget < ActiveRecord::Base
           is_impressionable
         end
 
-4. Log an impression per model instance in your controller.  Note that it is not necessary to specify "impressionist" (usage #1) in the top of you controller if you are using this method.  If you add "impressionist" to the top of your controller and also use this method in your action, it will result in 2 impressions being logged (but associated with one request_hash)
+4. Log an impression per model instance in your controller.  Note that it is
+   not necessary to specify "impressionist" (usage #1) in the top of you
+   controller if you are using this method.  If you add "impressionist" to the
+   top of your controller and also use this method in your action, it will
+   result in 2 impressions being logged (but associated with one request_hash)
 
         def show
           @widget = Widget.find
           impressionist(@widget,message:"wtf is a widget?") #message is optional
         end
 
-5. Get unique impression count from a model.  This groups impressions by request_hash, so if you logged multiple impressions per request, it will only count them one time.  This unique impression count will not filter out unique users, only unique requests
+5. Get unique impression count from a model.  This groups impressions by
+   request_hash, so if you logged multiple impressions per request, it will
+   only count them one time.  This unique impression count will not filter out
+   unique users, only unique requests
 
         @widget.impressionist_count
         @widget.impressionist_count(:start_date=>"2011-01-01",:end_date=>"2011-01-05")
         @widget.impressionist_count(:start_date=>"2011-01-01")  #specify start date only, end date = now
 
-6. Get the unique impression count from a model filtered by IP address.  This in turn will give you impressions with unique request_hash, since rows with the same request_hash will have the same IP address.
+6. Get the unique impression count from a model filtered by IP address.  This
+   in turn will give you impressions with unique request_hash, since rows with
+   the same request_hash will have the same IP address.
 
         @widget.impressionist_count(:filter=>:ip_address)
 
-7. Get the unique impression count from a model filtered by session hash.  Same as #6 regarding request hash.  This may be more desirable than filtering by IP address depending on your situation, since filtering by IP may ignore visitors that use the same IP.  The downside to this filtering is that a user could clear session data in their browser and skew the results.
+7. Get the unique impression count from a model filtered by session hash.  Same
+   as #6 regarding request hash.  This may be more desirable than filtering by
+   IP address depending on your situation, since filtering by IP may ignore
+   visitors that use the same IP.  The downside to this filtering is that a
+   user could clear session data in their browser and skew the results.
 
         @widget.impressionist_count(:filter=>:session_hash)
 
-8. Get total impression count.  This may return more than 1 impression per http request, depending on how you are logging impressions
+8. Get total impression count.  This may return more than 1 impression per http
+   request, depending on how you are logging impressions
 
         @widget.impressionist_count(:filter=>:all)
 
-Logging impressions for authenticated users happens automatically.  If you have a current_user helper or use @current_user in your before_filter to set your authenticated user, current_user.id will be written to the user_id field in the impressions table.
+Logging impressions for authenticated users happens automatically.  If you have
+a current_user helper or use @current_user in your before_filter to set your
+authenticated user, current_user.id will be written to the user_id field in the
+impressions table.
 
 Adding a counter cache
 ----------------------
-Impressionist makes it easy to add a `counter_cache` column to your model. The most basic configuration looks like:
+Impressionist makes it easy to add a `counter_cache` column to your model. The
+most basic configuration looks like:
 
     is_impressionable :counter_cache => true
 
-This will automatically increment the `impressions_count` column in the included model. Note: You'll need to add that column to your model. If you'd like specific a different column name, you can:
+This will automatically increment the `impressions_count` column in the
+included model. Note: You'll need to add that column to your model. If you'd
+like specific a different column name, you can:
 
     is_impressionable :counter_cache => { :column_name => :my_column }
 
@@ -120,10 +145,11 @@ If you'd like to include only unique impressions in your count:
 
     is_impressionable :counter_cache => { :column_name => :my_column, :unique => true }
 
-
 What if I only want to record unique impressions?
 -------------------------------------------------
-Maybe you only care about unique impressions and would like to eliminate unnecessary database calls. You can specify conditions for recording impressions in your controller:
+Maybe you only care about unique impressions and would like to avoid
+unnecessary database records. You can specify conditions for recording
+impressions in your controller:
 
     # only record impression if the request has a unique combination of type, id, and session
     impressionist :unique => [:impressionable_type, :impressionable_id, :session_hash]
@@ -138,30 +164,35 @@ Or you can use the `impressionist` method directly:
 
     impressionist(impressionable, "some message", :unique => [:session_hash])
 
-
 Development Roadmap
 -------------------
-* Automatic impression logging in views.  For example, log initial view, and any partials called from initial view
-* Customizable black list for user-agents or IP addresses.  Impressions will be ignored.  Web admin as part of the Engine.
+* Automatic impression logging in views.  For example, log initial view, and
+  any partials called from initial view
+* Customizable black list for user-agents or IP addresses.  Impressions will be
+  ignored.  Web admin as part of the Engine.
 * Reporting engine
 * AB testing integration
 
 Contributing to impressionist
 -----------------------------
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Check out the latest master to make sure the feature hasn't been implemented
+  or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it
+  and/or contributed it
 * Fork the project
 * Start a feature/bugfix branch
 * Commit and push until you are happy with your contribution
-* Make sure to add rpsec tests for it. Patches or features without tests will be ignored.  Also, try to write better tests than I do ;-)
-* If adding engine controller or view functionality, use HAML and Inherited Resources.
-* All testing is done inside a small Rails app (test_app).  You will find specs within this app.
+* Make sure to add rpsec tests for it. Patches or features without tests will
+  be ignored.  Also, try to write better tests than I do ;-)
+* If adding engine controller or view functionality, use HAML and Inherited
+  Resources.
+* All testing is done inside a small Rails app (test_app).  You will find specs
+  within this app.
 
 Contributors
 ------------
-* johnmcaliley
-* coryschires
-* georgmittendorfer
-
+* [johnmcaliley](https://github.com/johnmcaliley)
+* [coryschires](https://github.com/coryschires)
+* [georgmittendorfer](https://github.com/georgmittendorfer)
 
 Copyright (c) 2011 John McAliley. See LICENSE.txt for further details.

data/Rakefile

@@ -1,89 +1,17 @@
-require 'rubygems'
-require 'bundler'
+#!/usr/bin/env rake
 
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "impressionist"
-  gem.homepage = "http://github.com/cowboycoded/impressionist"
-  gem.license = "MIT"
-  gem.summary = %Q{Easy way to log impressions}
-  gem.description = %Q{Log impressions from controller actions or from a model}
-  gem.email = "john.mcaliley@gmail.com"
-  gem.authors = ["cowboycoded"]
-  gem.files.exclude "test_app/**/*", "test_app/**/.*"
-end
-Jeweler::RubygemsDotOrgTasks.new
+require 'bundler/setup'
+require 'rspec/core/rake_task'
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
+Bundler::GemHelper.install_tasks
 
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+RSpec::Core::RakeTask.new do |task|
+  task.rspec_opts = "-I ./test_app/spec"
+  task.pattern = "./test_app/spec/**/*_spec.rb"
 end
 
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "impressionist #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-namespace :version do
-  desc "create a new version, create tag and push to github"
-  task :patch_release do
-    if Jeweler::Commands::ReleaseToGit.new.clean_staging_area?
-      Rake::Task['version:bump:patch'].invoke
-      Rake::Task['gemspec:release'].invoke
-      Rake::Task['git:release'].invoke
-    else
-      puts "Commit your changed files first"
-    end
-  end
-
-  desc "create a new version, create tag and push to github"
-  task :minor_release do
-    if Jeweler::Commands::ReleaseToGit.new.clean_staging_area?
-      Rake::Task['version:bump:minor'].invoke
-      Rake::Task['gemspec:release'].invoke
-      Rake::Task['git:release'].invoke
-    else
-      puts "Commit your changed files first"
-    end
-  end
-
-  desc "create a new version, create tag and push to github"
-  task :major_release do
-    if Jeweler::Commands::ReleaseToGit.new.clean_staging_area?
-      Rake::Task['version:bump:major'].invoke
-      Rake::Task['gemspec:release'].invoke
-      Rake::Task['git:release'].invoke
-    else
-      puts "Commit your changed files first"
-    end
-  end
-end
+task :test => :spec
+task :default => :spec
 
 namespace :impressionist do
   require File.dirname(__FILE__) + "/lib/impressionist/bots"
@@ -92,4 +20,4 @@ namespace :impressionist do
   task :bots do
     p Impressionist::Bots.consume
   end
-end
+end

data/app/controllers/impressionist_controller.rb

@@ -39,22 +39,22 @@ module ImpressionistController
     end
 
     private
-    
+
     def bypass
       Impressionist::Bots::WILD_CARDS.each do |wild_card|
         return true if request.user_agent and request.user_agent.downcase.include? wild_card
       end
       Impressionist::Bots::LIST.include? request.user_agent
     end
-    
+
     def unique_instance?(impressionable, unique_opts)
-      return unique_opts.blank? || impressionable.impressions.where(unique_query(unique_opts)).size == 0
+      return unique_opts.blank? || !impressionable.impressions.where(unique_query(unique_opts)).exists?
     end
-    
+
     def unique?(unique_opts)
-      return unique_opts.blank? || Impression.where(unique_query(unique_opts)).size == 0
+      return unique_opts.blank? || !Impression.where(unique_query(unique_opts)).exists?
     end
-    
+
     # creates the query to check for uniqueness
     def unique_query(unique_opts)
       full_statement = direct_create_statement
@@ -64,7 +64,7 @@ module ImpressionistController
         query
       end
     end
-    
+
     # creates a statment hash that contains default values for creating an impression via an AR relation.
     def associative_create_statement(query_params={})
       query_params.reverse_merge!(
@@ -77,7 +77,7 @@ module ImpressionistController
         :referrer => request.referer
         )
     end
-    
+
     # creates a statment hash that contains default values for creating an impression.
     def direct_create_statement(query_params={})
       query_params.reverse_merge!(
@@ -86,7 +86,7 @@ module ImpressionistController
         )
       associative_create_statement(query_params)
     end
-    
+
     def session_hash
       # # careful: request.session_options[:id] encoding in rspec test was ASCII-8BIT
       # # that broke the database query for uniqueness. not sure if this is a testing only issue.
@@ -95,7 +95,7 @@ module ImpressionistController
       # # request.session_options[:id].encode("ISO-8859-1")
       request.session_options[:id]
     end
-    
+
     #use both @current_user and current_user helper
     def user_id
       user_id = @current_user ? @current_user.id : nil rescue nil
@@ -103,4 +103,4 @@ module ImpressionistController
       user_id
     end
   end
-end
+end

data/app/models/impression.rb

@@ -1,16 +1,3 @@
-class Impression < ActiveRecord::Base
+class Impression
   belongs_to :impressionable, :polymorphic=>true
-
-  after_save :update_impressions_counter_cache
-
-  private
-
-  def update_impressions_counter_cache
-    impressionable_class = self.impressionable_type.constantize
-
-    if impressionable_class.counter_cache_options
-      resouce = impressionable_class.find(self.impressionable_id)
-      resouce.try(:update_counter_cache)
-    end
-  end
-end
+end

data/app/models/impressionist/bots.rb

@@ -1,8 +1,8 @@
 module Impressionist
   module Bots
     WILD_CARDS = ["bot","yahoo","slurp","google","msn","crawler"]
-    
-    LIST = ["<a href='http://www.unchaos.com/'> UnChaos </a> From Chaos To Order Hybrid Web Search Engine.(vadim_gonchar@unchaos.com)", 
+
+    LIST = ["<a href='http://www.unchaos.com/'> UnChaos </a> From Chaos To Order Hybrid Web Search Engine.(vadim_gonchar@unchaos.com)",
       "<a href='http://www.unchaos.com/'> UnChaos Bot Hybrid Web Search Engine. </a> (vadim_gonchar@unchaos.com)",
       "<b> UnChaosBot From Chaos To Order UnChaos Hybrid Web Search Engine at www.unchaos.com </b> (info@unchaos.com)",
       "<http://www.sygol.com/> http://www.sygol.com",
@@ -1459,4 +1459,4 @@ module Impressionist
       "zspider/0.9-dev http://feedback.redkolibri.com/",
       "ZyBorg/1.0 (ZyBorg@WISEnut.com; http://www.WISEnut.com)"]
   end
-end
+end