soar_auditing_provider 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d111d5c387c29b5e0e250738f431f5e4ddd8283
-  data.tar.gz: 47c07689ce1876570f2ab18ec4adcbdcb8a253b3
+  metadata.gz: e21b8597fa31874223d872ab5ce118eacb7a3e01
+  data.tar.gz: bf73f8eebe80cd8a37e380f2fecc9ca9b6efaf97
 SHA512:
-  metadata.gz: a75314385273556c5a6f10aad6969e77384048da207a2872eb6036de7c434fcaa467317eba2da4d529678516c6ba3276027044445f06aaaa1e3f0705958e347f
-  data.tar.gz: eb69f3e8a51068240d6ee6b9e1361ca5bdd6eac0cbf7e37122cce75628ef821df12e37a8b6af779bf4eabe452a212d7e113620ef368cc4a870b1907810c866fc
+  metadata.gz: 3b0caa7895367d66046e60dbcdf23549313efaf9fa92f2d717217225d02d908b203124c4c2d66d9946c3b6d1a05735e9234642c090d6079544dd9891474baaa9
+  data.tar.gz: 90e297cf7d8f4d42f56ecc157068f30bc97a57ab3b7e97d834566e64957d97d8a95b0da403a565c2cb461aaee84103b8eaaa2ff0ced27e4f3875680548ecd347

data/README.md

@@ -2,9 +2,13 @@
 
 This gem provides the auditing API that audit providers for the SOAR architecture should adhere to. 
 
-Providers are initialized with a list of auditors and their configuration, as well as the NFRs they support, and is responsible for selecting an auditor giving a set of NFRs, and configuring the auditor appropriately. The auditing API as set out below then delegates auditing actions to the selected auditor.
+Providers are initialized with a list of auditors (already configured) and their configurations, which include the NFRs they support (key: 'nfrs'), and is responsible for selecting an auditor given a set of NFRs. Such selection is made by calling the select(nfrs) method. The auditing API as set out below then delegates auditing actions to the selected auditor.
 
-The API provides default delegation behaviour that calls the API methods verbatim on the auditor.
+The API provides default delegation behaviour that calls the API methods verbatim on the auditor. NFRs can be anything you want. You can ask the auditing provider to select an auditor based on a set of NFRs. The default behaviour is that the first auditor which matches all NFRs exactly is returned. You can override this behaviour by overriding the select(nfrs) method.
+
+If you'd simply like the auditing provider to use the first (perhaps only?) auditor that it knows about, you can tell it to select DEFAULT so:
+
+auditor = auditing_provider.select(SoarAuditingProvider::AuditingProviderAPI::DEFAULT)
 
 ## Installation
 
@@ -24,32 +28,31 @@ Or install it yourself as:
 
 ## Usage
 
-Extend the SoarAuditingProvider::AuditingProviderAPI to create an auditing provider:
+Extend the SoarAuditingProvider::AuditingProviderAPI to create a new auditing provider, or instantiate the API directly for an out-of-the-box auditing provider with default behaviour.
 
 ```
 class MyAuditingProvider < SoarAuditingProvider::AuditingProviderAPI
 end
 ```
 
-Provide the required inversion of control method to configure (an) injected auditor(s):
+or
 
 ```
-def configure_auditor(configuration = nil)
-  @auditor.configure(configuration)
-end
+auditor_provider = SoarAuditingProvider::AuditingProviderAPI.new(auditors)
 ```
 
 Initialize the provider so:
 
 ```
 auditor = MyAuditor.new
-auditor_configuration = { 'nfrs' => { 'nfr' => 'description' }, 'some' => 'configuration' }
-@iut = MyAuditingProvider.new(auditor, auditor_configuration)
+auditor_nfrs = { 'nfrs' => { 'accessibility' => 'local' }, 'privacy' => 'not encrypted' }
+@iut = MyAuditingProvider.new( { auditor => auditor_nfrs } )
 ```
 
