impressionist 0.3.2 → 0.4.0

data/CHANGELOG.rdoc

@@ -1,3 +1,10 @@
+== 0.4.0 (2011-06-03)
+* Fix postgres bug
+* New impression count method that accepts options for filter, start_date and end_date
+* Add referrer to Impression model.  YOU MUST RUN THE UPGRADE MIGRATION IF YOU ARE UPGRADING FROM 0.3.0
+* UPGRADE MIGRATION = impressionist/upgrade_migrations/version_0_4_0.rb
+* NOTE IF YOU ARE UPGRADING FROM 0.2.5 OR BELOW, YOU MUST RUN BOTH UPGRADE MIGRATIONS
+
 == 0.3.0 (2011-03-06)
 * added session_hash to impression model
 * migration template updated to add session_hash

data/Gemfile

@@ -7,21 +7,20 @@ group :development do
   gem "rcov", ">= 0"
 end
 
-if ENV['MY_BUNDLE_ENV'] == "dev"
-  group :development do
-    gem 'ZenTest'
-    gem 'autotest'
-    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'
-  end
+group :test do
+  gem 'ZenTest'
+  gem 'autotest'
+  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'
 end
+

data/README.md

@@ -1,4 +1,4 @@
-![Impressionist Logo](https://github.com/cowboycoded/impressionist/raw/master/logo.png)
+![Impressionist Logo](https://github.com/charlotte-ruby/impressionist/raw/master/logo.png)
 
 impressionist
 =============
@@ -53,6 +53,7 @@ The following fields are provided in the migration:
     t.string   "request_hash"         # unique ID per request, in case you want to log multiple impressions and group them
     t.string   "session_hash"         # logs the rails session
     t.string   "ip_address"           # request.remote_ip
+    t.string   "referrer"             # request.referer
     t.string   "message"              # custom message you can add
     t.datetime "created_at"           # I am not sure what this is.... Any clue?
     t.datetime "updated_at"           # never seen this one before either....  Your guess is as good as mine??
@@ -86,24 +87,22 @@ Usage
         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
-        @widget.unique_impression_count
-        @widget.unique_impression_count("2011-01-01","2011-01-02")  # start date, end date
-        @widget.unique_impression_count("2011-01-01")  #specify start date only, end date = now
+
+        @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.
-        @widget.unique_impression_count_ip
-        @widget.unique_impression_count_ip("2011-01-01","2011-01-02")  # start date, end date
-        @widget.unique_impression_count_ip("2011-01-01")  #specify start date only, end date = now
 
+        @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.unique_impression_count_session
-        @widget.unique_impression_count_session("2011-01-01","2011-01-02")  # start date, end date
-        @widget.unique_impression_count_session("2011-01-01")  #specify start date only, end date = now
+
+        @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.impression_count
-        @widget.impression_count("2011-01-01","2011-01-02")  # start date, end date
-        @widget.impression_count("2011-01-01")  #specify start date only, end date = now
+
+        @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.
 
@@ -126,8 +125,4 @@ Contributing to impressionist
 * 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
----------
-Copyright (c) 2011 cowboycoded. See LICENSE.txt for
-further details.
-
+Copyright (c) 2011 John McAliley. See LICENSE.txt for further details.

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.4.0

data/app/controllers/impressionist_controller.rb

@@ -21,7 +21,8 @@ module ImpressionistController
                                  :ip_address=> request.remote_ip,
                                  :user_id=> user_id,
                                  :controller_name=>controller_name,
-                                 :action_name=> action_name)
+                                 :action_name=> action_name,
+                                 :referrer=>request.referer)
         else
           raise "#{obj.class.to_s} is not impressionable!"
         end
@@ -43,7 +44,8 @@ module ImpressionistController
                             :session_hash=> request.session_options[:id],
                             :ip_address=> request.remote_ip,
                             :impressionable_type=> controller_name.singularize.camelize,
-                            :impressionable_id=> params[:id])
+                            :impressionable_id=> params[:id],
+                            :referrer=>request.referer)
         end
       end
     end

data/app/models/impressionist/impressionable.rb

@@ -10,20 +10,30 @@ module Impressionist
         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])
+        if options[:filter]!=:all
+          imps = imps.select(options[:filter]).group(options[:filter])
+        end
+        imps.all.size
+      end
+      
+      # OLD METHODS - DEPRECATE IN V0.5
       def impression_count(start_date=nil,end_date=Time.now)
-        start_date.blank? ? impressions.all.size : impressions.where("created_at>=? and created_at<=?",start_date,end_date).all.size
+        impressionist_count({:start_date=>start_date, :end_date=>end_date, :filter=>:all})
       end
 
       def unique_impression_count(start_date=nil,end_date=Time.now)
-        start_date.blank? ? impressions.group(:request_hash).all.size : impressions.where("created_at>=? and created_at<=?",start_date,end_date).group(:request_hash).all.size
+        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)
-        start_date.blank? ? impressions.group(:ip_address).all.size : impressions.where("created_at>=? and created_at<=?",start_date,end_date).group(:ip_address).all.size
+        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)
-        start_date.blank? ? impressions.group(:session_hash).all.size : impressions.where("created_at>=? and created_at<=?",start_date,end_date).group(:session_hash).all.size
+        impressionist_count({:start_date=>start_date, :end_date=>end_date, :filter=> :session_hash})
       end
     end
   end

data/impressionist.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{impressionist}
-  s.version = "0.3.2"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["cowboycoded"]
-  s.date = %q{2011-03-21}
+  s.date = %q{2011-06-03}
   s.description = %q{Log impressions from controller actions or from a model}
   s.email = %q{john.mcaliley@gmail.com}
   s.extra_rdoc_files = [
@@ -36,7 +36,8 @@ Gem::Specification.new do |s|
     "lib/impressionist/engine.rb",
     "lib/impressionist/railties/tasks.rake",
     "logo.png",
-    "upgrade_migrations/version_0_3_0.rb"
+    "upgrade_migrations/version_0_3_0.rb",
+    "upgrade_migrations/version_0_4_0.rb"
   ]
   s.homepage = %q{http://github.com/cowboycoded/impressionist}
   s.licenses = ["MIT"]
@@ -53,59 +54,17 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_development_dependency(%q<ZenTest>, [">= 0"])
-      s.add_development_dependency(%q<autotest>, [">= 0"])
-      s.add_development_dependency(%q<systemu>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-      s.add_development_dependency(%q<rspec-rails>, [">= 0"])
-      s.add_development_dependency(%q<mongrel>, ["= 1.2.0.pre2"])
-      s.add_development_dependency(%q<capybara>, [">= 0"])
-      s.add_development_dependency(%q<database_cleaner>, [">= 0"])
-      s.add_development_dependency(%q<cucumber-rails>, [">= 0"])
-      s.add_development_dependency(%q<cucumber>, [">= 0"])
-      s.add_development_dependency(%q<spork>, [">= 0"])
-      s.add_development_dependency(%q<launchy>, [">= 0"])
-      s.add_development_dependency(%q<autotest-notification>, [">= 0"])
-      s.add_development_dependency(%q<httpclient>, [">= 0"])
     else
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
       s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<ZenTest>, [">= 0"])
-      s.add_dependency(%q<autotest>, [">= 0"])
-      s.add_dependency(%q<systemu>, [">= 0"])
-      s.add_dependency(%q<rspec>, [">= 0"])
-      s.add_dependency(%q<rspec-rails>, [">= 0"])
-      s.add_dependency(%q<mongrel>, ["= 1.2.0.pre2"])
-      s.add_dependency(%q<capybara>, [">= 0"])
-      s.add_dependency(%q<database_cleaner>, [">= 0"])
-      s.add_dependency(%q<cucumber-rails>, [">= 0"])
-      s.add_dependency(%q<cucumber>, [">= 0"])
-      s.add_dependency(%q<spork>, [">= 0"])
-      s.add_dependency(%q<launchy>, [">= 0"])
-      s.add_dependency(%q<autotest-notification>, [">= 0"])
-      s.add_dependency(%q<httpclient>, [">= 0"])
     end
   else
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
     s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<ZenTest>, [">= 0"])
