mordor-auditing 0.0.4

data/.gitignore

@@ -0,0 +1,2 @@
+pkg/*
+.rvmrc

data/Gemfile

@@ -0,0 +1 @@
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    mordor-auditing (0.0.3)
+      mordor (= 0.2.1)
+
+GEM
+  specs:
+    bson (1.4.0)
+    bson_ext (1.4.0)
+    diff-lcs (1.1.3)
+    extlib (0.9.15)
+    json (1.6.1)
+    mongo (1.4.0)
+      bson (= 1.4.0)
+    mordor (0.2.1)
+      bson_ext
+      extlib
+      json
+      mongo
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mordor (= 0.2.1)
+  mordor-auditing!
+  rake
+  rspec (~> 2.0)

data/Rakefile

@@ -0,0 +1,17 @@
+load('tasks/github-gem.rake')
+
+# Register the gem release tasks in the gem namespace
+GithubGem::RakeTasks.new(:gem) do |config|
+
+  # Note that the following values are all default values and can 
+  # therefore be omitted if they are not changed.
+
+  config.gemspec_file   = GithubGem.detect_gemspec_file
+  config.main_include   = GithubGem.detect_main_include
+  config.root_dir       = Dir.pwd
+  config.test_pattern   = 'test/**/*_test.rb'
+  config.spec_pattern   = 'spec/**/*_spec.rb'
+  config.local_branch   = 'master'
+  config.remote         = 'origin'
+  config.remote_branch  = 'master'
+end

data/auditing.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name    = "mordor-auditing"
+  
+  # Do not set the version and date field manually, this is done by the release script
+  s.version = "0.0.4"
+  s.date    = "2011-12-27"
+
+  s.summary     = "mordor-auditing"
+  s.description = <<-eos
+    Auditing classes based on the Mordor gem, used to audit requests and modifications on objects
+  eos
+
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec', '~> 2.0')
+
+  s.add_development_dependency('mordor', '0.2.1')
+
+  s.add_runtime_dependency('mordor', '0.2.1')
+
+  s.authors  = ['Jan-Willem Koelewijn', 'Dirkjan Bussink']
+  s.email    = ['janwillem.koelewijn@nedap.com', 'dirkjan.bussink@nedap.com']
+  s.homepage = 'http://www.nedap.com'
+
+  # The files and test_files directives are set automatically by the release script.
+  # Do not change them by hand, but make sure to add the files to the git repository.
+  s.files = %w(.gitignore Gemfile Gemfile.lock Rakefile auditing.gemspec lib/auditing.rb lib/auditing/modification.rb lib/auditing/request.rb lib/auditing/version.rb spec/auditing/modification_spec.rb spec/auditing/request_spec.rb spec/spec.opts spec/spec_helper.rb tasks/github-gem.rake)
+end

data/lib/auditing/modification.rb

@@ -0,0 +1,57 @@
+module Auditing
+  class Modification
+    include Mordor::Resource
+
+    attribute :request_id, :index => true
+    attribute :object_type
+    attribute :object_id
+    attribute :changes
+    attribute :action
+    attribute :at, :index => true
+
+    def request_id=(id)
+      if id.is_a?(String) && id != ""
+        id = BSON::ObjectId.from_string(id)
+      end
+      @request_id = id
+    end
+
+    def request
+      Auditing::Request.find_by_id(request_id)
+    end
+
+    def request=(request)
+      self.request_id = request._id
+    end
+
+    def self.find_by_request(id)
+      find_by_request_id(id)
+    end
+
+    def self.find_by_request_id(id)
+      if id.is_a?(String)
+        id = BSON::ObjectId.from_string(id)
+      end
+      Mordor::Collection.new(self, self.collection.find(:request_id => id))
+    end
+
+    def to_hash
+      {
+        :request_id  => request_id,
+        :object_type => object_type,
+        :object_id   => object_id,
+        :changes     => changes,
+        :action      => action,
+        :at          => at
+      }
+    end
+
+    def changes=(changes)
+      @changes = replace_params(changes)
+    end
+
+    def self.collection_name
+      'audit_modifications'
+    end
+  end
+end

data/lib/auditing/request.rb

@@ -0,0 +1,75 @@
+module Auditing
+  class Request
+    include Mordor::Resource
+
+    attribute :url
+    attribute :url_parts
+    attribute :method
+    attribute :params
+    attribute :user_id, :finder_method => :find_by_user, :index => true
+    attribute :real_user_id
+    attribute :at, :index => true
+
+    def to_hash
+      {
+        :user_id      => user_id,
+        :real_user_id => real_user_id,
+        :params       => params,
+        :url          => url,
+        :url_parts    => url_parts,
+        :method       => method,
+        :at           => at
+      }
+    end
+
+    def url=(url)
+      self.url_parts = url_to_parts(url)
+      @url = url
+    end
+
+    def modifications
+      Modification.find_by_request(_id.to_s)
+    end
+
+    def url_parts=(parts)
+      @url_parts = self.replace_params(parts)
+    end
+
+    def params=(params)
+      @params = self.replace_params(params)
+    end
+
+    def self.find_by_url(url, partial = false)
+      if partial
+        Mordor::Collection.new(self, self.collection.find(:url => /.*#{url}.*/))
+      else
+        Mordor::Collection.new(self, self.collection.find(:url => url))
+      end
+    end
+
+    def self.find_by_url_parts(params = {})
+      parts_params = {}
+      params.each do |key, value|
+        parts_params["url_parts.#{key}"] = value
+      end
+      Mordor::Collection.new(self, self.collection.find(parts_params))
+    end
+
+    private
+
+    def self.collection_name
+      'audit_requests'
+    end
+
+    def url_to_parts(url)
+      result = {}
+      if url
+        url.scan(/([\w|_]+)\/([\d|-]+)/).each do |key, value|
+          key = key.gsub(/\W|\./, "_")
+          result[key.to_sym] = value.match(/-/) ? value : value.to_i
+        end
+      end
+      result
+    end
+  end
+end

data/lib/auditing/version.rb

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

data/lib/auditing.rb

@@ -0,0 +1,98 @@
+require 'rubygems'
+require 'mongo'
+require 'extlib'
+require 'mordor'
+require 'auditing/version'
+require 'auditing/request'
+require 'auditing/modification'
+
+unless Object.const_defined?('BigDecimal')
+  BigDecimal = Float
+end
+
+class Date
+  def to_time(form = :utc)
+    Time.send("#{form}", year, month, day)
+  end
+
+  def to_gm
+    Time.gm(year, month, day).to_datetime
+  end
+
+  def to_local
+    Time.local(year, month, day).to_datetime
+  end
+
+  def to_datetime
+    DateTime.civil(self.year, self.mon, self.day)
+  end
+
+  def show(format = nil)
+    case format
+    when :human
+      strftime("%d-%m-%Y")
+    else
+      to_s
+    end
+  end
+
+  def full_string
+    strftime("%A %d %B %Y")
+  end
+end
+
+class DateTime
+  def to_datetime
+    self
+  end
+
+  def to_date
+    Date.civil(self.year, self.mon, self.day)
+  end
+
+  def show(format = nil)
+    case format
+    when :human
+      strftime("%d-%m-%Y %H:%M")
+    when :full
+      strftime("%d-%m-%Y %H:%M:%S")
+    else
+      to_s
+    end
+  end
+end
+
+class Time
+
+  def to_date
+    Date.civil(year, month, day)
+  end if RUBY_VERSION < '1.8.6'
+
+  def show(format = nil)
+    return self.to_date.show(format) if [hour,min] == [0,0]
+    case format
+    when :human
+      strftime("%d-%m-%Y %H:%m")
+    when :full
+      strftime("%d-%m-%Y %H:%M:%S")
+    else
+      to_s
+    end
+  end
+end
+
+module Mordor
+  CONFIG = {
+    :hostname => 'localhost',
+    :port     => 27017,
+    :database => 'development'
+  }
+
+  def connection
+    @connection ||= Mongo::Connection.new(CONFIG[:hostname], CONFIG[:port])
+    @connection.autenticate(CONFIG[:username], CONFIG[:password]) if CONFIG[:username]
+    @connection.db(CONFIG[:database])
+  end
+  module_function :connection
+
+end

data/spec/auditing/modification_spec.rb

@@ -0,0 +1,145 @@
+require File.join(File.dirname(__FILE__), '..', '/spec_helper.rb')
+
+module AuditingModificationSpecHelper
+  def compare_modifications(stored_mods, retrieved_mods)
+    if retrieved_mods.is_a?(BSON::OrderedHash)
+      retrieved_mods['_id'].should == stored_mods._id
+      retrieved_mods['request_id'].should == (stored_mods.request_id ? stored_mods.request_id : nil)
+      retrieved_mods['object_type'].should == stored_mods.object_type
+      retrieved_mods['object_id'].should == stored_mods.object_id
+      retrieved_mods['changes'].size.should == stored_mods.changes.size
+      retrieved_mods['changes'].each do |k,v|
+        stored_mods.changes[k].should == v
+      end
+      retrieved_mods['action'].should == stored_mods.action
+      retrieved_mods['at'].should == stored_mods.at.to_time
+    else
+      retrieved_mods._id.should == stored_mods._id
+      retrieved_mods.request_id.should == (stored_mods.request_id ? stored_mods.request_id : nil)
+      retrieved_mods.object_type.should == stored_mods.object_type
+      retrieved_mods.object_id.should == stored_mods.object_id
+      retrieved_mods.changes.each do |key, value|
+        stored_mods.changes[key].should == value
+      end
+      retrieved_mods.action.should == stored_mods.action
+      retrieved_mods.at.should == stored_mods.at.to_time
+    end
+  end
+end
+
+describe "with respect to modifications" do
+  include AuditingModificationSpecHelper
+
+  before :each do
+    clean_sheet
+  end
+
+  it "should correctly initialize" do
+    options = {
+      :object_type => 'String',
+      :object_id => 2,
+      :changes => {:length => [2, 4]},
+      :action => 'put',
+      :at => DateTime.now.to_time
+    }
+    mod = Auditing::Modification.new(options)
+    options.each do |key, value|
+      ret_val = mod.send(key)
+      if value.is_a?(Hash)
+        value.each do |k, v|
+          ret_val[k.to_s].should == v
+        end
+      else
+        ret_val.should == value
+      end
+    end
+  end
+
+  context "with respect to saving and retrieving" do
+    it "should correctly save the modification" do
+      options = {
+        :object_type => 'String',
+        :object_id => 2,
+        :changes => {:length => [2, 4]},
+        :action => 'put',
+        :at => DateTime.now.to_time
+      }
+
+      mod = Auditing::Modification.new(options)
+      mod.save.should be_true
+      mod._id.should_not be_nil
+
+      Auditing::Modification.collection.count.should == 1
+
+      other_mod = mod.class.collection.find_one(:_id => mod._id)
+
+      compare_modifications(mod, other_mod)
+    end
+  end
+
+  describe "with respect to retrieval" do
+    before :each do
+      options = {
+        :object_type => 'String',
+        :object_id => 2,
+        :changes => {:length => [2, 4]},
+        :action => 'put',
+        :at => DateTime.now.to_time
+      }
+
+      @modification = Auditing::Modification.new(options)
+      @modification.save.should be_true
+      @modification._id.should_not be_nil
+    end
+
+    it "should correctly retrieve saved modifications by its _id" do
+      mod = Auditing::Modification.find_by_id(@modification._id)
+      compare_modifications(@modification, mod)
+    end
+
+     it "should correctly retrieve requests on a certain day" do
+      mods = Auditing::Modification.find_by_day(Date.today)
+      mods.size.should == 1
+      compare_modifications(@modification, mods.first)
+
+      mods = Auditing::Modification.find_by_day(DateTime.now)
+      mods.size.should == 1
+      compare_modifications(@modification, mods.first)
+    end
+
+    it "should correctly retrieve requests by object_type" do
+      mods = Auditing::Modification.find_by_object_type(@modification.object_type)
+      mods.size.should == 1
+      compare_modifications(@modification, mods.first)
+    end
+
+    it "should correctly retrieve requests by object_id" do
+      mods = Auditing::Modification.find_by_object_id(@modification.object_id)
+      mods.size.should == 1
+      compare_modifications(@modification, mods.first)
+    end
+
+    it "should correctly retrieve requests by action" do
+      mods = Auditing::Modification.find_by_action(@modification.action)
+      mods.size.should == 1
+      compare_modifications(@modification, mods.first)
+    end
+
+    it "should correctly retrieve requests by request_id" do
+      @modification.request_id = "4e79b0b20e02e145a9000001"
+      @modification.save.should be_true
+      mods = Auditing::Modification.find_by_request_id(@modification.request_id)
+      mods.size.should == 1
+      compare_modifications(@modification, mods.first)
+    end
+
+    it "should correctly retrieve requests by request" do
+      @modification.request_id = "4e79b0b20e02e145a9000001"
+      @modification.save.should be_true
+      mods = Auditing::Modification.find_by_request(@modification.request_id)
+      mods.size.should == 1
+      compare_modifications(@modification, mods.first)
+    end
+
+  end
+end

data/spec/auditing/request_spec.rb

@@ -0,0 +1,323 @@
+require File.join(File.dirname(__FILE__), '..', '/spec_helper.rb')
+
+module AuditingRequestSpecHelper
+  def compare_requests(stored_request, retrieved_request)
+    if retrieved_request.is_a?(BSON::OrderedHash)
+      retrieved_request['url'].should                                      == stored_request.url
+      retrieved_request['method'].should                                   == stored_request.method
+      retrieved_request['params'].should be_instance_of(BSON::OrderedHash)
+      retrieved_request['params'].should have_key("test_param1")
+      retrieved_request['params']['test_param1'].should                    == stored_request.params['test_param1']
+      retrieved_request['params'].should have_key("test_param2")
+      retrieved_request['params']['test_param2'].should                    == stored_request.params['test_param2']
+      retrieved_request['user_id'].should                                  == stored_request.user_id
+      retrieved_request['real_user_id'].should                             == stored_request.real_user_id
+      retrieved_request['at'].gmtime.to_s.should                                  == stored_request.at.gmtime.to_s
+    else
+      retrieved_request.url == stored_request.url
+      retrieved_request.method == stored_request.method
+      retrieved_request.user_id == stored_request.user_id
+      retrieved_request.real_user_id == stored_request.real_user_id
+      retrieved_request.at == stored_request.at
+    end
+  end
+
+  def compare_modifications(stored_mods, retrieved_mods)
+    if retrieved_mods.is_a?(BSON::OrderedHash)
+      retrieved_mods['_id'].should == stored_mods._id
+      retrieved_mods['request_id'].should == (stored_mods.request_id ? stored_mods.request_id : "")
+      retrieved_mods['object_type'].should == stored_mods.object_type
+      retrieved_mods['object_id'].should == stored_mods.object_id
+      retrieved_mods['changes'].size.should == stored_mods.changes.size
+      retrieved_mods['changes'].each do |k,v|
+        stored_mods.changes[k].should == v
+      end
+      retrieved_mods['action'].should == stored_mods.action
+      retrieved_mods['at'].to_s.should == stored_mods.at.to_time.to_s
+    else
+      retrieved_mods._id.should == stored_mods._id
+      retrieved_mods.request_id.should == (stored_mods.request_id ? stored_mods.request_id : "")
+      retrieved_mods.object_type.should == stored_mods.object_type
+      retrieved_mods.object_id.should == stored_mods.object_id
+      retrieved_mods.changes.each do |key, value|
+        stored_mods.changes[key].should == value
+      end
+      retrieved_mods.action.should == stored_mods.action
+      retrieved_mods.at.should == stored_mods.at.to_time
+    end
+  end
+end
+
+describe "with respect to auditing requests" do
+  include AuditingRequestSpecHelper
+
+  before :each do
+    clean_sheet
+  end
+
+  it "should correctly initialize" do
+    options = {
+      :url => 'http://test.com',
+      :method => 'get',
+      :params => {:test_param1 => '1', :test_param2 => '2'},
+      :user_id => 3,
+      :real_user_id => 5,
+      :at => Time.now
+    }
+
+    request = Auditing::Request.new(options)
+    options.each do |key, value|
+      ret_val = request.send(key)
+      if value.is_a?(Hash)
+        value.each do |k, v|
+          ret_val[k.to_s].should == v
+        end
+      else
+        ret_val.should == value
+      end
+    end
+  end
+
+  it "should correctly replace Date params with Times" do
+    options = {
+      :params => {:first => Date.today}
+    }
+    request = Auditing::Request.new(options)
+    request.params["first"].should be_instance_of(Time)
+  end
+
+  it "should correctly replace DateTime params with Time's" do
+    options = {
+      :params => {:first => DateTime.now}
+    }
+    request = Auditing::Request.new(options)
+    request.params["first"].should be_instance_of(Time)
+  end
+
+  context "with respect to saving" do
+    it "should correctly save the request" do
+      options = {
+        :url => 'http://test.com',
+        :method => 'get',
+        :params => {:test_param1 => '1', :test_param2 => '2'},
+        :user_id => 3,
+        :real_user_id => 5,
+        :at => Time.now
+      }
+      request = Auditing::Request.new(options)
+      request.save.should be_true
+      request._id.should_not be_nil
+
+      Auditing::Request.collection.count.should == 1
+
+      other_request = request.class.collection.find_one(:_id => request._id)
+
+      compare_requests(request, other_request)
+    end
+  end
+
+  describe "with respect to retrieval" do
+    before(:each) do
+      @request_time = DateTime.now.to_time
+      options = {
+        :url => 'http://test.com',
+        :method => 'get',
+        :params => {:test_param1 => '1', :test_param2 => '2'},
+        :user_id => 3,
+        :real_user_id => 5,
+        :at => @request_time
+      }
+      @request = Auditing::Request.new(options)
+      @request.save.should be_true
+      Auditing::Request.collection.find(:_id => @request._id).count.should == 1
+    end
+
+    it "should correctly retrieve a request by its _id" do
+      req = Auditing::Request.find_by_id(@request._id)
+      compare_requests(@request, req)
+    end
+
+    it "should correctly retrieve requests on a certain day" do
+      reqs = Auditing::Request.find_by_day(Date.today)
+      reqs.size.should == 1
+      compare_requests(@request, reqs.first)
+
+      reqs = Auditing::Request.find_by_day(DateTime.now)
+      reqs.size.should == 1
+      compare_requests(@request, reqs.first)
+    end
+
+    it "should correctly retrieve requests by url" do
+      reqs = Auditing::Request.find_by_url(@request.url)
+      reqs.size.should == 1
+      compare_requests(@request, reqs.first)
+    end
+
+    it "should correctly retrieve requests by part of an url" do
+      reqs = Auditing::Request.find_by_url(@request.url[0, @request.url.length - 2], true)
+      reqs.size.should == 1
+      compare_requests(@request, reqs.first)
+    end
+
+    it "should correctly retrieve requests by user_id" do
+      reqs = Auditing::Request.find_by_user(@request.user_id)
+      reqs.size.should == 1
+      compare_requests(@request, reqs.first)
+    end
+
+    it "should correctly retrieve requests by real_user_id" do
+      reqs = Auditing::Request.find_by_real_user_id(@request.real_user_id)
+      reqs.size.should == 1
+      compare_requests(@request, reqs.first)
+    end
+
+    it "should correctly retrieve requests by method" do
+      reqs = Auditing::Request.find_by_method(@request.method)
+      reqs.size.should == 1
+      compare_requests(@request, reqs.first)
+    end
+
+    describe "with respect to modifications" do
+      before :each do
+        options = {
+          :request_id => @request._id,
+          :object_type => "Audited::Request",
+          :object_id => @request._id.to_s,
+          :changes => {:url => [@request.url, "#{@request.url}/request"]},
+          :action => 'get',
+          :at => @request_time,
+          :request_id => @request._id
+        }
+        @modification = Auditing::Modification.new(options)
+        @modification.save.should be_true
+        @modification._id.should_not be_nil
+        Auditing::Modification.collection.count == 1
+      end
+
+      it "should correctly retrieve the corresponding modifications" do
+        @request.modifications.should_not be_nil
+        @request.modifications.size.should == 1
+        compare_modifications(@modification, @request.modifications.first)
+      end
+
+      it "should correctly retrieve the same request through the modifications" do
+        @request.modifications.should_not be_nil
+        @request.modifications.size.should == 1
+        compare_modifications(@modification, @request.modifications.first)
+        compare_requests(@request, @request.modifications.first.request)
+      end
+    end
+
+  end
+
+  describe "with respect to urls" do
+    before :each do
+      options = {
+        :url => '/week/2011-39/staffing_agencies/123/customers/12/arrangements/123',
+        :method => 'get',
+        :params => {:test_param1 => '1', :test_param2 => '2'},
+        :user_id => 3,
+        :real_user_id => 5,
+        :at => Time.now
+      }
+      @request = Auditing::Request.new(options)
+      @request.save.should be_true
+    end
+
+    it "should create url parts when saved" do
+      @request.url_parts.should_not be_nil
+    end
+
+    it "should create correct url parts" do
+      parts = @request.url_parts
+      parts.keys.should include "week"
+      parts.keys.should include "staffing_agencies"
+      parts.keys.should include "customers"
+      parts.keys.should include "arrangements"
+
+      parts["week"].should == "2011-39"
+      parts["staffing_agencies"].should == 123
+      parts["customers"].should == 12
+      parts["arrangements"].should == 123
+    end
+
+    it "should correctly get weeks" do
+      options = {
+        :url => '/week/2011-9/staffing_agencies/123/customers/12/arrangements/123',
+        :method => 'get',
+        :params => {:test_param1 => '1', :test_param2 => '2'},
+        :user_id => 3,
+        :real_user_id => 5,
+        :at => Time.now
+      }
+      request = Auditing::Request.new(options)
+      request.save.should be_true
+      request.url_parts.keys.should include "week"
+      request.url_parts["week"].should == "2011-9"
+
+      options = {
+        :url => '/week/weeknumber/staffing_agencies/123/customers/12/arrangements/123',
+        :method => 'get',
+        :params => {:test_param1 => '1', :test_param2 => '2'},
+        :user_id => 3,
+        :real_user_id => 5,
+        :at => Time.now
+      }
+      request = Auditing::Request.new(options)
+      request.save.should be_true
+      request.url_parts.keys.should_not include "week"
+    end
+
+    it "should corretly retrieve requests based on parts of the url" do
+      options = {
+        :url => '/week/2011-9/staffing_agencies/1234/customers/12/arrangements/123',
+        :method => 'get',
+        :params => {:test_param1 => '1', :test_param2 => '2'},
+        :user_id => 3,
+        :real_user_id => 5,
+        :at => Time.now
+      }
+      request = Auditing::Request.new(options)
+      request.save.should be_true
+
+      options2 = {
+        :url => '/week/2011-9/staffing_agencies/13/customers/124/arrangements/123',
+        :method => 'get',
+        :params => {:test_param1 => '1', :test_param2 => '2'},
+        :user_id => 3,
+        :real_user_id => 5,
+        :at => Time.now
+      }
+      request2 = Auditing::Request.new(options2)
+      request2.save.should be_true
+
+      search_options = {
+        :week => "2011-9"
+      }
+      results = Auditing::Request.find_by_url_parts(search_options)
+      results.size.should == 2
+
+      match = (results.first._id == request._id || results.first._id == request2._id)
+      match.should be_true
+
+      search_options = {
+        :staffing_agencies => 1234
+      }
+
+      results = Auditing::Request.find_by_url_parts(search_options)
+      results.size.should == 1
+      results.first._id.should == request._id
+
+      search_options = {
+        :week => "2011-9",
+        :arrangements => 123
+      }
+      results = Auditing::Request.find_by_url_parts(search_options)
+      results.size.should == 2
+
+      match = (results.first._id == request._id || results.first._id == request2._id)
+      match.should be_true
+
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--format specdoc
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'mongo'
+require 'mordor'
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'auditing'
+
+module Mordor
+CONFIG = {
+  :hostname => 'localhost',
+  :port     =>  27017,
+  :database => 'test'
+}
+end
+
+def clean_sheet
+  @connection ||= Mongo::Connection.new(Mordor::CONFIG[:hostname], Mordor::CONFIG[:port])
+  @db ||= @connection[Mordor::CONFIG[:database]]
+  [Auditing::Request, Auditing::Modification].each do |klass|
+    @db[klass.collection_name].drop
+  end
+end
+

data/tasks/github-gem.rake

@@ -0,0 +1,368 @@
+require 'rubygems'
+require 'rake'
+require 'rake/tasklib'
+require 'date'
+require 'set'
+
+module GithubGem
+
+  # Detects the gemspc file of this project using heuristics.
+  def self.detect_gemspec_file
+    FileList['*.gemspec'].first
+  end
+
+  # Detects the main include file of this project using heuristics
+  def self.detect_main_include
+    if File.exist?(File.expand_path("../lib/#{File.basename(detect_gemspec_file, '.gemspec').gsub(/-/, '/')}.rb", detect_gemspec_file))
+      "lib/#{File.basename(detect_gemspec_file, '.gemspec').gsub(/-/, '/')}.rb"
+    elsif FileList['lib/*.rb'].length == 1
+      FileList['lib/*.rb'].first
+    else
+      nil
+    end
+  end
+
+  class RakeTasks
+
+    include Rake::DSL if Rake.const_defined?('DSL')
+
+    attr_reader   :gemspec, :modified_files
+    attr_accessor :gemspec_file, :task_namespace, :main_include, :root_dir, :spec_pattern, :test_pattern, :remote, :remote_branch, :local_branch
+
+    # Initializes the settings, yields itself for configuration
+    # and defines the rake tasks based on the gemspec file.
+    def initialize(task_namespace = :gem)
+      @gemspec_file   = GithubGem.detect_gemspec_file
+      @task_namespace = task_namespace
+      @main_include   = GithubGem.detect_main_include
+      @modified_files = Set.new
+      @root_dir       = Dir.pwd
+      @test_pattern   = 'test/**/*_test.rb'
+      @spec_pattern   = 'spec/**/*_spec.rb'
+      @local_branch   = 'master'
+      @remote         = 'origin'
+      @remote_branch  = 'master'
+
+      yield(self) if block_given?
+
+      load_gemspec!
+      define_tasks!
+    end
+
+    protected
+
+    def git
+      @git ||= ENV['GIT'] || 'git'
+    end
+
+    # Define Unit test tasks
+    def define_test_tasks!
+      require 'rake/testtask'
+
+      namespace(:test) do
+        Rake::TestTask.new(:basic) do |t|
+          t.pattern = test_pattern
+          t.verbose = true
+          t.libs << 'test'
+        end
+      end
+
+      desc "Run all unit tests for #{gemspec.name}"
+      task(:test => ['test:basic'])
+    end
+
+    # Defines RSpec tasks
+    def define_rspec_tasks!
+      require 'rspec/core/rake_task'
+
+      namespace(:spec) do
+        desc "Verify all RSpec examples for #{gemspec.name}"
+        RSpec::Core::RakeTask.new(:basic) do |t|
+          t.pattern = spec_pattern
+        end
+
+        desc "Verify all RSpec examples for #{gemspec.name} and output specdoc"
+        RSpec::Core::RakeTask.new(:specdoc) do |t|
+          t.pattern = spec_pattern
+          t.rspec_opts = ['--format', 'documentation', '--color']
+        end
+
+        desc "Run RCov on specs for #{gemspec.name}"
+        RSpec::Core::RakeTask.new(:rcov) do |t|
+          t.pattern = spec_pattern
+          t.rcov = true
+          t.rcov_opts = ['--exclude', '"spec/*,gems/*"', '--rails']
+        end
+      end
+
+      desc "Verify all RSpec examples for #{gemspec.name} and output specdoc"
+      task(:spec => ['spec:specdoc'])
+    end
+
+    # Defines the rake tasks
+    def define_tasks!
+
+      define_test_tasks!  if has_tests?
+      define_rspec_tasks! if has_specs?
+
+      namespace(@task_namespace) do
+        desc "Updates the filelist in the gemspec file"
+        task(:manifest) { manifest_task }
+
+        desc "Builds the .gem package"
+        task(:build => :manifest) { build_task }
+
+        desc "Sets the version of the gem in the gemspec"
+        task(:set_version => [:check_version, :check_current_branch]) { version_task }
+        task(:check_version => :fetch_origin) { check_version_task }
+
+        task(:fetch_origin) { fetch_origin_task }
+        task(:check_current_branch) { check_current_branch_task }
+        task(:check_clean_status) { check_clean_status_task }
+        task(:check_not_diverged => :fetch_origin) { check_not_diverged_task }
+
+        #checks = [:check_current_branch, :check_clean_status, :check_not_diverged, :check_version]
+        checks = [:check_current_branch, :check_clean_status]
+        checks.unshift('spec:basic') if has_specs?
+        checks.unshift('test:basic') if has_tests?
+        # checks.push << [:check_rubyforge] if gemspec.rubyforge_project
+
+        desc "Perform all checks that would occur before a release"
+        task(:release_checks => checks)
+
+        release_tasks = [:release_checks, :set_version, :build, :github_release, :gemcutter_release]
+        # release_tasks << [:rubyforge_release] if gemspec.rubyforge_project
+
+        desc "Release a new version of the gem using the VERSION environment variable"
+        task(:release => release_tasks) { release_task }
+        
+        namespace(:release) do
+          desc "Release the next version of the gem, by incrementing the last version segment by 1"
+          task(:next => [:next_version] + release_tasks) { release_task }
+
+          desc "Release the next version of the gem, using a patch increment (0.0.1)"
+          task(:patch => [:next_patch_version] + release_tasks) { release_task }
+
+          desc "Release the next version of the gem, using a minor increment (0.1.0)"
+          task(:minor => [:next_minor_version] + release_tasks) { release_task }
+
+          desc "Release the next version of the gem, using a major increment (1.0.0)"
+          task(:major => [:next_major_version] + release_tasks) { release_task }
+        end
+
+        # task(:check_rubyforge)   { check_rubyforge_task }
+        # task(:rubyforge_release) { rubyforge_release_task }
+        task(:gemcutter_release) { gemcutter_release_task }
+        task(:github_release => [:commit_modified_files, :tag_version]) { github_release_task }
+        task(:tag_version) { tag_version_task }
+        task(:commit_modified_files) { commit_modified_files_task }
+
+        task(:next_version)       { next_version_task }
+        task(:next_patch_version)  { next_version_task(:patch) }
+        task(:next_minor_version) { next_version_task(:minor) }
+        task(:next_major_version) { next_version_task(:major) }
+        
+        desc "Updates the gem release tasks with the latest version on Github"
+        task(:update_tasks) { update_tasks_task }
+      end
+    end
+
+    # Updates the files list and test_files list in the gemspec file using the list of files
+    # in the repository and the spec/test file pattern.
+    def manifest_task
+      # Load all the gem's files using "git ls-files"
+      repository_files = `#{git} ls-files`.split("\n")
+      test_files       = Dir[test_pattern] + Dir[spec_pattern]
+
+      update_gemspec(:files, repository_files)
+      update_gemspec(:test_files, repository_files & test_files)
+    end
+
+    # Builds the gem
+    def build_task
+      sh "gem build -q #{gemspec_file}"
+      Dir.mkdir('pkg') unless File.exist?('pkg')
+      sh "mv #{gemspec.name}-#{gemspec.version}.gem pkg/#{gemspec.name}-#{gemspec.version}.gem"
+    end
+
+    def newest_version
+      `#{git} tag`.split("\n").map { |tag| tag.split('-').last }.compact.map { |v| Gem::Version.new(v) }.max || Gem::Version.new('0.0.0')
+    end
+
+    def next_version(increment = nil)
+      next_version = newest_version.segments
+      increment_index = case increment
+        when :micro then 3
+        when :patch then 2
+        when :minor then 1
+        when :major then 0
+        else next_version.length - 1
+      end
+      
+      next_version[increment_index] ||= 0
+      next_version[increment_index] = next_version[increment_index].succ
+      ((increment_index + 1)...next_version.length).each { |i| next_version[i] = 0 }
+      
+      Gem::Version.new(next_version.join('.'))
+    end
+
+    def next_version_task(increment = nil)
+      ENV['VERSION'] = next_version(increment).version
+      puts "Releasing version #{ENV['VERSION']}..."
+    end
+
+    # Updates the version number in the gemspec file, the VERSION constant in the main
+    # include file and the contents of the VERSION file.
+    def version_task
+      update_gemspec(:version, ENV['VERSION']) if ENV['VERSION']
+      update_gemspec(:date, Date.today)
+
+      update_version_file(gemspec.version)
+      update_version_constant(gemspec.version)
+    end
+
+    def check_version_task
+      raise "#{ENV['VERSION']} is not a valid version number!" if ENV['VERSION'] && !Gem::Version.correct?(ENV['VERSION'])
+      proposed_version = Gem::Version.new((ENV['VERSION'] || gemspec.version).dup)
+      raise "This version (#{proposed_version}) is not higher than the highest tagged version (#{newest_version})" if newest_version >= proposed_version
+    end
+
+    # Checks whether the current branch is not diverged from the remote branch
+    def check_not_diverged_task
+      raise "The current branch is diverged from the remote branch!" if `#{git} rev-list HEAD..#{remote}/#{remote_branch}`.split("\n").any?
+    end
+
+    # Checks whether the repository status ic clean
+    def check_clean_status_task
+      raise "The current working copy contains modifications" if `#{git} ls-files -m`.split("\n").any?
+    end
+
+    # Checks whether the current branch is correct
+    def check_current_branch_task
+      raise "Currently not on #{local_branch} branch!" unless `#{git} branch`.split("\n").detect { |b| /^\* / =~ b } == "* #{local_branch}"
+    end
+
+    # Fetches the latest updates from Github
+    def fetch_origin_task
+      sh git, 'fetch', remote
+    end
+
+    # Commits every file that has been changed by the release task.
+    def commit_modified_files_task
+      really_modified = `#{git} ls-files -m #{modified_files.entries.join(' ')}`.split("\n")
+      if really_modified.any?
+        really_modified.each { |file| sh git, 'add', file }
+        sh git, 'commit', '-m', "Released #{gemspec.name} gem version #{gemspec.version}."
+      end
+    end
+
+    # Adds a tag for the released version
+    def tag_version_task
+      sh git, 'tag', '-a', "#{gemspec.name}-#{gemspec.version}", '-m', "Released #{gemspec.name} gem version #{gemspec.version}."
+    end
+
+    # Pushes the changes and tag to github
+    def github_release_task
+      sh git, 'push', '--tags', remote, remote_branch
+    end
+
+    def gemcutter_release_task
+      sh "gem", 'push', "pkg/#{gemspec.name}-#{gemspec.version}.gem"
+    end
+
+    # Gem release task.
+    # All work is done by the task's dependencies, so just display a release completed message.
+    def release_task
+      puts
+      puts "Release successful."
+    end
+
+    private
+
+    # Checks whether this project has any RSpec files
+    def has_specs?
+      FileList[spec_pattern].any?
+    end
+
+    # Checks whether this project has any unit test files
+    def has_tests?
+      FileList[test_pattern].any?
+    end
+
+    # Loads the gemspec file
+    def load_gemspec!
+      @gemspec = eval(File.read(@gemspec_file))
+    end
+
+    # Updates the VERSION file with the new version
+    def update_version_file(version)
+      if File.exists?('VERSION')
+        File.open('VERSION', 'w') { |f| f << version.to_s }
+        modified_files << 'VERSION'
+      end
+    end
+
+    # Updates the VERSION constant in the main include file if it exists
+    def update_version_constant(version)
+      if main_include && File.exist?(main_include)
+        file_contents = File.read(main_include)
+        if file_contents.sub!(/^(\s+VERSION\s*=\s*)[^\s].*$/) { $1 + version.to_s.inspect }
+          File.open(main_include, 'w') { |f| f << file_contents }
+          modified_files << main_include
+        end
+      end
+    end
+
+    # Updates an attribute of the gemspec file.
+    # This function will open the file, and search/replace the attribute using a regular expression.
+    def update_gemspec(attribute, new_value, literal = false)
+
+      unless literal
+        new_value = case new_value
+          when Array        then "%w(#{new_value.join(' ')})"
+          when Hash, String then new_value.inspect
+          when Date         then new_value.strftime('%Y-%m-%d').inspect
+          else              raise "Cannot write value #{new_value.inspect} to gemspec file!"
+        end
+      end
+
+      spec   = File.read(gemspec_file)
+      regexp = Regexp.new('^(\s+\w+\.' + Regexp.quote(attribute.to_s) + '\s*=\s*)[^\s].*$')
+      if spec.sub!(regexp) { $1 + new_value }
+        File.open(gemspec_file, 'w') { |f| f << spec }
+        modified_files << gemspec_file
+
+        # Reload the gemspec so the changes are incorporated
+        load_gemspec!
+        
+        # Also mark the Gemfile.lock file as changed because of the new version.
+        modified_files << 'Gemfile.lock' if File.exist?(File.join(root_dir, 'Gemfile.lock'))
+      end
+    end
+
+    # Updates the tasks file using the latest file found on Github
+    def update_tasks_task
+      require 'net/https'
+      require 'uri'
+      
+      uri = URI.parse('https://raw.github.com/wvanbergen/github-gem/master/tasks/github-gem.rake')
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      response = http.request(Net::HTTP::Get.new(uri.path))
+
+      if Net::HTTPSuccess === response
+        open(__FILE__, "w") { |file| file.write(response.body) }
+        relative_file = File.expand_path(__FILE__).sub(%r[^#{@root_dir}/], '')
+        if `#{git} ls-files -m #{relative_file}`.split("\n").any?
+          sh git, 'add', relative_file
+          sh git, 'commit', '-m', "Updated to latest gem release management tasks."
+        else
+          puts "Release managament tasks already are at the latest version."
+        end
+      else
+        raise "Download failed with HTTP status #{response.code}!"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification 
+name: mordor-auditing
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 4
+  version: 0.0.4
+platform: ruby
+authors: 
+- Jan-Willem Koelewijn
+- Dirkjan Bussink
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-27 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  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
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mordor
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 0
+        - 2
+        - 1
+        version: 0.2.1
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mordor
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 0
+        - 2
+        - 1
+        version: 0.2.1
+  type: :runtime
+  version_requirements: *id004
+description: "    Auditing classes based on the Mordor gem, used to audit requests and modifications on objects\n"
+email: 
+- janwillem.koelewijn@nedap.com
+- dirkjan.bussink@nedap.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- auditing.gemspec
+- lib/auditing.rb
+- lib/auditing/modification.rb
+- lib/auditing/request.rb
+- lib/auditing/version.rb
+- spec/auditing/modification_spec.rb
+- spec/auditing/request_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/github-gem.rake
+has_rdoc: true
+homepage: http://www.nedap.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: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: mordor-auditing
+test_files: []
+