snoopit 0.0.1

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/snoopit

@@ -0,0 +1,173 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'logger'
+require 'snoopit'
+
+options = {}
+options[:snoopies_file]='snoopies.json'
+options[:snoopies] = []
+options[:verbose] = false
+options[:line_numbers] = false
+options[:new_line] = true
+options[:json] = false
+options[:pretty_json] = false
+options[:notifications] = false
+options[:tracking] = false
+options[:tracking_file] = './snoopit_db.json'
+
+OptionParser.new do |opts|
+
+  opts.banner = 'Usage: snoopit [options]'
+
+  opts.on('-s', '--snoopers snoopies.json', 'File contains one or more regular expressions to locate a line of interest in a file' ) do |snoopies_file|
+    options[:snoopies_file] = snoopies_file
+  end
+
+  opts.on('-S', '--snooper snooper_name', 'Only use the named snooper. This option can be used more than once to use several snoopers.' ) do |snooper|
+    options[:snoopies] << snooper
+  end
+
+  opts.on('-t', '--template', 'Generate a template snoopies.json file to stdout' ) do
+    template = File.expand_path '../../support/snoopies.json', __FILE__
+    File.readlines(template).each do |line|
+      puts line
+    end
+    exit
+  end
+
+  opts.on('-T', '--tracking', 'Enable log file tracking using file ./snoopit_db.json') do
+    options[:tracking] = true
+  end
+
+  opts.on('-f', '--tracking-file file_name', 'Specify a different tracking file name and location instead of the default ./snoopit_db.json') do |tracking_file|
+    options[:tracking] = true
+    options[:tracking_file] = tracking_file
+  end
+
+  opts.on('-j', '--json', 'Generate output in json' ) do
+    options[:json]  = true
+  end
+
+  opts.on('-J', '--pretty-json', 'Generate output in pretty json' ) do
+    options[:json]  = true
+    options[:pretty_json] = true
+  end
+
+  opts.on('-N', '--no-newline', 'Do not output new line between found items' ) do |l|
+    options[:new_line] = false
+  end
+
+  opts.on('-n', '--enable-notifications', 'Enable notifications' ) do |n|
+    options[:notifications] = true
+  end
+
+  opts.on('-l', '--line-numbers', 'show line numbers' ) do |l|
+    options[:line_numbers] = true
+  end
+
+  opts.on_tail('-v', '--verbose', 'prints out file name, matched line number') do
+    options[:verbose] = true
+  end
+
+  opts.on_tail('-h', '--help') do
+    puts opts
+    exit
+  end
+
+end.parse!
+
+def verbose(snoopy_name, sniffed)
+  puts ''
+  puts "File: #{sniffed.file}"
+  puts "Snooper: #{snoopy_name}"
+  puts "Match at line number: #{sniffed.line_no}"
+  puts "** Sniffed Out ** #{sniffed.match}"
+  puts ''
+end
+
+def get_start_line_number(sniffed)
+  start = sniffed.line_no - sniffed.after.size
+  start = 1 if start <= 0
+  start
+end
+
+def line_before(line_no, sniffed)
+  sniffed.before.register.each do |b|
+    unless b.nil?
+      puts "#{line_no}: #{b}"
+      line_no += 1
+    end
+  end
+  line_no
+end
+
+def line_after(line_no, sniffed)
+  sniffed.after.register.each do |a|
+    unless a.nil?
+      puts "#{line_no}: #{a}"
+      line_no += 1
+    end
+  end
+  line_no
+end
+
+def line_numbers(sniffed)
+  line_no = get_start_line_number sniffed
+  line_no = line_before line_no, sniffed
+  puts "#{line_no}: #{sniffed.match}"
+  line_no += 1
+  line_after line_no, sniffed
+end
+
+def no_line_numbers(sniffed)
+  sniffed.before.register.each {|b| puts b unless b.nil? }
+  puts sniffed.match
+  sniffed.after.register.each {|a| puts a unless a.nil? }
+end
+
+def dump_lines(snoopies, newline, line_no, is_verbose)
+  snoopies.each do |snoopie|
+    snoopie.sniffers.each do |sniffer|
+      sniffer.sniffed.each do |sniffed|
+        verbose snoopie.name, sniffed if is_verbose
+        line_no ? line_numbers(sniffed) : no_line_numbers(sniffed)
+        puts '' if newline
+      end
+    end
+  end
+end
+
+def dump_json(snoopies, pretty=false)
+  if pretty
+    puts JSON.pretty_generate snoopies
+  else
+    puts snoopies.to_json
+  end
+end
+
+if options[:tracking]
+  puts "File tracking database: #{options[:tracking_file]}"
+else
+  options[:tracking_file] = nil
+end
+
+unless File.exist? options[:snoopies_file]
+  puts "Snooper json file does not exist: #{options[:snoopies_file]}"
+  exit 1
+end
+
+#debug_file = File.open(File.expand_path('../../tmp/debug.log', __FILE__), 'w+')
+#snooper = Snoopit::Snooper.new options[:notifications], options[:tracking_file], debug_file, ::Logger::DEBUG
+#snooper = Snoopit::Snooper.new options[:notifications], options[:tracking_file], STDOUT, ::Logger::DEBUG
+snooper = Snoopit::Snooper.new options[:notifications], options[:tracking_file]
+snooper.load_file options[:snoopies_file]
+snoopies = snooper.snoop  options[:snoopies]
+if options[:json]
+  dump_json snoopies, options[:pretty_json]
+else
+  dump_lines snoopies, options[:new_line], options[:line_numbers], options[:verbose]
+end
+
+
+
+

