time_streamer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6335822a9bf6fcbe463bc8e08d72a3ce9e70bf65d566174b275442e7eeec1fb9
+  data.tar.gz: df9b6a36be5b17b5c635ba761fd8112faa62c5f61b8862968200c239cbd3af1d
+SHA512:
+  metadata.gz: 589c4f9cea810ecb2cbd394053e263a14a1dbd72413541e1c4e7a8371f46603bb4920814b48372197cba6f8256394b7a341e899c65568318e0498a3460bcc4a3
+  data.tar.gz: 8d460f8bb6881c3fc35590c4e1d01fb0bafe286e4257e4f5ca07b1928e49e2e647c790c4ce73c130149dc772c48d562aeb1e9ee0f7f73677e694130097d759c0

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Matous Vokal
+
+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,63 @@
+# Time Streamer
+
+Explore the versions of your ActiveRecord models in the browser.
+
+The web interface allows you to view models at different points in time based on versions from an auditing system. It also allows for traversing associations. Works with [Audited](https://github.com/collectiveidea/audited) and [PaperTrail](https://github.com/paper-trail-gem/paper_trail) by default.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'time_streamer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install time_streamer
+
+## Usage
+
+Mount Time Streamer inside your application
+
+```ruby
+# routes.rb
+mount TimeStreamer::App, at: '/time_streamer'
+```
+
+Configure the gem to suit your needs. The following example shows the default configuration.
+
+```ruby
+# config/initializers/time_streamer.rb
+TimeStreamer.configure do |config|
+  config.adapter = TimeStreamer::Adapters::Audited.new
+  config.global_ignored_associations = []
+  config.ignored_associations = {}
+  config.mount_path = '/time_streamer'
+end
+```
+
+The two available adapters are `TimeStreamer::Adapters::Audited` and `TimeStreamer::Adapters::PaperTrail`.
+
+Ignore associations that should not be displayed. For example, the association containing the versions (`audits` for Audited and `versions` for PaperTrail) should probably be ignored.
+
+To ignore associations for specific models, set the `ignored_associations` hash.
+
+*IMPORTANT*: The associations have to be given as strings, not symbols!
+```ruby
+TimeStreamer.configure do |config|
+  config.global_ignored_associations = ['audits']
+  config.ignored_associations = {
+    'Customer' => ['product_ratings'],
+    'Order' => ['products', 'discounts']
+  }
+end
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "time_streamer"
+
+# 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(__FILE__)

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/lib/time_streamer.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'time_streamer/version'
+require 'time_streamer/app'
+require 'time_streamer/configuration'
+require 'time_streamer/version_view_model'
+require 'time_streamer/adapters/audited'
+require 'time_streamer/adapters/paper_trail'
+
+module TimeStreamer
+end

data/lib/time_streamer/adapters/audited.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module TimeStreamer
+  module Adapters
+    class Audited
+      def search_placeholder
+        'AuditableType#AuditableId'
+      end
+
+      def identifier_for(record)
+        "#{record.class}##{record&.id}"
+      end
+
+      def find_version(id)
+        ::Audited::Audit.find id
+      end
+
+      def find_versions_by_search_term(search_term)
+        auditable_type, auditable_id = search_term.split '#', 2
+        ::Audited::Audit.where(auditable_type: auditable_type, auditable_id: auditable_id)
+                        .order version: :desc
+      end
+
+      def record_at_version(version)
+        version.revision
+      end
+
+      def current_record_from_version(version)
+        version.auditable
+      end
+
+      def versions_of_record(record)
+        record.audits.reorder version: :desc
+      end
+
+      def version_data(version)
+        {
+          id: version.id.to_s,
+          title: "#{version.created_at.strftime '%-d. %-m. %Y %H:%M:%S'} - #{version.action}",
+          metadata: "Request UUID: #{version.request_uuid}",
+          changes: version.audited_changes
+        }
+      end
+    end
+  end
+end

data/lib/time_streamer/adapters/paper_trail.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module TimeStreamer
+  module Adapters
+    class PaperTrail
+      def search_placeholder
+        'ItemType#ItemId'
+      end
+
+      def identifier_for(record)
+        "#{record.class}##{record&.id}"
+      end
+
+      def find_version(id)
+        ::PaperTrail::Version.find id
+      end
+
+      def find_versions_by_search_term(search_term)
+        item_type, item_id = search_term.split '#', 2
+        ::PaperTrail::Version.includes(:item)
+                             .where(item_type: item_type, item_id: item_id)
+                             .order created_at: :desc
+      end
+
+      def record_at_version(version)
+        version.item.paper_trail.version_at version.created_at
+      end
+
+      def current_record_from_version(version)
+        version.item
+      end
+
+      def versions_of_record(record)
+        record.versions.reorder created_at: :desc
+      end
+
+      def version_data(version)
+        {
+          id: version.id.to_s,
+          title: "#{version.created_at.strftime '%-d. %-m. %Y %H:%M:%S'} - #{version.event}",
+          metadata: "Request UUID: #{version.whodunnit}",
+          changes: version.changeset
+        }
+      end
+    end
+  end
+end

data/lib/time_streamer/app.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'sinatra/base'
+
+module TimeStreamer
+  class App < Sinatra::Base
+    get '/' do
+      puts params
+      @search_placeholder = adapter.search_placeholder
+      @search_term = params[:search_term].to_s
+      versions = adapter.find_versions_by_search_term @search_term
+      @record = adapter.current_record_from_version(versions.first) if versions.any?
+      @associations = associations_for @record
+      @header = "#{adapter.identifier_for @record} - latest version"
+      @versions = versions_to_view_models versions
+      erb :index
+    end
+
+    get '/version/:id' do
+      @search_placeholder = adapter.search_placeholder
+      version = adapter.find_version params[:id]
+      @record = adapter.record_at_version version
+      @versions = versions_to_view_models adapter.versions_of_record(@record)
+      @search_term = adapter.identifier_for @record
+      @associations = associations_for @record
+      @header = "#{adapter.identifier_for @record} - at #{format_time version.created_at}"
+      erb :index
+    end
+
+    ###
+
+    def associations_for(parent)
+      return if parent.nil?
+
+      associations = load_associations parent
+      associations.transform_values! do |value|
+        Array(value).map { |record| adapter.identifier_for(record) }
+      end
+      associations.reject { |_, value| value.empty? }
+    end
+
+    def load_associations(record)
+      associations = record.class.reflections.keys - ignored_associations(record.class)
+      associations.map { |key| [key, record.send(key)] }.to_h
+    end
+
+    def format_time(time)
+      time.strftime '%Y-%m-%d %H:%M:%S'
+    end
+
+    def versions_to_view_models(versions)
+      versions.map { |version| VersionViewModel.new adapter.version_data(version) }
+    end
+
+    def adapter
+      TimeStreamer.configuration.adapter
+    end
+
+    def ignored_associations(model_class)
+      global = TimeStreamer.configuration.global_ignored_associations
+      specific = TimeStreamer.configuration.ignored_associations.fetch(model_class.to_s) { [] }
+      global | specific
+    end
+
+    def mount_path
+      TimeStreamer.configuration.mount_path
+    end
+  end
+end

data/lib/time_streamer/configuration.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module TimeStreamer
+  CONFIGURABLE_VALUES = %i[
+    adapter
+    global_ignored_associations
+    ignored_associations
+    mount_path
+  ].freeze
+
+  Configuration = Struct.new(*CONFIGURABLE_VALUES, keyword_init: true)
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new(
+      adapter: Adapters::Audited.new,
+      global_ignored_associations: [],
+      ignored_associations: {},
+      mount_path: '/time_streamer'
+    )
+  end
+end

data/lib/time_streamer/public/time_streamer.css

@@ -0,0 +1,59 @@
+html, table {
+  font-size: 14px;
+}
+
+.red-text {
+  color: #e53935;
+}
+
+.grey-text {
+  color: #757575;
+}
+
+.versions {
+  margin-top: 2rem;
+  padding: 1rem;
+  background-color: #f5f5f5;
+}
+
+.version-card {
+  margin-bottom: 2rem;
+}
+
+.version-title, .version-meta {
+  display: inline-block;
+  margin: 1rem 1rem 1rem 0;
+  font-size: 16px;
+  font-weight: 500;
+}
+
+.version-meta {
+  color: #757575;
+}
+
+.link-btn {
+  display: inline-block;
+  background-color: #1e88e5;
+  color: white;
+  margin: 0 0.02rem 0.2rem 0;
+  padding: 0.4rem 1rem;
+  border-radius: 4px;
+  text-decoration: none;
+}
+
+.link-btn:hover {
+  background-color: #01579b;
+}
+
+table {
+  margin-bottom: 1rem;
+  background-color: #fff;
+}
+
+table, th, td {
+  border: 1px solid #bdbdbd;
+}
+
+table > tbody > tr > td {
+  padding: 0.5rem;
+}

data/lib/time_streamer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TimeStreamer
+  VERSION = '0.0.1'
+end

data/lib/time_streamer/version_view_model.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TimeStreamer
+  class VersionViewModel
+    attr_reader :id, :title, :metadata, :changes
+
+    def initialize(id:, title:, metadata:, changes:)
+      @id = id
+      @title = title
+      @metadata = metadata
+      @changes = changes
+    end
+  end
+end

data/lib/time_streamer/views/attributes.erb

@@ -0,0 +1,29 @@
+<table>
+  <tbody>
+  <% attributes.each do |key, value| %>
+    <tr>
+      <td>
+        <%= key %>
+      </td>
+      <% if value.is_a?(Array) && value.size == 2 %>
+        <td>
+          <%= value.first.inspect %>
+        </td>
+        <td>
+          <span class='grey-text'>
+            =>
+          </span>
+        </td>
+        <td>
+          <%= value.last.inspect %>
+        </td>
+      <% else %>
+        <td>
+          <%= value.inspect %>
+        </td>
+      <% end %>
+      </td>
+    </tr>
+  <% end %>
+  </tbody>
+</table>

data/lib/time_streamer/views/index.erb

@@ -0,0 +1,44 @@
+<html>
+  <head>
+    <link rel='stylesheet' href='<%= mount_path %>/time_streamer.css'>
+  </head>
+  <body>
+    <form action='<%= mount_path %>' method='get'>
+      <input type='text' name='search_term' placeholder='<%= @search_placeholder %>'>
+      <input type='submit' value='Find history'>
+    </form>
+
+    <% unless @record.nil? %>
+      <h1>
+        <%= @header %>
+      </h1>
+      <%= erb :attributes, locals: { attributes: @record.serializable_hash } %>
+      <div class='red-text'>
+        Only associations with ids stored in this record reflect the selected version
+      </div>
+      <% @associations.each do |name, associated_records| %>
+      <p>
+        <%= name %>:
+      </p>
+      <% associated_records.each do |associated_record| %>
+      <a href='<%= mount_path %>?search_term=<%= CGI.escape(associated_record) %>' class="link-btn">
+        <%= associated_record %>
+      </a>
+      <% end %>
+      <% end %>
+    <% end %>
+
+    <div class='versions'>
+      <% @versions.each do |version| %>
+      <div class='version-card'>
+        <span class="version-title"><%= version.title %></span>
+        <span class="version-meta">[ <%= version.metadata %> ]</span>
+        <%= erb :attributes, locals: { attributes: version.changes } %>
+        <a href='<%= mount_path %>/version/<%= CGI.escape(version.id) %>' class="link-btn">
+          Show record at version
+        </a>
+      </div>
+      <% end %>
+    </div>
+  </body>
+</html>

data/time_streamer.gemspec

@@ -0,0 +1,39 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "time_streamer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "time_streamer"
+  spec.version       = TimeStreamer::VERSION
+  spec.authors       = ["Matous Vokal"]
+  spec.email         = ["vokalmat@gmail.com"]
+
+  spec.summary       = "Web interface for audits in Rails applications"
+  spec.description   = "Explore the versions of your ActiveRecord models in the browser."
+  spec.homepage      = "https://github.com/Sorc96/time_streamer"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/Sorc96/time_streamer"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "sinatra"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: time_streamer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matous Vokal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Explore the versions of your ActiveRecord models in the browser.
+email:
+- vokalmat@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/setup
+- lib/time_streamer.rb
+- lib/time_streamer/adapters/audited.rb
+- lib/time_streamer/adapters/paper_trail.rb
+- lib/time_streamer/app.rb
+- lib/time_streamer/configuration.rb
+- lib/time_streamer/public/time_streamer.css
+- lib/time_streamer/version.rb
+- lib/time_streamer/version_view_model.rb
+- lib/time_streamer/views/attributes.erb
+- lib/time_streamer/views/index.erb
+- time_streamer.gemspec
+homepage: https://github.com/Sorc96/time_streamer
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Sorc96/time_streamer
+  source_code_uri: https://github.com/Sorc96/time_streamer
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Web interface for audits in Rails applications
+test_files: []