myabc-dm-audited 0.0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Dirkjan Bussink
+ 
+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

@@ -0,0 +1,4 @@
+dm-audited
+==========
+
+Add auditing to DataMapper Resources

data/Rakefile

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'spec'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'pathname'
+ 
+CLEAN.include '{log,pkg}/'
+
+spec = Gem::Specification.load('dm-audited.gemspec')
+
+task :default => [ :spec ]
+ 
+WIN32 = (RUBY_PLATFORM =~ /win32|mingw|cygwin/) rescue nil
+SUDO  = WIN32 ? '' : ('sudo' unless ENV['SUDOLESS'])
+ 
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+ 
+desc "Install #{spec.name} #{spec.version}"
+task :install => [ :package ] do
+  sh "#{SUDO} gem install pkg/#{spec.name}-#{spec.version} --no-update-sources", :verbose => false
+end
+ 
+desc 'Run specifications'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts << '--options' << 'spec/spec.opts' if File.exists?('spec/spec.opts')
+  t.spec_files = Pathname.glob(Pathname.new(__FILE__).dirname + 'spec/**/*_spec.rb')
+end

data/lib/dm-audited.rb

@@ -0,0 +1,127 @@
+require 'rubygems'
+gem 'dm-core', '>=0.9.2'
+gem 'dm-serializer', '>=0.9.2'
+require 'dm-core'
+require 'dm-timestamps'
+require 'dm-serializer'
+
+module DataMapper
+  module Audited
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module InstanceMethods
+
+      def create_audit(action)
+        # It needs to provide User.current_user if the user is to be saved
+        # The implementer needs to provide this and for example needs to make
+        # sure that the implementation is thread safe.
+        # The request is also optionally included if it can be found in the
+        # Application controller. Here again the implementer needs to provide
+        # this and make sure it's thread safe.
+        user    = defined?(::User)        && ::User.respond_to?(:current_user) && ::User.current_user ? ::User.current_user.id        : nil
+        request = defined?(::Application) && ::Application.respond_to?(:current_request)              ? ::Application.current_request : nil
+
+        changed_attributes = {}
+        @audited_attributes.each do |key, val|
+          changed_attributes[key] = [val, attributes[key]] unless val == attributes[key]
+        end
+
+        audit_attributes = {
+          :auditable_type => self.class.to_s,
+          :auditable_id   => self.id,
+          :user_id        => user,
+          :action         => action,
+          :changes        => changed_attributes
+        }
+
+        if request
+          params = request.params
+          if defined?(::Application) && defined?(Merb::Controller)
+            params = Application._filter_params(params)
+          end
+
+          audit_attributes.merge!(
+            :request_uri    => request.uri,
+            :request_method => request.method,
+            :request_params => params
+          )
+        end
+
+        remove_instance_variable("@audited_attributes")
+        remove_instance_variable("@audited_new_record") if instance_variable_defined?("@audited_new_record")
+
+        Audit.create(audit_attributes) unless changed_attributes.empty? && action != 'destroy'
+      end
+
+      def audits
+        Audit.all(:auditable_type => self.class.to_s, :auditable_id => self.id.to_s, :order => [:created_at, :id])
+      end
+
+    end
+
+    module ClassMethods
+      def is_audited
+
+        include DataMapper::Audited::InstanceMethods
+
+        before :save do
+          @audited_attributes = original_attributes.clone
+          @audited_new_record = new?
+        end
+
+        before :destroy do
+          @audited_attributes = original_attributes.clone
+        end
+
+        after :save do
+          create_audit(@audited_new_record ? 'create' : 'update')
+        end
+
+        after :destroy do
+          create_audit('destroy')
+        end
+
+      end
+    end
+
+    class Audit
+      include DataMapper::Resource
+
+      property :id,             Serial
+      property :auditable_type, String
+      property :auditable_id,   Integer
+      property :user_id,        Integer
+      property :request_uri,    String, :length => 255
+      property :request_method, String
+      property :request_params, Text
+      property :action,         String
+      property :changes,        Text
+      property :created_at,     DateTime
+
+      def auditable
+        auditable_type.constantize.get(auditable_id)
+      end
+
+      def changes=(properties)
+        attribute_set(:changes, properties.to_json)
+      end
+
+      def changes
+        @changes_hash ||= Mash.new(JSON.load(attribute_get(:changes)))
+      end
+
+      def request_params=(params)
+        attribute_set(:request_params, params.to_json)
+      end
+
+      def request_params
+        @request_params_hash ||= Mash.new(JSON.load(attribute_get(:request_params)))
+        @request_params_hash
+      end
+
+    end
+
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'pathname'
+
+gem 'dm-core', '>=0.9.2'
+require 'dm-core'
+
+spec_dir_path = Pathname(__FILE__).dirname.expand_path
+
+def load_driver(name, default_uri)
+  return false if ENV['ADAPTER'] != name.to_s
+ 
+  begin
+    DataMapper.setup(name, ENV["#{name.to_s.upcase}_SPEC_URI"] || default_uri)
+    DataMapper::Repository.adapters[:default] =  DataMapper::Repository.adapters[name]
+ 
+    FileUtils.touch LOG_PATH
+    DataMapper::Logger.new(LOG_PATH, 0)
+    at_exit { DataMapper.logger.close }
+    true
+  rescue Gem::LoadError => e
+    warn "Could not load #{lib}: #{e}"
+    false
+  end
+end
+ 
+ENV['ADAPTER'] ||= 'sqlite3'
+
+LOG_PATH     = Pathname(__FILE__).dirname.expand_path.to_s + '/sql.log'
+HAS_SQLITE3  = load_driver(:sqlite3,  'sqlite3::memory:')
+HAS_MYSQL    = load_driver(:mysql,    'mysql://localhost/dm_core_test')
+HAS_POSTGRES = load_driver(:postgres, 'postgres://postgres@localhost/dm_core_test')
+
+require spec_dir_path.parent + 'lib/dm-audited'
+
+Dir[spec_dir_path + "fixtures/*.rb"].each do |fixture_file|
+  require fixture_file
+end

data/spec/unit/audited_spec.rb

@@ -0,0 +1,74 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+describe "DataMapper::Audited" do
+
+  before :all do
+    DataObjects::Sqlite3.logger = DataObjects::Logger.new('spec/sql.log', 0)
+
+    class Cow
+      include DataMapper::Resource
+      include DataMapper::Audited
+
+      property :id,        Integer, :serial => true
+      property :name,      String
+      property :breed,     String
+
+      is_audited
+
+      auto_migrate!(:default)
+    end
+
+    module DataMapper
+      module Audited
+        class Audit
+          auto_migrate!(:default)
+        end
+      end
+    end
+  end
+
+  it "is included when DataMapper::Audited is loaded" do
+    Cow.new.should be_kind_of(DataMapper::Audited)
+  end
+
+  it "should create a new Audit object when creating an object" do
+    c = Cow.new(:name => "Bertha")
+    c.save
+
+    audit = DataMapper::Audited::Audit.first(:auditable_type => c.class.to_s, :auditable_id => c.id.to_s)
+
+    audit.should_not be_nil
+    audit.changes[:name].should_not be_nil
+    audit.action.should eql("create")
+  end
+
+  it "should create a new Audit object when changing an object" do
+    c = Cow.create(:name => "Bertha")
+
+    c.name = "Cindy"
+    c.save
+
+    audits = DataMapper::Audited::Audit.all(:auditable_type => c.class.to_s, :auditable_id => c.id.to_s, :order => [:created_at])
+
+    audits.length.should == 2
+    audits.last.should_not be_nil
+
+    audits.last.changes[:name].should_not be_nil
+    audits.last.changes[:name].first.should eql("Bertha")
+    audits.last.changes[:name].last.should eql("Cindy")
+    audits.last.action.should eql("update")
+  end
+
+  it "should create a new Audit object when destroying an object" do
+    c = Cow.create(:name => "Bertha")
+
+    c.destroy
+
+    c.audits.length.should == 2
+    c.audits.last.should_not be_nil
+
+    c.audits.last.action.should eql("destroy")
+  end
+
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: myabc-dm-audited
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Dirkjan Bussink
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-16 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.10.0
+    version: 
+description: DataMapper plugin providing auditing for resources
+email: d.bussink@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- lib/dm-audited.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/unit/audited_spec.rb
+- Rakefile
+- README
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/dbussink/dm-audited
+licenses: 
+post_install_message: 
+rdoc_options: []
+
+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: 2
+summary: DataMapper plugin providing auditing for resources
+test_files: []
+