data/lib/snoopit.rb

@@ -0,0 +1,22 @@
+require 'snoopit/version'
+require 'snoopit/logger'
+require 'snoopit/register'
+require 'snoopit/snooper'
+require 'snoopit/snoopy'
+require 'snoopit/sniffer'
+require 'snoopit/detected'
+require 'snoopit/file_info'
+require 'snoopit/file_tracker'
+require 'snoopit/notification_manager'
+require 'snoopit/notifier'
+require 'snoopit/notifiers/email'
+require 'snoopit/notifiers/http'
+require 'snoopit/notifiers/https'
+
+module Snoopit
+
+  def self.logger
+    Snoopit::Logging.logger
+  end
+
+end

data/lib/snoopit/detected.rb

@@ -0,0 +1,50 @@
+module Snoopit
+  class Detected
+
+    attr :comment, :before, :after, :after_count, :regexp, :match, :finished, :file, :line_no
+
+    def initialize(comment, pre_before, after, match, file, line_no)
+      setup_before pre_before
+      @comment     = comment
+      @after_count = 0
+      @after       = Register.new(after)
+      @match       = match
+      @file        = file
+      @line_no     = line_no
+      @finished    = false
+    end
+
+    def setup_before(pre_before)
+      @before = Register.new pre_before.size, pre_before.register
+    end
+
+    def track(line)
+      return if line == @match
+      if @after_count < @after.size
+        @after.push_front line
+        @after_count += 1
+      else
+        @finished = true
+      end
+    end
+
+    def finished?
+      @finished
+    end
+
+    def as_json(options=nil)
+      {
+          after: @after,
+          match: @match,
+          before: @before,
+          file: @file,
+          line_no: @line_no
+      }
+    end
+
+    def to_json(*a)
+      as_json.to_json(*a)
+    end
+
+  end
+end

data/lib/snoopit/file_info.rb

