logstash_auditor 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3dd294589825e39ca26e59a6204bb9431b9d9fbb
-  data.tar.gz: 98defbe2db36aec15e75cc2dad37befe9368487e
+  metadata.gz: 6f8dec6ba0d7de7778cc515f4e80f3d69a4a00b3
+  data.tar.gz: 2d65e403c26b261d8fc0f191764bc76ec46422f7
 SHA512:
-  metadata.gz: dfcb70d7dd0684918804948477e1902f219fdeb1cfef70130191e8348659eaf8ed9b1a25dd1fb2db2673c2758b36245e79e46b9ffb8b4e564087cd5834814672
-  data.tar.gz: 64c9352f29edb6c57d17426c22f1d4048082e7413acbfaef551a172f2f032a4fc7ebb20b6f7e66e4e0d5e190b20152d28af17e79d1f0eee98f545fbc0c3df743
+  metadata.gz: 65c93f8af9c1856a081a4f3464b3570d82004d57a727cb9975c27e5c37d69850d94610d92bf051759308c31721f7d783f76ae7d89994173612c038d1ec9a37a4
+  data.tar.gz: be829566efe2a0716662bf828c7449b9e5c482806e90f97b4215d8cc7f149d7a7d05a502e964f3e8b15174473f55d42c29c41b5a2c179822bee6af8616d71362

data/README.md

@@ -24,7 +24,7 @@ Or install it yourself as:
 
 ## Testing
 
-Behavioural driven testing can be performed by testing against an ELK docker image:
+Behavioural driven testing can be performed by testing against a local ELK docker image:
 
     $ sudo docker run -d -v $(pwd)/spec/support/logstash_conf.d:/etc/logstash/conf.d -p 9300:9300 -p 9200:9200 -p 5000:5000 -p 5044:5044 -p 5601:5601 -p 8080:8080 sebp/elk
 
@@ -44,75 +44,45 @@ Debugging the docker image:
 
 ## Usage
 
-
-#TODO complete this section
-#TODO Extend the LogstashAuditor::AuditingProviderAPI to create an auditing provider:
-
-```
-class MyAuditingProvider < LogstashAuditor::AuditingProviderAPI
-end
-```
-
-Provide the required inversion of control method to configure (an) injected auditor(s):
+Initialize and configure the auditor so:
 
 ```
-def configure_auditor(configuration = nil)
-  @auditor.configure(configuration)
-end
-```
-
-Initialize the provider so:
-
-```
-auditor = MyAuditor.new
-auditor_configuration = { 'some' => 'configuration' }
-@iut = MyAuditingProvider.new(auditor, auditor_configuration)
+@iut = LogstashAuditor::LogstashAuditor.new
+@logstash_configuration =
+{ "host_url" => "http://localhost:8080",
+  "use_ssl"  => false,
+  "username" => "something",
+  "password" => "something",
+  "timeout"  => 3}
+@iut.configure(@valid_logstash_configuration)
 ```
 
 Audit using the API methods, e.g.:
 
 ```
-@iut.info("This is info")
-@iut.debug(some_debug_object)
-@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'
-```
-
-The API also supports appending as below, enabling support, e.g. for Rack::CommonLogger, etc.:
-
-```
-<<
+@iut.event(flow_id, "This is a test event")
 ```
 
 ## Detailed example
 
 ```
-require 'log4r'
 require 'logstash_auditor'
 
-class Log4rAuditingProvider < LogstashAuditor::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 = { 'outputter' => Outputter.stdout }
-    @iut = Log4rAuditingProvider.new(auditor, auditor_configuration)
-
-    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 = LogstashAuditor::LogstashAuditor.new
+    @valid_logstash_configuration =
+    { "host_url" => "http://localhost:8080",
+      "use_ssl"  => false,
+      "username" => "something",
+      "password" => "something",
+      "timeout"  => 3}
+    @iut.configure(@valid_logstash_configuration)
+
+    require 'digest'
+    flow_id = Digest::SHA256.hexdigest("#{Time.now.to_i}#{rand(4000000)}")
+
+    @iut.event(flow_id, "This is a test event")
   end
 end
 
@@ -126,7 +96,7 @@ Bug reports and feature requests are welcome by email to barney dot de dot villi
 
 ## Notes
 
-Though out of scope for the provider, auditors should take into account encoding, serialization, and other NFRs.
+The interface for auditors is still not stable and therefore subject to change.
 
 ## License
 

data/lib/logstash_auditor/version.rb

@@ -1,3 +1,3 @@
 module LogstashAuditor
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/sanity/Gemfile

@@ -1,7 +1,3 @@
 source 'https://rubygems.org'
 
-gem 'byebug'
-gem 'logstash_auditor', "~> 0.0.1"
-
-gem 'http'
-gem 'net'
+gem 'logstash_auditor'

data/sanity/sanity.rb

@@ -1,12 +1,6 @@
 require 'logstash_auditor'
-require 'digest'
-
 
 class Main
-  def create_flow_id
-    return Digest::SHA256.hexdigest("#{Time.now.to_i}#{rand(4000000)}")
-  end
-
   def test_sanity
     @iut = LogstashAuditor::LogstashAuditor.new
     @valid_logstash_configuration =
@@ -16,7 +10,11 @@ class Main
       "password" => "something",
       "timeout"  => 3}
     @iut.configure(@valid_logstash_configuration)
-    @iut.event(create_flow_id, "This is a test event")
+
+    require 'digest'
+    flow_id = Digest::SHA256.hexdigest("#{Time.now.to_i}#{rand(4000000)}")
+
+    @iut.event(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.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Barney de Villiers