impressionist2 1.5.1

data/tests/test_app/spec/controllers/posts_controller_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe PostsController do
+  it "should log impression at the action level" do
+    get "show", :id=> 1
+    Impression.all.size.should eq 12
+    Impression.last.controller_name.should eq "posts"
+    Impression.last.action_name.should eq "show"
+    Impression.last.impressionable_type.should eq "Post"
+    Impression.last.impressionable_id.should eq 1
+  end
+
+  it "should log the user_id if user is authenticated (current_user helper method)" do
+    session[:user_id] = 123
+    get "show", :id=> 1
+    Post.first.impressions.last.user_id.should eq 123
+  end
+
+  it "should log impression at the action level with params" do
+    get "show", id: 1, checked: true
+    Impression.all.size.should eq 12
+    Impression.last.params.should eq({"checked"=>true})
+    Impression.last.controller_name.should eq "posts"
+    Impression.last.action_name.should eq "show"
+    Impression.last.impressionable_type.should eq "Post"
+    Impression.last.impressionable_id.should eq 1
+  end
+end

data/tests/test_app/spec/controllers/widgets_controller_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe WidgetsController do
+
+  before(:each) do
+    @widget = Widget.find(1)
+    Widget.stub(:find).and_return(@widget)
+  end
+
+  it "should log impression at the per action level" do
+    get "show", :id=> 1
+    Impression.all.size.should eq 12
+    get "index"
+    Impression.all.size.should eq 13
+    get "new"
+    Impression.all.size.should eq 13
+  end
+
+  it "should not log impression when user-agent is in wildcard list" do
+    request.stub(:user_agent).and_return('somebot')
+    get "show", :id=> 1
+    Impression.all.size.should eq 11
+  end
+
+  it "should not log impression when user-agent is in the bot list" do
+    request.stub(:user_agent).and_return('Acoon Robot v1.50.001')
+    get "show", :id=> 1
+    Impression.all.size.should eq 11
+  end
+
+  context "impressionist unique options" do
+
+    it "should log unique impressions at the per action level" do
+      get "show", :id=> 1
+      Impression.all.size.should eq 12
+      get "show", :id=> 2
+      Impression.all.size.should eq 13
+      get "show", :id => 2
+      Impression.all.size.should eq 13
+      get "index"
+      Impression.all.size.should eq 14
+    end
+
+    it "should log unique impressions only once per id" do
+      get "show", :id=> 1
+      Impression.all.size.should eq 12
+      get "show", :id=> 2
+      Impression.all.size.should eq 13
+
+      get "show", :id => 2
+      Impression.all.size.should eq 13
+
+      get "index"
+      Impression.all.size.should eq 14
+    end
+
+  end
+
+  context "Impresionist unique params options" do
+    it "should log unique impressions at the per action and params level" do
+      get "show", :id => 1
+      Impression.all.size.should eq 12
+      get "show", :id => 2, checked: true
+      Impression.all.size.should eq 13	
+      get "show", :id => 2, checked: false
+      Impression.all.size.should eq 14
+      get "index"
+      Impression.all.size.should eq 15
+    end
+
+    it "should not log impression for same params and same id" do
+      get "show", :id => 1
+      Impression.all.size.should eq 12
+      get "show", :id => 1
+      Impression.all.size.should eq 12
+      get "show", :id => 1, checked: true
+      Impression.all.size.should eq 13	
+      get "show", :id => 1, checked: false
+      Impression.all.size.should eq 14
+      get "show", :id => 1, checked: true
+      Impression.all.size.should eq 14
+      get "show", :id => 1, checked: false
+      Impression.all.size.should eq 14
+      get "show", :id => 1
+      Impression.all.size.should eq 14
+      get "show", :id => 2
+      Impression.all.size.should eq 15
+    end
+  end
+
+end

data/tests/test_app/spec/fixtures/articles.yml

@@ -0,0 +1,3 @@
+one:
+  id: 1
+  name: Test Article

data/tests/test_app/spec/fixtures/impressions.yml

@@ -0,0 +1,43 @@
+<% 1.upto(7) do |i| %>
+impression<%= i %>:
+  impressionable_type: Article
+  impressionable_id: 1
+  request_hash: a<%=i%>
+  session_hash: b<%=i%>
+  ip_address: 127.0.0.<%=i%>
+  created_at: 2011-01-01
+<% end %>
+
+
+impression8:
+  impressionable_type: Article
+  impressionable_id: 1
+  request_hash: a1
+  session_hash: b1
+  ip_address: 127.0.0.1
+  created_at: 2010-01-01
+
+impression9:
+  impressionable_type: Article
+  impressionable_id: 1
+  request_hash: a1
+  session_hash: b2
+  ip_address: 127.0.0.1
+  created_at: 2011-01-03
+
+impression10:
+  impressionable_type: Article
+  impressionable_id: 1
+  request_hash: a9
+  session_hash: b3
+  ip_address: 127.0.0.8
+  created_at: 2010-01-01
+
+impression11:
+  impressionable_type: Article
+  impressionable_id: 1
+  request_hash: a10
+  session_hash: b4
+  ip_address: 127.0.0.1
+  created_at: 2010-01-01
+

