cef 0.6.0 → 0.6.1

data/README.rdoc

@@ -1,6 +1,51 @@
 = cef
 
-Description goes here.
+This is an implementation of the Common Event Formatting standard.
+
+http://www.arcsight.com/solutions/solutions-cef/
+
+
+Included is a library implementing a formatter/emitter and a client program
+that can be called from a shell script or some other external source. The
+library currently hardcodes the syslog format|priority if you choose to send
+vi UDP to a receiver.
+
+Most of the standard dictionary is implemented.
+http://www.arcsight.com/collateral/CEFstandards.pdf
+
+== Example API Usage
+
+
+    # instantiate a sender object
+    sender=CEF::Sender.new(
+        :receiver=>"loghost.mycompany.com",
+        :eventDefaults=>{
+            :deviceProduct => "MySnazzyLogger",
+            :deviceVendor  => "My Company"
+        }
+      )
+    # instantiate an event
+    event=CEF::Event.new(
+    :sourceAddress      => "192.168.1.1",
+    :destinationAddress => "192.168.1.2",
+    :name               => "i think something happened"
+    )
+
+    # fire away!
+    sender.emit(e)
+
+== Example client usage
+
+  cef_sender --receiver="myloghost.company.com"\
+            --deviceProduct="MySnazzyLogger"   \
+            --deviceVendor="My Company"        \
+            --sourceAddress="192.168.1.1"      \
+            --destinationAddress="192.168.1.2" \
+            --name="i think something happened"
+
+To see the supported event attributes:
+
+  cef_sender --schema
 
 == Contributing to cef
  

data/Rakefile

@@ -15,13 +15,10 @@ Jeweler::Tasks.new do |gem|
   gem.name = "cef"
   gem.homepage = "http://github.com/ryanbreed/cef"
   gem.license = "MIT"
-  gem.summary = %Q{CEF Generation }
-  gem.description = %Q{Library and client }
+  gem.summary = %Q{ CEF Generation Library and Client }
+  gem.description = %Q{ format/send CEF logs via API+syslog or client program }
   gem.email = "opensource@breed.org"
   gem.authors = ["Ryan Breed"]
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  #gem.add_runtime_dependency 'escape', '~> 0.0.4'
   gem.add_development_dependency 'rspec', '~> 2.3.0'
   gem.files.include('VERSION')
 end

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.6.1

data/spec/cef_spec.rb

@@ -2,18 +2,11 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "CEF Event Format" do
   it "should output a preamble" do
-    test_prefix_vals={
-      :deviceVendor       => "breed",
-      :deviceProduct      => "CEF Sender",
-      :deviceVersion      => "0.1",
-      :deviceEventClassId => "0:debug",
-      :name               => "test",
-      :deviceSeverity     => "1"
-    }
+    prefix_vals=test_prefix_vals
     e=CEF::Event.new
-    test_prefix_vals.each {|k,v| e.send("%s="%k,v) }
+    prefix_vals.each {|k,v| e.send("%s="%k,v) }
     s=CEF::Sender.new
-    formatted=CEF::PREFIX_FORMAT % [ 131, *test_prefix_vals.values ]
-    s.format_event(e) ==formatted
+    formatted=CEF::PREFIX_FORMAT % [ 131, *prefix_vals.values ]
+    s.format_event(e)==formatted
   end
 end

data/spec/spec_helper.rb

@@ -10,3 +10,14 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 RSpec.configure do |config|
   
 end
+
+def test_prefix_vals
+  test_prefix_vals={
+    :deviceVendor       => "breed",
+    :deviceProduct      => "CEF Sender",
+    :deviceVersion      => "0.1",
+    :deviceEventClassId => "0:debug",
+    :name               => "test",
+    :deviceSeverity     => "1"
+  }
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cef
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: 
   segments: 
   - 0
   - 6
-  - 0
-  version: 0.6.0
+  - 1
+  version: 0.6.1
 platform: ruby
 authors: 
 - Ryan Breed
@@ -96,7 +96,7 @@ dependencies:
   prerelease: false
   type: :development
   requirement: *id005
-description: "Library and client "
+description: " format/send CEF logs via API+syslog or client program "
 email: opensource@breed.org
 executables: 
 - cef_sender
@@ -114,7 +114,6 @@ files:
 - Rakefile
 - VERSION
 - bin/cef_sender
-- cef.gemspec
 - lib/cef.rb
 - spec/cef_spec.rb
 - spec/spec_helper.rb
@@ -151,7 +150,7 @@ rubyforge_project:
 rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
-summary: CEF Generation
+summary: CEF Generation Library and Client
 test_files: 
 - spec/cef_spec.rb
 - spec/spec_helper.rb

data/cef.gemspec

@@ -1,69 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{cef}
-  s.version = "0.6.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Ryan Breed"]
-  s.date = %q{2011-02-20}
-  s.default_executable = %q{cef_sender}
-  s.description = %q{Library and client }
-  s.email = %q{opensource@breed.org}
-  s.executables = ["cef_sender"]
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-    ".rspec",
-    "Gemfile",
-    "LICENSE.txt",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "bin/cef_sender",
-    "cef.gemspec",
-    "lib/cef.rb",
-    "spec/cef_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/ryanbreed/cef}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.5.2}
-  s.summary = %q{CEF Generation}
-  s.test_files = [
-    "spec/cef_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
-    else
-      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
-    end
-  else
-    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
-  end
-end
-