transcript 0.1.0

data/spec/spec_helper.rb

@@ -0,0 +1,53 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+if ENV.fetch("COVERAGE", false)
+  require "simplecov"
+
+  if ENV["CIRCLE_ARTIFACTS"]
+    dir = File.join(ENV["CIRCLE_ARTIFACTS"], "coverage")
+    SimpleCov.coverage_dir(dir)
+  end
+
+  if ENV['CODECLIMATE_REPO_TOKEN']
+    require 'codeclimate-test-reporter'
+    CodeClimate::TestReporter.start
+
+    SimpleCov.formatters = [
+      SimpleCov::Formatter::HTMLFormatter,
+      CodeClimate::TestReporter::Formatter
+    ]
+  end
+
+  SimpleCov.configure do
+    load_profile "test_frameworks"
+  end
+
+  SimpleCov.start
+end
+
+require 'transcript'
+
+ENV["RAILS_ENV"] = "test"
+require "rails/all"
+require "dummy/config/environment"
+
+require "shoulda-matchers"
+require "factory_girl_rails"
+
+Dir[File.expand_path("../support/**/*.rb", __FILE__)].sort.each do |file|
+  require_relative file
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+
+  config.order = :random
+end

data/spec/support/active_job.rb

@@ -0,0 +1 @@
+ActiveJob::Base.queue_adapter = :test

data/spec/support/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/support/factory_girl.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end

data/spec/support/shoulda.rb

@@ -0,0 +1,11 @@
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+    with.library :rails
+  end
+end
+
+RSpec.configure do |config|
+  config.include Shoulda::Matchers::ActiveModel, type: :model
+  config.include Shoulda::Matchers::ActiveRecord, type: :model
+end

data/spec/transcript/configuration_spec.rb

@@ -0,0 +1,7 @@
+RSpec.describe Transcript::Configuration do
+  it "accepts a custom audit model" do
+    Transcript.configure { |config| config.audit_model = AuditEntry }
+
+    expect(Transcript.configuration.audit_model).to eq AuditEntry
+  end
+end

data/spec/transcript/controller_spec.rb

@@ -0,0 +1,49 @@
+RSpec.describe Transcript::Controller, type: :controller do
+  controller ActionController::Base do
+    include Transcript::Controller
+
+    def edit
+      @user = FactoryGirl.create(:user)
+      @post = FactoryGirl.create(:post)
+      audit_action @user, @post
+
+      head :ok
+    end
+
+    def custom
+      @user = FactoryGirl.create(:user)
+      @post = FactoryGirl.create(:post)
+      audit_action @user, @post, "custom"
+
+      head :ok
+    end
+  end
+
+  it "creates an audit entry by inferring the action" do
+    ActiveJob::Base.queue_adapter.enqueued_jobs.clear
+    routes.draw { get "edit" => "anonymous#edit" }
+
+    get :edit
+
+    expect(Transcript::Job).to have_been_enqueued
+                           .with do |actor, receiver, action|
+      expect(actor).to be_a User
+      expect(receiver).to be_a Post
+      expect(action).to eq "edit"
+    end
+  end
+
+  it "creates an audit entry with a given action" do
+    ActiveJob::Base.queue_adapter.enqueued_jobs.clear
+    routes.draw { get "custom" => "anonymous#custom" }
+
+    get :custom
+
+    expect(Transcript::Job).to have_been_enqueued
+                           .with do |actor, receiver, action|
+      expect(actor).to be_a User
+      expect(receiver).to be_a Post
+      expect(action).to eq "custom"
+    end
+  end
+end

data/spec/transcript/job_spec.rb

@@ -0,0 +1,14 @@
+RSpec.describe Transcript::Job, type: :job do
+  it "queues in the default queue" do
+    expect(Transcript::Job.queue_name).to eq("default")
+  end
+
+  it "creates an audit entry for the given objects" do
+    user = create(:user)
+    post = create(:post)
+
+    expect {
+      Transcript::Job.perform_now(user, post, "edit")
+    }.to change(AuditEntry, :count).by(1)
+  end
+end

