re_track 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4aabe5f9c6436c6acb865eb1996a94bc4f7f561c
-  data.tar.gz: 145e7a9168c92966f8df5cc876dfdb22f2e1e696
+  metadata.gz: d9c55efc6a40f7368c49e1dccbc6e12418ae4c11
+  data.tar.gz: 1f761b5374e042dd592026d141d7761022edfbc5
 SHA512:
-  metadata.gz: 19ad52bd8a4279132b347a12c47bdd159bdf0d8a46a712970ea94ed7960a2dd7b7b603ed00420d8d0d30d5a60df3e19a47afb090561a8a58e5a97394b1b3ff86
-  data.tar.gz: 1aec4f86f8d2fd071b4bd7e84fa39b43cd1533b8b08b5396f2cf63dca13d339ff02f2eee80fa165b05e5b4609c2fc0908956d953591aa33609f1efa6d78dc5ab
+  metadata.gz: f27cdeb865526103258b6ce3baea05e14dcf37f1b6cffcec8ee3c9ccca2b53687efeb385b0660e1b21ed4d25e06b6468f1dec1ca2021752f6b8363772637ab5e
+  data.tar.gz: c30b3a2e9867cc8884ad3dd5c0ece2c2e9767da87ee94af3b0c9f6afd761d0b1ba6ee6260f6bdd065ab5b2ea20e980663f366571a5eba17b220a942ac75dc771

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,12 @@
+.DS_Store
+.bundle/
+log/*.log
+pkg/
+coverage/
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+.yardoc/
+ctags
+gemfiles/*.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.ruby-gemset

@@ -0,0 +1 @@
+re_track

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+gemfile:
+  - gemfiles/rails_3.gemfile
+  - gemfiles/rails_4.gemfile
+services: mongodb

data/Appraisals

@@ -0,0 +1,9 @@
+appraise 'rails-3' do
+  gem 'rails', '~> 3.0'
+  gem 'mongoid', '~> 3.0'
+end
+
+appraise 'rails-4' do
+  gem 'rails', '~> 4.0.0'
+  gem 'mongoid', '~> 4.0.0.alpha1', github: 'mongoid/mongoid'
+end

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org/'
+gemspec
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"

data/Gemfile.lock

@@ -0,0 +1,150 @@
+PATH
+  remote: .
+  specs:
+    re_track (0.5.0)
+      activesupport
+      mongoid (>= 3)
+      rails
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.15)
+      actionpack (= 3.2.15)
+      mail (~> 2.5.4)
+    actionpack (3.2.15)
+      activemodel (= 3.2.15)
+      activesupport (= 3.2.15)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.15)
+      activesupport (= 3.2.15)
+      builder (~> 3.0.0)
+    activerecord (3.2.15)
+      activemodel (= 3.2.15)
+      activesupport (= 3.2.15)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.15)
+      activemodel (= 3.2.15)
+      activesupport (= 3.2.15)
+    activesupport (3.2.15)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    appraisal (0.5.2)
+      bundler
+      rake
+    arel (3.0.3)
+    builder (3.0.4)
+    coderay (1.1.0)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    database_cleaner (1.2.0)
+    diff-lcs (1.2.5)
+    docile (1.1.0)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.6.5)
+    journey (1.0.4)
+    jquery-rails (3.0.4)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.8.1)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    method_source (0.8.2)
+    mime-types (1.25)
+    mongoid (3.1.5)
+      activemodel (~> 3.2)
+      moped (~> 1.4)
+      origin (~> 1.0)
+      tzinfo (~> 0.3.29)
+    moped (1.5.1)
+    multi_json (1.8.2)
+    origin (1.1.0)
+    polyglot (0.3.3)
+    pry (0.9.12.3)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.15)
+      actionmailer (= 3.2.15)
+      actionpack (= 3.2.15)
+      activerecord (= 3.2.15)
+      activeresource (= 3.2.15)
+      activesupport (= 3.2.15)
+      bundler (~> 1.0)
+      railties (= 3.2.15)
+    railties (3.2.15)
+      actionpack (= 3.2.15)
+      activesupport (= 3.2.15)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    rspec-rails (2.14.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.4.7)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    tilt (1.4.1)
+    tins (0.13.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  coveralls
+  database_cleaner
+  jquery-rails
+  pry
+  re_track!
+  rspec-rails
+  simplecov

data/README.md

@@ -1,6 +1,9 @@
 # ReTrack
 
 [![Build Status](https://travis-ci.org/gewo/re_track.png)](https://travis-ci.org/gewo/re_track/)
+[![Coverage Status](https://coveralls.io/repos/gewo/re_track/badge.png)](https://coveralls.io/r/gewo/re_track)
+[![Code Climate](https://codeclimate.com/github/gewo/re_track.png)](https://codeclimate.com/github/gewo/re_track)
+[![Dependency Status](https://gemnasium.com/gewo/re_track.png)](https://gemnasium.com/gewo/re_track)
 
 Track HTTP-Referrers in Rails using Mongoid.
 
@@ -27,7 +30,8 @@ Or install it yourself as:
 
     OtherController
       # put in the controllers which create the model you want to track
-      cache_sweeper ReTrack::Sweeper
+      include ReTrack::Sweeper
+      re_track :user # there has to be a trackable @user instance variable
     end
 
     MyModel
@@ -35,19 +39,12 @@ Or install it yourself as:
       include ReTrack::Trackable
     end
 
-When your `OtherController` creates `MyModel` a
+When your `OtherController` creates `MyModel` in its `create`-action a
 `ReTrack::RefererTracking` is created as well, access it like this:
 
     my_model.referer_tracking
     ReTrack::RefererTracking.all.distinct(:first_url)
 
-## TODO
-
-### Get rid of `ActionController::Caching::Sweeper`!
-
-* right now ActiveRecord *and* Mongoid are required in your Rails app
-* it works although Mongoid models are observed by `ActiveRecord::Observer`s...
-
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -4,6 +4,8 @@ begin
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
+require 'appraisal'
+
 begin
   require 'rdoc/task'
 rescue LoadError
@@ -16,9 +18,13 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'ReTrack'
   rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('README.md')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
 Bundler::GemHelper.install_tasks
 
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new :spec
+
+task default: :spec

data/app/models/re_track/referer_tracking.rb

@@ -15,6 +15,9 @@ module ReTrack
     field :forwarded_ip,     type: String
     field :accept_language,  type: String
 
+    [:referer_url, :first_url, :user_agent, :first_visited_at, :ip,
+     :forwarded_ip, :accept_language].each { |field| index({ field => 1 }) }
+
     # Extract query parameters from referer_url and first_url.
     #
     # @example

data/gemfiles/rails_3.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org/"
+
+gem "jquery-rails"
+gem "rails", "~> 3.0"
+gem "mongoid", "~> 3.0"
+
+gemspec :path=>"../"

data/gemfiles/rails_4.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org/"
+
+gem "jquery-rails"
+gem "rails", "~> 4.0.0"
+gem "mongoid", "~> 4.0.0.alpha1", :github=>"mongoid/mongoid"
+
+gemspec :path=>"../"

data/lib/re_track/sweeper.rb

@@ -1,17 +1,55 @@
-class ReTrack::Sweeper < ActionController::Caching::Sweeper
-  def after_create(record)
-    if session && session[:retrack]
-      rt = ReTrack::RefererTracking.new
-      rt.trackable = record
-
-      session[:retrack].each_pair do |key, value|
-        rt[key] = value if rt.attribute_names.include?(key.to_s)
+module ReTrack
+  module Sweeper
+    extend ActiveSupport::Concern
+
+    mattr_accessor :rt_model_instance_names
+
+    included do
+      after_filter :rt_after_filter, only: :create
+    end
+
+    module ClassMethods
+      def re_track(record_instance_name)
+        (@rt_record_instance_names ||= []) << record_instance_name
       end
 
-      rt.save!
+      def rt_record_instance_names
+        (@rt_record_instance_names ||= []).uniq
+      end
     end
-  rescue => e
-    Rails.logger.info(
-      "ReTrack::Sweeper.after_create error saving record: #{e}")
+
+    private
+
+      def rt_after_filter
+        rt_records.each { |record| rt_after_create record }
+        true
+      end
+
+      def rt_records
+        self.class.rt_record_instance_names.map do |name|
+          instance_variable_get "@#{name}"
+        end
+      end
+
+      def rt_create_referer_tracking!(record)
+        rt = ReTrack::RefererTracking.new
+        rt.trackable = record
+
+        session[:retrack].each_pair do |key, value|
+          rt[key] = value if rt.attribute_names.include?(key.to_s)
+        end
+
+        rt.save!
+      end
+
+      def rt_after_create(record)
+        return unless record.persisted?
+        if session && session[:retrack]
+          rt_create_referer_tracking! record
+        end
+      rescue => e
+        Rails.logger.info(
+          "ReTrack::Sweeper.after_create error saving record: #{e}")
+      end
   end
 end

data/lib/re_track/trackable.rb

@@ -7,12 +7,8 @@ module ReTrack
     included do
       has_one :referer_tracking,
         class_name: 'ReTrack::RefererTracking',
-        as: :trackable
-
-      klass = self
-      ReTrack::Sweeper.class_eval do
-        observe klass
-      end
+        as: :trackable,
+        validate: false
     end
   end
 end

data/lib/re_track/tracker.rb

@@ -6,25 +6,28 @@ module ReTrack
       before_filter :rt_track_referer
     end
 
-    def rt_track_referer
-      if session[:retrack].nil? && !request_from_a_known_bot?
-        session[:retrack] = hash = {}
-        hash[:referer_url] = request.headers['HTTP_REFERER'].presence || 'none'
-        hash[:first_url] = request.url
-        hash[:user_agent] = request.env['HTTP_USER_AGENT']
-        hash[:first_visited_at] = Time.now
-        hash[:ip] = request.remote_ip
-        hash[:forwarded_ip] = request.env['HTTP_X_FORWARDED_FOR'] ||
-          request.env['HTTP_CLIENT_IP']
-        hash[:accept_language] = request.env['HTTP_ACCEPT_LANGUAGE']
+    private
+
+      TRACK = {
+        referer_url: ->(request) { request.headers['HTTP_REFERER'].presence || 'none' },
+        first_url: ->(request) { request.url },
+        user_agent: ->(request) { request.env['HTTP_USER_AGENT'] },
+        first_visited_at: ->(request) { Time.now },
+        ip: ->(request) { request.remote_ip },
+        accept_language: ->(request) { request.env['HTTP_ACCEPT_LANGUAGE'] },
+        forwarded_ip: ->(request) { request.env['HTTP_X_FORWARDED_FOR'] || request.env['HTTP_CLIENT_IP'] }
+      }
+
+      def rt_track_referer
+        session[:retrack].nil? && !request_from_a_known_bot? &&
+          session[:retrack] = Hash[TRACK.map { |k, v| [k, v.call(request)] }]
       end
-    end
 
-    def request_from_a_known_bot?
-      bot_user_agents = ['GoogleBot', 'Mediapartners-Google', 'msnbot',
-        'TwengaBot', 'DigExt; DTS Agent', 'YandexImages']
-      bot_user_agents_re = /\b(#{bot_user_agents * '|'})\b/i
-      request.user_agent =~ bot_user_agents_re
-    end
+      def request_from_a_known_bot?
+        bot_user_agents = ['GoogleBot', 'Mediapartners-Google', 'msnbot',
+          'TwengaBot', 'DigExt; DTS Agent', 'YandexImages']
+        bot_user_agents_re = /\b(#{bot_user_agents * '|'})\b/i
+        request.user_agent =~ bot_user_agents_re
+      end
   end
 end

data/lib/re_track/version.rb

@@ -1,3 +1,3 @@
 module ReTrack
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/lib/re_track.rb

@@ -1,7 +1,7 @@
-require "re_track/engine"
-require "re_track/tracker"
-require "re_track/sweeper"
-require "re_track/trackable"
+require 're_track/engine'
+require 're_track/tracker'
+require 're_track/sweeper'
+require 're_track/trackable'
 
 module ReTrack
 end

data/re_track.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 're_track/version'
+
+Gem::Specification.new do |s|
+  s.name          = 're_track'
+  s.version       = ReTrack::VERSION
+  s.authors       = ['Gebhard Wöstemeyer']
+  s.email         = ['g.woestemeyer@gmail.com']
+  s.homepage      = 'https://github.com/gewo/re_track'
+  s.summary       = 'Track HTTP-Referrers in Rails using Mongoid/MongoDB'
+  s.description   = 'Track HTTP-Referrers in Rails using Mongoid/MongoDB'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  s.test_files    = s.files.grep(/^spec\//)
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'rails'
+  s.add_runtime_dependency 'mongoid', '>= 3'
+  s.add_runtime_dependency 'activesupport'
+
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'coveralls'
+  s.add_development_dependency 'database_cleaner'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'appraisal'
+end

data/script/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/re_track/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/spec/controllers/referer_tracking_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe UsersController, "RefererTracking" do
+  before :each do
+    @request.env['HTTP_REFERER'] = (@referer = "awesome.pa.ge/believe/me")
+    @request.env['HTTP_USER_AGENT'] = @ua = "Fancy new UA"
+    @request.env['REMOTE_ADDR'] = @ip = '102.97.107.101'
+    get :new
+  end
+
+  it "saves referer_url to session" do
+    session[:retrack].should_not be_blank
+    session[:retrack][:referer_url].should == @referer
+  end
+
+  it "saves first_url to session" do
+    session[:retrack].should_not be_blank
+    session[:retrack][:first_url].should =~ %r(users/new$)
+  end
+
+  context "on the second request" do
+    before :each do
+      @request.env['HTTP_REFERER'] = ("this.is.the.new/referer")
+    end
+
+    it "doesn't update referer_url" do
+      get :index
+      session[:retrack][:referer_url].should == @referer
+    end
+
+    it "doesn't update first_url" do
+      get :index
+      session[:retrack][:first_url].should =~ %r(users/new$)
+    end
+  end
+
+  describe "POST 'create'" do
+    it "saves a user" do
+      expect {
+        post :create
+      }.to change(User.all, :count).by(1)
+    end
+
+    it "saves a RefererTracking" do
+      expect {
+        post :create
+      }.to change(ReTrack::RefererTracking.all, :count).by(1)
+    end
+
+    context "when saving the RefererTracking" do
+      before :each do
+        post :create
+        @rt = ReTrack::RefererTracking.last
+      end
+
+      it "saves the referer_url in RefererTracking" do
+        @rt.referer_url.should == @referer
+      end
+
+      it "saves the first_url in RefererTracking" do
+        @rt.first_url.should =~ %r(users/new$)
+      end
+
+      it "saves the user_agent in RefererTracking" do
+        @rt.user_agent.should == @ua
+      end
+
+      it "saves the first_visited_at in RefererTracking" do
+        # TODO: use Timecop
+        @rt.first_visited_at.should be_within(5.seconds).of(DateTime.now)
+      end
+
+      it "saves the correct user in RefererTracking" do
+        user = User.last
+        @rt.trackable.should == user
+      end
+
+      it 'saves the ip in RefererTracking' do
+        @rt.ip.should == @ip
+      end
+    end
+
+    it "completes the response when there are errors in the sweeper" do
+      ReTrack::RefererTracking.any_instance.stub(:save).and_raise
+      post :create
+      response.should be_a_redirect # not a 500
+    end
+  end
+end