mongo_trail 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongo_trail.gemspec
+gemspec
+
+group :development, :test do
+  gem "bson_ext",       require: false
+  gem "guard-rspec"
+  gem "rake"
+  gem "rb-fsevent"      # for guard
+  gem "rspec"
+  gem "ruby_gntp"       # for guard
+end
+
+group :test do
+  gem "ruby-debug19",   require: false
+  gem "simplecov",      require: false
+  #em "plymouth"        # invoke pry after rspec failures
+end

data/Guardfile

@@ -0,0 +1,6 @@
+guard "rspec" do
+  watch("lib/mongo_trail.rb")           { "spec" }
+  watch(%r{^lib/mongo_trail/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/.+_spec\.rb$})
+  watch("spec/helper.rb")               { "spec" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mark Lanett
+
+MIT License
+
+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,37 @@
+# MongoTrail
+
+Track audit trails in MongoDB.
+
+A single document is created with an id given by you.
+You can append simple records to it.
+The document can be exported in a way that is easy to turn into CSV.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongo_trail'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongo_trail
+
+## Usage
+
+MongoTrail.record_audit_trail 1, "author" => "Mark Lanett", "gem" => "MongoTrail"
+MongoTrail.record_audit_trail 1, "author" => "Mark Lanett", "gem" => "RedisLock"
+MongoTrail.export_audit_trail(1).should have(2).items
+MongoTrail.export_audit_trail(1).first.should include( "author" => "Mark Lanett", "gem" => "MongoTrail" )
+MongoTrail.export_audit_trail(1).last.should include( "author" => "Mark Lanett", "gem" => "RedisLock" )
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/mongo_trail.rb

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+require "mongo_trail/version"
+require "mongo"
+
+module MongoTrail
+
+  module Configuration
+    attr :audit_trail_configuration
+    def configure(&block)
+      @audit_trail_configuration = yield
+      @audit_trail_configuration.ensure_index( "id", unique: true )
+    end
+  end # Configuration
+
+  # Document structure:
+  # => id   Primary key (can't use _id due to limitations in upsert)
+  # => keys Array of Strings
+  # => data Array of Document
+  module AuditTrail
+
+    def record_audit_trail( id, data = {} )
+      bkey = { id: id }
+      keys = data.keys.sort
+      audit_trail_configuration.update( bkey, { "$set" => bkey, "$addToSet" => { keys: { "$each" => keys } }, "$push" => { data: data } }, upsert: true )
+    end
+
+    # If a block is given, writes an array to the block line by line
+    # Otherwise, returns an array.
+    def export_audit_trail( id, &block )
+      if ! block then
+        return [].tap { |result| export_audit_trail( id ) { |row| result << row } }
+      end
+
+      bkey = { id: id }
+      doc  = audit_trail_configuration.find( bkey ).to_a.first
+      if doc then
+        keys = doc["keys"].sort
+        data = doc["data"]
+        data.each { |row| block.call( row ) }
+      end
+    end
+
+  end # AuditTrail
+
+  extend Configuration
+  extend AuditTrail
+end

data/lib/mongo_trail/test/mongo_helper.rb

@@ -0,0 +1,15 @@
+RSpec.configure do |config|
+
+  config.before( :each, :mongo => true ) do
+    MongoTrail.configure do
+      Mongo::Connection.new.db("test").collection("audit_trails").tap do |c|
+        c.db.drop_collection( c.name)
+      end
+    end
+  end
+
+  config.after( :all, :mongo => true ) do
+    MongoTrail.audit_trail_configuration.db.drop_collection( MongoTrail.audit_trail_configuration.name)
+  end
+
+end

data/lib/mongo_trail/version.rb

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

data/mongo_trail.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/mongo_trail/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Mark Lanett"]
+  gem.email         = ["mark.lanett@gmail.com"]
+  gem.summary       = %q{Track audit trails in MongoDB}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "mongo_trail"
+  gem.require_paths = ["lib"]
+  gem.version       = MongoTrail::VERSION
+
+  gem.add_dependency "mongo"
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,10 @@
+require "helper"
+
+describe MongoTrail::Configuration do
+
+  it "can be configured" do
+    MongoTrail.configure { Mongo::Connection.new.db("test").collection("audit_trails") }
+    MongoTrail.audit_trail_configuration.should be_an_instance_of(Mongo::Collection)
+  end
+
+end

data/spec/helper.rb

@@ -0,0 +1,11 @@
+# -*- encoding: utf-8 -*-
+require "bundler/setup"         # set up gem paths
+require "ruby-debug"
+require "simplecov"             # code coverage
+SimpleCov.start                 # must be loaded before our own code
+require "mongo_trail"           # load this gem
+require "mongo_trail/test/mongo_helper"
+
+RSpec.configure do |spec|
+  #
+end

data/spec/mongo_spec.rb

@@ -0,0 +1,41 @@
+require "helper"
+
+describe Mongo do
+
+  subject { Mongo::Connection.new.db("test").collection("test") }
+  before { subject.db.drop_collection( subject.name) }
+  after  { subject.db.drop_collection( subject.name) }
+
+  it "can insert" do
+    subject.insert( { "a" => 1, "b" => 2 } )
+    subject.find.count.should == 1
+  end
+
+  it "can find" do
+    subject.insert( { "a" => 1, "b" => 2 } )
+    subject.insert( { "a" => 3, "b" => 4 } )
+    subject.find({ "a" => 3 }).first.should include({ "b" => 4 })
+  end
+
+  it "can update" do
+    subject.update( { id: 1 }, { id: 1, fields: [], changes: [] }, upsert: true )
+    subject.find({ id: 1 }).find.count.should == 1
+
+    # update can't mix modifiers and regular values, so must $set the keys
+    # update can't modify and set _id (as of 2.2)
+    subject.update( { id: 1 }, { "$set" => { id: 1 }, "$inc" => { magic: 1 }, "$addToSet" => { foo: "bar" } }, upsert: true, safe: true )
+    subject.update( { id: 1 }, { "$set" => { id: 1 }, "$inc" => { magic: 1 }, "$addToSet" => { foo: { "$each" => [ "zap", "zip" ] } } }, upsert: true )
+    subject.find({ id: 1 }).find.count.should == 1
+    subject.find({ id: 1 }).find.first.should include({ "foo" => [ "bar", "zap", "zip" ] })
+  end
+
+  it "can not upsert and set custom _id" do
+    expect { subject.update( { _id: 1 }, { "$set" => { _id: 1 } }, upsert: true, safe: true ) }.to raise_exception
+    expect { subject.update( { _id: 1 }, { "$iset" => { _id: 1 } }, upsert: true, safe: true ) }.to raise_exception
+  end
+
+  it "finds nothing as empty array" do
+    subject.find( foo: 1 ).to_a.should == []
+  end
+
+end

data/spec/mongo_trail_spec.rb

@@ -0,0 +1,25 @@
+require "helper"
+
+describe MongoTrail, mongo: true do
+
+  it "exports empty audit trails for unknown objects" do
+    MongoTrail.export_audit_trail(1).should have(0).items
+  end
+
+  it "can record and export audit trails" do
+    MongoTrail.record_audit_trail 1, "author" => "Mark Lanett", "gem" => "MongoTrail"
+    MongoTrail.record_audit_trail 1, "author" => "Mark Lanett", "gem" => "RedisLock"
+    MongoTrail.export_audit_trail(1).should have(2).items
+    MongoTrail.export_audit_trail(1).first.should include( "author" => "Mark Lanett", "gem" => "MongoTrail" )
+    MongoTrail.export_audit_trail(1).last.should include( "author" => "Mark Lanett", "gem" => "RedisLock" )
+    puts MongoTrail.audit_trail_configuration.find.to_a
+  end
+
+  it "normalizes data with all keys in use" do
+    MongoTrail.record_audit_trail 1, "author" => "Mark Lanett", "gem" => "MongoTrail"
+    MongoTrail.record_audit_trail 1, "author" => "Mark Lanett"
+    # expect all documents to have author and gem
+    MongoTrail.export_audit_trail(1).last.should include( "author" => "Mark Lanett", "gem" => nil )
+  end
+
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: mongo_trail
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: !!null 
+platform: ruby
+authors:
+- Mark Lanett
+autorequire: !!null 
+bindir: bin
+cert_chain: []
+date: 2012-04-14 00:00:00.000000000 -07:00
+default_executable: !!null 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: &70247499619260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70247499619260
+description: !!null 
+email:
+- mark.lanett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mongo_trail.rb
+- lib/mongo_trail/test/mongo_helper.rb
+- lib/mongo_trail/version.rb
+- mongo_trail.gemspec
+- spec/configuration_spec.rb
+- spec/helper.rb
+- spec/mongo_spec.rb
+- spec/mongo_trail_spec.rb
+has_rdoc: true
+homepage: ''
+licenses: []
+post_install_message: !!null 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: !!null 
+rubygems_version: 1.5.0
+signing_key: !!null 
+specification_version: 3
+summary: Track audit trails in MongoDB
+test_files:
+- spec/configuration_spec.rb
+- spec/helper.rb
+- spec/mongo_spec.rb
+- spec/mongo_trail_spec.rb