transcript 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b20d6d6f59ef113036dddfa9739d4fc16dc10b0
+  data.tar.gz: ea8aa8e46168e4dbddaa027f2820f6e83e7373ec
+SHA512:
+  metadata.gz: c58484693521b8da900784752ba56c334b7141d2af4163ce68b345b4010457fd43450eb2a9d307754dda9dc23ebafda1a7ec173d1a82999a360a4800778e66a0
+  data.tar.gz: 931079903ab30d12e4a52d9701120e22613d2dbe51a7be57764582d34b64df65b2b3f5f319e1af6c98976216ab8a8d6ff5f3620fc32a1c0faeb7c86c7d6fb2c8

data/.codeclimate.yml

@@ -0,0 +1,27 @@
+---
+engines:
+  bundler-audit:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+  markdownlint:
+    enabled: true
+    checks:
+      MD013:
+        enabled: false
+  shellcheck:
+    enabled: true
+ratings:
+  paths:
+  - Gemfile.lock
+  - "**.erb"
+  - "**.rb"
+exclude_paths:
+- spec/

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+log/*.log
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/

data/.rspec

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at logan@loganleger.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in transcript.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,170 @@
+PATH
+  remote: .
+  specs:
+    transcript (0.1.0)
+      rails (~> 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.0.0.1)
+      actionpack (= 5.0.0.1)
+      nio4r (~> 1.2)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.0.0.1)
+      actionpack (= 5.0.0.1)
+      actionview (= 5.0.0.1)
+      activejob (= 5.0.0.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.0.0.1)
+      actionview (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.0.1)
+      activesupport (= 5.0.0.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (5.0.0.1)
+      activesupport (= 5.0.0.1)
+      globalid (>= 0.3.6)
+    activemodel (5.0.0.1)
+      activesupport (= 5.0.0.1)
+    activerecord (5.0.0.1)
+      activemodel (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      arel (~> 7.0)
+    activesupport (5.0.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ammeter (1.1.3)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-rails (>= 2.2)
+    arel (7.1.1)
+    builder (3.2.2)
+    codeclimate-test-reporter (0.6.0)
+      simplecov (>= 0.7.1, < 1.0.0)
+    concurrent-ruby (1.0.2)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    erubis (2.7.0)
+    factory_girl (4.7.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.7.0)
+      factory_girl (~> 4.7.0)
+      railties (>= 3.0.0)
+    globalid (0.3.7)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (2.0.1)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.9.0)
+    nio4r (1.2.1)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    pkg-config (1.1.7)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.0.0.1)
+      actioncable (= 5.0.0.1)
+      actionmailer (= 5.0.0.1)
+      actionpack (= 5.0.0.1)
+      actionview (= 5.0.0.1)
+      activejob (= 5.0.0.1)
+      activemodel (= 5.0.0.1)
+      activerecord (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 5.0.0.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.1)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6.0)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.0.1)
+      actionpack (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.2)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-rails (3.5.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    shoulda-matchers (3.1.1)
+      activesupport (>= 4.0.0)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    sprockets (3.7.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.1.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.11)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.4)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ammeter (~> 1.1)
+  bundler (~> 1.12)
+  codeclimate-test-reporter (~> 0.6)
+  factory_girl_rails (~> 4.2)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  shoulda-matchers (~> 3.1)
+  simplecov (~> 0.12)
+  sqlite3 (~> 1.3)
+  transcript!
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009 NewAperio, LLC.
+
+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,174 @@
+# Transcript
+
+Simple ActiveRecord auditing.
+
+[![CircleCI](https://circleci.com/gh/newaperio/transcript.svg?style=svg)](https://circleci.com/gh/newaperio/transcript)
+[![Code Climate](https://codeclimate.com/github/newaperio/transcript/badges/gpa.svg)](https://codeclimate.com/github/newaperio/transcript)
+[![Test Coverage](https://codeclimate.com/github/newaperio/transcript/badges/coverage.svg)](https://codeclimate.com/github/newaperio/transcript/coverage)
+
+Transcript is a simple audit library. It provides a clean interface for recording changes to a given record, including metadata about the change itself. At its core, Transcript is simply a set of concerns that expose functionality in the controller to create the log and in the model to setup relationships between the data.
+
+Transcript differs from other auditing libraries in two ways. First, it values explicitness, exposing audit log creation near where the action takes place. Secondly, Transcript values simplicity. The core classes are only a few lines each.
+
+## Installation
+
+Transcript is a set of Rails concerns and generators. It's intended to be used with Rails 5.0+ and Ruby 1.9.3+. It currently only works with PostgreSQL.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'transcript'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Next, run the generator to install:
+
+```sh
+$ rails generate transcript:install NAME
+```
+
+This generates a Transcript model, which can be called anything, and an initializer, specifying some configuration.
+
+## Using Transcript
+
+### Models
+
+Transcript has notions of three types of models:
+
+- the actor, which is the object taking action;
+- the receiver, or the object that the actor is taking action on;
+- and the Transcript model, which records these actions.
+
+#### Actor
+
+An actor can be any individual model. Because this is configured as a polymorphic association, any number of individual models can be configured as actors. To add a new actor, include the concern in the model. For example, you might have a `User` model that you want to make an actor:
+
+```ruby
+class User < ActiveRecord::Base
+  include Transcript::Actor
+end
+```
+
+This interface sets up relationships to the log. To get a list of all the entries created by a particular actor, call the `audit_entries_by` relationship:
+
+```ruby
+@user.audit_entries_by # => [#<AuditEntry>, ...]
+```
+
+#### Receiver
+
+The receiver, similar to the actor, can be any individual model, and as many models as required. To add a new receiver, include the concern:
+
+```ruby
+class Post < ActiveRecord::Post
+  include Transcript::Receiver
+end
+```
+
+This will setup the relationships to get a list of the activities on a particular receiver:
+
+```ruby
+@post.audit_entries # => [#<AuditEntry>, ...]
+```
+
+Sometimes you may want to have a single model that is both an actor and a receiver. For example, you may want to track changes on your user model. You can do this by including both concerns:
+
+```ruby
+class User < ActiveRecord::Base
+  include Transcript::Actor
+  include Transcript::Receiver
+end
+```
+
+```ruby
+@user.audit_entries_by # => [#<AuditEntry>, ...]
+@user.audit_entries # => [#<AuditEntry>, ...]
+```
+
+#### Model
+
+The Transcript model is generated by the installer. The primary functionality is included as a concern to provide the most amount of flexibility. Since it's a module, you can override or extend the functionality in the model itself.
+
+The generator will give you something like this:
+
+```ruby
+class AuditEntry < ActiveRecord::Base
+  include Transcript::Model
+end
+```
+
+The concern also includes a convenience method to get the latest audit entry:
+
+```ruby
+@post.audit_entries.latest # => #<AuditEntry>
+```
+
+### Metadata
+
+Transcript tracks some metadata about the audit entry. It logs the receiver at the top of the entry to `receiver_serialized`. This is a JSONB column in PostgreSQL, which can be indexed and queried.
+
+### Controller
+
+The controller concern provides an easy controller helper to create the Transcript record. The installation generator should inject the concern automatically:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include Transcript::Controller
+end
+```
+
+Now, in any action, make a call to the helper. The method expects an object representing the actor and the object that is being acted upon. You can optionally pass a custom action name as a third argument as a string representing the verb (e.g. `create`, `delete`, or `export`). If no custom action is provided Transcript will infer from the controller action it's being called in.
+
+**Implied action:**
+```ruby
+def create
+  audit_action current_user, @comment
+  # ...
+end
+```
+
+**Custom action:**
+```ruby
+def send_password_reset
+  audit_action current_user, @user, "password_reset"
+  # ...
+end
+```
+
+## Known Issues
+
+### UUIDs
+
+If you use UUIDs as the primary key, you have to manually edit the migration before running it. This is a [known issue](https://github.com/rails/rails/issues/23422) with Rails migrations using `references` calls, which doesn't respect the configured primary key setting. Doing so would create something like this:
+
+```ruby
+class CreateAuditEntries < ActiveRecord::Migration[5.0]
+  def change
+    create_table :audit_entries do |t|
+      t.string :action
+      t.references :actor, polymorphic: true, type: :uuid
+      t.references :receiver, polymorphic: true, type: :uuid
+      t.jsonb :receiver_serialized
+
+      t.timestamps
+    end
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/newaperio/transcript. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+Transcript is copyright &copy; 2016 NewAperio. It is free software and may be redistributed under the terms specified in the [`LICENSE`](/LICENSE) file.
+
+## NewAperio
+
+Transcript was developed and is maintained by [NewAperio](http://newaperio.com), a web and mobile engineering firm based in Baton Rouge, LA.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Run tests"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "transcript"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circle.yml

@@ -0,0 +1,8 @@
+database:
+  override:
+    - bin/setup:
+        pwd:
+          spec/dummy
+test:
+  override:
+    - COVERAGE=true bundle exec rake spec

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/lib/generators/transcript/USAGE

@@ -0,0 +1,17 @@
+Description:
+  Installs Transcript. Creates a new audit model with the passed model name.
+  Creates a configuration file. Injects the Transcript concerns into
+  ApplicationController and the newly created model.
+
+Example:
+    rails generate transcript audit_entry
+
+    This will create:
+
+        Configuration: config/initializers/transcript.rb
+        Model:         app/models/audit_entry.rb
+
+    This will modify:
+
+        Controller:    app/controllers/application_controller.rb
+        Model:         app/models/audit_entry.rb

data/lib/generators/transcript/install_generator.rb

@@ -0,0 +1,33 @@
+require 'rails/generators'
+
+module Transcript
+  class InstallGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    def generate_model
+      invoke "active_record:model", [
+        name,
+        "action:string",
+        "actor:references{polymorphic}",
+        "receiver:references{polymorphic}",
+        "receiver_serialized:jsonb",
+      ]
+    end
+
+    def generate_configuration_initializer
+      template "transcript.rb.erb", "config/initializers/transcript.rb"
+    end
+
+    def add_model_concern
+      inject_into_class "app/models/#{file_path}.rb",
+        class_name,
+        "  include Transcript::Model\n\n"
+    end
+
+    def add_controller_concern
+      inject_into_class "app/controllers/application_controller.rb",
+        "ApplicationController",
+        "  include Transcript::Controller\n\n"
+    end
+  end
+end

data/lib/generators/transcript/templates/transcript.rb.erb

@@ -0,0 +1,3 @@
+Transcript.configure do |config|
+  config.audit_model = <%= class_name %>
+end

data/lib/transcript/actor.rb

@@ -0,0 +1,13 @@
+require "active_support/concern"
+
+module Transcript
+  module Actor
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :audit_entries_by,
+        as: :actor,
+        class_name: Transcript.configuration.audit_model
+    end
+  end
+end

data/lib/transcript/configuration.rb

@@ -0,0 +1,5 @@
+module Transcript
+  class Configuration
+    attr_accessor :audit_model
+  end
+end

data/lib/transcript/controller.rb

@@ -0,0 +1,11 @@
+require "active_support/concern"
+
+module Transcript
+  module Controller
+    extend ActiveSupport::Concern
+
+    def audit_action(actor, receiver, action = action_name)
+      Transcript::Job.perform_later(actor, receiver, action)
+    end
+  end
+end

data/lib/transcript/job.rb

@@ -0,0 +1,16 @@
+require "active_job"
+
+module Transcript
+  class Job < ActiveJob::Base
+    queue_as :default
+
+    def perform(actor, receiver, action)
+      Transcript.configuration.audit_model.create(
+        actor: actor,
+        action: action,
+        receiver: receiver,
+        receiver_serialized: receiver,
+      )
+    end
+  end
+end

data/lib/transcript/model.rb

@@ -0,0 +1,20 @@
+require "active_support/concern"
+
+module Transcript
+  module Model
+    extend ActiveSupport::Concern
+
+    included do
+      belongs_to :actor, polymorphic: true
+      belongs_to :receiver, polymorphic: true
+
+      validates :actor, presence: true
+    end
+
+    module ClassMethods
+      def latest
+        order('created_at DESC').first
+      end
+    end
+  end
+end

data/lib/transcript/receiver.rb

@@ -0,0 +1,11 @@
+require "active_support/concern"
+
+module Transcript
+  module Receiver
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :audit_entries, as: :receiver
+    end
+  end
+end

data/lib/transcript/version.rb

@@ -0,0 +1,3 @@
+module Transcript
+  VERSION = "0.1.0"
+end