data/tests/test_app/spec/fixtures/posts.yml

@@ -0,0 +1,3 @@
+one:
+  id: 1
+  name: Test Post

data/tests/test_app/spec/fixtures/profiles.yml

@@ -0,0 +1,4 @@
+one:
+  id: 1
+  username: test_profile
+  slug: test_profile

data/tests/test_app/spec/fixtures/widgets.yml

@@ -0,0 +1,4 @@
+one:
+  id: 1
+  name: A Widget
+  impressions_count: 0

data/tests/test_app/spec/initializers/initializers_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Impressionist do
+  let(:imp) { RUBY_VERSION.match("1.8") ? "is_impressionable" : :is_impressionable }
+
+  it "should be extended from ActiveRecord::Base" do
+    expect(ActiveRecord::Base).to respond_to(imp)
+    #ActiveRecord::Base.methods.include?(method).should be_true
+  end
+
+  it "should include methods in ApplicationController" do
+    method = RUBY_VERSION.match("1.8") ? "impressionist" : :impressionist
+    expect(ApplicationController).to respond_to(method)
+  end
+
+  it "should include the before_filter method in ApplicationController" do
+     filters = ApplicationController._process_action_callbacks.select { |c| c.kind == :before }
+     filters.collect{|filter|filter.filter}.include?(:impressionist_app_filter).should be_true
+  end
+end

data/tests/test_app/spec/models/bots_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Impressionist::Bots do
+
+  describe "self.bot?" do
+    it "is true if user_agent is matches wild card" do
+      Impressionist::Bots.bot?("google.com bot").should be_true
+    end
+
+    it "is true if user_agent is on bot list" do
+      Impressionist::Bots.bot?("A-Online Search").should be_true
+    end
+
+    it "is false if user_agent is blank" do
+      Impressionist::Bots.bot?("").should be_false
+      Impressionist::Bots.bot?(nil).should be_false
+    end
+
+    it "is false if user_agent is safe" do
+      Impressionist::Bots.bot?('127.0.0.1').should be_false
+    end
+
+    it "is false if user_agent not given" do
+      Impressionist::Bots.bot?.should be_false
+    end
+  end
+end

data/tests/test_app/spec/models/counter_caching_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Impression do
+  fixtures :widgets
+
+  let(:widget) { Widget.find(1) }
+
+  before(:each) do
+    Impression.destroy_all
+  end
+
+  describe "self#impressionist_counter_caching?" do
+    it "should know when counter caching is enabled" do
+      Widget.should be_impressionist_counter_caching
+    end
+
+    it "should know when counter caching is disabled" do
+      Article.should_not be_impressionist_counter_caching
+    end
+  end
+
+  describe "self#counter_caching?" do
+    it "should know when counter caching is enabled" do
+      ActiveSupport::Deprecation.should_receive(:warn)
+      Widget.should be_counter_caching
+    end
+
+    it "should know when counter caching is disabled" do
+      ActiveSupport::Deprecation.should_receive(:warn)
+      Article.should_not be_counter_caching
+    end
+
+  end
+
+  describe "#update_impressionist_counter_cache" do
+    it "should update the counter cache column to reflect the correct number of impressions" do
+      expect {
+         widget.impressions.create(:request_hash => 'abcd1234')
+         widget.reload
+       }.to change(widget, :impressions_count).from(0).to(1)
+    end
+
+    it "should not update the timestamp on the impressable" do
+      expect {
+         widget.impressions.create(:request_hash => 'abcd1234')
+         widget.reload
+       }.to_not change(widget, :updated_at)
+    end
+  end
+
+end