-    s.add_dependency(%q<autotest>, [">= 0"])
-    s.add_dependency(%q<systemu>, [">= 0"])
-    s.add_dependency(%q<rspec>, [">= 0"])
-    s.add_dependency(%q<rspec-rails>, [">= 0"])
-    s.add_dependency(%q<mongrel>, ["= 1.2.0.pre2"])
-    s.add_dependency(%q<capybara>, [">= 0"])
-    s.add_dependency(%q<database_cleaner>, [">= 0"])
-    s.add_dependency(%q<cucumber-rails>, [">= 0"])
-    s.add_dependency(%q<cucumber>, [">= 0"])
-    s.add_dependency(%q<spork>, [">= 0"])
-    s.add_dependency(%q<launchy>, [">= 0"])
-    s.add_dependency(%q<autotest-notification>, [">= 0"])
-    s.add_dependency(%q<httpclient>, [">= 0"])
   end
 end
 

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

@@ -11,6 +11,7 @@ class CreateImpressionsTable < ActiveRecord::Migration
       t.string :session_hash
       t.string :ip_address
       t.string :message
+      t.string :referrer
       t.timestamps
     end
     add_index :impressions, [:impressionable_type, :impressionable_id, :request_hash], :name => "poly_request_index", :unique => false

data/upgrade_migrations/version_0_4_0.rb

@@ -0,0 +1,9 @@
+class Version04UpdateImpressionsTable < ActiveRecord::Migration
+  def self.up
+    add_column :impressions, :referrer, :string    
+  end
+
+  def self.down
+    remove_column :impressions, :referrer
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 2
-  version: 0.3.2
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - cowboycoded
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-21 00:00:00 -04:00
+date: 2011-06-03 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -73,191 +73,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: ZenTest
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  prerelease: false
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: autotest
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  prerelease: false
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: systemu
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  prerelease: false
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  prerelease: false
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: rspec-rails
-  requirement: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  prerelease: false
-  version_requirements: *id009
-- !ruby/object:Gem::Dependency 
-  name: mongrel
-  requirement: &id010 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 2
-        - 0
-        - pre2
-        version: 1.2.0.pre2
-  type: :development
-  prerelease: false
-  version_requirements: *id010
-- !ruby/object:Gem::Dependency 
-  name: capybara
-  requirement: &id011 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  prerelease: false
-  version_requirements: *id011
-- !ruby/object:Gem::Dependency 
-  name: database_cleaner
-  requirement: &id012 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  prerelease: false
-  version_requirements: *id012
-- !ruby/object:Gem::Dependency 
-  name: cucumber-rails
-  requirement: &id013 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  prerelease: false
-  version_requirements: *id013
-- !ruby/object:Gem::Dependency 
-  name: cucumber
-  requirement: &id014 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  prerelease: false
-  version_requirements: *id014
-- !ruby/object:Gem::Dependency 
-  name: spork
-  requirement: &id015 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  prerelease: false
-  version_requirements: *id015
-- !ruby/object:Gem::Dependency 
-  name: launchy
-  requirement: &id016 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  prerelease: false
-  version_requirements: *id016
-- !ruby/object:Gem::Dependency 
-  name: autotest-notification
-  requirement: &id017 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  prerelease: false
-  version_requirements: *id017
-- !ruby/object:Gem::Dependency 
-  name: httpclient
-  requirement: &id018 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  prerelease: false
-  version_requirements: *id018
 description: Log impressions from controller actions or from a model
 email: john.mcaliley@gmail.com
 executables: []
@@ -288,6 +103,7 @@ files:
 - lib/impressionist/railties/tasks.rake
 - 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
 licenses: 
@@ -302,7 +118,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 916626274296505275
+      hash: -566691724227540930
       segments: 
       - 0
       version: "0"