soar_auditor_api 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5030e0bde899627dc4b7948d62c7beb4083c7cc
-  data.tar.gz: 2ab287eb385b783aaf66035ff2e5519c36f7dca1
+  metadata.gz: 5b6df8f23b406ea3f044f762a4b89c682ffa1e78
+  data.tar.gz: 457d8bc37bd018832c15a9f03b8c6a563502a898
 SHA512:
-  metadata.gz: e9be17c974061665baf108a1cd9471cb2def004f911c25dd486aa47e77ab4508107d90edbf56d551d9414baefa36898359e4bff96d7f6a20a15601d8f00fb903
-  data.tar.gz: 22badc8a993560166dec0a4f1e0f05f7914fbebf81fbc749cc635d1fa723f5be31812e8fe59f2b8d7143607d07811a6eee11bbc55fa91bc034419af802fdf352
+  metadata.gz: f2cbe2db4c2ebb1ff3c4aeb4591acc453032d44a8a62d7eaa3644ba09aa69cf187d95ecbc07af2b82113ae9b3d6f8ac3d47f60349e959aecd618fa68b2f06f47
+  data.tar.gz: c0f88aadbe0f8a7aa92edfeff0494b8dfd6a19945edca55911bd0458e160988bb78614d495bc440603ad4d5d38a637f24f113145fa32d8dffd2858a714d3baf4

data/README.md

@@ -99,6 +99,21 @@ some_debug_object = 123
 @iut.debug(some_debug_object)
 ```
 
+### Serializable classes
+
+Class instances to be logged in the message field can be serialized by extending from the SoarAuditorApi::Serializable class.
+Store the data in the @data attribute and implement the to_s method that calls the serialize method in the base class.
+
+``` ruby
+class TestSerializable < SoarAuditorApi::Serializable
+  attr_accessor :data
+
+  def to_s
+    serialize
+  end
+end
+```
+
 ## Detailed example
 
 ```ruby

data/lib/soar_auditor_api/auditor_api.rb

@@ -1,10 +1,11 @@
 module SoarAuditorApi
   class AuditorAPI
     AUDIT_LEVELS = [:debug, :info, :warn, :error, :fatal] unless defined? AUDIT_LEVELS; AUDIT_LEVELS.freeze
+    DEFAULT_AUDIT_LEVEL = :info unless defined? DEFAULT_AUDIT_LEVEL; DEFAULT_AUDIT_LEVEL.freeze
 
     def initialize
       @configuration = nil
-      @minimum_audit_level = :info
+      @minimum_audit_level = DEFAULT_AUDIT_LEVEL
     end
 
     def configure(configuration = nil)
@@ -43,12 +44,12 @@ module SoarAuditorApi
 
     #Safety to ensure that the Auditor that extends this API implements this IOC method
     def configuration_is_valid?(configuration)
-      raise NotImplementedError, "Method must implement configuration_is_valid? method in Auditor extending the API"
+      raise NotImplementedError, "Class must implement configuration_is_valid? method in Auditor extending the API"
     end
 
     #Safety to ensure that the Auditor that extends this API implements this IOC method
     def audit(data)
-      raise NotImplementedError, "Method must implement audit method in Auditor extending the API"
+      raise NotImplementedError, "Class must implement audit method in Auditor extending the API"
     end
 
     private

data/lib/soar_auditor_api/version.rb

@@ -1,3 +1,3 @@
 module SoarAuditorApi
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/sanity/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
 gem 'byebug'
-gem 'soar_auditor_api', "~> 0.0.6"
+gem 'soar_auditor_api', "~> 0.0.7"

data/sanity/sanity.rb

@@ -11,10 +11,11 @@ class SanityAuditor < SoarAuditorApi::AuditorAPI
   end
 end
 
-class MyStackTrace < SoarAuditorApi::Serializable
+class TestSerializable < SoarAuditorApi::Serializable
   def to_s
-    serialize()
+    serialize
   end
+end
 
 class Main
   def test_sanity
@@ -31,6 +32,9 @@ class Main
     @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'
+
+    serializable_object = TestSerializable.new("some data")
+    serializable_object.to_s
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soar_auditor_api
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Barney de Villiers