rack-analytics 0.0.1 → 0.0.2

data/README.markdown

@@ -49,7 +49,20 @@ You can also change the parser, to remove some of the fields (on the future, you
 
 		use Rack::Analytics::RequestLogger
 
-Be sure to just use one of those, since they are mutually excludent (and `only` has a preference over `except`).
+Be sure to just use one of those, since they are mutually excludent (and `only` has a preference over `except`). You can also create custom parsers, too, you just need to feed the parser with lambdas, like that:
+
+    require 'rack/analytics'
+
+    parser = Rack::Analytics::RequestParser.new
+
+    parser << lambda { |env, data| data['port'] = env['SERVER_PORT'] }
+    parser << lambda { |env, data| data['test'] = env['rack.test'] }
+
+    Rack::Analytics.parser = parser
+
+    use Rack::Analytics::RequestLogger
+
+The env is a hash with all the parameters of the request, and the data is the fields that are saved on the MongoDB. Just be creative. You can use any kind of object, though, as long that they respond to `call` with two arguments.
 
 ## Notes on Patches/Pull Requests ##
 

data/lib/rack/analytics/request_parser.rb

@@ -12,6 +12,11 @@ module Rack
       def only=(values)
         @only = values.to_a
       end
+      
+      def <<(field)
+        @custom_fields ||= []
+        @custom_fields << field
+      end
 
       def parse request
         @data = {}
@@ -21,13 +26,18 @@ module Rack
         @data['user_agent'] = request['HTTP_USER_AGENT'] if to_parse.include? 'user_agent'
         @data['referral'] = request['HTTP_REFERER'] if to_parse.include? 'referral'
 
+        @custom_fields.to_a.each do |field|
+          raise TypeError unless field.respond_to? :call
+          field.call(request, @data)
+        end
+
         return self
       end
 
       private
       def to_parse
-        @only ? @only.to_a : DEFAULT_KEYS - @except.to_a
+        @to_parse ||= (@only ? @only.to_a : DEFAULT_KEYS - @except.to_a)
       end
     end
   end
-end
+end

data/lib/rack/analytics/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module Analytics
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/test/request_logger_test.rb

@@ -1,9 +1,9 @@
 require 'teststrap'
 
 context "Rack::Analytics::RequestLogger" do
-  helper(:db) { mongo }
+  setup { db.drop_collection 'views' }
   teardown { Rack::Analytics.finish! }
-  
+
   context "should render a get request correctly" do
     setup { get '/' }
 
@@ -40,19 +40,13 @@ context "Rack::Analytics::RequestLogger" do
   end
 
   context "should create a access document when visiting the page" do
-    setup do
-      db.drop_collection 'views'
-
-      get '/'
-    end
+    setup { get '/' }
 
     asserts('counter has incremented') { db['views'].count }.equals 1
   end
 
   context "shouldn't create a access document when with post, put and delete" do
     setup do
-      db.drop_collection 'views'
-
       post '/'
       put '/'
       delete '/'
@@ -62,44 +56,28 @@ context "Rack::Analytics::RequestLogger" do
   end
 
   context "should save the path of the access" do
-    setup do
-      db.drop_collection 'views'
-
-      get '/'
-    end
+    setup { get '/' }
 
     asserts('it should have a time key') { db['views'].find_one }.includes 'path'
     asserts('it should have a time set') { db['views'].find_one['path'] }.equals '/'
   end
 
   context "should save the time of the access" do
-    setup do
-      db.drop_collection 'views'
-
-      get '/'
-    end
+    setup { get '/' }
 
     asserts('it should have a time key') { db['views'].find_one }.includes 'time'
     asserts('it should have a time set') { db['views'].find_one['time'] }.kind_of Time
   end
 
   context "should save the referral information" do
-    setup do
-      db.drop_collection 'views'
-
-      get '/', {}, 'HTTP_REFERER' => 'http://www.google.com'
-    end
+    setup { get '/', {}, 'HTTP_REFERER' => 'http://www.google.com' }
 
     asserts('it should have a referral key') { db['views'].find_one }.includes 'referral'
     asserts('it should have a correct referral set') { db['views'].find_one['referral'] }.equals 'http://www.google.com'
   end
 
   context "should save the user agent information" do
-    setup do
-      db.drop_collection 'views'
-
-      get 'views', {}, 'HTTP_USER_AGENT' => 'Firefox'
-    end
+    setup { get 'views', {}, 'HTTP_USER_AGENT' => 'Firefox' }
 
     asserts('it should have a user agent key') { db['views'].find_one }.includes 'user_agent'
     asserts('it should have a correct user agent set') { db['views'].find_one['user_agent'] }.equals 'Firefox'

data/test/request_parser_test.rb

@@ -24,7 +24,7 @@ context 'Rack::Analytics::RequestParser' do
       topic.except = 'time'
       topic.parse(request).data['time']
     end.nil
-    
+
     asserts ('it should accept multiple values as arguments') do
       topic.except = ['time']
       topic.parse(request).data['time']
@@ -38,10 +38,24 @@ context 'Rack::Analytics::RequestParser' do
       topic.only = 'time'
       topic.parse(request).data['path']
     end.nil
-    
+
     asserts ('it should accept multiple values as arguments') do
       topic.except = ['time', 'path']
       topic.parse(request).data['user_agent']
     end.nil
   end
-end
+
+  context "should accept custom fields" do
+    setup { Rack::Analytics::RequestParser.new }
+
+    asserts('it should receive the custom fields') do
+      topic << lambda { |env, data| data['port'] = env['SERVER_PORT'] }
+      topic.parse(request).data['port']
+    end.equals '80'
+
+    asserts('it should raise TypeError when receiving non-callables') do
+      topic << 0
+      topic.parse request
+    end.raises TypeError
+  end
+end

data/test/support/test_helpers.rb

@@ -1,15 +1,15 @@
 module TestHelpers
   def app
     Rack::Builder.new do
-      Rack::Analytics.db = mongo
+      Rack::Analytics.db = db
 
       use Rack::Analytics::RequestLogger
       run DummyApp
     end
   end
 
-  def mongo
+  def db
     connection = Mongo::Connection.new
     connection.db 'rack-analytics-test'
   end
-end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rack-analytics
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - "Cain\xC3\xA3 Costa"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-31 00:00:00 -02:00
+date: 2011-02-04 00:00:00 -02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency