simplestats 0.0.1 → 0.1.0

data/README.md

@@ -8,29 +8,41 @@ a view helper that tracks information from the client-side of a request.
 Both parts can be used independently, and when used together, SimpleStats will
 automatically store them together in the same MongoDB record.
 
-# How to use
+## How to use
 
-Mount as engine somewhere in your application:
+Mount as engine somewhere in your `config/routes.rb`:
 
-    mount SimpleStats, "/stats"
+    mount SimpleStats::Engine, "/stats"
 
-The following stuff is still TODO:
+Include the middleware component in your `config/application.rb`:
 
-* Add SimpleStats::Middleware as Rack middleware to collect
-  information from the server-side of the request.
-* In your layout, add
+    config.middleware.use SimpleStats::Middleware
 
-    <%= simple_stats_collector %>
+In your layout, add:
 
-## Contributing to simplestats
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+    :javascript
+      $(document).ready(function(){
+        jQuery.post("/stats", {
+          professional_id: #{@professional.id},
+          patient_id: #{@patient.id},
+          url: $(location).attr('href'),
+
+          browser: {
+            document: {
+              width: $(document).width(),
+              height: $(document).height()
+            }
+          }
+        });
+      });
+
+## TODO
+
+* View helpers like
+
+    <%= 
+      simple_stats_collector(:professional_id => @professional.id)
+    %>
 
 ## Copyright
 

data/Rakefile

@@ -14,7 +14,7 @@ require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
   gem.name = "simplestats"
-  gem.homepage = "http://github.com/marten/simplestats"
+  gem.homepage = "http://roqua.github.com/simplestats"
   gem.license = "MIT"
   gem.summary = %Q{A really simple webstats collection engine}
   gem.description = %Q{A Sinatra application that makes it easy to collect and store web statistics}

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/lib/simplestats.rb

@@ -1,27 +1,2 @@
-require 'sinatra/base'
-require 'mongoid'
-
-class SimpleStats < Sinatra::Base
-
-  class Stat
-    include Mongoid::Document
-  end
-
-  # This endpoint can be used to create a new stat
-  # for a request. If you don't want to store server-side
-  # processing information, this is probably what you want.
-  post '/' do
-    Stat.create!(params)
-    return 200
-  end
-
-  # This endpoint can be used to update an existing stat
-  # for a request. This makes it possible to create the
-  # stat from the controller action with information from
-  # there, and update it later on from the browser.
-  post '/:id' do |id|
-    Stat.find(id).update_attributes(params)
-    return 200
-  end
-
-end
+require "simplestats/engine"
+require "simplestats/middleware"

data/lib/simplestats/engine.rb

@@ -0,0 +1,23 @@
+require 'sinatra/base'
+require 'simplestats/stat'
+
+module SimpleStats
+  class Engine < Sinatra::Base
+    # This endpoint can be used to create a new stat
+    # for a request. If you don't want to store server-side
+    # processing information, this is probably what you want.
+    post '/' do
+      Stat.create!(params)
+      return 200
+    end
+
+    # This endpoint can be used to update an existing stat
+    # for a request. This makes it possible to create the
+    # stat from the controller action with information from
+    # there, and update it later on from the browser.
+    post '/:id' do |id|
+      Stat.find(id).update_attributes(params)
+      return 200
+    end
+  end
+end

data/lib/simplestats/middleware.rb

@@ -0,0 +1,20 @@
+require 'simplestats/stat'
+
+module SimpleStats
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      stat = SimpleStats::Stat.create(server_address: env["SERVER_ADDR"],
+                                      server_port: env["SERVER_PORT"],
+                                      request: {
+                                        uri: env["REQUEST_URI"]
+                                      })
+
+      status, headers, body = @app.call(env.merge("simplestats.stat_id" => stat.id.to_s))
+      [status, headers, body]
+    end
+  end
+end

data/lib/simplestats/stat.rb

@@ -0,0 +1,7 @@
+require 'mongoid'
+
+module SimpleStats
+  class Stat
+    include Mongoid::Document
+  end
+end

data/simplestats.gemspec

@@ -0,0 +1,77 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "simplestats"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Marten Veldthuis"]
+  s.date = "2012-02-17"
+  s.description = "A Sinatra application that makes it easy to collect and store web statistics"
+  s.email = "marten@veldthuis.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".rspec",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/simplestats.rb",
+    "lib/simplestats/engine.rb",
+    "lib/simplestats/middleware.rb",
+    "lib/simplestats/stat.rb",
+    "simplestats.gemspec",
+    "spec/simplestats/engine_spec.rb",
+    "spec/simplestats/middleware_spec.rb",
+    "spec/simplestats/stat_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://roqua.github.com/simplestats"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.11"
+  s.summary = "A really simple webstats collection engine"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<sinatra>, ["~> 1.3"])
+      s.add_runtime_dependency(%q<mongoid>, [">= 0"])
+      s.add_runtime_dependency(%q<bson_ext>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<rack-test>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<database_cleaner>, ["= 0.7.1"])
+    else
+      s.add_dependency(%q<sinatra>, ["~> 1.3"])
+      s.add_dependency(%q<mongoid>, [">= 0"])
+      s.add_dependency(%q<bson_ext>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<rack-test>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<database_cleaner>, ["= 0.7.1"])
+    end
+  else
+    s.add_dependency(%q<sinatra>, ["~> 1.3"])
+    s.add_dependency(%q<mongoid>, [">= 0"])
+    s.add_dependency(%q<bson_ext>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<rack-test>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<database_cleaner>, ["= 0.7.1"])
+  end
+end
+

data/spec/simplestats/engine_spec.rb

