auditing-middleware 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df9d2a6b89d0e94494653788c85d7f44693a12f8
+  data.tar.gz: 721339db5d1a2ec9189601906ca63b6b4edd6201
+SHA512:
+  metadata.gz: 41138c25488d63a7e0172bc1d36be1d81bb5ad1a41b02f9d38a3b79070b2ef36a04fa97ea12dadb7795730c62f1906f4f2b3de1abe2c0a571415cab7316c32d3
+  data.tar.gz: c48f5065a9873bd563a9a3794c2f827e5551912dcf9456e7976b4369922573536d82b108154bec849f35f65acfb338c6f5960670b3e0e14d03aafd8f59bc89a2

data/.gitignore

@@ -0,0 +1,15 @@
+./prototype/.byebug_history
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 daneb
+
+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,61 @@
+# Auditing::Middleware
+Provides logging support to middleware.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'auditing_middleware'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install auditing_middleware
+
+## Dependencies
+* [SoarAspects](https://rubygems.org/gems/soar_aspects) - for loading auditor into environment variable
+* [SoarAuditorApi](https://rubygems.org/gems/soar_auditor_api) - support for 'some' Audit Provider
+
+## Usage
+
+Setting up an Audit Provider
+
+```ruby
+configuration = { "preprefix" => "very important:" }
+auditor = SanityAuditor.new
+auditor.configure(configuration)
+auditor.set_audit_level(:error)
+```
+
+Using Soar Aspect
+
+```ruby
+SoarAspects::Aspects::auditing = auditor
+```
+
+Add support to Rack Middleware
+
+```ruby
+def call(env)
+  @app.call(env)
+rescue => exception
+  Auditing::Middleware.error(exception)
+end 
+```
+
+## Contributing
+
+Please send feedback and comments to the author at:
+
+Dane-Garrin Balia <dane.balia@hetzner.co.za>
+
+This gem is sponsored by Hetzner (Pty) Ltd - http://hetzner.co.za
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/auditing-middleware.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'auditing/middleware/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "auditing-middleware"
+  spec.version       = Auditing::Middleware::VERSION
+  spec.authors       = ["daneb"]
+  spec.email         = ["dane.balia@hetzner.co.za"]
+  spec.summary       = %q{Logging trace events in Rack Middleware}
+  spec.homepage      = "https://github.com/hetznerZA/auditing_middleware"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.5", '>= 3.5.0'
+  spec.add_development_dependency "rack", "~> 1.6",  '>= 1.6.4'
+  spec.add_development_dependency "byebug", "~> 9.0", '>= 9.0.5'
+  spec.add_dependency "soar_aspects", "~> 0.1.2"
+  spec.add_dependency "soar_auditor_api", "~> 0.0.12"
+end

data/lib/auditing/middleware.rb

@@ -0,0 +1,46 @@
+require "auditing/middleware/version"
+require 'soar_aspects'
+
+module Auditing
+  module Middleware
+    class Error < StandardError; end
+
+    def self.error(ruby_error)
+      log_detail(ENV['RACK_ENV'], ruby_error, :error)
+    end
+
+    def self.info(ruby_error)
+      log_detail(ENV['RACK_ENV'], ruby_error, :info)
+    end
+
+    def self.warn(ruby_error)
+      log_detail(ENV['RACK_ENV'], ruby_error, :warn)
+    end
+
+    def self.debug(ruby_error)
+      log_detail(ENV['RACK_ENV'], ruby_error, :debug)
+    end
+
+    def self.fatal(ruby_error)
+      log_detail(ENV['RACK_ENV'], ruby_error, :fatal)
+    end
+
+    private
+    def self.log_detail(rack_env, ruby_error, audit_level)
+      if rack_env == 'development'
+        what_to_log = ruby_error.respond_to?(:backtrace) ? "#{ruby_error.message}  #{ruby_error.backtrace}" : ruby_error
+        log_to_location(what_to_log , audit_level)
+      else
+        log_to_location(ruby_error, audit_level)
+      end
+    rescue => exception
+      Error.new("Unexpected exception: #{exception}")
+    end
+
+    def self.log_to_location(what_to_log, audit_level)
+      auditor = SoarAspects::Aspects.auditing
+      return STDERR.puts what_to_log if auditor.nil?
+      auditor.send(audit_level, what_to_log)
+    end
+  end
+end

data/lib/auditing/middleware/version.rb

@@ -0,0 +1,5 @@
+module Auditing
+  module Middleware
+    VERSION = "0.0.3"
+  end
+end

data/prototype/auditor.rb

@@ -0,0 +1,11 @@
+require 'soar_auditor_api'
+
+class SanityAuditor < SoarAuditorApi::AuditorAPI
+  def configuration_is_valid?(configuration)
+    return configuration.include?("preprefix")
+  end
+
+  def audit(data)
+    puts @configuration["preprefix"] + data
+  end
+end

data/prototype/config.ru

@@ -0,0 +1,14 @@
+require 'rack/lobster'
+require 'soar_aspects'
+require './auditor'
+require './some_middleware'
+
+configuration = { "preprefix" => "very important:" }
+auditor = SanityAuditor.new
+auditor.configure(configuration)
+auditor.set_audit_level(:error)
+SoarAspects::Aspects::auditing = nil
+use SoarAspects::Aspects
+use Shrimp
+
+run Rack::Lobster.new 

data/prototype/some_middleware.rb

@@ -0,0 +1,33 @@
+require_relative '../lib/auditing/middleware.rb'
+
+class Shrimp
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    raise StandardError.new('What now! Kapow!')
+    @app.call(env)
+  rescue => exception
+    Auditing::Middleware.error(exception)
+  end
+end
+
+#   private
+#   def error(env, ruby_error)
+#     log_detail(env['RACK_ENV'], env['auditing'], ruby_error, :error)
+#   end
+
+#   def log_detail(rack_env, auditor, ruby_error, audit_level)
+#     if rack_env == 'development'
+#       log_to_location(auditor, "#{ruby_error.message}  #{ruby_error.backtrace}", audit_level)
+#     else
+#       log_to_location(auditor, ruby_error.message, audit_level)
+#     end
+#   end
+
+#   def log_to_location(auditor, message, audit_level)
+#     return STDERR.puts message if auditor.nil? 
+#     auditor.send(audit_level, message)
+#   end
+# end

data/spec/middleware_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+require 'soar_aspects'
+require './spec/support/auditor'
+require './lib/auditing/middleware'
+
+describe "Auditing Middleware" do
+  before :each do
+    Auditing::Middleware.send(:public, *Auditing::Middleware.private_instance_methods)
+
+    # Requirements to use
+    # 1. Auditor
+    configuration = { "preprefix" => "very important:" }
+    auditor = SanityAuditor.new
+    auditor.configure(configuration)
+    auditor.set_audit_level(:error)
+
+    # 2. Soar Aspects
+    SoarAspects::Aspects::auditing = auditor
+
+    # 3. Some Error Message or Standard Error
+    class TestError < StandardError; end
+    @error_message = 'Some error'
+    @error = TestError.new(@error_message)
+
+    # or
+    @string_error = 'This is a string message not an exception'
+
+    # or
+    @standard_error_message = 'Random Reason'
+    @standard_error = StandardError.new(@standard_error_message)
+  end
+
+  context "logging audit information" do
+    it 'should use an auditor if configured' do
+      exception = set_backtrace
+      expect(SoarAspects::Aspects::auditing).to receive(:error).with(exception)
+      Auditing::Middleware.error(exception)
+    end
+
+    it 'should print to STDERR if an auditor is not configured' do
+      SoarAspects::Aspects::auditing = nil
+      expect(STDERR).to receive(:puts).with(@error_message)
+      Auditing::Middleware.error(@error_message)
+    end
+
+    it 'should support Exceptions or plain string objects' do
+      SoarAspects::Aspects::auditing = nil
+      expect(STDERR).to receive(:puts).with(@string_error)
+      Auditing::Middleware.error(@string_error)
+    end
+
+    it 'should support error audit level' do
+      expect(Auditing::Middleware.respond_to?(:error)).to eq true
+    end
+
+    it 'should support info audit level' do
+      expect(Auditing::Middleware.respond_to?(:info)).to eq true
+    end
+
+    it 'should support info audit level' do
+      expect(Auditing::Middleware.respond_to?(:warn)).to eq true
+    end
+
+    it 'should support debug audit level' do
+      expect(Auditing::Middleware.respond_to?(:debug)).to eq true
+    end
+
+    it 'should support fatal audit level' do
+      expect(Auditing::Middleware.respond_to?(:debug)).to eq true
+    end
+
+  end
+
+  context "error handling" do
+    it 'should never raise an exception so as to interfere with middleware processing' do
+      allow(Auditing::Middleware).to receive(:log_to_location).and_raise(@standard_error)
+      expect{Auditing::Middleware.error(@error)}.to_not raise_error
+    end
+
+    it 'should return an error message' do
+      allow(Auditing::Middleware).to receive(:log_to_location).and_raise(@standard_error)
+      expect(Auditing::Middleware.error(@error).message).to eq("Unexpected exception: #{@standard_error_message}")
+    end
+  end
+end
+
+def set_backtrace
+  @error.set_backtrace(['This is a backtrace', 'Ruby rocks'])
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/auditor.rb

@@ -0,0 +1,11 @@
+require 'soar_auditor_api'
+
+class SanityAuditor < SoarAuditorApi::AuditorAPI
+  def configuration_is_valid?(configuration)
+    return configuration.include?("preprefix")
+  end
+
+  def audit(data)
+    puts @configuration["preprefix"] + data
+  end
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: auditing-middleware
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- daneb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.0.5
+- !ruby/object:Gem::Dependency
+  name: soar_aspects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: soar_auditor_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.12
+description: 
+email:
+- dane.balia@hetzner.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- auditing-middleware.gemspec
+- lib/auditing/middleware.rb
+- lib/auditing/middleware/version.rb
+- prototype/auditor.rb
+- prototype/config.ru
+- prototype/some_middleware.rb
+- spec/middleware_spec.rb
+- spec/spec_helper.rb
+- spec/support/auditor.rb
+homepage: https://github.com/hetznerZA/auditing_middleware
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Logging trace events in Rack Middleware
+test_files:
+- spec/middleware_spec.rb
+- spec/spec_helper.rb
+- spec/support/auditor.rb