impressionist 1.5.1 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb9ffa85fa4e4bcd8eebad92acee8eb81c3f48de
-  data.tar.gz: 9073d41d76c1eec72dbc44b51fce2c6100269c34
+  metadata.gz: 77fe32e3f3573eee145dbc117db77870636488db
+  data.tar.gz: 5653b56f9e30cc83ab460ce4ebe14581aea1f0a5
 SHA512:
-  metadata.gz: 02d800f34d2d75e3e1605e5abee38c554b874509a3b2d9cd7ea199bb2cfbbda1ccadd6b1e0661b3021ea86eb686e0a632736ef7cc1deef75490d89bc75a4ba88
-  data.tar.gz: 26147d35e22672d3624340d52c8b8b2649ab65641c7377f9cc5c14f4d01e9c24a2cc2cf42b21a516ee04989aaf15b22d573d856706e5f2a264a09d12166472d6
+  metadata.gz: f30282672dfe4b2d8a848f571b6926640433e6131cdc744cd4b73b9c5ff63fd273467b2c0660bf49cb8401ff3223bac7871fa72ce7ac1af46938a4ae2eb0b824
+  data.tar.gz: be7b5e08610b3def60b450177dd12aec65b65e1cb9357b062599d760a1c3d0693a09e497d5fec4f2007e8904dcdda55ee29510d1ef1e8cb670886d1b07ff34d1

data/.travis.yml

@@ -2,7 +2,7 @@ language: ruby
 before_script:
   - cd tests/test_app
   - bundle exec rails g impressionist -f
-  - bundle exec rake db:migrate
+  - bundle exec rake db:create db:migrate RAILS_ENV=test
   - cd ..
 rvm:
   - 1.9.3

data/README.md

@@ -55,6 +55,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.text     "params"               # request.params, except action name, controller name and resource id
     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?
@@ -79,7 +80,7 @@ Usage
    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
+   need to make your model impressionable
 
         class Widget < ActiveRecord::Base
           is_impressionable
@@ -89,11 +90,14 @@ Usage
    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)
+   result in 2 impressions being logged (but associated with one request_hash).
+   If you're using [friendly_id](https://github.com/norman/friendly_id) be sure 
+   to log impressionist this way, as params[:id] will return a string(url slug) 
+   while impressionable_id is a Integer column in database.
 
         def show
           @widget = Widget.find
-          impressionist(@widget,message:"wtf is a widget?") #message is optional
+          impressionist(@widget, "message...") # 2nd argument is optional
         end
 
 5. Get unique impression count from a model.  This groups impressions by
@@ -111,7 +115,12 @@ Usage
 
         @widget.impressionist_count(:filter=>:ip_address)
 
-7. Get the unique impression count from a model filtered by session hash.  Same
+7. Get the unique impression count from a model filtered by params.  This
+   in turn will give you impressions with unique params.
+
+        @widget.impressionist_count(:filter => :params)
+        
+8. 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
@@ -119,12 +128,12 @@ Usage
 
         @widget.impressionist_count(:filter=>:session_hash)
 
-8. Get total impression count.  This may return more than 1 impression per http
+9. 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)
 
-9. Get impression count by message.  This only counts impressions of the given message.
+10. Get impression count by message.  This only counts impressions of the given message.
 
         @widget.impressionist_count(:message=>"pageview", :filter=>:all)
 
@@ -179,6 +188,9 @@ impressions in your controller:
 
     # only record impression if session is unique
     impressionist :unique => [:session_hash]
+    
+    # only record impression if param is unique
+    impressionist :unique => [:params]
 
 Or you can use the `impressionist` method directly:
 

data/app/controllers/impressionist_controller.rb

@@ -3,7 +3,7 @@ require 'digest/sha2'
 module ImpressionistController
   module ClassMethods
     def impressionist(opts={})
-      before_filter { |c| c.impressionist_subapp_filter(opts[:actions], opts[:unique])}
+      before_filter { |c| c.impressionist_subapp_filter(opts) }
     end
   end
 
@@ -13,7 +13,7 @@ module ImpressionistController
     end
 
     def impressionist(obj,message=nil,opts={})
-      unless bypass
+      if should_count_impression?(opts)
         if obj.respond_to?("impressionable?")
           if unique_instance?(obj, opts[:unique])
             obj.impressions.create(associative_create_statement({:message => message}))
@@ -29,10 +29,11 @@ module ImpressionistController
       @impressionist_hash = Digest::SHA2.hexdigest(Time.now.to_f.to_s+rand(10000).to_s)
     end
 
-    def impressionist_subapp_filter(actions=nil,unique_opts=nil)
-      unless bypass
+    def impressionist_subapp_filter(opts = {})
+      if should_count_impression?(opts)
+        actions = opts[:actions]
         actions.collect!{|a|a.to_s} unless actions.blank?
-        if (actions.blank? || actions.include?(action_name)) && unique?(unique_opts)
+        if (actions.blank? || actions.include?(action_name)) && unique?(opts[:unique])
           Impression.create(direct_create_statement)
         end
       end
@@ -49,7 +50,8 @@ module ImpressionistController
         :request_hash => @impressionist_hash,
         :session_hash => session_hash,
         :ip_address => request.remote_ip,
-        :referrer => request.referer
+        :referrer => request.referer,
+        :params => params_hash
         )
     end
 
