audit 0.1.0

data/Gemfile

@@ -0,0 +1,16 @@
+source :gemcutter
+
+gem "cassandra", "~> 0.8.2"
+gem "activemodel", "~> 3.0.0"
+gem "yajl-ruby", "~> 0.7.7"
+
+group :development do
+  gem "activerecord", "~> 3.0.0"
+  gem "sqlite3-ruby"
+end
+
+group :test do
+  gem "shoulda", "~> 2.11.3"
+  gem "nokogiri", "~> 1.4.3.1" # Cassandra::Mock needs this
+  gem "flexmock", "~> 0.8.7"
+end

data/Gemfile.lock

@@ -0,0 +1,47 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.0)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    cassandra (0.8.2)
+      json
+      rake
+      simple_uuid (>= 0.1.0)
+      thrift_client (>= 0.4.0)
+    flexmock (0.8.7)
+    i18n (0.4.1)
+    json (1.4.6)
+    nokogiri (1.4.3.1)
+    rake (0.8.7)
+    shoulda (2.11.3)
+    simple_uuid (0.1.1)
+    sqlite3-ruby (1.3.1)
+    thrift (0.2.0.4)
+    thrift_client (0.4.6)
+      thrift
+    tzinfo (0.3.23)
+    yajl-ruby (0.7.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel (~> 3.0.0)
+  activerecord (~> 3.0.0)
+  cassandra (~> 0.8.2)
+  flexmock (~> 0.8.7)
+  nokogiri (~> 1.4.3.1)
+  shoulda (~> 2.11.3)
+  sqlite3-ruby
+  yajl-ruby (~> 0.7.7)

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010 Adam Keys
+
+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.md

@@ -0,0 +1,76 @@
+# Audit
+
+Audit sits on top of your model objects and watches for changes to your data. When a change occurs, the differences are recorded and stored in Cassandra.
+
+## Usage
+
+Include `Audit::Tracking` into your change-sensitive ActiveRecord models. When you make changes to data in those tables, the relevant details will be written to a Cassandra column family.
+
+## Example
+
+    >> require 'audit'
+    >> class User < ActiveRecord::Base; include Audit::Tracking; end
+    >> u = User.create(:name => 'Adam', :city => 'Dallas')
+    >> u.update_attributes(:city => 'Austin')
+    >> u.audits
+    [#<struct Audit::Changeset changes=[#<struct Audit::Change attribute="username", old="akk", new="therealadam">]>, #<struct Audit::Changeset changes=[#<struct Audit::Change attribute="username", old="adam", new="akk">]>, #<struct Audit::Changeset changes=[#<struct Audit::Change attribute="age", old=30, new=31>]>]
+
+# Compatibility
+
+Audit is tested against ActiveRecord 3.0, Ruby 1.8.7 and Ruby 1.9.2.
+
+# Setup
+
+For Cassandra 0.7, you can set up the schema with `cassandra-cli` like so:
+
+    /* Create a new keyspace */
+    create keyspace Audit with replication_factor = 1
+
+    /* Switch to the new keyspace */
+    use Audit
+
+    /* Create new column families */
+    create column family Audits with column_type = 'Standard' and comparator = 'TimeUUIDType' and rows_cached = 10000
+
+For Cassandra 0.6, add the following to `storage-conf.xml`:
+
+    <Keyspace Name="Audit">
+        <KeysCachedFraction>0.01</KeysCachedFraction>
+        <ColumnFamily CompareWith="TimeUUIDType" Name="Audits" />
+        <ReplicaPlacementStrategy>org.apache.cassandra.locator.RackUnawareStrategy</ReplicaPlacementStrategy>
+        <ReplicationFactor>1</ReplicationFactor>
+        <EndPointSnitch>org.apache.cassandra.locator.EndPointSnitch</EndPointSnitch>
+    </Keyspace>
+    
+## Hacking
+
+Set up RVM:
+
+    $ rvm install ree-1.8.7-2010.01
+    $ rvm use ree-1.8.7-2010.01
+    $ rvm gemset create audit
+    $ rvm gemset use audit
+    $ gem install bundler
+    $ bundle install
+    $ rvm install 1.9.2
+    $ rvm use 1.9.2
+    $ rvm gemset create audit
+    $ rvm gemset use audit
+    $ gem install bundler
+    $ bundle install
+    
+Run the test suite with all supported runtimes:
+
+    $ rvm 1.9.2@audit,ree-1.8.7-2010.01@audit rake test
+
+## TODO
+
+- Ignore changes on some attributes
+- Add more AR callbacks (delete, ?)
+- Generate bucket names for namespaced models
+
+## License
+
+Copyright 2010 Adam Keys `<adam@therealaadam.com>`
+
+Audit is MIT licensed. Enjoy!

data/Rakefile

@@ -0,0 +1,129 @@
+require 'rake/testtask'
+require 'date'
+
+# Helpers
+begin
+  def name
+    @name ||= Dir['*.gemspec'].first.split('.').first
+  end
+
+  def version
+    line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+    line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+  end
+
+  def date
+    Date.today.to_s
+  end
+
+  def rubyforge_project
+    name
+  end
+
+  def gemspec_file
+    "#{name}.gemspec"
+  end
+
+  def gem_file
+    "#{name}-#{version}.gem"
+  end
+
+  def replace_header(head, header_name)
+    head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+  end
+end
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+end
+
+desc "Run tests against all supported Ruby versions"
+task :compat do
+  sh "rvm 1.9.2@audit,ree-1.8.7-2010.01@audit rake test"
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+# =============
+# = Packaging =
+# =============
+
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/audit.gemspec

@@ -0,0 +1,80 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'audit'
+  s.version           = '0.1.0'
+  s.date              = '2010-09-29'
+  s.rubyforge_project = 'audit'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "Audit logs changes to model objects to Cassandra."
+  s.description = "Audit sits on top of your model objects and watches for changes to your data. When a change occurs, the differences are recorded and stored in Cassandra."
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["Adam Keys"]
+  s.email    = 'adam@therealadam.com'
+  s.homepage = 'http://github.com/therealadam/auditus'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  ## Specify any RDoc options here. You'll want to add your README and
+  ## LICENSE files to the extra_rdoc_files list.
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  ## List your runtime dependencies here. Runtime dependencies are those
+  ## that are needed for an end user to actually USE your code.
+  s.add_dependency('cassandra', ["~> 0.8.2"])
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  s.add_development_dependency('shoulda', ["~> 2.11.3"])
+  s.add_development_dependency('nokogiri', ['~> 1.4.3.1'])
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    Gemfile.lock
+    LICENSE
+    README.md
+    Rakefile
+    audit.gemspec
+    examples/active_model.rb
+    examples/active_record.rb
+    examples/auditer.rb
+    examples/common.rb
+    lib/audit.rb
+    lib/audit/changeset.rb
+    lib/audit/log.rb
+    lib/audit/tracking.rb
+    test/changeset_test.rb
+    test/log_test.rb
+    test/storage-conf.xml
+    test/test_helper.rb
+    test/tracking_test.rb
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/.*_test\.rb/ }
+end

data/examples/active_model.rb

@@ -0,0 +1,42 @@
+# TODO: write me
+
+require 'common'
+require 'audit'
+require 'active_model'
+
+class User
+  extend ActiveModel::Callbacks
+  
+  define_model_callbacks :create, :update
+  after_update :bonk
+  after_create :clown
+  
+  def self.create(attrs)
+    new.create(attrs)
+  end
+  
+  def create(attrs)
+    _run_create_callbacks do
+      puts "Creating: #{attrs}"
+    end
+  end
+  
+  def update(attrs)
+    _run_update_callbacks do
+      puts "Updating #{attrs}"
+    end
+  end
+  
+  def bonk
+    puts 'bonk!'
+  end
+  
+  def clown
+    puts "clown!"
+  end
+  
+end
+
+if __FILE__ == $PROGRAM_NAME
+  User.create(:foo)
+end

data/examples/active_record.rb

@@ -0,0 +1,37 @@
+require 'common'
+require 'pp'
+require 'audit'
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :database => ':memory:'
+)
+
+ActiveRecord::Schema.define do
+  create_table :users do |t|
+    t.string :username, :null => false
+    t.integer :age, :null => false
+    t.integer :gizmo
+  end
+end
+
+class User < ActiveRecord::Base
+  include Audit::Tracking
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Audit::Log.connection = Cassandra.new('Audit')
+  Audit::Log.clear!
+
+  user = User.create(:username => 'adam', :age => 30)
+  user.update_attributes(:age => 31)
+  user.update_attributes(:username => 'akk')
+  
+  user.audit_metadata(:reason => "Canonize usernames")
+  user.update_attributes(:username => 'therealadam')
+
+  100.times.each { |i| user.update_attributes(:gizmo => i) }
+  
+  pp user.audits
+end

