syslog_generator 1.0.3 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10c4620e56001ee6f2df0158e5a064e16c79da04
-  data.tar.gz: d1b9cc462cf6de19e549bb033c6f5b91cb4e6d5c
+  metadata.gz: 8ea00844536286b7a35920e5fcdb297bd63aa72e
+  data.tar.gz: f7ae016391982ca2c5bcd3f6e26155194d2915e3
 SHA512:
-  metadata.gz: f40206a3bdcb212003e1e0d8051421faaaaad6520abd716485e59f3d8f4880af55eaff746f5439a477096b76cf201fb2c2a05c426945a39e6734a3128ba8b3be
-  data.tar.gz: 5d21ef9e46db1627bc616019a532d43a7763f64f56e781365ff8b50b67708e10d86bbadf1603b1c5aaafd2de20916dba925074510a321addf63532bce9c44140
+  metadata.gz: 87b95be36f0cb72f6a7e3c727738e009212ed59528feb5ab148018ad82d0b3d4ba1a9de3378f1999c7e78141c940cae6e732006bf720b65ee445c2031e06b309
+  data.tar.gz: aea3e051459c37d627172ea31cb74f0f8af60635ccd74aba2058beb770a422cfa8033a9f5ce9842dbb1b81b72214ba7c400534a93fbdf8ec8f81afffff19cd76

data/Rakefile

@@ -1,2 +1 @@
-require "bundler/gem_tasks"
-
+require 'bundler/gem_tasks'

data/bin/loggen

@@ -1,12 +1,21 @@
 #!/usr/bin/env ruby
 require 'syslog_generator'
-require 'trollop'
 require 'syslog_generator/version'
+require 'syslog_protocol'
+require 'trollop'
+
+# Drop the : from the severities hash when presenting it to the user
+valid_priorities_list = SyslogProtocol::SEVERITIES.keys.each do |k|
+  k.to_s.gsub(':', '')
+end
+
 opts = Trollop.options do
-  version "loggen #{SyslogGenerator::VERSION} - Michael Parks <mparks@tkware.info>"
+  version "loggen #{SyslogGenerator::VERSION}
+  APL, Michael Parks, TKWare Enteprises <mparks@tkware.info>"
   banner <<-EOS
 Generate random syslog lines according to the provided options.
-Absent any options, 100 lines of nonsense will be sent to the syslog port on localhost.
+Absent any options, 100 lines of nonsense will be sent to the syslog port on
+the local machine (localhost).
 
 Usage: loggen [options]
 
@@ -14,12 +23,17 @@ Where [options] can be any of the following:
   EOS
   opt :count, 'Count of lines to generate. Set to -1 for infinite.', type: Integer, default: 100
   opt :words, 'Words per line', type: Integer, default: 5
-  opt :progname, 'Program name attached to each log line', type: String, default: 'log_generator'
+  opt :name, 'Program name attached to each log line', type: String, default: 'log_generator'
   opt :test, 'Send lines to stdout rather than a remote server'
   opt :server, 'Send lines to this remote server', type: String, default: 'localhost'
   opt :facility, 'Syslog facility to use', type: String, default: 'local6'
   opt :protocol, 'TCP or UDP', type: String, default: 'udp'
   opt :port, 'Port number to send generated lines to', type: Integer, default: 514
+  opt :priority, "Message priority, must be one of: #{valid_priorities_list}", type: String, default: 'info'
+end
+
+if SyslogProtocol::SEVERITIES.keys.grep(opts[:priority]).empty?
+  Trollop.die :priority, "Must be one of #{valid_priorities_list}"
 end
 
 logger = SyslogGenerator::Logger.new(opts)

data/lib/syslog_generator.rb

@@ -1,38 +1,72 @@
-require "syslog_generator/version"
+require 'syslog_generator/version'
 require 'random-word'
 require 'syslog_protocol'
 require 'socket'
-
-# Initialize a new logger endpoint, setting up the appropriate socket from options.
+require 'pry'
+# Initialize a new logger endpoint, setting up the appropriate socket from
+# the provided options.
 module SyslogGenerator
+  # Implementation of a log formatter/sender
   class Logger
     attr_accessor :options
 
+    private
+
+    def initialize_socket(options)
+      case options[:protocol].downcase
+      when 'udp'
+        UDPSocket.new
+      when 'tcp'
+        TCPSocket.new
+      else fail 'Invalid protocol specified.'
+      end
+    end
+
+    def gen_payload(text)
+      # Syslog_protocol uses different methods for each priority
+      # (@formatter.debug, @formatter.emerg, etc) so we use .method to save the
+      # call with the appropriate name, and .call to invoke it with the right
+      # string. This won't be likely to break since we check for valid names
+      # back at options parsing.
+      meta_formatter = @formatter.method(options[:priority])
+      if text.is_a?(Array)
+        @payload = meta_formatter.call(text.join(' '))
+      else
+        @payload = meta_formatter.call(info(text))
+      end
+    end
+
+    def gen_words
+      RandomWord.nouns.take(options[:words])
+    end
+
+    public
+
     def initialize(options)
       self.options = options
-      @formatter = SyslogProtocol::Logger.new(`hostname`.strip, options[:progname], options[:facility])
-      @socket = case options[:protocol].downcase
-                when 'udp'
-                  UDPSocket.new
-                when 'tcp'
-                  TCPSocket.new
-                else fail 'Invalid protocol specified.'
-                end
+      # TODO: Won't work on systems that don't have `hostname`?
+      @formatter = SyslogProtocol::Logger.new(
+        `hostname`.strip,
+        options[:name],
+        options[:facility]
+      )
+      @socket = initialize_socket(options)
     end
 
     def send(text)
-      text.is_a?(Array) ? @payload = @formatter.info(text.join(' ')) : @payload = @formatter.info(text)
-      self.options[:test] ? puts(@payload) : @socket.send(@payload, 0, self.options[:server], self.options[:port])
+      if options[:test]
+        puts(gen_payload(text))
+      else
+        @socket.send(gen_payload(text), 0, options[:server], options[:port])
+      end
     end
 
     def start
-      if self.options[:count] != -1
-        self.options[:count].times { self.send RandomWord.nouns.take(self.options[:words]) }
+      if options[:count] != -1
+        options[:count].times { send(gen_words) }
       else
-        loop { self.send RandomWord.nouns.take(self.options[:words]) }
+        loop { send(gen_words) }
       end
     end
-
   end
 end
-

data/lib/syslog_generator/version.rb

@@ -1,3 +1,4 @@
+# Just pull in the version number (Gem defaults)
 module SyslogGenerator
-  VERSION = "1.0.3"
+  VERSION = '1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syslog_generator
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: '1.1'
 platform: ruby
 authors:
 - Michael Parks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-22 00:00:00.000000000 Z
+date: 2015-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler