Skip to content

Latest commit

 

History

History
116 lines (79 loc) · 3.61 KB

README.md

File metadata and controls

116 lines (79 loc) · 3.61 KB
Raw

AuditedAsync

Maintainability Test Coverage CircleCI

AuditedAsync is an extension for the audited gem which allows to create audits asynchronously using ActiveJob.

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

Add this line to your application's Gemfile, right after audited gem:

gem 'audited'
gem 'audited_async'

And then execute:

$ bundle

Usage

class Post < ApplicationRecord
  audited async: true
end

Depending on your active job adapter, you may need to make the queue name visible to the adapter.

Sidekiq

# config/sidekiq.yml
...
:queues:
  - [audits, 1] # add this line

All done! Although you can optionally configure some more stuff, check below.

Enabling it programmatically

# config/initializers/audited_async.rb

AuditedAsync.configure do |config|
  config.enabled = Rails.env.production?
end

Changing Job execution

# config/initializers/audited_async.rb

AuditedAsync.configure do |config|
  config.job_name  = 'JobityJob'
end

Create your own job:

class JobityJob < ApplicationJob
  queue_as :audits

  def perform(audit_info)
    # audit_info = {
    #   class_name:      'Post',
    #   record_id:       2,
    #   audited_changes: "{\"json_stringified_changes\": \"with_values\"}",
    #   action:          one of %w[create update destroy],
    #   comment:         there will be some string here if audited comments are enabled,
    # }

    # ...
    # run your logic
    # ...

    # job must have this line at the end
    class_name.constantize.send(:write_audit, attributes)
    # attributes = {
    #   audited_changes: {hash_changes: :with_values},
    #   action:          one of %w[create update destroy],
    #   comment:         comment, if enabled
    # }
  end
end

To see how the default job performs, look here.

Sample App

Samples on this repo.

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.

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/leonardofalk/audited_async. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

To Do

  • Elaborate more test cases.

License

The gem is available as open source under the terms of the MIT License.