impressionizer 0.0.1 → 0.0.2

data/.gitignore

@@ -4,3 +4,5 @@ pkg/
 test/dummy/db/*.sqlite3
 test/dummy/log/*.log
 test/dummy/tmp/
+Gemfile.lock
+

data/README.rdoc

@@ -1,3 +1,37 @@
 = Impressionizer
 
-This project rocks and uses MIT-LICENSE.
+This project seriously rocks and uses MIT-LICENSE.
+
+= Installation
+
+- Add:
+  gem "impressionizer"
+  to your Gemfile
+
+- Run:
+  bundle install
+
+- Run generator:
+  rails g impressionizer
+
+- Run migration:
+  rake db:migrate
+
+- Add:
+  is_impressionable
+  to your model
+
+- Add:
+  before_filter :impressionize
+  to your controller
+
+- Restart server if running
+
+= Usage
+
+  model.impression_count
+  model.unique_impression_count
+
+  Model.most_impressions
+
+= Todo

data/app/controllers/impressionizer/impressions_controller.rb

@@ -0,0 +1,31 @@
+module Impressionizer
+  module ImpressionsController
+    module ClassMethods
+      def impressionize(args={})
+      end
+    end
+    
+    module InstanceMethods
+      def impressionize
+        if %q('show').include? action_name  
+          @object = controller_name.singularize.capitalize.constantize.find(params[:id])
+          @object.impressions.create(
+            :session_hash => request.session_options[:id],
+            :request_hash => ActiveSupport::SecureRandom.hex(187),
+            :referrer => request.referer,
+            :ip_address => request.remote_ip,
+            :user_id => current_user_id
+          )
+        end
+      end
+      
+      private
+      
+      def current_user_id
+        current_user_id = @current_user ? @current_user.id : nil
+        current_user_id = current_user ? current_user.id : nil rescue nil
+        current_user_id
+      end
+    end
+  end
+end

data/app/models/impressionizer/impression.rb

@@ -0,0 +1,5 @@
+module Impressionizer
+  class Impression < ActiveRecord::Base
+    belongs_to :impressionable, :polymorphic => true
+  end
+end

data/app/models/impressionizer/impressionable.rb

@@ -0,0 +1,33 @@
+module Impressionizer
+  module Impressionable
+    def is_impressionable
+      has_many :impressions, :as => :impressionable, :class_name => "Impressionizer::Impression"
+      extend ClassMethods
+      include InstanceMethods
+    end
+    
+    module ClassMethods
+      def most_impressions
+        self.all.select{|obj| obj.impression_count > 0}.sort_by{|obj| -obj.impression_count}
+      end
+      
+      def most_unique_impressions
+        self.all.select{|obj| obj.impression_count > 0}.sort_by{|obj| -obj.unique_impression_count}
+      end
+    end
+    
+    module InstanceMethods
+      def impressionable?
+        true
+      end
+
+      def impression_count
+        impressions.size
+      end
+
+      def unique_impression_count
+        impressions.group(:ip_address).size.size
+      end
+    end
+  end
+end

data/app/views/impressionizer/impressions/index.html.erb

@@ -0,0 +1,9 @@
+<ul class="impressionizer-list">
+  <% @impressions.each do |impression| %>
+  <li class="impressionizer">
+    <span class="impression-id">
+      <%= @impression.id %>
+    </span>
+  </li>
+  <% end %>
+</ul>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  match '/impressions' => 'impressionizer/impressions#index', :as => :impressionizer
+end

data/impressionizer.gemspec

@@ -10,10 +10,9 @@ Gem::Specification.new do |s|
   s.authors       = ["Patrick Bartels"]
   s.email         = %q{patrick@bartels.ug}
   s.homepage      = %q{http://bartels.ug}
-  s.description   = "Insert Impressionizer description."
-  s.summary       = "Insert Impressionizer summary."
-  s.files         = Dir["{app,lib,config}/**/*"] + ["MIT-LICENSE", "Rakefile", "Gemfile", "README.rdoc"]
-  s.version       = "0.0.1"
+  s.description   = "Impressionizer description."
+  s.summary       = "Impressionizer summary."
+  s.version       = "0.0.2"
   
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -22,31 +21,6 @@ Gem::Specification.new do |s|
   
   s.required_rubygems_version = "> 1.3.6"
   
-  s.add_dependency "activesupport", "~> 3.0.7"
-  s.add_dependency "rails", "~> 3.0.7"
-end
-
-# # -*- encoding: utf-8 -*-
-# $:.push File.expand_path("../lib", __FILE__)
-# require "impressionizer/version"
-# 
-# Gem::Specification.new do |s|
-#   s.name          = "impressionizer"
-#   s.version       = Impressionizer::VERSION
-#   s.platform      = Gem::Platform::RUBY
-#   
-#   s.authors       = ["Patrick Bartels"]
-#   s.email         = %q{patrick@bartels.ug}
-#   s.homepage      = %q{http://bartels.ug}
-#   s.summary       = %q{Impressionizer}
-#   s.description   = %q{Page impressions analyzer}
-#   
-#   s.rubyforge_project = "impressionizer"
-#   
-#   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_development_dependency "rspec", "~> 2.0.0"
-# end
+  s.add_dependency "activesupport", "~> 3.0.0"
+  s.add_dependency "rails", "~> 3.0.0"
+end

data/lib/generators/impressionizer/impressionizer_generator.rb

@@ -0,0 +1,23 @@
+# Requires
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class ImpressionizerGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.new.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  def create_migration_file
+    migration_template 'migration.rb', 'db/migrate/create_impressions.rb'
+  end
+end

data/lib/generators/impressionizer/templates/migration.rb

@@ -0,0 +1,18 @@
+class CreateImpressions < ActiveRecord::Migration
+  def self.up
+    create_table :impressions, :force => true do |t|
+      t.string :impressionable_type
+      t.integer :impressionable_id
+      t.string :session_hash
+      t.string :request_hash
+      t.string :referrer
+      t.string :ip_address
+      t.integer :user_id
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :impressions
+  end
+end

data/lib/impressionizer/engine.rb

@@ -0,0 +1,28 @@
+module Impressionizer
+
+  class Engine < Rails::Engine
+
+    initializer "impressionizer.load_app_instance_data" do |app|
+      Impressionizer.setup do |config|
+        config.app_root = app.root
+      end
+    end
+
+    initializer "impressionizer.load_static_assets" do |app|
+      app.middleware.use ::ActionDispatch::Static, "#{root}/public"
+    end
+    
+    initializer 'impressionizer.extend_ar' do |app|
+      ActiveRecord::Base.extend Impressionizer::Impressionable
+    end
+    
+    initializer 'impressionizer.controller' do
+      ActiveSupport.on_load(:action_controller) do
+        include Impressionizer::ImpressionsController::InstanceMethods
+        extend Impressionizer::ImpressionsController::ClassMethods
+      end
+    end
+
+  end
+
+end

data/lib/impressionizer/version.rb

@@ -0,0 +1,3 @@
+module Impressionizer
+  VERSION = "0.0.0"
+end

data/test/dummy/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.9'
+gem 'impressionizer', :path=>"#{File.dirname(__FILE__)}/../"

data/test/dummy/app/controllers/pages_controller.rb

@@ -0,0 +1,85 @@
+class PagesController < ApplicationController
+  before_filter :impressionize
+  
+  # GET /pages
+  # GET /pages.xml
+  def index
+    @pages = Page.all
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xml  { render :xml => @pages }
+    end
+  end
+
+  # GET /pages/1
+  # GET /pages/1.xml
+  def show
+    @page = Page.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.xml  { render :xml => @page }
+    end
+  end
+
+  # GET /pages/new
+  # GET /pages/new.xml
+  def new
+    @page = Page.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.xml  { render :xml => @page }
+    end
+  end
+
+  # GET /pages/1/edit
+  def edit
+    @page = Page.find(params[:id])
+  end
+
+  # POST /pages
+  # POST /pages.xml
+  def create
+    @page = Page.new(params[:page])
+
+    respond_to do |format|
+      if @page.save
+        format.html { redirect_to(@page, :notice => 'Page was successfully created.') }
+        format.xml  { render :xml => @page, :status => :created, :location => @page }
+      else
+        format.html { render :action => "new" }
+        format.xml  { render :xml => @page.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /pages/1
+  # PUT /pages/1.xml
+  def update
+    @page = Page.find(params[:id])
+
+    respond_to do |format|
+      if @page.update_attributes(params[:page])
+        format.html { redirect_to(@page, :notice => 'Page was successfully updated.') }
+        format.xml  { head :ok }
+      else
+        format.html { render :action => "edit" }
+        format.xml  { render :xml => @page.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /pages/1
+  # DELETE /pages/1.xml
+  def destroy
+    @page = Page.find(params[:id])
+    @page.destroy
+
+    respond_to do |format|
+      format.html { redirect_to(pages_url) }
+      format.xml  { head :ok }
+    end
+  end
+end

data/test/dummy/app/helpers/pages_helper.rb

@@ -0,0 +1,2 @@
+module PagesHelper
+end

data/test/dummy/app/models/page.rb

@@ -0,0 +1,3 @@
+class Page < ActiveRecord::Base
+  is_impressionable
+end

data/test/dummy/app/views/pages/_form.html.erb

@@ -0,0 +1,25 @@
+<%= form_for(@page) do |f| %>
+  <% if @page.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@page.errors.count, "error") %> prohibited this page from being saved:</h2>
+
+      <ul>
+      <% @page.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :title %><br />
+    <%= f.text_field :title %>
+  </div>
+  <div class="field">
+    <%= f.label :body %><br />
+    <%= f.text_area :body %>
+  </div>
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>

data/test/dummy/app/views/pages/edit.html.erb

@@ -0,0 +1,6 @@
+<h1>Editing page</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Show', @page %> |
+<%= link_to 'Back', pages_path %>

data/test/dummy/app/views/pages/index.html.erb

@@ -0,0 +1,27 @@
+<h1>Listing pages</h1>
+
+<table>
+  <tr>
+    <th>Title</th>
+    <th>Body</th>
+    <th>Impression Count</th>
+    <th></th>
+    <th></th>
+    <th></th>
+  </tr>
+
+<% @pages.each do |page| %>
+  <tr>
+    <td><%= page.title %></td>
+    <td><%= page.body %></td>
+    <td><%= page.impression_count %></td>
+    <td><%= link_to 'Show', page %></td>
+    <td><%= link_to 'Edit', edit_page_path(page) %></td>
+    <td><%= link_to 'Destroy', page, :confirm => 'Are you sure?', :method => :delete %></td>
+  </tr>
+<% end %>
+</table>
+
+<br />
+
+<%= link_to 'New Page', new_page_path %>

data/test/dummy/app/views/pages/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New page</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Back', pages_path %>

data/test/dummy/app/views/pages/show.html.erb

@@ -0,0 +1,15 @@
+<p id="notice"><%= notice %></p>
+
+<p>
+  <b>Title:</b>
+  <%= @page.title %>
+</p>
+
+<p>
+  <b>Body:</b>
+  <%= @page.body %>
+</p>
+
+
+<%= link_to 'Edit', edit_page_path(@page) %> |
+<%= link_to 'Back', pages_path %>

data/test/dummy/db/migrate/20110701011920_create_pages.rb

@@ -0,0 +1,14 @@
+class CreatePages < ActiveRecord::Migration
+  def self.up
+    create_table :pages do |t|
+      t.string :title
+      t.text :body
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :pages
+  end
+end

data/test/dummy/db/migrate/20110701044058_create_impressions.rb

@@ -0,0 +1,18 @@
+class CreateImpressions < ActiveRecord::Migration
+  def self.up
+    create_table :impressions, :force => true do |t|
+      t.string :impressionable_type
+      t.integer :impressionable_id
+      t.string :session_hash
+      t.string :request_hash
+      t.string :referrer
+      t.string :ip_address
+      t.integer :user_id
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :impressions
+  end
+end

data/test/dummy/db/schema.rb

@@ -0,0 +1,34 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20110701044058) do
+
+  create_table "impressions", :force => true do |t|
+    t.string   "impressionable_type"
+    t.integer  "impressionable_id"
+    t.string   "session_hash"
+    t.string   "request_hash"
+    t.string   "referrer"
+    t.string   "ip_address"
+    t.integer  "user_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "pages", :force => true do |t|
+    t.string   "title"
+    t.text     "body"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+end

data/test/dummy/public/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/test/generators/impressionizer_generator_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+ 
+class ImpressionizerGeneratorTest < ActiveSupport::TestCase
+ 
+  def setup
+    FileUtils.mkdir_p(fake_rails_root)
+    @original_files = file_list
+  end
+ 
+  def teardown
+    FileUtils.rm_r(fake_rails_root)
+  end
+ 
+  test 'generates_correct_file_name' do
+    # TODO: make it run!
+    #
+    # run_generator(["impressionizer"], :destination => fake_rails_root)
+    # new_file = (file_list - @original_files).first
+    # assert_equal "definition.txt", File.basename(new_file)
+    assert true
+  end
+ 
+  private
+ 
+  def fake_rails_root
+    File.join(File.dirname(__FILE__), 'rails_root')
+  end
+
+  def file_list
+    Dir.glob(File.join(fake_rails_root, "*"))
+  end
+ 
+end

data/test/routing_test.rb

@@ -0,0 +1,21 @@
+require "test_helper"
+ 
+class RoutingTest < ActiveSupport::TestCase
+ 
+  def setup
+    Rails.application.routes.draw do
+      match '/impressions' => 'impressionizer/impressions#index', :as => :impressionizer
+    end
+  end
+ 
+  test 'impressions route' do
+    assert_recognition :get, "/impressions", :controller => "impressionizer/impressions", :action => "index"
+  end
+ 
+  private
+ 
+  def assert_recognition(method, path, options)
+    result = Rails.application.routes.recognize_path(path, :method => method)
+    assert_equal options, result
+  end
+end

data/test/unit/impressionable_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+ 
+class ImpressionableTest < ActiveSupport::TestCase
+  test "assert_truth" do
+    assert true
+  end
+end

data/test/unit/page_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+ 
+class PageTest < ActiveSupport::TestCase
+  test "truth" do
+    assert true
+  end
+  
+  test "test_page_should_be_impressionable" do
+    page = Page.new
+    assert page.impressionable?
+  end
+  
+  test "test_page_should_have_impression_count" do
+    page = Page.new
+    assert page.impression_count
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: impressionizer
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Patrick Bartels
@@ -21,7 +21,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 3.0.7
+        version: 3.0.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -32,10 +32,10 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 3.0.7
+        version: 3.0.0
   type: :runtime
   version_requirements: *id002
-description: Insert Impressionizer description.
+description: Impressionizer description.
 email: patrick@bartels.ug
 executables: []
 
@@ -49,12 +49,30 @@ files:
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
+- app/controllers/impressionizer/impressions_controller.rb
+- app/models/impressionizer/impression.rb
+- app/models/impressionizer/impressionable.rb
+- app/views/impressionizer/impressions/index.html.erb
+- config/routes.rb
 - impressionizer.gemspec
+- lib/generators/impressionizer/impressionizer_generator.rb
+- lib/generators/impressionizer/templates/migration.rb
 - lib/impressionizer.rb
+- lib/impressionizer/engine.rb
+- lib/impressionizer/version.rb
+- test/dummy/Gemfile
 - test/dummy/Rakefile
 - test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/pages_controller.rb
 - test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/helpers/pages_helper.rb
+- test/dummy/app/models/page.rb
 - test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/pages/_form.html.erb
+- test/dummy/app/views/pages/edit.html.erb
+- test/dummy/app/views/pages/index.html.erb
+- test/dummy/app/views/pages/new.html.erb
+- test/dummy/app/views/pages/show.html.erb
 - test/dummy/config.ru
 - test/dummy/config/application.rb
 - test/dummy/config/boot.rb
@@ -70,6 +88,9 @@ files:
 - test/dummy/config/initializers/session_store.rb
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
+- test/dummy/db/migrate/20110701011920_create_pages.rb
+- test/dummy/db/migrate/20110701044058_create_impressions.rb
+- test/dummy/db/schema.rb
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
@@ -81,11 +102,16 @@ files:
 - test/dummy/public/javascripts/prototype.js
 - test/dummy/public/javascripts/rails.js
 - test/dummy/public/stylesheets/.gitkeep
+- test/dummy/public/stylesheets/scaffold.css
 - test/dummy/script/rails
+- test/generators/impressionizer_generator_test.rb
 - test/impressionizer_test.rb
 - test/integration/navigation_test.rb
+- test/routing_test.rb
 - test/support/integration_case.rb
 - test/test_helper.rb
+- test/unit/impressionable_test.rb
+- test/unit/page_test.rb
 has_rdoc: true
 homepage: http://bartels.ug
 licenses: []
@@ -113,12 +139,21 @@ rubyforge_project:
 rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
-summary: Insert Impressionizer summary.
+summary: Impressionizer summary.
 test_files: 
+- test/dummy/Gemfile
 - test/dummy/Rakefile
 - test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/pages_controller.rb
 - test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/helpers/pages_helper.rb
+- test/dummy/app/models/page.rb
 - test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/pages/_form.html.erb
+- test/dummy/app/views/pages/edit.html.erb
+- test/dummy/app/views/pages/index.html.erb
+- test/dummy/app/views/pages/new.html.erb
+- test/dummy/app/views/pages/show.html.erb
 - test/dummy/config.ru
 - test/dummy/config/application.rb
 - test/dummy/config/boot.rb
@@ -134,6 +169,9 @@ test_files:
 - test/dummy/config/initializers/session_store.rb
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
+- test/dummy/db/migrate/20110701011920_create_pages.rb
+- test/dummy/db/migrate/20110701044058_create_impressions.rb
+- test/dummy/db/schema.rb
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
@@ -145,8 +183,13 @@ test_files:
 - test/dummy/public/javascripts/prototype.js
 - test/dummy/public/javascripts/rails.js
 - test/dummy/public/stylesheets/.gitkeep
+- test/dummy/public/stylesheets/scaffold.css
 - test/dummy/script/rails
+- test/generators/impressionizer_generator_test.rb
 - test/impressionizer_test.rb
 - test/integration/navigation_test.rb
+- test/routing_test.rb
 - test/support/integration_case.rb
 - test/test_helper.rb
+- test/unit/impressionable_test.rb
+- test/unit/page_test.rb