tophold_rack 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.3-p362@tophold_rack

data/Gemfile

@@ -0,0 +1,9 @@
+source 'http://ruby.taobao.org'
+
+# Specify your gem's dependencies in tophold_rack.gemspec
+
+gem 'rack'
+
+gem 'devise'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 readline
+
+MIT License
+
+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,29 @@
+# TopholdRack
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tophold_rack'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tophold_rack
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

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

@@ -0,0 +1,47 @@
+#author: shreadline@gmail.com
+#source http://github.com/tteng/tophold_rack
+#since the tophold_rack depends on the popular authticate gem `devise`,
+#which also based on the rack style auth middlware `warden`(for more detail go and 
+#reference: 
+#         http://railscasts.com/episodes/305-authentication-with-warden
+#         http://railscasts.com/episodes/209-introducing-devise
+#onece you invoke the devise generator, say you want user model authticateable
+#~/your_console>  rails g devise User
+#which will generate migration file, model and tests etc, but the background mechanism 
+#is devise add a rack middleware to the rails middlewares stack, run `rake middleware` 
+#to get the difference around the above command.
+#warden keeps the login session, and the seesion key is related with
+#the model you want to include the devise code, which is called a `scope`, 
+#
+#  module Warden
+#    class SessionSerializer
+#      attr_reader :env
+#      include ::Warden::Mixins::Common
+#  
+#      def initialize(env)
+#        @env = env
+#      end
+#  
+#      def key_for(scope)
+#        "warden.user.#{scope}.key"
+#      end
+#  ...   ...
+#
+#
+# and the model name (here is 'user') is corresponding to the scope, and so on 'admin_user' for the admin/.
+# Therefore, in this initializer set the 'tophold_rack_devise_scope' to your corresponding deviseable model
+# name ('user' by default) and with this parameter tophold_rack
+# will *know* the current_user/current_admin_user which helps to collect individual user behavior.
+Rails.configuration.tophold_rack_devise_scope = "user"
+
+#BTW, not all requests should be analyzed, such as static files and admin requests, by default 
+#tophold_rack will not collect request begin with "uploads", "assets",
+#belowing requests will be ignored:
+#  http://somedomain.com/uploads/post/document/14/normal_786_938652_586928.jpg
+#  http://somedomain.com/assets/jquery-migrate-1.1.1.min.js?body=1 
+#  http://somedomain.com/assets/xxx/xxx.*
+#customize this to meet your requirments.
+Rails.configuration.tophold_rack_request_black_list << "admin"
+
+#3rd party tracking url
+Rails.configuration.tophold_rack_tracking_url = "http://localhost:8888/tracking/"

data/lib/generators/tophold_rack/tophold_rack_generator.rb

@@ -0,0 +1,10 @@
+require 'rails/generators'
+class TopholdRackGenerator < Rails::Generators::Base
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  def install 
+    template "tophold_rack.rb", "config/initializers/tophold_rack.rb"
+  end
+
+end

data/lib/tophold_rack/engine.rb

@@ -0,0 +1,24 @@
+module TopholdRack
+
+  class Engine < Rails::Engine
+
+    config.tophold_rack_devise_scope = "user"
+
+    config.tophold_rack_request_black_list = ["uploads", "assets"]
+
+    config.tophold_rack_tracking_url = "http://localhost:8888/tracking/"
+ 
+    initializer "tophold_rack.load_app_instance_data" do |app|
+      TopholdRack.setup do |config|
+        config.app_root = app.root
+      end
+    end   
+
+    initializer "tophold_rack.add_middleware_after_devise" do |app|
+      #app.middleware.insert_after ActionDispatch::Session::CookieStore, TopholdRack::Redispatcher
+      app.middleware.use TopholdRack::Redispatcher
+    end
+  
+  end
+
+end

data/lib/tophold_rack/redispatcher.rb

@@ -0,0 +1,33 @@
+require 'cgi'
+require 'open-uri'
+
+module TopholdRack
+
+  class Redispatcher
+
+    def initialize app
+      @app = app
+    end
+
+    def request_black_list 
+      @black_list ||= /^\/(#{Rails.configuration.tophold_rack_request_black_list.join('|')})/
+    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
+        end
+      end
+      @app.call env #pass the buckets
+    end
+  
+  end
+
+end

data/lib/tophold_rack/version.rb

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

data/lib/tophold_rack.rb

@@ -0,0 +1,14 @@
+require "tophold_rack/version"
+
+module TopholdRack
+
+  mattr_accessor :app_root
+
+  def self.setup
+    yield self
+  end
+
+end
+
+require "tophold_rack/engine"
+require "tophold_rack/redispatcher"

data/tophold_rack.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tophold_rack/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "tophold_rack"
+  gem.version       = TopholdRack::VERSION
+  gem.authors       = ["tteng"]
+  gem.email         = ["tim.rubist@gmail.com"]
+  gem.description   = %q{A rack based middleware to redispatch requested uri path to 3rd party tracking server}
+  gem.summary       = %q{A rack based middleware to redispatch requested uri path to 3rd party tracking server}
+  gem.homepage      = "http://github.com/tteng"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: tophold_rack
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- tteng
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-22 00:00:00.000000000 Z
+dependencies: []
+description: A rack based middleware to redispatch requested uri path to 3rd party
+  tracking server
+email:
+- tim.rubist@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/tophold_rack/templates/tophold_rack.rb
+- lib/generators/tophold_rack/tophold_rack_generator.rb
+- lib/tophold_rack.rb
+- lib/tophold_rack/engine.rb
+- lib/tophold_rack/redispatcher.rb
+- lib/tophold_rack/version.rb
+- tophold_rack.gemspec
+homepage: http://github.com/tteng
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A rack based middleware to redispatch requested uri path to 3rd party tracking
+  server
+test_files: []