snoopit 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 773c96a6cce42a924a16de8a09d32981180fb570
-  data.tar.gz: e150e7960bad252b7707abd10775fdc748226f39
+  metadata.gz: 988a42e05de998211eac2a93a6c6692c320369be
+  data.tar.gz: 9fad23966cbbe1a33ab254a5f55b2d4960ecdbba
 SHA512:
-  metadata.gz: c73e43dd072abdbdef14e56ab28ae096c3beeca3d8bfc7dd9de1dbd0929b57af194882f49e2dc279d674fdf0d6d2ea70805b0756ddb3da6876656ae4217b5404
-  data.tar.gz: e80aa3bf4c634cfb6cd35adcec8d6009af9ecb141a04f8aa1aaac5c583dcece65b62f20dd90b14e062995132fa97362ebc6a82abe2880ab72bf86b4f9ae4b074
+  metadata.gz: 9c7b97959b9e5f0ec282990567eef77141da2cc06f4be52fa21065afc848039737069fa8c4febdbb72a32a1be936a291f48bb5d24928e717965942edea4ca430
+  data.tar.gz: b230a55bf4487df00f0fb36d3a377b8b7ad7c7ff57d483f54ff99f23080ae2befd0453efd32e43172782338e94ff5a104dcb50336026f525038d4010ba4d88a8

data/.travis.yml

@@ -1,6 +1,9 @@
 language: ruby
 
+bundler_args: --without debug
+
 rvm:
+  - 1.9.3
   - 2.0.0
   - 2.1.0
 

data/Gemfile

@@ -3,9 +3,12 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in snoopit.gemspec
 gemspec
 
+group :debug do
+  gem 'pry', '~> 0.9.12.6', require: false
+  gem 'pry-byebug', '~> 1.3.0', require: false
+end
+
 group :test, :development do
-  gem 'pry', '~> 0.9.12.6'
-  gem 'pry-byebug', '~> 1.3.0'
   gem 'coveralls', :require => false
 end
 

data/lib/snoopit.rb

@@ -13,6 +13,7 @@ require 'snoopit/notifiers/email'
 require 'snoopit/notifiers/http'
 require 'snoopit/notifiers/https'
 
+# Snoops files for a matching regular expressions and generates subscribed events
 module Snoopit
 
   def self.logger

data/lib/snoopit/detected.rb

@@ -1,8 +1,11 @@
 module Snoopit
+
+  # When the sniffer detects a match it saves the contextual information in a +Detected+ instances
   class Detected
 
     attr :comment, :before, :after, :after_count, :regexp, :match, :finished, :file, :line_no
 
+    # These are parameters from the match
     def initialize(comment, pre_before, after, match, file, line_no)
       setup_before pre_before
       @comment     = comment
@@ -14,10 +17,12 @@ module Snoopit
       @finished    = false
     end
 
+    # Get the lines before the found match
     def setup_before(pre_before)
       @before = Register.new pre_before.size, pre_before.register
     end
 
+    # This collects the lines after a match is found
     def track(line)
       return if line == @match
       if @after_count < @after.size

data/lib/snoopit/file_info.rb

@@ -1,6 +1,8 @@
 require 'time'
 
 module Snoopit
+
+    # Holds and manages the file read information
     class FileInfo
 
       attr_accessor :file, :line_no, :offset, :size, :mtime, :last_line, :init_stat
@@ -18,6 +20,7 @@ module Snoopit
       # Update file Info if the file has changed use the file handle to move the file pointer
       # to the character where reading will start
       #
+      # @param file_handle [File]
       # @return [boolean] true if updated false not updated
       def updated?(file_handle)
         c_stat = File.stat @file
@@ -38,6 +41,7 @@ module Snoopit
         updated
       end
 
+      # This is a new file reset or start reading from the beginning
       def new_file?(file_handle, stat)
         # seek to 0
         Snoopit.logger.debug 'FileTracker.updated? file new read from start of file: ' + @file
@@ -49,6 +53,7 @@ module Snoopit
         true
       end
 
+      # Continue reading from last location, which maybe on new file on initialization
       def read_from_last?(file_handle, stat)
         # seek to last position + 1
         old_size = @size
@@ -60,6 +65,7 @@ module Snoopit
         true
       end
 
+      # Get the last line of the file
       def get_last_line(file_handle)
         line = nil
         unless @last_line.nil?

data/lib/snoopit/file_tracker.rb

@@ -1,4 +1,8 @@
 module Snoopit
+
+  # Used to track file locations of the last requested snoops per +snooper.json+
+  # This is handy for repeated invocations via +cron+ so that the snooper does not send repeated notifications
+  # This is a very simple json file with **NO** concurrency.
   class FileTracker
 
     attr_accessor :files, :db_file
