pry-auditlog 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3ee50ac939176aede2e4955cd623aa70ea86ec6
-  data.tar.gz: af43359a9d894b87042f90f1360f88072b5800c7
+  metadata.gz: 035c74c0fdf31df8ae21d8bac8b19d845e7fc8d8
+  data.tar.gz: 0740c1a1c39bea29a3c6cf7f246c0f77c3d0fa9a
 SHA512:
-  metadata.gz: 6a5e2842283b10f2c17296f2c4738d7f9648807b077cee2ddc7e9c280a9d1e2b48ce1bef3918ccdf659fea1c59e74f50ba5ececb4ae9fe68188e145350a6ac59
-  data.tar.gz: 3c34344d5112ca2f2c0358a7c1f6e3fbcb5a6db34404e0d08e9bb2858cfcd3b16c2fd344b2761bf0335f323ac391dfa48af4a3031e61097a93c58ad1cf639ffb
+  metadata.gz: b75e8f845ca663f6924da9c05ff93f5bf464b533c29fdc472256b7081d9c7571dded1d2e2e798c9832f19c3c2f32671bbbd082d357509c597aad4cc327aec4c9
+  data.tar.gz: 609716ddfae232cc18e3b64eb97de38b155991c12e56d260220c5952744a9a928cab6bd7f9cfe6d02f1027558ea9a2de5bba4b79820d59a8d345167435fa48d6

data/.rubocop.yml

@@ -0,0 +1,23 @@
+MethodLength:
+  Max: 50
+
+LineLength:
+  Max: 160
+
+AbcSize:
+  Max: 75
+
+FileName:
+  Enabled: false
+
+PerceivedComplexity:
+  Enabled: false
+
+CyclomaticComplexity:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/CaseEquality:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+cache:
+  - bundler
+install:
+  - bundle install
+rvm:
+- 2.2.2
+script:
+  - bundle exec rake test

data/Gemfile

@@ -1,8 +1,3 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in pry-auditlog.gemspec
 gemspec
-
-group :development do
-  gem 'rubocop'
-end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Cozy Services Ltd.
+Copyright (c) 2014-2015 Matt Greensmith and Cozy Services Ltd.
 
 MIT License
 

data/README.md

@@ -1,5 +1,8 @@
 # PryAuditlog
 