data/examples/auditer.rb

@@ -0,0 +1,11 @@
+require 'common'
+require 'audit'
+
+if __FILE__ == $PROGRAM_NAME
+  log = Audit::Log
+  log.connection = Cassandra.new('Audit')
+  
+  changes = {:age => [30, 31]}
+  log.record(:user, 1, changes)
+  p log.audits(:user, 1)
+end

data/examples/common.rb

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler.setup

data/lib/audit.rb

@@ -0,0 +1,12 @@
+# Audit is a system for tracking model changes outside of your application's 
+# database.
+module Audit
+  
+  # Everything needs a version.
+  VERSION = '0.1.0'
+  
+  autoload :Log, "audit/log"
+  autoload :Changeset, "audit/changeset"
+  autoload :Tracking, "audit/tracking"
+  
+end

data/lib/audit/changeset.rb

@@ -0,0 +1,44 @@
+# A structure for tracking individual changes to a record.
+Audit::Change = Struct.new(:attribute, :old_value, :new_value)
+
+# A structure for tracking an atomic group of changes to a model.
+class Audit::Changeset < Struct.new(:changes, :metadata)
+  
+  # Recreate a changeset given change data as generated by ActiveRecord.
+  #
+  # hsh - the Hash to convert to a Changeset. Recognizes two keys:
+  #     "changes" - a Hash of changes as generated by ActiveRecord
+  #     "metadata" - user-provided metadata regarding this change
+  #
+  # Examples:
+  #
+  #   Audit::Changeset.from_hash({"changes" => {'age' => [30, 31]}})
+  #   # [<struct Audit::Changeset @attribute="age" @old_value=30 
+  #   #  @new_value=31>]
+  # 
+  # Returns an Array of Changeset objects, one for each changed attribute
+  def self.from_hash(hsh)
+    changes = hsh["changes"].map do |k, v|
+      attribute = k
+      old_value = v.first
+      new_value = v.last
+      Audit::Change.new(attribute, old_value, new_value)
+    end
+    new(changes, hsh["metadata"])
+  end
+  
+  # Recreate a changeset given one or more stored audit records.
+  #
+  # enum - an Array of change Hashes (see `from_hash` for details)
+  # 
+  # Returns an Array of Changeset objects, one for each atomic change
+  def self.from_enumerable(enum)
+    case enum
+    when Hash
+      from_hash(enum)
+    when Array
+      enum.map { |hsh| from_hash(hsh) }
+    end
+  end
+  
+end

data/lib/audit/log.rb

@@ -0,0 +1,51 @@
+require 'cassandra'
+require 'active_support/core_ext/module'
+require 'simple_uuid'
+require 'yajl'
+
+# Methods for manipulating audit data stored in Cassandra.
+module Audit::Log
+  
+  # Public: set or fetch the connection to Cassandra that Audit will use.
+  mattr_accessor :connection
+  
+  # Store an audit record.
+  #
+  # bucket - the String name for the logical bucket this audit record belongs 
+  #          to (i.e. table)
+  # key - the String key into the logical bucket
+  # changes - the changes hash (as generated by ActiveRecord) to store
+  #
+  # Returns nothing.
+  def self.record(bucket, key, changes)
+    json = Yajl::Encoder.encode(changes)
+    payload = {SimpleUUID::UUID.new => json}
+    connection.insert(:Audits, "#{bucket}:#{key}", payload)
+  end
+  
+  # Fetch all audits for a given record.
+  #
+  # bucket - the String name for the logical bucket this audit record belongs 
+  #          to (i.e. table)
+  # key - the String key into the logical bucket
+  #
+  # Returns an Array of Changeset objects
+  def self.audits(bucket, key)
+    # TODO: figure out how to do pagination here
+    payload = connection.get(:Audits, "#{bucket}:#{key}", :reversed => true)
+    payload.values.map do |p|
+      Audit::Changeset.from_enumerable(Yajl::Parser.parse(p))
+    end
+  end
+  
+  # Clear all audit data. 
+  # Note that this doesn't yet operate on logical 
+  # buckets. _All_ of the audit data is destroyed. Proceed with caution.
+  #
+  # Returns nothing.
+  def self.clear!
+    # It'd be nice if this could clear one bucket at a time
+    connection.clear_keyspace!
+  end
+  
+end