@@ -59,17 +61,52 @@ module ImpressionistController
       Impressionist::Bots.bot?(request.user_agent)
     end
 
+    def should_count_impression?(opts)
+      !bypass && condition_true?(opts[:if]) && condition_false?(opts[:unless])
+    end
+
+    def condition_true?(condition)
+      condition.present? ? conditional?(condition) : true
+    end
+
+    def condition_false?(condition)
+      condition.present? ? !conditional?(condition) : true
+    end
+
+    def conditional?(condition)
+      condition.is_a?(Symbol) ? self.send(condition) : condition.call
+    end
+
     def unique_instance?(impressionable, unique_opts)
-      return unique_opts.blank? || !impressionable.impressions.where(unique_query(unique_opts)).exists?
+      return unique_opts.blank? || !impressionable.impressions.where(unique_query(unique_opts, impressionable)).exists?
     end
 
     def unique?(unique_opts)
-      return unique_opts.blank? || !Impression.where(unique_query(unique_opts)).exists?
+      return unique_opts.blank? || check_impression?(unique_opts)
     end
 
+    def check_impression?(unique_opts)
+      impressions = Impression.where(unique_query(unique_opts - [:params]))
+      check_unique_impression?(impressions, unique_opts)
+    end
+
+    def check_unique_impression?(impressions, unique_opts)
+      impressions_present = impressions.exists?
+      impressions_present && unique_opts_has_params?(unique_opts) ? check_unique_with_params?(impressions) : !impressions_present
+    end
+
+    def unique_opts_has_params?(unique_opts)
+      unique_opts.include?(:params)
+    end
+
+    def check_unique_with_params?(impressions)
+      request_param = params_hash
+      impressions.detect{|impression| impression.params == request_param }.nil?
+    end
+    
     # creates the query to check for uniqueness
-    def unique_query(unique_opts)
-      full_statement = direct_create_statement
+    def unique_query(unique_opts,impressionable=nil)
+      full_statement = direct_create_statement({},impressionable)
       # 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]
@@ -78,10 +115,10 @@ module ImpressionistController
     end
 
     # creates a statment hash that contains default values for creating an impression.
-    def direct_create_statement(query_params={})
+    def direct_create_statement(query_params={},impressionable=nil)
       query_params.reverse_merge!(
         :impressionable_type => controller_name.singularize.camelize,
-        :impressionable_id=> params[:id]
+        :impressionable_id => impressionable.present? ? impressionable.id : params[:id]
         )
       associative_create_statement(query_params)
     end
@@ -95,6 +132,10 @@ module ImpressionistController
       request.session_options[:id]
     end
 
+    def params_hash
+      request.params.except(:controller, :action, :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/impressionist/impressionable.rb

@@ -41,7 +41,7 @@ module Impressionist
 
       # Count all distinct impressions unless the :all filter is provided.
       distinct = options[:filter] != :all
-      if Rails::VERSION::MAJOR == 4
+      if Rails::VERSION::MAJOR >= 4
         distinct ? imps.select(options[:filter]).distinct.count : imps.count
       else
         distinct ? imps.count(options[:filter], :distinct => true) : imps.count

data/gemfiles/rails32.gemfile

@@ -18,9 +18,13 @@ group :test do
   gem 'minitest'
   gem 'minitest-rails'
   gem 'rails', '~> 3.2.15'
-  gem 'rspec-rails'
+  gem 'rspec-rails', '~> 2.14.0'
   gem 'simplecov'
   gem 'systemu'
+  gem 'friendly_id', '~> 4.0.9'
+
+  # test/unit has been removed by default in Ruby 2.2.x+
+  gem 'test-unit'
 end
 
 gemspec :path => '../'

data/gemfiles/rails40.gemfile

@@ -18,9 +18,13 @@ group :test do
   gem 'minitest'
   gem 'minitest-rails'
   gem 'rails', '~> 4.0.1'
-  gem 'rspec-rails'
+  gem 'rspec-rails', '~> 2.14.0'
   gem 'simplecov'
   gem 'systemu'
+  gem 'friendly_id', '~> 5.1.0'
+
+  # test/unit has been removed by default in Ruby 2.2.x+
+  gem 'test-unit'
 end
 
 gemspec :path => '../'

data/impressionist.gemspec

@@ -18,8 +18,6 @@ Gem::Specification.new do |s|
   s.require_path  = 'lib'
   s.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if s.respond_to? :required_rubygems_version=
 
-  s.add_dependency 'httpclient', '~> 2.2'
-  s.add_dependency 'nokogiri', '~> 1.5'
-
+  s.add_dependency 'nokogiri', '~> 1.6'
   s.add_development_dependency 'bundler', '~> 1.0'
 end

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

@@ -12,6 +12,7 @@ class CreateImpressionsTable < ActiveRecord::Migration
       t.string :session_hash
       t.text :message
       t.text :referrer
+      t.text :params
       t.timestamps
     end
     add_index :impressions, [:impressionable_type, :message, :impressionable_id], :name => "impressionable_type_message_index", :unique => false, :length => {:message => 255 }
@@ -21,6 +22,7 @@ class CreateImpressionsTable < ActiveRecord::Migration
     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, [:impressionable_type, :impressionable_id, :params], :name => "poly_params_request_index", :unique => false
     add_index :impressions, :user_id
   end
 

data/lib/impressionist/bots.rb

@@ -1,18 +1,21 @@
-require 'httpclient'
+require 'timeout'
+require 'net/http'
 require 'nokogiri'
 
 module Impressionist
   module Bots
     LIST_URL = "http://www.user-agents.org/allagents.xml"
     def self.consume
-      response = HTTPClient.new.get_content(LIST_URL)
-      doc = Nokogiri::XML(response)
-      list = []
-      doc.xpath('//user-agent').each do |agent|
-        type = agent.xpath("Type").text
-        list << agent.xpath("String").text.gsub("&lt;","<") if ["R","S"].include?(type) #gsub hack for badly formatted data
+      Timeout.timeout(4) do
+        response = Net::HTTP.get(URI.parse(LIST_URL))
+        doc = Nokogiri::XML(response)
+        list = []
+        doc.xpath('//user-agent').each do |agent|
+          type = agent.xpath("Type").text
+          list << agent.xpath("String").text.gsub("&lt;","<") if ["R","S"].include?(type) #gsub hack for badly formatted data
+        end
+        list
       end
-      list
     end
   end
 end

data/lib/impressionist/models/active_record/impression.rb

@@ -9,6 +9,6 @@ class Impression < ActiveRecord::Base
   # sets belongs_to and attr_accessible depending on Rails version
   Impressionist::SetupAssociation.new(self).set
 
+  store :params
   after_save :impressionable_counter_cache_updatable?
-
 end

data/lib/impressionist/models/mongoid/impression.rb

@@ -8,7 +8,7 @@ class Impression
   include Impressionist::CounterCache
   Impressionist::SetupAssociation.new(self).set
 
-  field :impressionable_id
+  field :impressionable_id, type: BSON::ObjectId
   field :impressionable_type
   field :user_id
   field :controller_name

data/lib/impressionist/setup_association.rb

@@ -35,7 +35,8 @@ module Impressionist
                         :view_name,
                         :referrer,
                         :message,
-                        :user_id)
+                        :user_id,
+                        :params)
       end
 
       def toggle

