impressionist 0.4.0 → 1.0.0

data/README.md

@@ -10,9 +10,9 @@ I would not call this a stable plugin yet, although I have been running it in pr
 
 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 
+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.
 
 What about bots?
@@ -95,17 +95,49 @@ Usage
 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.
 
         @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
 
         @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.
 
+Adding a counter cache
+----------------------
+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:
+
+  is_impressionable :counter_cache => { :column_name => :my_column }
+
+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:
+
+    # only record impression if the request has a unique combination of type, id, and session
+    impressionist :unique => [:impressionable_type, :impressionable_id, :session_hash]
+
+    # only record impression if the request has a unique combination of controller, action, and session
+    impressionist :unique => [:controller_name, :action_name, :session_hash]
+
+    # only record impression if session is unique
+    impressionist :unique => [:session_hash]
+
+Or you can use the `impressionist` method directly:
+
+    impressionist(impressionable, "some message", :unique => [:session_hash])
+
 
 Development Roadmap
 -------------------
@@ -115,14 +147,14 @@ Development Roadmap
 * 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
 * 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.  
+* 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.
 
 Copyright (c) 2011 John McAliley. See LICENSE.txt for further details.

data/Rakefile

@@ -70,14 +70,14 @@ namespace :version do
       Rake::Task['git:release'].invoke
     else
       puts "Commit your changed files first"
-    end      
+    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['gemspec:release'].invoke
       Rake::Task['git:release'].invoke
     else
       puts "Commit your changed files first"
@@ -87,9 +87,9 @@ end
 
 namespace :impressionist do
   require File.dirname(__FILE__) + "/lib/impressionist/bots"
-  
+
   desc "output the list of bots from http://www.user-agents.org/"
-  task :bots do  
+  task :bots do
     p Impressionist::Bots.consume
   end
 end

data/VERSION

@@ -1 +1 @@
-0.4.0
+1.0.0

data/app/controllers/impressionist_controller.rb

@@ -3,27 +3,23 @@ require 'digest/sha2'
 module ImpressionistController
   module ClassMethods
     def impressionist(opts={})
-      before_filter { |c| c.impressionist_subapp_filter opts[:actions] }
+      before_filter { |c| c.impressionist_subapp_filter(opts[:actions], opts[:unique])}
     end
   end
-  
+
   module InstanceMethods
     def self.included(base)
       base.before_filter :impressionist_app_filter
     end
 
-    def impressionist(obj,message=nil)
+    def impressionist(obj,message=nil,opts={})
       unless bypass
         if obj.respond_to?("impressionable?")
-          obj.impressions.create(:message=> message,
-                                 :request_hash=> @impressionist_hash,
-                                 :session_hash=> request.session_options[:id],
-                                 :ip_address=> request.remote_ip,
-                                 :user_id=> user_id,
-                                 :controller_name=>controller_name,
-                                 :action_name=> action_name,
-                                 :referrer=>request.referer)
+          if unique_instance?(obj, opts[:unique])
+            obj.impressions.create(associative_create_statement({:message => message}))
+          end
         else
+          # we could create an impression anyway. for classes, too. why not?
           raise "#{obj.class.to_s} is not impressionable!"
         end
       end
@@ -33,31 +29,73 @@ module ImpressionistController
       @impressionist_hash = Digest::SHA2.hexdigest(Time.now.to_f.to_s+rand(10000).to_s)
     end
 
-    def impressionist_subapp_filter(actions=nil)
+    def impressionist_subapp_filter(actions=nil,unique_opts=nil)
       unless bypass
         actions.collect!{|a|a.to_s} unless actions.blank?
-        if actions.blank? or actions.include?(action_name)
-          Impression.create(:controller_name=> controller_name,
-                            :action_name=> action_name,
-                            :user_id=> user_id,
-                            :request_hash=> @impressionist_hash,
-                            :session_hash=> request.session_options[:id],
-                            :ip_address=> request.remote_ip,
-                            :impressionable_type=> controller_name.singularize.camelize,
-                            :impressionable_id=> params[:id],
-                            :referrer=>request.referer)
+        if (actions.blank? || actions.include?(action_name)) && unique?(unique_opts)
+          Impression.create(direct_create_statement)
         end
       end
     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