@@ -13,6 +17,7 @@ module Snoopit
       end
     end
 
+    # Used to start reading lines from the last read invocation
     def foreach(file, &block)
       file_info = get_file(file)
       unless file_info.nil?
@@ -21,12 +26,14 @@ module Snoopit
       end
     end
 
+    # Get the last read file information
     def get_file(file)
       return nil unless File.exist? file
       @files[file] = FileInfo.new(file) if @files[file].nil?
       @files[file]
     end
 
+    # Used to start reading lines from the last read invocation
     def read_lines(file_info, block)
       begin
         fh = File.new(file_info.file)

data/lib/snoopit/logger.rb

@@ -2,8 +2,11 @@ require 'logger'
 require 'awesome_print'
 
 module Snoopit
+
+  # Snoopis Logging Wrapper
   module Logging
 
+    # Maps standard logger constants to symbols
     LEVEL_MAP = {
         info: ::Logger::INFO,
         warn: ::Logger::WARN,

data/lib/snoopit/notification_manager.rb

@@ -1,5 +1,6 @@
 module Snoopit
 
+  # Instantiates all specified +Notifiers+
   class NotificationManager
 
     attr :active, :config
@@ -10,6 +11,7 @@ module Snoopit
       load_default_notifiers unless @config.nil?
     end
 
+    # Load default notifiers and configured notifiers
     def load_notifier_config(config)
       @config = config
       load_default_notifiers
@@ -17,12 +19,16 @@ module Snoopit
       load_files(load) unless load.nil?
     end
 
+    # Register the specified +Notifier+
+    # @param notifier [Notifier]
     def register(notifier)
       raise NameError.new "Notifier missing valid name: #{notifier.inspect}" if notifier.name.nil?
       Snoopit.logger.debug "Registering notifier #{notifier.name}"
       @active[notifier.name] = notifier
     end
 
+    # Unregister the specified +Notifier+
+    # @param notifier [Notifier]
     def unregister(notifier)
       self.unregister_by_name notifier.name
     end
@@ -35,6 +41,8 @@ module Snoopit
       @active[name]
     end
 
+    # Invoke all notifications that this list of snoopies is subscribed to via the +snooper.json+
+    # @param snoopies [Snoopy]
     def notify(snoopies)
       snoopies.each do |snoopy|
         snoopy.sniffers.each do |sniffer|
@@ -43,6 +51,8 @@ module Snoopit
       end
     end
 
+    # Snoopies use sniffers that may or may not be associated with a notifier
+    # @param sniffer [Sniffer]
     def sniffer_notify(sniffer)
       messages = get_sniffed_messages sniffer
       sniffer.notifiers.each do |key, value|

data/lib/snoopit/notifiers/stomp.rb

@@ -2,6 +2,7 @@ require 'stomp'
 require 'awesome_print'
 
 module Snoopit
+  # Notifiers belong to this module
   module Notifiers
 
     class Stomp < Snoopit::Notifier

data/lib/snoopit/sniffer.rb

@@ -1,8 +1,12 @@
 module Snoopit
+
+  # Does the actual searching for the given regular expression
   class Sniffer
 
     attr :pre_before, :before, :after, :comment, :regexp, :sniffed, :notifiers
 
+    # This creates a +Sniffer+ which was specified in the +snoopers.json+ file in the +sniffers+ section
+    # @param sniffer_params [Hash] this is a hash from the +snoopers.json+ file in the +sniffers+ section for the assciated +Snoopy+
     def initialize(sniffer_params)
       @before  = sniffer_params['lines']['before'].nil? ? 2 : sniffer_params['lines']['before']
       @pre_before = Register.new @before
@@ -14,10 +18,16 @@ module Snoopit
       @sniffed = []
     end
 
+    # Set up the specified notifier parameters
+    # @param params [Hash] this is a hash from the +snoopers.json+ file in the +notify+ section for the  associated +Sniffer+
     def setup_notifiers(params)
       @notifiers = params['notify'] unless params['notify'].nil?
     end
 
+    # This sniffer tracks through a file until it detects a match
+    # @param file [String] file the +sniffer+ is tracking
+    # @param line_no [Integer] line number the +sniffer+ is tracking
+    # @param  line [String] line the +sniffer+ is tracking
     def track(file, line_no, line)
       matched = @regexp.match(line) do |m|
         @sniffed << Detected.new(@comment, @pre_before, @after, line, file, line_no)
@@ -26,6 +36,8 @@ module Snoopit
       tracking line
     end
 
+    # This is tracking the lines after the match
+    # The +Detected+ instance will let us know when we are finished collecting lines
     def tracking(line)
       @sniffed.each do |detected|
         detected.track line unless detected.finished?

data/lib/snoopit/snooper.rb

@@ -1,11 +1,19 @@
 require 'json'
 module Snoopit
+
+  # Coordinates activities between the +NotificationManager+ the +Snoopies+ their
+  # +Sniffers+ and the +FileTracker+
   class Snooper
 
+    # +snoopies+ table of +Snoopy+ instances that snoop files
+    # +notifier+ +NotificationManager+ manages distributing notifications
+    # +file_tracker+
     attr_accessor :snoopies, :notifier, :file_tracker
 
     # Snoopies are the list of available named snoopers
-    # Snoopers are the current active invocations of selected snoopies
+    # @param [boolean #notifications] generate notifications
+    # @param [String #db_file] used for file tracking
+    # @param [Logger #logger] use  the passed in logger
     def initialize(notifications=true, db_file=nil, logger=nil, log_level=::Logger::INFO)
       @snoopies = { }
       @file_tracker = FileTracker.new db_file unless db_file.nil?
@@ -42,19 +50,29 @@ module Snoopit
       raise ArgumentError.new 'There are no Snoopies in the JSON Snooper ' if @snoopies.size == 0
     end
 
+    # Load notifiers from the +notifiers+ section
+    # @param json_hash [Hash]
     def load_notifiers(json_hash)
       @notifier.load_notifier_config json_hash['notifiers'] unless @notifier.nil?
     end
 
+    # Register the given +notifier+ that inherits from the +Notifier+ class and implements the
+    # +notify+ method
+    # @params notifier [Notifier]
     def register_notifier(notifier)
       @notifier.register notifier
     end
 
+    # Unegister the given +notifier+ that inherits from the +Notifier+ class and implements the
+    # +notify+ method
+    # @params notifier [Notifier]
     def unregister_notifier(notifier)
       @notifier.unregister notifier
     end
 
-    # Use the snoopies and start snooping
+    # Start the snooping files. If a list of names are given then the only the snoopies in the
+    # list will be used
+    # @param names [Array] - an array of string names
     def snoop(names=[])
       snoopers = get_snoopers names
       snoopers.each do |snoopy|
@@ -68,6 +86,8 @@ module Snoopit
       snoopers
     end
 
+    # Get all the snoopers or only the named snoopers
+    # @param names [Array] - an array of string names
     def get_snoopers(names=[])
       snoopers = []
       use_names = (names.size == 0 ? false : true)
@@ -81,6 +101,8 @@ module Snoopit
       snoopers
     end
 
+    # Have the given +snoopy+ sniff the files in its specified directory
+    # @param snoopy [Snoopy] - current active snoopy
     def snoop_dir(snoopy)
       Snoopit.logger.debug "Snooping directory: #{snoopy.dir}"
       get_files(snoopy).each do |file|
@@ -89,6 +111,8 @@ module Snoopit
       end
     end
 
+    # Get the files the +snoopy+ must sniff out for information
+    # @param snoopy [Snoopy] - current active snoopy
     def get_files(snoopy)
       if snoopy.glob?
         files = get_glob_list snoopy
@@ -98,6 +122,8 @@ module Snoopit
       files
     end
 
+    # Get the files that match the glob expression so the +snoopy+ can snoop the files
+    # @param snoopy [Snoopy] - current active snoopy
     def get_glob_list(snoopy)
       Snoopit.logger.debug "Snooping glob: #{snoopy.glob}"
       cwd = Dir.getwd
@@ -110,17 +136,24 @@ module Snoopit
       files
     end
 
+    # Get the files that match the glob expression so the +snoopy+ can snoop the files
+    # @param snoopy [Snoopy] - current active snoopy
     def get_file_list(snoopy)
       Snoopit.logger.debug "Snooper directory: #{snoopy.dir}"
       Dir.entries snoopy.dir
     end
 
+    # Have the +snoopy+ snoop a file
+    # @param snoopy [Snoopy] - current active snoopy
     def snoop_file(snoopy)
       raise ArgumentError.new "Could find file #{snoopy.input}" unless File.exist? snoopy.input
       Snoopit.logger.debug "Snooping file: #{snoopy.input} with snoopy: #{snoopy.name}"
       sniff_it snoopy, snoopy.input
     end
 
+    # Have the +snoopy+ sniff a file for
+    # @param snoopy [Snoopy] - current active snoopy
+    # @param file_name [String] - file to be snooped
     def sniff_it(snoopy, file_name)
       Snoopit.logger.debug "Sniffing file: #{file_name} with snoopy: #{snoopy.name}"
       unless @file_tracker.nil?
@@ -130,12 +163,18 @@ module Snoopit
       end
     end
 
+    # Have the +snoopy+ sniff a file that is being tracked
+    # @param snoopy [Snoopy] - current active snoopy
+    # @param file_name [String] - file to be snooped
     def file_track_read(snoopy, file_name)
       @file_tracker.foreach file_name do |line, line_no|
         snoopy.sniff snoopy.input, line_no, line
       end
     end
 
+    # Have the +snoopy+ sniff a file
+    # @param snoopy [Snoopy] - current active snoopy
+    # @param file_name [String] - file to be snooped
     def file_read(snoopy, file_name)
       line_no = 0
       File.foreach file_name do |line|

data/lib/snoopit/snoopy.rb

@@ -1,8 +1,13 @@
 module Snoopit
+
+  # Snoops around the specified file or directory of files
   class Snoopy
 
     attr :name, :input, :output, :dir, :glob, :sniffers
 
+    # This creates a +Snoopy+ which was specified in the +snoopers.json+ file in the +snoopers+ section
+    # @param name [String] the name of the snoopy
+    # @param params [Hash] this is a hash from the +snoopers.json+ file in the +snoopers+ section for this +Snoopy+
     def initialize(name, params)
       @name = name
       @output = params['output']
@@ -12,21 +17,28 @@ module Snoopit
       setup_sniffers params
     end
 
+    # Get the name of the file to snoop if specified
+    # @param params [Hash] this is a hash from the +snoopers.json+ file in the +snoopers+ section for this +Snoopy+
     def setup_input(params)
       @input = params['snoop']
     end
 
+    # Get the name of the directory to snoop if specified
+    # @param params [Hash] this is a hash from the +snoopers.json+ file in the +snoopers+ section for this +Snoopy+
     def setup_dir(params)
       @dir = params['dir']['path']
       @glob = params['dir']['glob']
     end
 
+    # Ensure we have something to snoop
     def input_check?
       return true unless @input.nil?
       return true unless @dir.nil?
       raise ArgumentError.new('Snooper JSON must contain either an input or dir parameter')
     end
 
+    # Create the specified sniffers
+    # @param params [Hash] this is a hash from the +snoopers.json+ file in the +sniffers+ section for this +Snoopy+
     def setup_sniffers(params)
       raise ArgumentError.new('Snooper JSON missing sniffers array') if params['sniffers'].nil?
       @sniffers = []
@@ -43,6 +55,10 @@ module Snoopit
       ! @glob.nil?
     end
 
+    # Sniff specified line which is from the named file
+    # param file [String] file +Snoopy+ is sniffing
+    # param line_no [Integer] line_n0 +Snoopy+ is sniffing
+    # param line [String] line +Snoopy+ is sniffing
     def sniff(file, line_no, line)
       @sniffers.each do |sniffer|
         sniffer.track file, line_no, line

data/lib/snoopit/version.rb

@@ -1,3 +1,3 @@
 module Snoopit
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/snoopit.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Robert Birch']
   spec.email         = ['robdbirch@gmail.com']
   spec.description   = %q{Snoops files for specified information via a simple configuration file}
-  spec.summary       = %q{Using regular expressions snoops files or directories for specific information. Sends events and tracks repeated invocations as not to send repeat events}
+  spec.summary       = %q{Simple tool for monitoring process log files for specified events and then generating basic notifications. This is an extensible and data driven solution. It provides a single location to manage log scraping duties.}
   spec.homepage      = 'https://github.com/robdbirch/snoopit/blob/master/README.md'
   spec.license       = 'MIT'
 
@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>=1.9.3', '<3.0'
+
   spec.add_runtime_dependency 'awesome_print', '~> 1.2'
   spec.add_runtime_dependency 'stomp', '~> 1.3'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snoopit
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Robert Birch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-28 00:00:00.000000000 Z
+date: 2014-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -155,7 +155,10 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -166,8 +169,9 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Using regular expressions snoops files or directories for specific information.
-  Sends events and tracks repeated invocations as not to send repeat events
+summary: Simple tool for monitoring process log files for specified events and then
+  generating basic notifications. This is an extensible and data driven solution.
+  It provides a single location to manage log scraping duties.
 test_files:
 - spec/bin/snoopit_spec.rb
 - spec/file_info_spec.rb
@@ -188,3 +192,4 @@ test_files:
 - spec/support/snoopies_notifiers.json
 - spec/support/test_notifier.rb
 - spec/support/test_notifier_load.rb
+has_rdoc: