audited_async 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6149810ee92e27f07045b28bea8cf9b1ad380a36f45fdf4d94b61889d58a6969
-  data.tar.gz: ec08ea6bbdea4f847437c322ef94aafef077f727fe2e0cdc2f1c0a56a3258a7c
+  metadata.gz: c51c75ec3c4c198def1ef6c8ba7d097d3082c34c50e2d9f21c32c11eccd47dff
+  data.tar.gz: 5f07254004b8529bf89fc45135a969c4a908b5ead5e8fcb474101bfa9ad02340
 SHA512:
-  metadata.gz: 7378037f865f092a172bdc88065bc633145684ae122a8ff64f81873b21e204cb682a60cd0914a105bf1c36ab03e085f86587cc8d34f902f0a37b5abb7156e749
-  data.tar.gz: c1b43a9aa415b486bb2ce1c64859a222193a6c124f68cb3a95ca1f091a313d5e0fef9d1b9bd990a8c473a7c6947f34dbe9a7b8f79582f8ec4d54d8184bdfdb1b
+  metadata.gz: 42fb8fa07014009ae4e1dbc60d9da873db89b0f6d11638ffd7af74c6dcd48a646be6cdac074652dba0f788d49e3599aa2e9bd20295d49ee60f646aa034622ee1
+  data.tar.gz: 2eeb65827e23e29d82b691501eaca6341d1aea260a9512e4e364bfdc3680bfd31c7fbd76b6aceff00034c7ea59d0c9dfb9eac92362cba88783d94576db253d13

data/.circleci/config.yml

@@ -0,0 +1,39 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.5.1-node-browsers
+    working_directory: ~/audited_async
+    parallelism: 4
+    branches:
+      only: master
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+            - audited_async-{{ .Branch }}-{{ checksum "Gemfile.lock" }}
+            - audited_async-master-{{ checksum "Gemfile.lock" }}
+
+      - run:
+          name: Bundle Install
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: audited_async-{{ .Branch }}-{{ checksum "Gemfile.lock" }}
+
+      - run:
+          name: Test Suite
+          command: |
+            mkdir /tmp/test-results
+
+            bundle exec rspec --format progress \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress
+
+      - run:
+          name: Test Coverage Report
+          command: bundle exec codeclimate-test-reporter

data/Gemfile.lock

@@ -1,164 +1,82 @@
 PATH
   remote: .
   specs:
-    audited_async (0.2.0)
+    audited_async (0.2.1)
+      activejob
       audited (>= 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.2.0)
-      actionpack (= 5.2.0)
-      nio4r (~> 2.0)
-      websocket-driver (>= 0.6.1)
-    actionmailer (5.2.0)
-      actionpack (= 5.2.0)
-      actionview (= 5.2.0)
-      activejob (= 5.2.0)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 2.0)
-    actionpack (5.2.0)
-      actionview (= 5.2.0)
-      activesupport (= 5.2.0)
-      rack (~> 2.0)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.0)
-      activesupport (= 5.2.0)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.2.0)
-      activesupport (= 5.2.0)
+    activejob (5.2.3)
+      activesupport (= 5.2.3)
       globalid (>= 0.3.6)
-    activemodel (5.2.0)
-      activesupport (= 5.2.0)
-    activerecord (5.2.0)
-      activemodel (= 5.2.0)
-      activesupport (= 5.2.0)
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
       arel (>= 9.0)
-    activestorage (5.2.0)
-      actionpack (= 5.2.0)
-      activerecord (= 5.2.0)
-      marcel (~> 0.3.1)
-    activesupport (5.2.0)
+    activesupport (5.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     arel (9.0.0)
     ast (2.4.0)
-    audited (4.7.1)
-      activerecord (>= 4.0, < 5.3)
-    builder (3.2.3)
-    codeclimate-test-reporter (1.0.8)
-      simplecov (<= 0.13)
-    concurrent-ruby (1.0.5)
-    crass (1.0.4)
+    audited (4.9.0)
+      activerecord (>= 4.2, < 6.1)
+    concurrent-ruby (1.1.5)
     diff-lcs (1.3)
-    docile (1.1.5)
-    erubi (1.7.1)
-    globalid (0.4.1)
+    globalid (0.4.2)
       activesupport (>= 4.2.0)
-    i18n (1.0.1)
+    i18n (1.6.0)
       concurrent-ruby (~> 1.0)
-    json (2.1.0)
-    loofah (2.2.2)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.0)
-      mini_mime (>= 0.1.1)
-    marcel (0.3.2)
-      mimemagic (~> 0.3.2)
-    method_source (0.9.0)
-    mimemagic (0.3.2)
-    mini_mime (1.0.0)
-    mini_portile2 (2.3.0)
+    jaro_winkler (1.5.3)
     minitest (5.11.3)
-    nio4r (2.3.1)
-    nokogiri (1.8.2)
-      mini_portile2 (~> 2.3.0)
-    parallel (1.12.1)
-    parser (2.5.1.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
       ast (~> 2.4.0)
-    powerpack (0.1.1)
-    rack (2.0.5)
-    rack-test (1.0.0)
-      rack (>= 1.0, < 3)
-    rails (5.2.0)
-      actioncable (= 5.2.0)
-      actionmailer (= 5.2.0)
-      actionpack (= 5.2.0)
-      actionview (= 5.2.0)
-      activejob (= 5.2.0)
-      activemodel (= 5.2.0)
-      activerecord (= 5.2.0)
-      activestorage (= 5.2.0)
-      activesupport (= 5.2.0)
-      bundler (>= 1.3.0)
-      railties (= 5.2.0)
-      sprockets-rails (>= 2.0.0)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.0)
-      actionpack (= 5.2.0)
-      activesupport (= 5.2.0)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
+    rack (2.0.7)
     rainbow (3.0.0)
-    rake (12.3.1)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rake (12.3.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    rubocop (0.55.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rubocop (0.71.0)
+      jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5)
-      powerpack (~> 0.1)
+      parser (>= 2.6)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    rubocop-rspec (1.25.1)
-      rubocop (>= 0.53.0)
-    ruby-progressbar (1.9.0)
-    simplecov (0.13.0)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    sprockets (3.7.1)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.2.1)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
-      sprockets (>= 3.0.0)
-    thor (0.20.0)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.4.1)
+      rubocop (>= 0.71.0)
+    rubocop-rails (2.0.1)
+      rack (>= 1.1)
+      rubocop (>= 0.70.0)
+    rubocop-rspec (1.35.0)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.1)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    unicode-display_width (1.3.2)
-    websocket-driver (0.7.0)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.3)
-    wonder-ruby-style (0.54.0)
-      rubocop (~> 0.49)
-      rubocop-rspec (~> 1.15)
+    unicode-display_width (1.6.0)
+    wonder-ruby-style (0.71.0)
+      rubocop (= 0.71.0)
+      rubocop-performance
+      rubocop-rails
+      rubocop-rspec
 
 PLATFORMS
   ruby
@@ -166,11 +84,9 @@ PLATFORMS
 DEPENDENCIES
   audited_async!
   bundler
-  codeclimate-test-reporter
-  rails
   rake
   rspec
   wonder-ruby-style
 
 BUNDLED WITH
-   1.16.1
+   1.17.3

data/README.md

@@ -1,10 +1,11 @@
 # AuditedAsync
 
 [![Maintainability](https://api.codeclimate.com/v1/badges/2d4899ab63fcea8a9144/maintainability)](https://codeclimate.com/github/leonardofalk/audited_async/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/2d4899ab63fcea8a9144/test_coverage)](https://codeclimate.com/github/leonardofalk/audited_async/test_coverage)
+[![CircleCI](https://circleci.com/gh/leonardofalk/audited_async.svg?style=svg)](https://circleci.com/gh/leonardofalk/audited_async)
 
-AuditedAsync is an addon for audited gem which allows to create audits asynchronously using ActiveJob.
+AuditedAsync is an extension for the [audited](https://github.com/collectiveidea/audited) gem which allows to create audits asynchronously using ActiveJob.
 
-It's currently under initial development and I strongly recommend you do not use it in production until it reaches a stable version.
+It works by safely injecting the `async` option into audited model option using functional programming. If enabled, it'll move audit creation logic into an ActiveJob instance, then it's sent to the queue to be executed later.
 
 ## Installation
 
@@ -27,7 +28,18 @@ class Post < ApplicationRecord
 end
 ```
 
-All done! Although you can configure some stuff, check below.
+Depending on your active job adapter, you may need to make the queue name visible to the adapter.
+
+### Sidekiq
+
+```yaml
+# config/sidekiq.yml
+...
+:queues:
+  - [audits, 1] # add this line
+```
+
+All done! Although you can optionally configure some more stuff, check below.
 
 #### Enabling it programmatically
 
@@ -35,7 +47,7 @@ All done! Although you can configure some stuff, check below.
 # config/initializers/audited_async.rb
 
 AuditedAsync.configure do |config|
-  config.enabled  = Rails.env.production?
+  config.enabled = Rails.env.production?
 end
 ```
 
@@ -46,6 +58,7 @@ end
 
 AuditedAsync.configure do |config|
   config.job_name  = 'JobityJob'
+  config.job_options = { wait: 1.second }
 end
 ```
 
@@ -79,17 +92,24 @@ class JobityJob < ApplicationJob
 end
 ```
 
-To see how the default job performs, [look here](./lib/audited_async/audit_async_job).
+### Limitations
 
-## How It Works
+ - Audits for destroying an object are subject to soft delete, hard deleted records are ignored, so if you are using some library like [paranoia](https://github.com/rubysherpas/paranoia) or [discard](https://github.com/jhawthorn/discard), destroying an object will still create audits, regardless model scoping.
+ - Attributes passed down to job are limited to serializable attributes, you can find a [list here](https://edgeguides.rubyonrails.org/active_job_basics.html#supported-types-for-arguments), other than that would throw an error.
 
-AuditedAsync safely inject the `async` option into audited model option using functional programming. If enabled, it'll move audit creation logic into an ActiveJob instance, then it's sent to the queue to be executed later.
+To see how the default job performs, [look here](./lib/audited_async/audit_async_job.rb).
+
+## Sample App
+
+https://github.com/leonardofalk/audited_async_sample.git
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Check out the repository, execute `bundle install` and you're good to go.
+
+## Testing
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+There are some unit tests now but integration tests are missing. You can ran the suite by executing `rspec`.
 
 ## Contributing
 
@@ -97,7 +117,7 @@ Bug reports and pull requests are welcome on GitHub at <https://github.com/leona
 
 ## To Do
 
--   [ ] Elaborate more test cases.
+-   [ ] Elaborate integration test cases.
 
 ## License
 

data/audited_async.gemspec

@@ -23,11 +23,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w[lib]
 
   spec.add_dependency 'audited', '>= 4.0'
+  spec.add_dependency 'activejob'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'wonder-ruby-style'
-  spec.add_development_dependency 'rails'
-  spec.add_development_dependency 'codeclimate-test-reporter'
 end

data/lib/audited_async.rb

@@ -5,14 +5,30 @@ require 'audited_async/audit_async_job'
 
 module AuditedAsync
   class << self
-    def configure
-      @configurator ||= AuditedAsync::Configurator.new
+    def logger
+      @logger ||= begin
+        if defined?(::Rails)
+          ::Rails.logger
+        else
+          require 'logger'
+
+          Logger.new
+        end
+      end
+    end
 
-      yield @configurator
+    def configure
+      yield configurator
     end
 
     def config
-      @configurator
+      configurator
+    end
+
+    private
+
+    def configurator
+      @configurator ||= AuditedAsync::Configurator.new
     end
   end
 end
@@ -49,8 +65,8 @@ module Audited::Auditor::AuditedInstanceMethods
   define_method :audit_update do
     return _audit_update.bind(self).() unless audited_async_enabled?
 
-    unless (changes = audited_changes).empty? && audit_comment.blank?
-      perform_async_audit 'update'
+    unless (changes = audited_changes).empty? && (audit_comment.blank? || audited_options[:update_with_comment_only] == false)
+      perform_async_audit('update', changes)
     end
   end
 
@@ -60,11 +76,14 @@ module Audited::Auditor::AuditedInstanceMethods
     perform_async_audit 'destroy' unless new_record?
   end
 
-  def perform_async_audit(method)
-    AuditedAsync.config.job.perform_later class_name: self.class.name,
-                                          record_id: send(self.class.primary_key.to_sym),
-                                          action: method,
-                                          audited_changes: audited_attributes.to_json,
-                                          comment: audit_comment
+  def perform_async_audit(method, changes = nil)
+    AuditedAsync.config
+                .job
+                .set(AuditedAsync.config.job_options)
+                .perform_later class_name: self.class.name,
+                               record_id: send(self.class.primary_key.to_sym),
+                               action: method,
+                               audited_changes: (changes || audited_attributes).to_json,
+                               comment: audit_comment
   end
 end

data/lib/audited_async/audit_async_job.rb

@@ -3,10 +3,27 @@ require 'active_job'
 class AuditedAsync::AuditAsyncJob < ActiveJob::Base
   queue_as :audits
 
-  def perform(attributes)
-    klass = attributes.delete(:class_name).constantize
-    model = klass.find_by(klass.primary_key.to_sym => attributes.delete(:record_id))
-    attributes[:audited_changes] = JSON.parse(attributes[:audited_changes])
-    model.send(:write_audit, attributes)
+  def perform(args)
+    klass, id, changes = extract_auditing_elements(args)
+
+    record = klass.unscoped.find_by(klass.primary_key.to_sym => id)
+
+    return alert_record_not_found(klass, id) unless record
+
+    record.send(:write_audit, changes)
+  end
+
+  private
+
+  def extract_auditing_elements(args)
+    return [args[:class_name].safe_constantize, args[:record_id], extract_audit_changes(args)]
+  end
+
+  def extract_audit_changes(args)
+    args.except(:class_name, :record_id).merge(audited_changes: JSON.parse(args[:audited_changes]))
+  end
+
+  def alert_record_not_found(klass, id)
+    AuditedAsync.logger.error "AuditedAsync: #{klass} record with id '#{id}' not found, ignoring audit write."
   end
 end

data/lib/audited_async/configurator.rb

@@ -1,10 +1,15 @@
 module AuditedAsync
   class Configurator
-    attr_accessor :enabled, :job_name
+    attr_accessor :enabled, :job_name, :job_options
 
     def initialize
-      @enabled  = true
-      @job_name = 'AuditedAsync::AuditAsyncJob'
+      @enabled     = true
+      @job_name    = 'AuditedAsync::AuditAsyncJob'
+      @job_options = { wait: 1.second }
+    end
+
+    def job_options
+      @job_options || {}
     end
 
     alias enabled? enabled

data/lib/audited_async/version.rb

@@ -1,3 +1,3 @@
 module AuditedAsync
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: audited_async
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Leonardo Falk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-04 00:00:00.000000000 Z
+date: 2019-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: audited
@@ -25,27 +25,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: activejob
   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
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -53,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: wonder-ruby-style
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: wonder-ruby-style
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -115,6 +101,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -150,8 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Execute audited asynchronously with ActiveJob.