re_track 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 17258306272edcd9f384aaab7c92a8211708f802
+  data.tar.gz: 147f192b1545431a897e379d0ae13a0280a9edea
+SHA512:
+  metadata.gz: f65b3b7dce2ef33846a21582af79001076e7b45bd9de926e3dc0071ab7f4ea2451acea272823844abc05d14e805e74332686133457578dd942b05253d7c2bec5
+  data.tar.gz: 84f764231ebb6d4ba7121bcc16fa1623a3c5ff253c09786e959ca8022f755b87d5306d9c57b39e937b2fda5fedd2119402a1790df48b73f3d8b2adbf4fdb3af9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# ReTrack
+
+[![Build Status](https://travis-ci.org/gewo/re_track.png)](https://travis-ci.org/gewo/re_track/)
+
+Track HTTP-Referrers in Rails using Mongoid.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 're_track'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install re_track
+
+## Usage
+
+    ApplicationController
+      # saves referer information to the session
+      include ReTrack::Tracker
+    end
+
+    OtherController
+      # put in the controllers which create the model you want to track
+      cache_sweeper ReTrack::Sweeper
+    end
+
+    MyModel
+      # include in every model that should get tracking information added
+      include ReTrack::Trackable
+    end
+
+When your `OtherController` creates `MyModel` 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
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credit
+
+[re_track](http://github.com/gewo/re_track/) is inspired (read: stolen)
+by [referer_tracking](http://github.com/holli/referer_tracking). Thanks.
+
+## License
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,24 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+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('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+

data/app/models/re_track/referer_tracking.rb

@@ -0,0 +1,44 @@
+module ReTrack
+  class RefererTracking
+    include ::Mongoid::Document
+    include ::Mongoid::Timestamps
+
+    store_in collection: 'retrack_referer_trackings'
+
+    belongs_to :trackable, polymorphic: true
+
+    field :referer_url,      type: String
+    field :first_url,        type: String
+    field :user_agent,       type: String
+    field :first_visited_at, type: DateTime
+
+    # Extract query parameters from referer_url and first_url.
+    #
+    # @example
+    #   r = ReTrack::RefererTracking.new referer_url: 'http://google.de/?q=a'
+    #   r.query('q')               # => 'a'
+    #   r.query('a')               # => nil
+    #   r.query('q', 'first_url')  # => nil
+    #
+    # @param parameter [String] The Query String Parameter to look up.
+    # @param url_field_name [String] The URL field to query. Either
+    #   'referer_url' or 'first_url'.
+    #
+    # @return [String] The value for the given query parameter or nil.
+    def query(parameter, url_field_name = 'referer_url')
+      return nil unless url = value_for(url_field_name)
+      query_hash(url)[parameter.to_s]
+    end
+
+    private
+
+      def query_hash(url)
+        Rack::Utils.parse_query URI.parse(CGI::unescape(url)).query rescue {}
+      end
+
+      def value_for(field)
+        return nil unless ['referer_url', 'first_url'].include? field.to_s
+        public_send("#{field}")
+      end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+ReTrack::Engine.routes.draw do
+end

data/lib/re_track/engine.rb

@@ -0,0 +1,7 @@
+require 'mongoid'
+
+module ReTrack
+  class Engine < ::Rails::Engine
+    isolate_namespace ReTrack
+  end
+end

data/lib/re_track/sweeper.rb

@@ -0,0 +1,17 @@
+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)
+      end
+
+      rt.save!
+    end
+  rescue => e
+    Rails.logger.info(
+      "ReTrack::Sweeper.after_create error saving record: #{e}")
+  end
+end

data/lib/re_track/trackable.rb

@@ -0,0 +1,18 @@
+require 'active_support/concern'
+
+module ReTrack
+  module Trackable
+    extend ActiveSupport::Concern
+
+    included do
+      has_one :referer_tracking,
+        class_name: 'ReTrack::RefererTracking',
+        as: :trackable
+
+      klass = self
+      ReTrack::Sweeper.class_eval do
+        observe klass
+      end
+    end
+  end
+end

data/lib/re_track/tracker.rb

@@ -0,0 +1,26 @@
+module ReTrack
+  module Tracker
+    extend ActiveSupport::Concern
+
+    included do
+      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
+      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
+  end
+end

data/lib/re_track/version.rb

@@ -0,0 +1,3 @@
+module ReTrack
+  VERSION = "0.1.0"
+end

data/lib/re_track.rb

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

data/lib/tasks/re_track_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :re_track do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: re_track
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gebhard Wöstemeyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Track HTTP-Referrers in Rails using Mongoid/MongoDB
+email:
+- g.woestemeyer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/models/re_track/referer_tracking.rb
+- config/routes.rb
+- lib/re_track.rb
+- lib/tasks/re_track_tasks.rake
+- lib/re_track/version.rb
+- lib/re_track/tracker.rb
+- lib/re_track/trackable.rb
+- lib/re_track/engine.rb
+- lib/re_track/sweeper.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/gewo/re_track
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Track HTTP-Referrers in Rails using Mongoid/MongoDB
+test_files: []