-Audit using the API methods, e.g.:
+Select an auditor and audit using the API methods. The auditing provider remembers your selection, e.g.:
 
 ```
+@iut.select( {'accessibility' => 'local' })
 @iut.info("This is info")
 @iut.debug(some_debug_object)
 @iut.warn("Statistics show that dropped packets have increased to #{dropped}%")
@@ -58,6 +61,18 @@ Audit using the API methods, e.g.:
 @iut << 'Rack::CommonLogger requires this'
 ```
 
+Alternatively, to use different auditors for different sets of NFRs in the same code, do as below. The auditing provider remembers the last auditor selected.
+
+```
+  auditor_A = @iut.select( {'my nfr 1' => 'criteria 1' })
+  auditor_B = @iut.select( {'my nfr 2' => 'criteria 2' })
+
+  auditor_A.debug('debug')
+  auditor_B.warn('warn')
+
+  @iut.error('error') # Uses auditor_B since it was selected last
+```
+
 The API also supports appending as below, enabling support, e.g. for Rack::CommonLogger, etc.:
 
 ```
@@ -70,21 +85,14 @@ The API also supports appending as below, enabling support, e.g. for Rack::Commo
 require 'log4r'
 require 'soar_auditing_provider'
 
-class Log4rAuditingProvider < SoarAuditingProvider::AuditingProviderAPI
-  def configure_auditor(configuration = nil)
-    @auditor.outputters = configuration['outputter']
-  end
-end
-
 class Main
   include Log4r
- 
+  
   def test_sanity
     auditor = Logger.new 'sanity'
-    auditor_configuration = { 'nfrs' => { 'accessibility' => 'local' }, 'outputter' => Outputter.stdout }
-    provider = Log4rAuditingProvider.new(auditor, auditor_configuration)
-    @iut = provider.create('')
-
+    auditor.outputters = Outputter.stdout
+    @iut = SoarAuditingProvider::AuditingProviderAPI.new( { auditor => { 'nfrs' => {'accessibility' => 'local'} } } )
+    @iut.select(SoarAuditingProvider::AuditingProviderAPI::DEFAULT)
     some_debug_object = 123
     @iut.info("This is info")
     @iut.debug(some_debug_object)
@@ -92,6 +100,7 @@ class Main
     @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'
   end
 end
 

data/lib/soar_auditing_provider/auditing_provider_api.rb

@@ -55,18 +55,7 @@ module SoarAuditingProvider
       end
       configuration = auditors[auditor_selected]
       @auditor = auditor_selected
-      configure_auditor(@auditor, configuration)
-      @auditor
+      return @auditor, configuration
     end
-
-    protected
-    
-    def configure_auditor(auditor, configuration = nil)
-      raise NotImplementedError.new("You should override this method and configure your auditor")
-    end    
-
-    private
-
-
   end
 end

data/lib/soar_auditing_provider/version.rb

@@ -1,3 +1,3 @@
 module SoarAuditingProvider
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/sanity/sanity.rb

@@ -1,23 +1,13 @@
 require 'log4r'
 require 'soar_auditing_provider'
 
-class Log4rAuditingProvider < SoarAuditingProvider::AuditingProviderAPI
-  def configure_auditor(auditor, configuration = nil)
-    auditor.outputters = configuration['outputter']
-  end
-
-  def select(nfrs)
-    super(nfrs)
-  end  
-end
-
 class Main
   include Log4r
   
   def test_sanity
     auditor = Logger.new 'sanity'
-    auditor_configuration = { 'outputter' => Outputter.stdout }
-    @iut = Log4rAuditingProvider.new( { auditor => auditor_configuration } )
+    auditor.outputters = Outputter.stdout
+    @iut = SoarAuditingProvider::AuditingProviderAPI.new( { auditor => { 'nfrs' => {'accessibility' => 'local'} } } )
     @iut.select(SoarAuditingProvider::AuditingProviderAPI::DEFAULT)
     some_debug_object = 123
     @iut.info("This is info")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soar_auditing_provider
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Ernst Van Graan