almaz-revelation 0.0.4

data/.gitignore

@@ -0,0 +1,4 @@
+dump.rdb
+pkg
+almaz-*.gem
+almaz.gemspec

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009 James Pozdena
+ 
+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.textile

@@ -0,0 +1,26 @@
+h1. Almaz
+
+<img src='http://jpoz.net/almaz-medium-transparent.png'/>
+
+Almaz is always watching!
+
+h2. Explanation
+
+Almaz is rack middlware which logs request information to a redis server, under a preset user session variable.
+
+h2. Example
+
+h3. Almaz::Capture
+
+<pre>
+  <code>
+    require 'almaz'
+
+    use Almaz::Capture
+  
+    Almaz.config[:redis] = {:db => 0, :host => 'localhost', :port => 6379} # this is also the default
+    Almaz.config[:session_variable] = :user #this is also the default
+  </code>
+</pre>
+
+By using Almaz::Capture and setting the session_variable to :user, all requests are now logged under 'almaz::user::(session[:user])' in redis. Each user gets a separate list in the redis DB. All requests that don't have the session variable :user are logged under 'almaz::user::'.

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'rake'
+require 'spec'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "almaz-revelation"
+    gem.summary = "Almaz is watching!"
+    gem.description = "Almaz is a ruby rack middleware redis logger"
+    gem.email = "ops@revelationglobal.com"
+    gem.homepage = "http://github.com/revelation/almaz"
+    gem.authors = ['James Pozdena', 'Max Ogden', 'Andrew Kurtz', 'Dan Herrera']
+    gem.add_dependency "redis"
+    gem.add_dependency "json"
+    gem.add_development_dependency 'timecop'
+    gem.add_development_dependency 'sinatra'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: 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

data/lib/almaz.rb

@@ -0,0 +1,43 @@
+require 'redis'
+require 'json'
+
+class Almaz
+  @config = { :redis => {:db => 0},
+              :session_variable => :user,
+              :max_list_size => 100,
+              :capture_keys => [:request_method, :path_info, :referrer, :params, :ip]
+            }
+  
+  def self.config
+    @config
+  end
+  
+  class Capture
+    def initialize(app)
+      @app = app
+      @r = Redis.new(Almaz.config[:redis])
+    end
+    
+    def call(env)
+      begin
+        request = Rack::Request.new(env)
+        key = "almaz::#{Almaz.config[:session_variable]}::#{env['rack.session'][Almaz.config[:session_variable]]}"
+        @r.rpush(key, capture_keys(request).to_json)
+        @r.ltrim(key, 0, Almaz.config[:max_list_size] - 1)
+      rescue => e
+        puts "ALMAZ ERROR: #{e}"
+      end
+      
+      @app.call(env)
+    end
+
+    def capture_keys(request)
+      captured = {}
+      Rack::Request.public_instance_methods(false).each do |request_method|
+        captured[request_method] = request.send(request_method.to_sym) if Almaz.config[:capture_keys].include?(request_method.to_sym)
+      end
+      captured.merge!(:time => Time.now.to_s)
+      captured
+    end
+  end
+end

data/spec/almaz_spec.rb

@@ -0,0 +1,64 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+require 'rack/test'
+
+describe Almaz do
+  before(:each) do
+    Almaz.config[:redis] = {:db => 15}
+  end
+
+  describe Almaz::Capture do
+    include Rack::Test::Methods
+ 
+    def app
+      use Rack::Session::Cookie, :key => '_max_project_session'
+      use Almaz::Capture
+      Sinatra::Application
+    end
+  
+    describe "with session's user id" do
+  
+      before(:each) do
+        session_info = {:user => 1}
+        rack_mock_session.set_cookie("_max_project_session=#{[Marshal.dump(session_info)].pack("m*")}")
+      end
+
+      it "should capture the request path under the session_variable" do
+        get '/awesome/controller'
+        @db.lrange('almaz::user::1',0,-1).first.should include('/awesome/controller')
+      end
+    
+      it "should capture the request query params under the session_variable" do
+        get '/awesome/controller?whos=yourdaddy&what=doeshedo'
+        logged_request = @db.lrange('almaz::user::1',0,-1).first
+        JSON.parse(logged_request)['params'].should == {"whos"=>"yourdaddy", "what"=>"doeshedo"}
+      end
+
+      it "should capture the request method params under the session_variable" do
+        get '/awesome/controller'
+        @db.lrange('almaz::user::1',0,-1).first.should include('GET')
+      end
+
+      it "should capture the post params under the session_variable" do
+        post '/awesome/controller', :didyouknow => 'thatyouremyhero'
+        logged_request = @db.lrange('almaz::user::1',0,-1).first
+        JSON.parse(logged_request)['params'].should == {"didyouknow"=>"thatyouremyhero"}
+      end
+      
+      it "should record a timestamp on each request" do
+        Timecop.freeze(Date.today + 30) do        
+          post '/awesome/controller', :didyouknow => 'thatyouremyhero'
+          @db.lrange('almaz::user::1',0,-1).first.should include(Time.now.to_s)
+        end
+      end
+      
+      it "should only store the most recent requests up to the maximum configured length" do
+        max_size = Almaz.config[:max_list_size] = 10
+        post '/awesome/controller', :didyouknow => 'thisshouldbedeleted'
+        max_size.times {|taco| post '/awesome/controller', :didyouknow => 'thatyouremyhero'}
+        @db.llen('almaz::user::1').should == max_size
+        logged_request = @db.lrange('almaz::user::1', -1, -1).first
+        JSON.parse(logged_request)['params'].should_not == {"didyouknow"=>"thisshouldbedeleted"}
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+require 'rubygems'
+gem 'rspec', '>= 1.2.8'
+require 'spec'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'almaz')
+require 'base64'
+require 'timecop'
+require 'logger'
+require 'date'
+require 'sinatra'
+
+Spec::Runner.configure do |config|
+  config.before(:all) {
+    @db = Redis.new(:db => 15) #, :logger => Logger.new(STDOUT), :debug => true)
+  }
+  
+  config.after(:each) {
+    @db.flushdb
+  }
+  
+  config.after(:all) {
+    @db.quit
+  }
+end
+
+def encode_credentials(username, password)
+  "Basic " + Base64.encode64("#{username}:#{password}")
+end
+
+
+class ExampleSinatraApp < Sinatra::Base
+  
+  get '/awesome/controller' do
+    'wooo hoo'
+  end
+  
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification 
+name: almaz-revelation
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 4
+  version: 0.0.4
+platform: ruby
+authors: 
+- James Pozdena
+- Max Ogden
+- Andrew Kurtz
+- Dan Herrera
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-06 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: timecop
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Almaz is a ruby rack middleware redis logger
+email: ops@revelationglobal.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- lib/almaz.rb
+- spec/almaz_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/revelation/almaz
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Almaz is watching!
+test_files: 
+- spec/almaz_spec.rb
+- spec/spec_helper.rb