samsara 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTg2NTcwOGUzYzc2ZGVlNjM3MmMyZTM3NmNmY2Y3YzVmNWVjMzk2NA==
+  data.tar.gz: !binary |-
+    YWFhMGZhY2RiYzJjODhhMWU3MTEwNWNjNmQ2OTNlNmEyYmVmNTVhNQ==
+SHA512:
+  metadata.gz: !binary |-
+    N2QyNzMwZjIxMTU2YTY0YjNhZDI3MGZjMTJhNTY2NTA1MDU0ZDc0Y2MxZmE0
+    OGI4ZTJlYzMyODg2NjU5MzdjZGQ4Y2UyNzZkODA4NDM5YmViMjE2MTYyNTdm
+    ZDU3NTQyNzFjNDgwODIxMjFmYzZkNGJmZjdlM2YxZDY5ZjBjMmE=
+  data.tar.gz: !binary |-
+    OGEyZWQ2Njc0MjY5OGY5MmZmOTc4YzBhM2E5OGRiMDJmZWUyNTdlNTM1MjZi
+    ZDRmOWNjYjViYzEwZWIzNTk5MzhjZWE2OTUyODM0NGI0OTg5NzMzZjIwOGNj
+    OGY4NTc3NWE1YmM1OThlZjBjODcyYmM1ZjZmM2ZiMGIzYzk2M2Y=

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+spec/dummy/log/*
+spec/dummy/db/test.sqlite3

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.1.1
+  - 2.1.2
+  - 2.1.3
+  - 2.2.0
+
+addons:
+  code_climate:
+    repo_token: 749cbdcad311874703e4581c7c3504d5e1cefe2d81ed61506018f546f458e219

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in samsara.gemspec
+gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Tom Nijmeijer
+
+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,33 @@
+# Samsara
+[![Build Status](https://travis-ci.org/nedap/samsara.svg?branch=master)](http://travis-ci.org/nedap/samsara)
+[![Code Climate](https://codeclimate.com/repos/55377484e30ba0452a000e20/badges/4a99ca136302edade535/gpa.svg)](https://codeclimate.com/repos/55377484e30ba0452a000e20/feed)
+[![Test Coverage](https://codeclimate.com/repos/55377484e30ba0452a000e20/badges/4a99ca136302edade535/coverage.svg)](https://codeclimate.com/repos/55377484e30ba0452a000e20/feed)
+
+A simple auditing gem that does things a little differently. Rather than just storing the domain changes made
+this gem is also capable of storing the context in which the changes were made such as a http request. This
+context is stored in a separate database table and is shared by multiple revisions in case a single request
+causes changes to multiple domain models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'samsara'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install samsara
+
+## Contributing
+
+1. Fork it ( https://github.com/nedap/samsara/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Run the spec testing suite'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Default: run the test suite'
+task :default => [:spec]

data/lib/samsara/context.rb

@@ -0,0 +1,7 @@
+require 'active_record'
+
+class Samsara::Context < ActiveRecord::Base
+
+  include Samsara::ContextConcern
+
+end

data/lib/samsara/context_concern.rb

@@ -0,0 +1,31 @@
+require 'active_support/concern'
+
+module Samsara::ContextConcern
+  extend ActiveSupport::Concern
+
+  # t.string  :event_type
+  # t.text    :event_attributes
+  # t.string  :environment_name
+  # t.string  :application_name
+  # t.timestamps
+
+  included do
+    has_many :revisions, class_name: Samsara.revision_class_name
+
+    serialize :event_attributes, Samsara::Serializer
+  end
+
+  def event_class
+    event_type.constantize
+  end
+
+  def event
+    @event ||= event_class.new(event_attributes)
+  end
+
+  def event=(event)
+    self.event_type       = event.class.name
+    self.event_attributes = event.attributes
+  end
+
+end

data/lib/samsara/controller.rb

@@ -0,0 +1,37 @@
+module Samsara::Controller
+  extend ActiveSupport::Concern
+
+  included do
+    before_filter :set_samsara_context
+    after_filter  :unset_samsara_context
+  end
+
+  def set_samsara_context
+    return unless Samsara.active?
+    Samsara.current_context = build_samsara_context
+  end
+
+  def unset_samsara_context
+    Samsara.current_context = nil
+  end
+
+  def build_samsara_context
+    Samsara.context_class.new.tap do |c|
+      c.event = build_samsara_http_request
+      c.application_name = application_name_for_samsara
+      c.environment_name = environment_name_for_samsara
+    end
+  end
+
+  def build_samsara_http_request
+    Samsara.request_class.build_from(self)
+  end
+
+  def environment_name_for_samsara
+    Rails.env
+  end
+
+  def application_name_for_samsara
+    Rails.application.class.parent.name
+  end
+end

data/lib/samsara/http_request.rb

@@ -0,0 +1,32 @@
+class Samsara::HttpRequest
+  attr_accessor :attributes
+
+  def self.build_from(controller)
+    self.new(extract_attributes_from controller)
+  end
+
+  def self.extract_attributes_from(controller)
+    {
+      url:       controller.request.filtered_path,
+      params:    controller.request.filtered_parameters,
+      method:    controller.request.method
+    }
+  end
+
+  def initialize(attributes = {})
+    @attributes = attributes
+  end
+
+  def method
+    attributes[:method]
+  end
+
+  def url
+    attributes[:url]
+  end
+
+  def params
+    attributes[:params]
+  end
+
+end

data/lib/samsara/model.rb

@@ -0,0 +1,43 @@
+module Samsara::Model
+  extend ActiveSupport::Concern
+
+  included do
+    def self.is_audited?
+      @is_audited || false
+    end
+
+    def self.is_audited
+      @is_audited = true
+
+      has_many :auditing_revisions, class_name: Samsara.revision_class_name, as: :subject
+
+      after_create  :audit_create
+      after_update  :audit_update,  if: :changed?
+      after_destroy :audit_destroy, if: :destroyed?
+    end
+  end
+
+  def audit_create
+    create_audit :create
+  end
+
+  def audit_update
+    create_audit :update
+  end
+
+  def audit_destroy
+    create_audit :destroy
+  end
+
+  def create_audit(action)
+    return unless Samsara.active?
+    Samsara.revision_class.new do |a|
+      a.action  = action
+      a.subject = self
+      a.context = Samsara.current_context
+      a.modified_attributes = self.attributes
+      a.original_attributes = self.changed_attributes
+    end.save
+  end
+
+end

data/lib/samsara/railtie.rb

@@ -0,0 +1,13 @@
+class Samsara::Railtie < Rails::Railtie
+  initializer 'samsara.initialize' do
+
+    ActiveSupport.on_load(:active_record) do
+      include Samsara::Model
+    end
+
+    ActiveSupport.on_load(:action_controller) do
+      include Samsara::Controller
+    end
+
+  end
+end

data/lib/samsara/revision.rb

@@ -0,0 +1,7 @@
+require 'active_record'
+
+class Samsara::Revision < ActiveRecord::Base
+
+  include Samsara::RevisionConcern
+
+end

data/lib/samsara/revision_concern.rb

@@ -0,0 +1,30 @@
+require 'active_support/concern'
+
+module Samsara::RevisionConcern
+  extend ActiveSupport::Concern
+
+  #  t.string     :action
+  #  t.integer    :subject_id
+  #  t.string     :subject_type
+  #  t.text       :modified_attributes
+  #  t.text       :original_attributes
+  #  t.references :context
+  #  t.timestamps
+
+  included do
+    belongs_to :subject, polymorphic: true
+    belongs_to :context, class_name: Samsara.context_class_name
+
+    default_scope{ order(:created_at) }
+
+    serialize :modified_attributes, Samsara::Serializer
+    serialize :original_attributes, Samsara::Serializer
+  end
+
+  def attribute_changes
+    original_attributes.each_with_object({}) do |(attribute, value), changes|
+      changes[attribute] = [value, modified_attributes[attribute]]
+    end
+  end
+
+end

data/lib/samsara/serializer.rb

@@ -0,0 +1,29 @@
+class Samsara::Serializer
+
+  def self.dump(arg)
+    case arg
+    when Hash
+      arg.to_json
+    else
+      arg
+    end
+  end
+
+  def self.load(arg)
+    case arg
+    when String
+      load JSON.parse(arg)
+    when Hash
+      symbolize_keys! arg
+    else
+      arg
+    end
+  end
+
+  def self.symbolize_keys!(arg)
+    return arg unless arg.is_a? Hash
+    arg.values.each{|val| symbolize_keys! val }
+    arg.symbolize_keys!
+  end
+
+end

data/lib/samsara/version.rb

@@ -0,0 +1,3 @@
+module Samsara
+  VERSION = "0.0.2"
+end

data/lib/samsara.rb

@@ -0,0 +1,90 @@
+require "samsara/version"
+
+module Samsara
+
+  def self.table_name_prefix
+    'samsara_'
+  end
+
+  def self.active?
+    active != :disabled
+  end
+
+  def self.active
+    @@auditing_active ||= :disabled
+  end
+
+  def self.active=(active)
+    @@auditing_active = active
+  end
+
+  def self.enable!
+    @@auditing_active = :enabled
+  end
+
+  def self.disable!
+    @@auditing_active = :disabled
+  end
+
+  def self.current_context=(val)
+    Thread.current[:samsara_context] = val
+  end
+
+  def self.current_context
+    Thread.current[:samsara_context]
+  end
+
+  def self.revision_class_name
+    @@revision_class_name ||= "Samsara::Revision"
+  end
+
+  def self.revision_class_name=(name)
+    Samsara::Revision.abstract_class = (name != "Samsara::Revision")
+    @@revision_class_name = name
+  end
+
+  def self.revision_class
+    revision_class_name.constantize
+  end
+
+  def self.context_class_name
+    @@context_class_name ||= "Samsara::Context"
+  end
+
+  def self.context_class_name=(name)
+    Samsara::Context.abstract_class = (name != "Samsara::Context")
+    @@context_class_name = name
+  end
+
+  def self.context_class
+    context_class_name.constantize
+  end
+
+  def self.request_class_name
+    @@request_class_name ||= "Samsara::HttpRequest"
+  end
+
+  def self.request_class_name=(name)
+    Samsara::Context.abstract_class = (name != "Samsara::HttpRequest")
+    @@request_class_name = name
+  end
+
+  def self.request_class
+    request_class_name.constantize
+  end
+
+  def self.configure(&block)
+    yield self
+  end
+
+end
+
+require "samsara/serializer"
+require "samsara/http_request"
+require "samsara/revision_concern"
+require "samsara/revision"
+require "samsara/context_concern"
+require "samsara/context"
+require "samsara/model"
+require "samsara/controller"
+require "samsara/railtie" if defined?(Rails)

data/samsara.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'samsara/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "samsara"
+  spec.version       = Samsara::VERSION
+  spec.authors       = ["Tom Nijmeijer"]
+  spec.email         = ["tom.nijmeijer@nedap.com"]
+  spec.summary       = "Custom auditing gem made for and by PEP"
+  spec.description   = <<-DESC
+    Custom auditing gem made for and by PEP. Rather than just saving the modifications made,
+    this gem puts the changes in context by storing a separate context object. Multiple
+    revisions can be attached to a single context such as a single http request.
+  DESC
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord",  ">= 3.0"
+  spec.add_dependency "activesupport", ">= 3.0"
+
+  spec.add_development_dependency "bundler", ">= 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "sqlite3", "~> 1.2"
+  spec.add_development_dependency "rspec-rails", "~> 3.2"
+end

data/spec/context_spec.rb

@@ -0,0 +1,42 @@
+require 'rails_helper'
+
+describe Samsara::Context do
+
+  let(:celebrity_params) do
+    { first_name: "Neil", last_name: "Harris" }
+  end
+
+  let(:params) do
+    { celebrity: celebrity_params, controller: "celebrities", action: "create" }
+  end
+
+  let(:event_attributes) do
+    { method: "POST", url: "/celebrities", params: params }
+  end
+
+  let(:event) do
+    Samsara::HttpRequest.new(event_attributes)
+  end
+
+  let(:context_attributes) do
+    { environment_name: "test", application_name: "Dummy", event: event }
+  end
+
+  before { Samsara::Context.create context_attributes }
+  subject { Samsara::Context.first }
+
+  describe "#event_attributes" do
+    it "is serialized using the Samsara::Serializer" do
+      allow(Samsara::Serializer).to receive(:dump).with(any_args)
+      expect(Samsara::Serializer).to receive(:dump).with(event_attributes)
+      subject.event_attributes = event_attributes
+    end
+
+    it "is deserialized using the Samsara::Serializer" do
+      allow(Samsara::Serializer).to receive(:load).with(any_args)
+      expect(Samsara::Serializer).to receive(:load).with(event_attributes.to_json)
+      subject.event_attributes
+    end
+  end
+
+end

data/spec/controller_spec.rb

@@ -0,0 +1,122 @@
+require 'rails_helper'
+
+describe CelebritiesController, type: :request do
+  let(:context_class) { Samsara.context_class }
+  let(:revision_class) { Samsara.revision_class }
+
+  let(:celebrity_params) do
+    { first_name: "Brigitte", last_name: "Bardot", gender: "2", birth_date: "1934-9-28" }
+  end
+
+  context "while samsara is not active" do
+    before do
+      Samsara.disable!
+      post(celebrities_path, celebrity: celebrity_params)
+    end
+
+    it "does not create a context" do
+      expect(context_class.count).to eq 0
+    end
+
+    it "does not create a revision" do
+      expect(revision_class.count).to eq 0
+    end
+  end
+
+  context "while samsara is active" do
+    before do
+      Samsara.enable!
+    end
+
+    context "requesting the index" do
+      before do
+        get(celebrities_path)
+      end
+
+      it "does not create a context" do
+        expect(context_class.count).to eq 0
+      end
+
+      it "does not create a revision" do
+        expect(revision_class.count).to eq 0
+      end
+    end
+
+    context "creating an invalid celebrity" do
+      before do
+        post(celebrities_path, celebrity: celebrity_params.merge(gender: 3))
+      end
+
+      it "does not create a context" do
+        expect(context_class.count).to eq 0
+      end
+
+      it "does not create a revision" do
+        expect(revision_class.count).to eq 0
+      end
+    end
+
+    context "creating a single celebrity" do
+      before do
+        post(celebrities_path, celebrity: celebrity_params, password: "supersecret")
+      end
+
+      it "creates a context" do
+        expect(context_class.count).to eq 1
+      end
+
+      it "creates a revision" do
+        expect(revision_class.count).to eq 1
+      end
+
+      context "the created context" do
+        let(:context) { context_class.first }
+
+        let(:expected_params) do
+          { celebrity: celebrity_params, password: "[FILTERED]", controller: "celebrities", action: "create" }
+        end
+
+        it "has set the application name" do
+          expect(context.application_name).to eq "Dummy"
+        end
+
+        it "has set the environment name" do
+          expect(context.environment_name).to eq "test"
+        end
+
+        it "has set the http request as the event" do
+          expect(context.event).to be_a Samsara::HttpRequest
+          expect(context.event.method).to eq "POST"
+          expect(context.event.url).to eq celebrities_path
+          expect(context.event.params).to eq(expected_params)
+        end
+
+        it "has been linked to the revision" do
+          expect(context.revisions.count).to eq 1
+        end
+      end
+    end
+
+    context "creating multiple celebrities" do
+      before do
+        post(multiply_celebrities_path, celebrity: celebrity_params, password: "supersecret")
+      end
+
+      it "creates a context" do
+        expect(context_class.count).to eq 1
+      end
+
+      it "creates multiple revisions" do
+        expect(revision_class.count).to eq 2
+      end
+
+      context "the created context" do
+        let(:context) { context_class.first }
+
+        it "has been linked to all the revisions" do
+          expect(context.revisions.count).to eq 2
+        end
+      end
+    end
+  end
+end

data/spec/dummy/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.