notches 0.3.0

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+.sass-cache
+Gemfile.lock
+pkg/*
+*.sqlite
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/HISTORY

@@ -0,0 +1,2 @@
+0.1.0 - ?
+* Initial Release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Hyper Tiny
+
+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,54 @@
+Notches
+-------
+
+A Rails Engine for tracking your web traffic.
+
+Installation
+------------
+
+Add this to your Gemfile and run the `bundle` command.
+
+    gem 'notches', '~> 0.1.0'
+
+And then install and run the necessary migrations.
+
+    rake notches:install:migrations
+    rake db:migrate
+
+Mount your engine at your desired location in `config/routes.rb`.
+
+    mount Notches::Engine => '/notches'
+
+Finally to start recording hits include the notch pixel image at the bottom of your views.
+
+    <%= image_tag "/notches/hits/new.gif?url=#{request.url}" %>
+
+Counting hits
+-------------
+
+For a URL:
+
+    Notches::Hit.joins(:url).where('url like ?', '/posts').count
+
+For an IP:
+
+    Notches::Hit.joins(:ip).where('ip = ?', '127.0.0.1').count
+
+For a session id:
+
+    Notches::Hit.joins(:session).where('session_id = ?', 'abcd').count
+
+For a date:
+
+    Notches::Hit.joins(:date).where('date = ?', Date.today).count
+
+For a particular time of day:
+
+    Notches::Hit.joins(:time).where('time between ?', '09:00:00', '17:00:00').count
+
+Or a user agent:
+
+    Notches::Hit.joins(:user_agent).where('user_agent like ?', '%Mobile%').count
+
+To get a better idea of how Notches is setup check out the
+[Notches::Hit](http://github.com/hypertiny/notches/blob/master/app/models/notches/hit.rb) model.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :default => :test
+task :test    => :spec

data/app/controllers/notches/hits_controller.rb

@@ -0,0 +1,18 @@
+class Notches::HitsController < ActionController::Base
+  def new
+    session[:notches]
+    Notches::Hit.log(
+      :url => params[:url],
+      :user_agent => request.env["HTTP_USER_AGENT"],
+      :session_id => request.session_options[:id],
+      :ip => request.remote_ip
+    )
+
+    # Don't cache the image.
+    response.header["Last-Modified"] = Time.now.httpdate
+
+    send_file Notches::Engine.root.join("app/assets/images/notches/hit.gif"),
+              :type => "image/gif",
+              :disposition => "inline"
+  end
+end

data/app/models/notches/date.rb

@@ -0,0 +1,6 @@
+class Notches::Date < ActiveRecord::Base
+  self.table_name = "notches_dates"
+
+  has_many :hits, :class_name => "Notches::Hit",
+                  :foreign_key => 'notches_date_id'
+end

data/app/models/notches/hit.rb

@@ -0,0 +1,37 @@
+class Notches::Hit < ActiveRecord::Base
+  self.table_name = "notches_hits"
+
+  validates :url,     :presence => true
+  validates :session, :presence => true
+  validates :ip,      :presence => true
+
+  validates_associated :url, :session, :ip
+
+  belongs_to :url,        :foreign_key => :notches_url_id, :class_name => "URL"
+  belongs_to :user_agent, :foreign_key => :notches_user_agent_id
+  belongs_to :session,    :foreign_key => :notches_session_id
+  belongs_to :ip,         :foreign_key => :notches_ip_id, :class_name => "IP"
+  belongs_to :date,       :foreign_key => :notches_date_id
+  belongs_to :time,       :foreign_key => :notches_time_id
+
+  scope :unique, group("notches_url_id, notches_session_id, notches_ip_id")
+
+  def self.log(attributes)
+    hit = self.new
+    hit.transaction do
+      Rails.logger.info("[Notches] Tracking #{attributes.inspect} at #{Date.today} #{Time.now}")
+      hit.url = Notches::URL.find_or_create_by_url(attributes[:url])
+      hit.user_agent = Notches::UserAgent.find_or_create_by_user_agent(attributes[:user_agent])
+      hit.session = Notches::Session.find_or_create_by_session_id(attributes[:session_id])
+      hit.ip = Notches::IP.find_or_create_by_ip(attributes[:ip])
+      hit.date = Notches::Date.find_or_create_by_date(Date.today)
+      hit.time = Notches::Time.find_or_create_by_time(Time.now)
+      begin
+        hit.save!
+      rescue #ActiveRecord::RecordNotUnique
+        Rails.logger.info "Skipping non-unique hit"
+      end
+    end
+    hit
+  end
+end

data/app/models/notches/ip.rb

@@ -0,0 +1,8 @@
+class Notches::IP < ActiveRecord::Base
+  self.table_name = "notches_ips"
+
+  has_many :hits, :class_name => "Notches::Hit",
+                  :foreign_key => 'notches_ip_id'
+
+  validates :ip, :presence => true, :allow_blank => false
+end

data/app/models/notches/session.rb

@@ -0,0 +1,8 @@
+class Notches::Session < ActiveRecord::Base
+  self.table_name = "notches_sessions"
+
+  has_many :hits, :class_name => "Notches::Hit",
+                  :foreign_key => 'notches_session_id'
+
+  validates :session_id, :presence => true
+end

data/app/models/notches/time.rb

@@ -0,0 +1,6 @@
+class Notches::Time < ActiveRecord::Base
+  self.table_name = "notches_times"
+
+  has_many :hits, :class_name => "Notches::Hit",
+                  :foreign_key => 'notches_time_id'
+end

data/app/models/notches/url.rb

@@ -0,0 +1,8 @@
+class Notches::URL < ActiveRecord::Base
+  self.table_name = "notches_urls"
+
+  has_many :hits, :class_name => "Notches::Hit",
+                  :foreign_key => 'notches_url_id'
+
+  validates :url, :presence => true
+end

data/app/models/notches/user_agent.rb

@@ -0,0 +1,5 @@
+class Notches::UserAgent < ActiveRecord::Base
+  self.table_name = "notches_user_agents"
+
+  has_many :hits, :class_name => "Notches::Hit"
+end

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize!
+run Combustion::Application

data/config/routes.rb

@@ -0,0 +1,3 @@
+Notches::Engine.routes.draw do
+  get '/hits/new' => 'hits#new', :as => :new_hit
+end

data/db/migrate/20120323111734_create_notches.rb

@@ -0,0 +1,55 @@
+class CreateNotches < ActiveRecord::Migration
+  def up
+    create_table :notches_urls do |t|
+      t.string :url
+    end
+    create_table :notches_sessions do |t|
+      t.string :session_id
+    end
+    create_table :notches_ips do |t|
+      t.string :ip
+    end
+    create_table :notches_dates do |t|
+      t.date :date
+    end
+    create_table :notches_times do |t|
+      t.time :time
+    end
+    create_table :notches_hits do |t|
+      t.integer :notches_url_id, :null => false
+      t.integer :notches_session_id, :null => false
+      t.integer :notches_ip_id, :null => false
+      t.integer :notches_date_id, :null => false
+      t.integer :notches_time_id, :null => false
+    end
+    add_index :notches_urls, :url
+    add_index :notches_sessions, :session_id
+    add_index :notches_ips, :ip
+    add_index :notches_dates, :date
+    add_index :notches_times, :time
+    add_index :notches_hits, [
+      :notches_time_id,
+      :notches_date_id,
+      :notches_ip_id,
+      :notches_session_id,
+      :notches_url_id
+    ], :name => :notches_index, :unique => true
+  end
+
+  def down
+    remove_index :notches_urls, :url
+    remove_index :notches_sessions, :session_id
+    remove_index :notches_ips, :ip
+    remove_index :notches_dates, :date
+    remove_index :notches_times, :time
+    change_table :notches_hits do |t|
+      t.remove_index :name => :notches_index
+    end
+    drop_table :notches_urls
+    drop_table :notches_sessions
+    drop_table :notches_ips
+    drop_table :notches_dates
+    drop_table :notches_times
+    drop_table :notches_hits
+  end
+end

data/db/migrate/20120713142636_create_notches_user_agents.rb

@@ -0,0 +1,34 @@
+class CreateNotchesUserAgents < ActiveRecord::Migration
+  def up
+    create_table :notches_user_agents do |t|
+      t.text :user_agent
+    end
+    add_column :notches_hits, :notches_user_agent_id, :integer
+    change_table :notches_hits do |t|
+      t.remove_index :name => :notches_index
+    end
+    add_index :notches_hits, [
+      :notches_time_id,
+      :notches_date_id,
+      :notches_ip_id,
+      :notches_session_id,
+      :notches_url_id,
+      :notches_user_agent_id
+    ], :name => :notches_index, :unique => true
+  end
+
+  def down
+    change_table :notches_hits do |t|
+      t.remove_index :name => :notches_index
+    end
+    add_index :notches_hits, [
+      :notches_time_id,
+      :notches_date_id,
+      :notches_ip_id,
+      :notches_session_id,
+      :notches_url_id
+    ], :name => :notches_index, :unique => true
+    remove_column :notches_hits, :notches_user_agent_id
+    drop_table :notches_user_agents
+  end
+end

data/lib/notches.rb

@@ -0,0 +1,3 @@
+require 'rails'
+require 'notches/engine'
+require 'notches/version'

data/lib/notches/engine.rb

@@ -0,0 +1,5 @@
+module Notches
+  class Engine < ::Rails::Engine
+    isolate_namespace Notches
+  end
+end

data/lib/notches/version.rb

@@ -0,0 +1,3 @@
+module Notches
+  VERSION = '0.3.0'
+end

data/notches.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "notches/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'notches'
+  s.version     = Notches::VERSION
+  s.authors     = ["Cillian O'Ruanaidh", "Paul Campbell"]
+  s.email       = ['contact@cilliano.com']
+  s.homepage    = 'http://github.com/hypertiny/notches'
+  s.summary     = %q{Simple Rails web traffic counter}
+  s.description = %q{A Rails Engine for tracking your web traffic.}
+
+  s.rubyforge_project = 'notches'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f|
+    File.basename(f)
+  }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency     'rails',           '~> 3.1'
+
+  s.add_development_dependency 'combustion', '~> 0.3.2'
+  s.add_development_dependency 'rspec-rails', '~> 2.11'
+  s.add_development_dependency 'sqlite3',     '~> 1.3.4'
+end

data/spec/controllers/notches/hits_controller_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Notches::HitsController do
+  describe "#new" do
+    it "returns an image" do
+      get :new, :url => '/posts', :format => 'gif'
+
+      response.headers["Content-Type"].should == 'image/gif'
+    end
+
+    it "logs the hit" do
+      @request.env['HTTP_USER_AGENT'] = 'FeedBurner/1.0'
+      @request.stub(:remote_ip => '234.101.82.14')
+      @request.stub(:session_options => { :id => 'abcd' })
+
+      get :new, :url => '/posts', :format => 'gif'
+
+      Notches::Hit.count.should == 1
+      hit = Notches::Hit.first
+      hit.url.url.should == '/posts'
+      hit.user_agent.user_agent.should == 'FeedBurner/1.0'
+      hit.ip.ip.should == '234.101.82.14'
+      hit.session.session_id.should == 'abcd'
+    end
+  end
+end

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/notches_test.sqlite

data/spec/internal/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  namespace 'notches' do
+    resources :hits, :only => [:new]
+  end
+end

data/spec/internal/db/schema.rb

@@ -0,0 +1,2 @@
+ActiveRecord::Schema.define do
+end

data/spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/models/notches/hit_spec.rb

@@ -0,0 +1,156 @@
+require 'spec_helper'
+
+describe Notches::Hit do
+  describe "validations" do
+    let(:hit) do
+      Notches::Hit.new(
+        :url => Notches::URL.new(:url => "/posts"),
+        :session => Notches::Session.new(:session_id => '1234'),
+        :ip => Notches::IP.new(:ip => '209.85.143.94')
+      )
+    end
+
+    its "valid with valid attributes" do
+      hit.should be_valid
+    end
+
+    it "requires an ip" do
+      hit.ip = nil
+      hit.should have(1).error_on(:ip)
+    end
+
+    it "requires a session" do
+      hit.session = nil
+      hit.should have(1).error_on(:session)
+    end
+
+    it "requires a " do
+      hit.url = nil
+      hit.should have(1).error_on(:url)
+    end
+
+    it "does not validate if its IP's ip blank" do
+      hit.ip = Notches::IP.new(:ip => '')
+      hit.should have(1).error_on(:ip)
+    end
+
+    it "does not validate if its Session's session_id is blank" do
+      hit.session = Notches::Session.new(:session_id => '')
+      hit.should have(1).error_on(:session)
+    end
+
+    it "does not validate if its URL's url is blank" do
+      hit.url = Notches::URL.new(:url => '')
+      hit.should have(1).error_on(:url)
+    end
+  end
+
+  describe ".log" do
+
+    context "with valid attributes" do
+      let(:today) { Date.today }
+      let(:now) { Time.now }
+      before do
+        Date.stub(:today => today)
+        Time.stub(:now => now)
+      end
+
+      it "creates a hit for today and current time with those attributes" do
+        Notches::Hit.log({
+          :url => '/posts',
+          :user_agent => 'FeedBurner/1.0',
+          :session_id => '1',
+          :ip => '0.0.0.1'
+        })
+        hit = Notches::Hit.first
+        hit.should be_present
+        hit.url.url.should == '/posts'
+        hit.session.session_id.should == '1'
+        hit.ip.ip.should == '0.0.0.1'
+        hit.date.date.should == today
+        hit.time.time.strftime('%H:%M:%S').should == now.strftime('%H:%M:%S')
+        hit.user_agent.user_agent.should == 'FeedBurner/1.0'
+      end
+    end
+
+    let(:existing_hit) { 
+      Notches::Hit.log(
+        :url => "/posts/1",
+        :user_agent => 'FeedBurner/1.0',
+        :session_id => '1',
+        :ip => '0.0.0.1'
+      )
+    }
+
+    it "does not create a new IP record if there's a record for that IP already" do
+      hit = Notches::Hit.log(
+        :url => "/posts/2",
+        :session_id => '2',
+        :ip => existing_hit.ip.ip
+      )
+      hit.ip.id.should == existing_hit.ip.id
+    end
+
+    it "does not create a new URL record if there's a record for that URL already" do
+      hit = Notches::Hit.log(
+        :url => existing_hit.url.url,
+        :session_id => '2',
+        :ip => '0.0.0.2'
+      )
+      hit.url.id.should == existing_hit.url.id
+    end
+
+    it "does not create a new Session record there's a record for that session id already" do
+      hit = Notches::Hit.log(
+        :url => "/posts/2",
+        :session_id => existing_hit.session.session_id,
+        :ip => '0.0.0.2'
+      )
+      hit.session.id.should == existing_hit.session.id
+    end
+
+    it "does not create a new Date record there's a record for that Date already" do
+      hit = Notches::Hit.log(
+        :url => '/posts/2',
+        :session_id => '2',
+        :ip => '0.0.0.2'
+      )
+      hit.date.id.should == existing_hit.date.id
+    end
+
+    it "does not create a new Time record there's a record for that Time already" do
+      Time.stub(:now => existing_hit.time.time)
+      hit = Notches::Hit.log(
+        :url => '/posts/2',
+        :session_id => '2',
+        :ip => '0.0.0.2'
+      )
+      hit.time.id.should == existing_hit.time.id
+    end
+
+    it "does not create a new UserAgent record if there's a record for that UserAgent already" do
+      hit = Notches::Hit.log(
+        :url => '/post/2',
+        :user_agent => 'FeedBurner/1.0',
+        :session_id => '2',
+        :ip => '0.0.0.2'
+      )
+      hit.user_agent.id.should == existing_hit.user_agent.id
+    end
+
+    context "a hit with the same url, session, ip, date and time exists already" do
+      it "does not log the hit" do
+        Date.stub(:today => existing_hit.date.date)
+        Time.stub(:now => existing_hit.time.time)
+        expect {
+          hit = Notches::Hit.log(
+            :url => existing_hit.url.url,
+            :user_agent => 'FeedBurner/1.0',
+            :session_id => existing_hit.session.session_id,
+            :ip => existing_hit.ip.ip
+          )
+        }.to_not change { Notches::Hit.count }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize!
+
+require 'rspec/rails'
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: notches
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+  prerelease: 
+platform: ruby
+authors:
+- Cillian O'Ruanaidh
+- Paul Campbell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+description: A Rails Engine for tracking your web traffic.
+email:
+- contact@cilliano.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- HISTORY
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/images/notches/hit.gif
+- app/controllers/notches/hits_controller.rb
+- app/models/notches/date.rb
+- app/models/notches/hit.rb
+- app/models/notches/ip.rb
+- app/models/notches/session.rb
+- app/models/notches/time.rb
+- app/models/notches/url.rb
+- app/models/notches/user_agent.rb
+- config.ru
+- config/routes.rb
+- db/migrate/20120323111734_create_notches.rb
+- db/migrate/20120713142636_create_notches_user_agents.rb
+- lib/notches.rb
+- lib/notches/engine.rb
+- lib/notches/version.rb
+- notches.gemspec
+- spec/controllers/notches/hits_controller_spec.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/models/notches/hit_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/hypertiny/notches
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1181156043935805657
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1181156043935805657
+requirements: []
+rubyforge_project: notches
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple Rails web traffic counter
+test_files:
+- spec/controllers/notches/hits_controller_spec.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/models/notches/hit_spec.rb
+- spec/spec_helper.rb