stream_auditor 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 894b6a9dbf40b4b66c3919484e8457c1e06c7235
-  data.tar.gz: dc994150516cdca9bd60b8efb77d8f7541c055dc
+  metadata.gz: 50250b66a46864c7c059e9b0b55983f25086a662
+  data.tar.gz: d0b0f3f9d49fea41c7a24001d0035c022862f4c1
 SHA512:
-  metadata.gz: 64f66715dd0021f18f8085daa98de1e8d2a68ff4cd7d81f8ad3ddde63d1dd40fdeafb6849e173bd6766c6767ef26c50e8bd1664766ff03226c247096ae0a1565
-  data.tar.gz: c82e5dc68d6091015d7319be2004d677f0832c3d843dc140a2dfb77e61229edbc156411d126c3cb6ae851797c1e5fcb722dd562fbe9748608268b1325a5565c4
+  metadata.gz: 4fed046c80026fedecd44e6932339fdef25c67802197bb506697a889810a1456a6ff41917ebb1db12a43b8df51f80685f01ec250deceebd821f91e7f623464f0
+  data.tar.gz: 55f98b27fdc3ce7f24d26da9761005120a42b8a4f899285a613f21b772e4b659d119f45ed368975eef12a41c92177f5f59f98ec488e3ba91fb348f081d218592

data/README.md

@@ -61,7 +61,7 @@ config = {
     "auditors" => {
       "local" => {
         "adaptor" => "StreamAuditor",
-        "standard_stream" => "stdout"
+        "stream" => "$stdout"
       }
     }
   }
@@ -82,7 +82,7 @@ config = {
     "auditors" => {
       "local" => {
         "adaptor" => "StreamAuditor",
-        "path" => "/var/log/application.log"
+        "stream" => "/var/log/application.log"
       }
     }
   }
@@ -103,7 +103,7 @@ config = {
     "auditors" => {
       "local" => {
         "adaptor" => "StreamAuditor",
-        "io" => File.open("/var/log/application.log", "a")
+        "stream" => File.open("/var/log/application.log", "a")
       }
     }
   }

data/lib/stream_auditor/version.rb

@@ -1,5 +1,5 @@
 require "soar_auditor_api/auditor_api"
 
 class StreamAuditor < SoarAuditorApi::AuditorAPI
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/stream_auditor.rb

@@ -4,79 +4,59 @@ require "fileutils"
 
 class StreamAuditor < SoarAuditorApi::AuditorAPI
 
-  DEFAULT_CONFIGURATION = {
-    "standard_stream" => "stderr"
-  }
-
-  def initialize(configuration = nil)
-    configuration = cleanup_configuration(configuration)
-    super
-  end
-
   def audit(data)
-    @stream << data.to_s.chomp + "\n"
-    @stream.flush
+    stream << data.to_s.chomp + "\n"
+    stream.flush
   end
 
   def configure(configuration = nil)
-    configuration = cleanup_configuration(configuration)
     super
-    @stream = nil
-    @stream = configuration["io"] if configuration["io"]
-    @stream = standard_stream(configuration["standard_stream"]) if configuration["standard_stream"]
-    @stream = creative_open_file(configuration["path"]) if configuration["path"]
+    if configuration
+      s = configuration["stream"]
+      @stream = if want_stdout_stream?(s) then $stdout
+                elsif want_stderr_stream?(s) then $stderr
+                elsif want_io_stream?(s) then s
+                elsif want_path_stream?(s) then creative_open_file(s)
+                end
+    end
   end
 
   def configuration_is_valid?(configuration)
-    configuration = cleanup_configuration(configuration)
-    1 == configuration.keys.inject(0) { |count, key| count += 1 if ["standard_stream", "path", "io"].include?(key) } and
-      configuration["io"].nil? || configuration["io"].respond_to?(:<<) and
-      configuration["path"].nil? || (File.expand_path(configuration["path"]) rescue false) and
-      configuration["standard_stream"].nil? || ["stderr", "stdout"].include?(configuration["standard_stream"])
+    return false unless (configuration.keys - ["adaptor", "stream"]).empty?
+
+    s = configuration["stream"]
+    want_default_stream?(s) or want_stderr_stream?(s) or want_stdout_stream?(s) or want_io_stream?(s) or want_path_stream?(s)
   end
 
   private
 
-  # XXX Fight the auditor API
-  #
-  # The auditor API:
-  #
-  # * doesn't run the configure method for nil configuration,
-  # * insists on validation non-nil configuration, and
-  # * received the "adaptor" configuration key from the SOAR auditing provider.
-  #
-  def cleanup_configuration(configuration)
-    configuration = (configuration || {}).reject { |k, v| k == "adaptor" }
+  def creative_open_file(path)
+    FileUtils.mkdir_p(File.expand_path("..", path), mode: 0700)
+    File.open(path, "a")
+  end
 
-    if configuration.nil? or configuration.empty?
-      DEFAULT_CONFIGURATION
-    else
-      configuration
-    end
+  def stream
+    @stream || $stderr
   end
 
-  # XXX Fight rspec
-  #
-  # From the rspec-expectations documentation:
-  #
-  #     Note: to_stdout and to_stderr work by temporarily replacing $stdout or $stderr,
-  #     so they're not able to intercept stream output that explicitly uses STDOUT/STDERR
-  #     or that uses a reference to $stdout/$stderr that was stored before the matcher was used.
-  #
-  def standard_stream(stream_name)
-    case stream_name
-    when "stderr"
-      $stderr
-    when "stdout"
-      $stdout
-    else
-      raise ArgumentError, "unknown stream name #{stream_name.inspect}"
-    end
+  def want_default_stream?(s)
+    s.nil?
   end
 
-  def creative_open_file(path)
-    FileUtils.mkdir_p(File.expand_path("..", path), mode: 0700)
-    File.open(path, "a")
+  def want_io_stream?(s)
+    s.respond_to?(:<<) and s.respond_to?(:flush)
+  end
+
+  def want_path_stream?(s)
+    s.respond_to?(:start_with?) and (!s.start_with?("$")) and !!(File.expand_path(s) rescue false)
+  end
+
+  def want_stderr_stream?(s)
+    s == "$stderr"
+  end
+
+  def want_stdout_stream?(s)
+    s == "$stdout"
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stream_auditor
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Sheldon Hearn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-03 00:00:00.000000000 Z
+date: 2017-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler