audited-deferrable 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Ben Hughes
+
+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,41 @@
+# audited-deferrable
+
+Extension to the audited gem to deferred writing of audits via Resque, but with modular architecture to support adding other providers such as sidekiq and delayed job (pull requests, please!)
+
+NOTE: This currently only works with Resque v1, not Resque v2 which is a different API. I'd gladly accept pull requests supporting both.
+
+## Usage:
+
+In Gemfile:
+
+    gem "audited-activerecord", "~> 3.0.0"
+    gem "resque", "~> 1.24"
+    gem "audited-deferrable", "~> 0.1.0"
+
+In an initializer (config/initializers/audited.rb):
+
+    Audited.defer_with = :resque
+
+After this, all of your audits will be written to the resque queue, and to completely them you'll need to run a resque worker:
+
+    $ QUEUE=audited rake environment resque:work
+
+## Configuration
+
+By default, the resque queue is set to :audited, but can be changed:
+
+    Audited::Deferrable::Resque.queue = :custom_queue
+
+## Custom Handlers
+
+If you want to write a handler for sidekiq or delayed job, please fork the project and implement as a subclass of Audited::Deferrable::Base, then send a pull request so all can use.
+
+A completely custom handler can be implemented outside of the gem by subclassing Audited::Deferrable::Base, then setting that class to defer_with directly:
+
+    class Audited::Deferrable::CustomProvider < Audited::Deferrable::Base
+      ...
+    end
+    
+    Audited.defer_with = Audited::Deferrable::CustomProvider
+
+

data/lib/audited/deferrable.rb

@@ -0,0 +1,52 @@
+require "audited"
+
+module Audited
+  module Deferrable
+    extend ActiveSupport::Concern
+
+    included do
+      Audited::Auditor::AuditedInstanceMethods.class_eval do
+        alias_method :write_audit_without_deferrable, :write_audit
+
+        def write_audit(attrs)
+          if Audited.deferrable
+            Audited.deferrable.new(self, Audited::Sweeper.instance.current_user, attrs).defer if auditing_enabled
+          else
+            write_audit_without_deferrable(attrs)
+          end
+        end
+      end
+    end
+
+    module ClassMethods
+      def defer_with
+        @defer_with
+      end
+
+      def defer_with=(value)
+        @defer_with = value
+        deferrable
+        @defer_with
+      end
+
+      def deferrable
+        if @defer_with.nil?
+          nil
+        elsif @defer_with.is_a?(Class)
+          @defer_with
+        else
+          begin
+            require "audited/deferrable/#{@defer_with}"
+            @defer_with = Audited::Deferrable.const_get(@defer_with.to_s.classify)
+          rescue LoadError
+            raise ArgumentError, "No handler exists for '#{@defer_with}'"
+          end
+        end
+      end
+    end
+
+  end
+end
+
+Audited.send :include, Audited::Deferrable
+

data/lib/audited/deferrable/base.rb

@@ -0,0 +1,39 @@
+module Audited
+  module Deferrable
+    class Base
+
+      def initialize(object, user, attrs)
+        @object = object
+        @user = user
+        @attrs = attrs
+      end
+
+      def arguments
+        [
+          @object.class.name, 
+          @object.id, 
+          @user.try(:class).try(:name),
+          @user.try(:id),
+          @attrs
+        ]
+      end
+
+      def self.from_arguments(object_class_name, object_id, user_class_name, user_id, attrs)
+        object = object_class_name.constantize.find(object_id)
+        user = user_class_name.constantize.find(user_id) if user_class_name
+        new(object, user, attrs)
+      end
+
+      def defer
+        raise ArgumentError, "Implementation Required"
+      end
+
+      def work
+        Audited.audit_class.as_user(@user) do
+          @object.send(:write_audit_without_deferrable, @attrs)
+        end
+      end
+
+    end
+  end
+end

data/lib/audited/deferrable/resque.rb

@@ -0,0 +1,30 @@
+require "audited"
+require "audited/deferrable/base"
+
+module Audited
+  module Deferrable
+    class Resque < Base
+      @queue = :audited
+
+      def self.queue
+        @queue
+      end
+      def self.queue=(value)
+        @queue = value
+      end
+
+      def resque
+        @resque ||= Resque.new
+      end
+
+      def defer
+        ::Resque.enqueue(self.class, *arguments)
+      end
+
+      def self.perform(*args)
+        from_arguments(*args).work
+      end
+
+    end
+  end
+end

data/lib/audited/deferrable/version.rb

@@ -0,0 +1,5 @@
+module Audited
+  module Deferrable
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: audited-deferrable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ben Hughes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70329449422300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70329449422300
+- !ruby/object:Gem::Dependency
+  name: audited
+  requirement: &70329449420780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70329449420780
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70329449418760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: *70329449418760
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: &70329449416480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: *70329449416480
+- !ruby/object:Gem::Dependency
+  name: sqlite3-ruby
+  requirement: &70329449434560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :development
+  prerelease: false
+  version_requirements: *70329449434560
+description: Extension to the audited gem to deferred writing of audits via Resque,
+  Delayed Job, or Sidekiq
+email: ben@railsgarden.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/audited/deferrable/base.rb
+- lib/audited/deferrable/resque.rb
+- lib/audited/deferrable/version.rb
+- lib/audited/deferrable.rb
+- LICENSE
+- README.md
+homepage: http://github.com/rubiety/audited-deferrable
+licenses: []
+post_install_message: 
+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: 1.3.4
+requirements: []
+rubyforge_project: audited-deferrable
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Extension to the audited gem to deferred writing of audits via Resque, Delayed
+  Job, or Sidekiq
+test_files: []
+has_rdoc: