soar_auditing_provider 0.7.0 → 0.9.3

data/lib/soar_auditing_provider/version.rb

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

data/lib/soar_auditing_provider.rb

@@ -1,6 +1,7 @@
 require "soar_auditing_provider/version"
-require 'soar_auditing_provider/auditing_provider_api'
-require 'soar_auditing_provider/nfr_match_error'
+require 'soar_auditing_provider/auditing_overflow_error'
+require 'soar_auditing_provider/auditing_worker'
+require 'soar_auditing_provider/auditing_provider'
 
 module SoarAuditingProvider
 end

data/sanity/.ruby-version

@@ -1 +1 @@
-ruby-2.2
+ruby-2.3.0

data/sanity/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
 
-gem 'log4r'
 gem 'soar_auditing_provider', :path => "../"
+gem "log4r_auditor", "~> 0.0.4"
+gem "soar_flow", "~> 0.1.1"

data/sanity/sanity.rb

@@ -1,22 +1,59 @@
-require 'log4r'
 require 'soar_auditing_provider'
+require 'log4r_auditor'
+require 'soar_flow'
 
 class Main
-  include Log4r
-  
+
+  AUDITING_CONFIGURATION = {
+    'auditing' => {
+      'level' => 'debug',
+      'install_exit_handler' => 'true',
+      'queue_worker' => {
+        'queue_size' => 1000,
+        'initial_back_off_in_seconds' => 1,
+        'back_off_multiplier' => 2,
+        'back_off_attempts' => 5
+      },
+      'default_nfrs' => {
+        'accessibility' => 'local',
+        'privacy' => 'not encrypted',
+        'reliability' => 'instance',
+        'performance' => 'high'
+      },
+      'auditors' => {
+        'log4r' => {
+          'adaptor' => 'Log4rAuditor::Log4rAuditor',
+          'file_name' => 'soar_sc.log',
+          'standard_stream' => 'stdout',
+          'nfrs' => {
+            'accessibility' => 'local',
+            'privacy' => 'not encrypted',
+            'reliability' => 'instance',
+            'performance' => 'high'
+          }
+        }
+      }
+    }
+  }
+
   def test_sanity
-    auditor = Logger.new 'sanity'
-    auditor.outputters = Outputter.stdout
-    @iut = SoarAuditingProvider::AuditingProviderAPI.new( { auditor => { 'nfrs' => {'accessibility' => 'local'} } } )
-    @iut.select(SoarAuditingProvider::AuditingProviderAPI::DEFAULT)
+    #create and configure auditing instance
+    myauditing = SoarAuditingProvider::AuditingProvider.new( AUDITING_CONFIGURATION['auditing'] )
+    myauditing.instance_flow_identifier = SoarFlow::ID::generate_flow_id
+    myauditing.service_identifier = 'my-test-service.com'
+
+    #associate a set of auditing entries with a flow by generating a flow identifiers
+    flow_id = SoarFlow::ID::generate_flow_id
+
+    #generate audit events
     some_debug_object = 123
-    @iut.info("This is info")
-    @iut.debug(some_debug_object)
+    myauditing.info("This is info",flow_id)
+    myauditing.debug(some_debug_object,flow_id)
     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 << 'Rack::CommonLogger requires this'
+    myauditing.warn("Statistics show that dropped packets have increased to #{dropped}%",flow_id)
+    myauditing.error("Could not resend some dropped packets. They have been lost. All is still OK, I could compensate",flow_id)
+    myauditing.fatal("Unable to perform action, too many dropped packets. Functional degradation.",flow_id)
+    myauditing << 'Rack::CommonLogger requires this'
   end
 end
 

data/soar_auditing_provider.gemspec

@@ -4,22 +4,30 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'soar_auditing_provider/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "soar_auditing_provider"
+  spec.name          = 'soar_auditing_provider'
   spec.version       = SoarAuditingProvider::VERSION
-  spec.authors       = ["Ernst Van Graan"]
-  spec.email         = ["ernst.van.graan@hetzner.co.za"]
+  spec.authors       = ['Ernst van Graan', 'Barney de Villiers']
+  spec.email         = ['ernst.van.graan@hetzner.co.za', 'barney.de.villiers@hetzner.co.za']
 
-  spec.summary       = %q{API for SOAR architecture auditing}
-  spec.description   = %q{API for SOAR architecture auditing}
-  spec.license       = "MIT"
+  spec.summary       = %q{SOAR architecture auditing provider}
+  spec.description   = %q{SOAR architecture auditing provider extending from auditing provider API}
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "byebug"
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'byebug', '~> 9.0.5'
+  spec.add_development_dependency 'log4r_auditor', '~> 0.0.4'
+  spec.add_development_dependency 'soar_flow', '~> 0.1.1'
+  spec.add_development_dependency 'soar_xt', '~> 0.0.3'
+
+  spec.add_dependency 'soar_auditing_provider_api', '~> 0.9.0'
+  spec.add_dependency 'soar_auditing_format', '~> 0.0.5'
+  spec.add_dependency 'soar_thread_worker', '~> 0.1'
+  spec.add_dependency 'soar_configured_factory', '~> 0.1.0'
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: soar_auditing_provider
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.3
 platform: ruby
 authors:
-- Ernst Van Graan
+- Ernst van Graan
+- Barney de Villiers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-14 00:00:00.000000000 Z
+date: 2016-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,28 +57,129 @@ dependencies:
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.0.5
+- !ruby/object:Gem::Dependency
+  name: log4r_auditor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: soar_flow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: soar_xt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: soar_auditing_provider_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: soar_auditing_format
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+- !ruby/object:Gem::Dependency
+  name: soar_thread_worker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: soar_configured_factory
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: API for SOAR architecture auditing
+        version: 0.1.0
+description: SOAR architecture auditing provider extending from auditing provider
+  API
 email:
 - ernst.van.graan@hetzner.co.za
+- barney.de.villiers@hetzner.co.za
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -85,8 +187,9 @@ files:
 - bin/console
 - bin/setup
 - lib/soar_auditing_provider.rb
-- lib/soar_auditing_provider/auditing_provider_api.rb
-- lib/soar_auditing_provider/nfr_match_error.rb
+- lib/soar_auditing_provider/auditing_overflow_error.rb
+- lib/soar_auditing_provider/auditing_provider.rb
+- lib/soar_auditing_provider/auditing_worker.rb
 - lib/soar_auditing_provider/version.rb
 - sanity/.gitignore
 - sanity/.ruby-gemset
@@ -114,8 +217,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: API for SOAR architecture auditing
+summary: SOAR architecture auditing provider
 test_files: []

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.2
-before_install: gem install bundler -v 1.11.2

data/lib/soar_auditing_provider/auditing_provider_api.rb

@@ -1,61 +0,0 @@
-module SoarAuditingProvider
-  class AuditingProviderAPI
-    DEFAULT = {} unless defined? DEFAULT; DEFAULT.freeze
-
-    attr_accessor :auditors
-    attr_accessor :auditor
-
-    def initialize(auditors)
-      raise ArgumentError.new("Invalid auditors provided") if not auditors.is_a?(Hash)
-      raise ArgumentError.new("No auditors provided") if auditors.nil? or auditors.empty?
-      @auditors = auditors
-    end
-
-    def debug(data)
-      @auditor.debug(data)
-    end
-
-    def <<(data)
-      @auditor.info(data)
-    end
-
-    def info(data)
-      @auditor.info(data)
-    end
-
-    def error(data)
-      @auditor.error(data)
-    end
-
-    def warn(data)
-      @auditor.warn(data)
-    end
-
-    def fatal(data)
-      @auditor.fatal(data)
-    end
-
-    def select(nfrs = DEFAULT)
-      if nfrs.nil? or nfrs.empty?
-        auditor_selected = auditors.keys.first
-      else
-        auditor_selected = nil
-        auditors.each do |auditor, configuration|
-          auditor_nfrs = configuration['nfrs']
-          nfrs_matched = true
-          nfrs.each do |nfr, value|
-            nfrs_matched = false if not auditor_nfrs[nfr] or (auditor_nfrs[nfr] != value)
-          end
-          if nfrs_matched
-            auditor_selected = auditor
-            break
-          end
-        end
-        raise NFRMatchError.new("Could not match NFRs to an auditor") if auditor_selected.nil?
-      end
-      configuration = auditors[auditor_selected]
-      @auditor = auditor_selected
-      return @auditor, configuration
-    end
-  end
-end

data/lib/soar_auditing_provider/nfr_match_error.rb

@@ -1,4 +0,0 @@
-module SoarAuditingProvider
-  class NFRMatchError < StandardError
-  end
-end