data/spec/transcript/transcript_spec.rb

@@ -0,0 +1,5 @@
+RSpec.describe Transcript do
+  it "has a version number" do
+    expect(Transcript::VERSION).not_to be nil
+  end
+end

data/spec/user_spec.rb

@@ -0,0 +1,17 @@
+RSpec.describe User, type: :model do
+  it "includes the model concern" do
+    expect(User.ancestors).to include Transcript::Actor
+  end
+
+  describe "audit_entries_by has_many" do
+    it { is_expected.to have_many(:audit_entries_by) }
+
+    it "returns audit entries for a specific model" do
+      user = create(:user)
+      entries = create_list(:audit_entry, 2, actor: user)
+      create_list(:audit_entry, 2)
+
+      expect(user.audit_entries_by).to match_array entries
+    end
+  end
+end

data/transcript.gemspec

@@ -0,0 +1,32 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'transcript/version'
+
+Gem::Specification.new do |spec|
+  spec.add_development_dependency "ammeter", "~> 1.1"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.6"
+  spec.add_development_dependency "factory_girl_rails", "~> 4.2"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "shoulda-matchers", "~> 3.1"
+  spec.add_development_dependency "simplecov", "~> 0.12"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_runtime_dependency "rails", "~> 5.0"
+  spec.authors = ["Logan Leger", "NewAperio"]
+  spec.description = <<-DESC
+Transcript is a simple audit library. It provides a clean interface for
+recording changes to a given record, including metadata about the change itself.
+  DESC
+  spec.email = ["logan@newaperio.com", "hello@newaperio.com"]
+  spec.files = `git ls-files -z`.split("\x0")
+                                .reject { |f| f.match(%r{^(spec)/}) }
+  spec.homepage = "https://github.com/newaperio/transcript"
+  spec.license = "MIT"
+  spec.name = "transcript"
+  spec.platform = Gem::Platform::RUBY
+  spec.required_ruby_version = ">= 1.9.3"
+  spec.require_paths = ["lib"]
+  spec.summary = "Simple ActiveRecord auditing."
+  spec.test_files = `git ls-files -- spec/*`.split("\n")
+  spec.version = Transcript::VERSION
+end

metadata

