pry-auditlog 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Cozy Services Ltd.
+
+MIT License
+
+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,36 @@
+# PryAuditlog
+
+PryAuditlog is a plugin for the [Pry](http://pry.github.com) REPL that enables logging of any combination of Pry input and output to a configured audit log file.
+
+It scrapes the Pry history sender to read input statements to Pry, and it inserts itself into the `output` mechanism to scrape a copy of all emitted data. It also redirects `$stdout` and `$stderr` during the Pry session in order to capture all output emitted from any `puts` or similar statements. 
+
+All output data is forwarded to the original configured `Pry.config.output` mechanism after logging, and this plugin should (hopefully) respect any configured outputter.
+
+The log file location is configurable, and the choice of logging input statements, output statements or both (the default) is configurable.
+
+## Installation
+
+    $ gem install pry-auditlog
+
+## Usage
+
+Set appropriate config values and then require the plugin in your `.pryrc` or any other location where you configure Pry.
+
+```
+# The auditlog must be explicitly enabled
+Pry.config.auditlog_enabled = true         # default: false
+
+# Optional path to audit log destination
+Pry.config.auditlog_file = '/path/to/file' # default: "~/.pry_auditlog"
+
+# We log both input and output by default
+Pry.config.auditlog_log_input = false    # default: true
+Pry.config.auditlog_log_output = false   # default: true
+
+# Set all config values *before* requiring the plugin
+require 'pry-auditlog'
+```
+
+### Author
+
+Matt Greensmith for [Cozy](http://www.cozy.co)

data/lib/ext/pry/history.rb

@@ -0,0 +1,30 @@
+class Pry
+  class History
+    
+    #attr_accessor :original_pusher
+
+    # we monkeypatch 'load' to 
+    # 1. Overwrite @pusher with our own audit_and_push method
+    # 2. ensure that we don't write the entire history into the audit log on load.
+    def load
+      @original_pusher ||= @pusher
+      @pusher = method(:audit_and_push) if Pry.config.auditlog_enabled
+      @loader.call do |line|
+        if Pry.config.auditlog_enabled
+          @original_pusher.call(line.chomp)
+        else
+          @pusher.call(line.chomp)
+        end
+        @history << line.chomp
+      end
+      @saved_lines = @original_lines = @history.length
+    end
+
+    # new method
+    def audit_and_push(line)
+      PryAuditlog::Logger.log("I", line)
+      @original_pusher.call(line)
+    end
+
+  end
+end

data/lib/ext/pry/pry_instance.rb

@@ -0,0 +1,11 @@
+class Pry
+  # we monkeypatch retrieve_line to send the current prompt string to the logger
+
+  alias original_retrieve_line retrieve_line
+
+  def retrieve_line(eval_string, target)
+    current_prompt = select_prompt(eval_string, target)
+    PryAuditlog::Logger.set_prompt(current_prompt)
+    original_retrieve_line(eval_string, target)
+  end
+end

data/lib/pry-auditlog.rb

@@ -0,0 +1,38 @@
+require 'pry'
+require 'pry-auditlog/version'
+require 'pry-auditlog/logger'
+require 'pry-auditlog/output'
+
+
+Pry.config.auditlog_enabled ||= false
+Pry.config.auditlog_file ||= "~/.pry_auditlog"
+Pry.config.auditlog_log_input ||= true
+Pry.config.auditlog_log_output ||= true
+
+if Pry.config.auditlog_enabled
+  if Pry.config.auditlog_log_input
+    require 'ext/pry/history'
+    require 'ext/pry/pry_instance'
+  end
+
+  if Pry.config.auditlog_log_output
+    Pry.config._orig_stdout = $stdout
+    Pry.config._orig_stderr = $stderr
+
+    original_output = Pry.config.output
+    Pry.config.output = PryAuditlog::Output.new
+    Pry.config.output._set_original_output(original_output)
+  end
+
+  Pry.config.hooks.add_hook(:before_session, :prepare_auditlog) do
+    $stdout = $stderr = Pry.config.output if Pry.config.auditlog_log_output
+    PryAuditlog::Logger.set_session_token(Time.now.to_i)
+    PryAuditlog::Logger.log("AUDIT LOG", "Pry session started")
+  end
+
+  Pry.config.hooks.add_hook(:after_session, :unhijack_stdout) do
+    $stdout = Pry.config._orig_stdout
+    $stderr = Pry.config._orig_stderr
+    PryAuditlog::Logger.log("AUDIT LOG", "Pry session ended")
+  end
+end

data/lib/pry-auditlog/logger.rb

@@ -0,0 +1,26 @@
+module PryAuditlog
+  class Logger
+    begin
+      @@audit_file = File.open(Pry.config.auditlog_file, 'a', 0600).tap { |f| f.sync = true }
+    rescue Errno::EACCES
+      @@audit_file = false
+    end
+
+    def self.set_session_token(token)
+      @@session_token = token
+    end
+
+    def self.set_prompt(current_prompt)
+      @@current_prompt = current_prompt
+    end
+
+    def self.log(type, line)
+      if type == 'I'
+        line = "#{@@current_prompt}#{line}"
+      end
+      log_line = "[#{Time.now.to_s}][#{@@session_token}][#{type}] #{line}"
+      @@audit_file.puts log_line if @@audit_file
+    end
+
+  end
+end

data/lib/pry-auditlog/output.rb

@@ -0,0 +1,13 @@
+module PryAuditlog
+  class Output < StringIO
+
+    def _set_original_output(orig)
+      @original_output = orig
+    end
+
+    def puts(line)
+      PryAuditlog::Logger.log("O", line)
+      @original_output.puts(line)
+    end
+  end
+end

data/lib/pry-auditlog/version.rb

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

data/pry-auditlog.gemspec

@@ -0,0 +1,19 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pry-auditlog/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pry-auditlog"
+  spec.version       = PryAuditlog::VERSION
+  spec.authors       = ["Cozy Services Ltd.", "Matt Greensmith"]
+  spec.email         = ["opensource@cozy.co"]
+  spec.summary       = %q{Adds audit log capability to Pry}
+  spec.description   = %q{PryAuditlog is a plugin for the Pry REPL that enables logging of any combination of Pry input and output to a configured audit log file.}
+  spec.homepage      = "http://github.com/cozyco/pry-auditlog"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'pry', '~> 0.9'
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: pry-auditlog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Cozy Services Ltd.
+- Matt Greensmith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: PryAuditlog is a plugin for the Pry REPL that enables logging of any
+  combination of Pry input and output to a configured audit log file.
+email:
+- opensource@cozy.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/ext/pry/history.rb
+- lib/ext/pry/pry_instance.rb
+- lib/pry-auditlog.rb
+- lib/pry-auditlog/logger.rb
+- lib/pry-auditlog/output.rb
+- lib/pry-auditlog/version.rb
+- pry-auditlog.gemspec
+homepage: http://github.com/cozyco/pry-auditlog
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Adds audit log capability to Pry
+test_files: []