data/lib/impressionist/version.rb

@@ -1,3 +1,3 @@
 module Impressionist
-  VERSION = "1.5.1"
+  VERSION = "1.5.2"
 end

data/tests/spec/setup_association_spec.rb

@@ -9,10 +9,10 @@ module Impressionist
 
     before do
       # expects attr_accessible to return true
-      # and pass 11 arguments
+      # and pass 12 arguments
       mock.
         expect(:attr_accessible, true) do |args|
-          args.size == 11
+          args.size == 12
         end
 
     end

data/tests/test_app/.gitignore

@@ -15,3 +15,4 @@
 /coverage
 /log/*.log
 /tmp
+/.idea

data/tests/test_app/Gemfile

@@ -34,8 +34,11 @@ end
 
 group :development, :test do
   gem 'autotest-notification'
-  gem 'rspec-rails'
+  gem 'rspec-rails', '~> 2.14.0'
   gem 'spork'
+
+  # test/unit has been removed by default in Ruby 2.2.x+
+  gem 'test-unit'
 end
 
 group :test do
@@ -45,3 +48,4 @@ group :test do
 end
 
 gem 'jquery-rails'
+gem 'friendly_id', '~> 4.0.9'

data/tests/test_app/app/controllers/profiles_controller.rb

@@ -0,0 +1,14 @@
+class ProfilesController < ApplicationController
+  helper_method :current_user
+
+  def show
+  end
+
+  def current_user
+    if session[:user_id]
+      user = User.new
+      user.id = session[:user_id]
+      @current_user ||= user
+    end
+  end
+end

data/tests/test_app/app/controllers/widgets_controller.rb

@@ -1,5 +1,5 @@
 class WidgetsController < ApplicationController
-  impressionist :actions=>[:show,:index], :unique => [:controller_name,:action_name,:impressionable_id]
+  impressionist :actions=>[:show, :index], :unique => [:controller_name, :action_name, :impressionable_id, :params]
 
   def show
   end

data/tests/test_app/app/models/profile.rb

@@ -0,0 +1,6 @@
+class Profile < ActiveRecord::Base
+  extend FriendlyId
+
+  friendly_id :username, use: :slugged
+  is_impressionable
+end

data/tests/test_app/app/views/profiles/show.html.erb

@@ -0,0 +1,3 @@
+<h2>User Public Profile</h2>
+
+<p>User Name: <%= @profile.username %></p>

data/tests/test_app/config/initializers/impression.rb

@@ -5,4 +5,4 @@
 #end
 
 
-Impressionist.orm = :active_record
+

data/tests/test_app/config/routes.rb

@@ -1,3 +1,4 @@
 TestApp::Application.routes.draw do
   resources :articles, :posts, :widgets, :dummy
+  get 'profiles/[:id]' => 'profiles#show'
 end

data/tests/test_app/db/migrate/20130719024021_create_impressions_table.rb

@@ -11,6 +11,7 @@ class CreateImpressionsTable < ActiveRecord::Migration
       t.string :ip_address
       t.string :session_hash
       t.text :message
+      t.text :params
       t.text :referrer
       t.timestamps
     end
@@ -21,6 +22,7 @@ class CreateImpressionsTable < ActiveRecord::Migration
     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, [:impressionable_type, :impressionable_id, :params], :name => "poly_params_request_index", :unique => false
     add_index :impressions, :user_id
   end
 

data/tests/test_app/db/migrate/20150207135825_create_profiles.rb

@@ -0,0 +1,10 @@
+class CreateProfiles < ActiveRecord::Migration
+  def change
+    create_table :profiles do |t|
+      t.string :username
+      t.string :slug
+
+      t.timestamps
+    end
+  end
+end

data/tests/test_app/db/migrate/20150207140310_create_friendly_id_slugs.rb

@@ -0,0 +1,18 @@
+class CreateFriendlyIdSlugs < ActiveRecord::Migration
+
+  def self.up
+    create_table :friendly_id_slugs do |t|
+      t.string   :slug,           :null => false
+      t.integer  :sluggable_id,   :null => false
+      t.string   :sluggable_type, :limit => 40
+      t.datetime :created_at
+    end
+    add_index :friendly_id_slugs, :sluggable_id
+    add_index :friendly_id_slugs, [:slug, :sluggable_type], :unique => true
+    add_index :friendly_id_slugs, :sluggable_type
+  end
+
+  def self.down
+    drop_table :friendly_id_slugs
+  end
+end

data/tests/test_app/db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20130719024021) do
+ActiveRecord::Schema.define(:version => 20150207140310) do
 
   create_table "articles", :force => true do |t|
     t.string   "name"
@@ -19,6 +19,17 @@ ActiveRecord::Schema.define(:version => 20130719024021) do
     t.datetime "updated_at", :null => false
   end
 
+  create_table "friendly_id_slugs", :force => true do |t|
+    t.string   "slug",                         :null => false
+    t.integer  "sluggable_id",                 :null => false
+    t.string   "sluggable_type", :limit => 40
+    t.datetime "created_at"
+  end
+
+  add_index "friendly_id_slugs", ["slug", "sluggable_type"], :name => "index_friendly_id_slugs_on_slug_and_sluggable_type", :unique => true
+  add_index "friendly_id_slugs", ["sluggable_id"], :name => "index_friendly_id_slugs_on_sluggable_id"
+  add_index "friendly_id_slugs", ["sluggable_type"], :name => "index_friendly_id_slugs_on_sluggable_type"
+
   create_table "impressions", :force => true do |t|
     t.string   "impressionable_type"
     t.integer  "impressionable_id"
@@ -30,6 +41,7 @@ ActiveRecord::Schema.define(:version => 20130719024021) do
     t.string   "ip_address"
     t.string   "session_hash"
     t.text     "message"
+    t.text     "params"
     t.text     "referrer"
     t.datetime "created_at",          :null => false
     t.datetime "updated_at",          :null => false
@@ -39,6 +51,7 @@ ActiveRecord::Schema.define(:version => 20130719024021) do
   add_index "impressions", ["controller_name", "action_name", "request_hash"], :name => "controlleraction_request_index"
   add_index "impressions", ["controller_name", "action_name", "session_hash"], :name => "controlleraction_session_index"
   add_index "impressions", ["impressionable_type", "impressionable_id", "ip_address"], :name => "poly_ip_index"
+  add_index "impressions", ["impressionable_type", "impressionable_id", "params"], :name => "poly_params_request_index"
   add_index "impressions", ["impressionable_type", "impressionable_id", "request_hash"], :name => "poly_request_index"
   add_index "impressions", ["impressionable_type", "impressionable_id", "session_hash"], :name => "poly_session_index"
   add_index "impressions", ["impressionable_type", "message", "impressionable_id"], :name => "impressionable_type_message_index"
@@ -50,6 +63,13 @@ ActiveRecord::Schema.define(:version => 20130719024021) do
     t.datetime "updated_at", :null => false
   end
 
+  create_table "profiles", :force => true do |t|
+    t.string   "username"
+    t.string   "slug"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
+  end
+
   create_table "widgets", :force => true do |t|
     t.string   "name"
     t.integer  "impressions_count", :default => 0

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

@@ -53,8 +53,24 @@ describe ArticlesController do
     click_link "Same Page"
     Impression.last.referrer.should eq "http://test.host/articles/1"
   end
-end
 
+  it "should log request with params (checked = true)" do
+    get "show", id: 1, checked: true
+    Impression.last.params.should eq({"checked"=>true})
+    Impression.last.request_hash.size.should eq 64
+    Impression.last.ip_address.should eq "0.0.0.0"
+    Impression.last.session_hash.size.should eq 32
+    Impression.last.referrer.should eq nil
+  end
 
+  it "should log request with params {}" do
+    get "index"
+    Impression.last.params.should eq({})
+    Impression.last.request_hash.size.should eq 64
+    Impression.last.ip_address.should eq "0.0.0.0"
+    Impression.last.session_hash.size.should eq 32
+    Impression.last.referrer.should eq nil
+  end
+end
 
 

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

@@ -10,63 +10,63 @@ describe DummyController do
   describe "impressionist filter uniqueness" do
 
     it "should ignore uniqueness if not requested" do
-      controller.impressionist_subapp_filter(nil, nil)
-      controller.impressionist_subapp_filter(nil, nil)
+      controller.impressionist_subapp_filter
+      controller.impressionist_subapp_filter
       Impression.should have(@impression_count + 2).records
     end
 
     it "should recognize unique session" do
       controller.stub(:session_hash).and_return(request.session_options[:id])
-      controller.impressionist_subapp_filter(nil, [:session_hash])
-      controller.impressionist_subapp_filter(nil, [:session_hash])
+      controller.impressionist_subapp_filter(unique: [:session_hash])
+      controller.impressionist_subapp_filter(unique: [:session_hash])
       Impression.should have(@impression_count + 1).records
     end
 
     it "should recognize unique ip" do
       controller.request.stub(:remote_ip).and_return("1.2.3.4")
-      controller.impressionist_subapp_filter(nil, [:ip_address])
-      controller.impressionist_subapp_filter(nil, [:ip_address])
+      controller.impressionist_subapp_filter(unique: [:ip_address])
+      controller.impressionist_subapp_filter(unique: [:ip_address])
       Impression.should have(@impression_count + 1).records
     end
 
     it "should recognize unique request" do
-      controller.impressionist_subapp_filter(nil, [:request_hash])
-      controller.impressionist_subapp_filter(nil, [:request_hash])
+      controller.impressionist_subapp_filter(unique: [:request_hash])
+      controller.impressionist_subapp_filter(unique: [:request_hash])
       Impression.should have(@impression_count + 1).records
     end
 
     it "should recognize unique action" do
       controller.stub(:action_name).and_return("test_action")
-      controller.impressionist_subapp_filter(nil, [:action_name])
-      controller.impressionist_subapp_filter(nil, [:action_name])
+      controller.impressionist_subapp_filter(unique: [:action_name])
+      controller.impressionist_subapp_filter(unique: [:action_name])
       Impression.should have(@impression_count + 1).records
     end
 
     it "should recognize unique controller" do
       controller.stub(:controller_name).and_return("post")
-      controller.impressionist_subapp_filter(nil, [:controller_name])
-      controller.impressionist_subapp_filter(nil, [:controller_name])
+      controller.impressionist_subapp_filter(unique: [:controller_name])
+      controller.impressionist_subapp_filter(unique: [:controller_name])
       Impression.should have(@impression_count + 1).records
     end
 
     it "should recognize unique user" do
       controller.stub(:user_id).and_return(42)
-      controller.impressionist_subapp_filter(nil, [:user_id])
-      controller.impressionist_subapp_filter(nil, [:user_id])
+      controller.impressionist_subapp_filter(unique: [:user_id])
+      controller.impressionist_subapp_filter(unique: [:user_id])
       Impression.should have(@impression_count + 1).records
     end
 
     it "should recognize unique referer" do
       controller.request.stub(:referer).and_return("http://foo/bar")
-      controller.impressionist_subapp_filter(nil, [:referrer])
-      controller.impressionist_subapp_filter(nil, [:referrer])
+      controller.impressionist_subapp_filter(unique: [:referrer])
+      controller.impressionist_subapp_filter(unique: [:referrer])
       Impression.should have(@impression_count + 1).records
     end
 
     it "should recognize unique id" do
       controller.stub(:params).and_return({:id => "666"}) # for correct impressionable id in filter
-      controller.impressionist_subapp_filter(nil, [:impressionable_id])
-      controller.impressionist_subapp_filter(nil, [:impressionable_id])
+      controller.impressionist_subapp_filter(unique: [:impressionable_id])
+      controller.impressionist_subapp_filter(unique: [:impressionable_id])
       Impression.should have(@impression_count + 1).records
     end
 
@@ -74,104 +74,104 @@ describe DummyController do
     it "should recognize different controller and action" do
       controller.stub(:controller_name).and_return("post")
       controller.stub(:action_name).and_return("test_action")
-      controller.impressionist_subapp_filter(nil, [:controller_name, :action_name])
-      controller.impressionist_subapp_filter(nil, [:controller_name, :action_name])
+      controller.impressionist_subapp_filter(unique: [:controller_name, :action_name])
+      controller.impressionist_subapp_filter(unique: [:controller_name, :action_name])
       Impression.should have(@impression_count + 1).records
       controller.stub(:action_name).and_return("another_action")
-      controller.impressionist_subapp_filter(nil, [:controller_name, :action_name])
-      controller.impressionist_subapp_filter(nil, [:controller_name, :action_name])
+      controller.impressionist_subapp_filter(unique: [:controller_name, :action_name])
+      controller.impressionist_subapp_filter(unique: [:controller_name, :action_name])
       Impression.should have(@impression_count + 2).records
       controller.stub(:controller_name).and_return("article")
-      controller.impressionist_subapp_filter(nil, [:controller_name, :action_name])
-      controller.impressionist_subapp_filter(nil, [:controller_name, :action_name])
+      controller.impressionist_subapp_filter(unique: [:controller_name, :action_name])
+      controller.impressionist_subapp_filter(unique: [:controller_name, :action_name])
       Impression.should have(@impression_count + 3).records
     end
 
     it "should recognize different action" do
       controller.stub(:action_name).and_return("test_action")
-      controller.impressionist_subapp_filter(nil, [:action_name])
-      controller.impressionist_subapp_filter(nil, [:action_name])
+      controller.impressionist_subapp_filter(unique: [:action_name])
+      controller.impressionist_subapp_filter(unique: [:action_name])
       Impression.should have(@impression_count + 1).records
       controller.stub(:action_name).and_return("another_action")
-      controller.impressionist_subapp_filter(nil, [:action_name])
-      controller.impressionist_subapp_filter(nil, [:action_name])
+      controller.impressionist_subapp_filter(unique: [:action_name])
+      controller.impressionist_subapp_filter(unique: [:action_name])
       Impression.should have(@impression_count + 2).records
     end
 
     it "should recognize different controller" do
       controller.stub(:controller_name).and_return("post")
-      controller.impressionist_subapp_filter(nil, [:controller_name])
-      controller.impressionist_subapp_filter(nil, [:controller_name])
+      controller.impressionist_subapp_filter(unique: [:controller_name])
+      controller.impressionist_subapp_filter(unique: [:controller_name])
       Impression.should have(@impression_count + 1).records
       controller.stub(:controller_name).and_return("article")
-      controller.impressionist_subapp_filter(nil, [:controller_name])
-      controller.impressionist_subapp_filter(nil, [:controller_name])
+      controller.impressionist_subapp_filter(unique: [:controller_name])
+      controller.impressionist_subapp_filter(unique: [:controller_name])
       Impression.should have(@impression_count + 2).records
     end
 
     it "should recognize different session" do
       controller.stub(:session_hash).and_return("foo")
-      controller.impressionist_subapp_filter(nil, [:session_hash])
-      controller.impressionist_subapp_filter(nil, [:session_hash])
+      controller.impressionist_subapp_filter(unique: [:session_hash])
+      controller.impressionist_subapp_filter(unique: [:session_hash])
       Impression.should have(@impression_count + 1).records
       controller.stub(:session_hash).and_return("bar")
-      controller.impressionist_subapp_filter(nil, [:session_hash])
-      controller.impressionist_subapp_filter(nil, [:session_hash])
+      controller.impressionist_subapp_filter(unique: [:session_hash])
+      controller.impressionist_subapp_filter(unique: [:session_hash])
       Impression.should have(@impression_count + 2).records
     end
 
     it "should recognize different ip" do
       controller.request.stub(:remote_ip).and_return("1.2.3.4")
-      controller.impressionist_subapp_filter(nil, [:ip_address])
-      controller.impressionist_subapp_filter(nil, [:ip_address])
+      controller.impressionist_subapp_filter(unique: [:ip_address])
+      controller.impressionist_subapp_filter(unique: [:ip_address])
       Impression.should have(@impression_count + 1).records
       controller.request.stub(:remote_ip).and_return("5.6.7.8")
-      controller.impressionist_subapp_filter(nil, [:ip_address])
-      controller.impressionist_subapp_filter(nil, [:ip_address])
+      controller.impressionist_subapp_filter(unique: [:ip_address])
+      controller.impressionist_subapp_filter(unique: [:ip_address])
       Impression.should have(@impression_count + 2).records
     end
 
     it "should recognize different referer" do
       controller.request.stub(:referer).and_return("http://foo/bar")
-      controller.impressionist_subapp_filter(nil, [:referrer])
-      controller.impressionist_subapp_filter(nil, [:referrer])
+      controller.impressionist_subapp_filter(unique: [:referrer])
+      controller.impressionist_subapp_filter(unique: [:referrer])
       Impression.should have(@impression_count + 1).records
       controller.request.stub(:referer).and_return("http://bar/fo")
-      controller.impressionist_subapp_filter(nil, [:referrer])
-      controller.impressionist_subapp_filter(nil, [:referrer])
+      controller.impressionist_subapp_filter(unique: [:referrer])
+      controller.impressionist_subapp_filter(unique: [:referrer])
       Impression.should have(@impression_count + 2).records
     end
 
     it "should recognize different id" do
       controller.stub(:params).and_return({:id => "666"}) # for correct impressionable id in filter
-      controller.impressionist_subapp_filter(nil, [:impressionable_type, :impressionable_id])
-      controller.impressionist_subapp_filter(nil, [:impressionable_type, :impressionable_id])
+      controller.impressionist_subapp_filter(unique: [:impressionable_type, :impressionable_id])
+      controller.impressionist_subapp_filter(unique: [:impressionable_type, :impressionable_id])
       controller.stub(:params).and_return({:id => "42"}) # for correct impressionable id in filter
-      controller.impressionist_subapp_filter(nil, [:impressionable_type, :impressionable_id])
-      controller.impressionist_subapp_filter(nil, [:impressionable_type, :impressionable_id])
+      controller.impressionist_subapp_filter(unique: [:impressionable_type, :impressionable_id])
+      controller.impressionist_subapp_filter(unique: [:impressionable_type, :impressionable_id])
       Impression.should have(@impression_count + 2).records
     end
 
     it "should recognize combined uniqueness" do
       controller.stub(:action_name).and_return("test_action")
-      controller.impressionist_subapp_filter(nil, [:ip_address, :request_hash, :action_name])
-      controller.impressionist_subapp_filter(nil, [:request_hash, :ip_address, :action_name])
-      controller.impressionist_subapp_filter(nil, [:request_hash, :action_name])
-      controller.impressionist_subapp_filter(nil, [:ip_address, :action_name])
-      controller.impressionist_subapp_filter(nil, [:ip_address, :request_hash])
-      controller.impressionist_subapp_filter(nil, [:action_name])
-      controller.impressionist_subapp_filter(nil, [:ip_address])
-      controller.impressionist_subapp_filter(nil, [:request_hash])
+      controller.impressionist_subapp_filter(unique: [:ip_address, :request_hash, :action_name])
+      controller.impressionist_subapp_filter(unique: [:request_hash, :ip_address, :action_name])
+      controller.impressionist_subapp_filter(unique: [:request_hash, :action_name])
+      controller.impressionist_subapp_filter(unique: [:ip_address, :action_name])
+      controller.impressionist_subapp_filter(unique: [:ip_address, :request_hash])
+      controller.impressionist_subapp_filter(unique: [:action_name])
+      controller.impressionist_subapp_filter(unique: [:ip_address])
+      controller.impressionist_subapp_filter(unique: [:request_hash])
       Impression.should have(@impression_count + 1).records
     end
 
     it "should recognize combined non-uniqueness" do
       controller.stub(:action_name).and_return(nil)
-      controller.impressionist_subapp_filter(nil, [:ip_address, :action_name])
+      controller.impressionist_subapp_filter(unique: [:ip_address, :action_name])
       controller.stub(:action_name).and_return("test_action")
-      controller.impressionist_subapp_filter(nil, [:ip_address, :action_name])
+      controller.impressionist_subapp_filter(unique: [:ip_address, :action_name])
       controller.stub(:action_name).and_return("another_action")
-      controller.impressionist_subapp_filter(nil, [:ip_address, :action_name])
+      controller.impressionist_subapp_filter(unique: [:ip_address, :action_name])
       Impression.should have(@impression_count + 3).records
     end
 
@@ -299,12 +299,98 @@ describe DummyController do
       controller.stub(:session_hash).and_return("foo")
       controller.request.stub(:remote_ip).and_return("1.2.3.4")
       # order of the following methods is important for the test!
-      controller.impressionist_subapp_filter(nil, [:ip_address, :request_hash, :session_hash])
+      controller.impressionist_subapp_filter(unique: [:ip_address, :request_hash, :session_hash])
       controller.impressionist(impressionable, nil, :unique => [:ip_address, :request_hash, :session_hash])
       Impression.should have(@impression_count + 1).records
     end
 
   end
 
+  describe 'impressionist with friendly id' do
+    it 'should unique' do
+      impressionable = Profile.create({username: 'test_profile', slug: 'test_profile'})
+
+      controller.stub(:controller_name).and_return('profile')
+      controller.stub(:action_name).and_return('show')
+      controller.stub(:params).and_return({id: impressionable.slug})
+      controller.request.stub(:remote_ip).and_return('1.2.3.4')
+
+      controller.impressionist(impressionable, nil, :unique => [:impressionable_type, :impressionable_id])
+      controller.impressionist(impressionable, nil, :unique => [:impressionable_type, :impressionable_id])
+      Impression.should have(@impression_count + 1).records
+    end
+  end
+
+  shared_examples_for 'an impressionable action' do
+    it 'should record an impression' do
+      controller.impressionist_subapp_filter(condition)
+      Impression.should have(@impression_count + 1).records
+    end
+  end
+
+  shared_examples_for 'an unimpressionable action' do
+    it 'should record an impression' do
+      controller.impressionist_subapp_filter(condition)
+      Impression.should have(@impression_count).records
+    end
+  end
+
+  describe "conditional impressions" do
+    describe ":if condition" do
+      context "true condition" do
+        before do
+          controller.stub(:true_condition).and_return(true)
+        end
+        it_behaves_like 'an impressionable action' do
+          let(:condition) {{ if: :true_condition }}
+        end
+
+        it_behaves_like 'an impressionable action' do
+          let(:condition) {{ if: lambda { true } }}
+        end
+      end
+
+      context "false condition" do
+        before do
+          controller.stub(:false_condition).and_return(false)
+        end
+        it_behaves_like 'an unimpressionable action' do
+          let(:condition) {{ if: :false_condition }}
+        end
+
+        it_behaves_like 'an unimpressionable action' do
+          let(:condition) {{ if: lambda { false } }}
+        end
+      end
+    end
+
+    describe ":unless condition" do
+      context "true condition" do
+        before do
+          controller.stub(:true_condition).and_return(true)
+        end
+        it_behaves_like 'an unimpressionable action' do
+          let(:condition) {{ unless: :true_condition }}
+        end
+
+        it_behaves_like 'an unimpressionable action' do
+          let(:condition) {{ unless: lambda { true } }}
+        end
+      end
+
+      context "false condition" do
+        before do
+          controller.stub(:false_condition).and_return(false)
+        end
+        it_behaves_like 'an impressionable action' do
+          let(:condition) {{ unless: :false_condition }}
+        end
+
+        it_behaves_like 'an impressionable action' do
+          let(:condition) {{ unless: lambda { false } }}
+        end
+      end
+    end
+  end
 end
 

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

@@ -16,4 +16,13 @@ describe PostsController do
     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

@@ -44,7 +44,6 @@ describe WidgetsController do
     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
 
@@ -57,4 +56,36 @@ describe WidgetsController do
 
   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/profiles.yml

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

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

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Impression do
-  fixtures :articles,:impressions,:posts
+  fixtures :articles,:impressions,:posts,:profiles
 
   before(:each) do
     @article = Article.find(1)

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

@@ -4,7 +4,7 @@ require 'systemu'
 # FIXME this test might break the others if run before them
 # started fixing @nbit001
 describe Impressionist, :migration do
-  fixtures :articles,:impressions,:posts
+  fixtures :articles,:impressions,:posts,:profiles
   it "should delete existing migration and generate the migration file" do
     pending
     migrations_dir = "#{Rails.root}/db/migrate"

metadata

@@ -1,55 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: impressionist
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.2
 platform: ruby
 authors:
 - johnmcaliley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-31 00:00:00.000000000 Z
+date: 2016-09-16 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: httpclient
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 description: Log impressions from controller actions or from a model
@@ -58,9 +44,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.rdoc
 - Gemfile
 - LICENSE.txt
@@ -114,6 +100,7 @@ files:
 - tests/test_app/app/controllers/articles_controller.rb
 - tests/test_app/app/controllers/dummy_controller.rb
 - tests/test_app/app/controllers/posts_controller.rb
+- tests/test_app/app/controllers/profiles_controller.rb
 - tests/test_app/app/controllers/widgets_controller.rb
 - tests/test_app/app/helpers/application_helper.rb
 - tests/test_app/app/mailers/.gitkeep
@@ -121,6 +108,7 @@ files:
 - tests/test_app/app/models/article.rb
 - tests/test_app/app/models/dummy.rb
 - tests/test_app/app/models/post.rb
+- tests/test_app/app/models/profile.rb
 - tests/test_app/app/models/user.rb
 - tests/test_app/app/models/widget.rb
 - tests/test_app/app/views/articles/index.html.erb
@@ -130,6 +118,7 @@ files:
 - tests/test_app/app/views/posts/edit.html.erb
 - tests/test_app/app/views/posts/index.html.erb
 - tests/test_app/app/views/posts/show.html.erb
+- tests/test_app/app/views/profiles/show.html.erb
 - tests/test_app/app/views/widgets/index.html.erb
 - tests/test_app/app/views/widgets/new.html.erb
 - tests/test_app/app/views/widgets/show.html.erb
@@ -156,6 +145,8 @@ files:
 - tests/test_app/db/migrate/20110210205028_create_posts.rb
 - tests/test_app/db/migrate/20111127184039_create_widgets.rb
 - tests/test_app/db/migrate/20130719024021_create_impressions_table.rb
+- tests/test_app/db/migrate/20150207135825_create_profiles.rb
+- tests/test_app/db/migrate/20150207140310_create_friendly_id_slugs.rb
 - tests/test_app/db/schema.rb
 - tests/test_app/db/seeds.rb
 - tests/test_app/lib/assets/.gitkeep
@@ -186,6 +177,7 @@ files:
 - tests/test_app/spec/fixtures/articles.yml
 - tests/test_app/spec/fixtures/impressions.yml
 - tests/test_app/spec/fixtures/posts.yml
+- tests/test_app/spec/fixtures/profiles.yml
 - tests/test_app/spec/fixtures/widgets.yml
 - tests/test_app/spec/initializers/initializers_spec.rb
 - tests/test_app/spec/models/bots_spec.rb
@@ -205,17 +197,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Easy way to log impressions
@@ -234,6 +226,7 @@ test_files:
 - tests/test_app/app/controllers/articles_controller.rb
 - tests/test_app/app/controllers/dummy_controller.rb
 - tests/test_app/app/controllers/posts_controller.rb
+- tests/test_app/app/controllers/profiles_controller.rb
 - tests/test_app/app/controllers/widgets_controller.rb
 - tests/test_app/app/helpers/application_helper.rb
 - tests/test_app/app/mailers/.gitkeep
@@ -241,6 +234,7 @@ test_files:
 - tests/test_app/app/models/article.rb
 - tests/test_app/app/models/dummy.rb
 - tests/test_app/app/models/post.rb
+- tests/test_app/app/models/profile.rb
 - tests/test_app/app/models/user.rb
 - tests/test_app/app/models/widget.rb
 - tests/test_app/app/views/articles/index.html.erb
@@ -250,6 +244,7 @@ test_files:
 - tests/test_app/app/views/posts/edit.html.erb
 - tests/test_app/app/views/posts/index.html.erb
 - tests/test_app/app/views/posts/show.html.erb
+- tests/test_app/app/views/profiles/show.html.erb
 - tests/test_app/app/views/widgets/index.html.erb
 - tests/test_app/app/views/widgets/new.html.erb
 - tests/test_app/app/views/widgets/show.html.erb
@@ -276,6 +271,8 @@ test_files:
 - tests/test_app/db/migrate/20110210205028_create_posts.rb
 - tests/test_app/db/migrate/20111127184039_create_widgets.rb
 - tests/test_app/db/migrate/20130719024021_create_impressions_table.rb
+- tests/test_app/db/migrate/20150207135825_create_profiles.rb
+- tests/test_app/db/migrate/20150207140310_create_friendly_id_slugs.rb
 - tests/test_app/db/schema.rb
 - tests/test_app/db/seeds.rb
 - tests/test_app/lib/assets/.gitkeep
@@ -306,6 +303,7 @@ test_files:
 - tests/test_app/spec/fixtures/articles.yml
 - tests/test_app/spec/fixtures/impressions.yml
 - tests/test_app/spec/fixtures/posts.yml
+- tests/test_app/spec/fixtures/profiles.yml
 - tests/test_app/spec/fixtures/widgets.yml
 - tests/test_app/spec/initializers/initializers_spec.rb
 - tests/test_app/spec/models/bots_spec.rb
@@ -313,4 +311,3 @@ test_files:
 - tests/test_app/spec/models/model_spec.rb
 - tests/test_app/spec/rails_generators/rails_generators_spec.rb
 - tests/test_app/spec/spec_helper.rb
-has_rdoc: