loganb-scribble-client 0.0.2

data/History.txt

@@ -0,0 +1,10 @@
+== 0.0.2 2009-05-28
+
+* Changed the structure of contexts, they are now named and contain only one hash. A named context may be applied for the duration of a block
+* Set SND_BUF socket option to 24k in syslog client, supporting the sending of larger messages
+* Changed time format on SyslogClient for better compatibility
+
+== 0.0.1 2009-05-01
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,14 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/scribble-client.rb
+lib/scribble-client/scribbler.rb
+lib/scribble-client/syslog_client.rb
+scribble-client.gemspec
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_scribble_client.rb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on scribble-client, see http://scribble-client.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,48 @@
+= scribble-client
+
+* FIX (url)
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 FIXME full name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,31 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/scribble-client'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('scribble-client', ScribbleClient::VERSION) do |p|
+  p.developer('Logan Bowers', 'logan@datacurrent.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  p.url = 'http://www.example.com/'
+  p.extra_deps         = [
+    ['uuidtools','>= 1.0.7'],
+    ['collections','>= 0.1.4'],
+    ['json', '>= 1.1.3']
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/lib/scribble-client.rb

@@ -0,0 +1,10 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+Dir["#{File.dirname(__FILE__)}/scribble-client/**/*.rb"].sort.each { |lib| 
+  require lib 
+}
+
+module ScribbleClient
+  VERSION = '0.0.2'
+end

data/lib/scribble-client/scribbler.rb

@@ -0,0 +1,123 @@
+require 'collections'
+require 'uuidtools'
+require 'socket'
+require 'json'
+
+# Scribbler provides support for logging structured data via syslog.  The 
+# 
+class Scribbler
+  def self.thread_context
+    t = Thread.current
+    t[:_scribbler_context] ||= Context.new {
+      sequence_num = 0
+      {
+        :thuid => UUID.random_create.to_s,
+        :thseq => lambda { |ctx,evt|
+          sequence_num += 1
+        }
+      }
+    }
+  end
+  
+  def self.process_context
+    @proc_scribbler ||= Context.new {
+      {
+        :host => Socket.gethostname,
+        :pid => Process.pid
+      }
+    }
+  end
+  
+  #def log(string,context)
+  #  event('log',:msg => string,context)
+  #end
+  
+  def event(hash)
+    result = {}
+    #Merge data from the system-wide contexts
+    (self.class.process_context.apply_context result)
+    (self.class.thread_context.apply_context  result)
+
+    #Merge the contexts on this instance
+    @contexts.keys.reverse_each { |k|
+      ctx = @contexts[k]
+      ctx.apply_context result
+    }
+    (result.merge! hash)
+    
+    #21 == local5 facility, 6 == info priority
+    @syslogger.syslog(21,6,result.to_json)
+  end
+  
+  #
+  # Returns the context of the given name, creating a new one if it does not exist.  
+  # If a block is supplied, the context is created for the duration of the block
+  # and removed afterwards (in this case the method returns the result of the block).  
+  #
+  def context(name = :default,&block)
+    ctx = @contexts[name]
+    if(ctx.nil?)
+      delete_when_finished = true
+      @contexts[name] = ctx = Context.new
+    else
+      delete_when_finished = false
+    end
+    
+    if(block_given?)
+      begin
+        return (yield ctx)
+      ensure
+        @contexts.delete(name) if(delete_when_finished)
+      end
+    else
+      return ctx
+    end
+  end
+
+  
+  # Initializes a new Logger.  
+  #   target is a string, it is assumed to be <host>:<port> format of the target syslog server
+  #
+  def initialize(target,context = nil)
+    @syslogger = SyslogClient.new(target)
+    
+    @contexts = SequencedHash.new
+    self.context.add(context) if context
+  end
+  
+  protected 
+  
+  class Context
+    # Can optionally be initialized/reset with starting context data supplied via a block
+    #
+    def initialize(&block)
+      @contexts   = Hash.new()
+      @init_proc  = block
+      
+      reset!
+    end
+    
+    # Merges the supplied key-value pairs into the context
+    #
+    def add(hash)
+      hash.each_pair { |k,v|
+        @contexts[k] = v
+      }
+    end
+    
+    def reset!
+      @contexts.clear
+      add(@init_proc.call) if(@init_proc)
+    end
+    
+    def apply_context(target_hash)
+      @contexts.each_pair { |k,v| 
+        unless (target_hash.key? k)
+          target_hash[k] = (v.is_a? Proc) ? (v.call target_hash,self) : v 
+        end
+      }
+    end
+  end
+  
+  self.process_context
+end

data/lib/scribble-client/syslog_client.rb

@@ -0,0 +1,27 @@
+require 'socket'
+require 'time'
+
+class SyslogClient
+  
+  def initialize(server = nil)
+    raise "Don't support system logger (yet)" unless server
+    
+    (host,port) = server.split(/:/)
+    @socket = UDPSocket.new
+    @socket.connect(host,port)
+    #Allow for really big log lines
+    @socket.setsockopt(Socket::SOL_SOCKET,Socket::SO_SNDBUF,24000)
+  end
+  
+  def syslog(facility,priority,message)
+    #Build the header
+    fpnum = ((facility & 0x1F) << 3) | (priority & 0x07)
+    host = Socket.gethostname
+    tim = Time.now.strftime("%b %d %H:%M:%S")
+    #tim = Time.now.xmlschema
+    buf = "<#{fpnum}>#{tim} #{host} thetag #{message}"
+    @socket.send(buf,0)
+  end
+  
+end
+

data/scribble-client.gemspec

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{scribble-client}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Logan Bowers"]
+  s.date = %q{2009-05-28}
+  s.description = %q{FIX (describe your package)}
+  s.email = ["logan@datacurrent.com"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc"]
+  s.files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "lib/scribble-client.rb", "lib/scribble-client/scribbler.rb", "lib/scribble-client/syslog_client.rb", "scribble-client.gemspec", "script/console", "script/destroy", "script/generate", "test/test_helper.rb", "test/test_scribble_client.rb"]
+  s.homepage = %q{http://www.example.com/}
+  s.post_install_message = %q{PostInstall.txt}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{scribble-client}
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{FIX (describe your package)}
+  s.test_files = ["test/test_helper.rb", "test/test_scribble_client.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<uuidtools>, [">= 1.0.7"])
+      s.add_runtime_dependency(%q<collections>, [">= 0.1.4"])
+      s.add_runtime_dependency(%q<json>, [">= 1.1.3"])
+      s.add_development_dependency(%q<newgem>, [">= 1.3.0"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
+    else
+      s.add_dependency(%q<uuidtools>, [">= 1.0.7"])
+      s.add_dependency(%q<collections>, [">= 0.1.4"])
+      s.add_dependency(%q<json>, [">= 1.1.3"])
+      s.add_dependency(%q<newgem>, [">= 1.3.0"])
+      s.add_dependency(%q<hoe>, [">= 1.8.0"])
+    end
+  else
+    s.add_dependency(%q<uuidtools>, [">= 1.0.7"])
+    s.add_dependency(%q<collections>, [">= 0.1.4"])
+    s.add_dependency(%q<json>, [">= 1.1.3"])
+    s.add_dependency(%q<newgem>, [">= 1.3.0"])
+    s.add_dependency(%q<hoe>, [">= 1.8.0"])
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/scribble-client.rb'}"
+puts "Loading scribble-client gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/scribble-client'

data/test/test_scribble_client.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestScribbleClient < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+  
+  def test_makingasyslog
+    sc = SyslogClient.new("localhost:511")
+    
+    sc.syslog(23,1,"A syslog!!!")
+  end
+  
+  def test_makingascribbler
+    scr = Scribbler.new("lrrr.freelard.com:514")
+    
+    scr.event({:evid => 'first event'})
+    scr.event({:evid => 'second event'})
+    scr.context.reset!
+    scr.event({:evid => 'third event (local context reset)'})
+    scr.class.thread_context.reset!
+    scr.event({:evid => 'fourth event (local and thread contexts reset)'})
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification 
+name: loganb-scribble-client
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Logan Bowers
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-28 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: uuidtools
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.7
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: collections
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: FIX (describe your package)
+email: 
+- logan@datacurrent.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/scribble-client.rb
+- lib/scribble-client/scribbler.rb
+- lib/scribble-client/syslog_client.rb
+- scribble-client.gemspec
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_scribble_client.rb
+has_rdoc: false
+homepage: http://www.example.com/
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: scribble-client
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: FIX (describe your package)
+test_files: 
+- test/test_helper.rb
+- test/test_scribble_client.rb