@@ -0,0 +1,54 @@
+require_relative '../spec_helper'
+require 'rack/test'
+
+module SimpleStats
+  describe Engine do
+    include Rack::Test::Methods
+
+    def app
+      SimpleStats::Engine
+    end
+
+    describe "POST /" do
+      before { post '/', "foo" => "bar" }
+
+      it 'saves stats' do
+        SimpleStats::Stat.count.should == 1
+      end
+
+      it 'saves params' do
+        stat = SimpleStats::Stat.first
+        stat.attributes.should == {"_id" => stat.id, "foo" => "bar"}
+      end
+
+      it 'returns HTTP 200' do
+        last_response.should be_ok
+      end
+
+      it 'returns no body' do
+        last_response.body.should be_empty
+      end
+    end
+
+    describe "POST /:id" do
+      let(:stat) { SimpleStats::Stat.create(:session => {:user_id => 1}) }
+
+      before do
+        post "/#{stat.id}", :browser => {:window => {:width => 1032}}
+      end
+
+      it 'updates existing stats' do
+        stat.reload
+        stat.browser.should == {"window" => {"width" => "1032"}}
+      end
+
+      it 'returns HTTP 200' do
+        last_response.should be_ok
+      end
+
+      it 'returns no body' do
+        last_response.body.should be_empty
+      end
+    end
+  end
+end

data/spec/simplestats/middleware_spec.rb

@@ -0,0 +1,20 @@
+require_relative "../spec_helper"
+require 'rack/test'
+
+module SimpleStats
+  describe Middleware do
+    it 'acts as middleware' do
+      app, status, headers, body = stub, stub, stub, stub
+      app.stub(:call).and_return { [status, headers, body] }
+      middleware = SimpleStats::Middleware.new(app)
+      middleware.call({}).should == [status, headers, body]
+    end
+
+    it 'creates a stat' do
+      app = stub(:call => nil)
+      middleware = SimpleStats::Middleware.new(app)
+      middleware.call({})
+      Stat.all.should have(1).stat
+    end
+  end
+end

data/spec/simplestats/stat_spec.rb

@@ -0,0 +1,7 @@
+require_relative "../spec_helper"
+
+module SimpleStats
+  describe Stat do
+    it 'saves to the db'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simplestats
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-06 00:00:00.000000000 Z
+date: 2012-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &16897920 !ruby/object:Gem::Requirement
+  requirement: &16522860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *16897920
+  version_requirements: *16522860
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &16897320 !ruby/object:Gem::Requirement
+  requirement: &16521040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *16897320
+  version_requirements: *16521040
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &16896560 !ruby/object:Gem::Requirement
+  requirement: &16519160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *16896560
+  version_requirements: *16519160
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &16895500 !ruby/object:Gem::Requirement
+  requirement: &16516420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *16895500
+  version_requirements: *16516420
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &16894340 !ruby/object:Gem::Requirement
+  requirement: &18017300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *16894340
+  version_requirements: *18017300
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &16893300 !ruby/object:Gem::Requirement
+  requirement: &18015720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16893300
+  version_requirements: *18015720
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &16892340 !ruby/object:Gem::Requirement
+  requirement: &18014880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *16892340
+  version_requirements: *18014880
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &16890620 !ruby/object:Gem::Requirement
+  requirement: &18014160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -98,7 +98,7 @@ dependencies:
         version: 0.7.1
   type: :development
   prerelease: false
-  version_requirements: *16890620
+  version_requirements: *18014160
 description: A Sinatra application that makes it easy to collect and store web statistics
 email: marten@veldthuis.com
 executables: []
@@ -107,7 +107,6 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- .document
 - .rspec
 - .travis.yml
 - Gemfile
@@ -117,9 +116,15 @@ files:
 - Rakefile
 - VERSION
 - lib/simplestats.rb
-- spec/simplestats_spec.rb
+- lib/simplestats/engine.rb
+- lib/simplestats/middleware.rb
+- lib/simplestats/stat.rb
+- simplestats.gemspec
+- spec/simplestats/engine_spec.rb
+- spec/simplestats/middleware_spec.rb
+- spec/simplestats/stat_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/marten/simplestats
+homepage: http://roqua.github.com/simplestats
 licenses:
 - MIT
 post_install_message: 
@@ -134,7 +139,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3456130462776699016
+      hash: -1231894380103482237
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt

data/spec/simplestats_spec.rb

@@ -1,52 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-require 'rack/test'
-
-describe SimpleStats do
-  include Rack::Test::Methods
-
-  def app
-    SimpleStats
-  end
-
-  describe "POST /" do
-    before { post '/', "foo" => "bar" }
-
-    it 'saves stats' do
-      SimpleStats::Stat.count.should == 1
-    end
-
-    it 'saves params' do
-      stat = SimpleStats::Stat.first
-      stat.attributes.should == {"_id" => stat.id, "foo" => "bar"}
-    end
-
-    it 'returns HTTP 200' do
-      last_response.should be_ok
-    end
-
-    it 'returns no body' do
-      last_response.body.should be_empty
-    end
-  end
-
-  describe "POST /:id" do
-    let(:stat) { SimpleStats::Stat.create(:session => {:user_id => 1}) }
-
-    before do
-      post "/#{stat.id}", :browser => {:window => {:width => 1032}}
-    end
-
-    it 'updates existing stats' do
-      stat.reload
-      stat.browser.should == {"window" => {"width" => "1032"}}
-    end
-
-    it 'returns HTTP 200' do
-      last_response.should be_ok
-    end
-
-    it 'returns no body' do
-      last_response.body.should be_empty
-    end
-  end
-end