audited-activejob 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 120aff781d352f12152137ba7f7757f1ae0ba782
-  data.tar.gz: b9f29b3ad623bf2c1c51148f68c4949a48a1cf82
+  metadata.gz: 9d9284c4dd4face8354666d613c857578754815c
+  data.tar.gz: 9b3efea5550c313dcdd22f0c06ceee58741dccb6
 SHA512:
-  metadata.gz: fa489ed1cee3592546cc7ee80414243234eba36f939a56d26e59fb986a6ae86012ce8f7fc2ef2ae682510aaaae99262b5d8542c4b38fa7f994f86683f5dda8c9
-  data.tar.gz: d07b7f67b621e807827421959abc4cf238fcdcb92073dbcd253d5a9cdca7c2a8d12bb48248fe8c42e228a11138ba6a338c4869ed6f24355b038b1aadc4af319e
+  metadata.gz: 102a7d84ee4eff3322c22e81044727817008ac165b6cfccb965dba65a5b23c6665fae4c1c94045ca0553985d5fcfec8b37a38cd48f1259c830bba2bab9b0e6ca
+  data.tar.gz: 50df632247b25ee57c299173af683fb05e3a08135f8933e72712974111e9cc2849a004b35fe29f0e38220828052c14c04e83615cf79485bcb7c7a22bb36e999c

data/lib/audited/active_job.rb

@@ -1,17 +1,25 @@
 module Audited
   module ActiveJob
     def self.included(base)
-      base.send :attr_reader, :audit_user
+      base.send :include, ::ActiveJob::Users if defined?(::ActiveJob::Users)
 
       base.send :around_perform do |_job, block|
-        options = arguments.extract_options!
-        @audit_user = options.delete(:audit_user)
-        arguments << options unless options.empty?
-        
+        extract_audit_user!
+
         Audited.audit_class.as_user(audit_user) do
           block.call
         end
       end
+
+      def extract_audit_user!
+        options = arguments.extract_options!
+        @audit_user = options.delete(:audit_user)
+        arguments << options unless options.empty?
+      end
+
+      def audit_user
+        @audit_user || try(:job_user)
+      end
     end
   end
 end

data/lib/audited/active_job/version.rb

@@ -1,5 +1,5 @@
 module Audited
   module ActiveJob
-    VERSION = '0.0.4'
+    VERSION = '0.0.5'
   end
 end

data/spec/audited/active_job_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+RSpec.describe Audited::ActiveJob do
+  subject { TestJob.new }
+
+  context 'when an audit_user argument is passed to the job' do
+    let(:user) { {email: 'mark@markrebec.com'} }
+
+    it 'extracts the audit_user keyword argument' do
+      subject.arguments << {audit_user: user}
+      subject.extract_audit_user!
+
+      expect(subject.audit_user).to eq(user)
+    end
+
+    it 'passes other keyword arguments through' do
+      subject.arguments << {audit_user: user, foo: 'bar'}
+      subject.extract_audit_user!
+
+      expect(subject.arguments.last).to eq({foo: 'bar'})
+    end
+  end
+
+  context 'when an audit_user argument is not passed to the job' do
+    it 'sets the audit_user to nil' do
+      subject.extract_audit_user!
+
+      expect(subject.audit_user).to eq(nil)
+    end
+
+    it 'passes all keyword arguments through' do
+      subject.arguments << {foo: 'bar'}
+      subject.extract_audit_user!
+
+      expect(subject.arguments.last).to eq({foo: 'bar'})
+    end
+  end
+
+  describe '#audit_user' do
+    let(:audit_user) { {email: 'audit@example.com'} }
+    let(:job_user) { {email: 'job@example.com'} }
+
+    context 'when a job_user argument is passed to the job' do
+      context 'and no audit_user argument is passed to the job' do
+        it 'falls back to the job_user argument' do
+          subject.arguments << {job_user: job_user}
+          subject.extract_job_user!
+          subject.extract_audit_user!
+
+          expect(subject.audit_user).to eq(job_user)
+        end
+      end
+
+      context 'and an audit_user argument is passed to the job' do
+        it 'prefers the audit_user argument' do
+          subject.arguments << {job_user: job_user, audit_user: audit_user}
+          subject.extract_job_user!
+          subject.extract_audit_user!
+
+          expect(subject.audit_user).to eq(audit_user)
+        end
+      end
+    end
+  end
+
+  describe 'around_perform' do
+    it 'calls extract_audit_user!' do
+      expect_any_instance_of(TestJob).to receive(:extract_audit_user!)
+      TestJob.perform_now
+    end
+
+    it 'calls Audited.audit_class.as_user with the audit_user' do
+      expect(Audited.audit_class).to receive(:as_user).with(nil)
+      TestJob.perform_now
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,9 +1,12 @@
 require 'coveralls'
 Coveralls.wear!
+require 'active_job'
+require 'active_job/users'
+require 'audited'
 require 'audited-activejob'
 require 'rspec'
 
-#Dir[File.join(File.dirname(__FILE__), '..', "spec/support/**/*.rb")].each { |f| require f }
+Dir[File.join(File.dirname(__FILE__), '..', "spec/support/**/*.rb")].each { |f| require f }
 
 RSpec.configure do |config|
   # rspec-expectations config goes here. You can use an alternate

data/spec/support/audit_model.rb

@@ -0,0 +1,6 @@
+class AuditModel
+  def self.as_user(user)
+    # noop
+  end
+end
+Audited.audit_class = AuditModel

data/spec/support/test_job.rb

@@ -0,0 +1,7 @@
+class TestJob < ActiveJob::Base
+  include Audited::ActiveJob
+  queue_as :default
+
+  def perform
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: audited-activejob
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Mark Rebec
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activejob-users
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -77,7 +91,10 @@ files:
 - lib/audited-activejob.rb
 - lib/audited/active_job.rb
 - lib/audited/active_job/version.rb
+- spec/audited/active_job_spec.rb
 - spec/spec_helper.rb
+- spec/support/audit_model.rb
+- spec/support/test_job.rb
 homepage: http://github.com/markrebec/audited-activejob
 licenses: []
 metadata: {}
@@ -103,5 +120,7 @@ specification_version: 4
 summary: Pass a user through to your active_jobs and associate it with any generated
   audits
 test_files:
+- spec/audited/active_job_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 
+- spec/support/audit_model.rb
+- spec/support/test_job.rb