tophold_rack 0.0.1 → 0.1.1

data/README.md

@@ -1,6 +1,18 @@
-# TopholdRack
+## Scenario
 
-TODO: Write a gem description
+Once you want to do some statistics on your ROR application, there're three solutions so far as I know.
+
+  *  One is to analyze the log file(decouple way, but need to customize the log format to record who is the current user) 
+  *  The other way is add some callbacks in your code(coupled). 
+  *  And also you could use the google analytics(not so realtime). 
+
+Today I introduce you the way I do. 
+
+When we talk about how to authticate in rails, people may suggest you the very popular gem ``` devise ```, it's based on the ```warden``` middleware, and you can access the seeeion in your rack code. 
+
+Since with rack we could access the request info(path, query string etc) and we also could access the session info, why not we collect these info and parse it? 
+
+That's what tophold_rack do. Tophold rack will not perform *statistics* work, it only collect nessary info and send it to the 3rd party ( I coded this module with node, see detail at [here] (https://github.com/tteng/fetch_stock_quotes/blob/master/src/tracking_handler.coffee)
 
 ## Installation
 
@@ -16,9 +28,27 @@ Or install it yourself as:
 
     $ gem install tophold_rack
 
+After installation, run 
+
+    $ rails g tophold_rack install  
+
+to generate the config file.
+
 ## Usage
 
-TODO: Write usage instructions here
+Say, if you authticate with admin_user.rb model, change the devise scope to corresponding model name.
+
+    Rails.configuration.tophold_rack_devise_scope = "admin_user"
+
+Sometimes we don't want to analyze assets and some static file uri, it make no sense. You could customize the uri black list, by default tophold_rack will ignore uri begin with 'assets', 'uploads'.
+
+    Rails.configuration.tophold_rack_request_black_list << "admin"
+
+The last thing is to specify which url to receive these parameters and to do the detaild parse job. I prefer node, it's bloody fast and non-block, will make the cost to the minimum level. Also you can push these parameters to a redis list, and parse it with blpop, it's up to you.
+
+And the last, you can disable/enable this middleware by toggle the switch
+
+    Rails.configuration.tophold_rack_disabled = true/false
 
 ## Contributing
 

data/lib/generators/tophold_rack/templates/tophold_rack.rb

@@ -45,3 +45,7 @@ Rails.configuration.tophold_rack_request_black_list << "admin"
 
 #3rd party tracking url
 Rails.configuration.tophold_rack_tracking_url = "http://localhost:8888/tracking/"
+
+#if Rails.env.development?
+#  Rails.configuration.tophold_rack_disabled = true
+#end

data/lib/tophold_rack/engine.rb

@@ -7,6 +7,8 @@ module TopholdRack
     config.tophold_rack_request_black_list = ["uploads", "assets"]
 
     config.tophold_rack_tracking_url = "http://localhost:8888/tracking/"
+
+    config.tophold_rack_disabled = false
  
     initializer "tophold_rack.load_app_instance_data" do |app|
       TopholdRack.setup do |config|

data/lib/tophold_rack/redispatcher.rb

@@ -14,15 +14,17 @@ module TopholdRack
     end
 
     def call env
-      request = Rack::Request.new env
-      if request.get?
-        path, query = request.path, request.query_string
-        scope = env["rack.session"]["warden.user.#{Rails.configuration.tophold_rack_devise_scope}.key"]
-        user_id = scope ? scope[1][0] : nil
-        unless path =~ request_black_list            
-          str = "#{path.blank? ? '/' : path}?query=#{query}&user_id=#{user_id}" 
-          url = Rails.configuration.tophold_rack_tracking_url+"?request_url=#{CGI.escape str}"
-          open url
+      unless Rails.configuration.tophold_rack_disabled
+        request = Rack::Request.new env
+        if request.get?
+          path, query = request.path, request.query_string
+          scope = env["rack.session"]["warden.user.#{Rails.configuration.tophold_rack_devise_scope}.key"]
+          user_id = scope ? scope[1][0] : nil
+          unless path =~ request_black_list            
+            str = "#{path.blank? ? '/' : path}?query=#{query}&user_id=#{user_id}" 
+            url = Rails.configuration.tophold_rack_tracking_url+"?request_url=#{CGI.escape str}"
+            open url
+          end
         end
       end
       @app.call env #pass the buckets

data/lib/tophold_rack/version.rb

@@ -1,3 +1,3 @@
 module TopholdRack
-  VERSION = "0.0.1"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tophold_rack
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-22 00:00:00.000000000 Z
+date: 2013-03-30 00:00:00.000000000 Z
 dependencies: []
 description: A rack based middleware to redispatch requested uri path to 3rd party
   tracking server