ccdk 0.2.0

data/Manifest.txt

@@ -0,0 +1,7 @@
+README.markdown
+Manifest.txt
+bin/cc_track_user
+lib/ccdk.rb
+lib/ccdk/log_file.rb
+lib/ccdk/tdump.rb
+lib/ccdk/version.rb

data/README.markdown

@@ -0,0 +1,54 @@
+# CCDK
+
+The Crystal Commerce Debugging Kit
+
+## Description
+
+CCDK is a set of tools made to ease development of Rails applications
+developed at [Crystal Commerce](http://www.crystalcommerce.com). It
+includes both executable scripts and modules that can be mixed into
+classes to help debug. The code herein is not designed to be run as
+part of a production application, just for use while building one.
+
+## Included Executables
+
+* `cc_track_user`
+
+## `cc_track_user`
+
+`cc_track_user` is a script that will search a Rails log file for a
+specific IP address and display the actions that the user has
+performed. This can be helpful in tracking the steps a user took to
+get their session into a particular state.
+
+### Usage
+
+`cc_track_user IP_ADDR FILE [FILE ...]`
+
+* IP_ADDR is the ip address to track
+* FILE is a a file (or list of files) to search across
+
+If any the file names passed to `cc_track_user` end in `.gz`,
+`cc_track_user` will assume that they have been gzipped when it opens
+them. This makes it easy to follow a user's actions across several
+days of logs without having to unzip the file first.
+
+It is suggested to pass the files to `cc_track_user` from oldest to
+newest so the output is chronological.
+
+## Included Modules
+
+* `Ccdk::TDump`
+
+## `Ccdk::TDump`
+
+`TDump` is a module that allows you to display a templated
+representation of a record using the `#tdump` method. It can be passed
+a filename, a string template, an erb object, or an IO (really
+anything that responds to `#read`).
+
+### Examples
+
+    car.tdump('I have a <%= year %> <%= make %> <%= model %>')
+
+    product.tdump('path/to/product_template.erb')

data/bin/cc_count_actions

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+require 'ccdk/log_file'
+
+class ActionCounter
+  attr_reader :ignore_domain, :counts
+
+  def initialize(ignore_domain = false)
+    @counts        = {}
+    @ignore_domain = ignore_domain
+  end
+
+  def count(file_name)
+    log = Ccdk::LogFile.open(file_name)
+
+    log.each_block do |blk|
+      a = get_action(blk)
+
+      if a
+        counts[a] ||= 0
+        counts[a] += 1
+      end
+    end
+  end
+
+  def print_results
+    counts.sort{ |a, b| b[1] <=> a[1] }.each do |(action, count)|
+      printf("%6d: %s\n", count, action)
+    end
+  end
+
+  private
+
+  def get_action(block)
+    url = block.match(/\[http(s?):\/\/([^\/?]+(\/[^?]+))(\?.*)?\]/)
+    return nil unless url
+
+    if ignore_domain
+      url[3]
+    else
+      url[2]
+    end
+  end
+end
+
+if ARGV.size < 1
+  puts "Usage: cc_count_actions [--ignore-domain] FILE [FILE ...]"
+  exit 1
+elsif ARGV[0] == "--ignore-domain"
+  counter = ActionCounter.new(true)
+  ARGV.shift
+else
+  counter = ActionCounter.new
+end
+
+ARGV.each do |file_name|
+  counter.count(file_name)
+end
+
+begin
+  counter.print_results
+rescue Errno::EPIPE, Interrupt
+  # Allow the output to be passed to head etc
+end

data/bin/cc_track_user

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+require 'ccdk/log_file'
+
+class Tracker
+  def initialize(ip_address)
+    @ip_address = ip_address
+  end
+
+  def track(file_name)
+    log = Ccdk::LogFile.open(file_name)
+
+    log.each_block do |blk|
+      display(blk) if blk =~ /for #{@ip_address}/
+    end
+
+    log.close
+  end
+
+  def display(block)
+    timestamp_method = block.match(/at (.+)\) \[(\w+)\]/)
+    timestamp, method = timestamp_method[1], timestamp_method[2]
+    url = block.match(/\[(http(s?):\/\/.+\/.*)\]/)
+    params = block.match(/Parameters: (\{.*\})/)
+
+    if url && timestamp && method && params
+      puts timestamp
+      puts "  #{method} #{url[1]}"
+      puts "    #{params[1]}"
+      puts
+    end
+  end
+end
+
+if ARGV.size < 2
+  puts "Usage: cc_track_user IP_ADDR FILE [FILE ...]"
+  exit 1
+end
+
+tracker = Tracker.new(ARGV.shift)
+ARGV.each do |file_name|
+  tracker.track(file_name)
+end

data/lib/ccdk.rb

@@ -0,0 +1,19 @@
+module Ccdk
+  MODULES = {
+    :tdump => 'ccdk/tdump'
+  }
+
+  class << self
+    def load_all!
+      MODULES.values.each do |lib|
+        Kernel.require lib
+      end
+    end
+
+    def load(*sym)
+      sym.each do |sym|
+        Kernel.require MODULES[sym]
+      end
+    end
+  end
+end

data/lib/ccdk/log_file.rb

@@ -0,0 +1,105 @@
+require 'zlib'
+
+module Ccdk #:nodoc:
+
+  # A class for reading Rails log files. Provides a way to step through the log
+  # by assuming the format of the output conforms to the Rails defaul.
+  class LogFile
+
+    class << self
+
+      # Open a LogFile with the provided name. If the file name ends in '.gz'
+      # assume that the file is gzipped
+      #
+      # ==== Parameters
+      #
+      # * +file_name+ - The name of the log file to open
+      #
+      # ==== Examples
+      #   # Open the log file 'log/production.log'
+      #   LogFile.open('log/production.log')
+      #
+      #   # Open the gzipped log file 'log/old/production.log.1.gz'
+      #   LogFile.open('log/old/production.log.1.gz')
+      def open(file_name)
+        if file_name =~ /\.gz$/
+          GzipLogFile.new(file_name)
+        else
+          LogFile.new(file_name)
+        end
+      end
+    end
+
+    # Create a new LogFile
+    #
+    # ==== Parameters
+    #
+    # * +name+ - The name of the file to open
+    def initialize(name)
+      @fh = File.open(name, 'r')
+    end
+
+    # execute code on each block of the log file. A block is defined as starting
+    # with Processing and ending with a blank line
+    #
+    # ==== Examples
+    #   log.each_block{ |b| puts b if b =~ ApplicationController }
+    def each_block
+      while !@fh.eof?
+        yield next_block
+      end
+    end
+
+    # Read the next block from the log file
+    #
+    # TODO: please refactor me
+    def next_block
+      lines = []
+
+      line = @fh.gets
+      while !start_of_block?(line)
+        line = @fh.gets
+        return "" if @fh.eof?
+      end
+
+      while(!@fh.eof? && !end_of_block?(line))
+        lines << line.chomp
+        line = @fh.gets
+      end
+
+      lines.join("\n")
+    end
+
+    # Close the log file
+    def close
+      @fh.close
+    end
+
+    private
+
+    def start_of_block?(line)
+      line && line =~ /^Processing/
+    end
+
+    def end_of_block?(line)
+      line.nil? || line =~ /^$/ ||
+        line =~ /^Starting the New Relic/ ||
+        line =~ /^\*\* \[Hoptoad\]/
+    end
+  end
+
+  # A Gzipped version of the log file
+  # All behavior is the same as a standard log file except it assumes the
+  # content has been gzipped
+  class GzipLogFile < LogFile
+
+    # Create a new GzipLogFile. The file name passed must be gzipped
+    #
+    # ==== Parameters
+    #
+    # * +file_name+ - The name of the gzipped log file to open
+    def initialize(file_name)
+      @fh = Zlib::GzipReader.new(File.open(file_name, 'r'))
+    end
+  end
+end

data/lib/ccdk/tdump.rb

@@ -0,0 +1,62 @@
+require 'erb'
+
+module Ccdk #:nodoc:
+
+  # Create a templated representation of the object. This module can be useful
+  # For debugging objects by dumping them out to a template of your choosing.
+  # Similar in use to <tt>pp</tt>, but more flexible so that you can display
+  # only the information that you care about.
+  module TDump
+
+    # Convert the object to a <tt>String</tt> based on the provided template.
+    # Templates can be specified in several ways
+    #
+    # * A <tt>String</tt> representation of the template.
+    # * A <tt>String</tt> path to a template file
+    # * An <tt>Erb</tt> object of the template
+    # * An <tt>IO<tt> object that can be read to retrieve a template
+    #   (Really anything that responds to <tt>#read</tt>)
+    #
+    # ==== Parameters
+    #
+    # * +template+ - The template to use for formatting the object
+    #
+    # ==== Examples
+    #   # Output information to a templating string
+    #   car.tdump('I have a <%= year %> <%= make %> <%= model %>')
+    #
+    #   # Use the path to an erb template file
+    #   product.tdump('path/to/product_template.erb')
+    def tdump(template)
+      if template.is_a? ERB
+        tdump_erb(template)
+      elsif template.respond_to?(:read)
+        tdump_io(template)
+      elsif template.is_a? String
+        tdump_string(template)
+      end
+    end
+
+    private
+
+    def tdump_erb(erb)
+      erb.result(binding)
+    end
+
+    def tdump_string(string)
+      if File.exist?(string)
+        tdump_erb(ERB.new(File.read(string)))
+      else
+        tdump_erb(ERB.new(string))
+      end
+    end
+
+    def tdump_io(io)
+      tdump_erb(ERB.new(io.read))
+    end
+  end
+end
+
+class Object
+  include Ccdk::TDump
+end

data/lib/ccdk/version.rb

@@ -0,0 +1,3 @@
+module Ccdk
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: ccdk
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Ryan Burrows
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-19 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: "    Ccdk is a set of extensions and scripts helpful to debugging and development\n"
+email: rhburrows@crystalcommerce.com
+executables: 
+- cc_track_user
+- cc_count_actions
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- Manifest.txt
+- bin/cc_track_user
+- lib/ccdk.rb
+- lib/ccdk/log_file.rb
+- lib/ccdk/tdump.rb
+- lib/ccdk/version.rb
+- bin/cc_count_actions
+has_rdoc: true
+homepage: http://www.crystalcommerce.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Crystal Commerce's Debugging Kit
+test_files: []
+