logstash_auditor 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 030aece775d1f1ce076e855a14509541b9033677
-  data.tar.gz: 7b324939d42281d8081c63fc2c34fcfa827b0024
+  metadata.gz: 6c3d76abc5788824b821f1770ec008c16437abb5
+  data.tar.gz: 7117c44fa990fe9a1e1f8a0f242bd2078dcfddaf
 SHA512:
-  metadata.gz: 8ddc607e7296a894cea671daba9408a25dc6782634f9256b7bba979ec3a2960a7ec7ad69658f3ddef78242d8dd34db7a6eabfe956f19c2c676ba5f73fa6f8665
-  data.tar.gz: e6b6cfa9edfda84fd7d70ec929bdf1c906bea5eb3c0b0535d3cdbc0a017560c64dcc7e42dc5e15b4ba536a59ed11eac8e1b3b81a6ca9e7bcab835d15bcc13c8b
+  metadata.gz: 0397b01c9e3d5791b38b66138bd3ce812ea828c448c6bfbde7ea5b49ff33ff23239925cabf02b2f65bcbe2c8b32808ad8715528f3a1045e5b136743d126fa2d7
+  data.tar.gz: c45df64e14df881cddfd6966f8200e83db91f169999612fe2defba11cf55f19744388bee95e89a41068565a83adcd4a6f779abd2cac894190cfecd049ae338a7

data/README.md

@@ -5,6 +5,7 @@ This gem provides the logstash auditor that can be plugged into the SOAR archite
 ## State of the API
 
 This auditor is to be extended with NFR support pending behavioural specifications.
+Note that the interface for auditors is still not completely stable and therefore subject to change.
 
 ## Installation
 
@@ -46,42 +47,41 @@ Debugging the docker image:
 
 Initialize and configure the auditor so:
 
-```
+```ruby
 @iut = LogstashAuditor::LogstashAuditor.new
 @logstash_configuration =
 { "host_url" => "http://localhost:8080",
-  "username" => "something",
-  "password" => "something",
+  "username" => "auditorusername",
+  "password" => "auditorpassword",
   "timeout"  => 3}
-@iut.configure(@valid_logstash_configuration)
+@iut.configure(@logstash_configuration)
 ```
 
-Audit using the inherited API methods, e.g.:
+Audit using the API methods inherited from SoarAuditorApi::SoarAuditorAPI, e.g.:
 
-```
-@iut.event(flow_id, "This is a test event")
+```ruby
+@iut.warn("#{flow_id}:This is a test event")
 ```
 
 ## Detailed example
 
-```
+```ruby
 require 'logstash_auditor'
 
 class Main
   def test_sanity
     @iut = LogstashAuditor::LogstashAuditor.new
-    @valid_logstash_configuration =
+    @logstash_configuration =
     { "host_url" => "http://localhost:8080",
-      "use_ssl"  => false,
-      "username" => "something",
-      "password" => "something",
+      "username" => "auditorusername",
+      "password" => "auditorpassword",
       "timeout"  => 3}
-    @iut.configure(@valid_logstash_configuration)
+    @iut.configure(@logstash_configuration)
 
     require 'digest'
     flow_id = Digest::SHA256.hexdigest("#{Time.now.to_i}#{rand(4000000)}")
 
-    @iut.event(flow_id, "This is a test event")
+    @iut.warn("#{flow_id}:This is a test event")
   end
 end
 
@@ -93,10 +93,6 @@ main.test_sanity
 
 Bug reports and feature requests are welcome by email to barney dot de dot villiers at hetzner dot co dot za. This gem is sponsored by Hetzner (Pty) Ltd (http://hetzner.co.za)
 
-## Notes
-
-The interface for auditors is still not stable and therefore subject to change.
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/logstash_auditor/version.rb

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

data/sanity/Gemfile

@@ -1,3 +1,3 @@
 source 'https://rubygems.org'
 
-gem 'logstash_auditor'
+gem 'logstash_auditor', "~> 0.0.7"

data/sanity/sanity.rb

@@ -3,17 +3,17 @@ require 'logstash_auditor'
 class Main
   def test_sanity
     @iut = LogstashAuditor::LogstashAuditor.new
-    @valid_logstash_configuration =
+    @logstash_configuration =
     { "host_url" => "http://localhost:8080",
       "username" => "auditorusername",
       "password" => "auditorpassword",
       "timeout"  => 3}
-    @iut.configure(@valid_logstash_configuration)
+    @iut.configure(@logstash_configuration)
 
     require 'digest'
     flow_id = Digest::SHA256.hexdigest("#{Time.now.to_i}#{rand(4000000)}")
 
-    @iut.warn(flow_id, "This is a test event")
+    @iut.warn("#{flow_id}:This is a test event")
   end
 end
 

metadata

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