@@ -0,0 +1,383 @@
+--- !ruby/object:Gem::Specification
+name: transcript
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Logan Leger
+- NewAperio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ammeter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: |
+  Transcript is a simple audit library. It provides a clean interface for
+  recording changes to a given record, including metadata about the change itself.
+email:
+- logan@newaperio.com
+- hello@newaperio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- config.ru
+- lib/generators/transcript/USAGE
+- lib/generators/transcript/install_generator.rb
+- lib/generators/transcript/templates/transcript.rb.erb
+- lib/transcript.rb
+- lib/transcript/actor.rb
+- lib/transcript/configuration.rb
+- lib/transcript/controller.rb
+- lib/transcript/job.rb
+- lib/transcript/model.rb
+- lib/transcript/receiver.rb
+- lib/transcript/version.rb
+- spec/audit_entry_spec.rb
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/config/manifest.js
+- spec/dummy/app/assets/images/.keep
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/javascripts/cable.js
+- spec/dummy/app/assets/javascripts/channels/.keep
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/channels/application_cable/channel.rb
+- spec/dummy/app/channels/application_cable/connection.rb
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/concerns/.keep
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/jobs/application_job.rb
+- spec/dummy/app/mailers/application_mailer.rb
+- spec/dummy/app/models/application_record.rb
+- spec/dummy/app/models/audit_entry.rb
+- spec/dummy/app/models/concerns/.keep
+- spec/dummy/app/models/post.rb
+- spec/dummy/app/models/user.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/app/views/layouts/mailer.html.erb
+- spec/dummy/app/views/layouts/mailer.text.erb
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- spec/dummy/bin/update
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/cable.yml
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/application_controller_renderer.rb
+- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/new_framework_defaults.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/transcript.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/puma.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/config/secrets.yml
+- spec/dummy/config/spring.rb
+- spec/dummy/db/migrate/20160822202506_create_users.rb
+- spec/dummy/db/migrate/20160822202519_create_posts.rb
+- spec/dummy/db/migrate/20160823152659_create_audit_entries.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/lib/assets/.keep
+- spec/dummy/log/.keep
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/apple-touch-icon-precomposed.png
+- spec/dummy/public/apple-touch-icon.png
+- spec/dummy/public/favicon.ico
+- spec/dummy/test/factories/audit_entries.rb
+- spec/dummy/test/fixtures/audit_entries.yml
+- spec/dummy/test/fixtures/posts.yml
+- spec/dummy/test/fixtures/users.yml
+- spec/dummy/test/models/audit_entry_test.rb
+- spec/dummy/test/models/post_test.rb
+- spec/dummy/test/models/user_test.rb
+- spec/factories.rb
+- spec/generators/install_generator_spec.rb
+- spec/post_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_job.rb
+- spec/support/application_controller.rb
+- spec/support/factory_girl.rb
+- spec/support/shoulda.rb
+- spec/transcript/configuration_spec.rb
+- spec/transcript/controller_spec.rb
+- spec/transcript/job_spec.rb
+- spec/transcript/transcript_spec.rb
+- spec/user_spec.rb
+- transcript.gemspec
+homepage: https://github.com/newaperio/transcript
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Simple ActiveRecord auditing.
+test_files:
+- spec/audit_entry_spec.rb
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/config/manifest.js
+- spec/dummy/app/assets/images/.keep
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/javascripts/cable.js
+- spec/dummy/app/assets/javascripts/channels/.keep
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/channels/application_cable/channel.rb
+- spec/dummy/app/channels/application_cable/connection.rb
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/concerns/.keep
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/jobs/application_job.rb
+- spec/dummy/app/mailers/application_mailer.rb
+- spec/dummy/app/models/application_record.rb
+- spec/dummy/app/models/audit_entry.rb
+- spec/dummy/app/models/concerns/.keep
+- spec/dummy/app/models/post.rb
+- spec/dummy/app/models/user.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/app/views/layouts/mailer.html.erb
+- spec/dummy/app/views/layouts/mailer.text.erb
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- spec/dummy/bin/update
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/cable.yml
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/application_controller_renderer.rb
+- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/new_framework_defaults.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/transcript.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/puma.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/config/secrets.yml
+- spec/dummy/config/spring.rb
+- spec/dummy/db/migrate/20160822202506_create_users.rb
+- spec/dummy/db/migrate/20160822202519_create_posts.rb
+- spec/dummy/db/migrate/20160823152659_create_audit_entries.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/lib/assets/.keep
+- spec/dummy/log/.keep
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/apple-touch-icon-precomposed.png
+- spec/dummy/public/apple-touch-icon.png
+- spec/dummy/public/favicon.ico
+- spec/dummy/test/factories/audit_entries.rb
+- spec/dummy/test/fixtures/audit_entries.yml
+- spec/dummy/test/fixtures/posts.yml
+- spec/dummy/test/fixtures/users.yml
+- spec/dummy/test/models/audit_entry_test.rb
+- spec/dummy/test/models/post_test.rb
+- spec/dummy/test/models/user_test.rb
+- spec/factories.rb
+- spec/generators/install_generator_spec.rb
+- spec/post_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_job.rb
+- spec/support/application_controller.rb
+- spec/support/factory_girl.rb
+- spec/support/shoulda.rb
+- spec/transcript/configuration_spec.rb
+- spec/transcript/controller_spec.rb
+- spec/transcript/job_spec.rb
+- spec/transcript/transcript_spec.rb
+- spec/user_spec.rb