data/lib/audit/tracking.rb

@@ -0,0 +1,52 @@
+require 'active_support/core_ext/module'
+
+# Methods for tracking changes to your models by creating audit records
+# for every atomic change. Including this module adds callbacks which create
+# audit records every time a model object is changed and saved.
+module Audit::Tracking
+  extend ActiveSupport::Concern
+
+  # Public: set the log object to track changes with.
+  #
+  # Returns the log object currently in use.
+  mattr_accessor :log
+  self.log = Audit::Log
+  
+  included do
+    before_update :audit
+  end
+  
+  # Public: fetch audit records for a model object.
+  #
+  # Returns an Array of Changeset objects.
+  def audits
+    Audit::Tracking.log.audits(audit_bucket, self.id)
+  end
+  
+  # Creates a new audit record for this model object using data returned by 
+  # ActiveRecord::Base#changes.
+  #
+  # Returns nothing.
+  def audit
+    data = {"changes" => changes, "metadata" => audit_metadata}
+    Audit::Tracking.log.record(audit_bucket, self.id, data)
+    @audit_metadata = {}
+  end
+  
+  # Generates the bucket name for the model class.
+  #
+  # Returns a Symbol-ified and pluralized version of the model's name.
+  def audit_bucket
+    self.class.name.pluralize.to_sym
+  end
+  
+  # Public: Store audit metadata for the next write.
+  #
+  # metadata - a Hash of data that is written alongside the change data
+  #
+  # Returns nothing.
+  def audit_metadata(metadata={})
+    @audit_metadata = @audit_metadata.try(:update, metadata) || metadata
+  end
+  
+end

data/test/changeset_test.rb

@@ -0,0 +1,48 @@
+require 'test_helper'
+
+class ChangesetTest < Test::Unit::TestCase
+  
+  should 'convert a hash of changes to a changeset' do
+    metadata = {
+      "reason" => "Canonize usernames, getting older",
+      "signed" => "akk"
+    }
+    changes = {
+      "changes" => {
+        "username" => ["akk", "adam"], 
+        "age" => [30, 31]
+      },
+      "metadata" => metadata
+    }
+    changeset = Audit::Changeset.from_enumerable(changes)
+    
+    assert_equal 2, changeset.changes.length
+    assert(changeset.changes.all? { |cs| 
+      %w{username age}.include?(cs.attribute)
+      ["akk", 30].include?(cs.old_value)
+      ["adam", 31].include?(cs.new_value)
+    })
+    assert_equal metadata, changeset.metadata
+  end
+  
+  should "convert multile change records to an Array of Changesets" do
+    changes = [
+      {
+        "changes" => {"username" => ["akk", "adam"], "age" => [30, 31]}, 
+        "metadata" => {}
+      },
+      {
+        "changes" => {
+          "username" => ["adam", "therealadam"], 
+          "age" => [31, 32]
+        },
+        "metadata" => {}
+      }
+      
+    ]
+    changesets = Audit::Changeset.from_enumerable(changes)
+    
+    assert_equal 2, changesets.length
+  end
+  
+end

data/test/log_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+class LogTest < Test::Unit::TestCase
+  
+  should "save audit record" do
+    assert Audit::Log.record(:Users, 1, simple_change)
+  end
+  
+  should "load audit records" do
+    Audit::Log.record(:Users, 1, simple_change)
+    assert_kind_of Audit::Changeset, Audit::Log.audits(:Users, 1).first
+  end
+  
+  should "load audits with multiple changed attributes" do
+    Audit::Log.record(:Users, 1, multiple_changes)
+    changes = Audit::Log.audits(:Users, 1).first.changes
+    changes.each do |change|
+      assert %w{username age}.include?(change.attribute)
+      assert ["akk", 30].include?(change.old_value)
+      assert ["adam", 31].include?(change.new_value)
+    end
+  end
+  
+  def simple_change
+    {"changes" => {"username" => ["akk", "adam"]}, "metadata" => {}}
+  end
+  
+  def multiple_changes
+    {
+      "changes" => {"username" => ["akk", "adam"], "age" => [30, 31]}, 
+      "metadata" => {}
+    }
+  end
+  
+end

data/test/storage-conf.xml

@@ -0,0 +1,10 @@
+<!-- This isn't a valid config, just enough to get tests passing -->
+<Keyspaces>
+  <Keyspace Name="Audit">
+      <KeysCachedFraction>0.01</KeysCachedFraction>
+      <ColumnFamily CompareWith="UTF8Type" Name="Audits" />
+      <ReplicaPlacementStrategy>org.apache.cassandra.locator.RackUnawareStrategy</ReplicaPlacementStrategy>
+      <ReplicationFactor>1</ReplicationFactor>
+      <EndPointSnitch>org.apache.cassandra.locator.EndPointSnitch</EndPointSnitch>
+  </Keyspace>
+</Keyspaces>

data/test/test_helper.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+require 'test/unit'
+require 'shoulda'
+require 'flexmock/test_unit'
+require 'cassandra'
+require 'cassandra/mock'
+require 'active_record'
+require 'audit'
+
+class Test::Unit::TestCase
+
+  alias_method :original_setup, :setup
+  def setup
+    Audit::Log.connection = Cassandra::Mock.new(
+      'Audit', 
+      File.join(File.dirname(__FILE__), 'storage-conf.xml')
+    )
+    original_setup
+  end
+  
+end

data/test/tracking_test.rb

@@ -0,0 +1,62 @@
+require "test_helper"
+
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :database => ':memory:'
+)
+
+ActiveRecord::Schema.define do
+  create_table :users do |t|
+    t.string :username, :null => false
+    t.integer :age, :null => false
+  end
+end
+
+class User < ActiveRecord::Base; include Audit::Tracking; end
+
+class TrackingTest < Test::Unit::TestCase
+  
+  def setup
+    super
+    @model = User.new
+  end
+  
+  context "generate an audit bucket name" do
+    
+    should "based on the model name" do
+      assert_equal :Users, @model.audit_bucket
+    end
+    
+  end
+  
+  should "track audit metadata for the next save" do
+    audit_metadata = {"reason" => "Canonize usernames", "changed_by" => "JD"}
+    user = User.create(:username => "adam", :age => 31)
+    user.audit_metadata(audit_metadata)
+    user.update_attributes(:username => "therealadam")
+    changes = user.audits
+    
+    assert_equal audit_metadata, changes.first.metadata
+
+    user.save!
+
+    assert_equal({}, user.audit_metadata) # Should clear audit after write
+  end
+
+  should "add audit-related methods" do
+    assert_equal %w{audit audit_bucket audit_metadata audits}, 
+      @model.methods.map { |s| s.to_s }.grep(/audit/).sort
+  end
+
+  should "set the log object to an arbitrary object" do
+    Audit::Tracking.log = flexmock(:log).
+      should_receive(:audits).
+      once.
+      mock
+
+    User.create(:username => "Adam", :age => "31").audits
+
+    Audit::Tracking.log = Audit::Log
+  end
+  
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: audit
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Adam Keys
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-29 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cassandra
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 2
+        version: 0.8.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 11
+        - 3
+        version: 2.11.3
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 3
+        - 1
+        version: 1.4.3.1
+  type: :development
+  version_requirements: *id003
+description: Audit sits on top of your model objects and watches for changes to your data. When a change occurs, the differences are recorded and stored in Cassandra.
+email: adam@therealadam.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- LICENSE
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- audit.gemspec
+- examples/active_model.rb
+- examples/active_record.rb
+- examples/auditer.rb
+- examples/common.rb
+- lib/audit.rb
+- lib/audit/changeset.rb
+- lib/audit/log.rb
+- lib/audit/tracking.rb
+- test/changeset_test.rb
+- test/log_test.rb
+- test/storage-conf.xml
+- test/test_helper.rb
+- test/tracking_test.rb
+has_rdoc: true
+homepage: http://github.com/therealadam/auditus
+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: audit
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 2
+summary: Audit logs changes to model objects to Cassandra.
+test_files: 
+- test/changeset_test.rb
+- test/log_test.rb
+- test/tracking_test.rb