data/tests/test_app/spec/models/model_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Impression do
+  fixtures :articles,:impressions,:posts,:profiles
+
+  before(:each) do
+    @article = Article.find(1)
+  end
+
+  it "should save a blank impression for an Article that has 10 impressions" do
+    @article.impressions.create
+    @article.impressions.size.should eq 12
+  end
+
+  it "should save an impression with a message" do
+    @article.impressions.create(:message=>"test message")
+    @article.impressions.last.message.should eq "test message"
+  end
+
+  it "should return the impression count for the message specified" do
+    @article.impressions.create(:message => "pageview")
+    @article.impressions.create(:message => "pageview")
+    @article.impressions.create(:message => "visit")
+
+    @article.impressionist_count(:message => "pageview", :filter => :all).should eq 2
+  end
+
+  it "should return the impression count for all with no date range specified" do
+    @article.impressionist_count(:filter=>:all).should eq 11
+  end
+
+  it "should return unique impression count with no date range specified" do
+    @article.impressionist_count.should eq 9
+  end
+
+  it "should return impression count with only start date specified" do
+    @article.impressionist_count(:start_date=>"2011-01-01",:filter=>:all).should eq 8
+  end
+
+  it "should return impression count with whole date range specified" do
+    @article.impressionist_count(:start_date=>"2011-01-01",:end_date=>"2011-01-02",:filter=>:all).should eq 7
+  end
+
+  it "should return unique impression count with only start date specified" do
+    @article.impressionist_count(:start_date=>"2011-01-01").should eq 7
+  end
+
+  it "should return unique impression count with date range specified" do
+    @article.impressionist_count(:start_date=>"2011-01-01",:end_date=>"2011-01-02").should eq 7
+  end
+
+  it "should return unique impression count using ip address (which in turn eliminates duplicate request_hashes)" do
+    @article.impressionist_count(:filter=>:ip_address).should eq 8
+  end
+
+  it "should return unique impression count using session_hash (which in turn eliminates duplicate request_hashes)" do
+    @article.impressionist_count(:filter=>:session_hash).should eq 7
+  end
+
+  # tests :dependent => :destroy
+  it "should delete impressions on deletion of impressionable" do
+    #impressions_count = Impression.all.size
+    a = Article.create
+    i = a.impressions.create
+    a.destroy
+    a.destroyed?.should be_true
+    i.destroyed?.should be_true
+  end
+
+end

data/tests/test_app/spec/rails_generators/rails_generators_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require 'systemu'
+
+# FIXME this test might break the others if run before them
+# started fixing @nbit001
+describe Impressionist, :migration do
+  fixtures :articles,:impressions,:posts,:profiles
+  it "should delete existing migration and generate the migration file" do
+    pending
+    migrations_dir = "#{Rails.root}/db/migrate"
+    impressions_migration = Dir.entries(migrations_dir).grep(/impressions/)[0]
+    File.delete("#{migrations_dir}/#{impressions_migration}") unless impressions_migration.blank?
+    generator_output = systemu("rails g impressionist")[1]
+    migration_name = generator_output.split("migrate/")[1].strip
+    Dir.entries(migrations_dir).include?(migration_name).should be_true
+  end
+
+  it "should run the migration created in the previous spec" do
+    pending
+    migrate_output = systemu("rake db:migrate RAILS_ENV=test")
+    migrate_output[1].include?("CreateImpressionsTable: migrated").should be_true
+  end
+end

data/tests/test_app/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+ENV["RAILS_ENV"] ||= 'test'
+
+unless ENV['CI']
+  require 'simplecov'
+  SimpleCov.start 'rails'
+end
+
+require File.
+expand_path("../../config/environment", __FILE__)
+
+require 'rspec/rails'
+require 'capybara/rails'
+
+# Custom matchers and macros, etc...
+Dir[Rails.root.join("spec/support/**/*.rb")].each {|f|
+  require f
+}
+
+RSpec.configure do |config|
+
+  # in order to pass tags(symbols) as true values
+  # you need to tell rspec to do so by
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+
+  config.mock_with :rspec
+
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  config.use_transactional_fixtures = true
+
+  # excludes migration tag while running app base tests
+  config.filter_run_excluding :migration => true
+
+  # self explanatory
+  # runs everything
+  config.run_all_when_everything_filtered = true
+
+  # make the rails logger usable in the tests as logger.xxx "..."
+  def logger
+    Rails.logger
+  end
+
+end

data/upgrade_migrations/version_0_3_0.rb

@@ -0,0 +1,27 @@
+class CreateImpressionsTable < ActiveRecord::Migration
+  def self.up
+    add_column :impressions, :session_hash, :string
+    remove_index :impressions, :name => :poly_index
+    remove_index :impressions, :name => :controlleraction_index
+    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, [: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
+
+  end
+
+  def self.down
+    remove_column :impressions, :session_hash
+    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 => :controlleraction_request_index
+    remove_index :impressions, :name => :controlleraction_ip_index
+    remove_index :impressions, :name => :controlleraction_session_index
+    remove_index :impressions, :user_id
+    add_index :impressions, [:impressionable_type, :impressionable_id, :request_hash, :ip_address], :name => "poly_index", :unique => false
+    add_index :impressions, [:controller_name,:action_name,:request_hash,:ip_address], :name => "controlleraction_index", :unique => false
+  end
+end

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