soar_auditing_format 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5808f4570485d4eb876c38c01ef85919d245ade0
-  data.tar.gz: b5e6d3f4da4a01ce2ccaceedbcd53adb3f24ca6d
+  metadata.gz: 63b94935c99264de5ac0f5a9fb0b88ce2f1718b4
+  data.tar.gz: 7397a4fff409fa113cfd28b2e7a3a5288921bf58
 SHA512:
-  metadata.gz: cc049109e2d3c27e12b82d23b1469d26a6d2863e06b9a96fd7c075af0e5dbd02c8ac96677f679bfc08bfcf2afddd580bd965e5df7dc1aff8b50267c92846b1fc
-  data.tar.gz: d06b0caf51d6cca33223456d82c1a522b960bb7b25b877b56f54b5a5478732ff50e202f0e86288fc928cc66a6fe01ebba6e39fd2f39edb6e82545e3ca40a2b3d
+  metadata.gz: 20f98f028dc46a3dcc30d774810a06cd4c4c46776b764b1bd940fe79c992e3575b96046578e3639e5f494bc74e669f360ea15b1fa55052898dd2a802519c8223
+  data.tar.gz: 7b596173ba504e477b029af241326eab01920e5489b3499e3ae82f1cc67b6547f01751a22c49fdc0689911393ca76ea86d384310b94f69aa33b9a173c40851e8

data/README.md

@@ -1,15 +1,6 @@
 # SoarAuditingFormatter
 
-This gem provides the formatting for auditing
-
-#TODO complete file
-
-## State of the API
-
-This API is still a work in progress but should be sufficient for most auditors
-
-Future work:
-* The API should support the reformating of timestamps to a standardized ISO8601 format.
+This gem provides the formatting of audit entries for auditing purposes.
 
 ## Installation
 
@@ -35,70 +26,16 @@ Behavioural driven testing can be performed:
 
 ## Usage
 
-### Auditors that extend from the AuditorAPI
-
-Extend from the AuditorAPI as follow
-
-``` ruby
-class MyAuditor < SoarAuditingFormatter::AuditorAPI
-end
-```
-
-It is required that the auditors that extend from this API implement two methods: "audit" and "configuration_is_valid". The API will call these methods using inversion of control as follow:
-
-The configuration_is_valid method provides the API with a way of ensuring that a configuration is valid for the auditor.
-```ruby
-def configuration_is_valid(configuration)
-  return configuration.include?("something_needed")
-end
-```
-
-The audit method will be called when the base API wants to publish an audit event after it has been formatted and filtered.
-```ruby
-def audit(data)
-  puts data
-end
-```
-
-The configuration is made available to the auditor through the @configuration attribute in the API class.
-```ruby
-def audit(data)
-  puts @configuration["preprefix"] + data
-end
-```
-
-
-### Auditing Providers that utilize the AuditorAPI as clients
-
-Instantiate an auditor that extends the AuditorAPI:
-```ruby
-@iut = SanityAuditor.new
-```
-
-Configure the auditor with required parameters:
-```ruby
-configuration = { "preprefix" => "very important:" }
-@iut.configure(configuration)
-```
+When formatting an auditing entry call the formatter as follow:
 
-Set the desired audit level. Allowed levels (in increasing level of priority) are :debug, :info, :warn, :error and :fatal.  As an example only :warn, :error and :fatal audit events will be logged if you set the level to :warn.
 ```ruby
-@iut.set_audit_level(:warn)
+SoarAuditingFormatter::Formatter.format(:error,SecureRandom.hex(32),Time.now,"message")
 ```
 
-Use the auditing interfaces as follow. The API also supports appending as below, enabling support, e.g. for Rack::CommonLogger, etc.:
-```ruby
-@iut.info("This is info")
-@iut.warn("Statistics show that dropped packets have increased to #{dropped}%")
-@iut.error("Could not resend some dropped packets. They have been lost. All is still OK, I could compensate")
-@iut.fatal("Unable to perform action, too many dropped packets. Functional degradation.")
-@iut << 'Rack::CommonLogger requires this'
-```
+When formatting an optional field call the formatter as follow:
 
-Note that the APIs (debug/info/warn/error/fatal) accept any object as a parameter. The object will be serialized using the .to_s method and therefore the object must implement the .to_s method (or already be of a basic object type that has the .to_s method).
 ```ruby
-some_debug_object = 123
-@iut.debug(some_debug_object)
+SoarAuditingFormatter::Formatter.optional_field_format("somekey", "somevalue")
 ```
 
 ## Detailed example
@@ -106,32 +43,12 @@ some_debug_object = 123
 ```ruby
 require 'soar_auditing_format'
 require 'byebug'
-
-class SanityAuditor < SoarAuditingFormatter::AuditorAPI
-  def configuration_is_valid(configuration)
-    return configuration.include?("preprefix")
-  end
-
-  def audit(data)
-    puts @configuration["preprefix"] + data
-  end
-end
+require 'securerandom'
 
 class Main
   def test_sanity
-    @iut = SanityAuditor.new
-    configuration = { "preprefix" => "very important:" }
-    @iut.configure(configuration)
-    @iut.set_audit_level(:debug)
-
-    some_debug_object = 123
-    @iut.info("This is info")
-    @iut.debug(some_debug_object)
-    dropped = 95
-    @iut.warn("Statistics show that dropped packets have increased to #{dropped}%")
-    @iut.error("Could not resend some dropped packets. They have been lost. All is still OK, I could compensate")
-    @iut.fatal("Unable to perform action, too many dropped packets. Functional degradation.")
-    @iut << 'Rack::CommonLogger requires this'
+    my_optional_field = SoarAuditingFormatter::Formatter.optional_field_format("somekey", "somevalue")
+    puts SoarAuditingFormatter::Formatter.format(:error,SecureRandom.hex(32),Time.now,"#{my_optional_field} message")
   end
 end
 

data/lib/soar_auditing_format/version.rb

@@ -1,3 +1,3 @@
 module SoarAuditingFormatter
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/sanity/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
 gem 'byebug'
-gem 'soar_auditing_format', "~> 0.0.1"
+gem 'soar_auditing_format', "~> 0.0.2"

data/sanity/sanity.rb

@@ -1,9 +1,11 @@
 require 'soar_auditing_format'
 require 'byebug'
+require 'securerandom'
 
 class Main
   def test_sanity
-    SoarAuditingFormatter::Formatter.format("level",SecureRandom.hex(32),Time.now,"message")
+    my_optional_field = SoarAuditingFormatter::Formatter.optional_field_format("somekey", "somevalue")
+    puts SoarAuditingFormatter::Formatter.format(:error,SecureRandom.hex(32),Time.now,"#{my_optional_field} message")
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soar_auditing_format
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Barney de Villiers