anerian-rack-analytics 0.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Anerian LLC
+
+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.rdoc

@@ -0,0 +1,7 @@
+= rack-analytics
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 Anerian LLC. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rack-analytics"
+    gem.summary = %Q{A gem that provides rack middleware to capture analytics}
+    gem.email = "dev@anerian.com"
+    gem.homepage = "http://github.com/anerian/rack-analytics"
+    gem.authors = ["Jack Dempsey"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rack-analytics #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 0
+:patch: 0

data/lib/rack-analytics.rb

@@ -0,0 +1,134 @@
+require 'ruby-prof'
+require 'ruby-debug'
+
+$reporter = nil
+$mutex = Mutex.new
+module Rack
+  class Reporter
+    attr_accessor :logfile
+    def initialize(logfile=nil)
+      @logfile = logfile
+    end
+  end
+  # Set the profile=process_time query parameter to download a
+  # calltree profile of the request.
+  #
+  # Pass the :printer option to pick a different result format.
+  class Analytics
+    LOG_DIR = '.'
+    LOGFILE_MAX_SIZE = 1024 * 500# in bytes, ie 1 mb
+    LOGFILE_MAX_AGE = 3 # in seconds, ie 1 hour
+
+    MODES = %w(
+      process_time
+      wall_time
+      cpu_time
+    )
+
+    def initialize(app, options = {})
+      $reporter ||= Reporter.new
+      @app = app
+      @profile_type = :time 
+      @write_type = :file
+    end
+
+    def call(env)
+     case @profile_type 
+     when :prof
+       profile(env, mode)
+     when :time
+      start_time = Time.now
+      app_response = @app.call(env)
+      end_time = Time.now
+
+      time_taken = end_time - start_time
+  
+      # dup, otherwise we screw up the env hash for rack
+      # also merge with an empty new Hash to create a real Hash and not a Mongrel::HttpParams 'hash'
+      @rack_env = Hash.new.merge(env.dup)
+    
+      # a mix of IO and Action::* classes that rails can't to_yaml
+      @rack_env.delete('rack.errors')
+      @rack_env.delete('rack.input')
+      @rack_env.delete('action_controller.rescue.request')
+      @rack_env.delete('action_controller.rescue.response')
+      @rack_env.delete('rack.session')
+
+      data = {:time_taken => time_taken, :created_at => Time.now.to_i, :rack_env => @rack_env}
+
+      if @write_type == :file
+        $mutex.synchronize do
+          set_new_logfile unless $reporter.logfile
+          filename = $reporter.logfile
+          if logfile_needs_rotating?(filename)
+            filename = rotate_logfile(filename)
+          end
+          file_write(filename, data.to_yaml)
+        end
+      elsif @write_type == :db
+        ActiveRecord::Base.connection.insert("insert into log_entries (time_taken, details, created_at) values (#{time_taken}, #{ActiveRecord::Base.connection.quote(@rack_env)}, #{Time.now.to_i})")
+      end
+      app_response
+     else
+       @app.call(env)
+     end
+    end
+
+    def rotate_logfile(filename)
+      debug "rotating logfile"
+      `mv #{filename} archived.#{filename}`
+      set_new_logfile
+    end
+
+    def logfile_needs_rotating?(filename)
+      # this assumes an analysis.port_number.timestamp.log layout
+      created_at = filename.split('.')[2].to_i
+      (Time.now.to_i - created_at) > LOGFILE_MAX_AGE or (::File.exists?(filename) and ::File.size(filename) > LOGFILE_MAX_SIZE)
+    end
+        
+    def set_new_logfile
+      $reporter.logfile = get_new_logfile_name 
+    end
+
+    def get_new_logfile_name
+      "analysis.#{@rack_env['SERVER_PORT']}.#{Time.now.to_i}.log"
+    end
+
+    def profile(env, mode)
+      RubyProf.measure_mode = RubyProf.const_get(mode.upcase)
+
+      rails_response = []
+      result = RubyProf.profile do
+        rails_response = @app.call(env)
+      end
+
+      store_in_filesystem(result, env)
+
+      [200, {'Content-Type' => 'text/html'}, rails_response[2]]
+    end
+
+    def file_write(filename, data)
+      debug "writing out file #{filename}"
+      ::File.open(filename, 'a') {|file| file.write data}
+    end
+
+    def store_in_filesystem(result, env)
+      filename = "public/analytics.profile.#{timestamp}.txt"
+      string = StringIO.new
+      RubyProf::FlatPrinter.new(result).print(string, :min_percent => 0.01)
+      string.rewind
+      file_write(filename, string)
+
+      filename = "public/analytics.rack_env.#{timestamp}.txt"
+      file_write(filename, env.to_hash.to_yaml)
+    end
+
+    def timestamp
+      "%10.6f" % Time.now.to_f
+    end
+
+    def debug(text)
+      puts text if $DEBUG
+    end
+  end
+end

data/test/rack_analytics_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class RackAnalyticsTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rack_analytics'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: anerian-rack-analytics
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Jack Dempsey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-22 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: dev@anerian.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/rack-analytics.rb
+- test/rack_analytics_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/anerian/rack-analytics
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: A gem that provides rack middleware to capture analytics
+test_files: 
+- test/rack_analytics_test.rb
+- test/test_helper.rb