+    end
+    
+    def unique?(unique_opts)
+      return unique_opts.blank? || Impression.where(unique_query(unique_opts)).size == 0
+    end
+    
+    # creates the query to check for uniqueness
+    def unique_query(unique_opts)
+      full_statement = direct_create_statement
+      # reduce the full statement to the params we need for the specified unique options
+      unique_opts.reduce({}) do |query, param|
+        query[param] = full_statement[param]
+        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!(
+        :controller_name => controller_name,
+        :action_name => action_name,
+        :user_id => user_id,
+        :request_hash => @impressionist_hash,
+        :session_hash => session_hash,
+        :ip_address => request.remote_ip,
+        :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!(
+        :impressionable_type => controller_name.singularize.camelize,
+        :impressionable_id=> params[:id]
+        )
+      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.
+      # str = request.session_options[:id]
+      # logger.debug "Encoding: #{str.encoding.inspect}"
+      # # 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

data/app/models/impression.rb

@@ -1,3 +1,16 @@
 class Impression < ActiveRecord::Base
   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

data/app/models/impressionist/impressionable.rb

@@ -1,15 +1,38 @@
 module Impressionist
   module Impressionable
-    def is_impressionable
-      has_many :impressions, :as=>:impressionable
-      include InstanceMethods
+
+    def self.included(base)
+      base.extend ClassMethods
+      base.send(:include, InstanceMethods)
+    end
+
+    module ClassMethods
+      attr_accessor :cache_options
+      @cache_options = nil
+
+      def is_impressionable(options={})
+        has_many :impressions, :as=>:impressionable
+        @cache_options = options[:counter_cache]
+      end
+
+      def counter_cache_options
+        if @cache_options
+          options = { :column_name => :impressions_count, :unique => false }
+          options.merge!(@cache_options) if @cache_options.is_a?(Hash)
+          options
+        end
+      end
+
+      def counter_caching?
+        counter_cache_options.present?
+      end
     end
-    
+
     module InstanceMethods
       def impressionable?
         true
       end
-      
+
       def impressionist_count(options={})
         options.reverse_merge!(:filter=>:request_hash, :start_date=>nil, :end_date=>Time.now)
         imps = options[:start_date].blank? ? impressions : impressions.where("created_at>=? and created_at<=?",options[:start_date],options[:end_date])
@@ -18,7 +41,14 @@ module Impressionist
         end
         imps.all.size
       end
-      
+
+      def update_counter_cache
+        cache_options = self.class.counter_cache_options
+        column_name = cache_options[:column_name].to_sym
+        count = cache_options[:unique] ? impressionist_count(:filter => :ip_address) : impressionist_count
+        update_attribute(column_name, count)
+      end
+
       # OLD METHODS - DEPRECATE IN V0.5
       def impression_count(start_date=nil,end_date=Time.now)
         impressionist_count({:start_date=>start_date, :end_date=>end_date, :filter=>:all})
@@ -27,14 +57,15 @@ module Impressionist
       def unique_impression_count(start_date=nil,end_date=Time.now)
         impressionist_count({:start_date=>start_date, :end_date=>end_date, :filter=> :request_hash})
       end
-      
+
       def unique_impression_count_ip(start_date=nil,end_date=Time.now)
         impressionist_count({:start_date=>start_date, :end_date=>end_date, :filter=> :ip_address})
       end
-      
+
       def unique_impression_count_session(start_date=nil,end_date=Time.now)
         impressionist_count({:start_date=>start_date, :end_date=>end_date, :filter=> :session_hash})
       end
     end
+
   end
 end

data/impressionist.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{impressionist}
-  s.version = "0.4.0"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["cowboycoded"]
@@ -39,7 +39,7 @@ Gem::Specification.new do |s|
     "upgrade_migrations/version_0_3_0.rb",
     "upgrade_migrations/version_0_4_0.rb"
   ]
-  s.homepage = %q{http://github.com/cowboycoded/impressionist}
+  s.homepage = %q{https://github.com/charlotte-ruby/impressionist}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}

data/lib/generators/impressionist/templates/create_impressions_table.rb

@@ -8,30 +8,30 @@ class CreateImpressionsTable < ActiveRecord::Migration
       t.string :action_name
       t.string :view_name
       t.string :request_hash
-      t.string :session_hash
       t.string :ip_address
-      t.string :message
-      t.string :referrer
+      t.text :session_hash
+      t.text :message
+      t.text :referrer
       t.timestamps
     end
     add_index :impressions, [:impressionable_type, :impressionable_id, :request_hash], :name => "poly_request_index", :unique => false
     add_index :impressions, [:impressionable_type, :impressionable_id, :ip_address], :name => "poly_ip_index", :unique => false
-    add_index :impressions, [:impressionable_type, :impressionable_id, :session_hash], :name => "poly_session_index", :unique => false    
+    add_index :impressions, [:impressionable_type, :impressionable_id, :session_hash], :name => "poly_session_index", :unique => false
     add_index :impressions, [:controller_name,:action_name,:request_hash], :name => "controlleraction_request_index", :unique => false
     add_index :impressions, [:controller_name,:action_name,:ip_address], :name => "controlleraction_ip_index", :unique => false
-    add_index :impressions, [:controller_name,:action_name,:session_hash], :name => "controlleraction_session_index", :unique => false        
+    add_index :impressions, [:controller_name,:action_name,:session_hash], :name => "controlleraction_session_index", :unique => false
     add_index :impressions, :user_id
   end
 
   def self.down
     remove_index :impressions, :name => :poly_request_index
     remove_index :impressions, :name => :poly_ip_index
-    remove_index :impressions, :name => :poly_session_index        
+    remove_index :impressions, :name => :poly_session_index
     remove_index :impressions, :name => :controlleraction_request_index
     remove_index :impressions, :name => :controlleraction_ip_index
-    remove_index :impressions, :name => :controlleraction_session_index        
+    remove_index :impressions, :name => :controlleraction_session_index
     remove_index :impressions, :user_id
-    
+
     drop_table :impressions
   end
 end

data/lib/impressionist/engine.rb

@@ -2,11 +2,11 @@ require "impressionist"
 require "rails"
 
 module Impressionist
-  class Engine < Rails::Engine    
+  class Engine < Rails::Engine
     initializer 'impressionist.extend_ar' do |app|
-      ActiveRecord::Base.extend Impressionist::Impressionable
+      ActiveRecord::Base.send(:include, Impressionist::Impressionable)
     end
-    
+
     initializer 'impressionist.controller' do
       ActiveSupport.on_load(:action_controller) do
         include ImpressionistController::InstanceMethods

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: impressionist
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 4
-  - 0
-  version: 0.4.0
+  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors: 
 - cowboycoded
@@ -14,64 +10,51 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-03 00:00:00 -04:00
-default_executable: 
+date: 2011-06-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: shoulda
+  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
-  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: bundler
+  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
         version: 1.0.0
   type: :development
-  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: jeweler
+  prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 5
-        - 1
         version: 1.5.1
   type: :development
-  prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rcov
+  prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
-  prerelease: false
   version_requirements: *id004
 description: Log impressions from controller actions or from a model
 email: john.mcaliley@gmail.com
@@ -104,8 +87,7 @@ files:
 - logo.png
 - upgrade_migrations/version_0_3_0.rb
 - upgrade_migrations/version_0_4_0.rb
-has_rdoc: true
-homepage: http://github.com/cowboycoded/impressionist
+homepage: https://github.com/charlotte-ruby/impressionist
 licenses: 
 - MIT
 post_install_message: 
@@ -118,22 +100,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -566691724227540930
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Easy way to log impressions