rack-probe 0.0.3

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

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

@@ -0,0 +1,53 @@
+Rack::Probe : dtrace probes for your webapp
+===========================================
+
+status
+------
+
+Rack::Probe (along with Dtracy) is part of the Ruby on Rail's Google Summer of Code '09 Quartet, with development updates and entertainment available at `http://ecin.tumblr.com` Welcome! Sit down, grab a sugary drink, and enjoy the smell of freshly baked code right out of the oven.
+
+requirements
+------------
+
+An operating system with support for Dtrace (http://www.sun.com/bigadmin/content/dtrace/) is a must. Mac OS X, Solaris/OpenSolaris and FreeBSD are all acceptable choices, though no testing has been done on FreeBSD.
+
+gem dependencies
+------------
+
+* rack
+* ruby-dtrace
+
+installing
+----------
+
+`gem sources -a http://gems.github.com`
+
+`gem install ecin-rack-probe`
+
+setup
+-----
+
+Rails Middleware:
+
+_Inside your config/environment.rb_
+
+`config.gem "ecin-rack-probe", :lib => "rack/probe"`
+
+`config.middleware.use "Rack::Probe"`
+
+Rack Middleware:
+
+_Inside your rackup file_
+
+`require 'rack/probe'`
+`use Rack::Probe`
+
+use
+---
+
+From a terminal, run `dtrace -n rack*::: -l` to get a list of all the available probes. The number you'll see after 'rack' in the provider field is the PID of the process that's making the probes available.
+
+copyright
+---------
+
+Copyright (c) 2009 ecin. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rack-probe"
+    gem.summary = %Q{Rack::Probe adds Dtrace probes to your Rack apps.}
+    gem.description = %Q{Rack::Probe provides a set of probes for Rack that fire with each request.}
+    gem.email = "ecin@copypastel.com"
+    gem.homepage = "http://github.com/ecin/rack-probe"
+    gem.authors = ["ecin"]
+    gem.add_dependency "ruby-dtrace", ">= 0.2.8"
+    gem.add_dependency "rack", ">= 1.0.0"
+    gem.add_development_dependency "rspec"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rack-probe #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.3

data/lib/rack-probe.rb

@@ -0,0 +1,3 @@
+module Rack
+  autoload :Probe, 'rack/probe'
+end

data/lib/rack/probe.rb

@@ -0,0 +1,55 @@
+class Symbol
+  unless instance_methods.include? :to_proc
+    def to_proc
+      Proc.new { |obj, *args| obj.send(self, *args) }
+    end
+  end
+end
+
+module Rack
+  class Probe
+    
+    gem 'ruby-dtrace', '>= 0.2.7'
+    require 'dtrace/provider'
+        
+    def initialize( app, opts = {} )
+      # Unless our probes are already defined...
+      unless Dtrace::Probe::Rack.instance_of? Dtrace::Provider::Klass
+        Dtrace::Provider.create :rack do |p|
+          p.probe :get                # GET request
+          p.probe :post               # POST request
+          p.probe :put                # PUT request
+          p.probe :delete             # DELETE request
+          p.probe :ip,  :string       # IP of the requester
+          p.probe :path,  :string     # Path visited 
+          p.probe :referer, :string   # Referer
+          p.probe :xhr                # AJAX request
+          
+          p.probe :request_start      # Start of a request
+          p.probe :request_finish     # End of a request
+        end
+      end
+    
+      # Provider shortcut
+      @R = Dtrace::Probe::Rack
+      @app = app
+    end
+
+    def call( env )
+      @R.request_start(&:fire)
+      request = Rack::Request.new env
+      @R.get(&:fire) if request.get?
+      @R.post(&:fire) if request.post?
+      @R.put(&:fire)  if request.put?
+      @R.delete(&:fire) if request.delete?
+      @R.xhr(&:fire) if request.xhr?
+      @R.path    { |p| p.fire(request.path) }
+      @R.ip      { |p| p.fire(request.ip) }
+      @R.referer { |p| p.fire(request.referer) }
+      response = @app.call(env)
+      @R.request_finish(&:fire)
+      response
+    end
+
+  end
+end

data/rack-probe.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rack-probe}
+  s.version = "0.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["ecin"]
+  s.date = %q{2009-08-21}
+  s.description = %q{Rack::Probe provides a set of probes for Rack that fire with each request.}
+  s.email = %q{ecin@copypastel.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/rack-probe.rb",
+     "lib/rack/probe.rb",
+     "rack-probe.gemspec",
+     "spec/rack/probe_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/ecin/rack-probe}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Rack::Probe adds Dtrace probes to your Rack apps.}
+  s.test_files = [
+    "spec/rack/probe_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ruby-dtrace>, [">= 0.2.8"])
+      s.add_runtime_dependency(%q<rack>, [">= 1.0.0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<ruby-dtrace>, [">= 0.2.8"])
+      s.add_dependency(%q<rack>, [">= 1.0.0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<ruby-dtrace>, [">= 0.2.8"])
+    s.add_dependency(%q<rack>, [">= 1.0.0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end

data/spec/rack/probe_spec.rb

@@ -0,0 +1,136 @@
+require File.expand_path(File.dirname(__FILE__)+'/../spec_helper.rb')
+
+require 'spec/interop/test'
+require 'dtrace'
+
+describe Rack::Probe do
+  include Rack::Test::Methods
+  
+  def app
+    a = lambda { [200, {'Content-Type' => 'text/html'},''] }
+    Rack::Probe.new(a)
+  end
+
+  def compile_script(script)
+    @compiler.compile(script).execute
+    @compiler.go
+    DtraceConsumer.new(@compiler)
+  end
+
+  class DtraceConsumer
+    def finished?
+      @done
+    end
+  end
+
+  before :each do
+    @q = Proc.new {'hello'}
+    @compiler = Dtrace.new
+    @compiler.setopt('bufsize', '8m')
+  end
+
+  it 'should fire a probe with a request\'s ip' do
+    Rack::Probe.new @q
+    consumer = compile_script ":::ip {trace(copyinstr((int) arg0));}"
+    get '/'
+    consumer.consume_once do |d|
+      record = d.data.first
+      record.value.should match(/.*\..*\..*\..*/)
+      consumer.finish
+    end
+    consumer.finished?.should be_true
+  end
+  
+  it 'should fire a probe with a request\'s path' do
+    consumer = compile_script ":::path {trace(copyinstr((int) arg0));}"
+    get '/'
+    consumer.consume_once do |d|
+      record = d.data.first
+      record.value.should eql('/')
+      consumer.finish
+    end
+    consumer.finished?.should be_true
+  end
+  
+  it 'should fire a probe with a request\'s referer' do
+    consumer = compile_script ":::referer {trace(copyinstr((int) arg0));}"
+    get '/'
+    consumer.consume_once do |d|
+      record = d.data.first
+      record.value.should eql('/')
+      consumer.finish
+    end
+    consumer.finished?.should be_true
+  end
+  
+  it 'should fire a probe when a request is a GET' do
+    consumer = compile_script ":::get {}"
+    get '/'
+    consumer.consume_once do |d|
+      d.probe.name.should eql('get')
+      consumer.finish
+    end
+    consumer.finished?.should be_true
+  end
+  
+  it 'should fire a probe when a request is a POST' do
+    consumer = compile_script ":::post {}"
+    post '/'
+    consumer.consume_once do |d|
+      d.probe.name.should eql('post')
+      consumer.finish
+    end
+    consumer.finished?.should be_true
+  end
+  
+  it 'should fire a probe when a request is a PUTS' do
+    consumer = compile_script ":::put {}"
+    put '/'
+    consumer.consume_once do |d|
+      d.probe.name.should eql('put')
+      consumer.finish
+    end
+    consumer.finished?.should be_true
+  end
+  
+  it 'should fire a probe when a request is a DELETE' do
+    consumer = compile_script ":::delete {}"
+    delete '/'
+    consumer.consume_once do |d|
+      d.probe.name.should eql('delete')
+      consumer.finish
+    end
+    consumer.finished?.should be_true
+  end
+  
+  it 'should fire a probe when a request is a XHR' do
+    consumer = compile_script ":::xhr {}"
+    get '/', {}, { "HTTP_X_REQUESTED_WITH" => "XMLHttpRequest" }
+    consumer.consume_once do |d|
+      d.probe.name.should eql('xhr')
+      consumer.finish
+    end
+    consumer.finished?.should be_true
+  end
+  
+  it 'should fire a probe when a request is started' do
+    consumer = compile_script ":::request_start {}"
+    get '/'
+    consumer.consume_once do |d|
+      d.probe.name.should eql('request_start')
+      consumer.finish
+    end
+    consumer.finished?.should be_true
+  end
+  
+  it 'should fire a probe when a request finishes' do
+    consumer = compile_script ":::request_finish {}"
+    get '/'
+    consumer.consume_once do |d|
+      d.probe.name.should eql('request_finish')
+      consumer.finish
+    end
+    consumer.finished?.should be_true
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'rack/probe'
+require 'rack/test'
+require 'spec'
+require 'spec/autorun'
+
+# Be sure to run tests with sudo/as root, as it makes use of Dtrace
+# consumers.
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: rack-probe
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- ecin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-21 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-dtrace
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.8
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Rack::Probe provides a set of probes for Rack that fire with each request.
+email: ecin@copypastel.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/rack-probe.rb
+- lib/rack/probe.rb
+- rack-probe.gemspec
+- spec/rack/probe_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/ecin/rack-probe
+licenses: []
+
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Rack::Probe adds Dtrace probes to your Rack apps.
+test_files: 
+- spec/rack/probe_spec.rb
+- spec/spec_helper.rb