+[![Build Status](https://travis-ci.org/mgreensmith/pry-auditlog.svg)](https://travis-ci.org/mgreensmith/pry-auditlog)
+[![Gem Version](https://badge.fury.io/rb/pry-auditlog.svg)](http://badge.fury.io/rb/pry-auditlog)
+
 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 modifies the `read` method of the REPL class 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. 
@@ -18,19 +21,21 @@ Set appropriate config values and then require the plugin in your `.pryrc` or an
 
 ```
 # The auditlog must be explicitly enabled
-Pry.config.auditlog_enabled = true         # default: false
+Pry.config.auditlog_enabled = true           # default: false
 
-# Optional path to audit log destination
-Pry.config.auditlog_file = '/path/to/file' # default: '/dev/null'
+# Path to audit log destination and optional file mode
+Pry.config.auditlog_file = '/path/to/file'   # default: '/dev/null'
+Pry.config.auditlog_file_mode = 0644         # default: 0600
 
 # We log both input and output by default
-Pry.config.auditlog_log_input = false    # default: true
-Pry.config.auditlog_log_output = false   # default: true
+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
+## Copyright
 
-Matt Greensmith for [Cozy](http://www.cozy.co)
+Copyright (c) 2014-2015 Matt Greensmith and Cozy Services Ltd. See [LICENSE.txt](LICENSE.txt) for
+further details.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+
+task default: %w(test)
+
+task :test do
+  sh 'rubocop'
+end

data/bin/example.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'pry'
+
+Pry.config.auditlog_enabled = true
+Pry.config.auditlog_file = '~/pry_audit.log'
+require 'pry-auditlog'
+
+Pry.start

data/lib/ext/pry/repl.rb

@@ -44,7 +44,7 @@ class Pry
 
       # send the prompt and log line to our logger.
       if Pry.config.auditlog_log_input
-        PryAuditlog::Logger.set_prompt(current_prompt)
+        PryAuditlog::Logger.prompt = current_prompt
         PryAuditlog::Logger.log('I', indented_val)
       end
 

data/lib/pry-auditlog.rb

@@ -3,6 +3,7 @@ require 'pry-auditlog/version'
 
 Pry.config.auditlog_enabled = false unless defined?(Pry.config.auditlog_enabled)
 Pry.config.auditlog_file = '/dev/null' unless defined?(Pry.config.auditlog_file)
+Pry.config.auditlog_file_mode = 0600 unless defined?(Pry.config.auditlog_file_mode)
 Pry.config.auditlog_log_input = true unless defined?(Pry.config.auditlog_log_input)
 Pry.config.auditlog_log_output = true unless defined?(Pry.config.auditlog_log_output)
 
@@ -17,14 +18,14 @@ if Pry.config.auditlog_enabled
 
     Pry.config.original_output = Pry.config.output
     Pry.config.output = PryAuditlog::Output.new
-    Pry.config.output._set_original_output(Pry.config.original_output)
+    Pry.config.output._original_output = Pry.config.original_output
   end
 
   local_hooks = Pry::Hooks.new
 
   local_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.session_token = Time.now.to_i
     PryAuditlog::Logger.log('AUDIT LOG', 'Pry session started')
   end
 

data/lib/pry-auditlog/logger.rb

@@ -1,29 +1,25 @@
 module PryAuditlog
   class Logger
-    @@current_prompt = ''
-    @@session_token = ''
-    begin
-      if Pry.config.auditlog_file
-        @@audit_file = File.open(Pry.config.auditlog_file, 'a', 0600).tap { |f| f.sync = true }
-      else
-        @@audit_file = false
-      end
-    rescue Errno::EACCES, Errno::ENOENT
-      @@audit_file = false
+    class << self
+      attr_accessor :audit_file, :prompt, :session_token
     end
 
-    def self.set_session_token(token)
-      @@session_token = token
-    end
+    @prompt = ''
+    @session_token = ''
 
-    def self.set_prompt(current_prompt)
-      @@current_prompt = current_prompt
+    begin
+      if Pry.config.auditlog_file
+        @audit_file = File.open(File.expand_path(Pry.config.auditlog_file), 'a', Pry.config.auditlog_file_mode).tap { |f| f.sync = true }
+      end
+    rescue Errno::EACCES, Errno::ENOENT => e
+      Pry.output.print "Failed to open audit log file, audit logging is disabled: #{e.message}\n"
+      @audit_file = nil
     end
 
     def self.log(type, line)
-      line = "#{@@current_prompt}#{line}" if type == 'I'
-      log_line = "[#{Time.now.to_s}][#{@@session_token}][#{type}] #{line}"
-      @@audit_file.puts log_line if @@audit_file && !line.strip.empty?
+      line = "#{@prompt}#{line}" if type == 'I'
+      log_line = "[#{Time.now}][#{@session_token}][#{type}] #{line}"
+      @audit_file.puts log_line if @audit_file && !line.strip.empty?
     end
   end
 end

data/lib/pry-auditlog/output.rb

@@ -1,14 +1,12 @@
 module PryAuditlog
   class Output < StringIO
-    def _set_original_output(orig)
-      @original_output = orig
-    end
+    attr_accessor :_original_output
 
     def print(line)
       PryAuditlog::Logger.log('O', line)
-      @original_output.print(line)
+      @_original_output.print(line)
     end
-    alias << print
-    alias write print
+    alias_method :<<, :print
+    alias_method :write, :print
   end
 end

data/lib/pry-auditlog/version.rb

@@ -1,3 +1,3 @@
 module PryAuditlog
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/pry-auditlog.gemspec

@@ -6,14 +6,18 @@ 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.authors       = ['Matt Greensmith', 'Cozy Services Ltd.']
+  spec.email         = ['matt@mattgreensmith.net', 'opensource@cozy.co']
+  spec.summary       = 'Adds audit log capability to Pry'
+  spec.description   = 'PryAuditlog is a plugin for the Pry REPL that enables logging of any combination of Pry input and output to a configured audit file.'
+  spec.homepage      = 'http://github.com/mgreensmith/pry-auditlog'
   spec.license       = 'MIT'
   spec.files         = `git ls-files -z`.split("\x0")
   spec.require_paths = ['lib']
 
   spec.add_dependency 'pry', '~> 0.10'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
 end

metadata

@@ -1,49 +1,96 @@
 --- !ruby/object:Gem::Specification
 name: pry-auditlog
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
-- Cozy Services Ltd.
 - Matt Greensmith
+- Cozy Services Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-07 00:00:00.000000000 Z
+date: 2015-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 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.
+  combination of Pry input and output to a configured audit file.
 email:
+- matt@mattgreensmith.net
 - opensource@cozy.co
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
+- Rakefile
+- bin/example.rb
 - lib/ext/pry/repl.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
+homepage: http://github.com/mgreensmith/pry-auditlog
 licenses:
 - MIT
 metadata: {}
@@ -53,17 +100,17 @@ 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: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Adds audit log capability to Pry