@@ -0,0 +1,104 @@
+require 'time'
+
+module Snoopit
+    class FileInfo
+
+      attr_accessor :file, :line_no, :offset, :size, :mtime, :last_line, :init_stat
+
+      def initialize(file=nil)
+        @file = file
+        @line_no = 0
+        @offset = 0
+        @size = 0
+        @mtime = nil
+        @last_line = nil
+        @init_stat = true
+      end
+
+      # Update file Info if the file has changed use the file handle to move the file pointer
+      # to the character where reading will start
+      #
+      # @return [boolean] true if updated false not updated
+      def updated?(file_handle)
+        c_stat = File.stat @file
+        if (c_stat.size == @size) && (c_stat.mtime.to_i == @mtime.to_i) && (! @init_stat)
+          Snoopit.logger.debug 'FileTracker.updated? file has not changed: ' + @file
+          updated = false
+        elsif c_stat.size < @size
+          Snoopit.logger.debug 'FileTracker.updated? file size is smaller it is a new new file: ' + @file
+          updated = new_file? file_handle, c_stat
+        elsif (c_stat.size == @size) && (! @mtime.nil?) && (c_stat.mtime.to_i > @mtime.to_i)
+          Snoopit.logger.debug 'FileTracker.updated? file size is same but file time is newer it is a new file: ' + @file
+          updated = new_file? file_handle, c_stat
+        else
+          Snoopit.logger.debug 'FileTracker.updated? reading from last read location: ' + @file
+          updated = read_from_last? file_handle, c_stat
+        end
+        @init_stat = false
+        updated
+      end
+
+      def new_file?(file_handle, stat)
+        # seek to 0
+        Snoopit.logger.debug 'FileTracker.updated? file new read from start of file: ' + @file
+        @offset = 0
+        @size = stat.size
+        @mtime = stat.mtime
+        @last_line = nil
+        file_handle.seek 0, IO::SEEK_SET
+        true
+      end
+
+      def read_from_last?(file_handle, stat)
+        # seek to last position + 1
+        old_size = @size
+        @size = stat.size
+        @mtime = stat.mtime
+        Snoopit.logger.debug "File pointer at byte: #{file_handle.tell}"
+        file_handle.seek old_size, IO::SEEK_SET
+        Snoopit.logger.debug "Starting read from byte: #{file_handle.tell} destination byte #{old_size} new size #{@size}"
+        true
+      end
+
+      def get_last_line(file_handle)
+        line = nil
+        unless @last_line.nil?
+          Snoopit.logger.debug "File point at byte: #{file_handle.tell}"
+          file_handle.seek (-@last_line.bytesize), IO::SEEK_END
+          Snoopit.logger.debug "Seeked to byte: #{file_handle.tell}"
+          line = file_handle.readline
+        end
+        line
+      end
+
+      def as_json(*)
+        {
+            file: @file,
+            line_no: @line_no,
+            offset: @offset,
+            size: @size,
+            mtime: @mtime.iso8601,
+            last_line: @last_line
+        }
+      end
+
+      def to_json(*args)
+        as_json.to_json(*args)
+      end
+
+      def from_json(json_str)
+        from_hash JSON.parse(json_str)
+      end
+
+      def from_hash(hash)
+        @file = hash['file']
+        @line_no = hash['line_no']
+        @offset = hash['offset']
+        @size = hash['size']
+        @mtime = Time.parse hash['mtime']
+        @last_line = hash['last_line']
+        @init_stat = false
+      end
+
+    end
+end

data/lib/snoopit/file_tracker.rb

@@ -0,0 +1,83 @@
+module Snoopit
+  class FileTracker
+
+    attr_accessor :files, :db_file
+
+    def initialize(db_file='./snooper_db.json', remove=false)
+      @files = { }
+      @db_file = db_file
+      if remove
+        remove_db @db_file
+      else
+        load_db @db_file
+      end
+    end
+
+    def foreach(file, &block)
+      file_info = get_file(file)
+      unless file_info.nil?
+        read_lines(file_info, block)
+        save_db @db_file
+      end
+    end
+
+    def get_file(file)
+      return nil unless File.exist? file
+      @files[file] = FileInfo.new(file) if @files[file].nil?
+      @files[file]
+    end
+
+    def read_lines(file_info, block)
+      begin
+        fh = File.new(file_info.file)
+        if file_info.updated? fh
+          fh.each_line do |line|
+            file_info.offset += line.bytesize
+            file_info.line_no += 1
+            file_info.last_line = line
+            block.call line, file_info.line_no
+          end
+        end
+      ensure
+        fh.close
+      end
+    end
+
+    def load_db(db_file)
+      if (! db_file.nil?) && (File.exist? db_file)
+        Snoopit.logger.debug 'Loading from db file: ' + db_file
+        hash_db = JSON.parse(IO.read db_file)
+        hash_db.each do |key, file_info|
+          unless file_info.nil?
+            fi = FileInfo.new
+            fi.from_hash(file_info)
+            @files[key] = fi
+          end
+        end
+      end
+    end
+
+    def save_db(db_file)
+      unless  db_file.nil?
+        File.open db_file, 'w' do |f|
+          f.write @files.to_json
+        end
+      end
+    end
+
+    def remove_db(db_file)
+      if (! db_file.nil?) && (File.exist? db_file)
+        File.delete db_file
+      end
+    end
+
+    def as_json(*)
+      { files: @files  }
+    end
+
+    def to_json(*args)
+      as_json.to_json(*args)
+    end
+
+  end
+end

data/lib/snoopit/logger.rb

@@ -0,0 +1,30 @@
+require 'logger'
+require 'awesome_print'
+
+module Snoopit
+  module Logging
+
+    LEVEL_MAP = {
+        info: ::Logger::INFO,
+        warn: ::Logger::WARN,
+        error: ::Logger::ERROR,
+        fatal: ::Logger::FATAL,
+        debug: ::Logger::DEBUG
+    }
+
+    def self.create_logger(out=STDOUT, level=::Logger::INFO)
+      @logger = ::Logger.new(out)
+      @logger.level = level
+      @logger
+    end
+
+    def self.logger
+      @logger || create_logger
+    end
+
+    def logger
+      Snoopit::Logging.logger
+    end
+
+  end
+end