console_detective 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ef9da06b2847ed04dd93462272f647bf51ce89af78693a975234f8cb3ae011d8
+  data.tar.gz: ae806be239601ccc221519bb1b787d21341975736f739a0061296c437e130f57
+SHA512:
+  metadata.gz: 7d63f6471350aa8b5d46bf53186eda1e98a5167c2f4772ba10f816a2ee1a90b182fd6632cea1bb77fb443f575bb6f43fbfdedacec76e58f6732a14f82777ebb9
+  data.tar.gz: 2c317ba8cc2603119f26ba809036248d7bbfa5959f02b82fcc3c5af4263c66b06acce7045b364fe84c6e8f5efeff9777443bcd0017483bf08fd2dda2ebc9cf9f

data/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: Console Detective
+
+on: [push, pull_request]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0', head, truffleruby, truffleruby-head]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+      # uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - run: mkdir -p log/ tmp/ coverage/
+    - name: Run tests
+      run: bundle exec rake
+    - name: Upload Code Coverage
+      env: # Or as an environment variable
+        CODACY_PROJECT_TOKEN: ${{ secrets.CODACY_PROJECT_TOKEN }}
+      run: bash <(curl -Ls https://coverage.codacy.com/get.sh) report -r coverage/lcov.info

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/log/
+
+# rspec failure tracking
+.rspec_status
+.byebug_history

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in console_detective.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+
+gem 'byebug'
+gem 'pry'
+
+gem 'simplecov', require: false
+gem 'simplecov-lcov', require: false

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    console_detective (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    method_source (1.0.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov-lcov (0.8.0)
+    simplecov_json_formatter (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  console_detective!
+  pry
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  simplecov
+  simplecov-lcov
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 ArunkumarN
+
+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,69 @@
+# ConsoleDetective ![Console Detective](https://github.com/arunn/console_detective/actions/workflows/ci.yml/badge.svg)[![Codacy Badge](https://app.codacy.com/project/badge/Grade/7fabacab5ff445248655e1b9b35f1aef)](https://www.codacy.com?utm_source=github.com&utm_medium=referral&utm_content=arunn/console_detective&utm_campaign=Badge_Grade)[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/7fabacab5ff445248655e1b9b35f1aef)](https://www.codacy.com?utm_source=github.com&utm_medium=referral&utm_content=arunn/console_detective&utm_campaign=Badge_Coverage)[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/arunn/console_detective/graphs/commit-activity)
+
+A gem to track commands typed in rails console along with tagging in realtime. The tags can be used to identify users. This works with plain [pry](https://github.com/pry/pry) and [IRB](https://github.com/ruby/ruby/tree/master/lib/irb) and rails console using pry or IRB. The values for log tags, log format, log file name, and memoization requirements are configurable. 
+
+Pry and IRB both provide options for recordng history. It has a few disadvantages:
+
+1. It is not possible to get the logs in realtime.
+2. There are no tagging options available.
+3. There is no way to know the time when the command was fired. 
+4. If we're connecting to console using ssh, the logs will be lost if the connection is disconnected since the logs are only written only when we exit the session. 
+
+`console_detective` overcomes such disadvantages.
+## Installation
+
+Add this line to your application's Gemfile:
+
+~~~~~ruby
+gem 'console_detective'
+~~~~~
+
+And then execute:
+
+~~~~~sh
+$ bundle install
+~~~~~
+
+Or install it yourself as:
+~~~~~sh
+$ gem install console_detective
+~~~~~
+## Usage
+
+There are meaningful defaults for the config. If you are using rails, run `rails console`. Otherwise, `irb -rconsole_detective` or `pry -I./lib -r console_detective` will load the respective consoles with `console_detective` loaded.
+
+The configs can be overridden by creating a file named `console_detective.rb` with following code.
+
+~~~ruby
+require 'console_detective'
+
+ConsoleDetective.setup do |config|
+  # log_file_name is a string/file that mentions the location and name of the file where log will be written.
+  # default value is log/console.log
+  config.log_file_name      = "log/console.log"
+
+  # log_tags is a lambda outputting the tag to tag the log entry
+  # default value is the ENV['USER']
+  config.log_tags           = -> { ENV['USER'] }
+
+  # log_format is a lambda which takes tag and command as input and outputs the format in which the log will be entered in the log file
+  # default format is a hash of format { :tag => <tag>, :command => <command> }
+  config.log_format         = -> (tag, command) { { tag: tag, command: command } }
+  
+  # tag_memoization is a boolean to mention if the tag should be memoized or not.
+  # default is true
+  config.tag_memoization    = true
+end
+~~~
+
+If you are using rails, place this file in `config/initializers` folder and run `rails console`. Otherwise, `irb -r ./console_detective.rb` or `pry -r ./console_detective.rb` will load the respective consoles with `console_detective` loaded with modified config.
+
+## 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. `bin/console` will run in IRB whereas `PRY=true bin/console` will run with Pry. 
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/arunn/console_detective.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require 'byebug'
+# 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!)
+
+if(ENV['PRY'] == 'true')
+  require "pry"
+  require "console_detective" # Loading after loading irb/pry since we want those to be present when loading console_detective
+
+  Pry.start
+else
+  require "irb"
+  require "console_detective" # Loading after loading irb/pry since we want those to be present when loading console_detective
+
+  IRB.start(__FILE__)
+end

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/console_detective.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/console_detective/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "console_detective"
+  spec.version       = ConsoleDetective::VERSION
+  spec.authors       = ["ArunkumarN"]
+  spec.email         = ["arunn@arunn.dev"]
+  spec.licenses      = ["MIT"]
+
+  spec.summary       = %q{Track rails console user activity in real time}
+  spec.description   = %q{Commands typed in rails console will be tracked realtime in a log file in the given format}
+  spec.homepage      = "https://github.com/arunn/console_detective"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/arunn/console_detective"
+  spec.metadata["changelog_uri"] = "https://github.com/arunn/console_detective/CHANGELOG.md"
+
+  # 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.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/console_detective.rb

@@ -0,0 +1,30 @@
+require "console_detective/version"
+require "console_detective/mod_attr_accessor"
+
+module ConsoleDetective
+  extend ConsoleDetective::ModAttrAccessor
+
+  def self.setup
+    yield self
+  end
+
+  # log_file_name is a string/file that mentions the location and name of the file where log will be written.
+  # default value is log/console.log
+  mod_attr_accessor :log_file_name, "log/console.log"
+
+  # log_tags is a lambda outputting the tag to tag the log entry
+  # default value is the ENV['USER']
+  mod_attr_accessor :log_tags, -> { ENV['USER'] }
+
+  # log_format is a lambda which takes tag and command as input and outputs the format in which the log will be entered in the log file
+  # default format is a hash of format { :tag => <tag>, :command => <command> }
+  mod_attr_accessor :log_format, -> (tag, command) { { tag: tag, command: command } }
+  
+  # tag_memoization is a boolean to mention if the tag should be memoized or not.
+  # default is true
+  mod_attr_accessor :tag_memoization, true
+end
+
+require 'console_detective/utils'
+require 'console_detective/irb'
+require 'console_detective/pry'

data/lib/console_detective/irb.rb

@@ -0,0 +1,10 @@
+module ConsoleDetective
+  module IrbLogger
+    def evaluate(*args)
+      ConsoleDetective::Utils.log_command(args.first.chomp)
+      super(*args)
+    end
+  end
+end
+
+IRB::Context.prepend(ConsoleDetective::IrbLogger) if defined?(IRB::Context)

data/lib/console_detective/mod_attr_accessor.rb

@@ -0,0 +1,22 @@
+# Inspired and simplified from ActiveSupport's defintion of mattr_accessor
+# https://github.com/rails/rails/blob/5db5de534106a44070374810a99853f38843b1d2/activesupport/lib/active_support/core_ext/module/attribute_accessors.rb
+
+module ConsoleDetective
+  module ModAttrAccessor
+    def mod_attr_accessor(attr_name, default_value)
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        @@#{attr_name} = nil unless defined? @@#{attr_name}
+
+        def self.#{attr_name}
+          @@#{attr_name}
+        end
+
+        def self.#{attr_name}=(obj)
+          @@#{attr_name} = obj
+        end
+      EOS
+
+      send("#{attr_name}=", default_value) unless default_value.nil?
+    end
+  end
+end

data/lib/console_detective/pry.rb

@@ -0,0 +1,9 @@
+if defined?(Pry)
+  Pry.hooks.add_hook(:before_eval, "log_before_eval") do |command, _pry|
+    ConsoleDetective::Utils.log_command(command.chomp)
+  end
+
+  Pry.hooks.add_hook(:after_session, "log_after_session") do |_output, _binding, _pry|
+    ConsoleDetective::Utils.log_command("exit", immediately: true)
+  end
+end

data/lib/console_detective/utils.rb

@@ -0,0 +1,21 @@
+require 'logger'
+
+module ConsoleDetective
+  module Utils
+    LOGGER_PROC = ->(command) { ConsoleDetective::Utils.logger.info(ConsoleDetective.log_format.call(ConsoleDetective::Utils.get_tag, command)) }
+
+    def self.logger
+      @logger ||= Logger.new(ConsoleDetective.log_file_name)
+    end
+
+    def self.get_tag
+      return @tag if ConsoleDetective.tag_memoization && @tag
+      @tag = ConsoleDetective.log_tags.call
+    end
+
+    def self.log_command(command, immediately: false)
+      return Thread.new { ConsoleDetective::Utils::LOGGER_PROC.call(command) } unless immediately
+      ConsoleDetective::Utils::LOGGER_PROC.call(command)
+    end
+  end
+end

data/lib/console_detective/version.rb

@@ -0,0 +1,3 @@
+module ConsoleDetective
+  VERSION = "0.1.1".freeze
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: console_detective
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- ArunkumarN
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-07-25 00:00:00.000000000 Z
+dependencies: []
+description: Commands typed in rails console will be tracked realtime in a log file
+  in the given format
+email:
+- arunn@arunn.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- console_detective.gemspec
+- lib/console_detective.rb
+- lib/console_detective/irb.rb
+- lib/console_detective/mod_attr_accessor.rb
+- lib/console_detective/pry.rb
+- lib/console_detective/utils.rb
+- lib/console_detective/version.rb
+homepage: https://github.com/arunn/console_detective
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/arunn/console_detective
+  source_code_uri: https://github.com/arunn/console_detective
+  changelog_uri: https://github.com/arunn/console_detective/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Track rails console user activity in real time
+test_files: []