tailnudge 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab69ad2210a335582f7fa11008dc199776e0dfdf
+  data.tar.gz: 054f6f3e889ce45b0bc0d50a3517b2ab32b51bed
+SHA512:
+  metadata.gz: c81f070a7013d46549e220b8f1554473102436b12274c91cfb842989bb93265380b094092f2f3bb4fc72f96f1bf10a8163c6a39cd1af887478c93c450ef3b4df
+  data.tar.gz: 867cfb067b7b831e5bfb6f4b035a87712054a4f1b96c4a82d9e2163befbf8f957f70bf9d626d4e7fe885e23bc821c37a245cd22293f0c29ef85af9443137cf94

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-version

@@ -0,0 +1 @@
+2.1.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tailnudge.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TODO: Write your name
+
+MIT License
+
+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/README.md

@@ -0,0 +1,63 @@
+# Tailnudge
+
+Utility to send OSX notifications while tailing one or more files for
+pattern matches.
+
+Useful if you'd like to be notified when, eg, a log displays a
+deprecation or error notice during development.
+
+## Installation
+
+
+```sh
+$ gem install tailnudge
+```
+
+## Usage
+
+See:
+
+```sh
+$ tailnudge help tail
+```
+
+## Examples
+
+Tail a log and look for lines that include "DEPRECATION" or
+"DEPRECATED", and play the "Tink" sound.
+
+```sh
+$ tailnudge log/development.log -p deprecat -t 'My App' -s Tink
+```
+
+Note that patterns are case-insensitive and that only one notification
+per pattern will be displayed at a time (to prevent inadvertent event
+flooding) unless you use the `--all`/`-a` option.
+
+Notify Rails HTTP 200 request times, without throttling:
+
+```sh
+$ tailnudge log/development.log -a -p 'Completed 200 OK in (\d+m?s)' -t 'Requests'
+```
+
+Notify when HTTP 500 or 404 is encountered (but only show one 500/404
+notication at a time; no `-a` option, and throttling is done per-pattern):
+
+```sh
+$ tailnudge log/development.log -p 'Completed 500' 'Completed 404' -t 'HTTP 404/500'
+```
+
+Notify when HTTP 5XX or 404 is encountered (but only show one 500 or
+404 at a time; no `-a` option, and throttling is done per-pattern):
+
+```sh
+$ tailnudge log/development.log -p 'Completed [45]\d{2}' -t 'HTTP 4XX/5XX'
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/bin/tailnudge

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+# -*- mode: ruby; -*-
+
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+
+require "tailnudge"
+
+unless ARGV.empty? || %w(help tail).include?(ARGV[0])
+  ARGV.unshift('tail')
+end
+
+Tailnudge::CLI.start(ARGV)

data/lib/tailnudge.rb

@@ -0,0 +1,36 @@
+require "eventmachine"
+require "eventmachine-tail"
+require "terminal-notifier"
+require "thor"
+
+module Tailnudge
+  autoload :VERSION,      "tailnudge/version"
+  autoload :CLI,          "tailnudge/cli"
+  autoload :Notification, "tailnudge/notification"
+  autoload :Reader,       "tailnudge/reader"
+  autoload :Result,       "tailnudge/result"
+
+  def self.configuration=(configuration = {})
+    # Patterns to match
+    self.patterns = configuration[:pattern]
+    # Basics
+    @configuration = configuration
+  end
+
+  def self.patterns=(patterns)
+    @patterns = Array(patterns).map { |pattern|
+      Regexp.new(pattern, Regexp::IGNORECASE)
+    }
+  end
+  class << self; attr_reader :patterns, :configuration; end
+
+  def self.run(paths = [], options)
+    self.configuration = options
+    EventMachine.run do
+      paths.each do |path|
+        EventMachine.file_tail(path, Reader)
+      end
+    end
+  end
+
+end

data/lib/tailnudge/cli.rb

@@ -0,0 +1,36 @@
+module Tailnudge
+
+  class CLI < Thor
+
+    method_option :all, {
+      aliases: %w(-a),
+      default: false,
+      desc:    "Notify on every match (no throttling by pattern)"
+    }
+    method_option :title, {
+      aliases: %w(-t),
+      default: "tailnudge",
+      desc:    "Title to use for notifications"
+    }
+    method_option :subtitle, desc: "Subtitle to use for notifications"
+    method_option :sound, {
+      lazy_default: 'default',
+      aliases: %w(-s),
+      desc: "Sound to play (listed in Sound Preferences, note they are case-sensitive)"
+    }
+    method_option :pattern, {
+      aliases: %w(-p --patterns),
+      type: :array,
+      required: true,
+      desc: "Regular expressions to match. Case-insensitive. Note that if a capture is present, only its contents will be used in the notification."
+    }
+    desc "tail FILE [MORE_FILES]", "Tail files for patterns"
+    def tail(files = [])
+      Tailnudge.run(Array(files), options)
+    end
+
+    default_task :tail
+
+  end
+
+end

data/lib/tailnudge/notification.rb

@@ -0,0 +1,38 @@
+module Tailnudge
+
+  class Notification
+
+    def self.create(result)
+      new(result).run
+    end
+
+    def initialize(result)
+      @result = result
+    end
+
+    def run
+      TerminalNotifier.notify(@result.message,
+                              options)
+    end
+
+    private
+
+    def options
+      if Tailnudge.configuration[:all]
+        Tailnudge.configuration
+      else
+        # Throttling by group
+        Tailnudge.configuration.merge(group_id: group_id)
+      end
+    end
+
+    def group_id
+      [
+        Process.pid,
+        @result.pattern_id
+      ].join('-')
+    end
+
+  end
+
+end

data/lib/tailnudge/reader.rb

@@ -0,0 +1,31 @@
+module Tailnudge
+
+  class Reader < EventMachine::FileTail
+
+    def self.extract(line)
+      Tailnudge.patterns.each do |pattern|
+        match = pattern.match(line)
+        if match
+          return Result.new(match, line)
+        end
+      end
+      nil
+    end
+
+    def initialize(path, startpos=-1)
+      super(path, startpos)
+      @buffer = BufferedTokenizer.new
+    end
+
+    def receive_data(data)
+      @buffer.extract(data).each do |line|
+        result = self.class.extract(line)
+        if result
+          Notification.create(result)
+        end
+      end
+    end
+
+  end
+
+end

data/lib/tailnudge/result.rb

@@ -0,0 +1,20 @@
+module Tailnudge
+
+  class Result
+
+    def initialize(match, text)
+      @match = match
+      @text  = text
+    end
+
+    def message
+      @match[1] || @text
+    end
+
+    def pattern_id
+      @match.regexp.object_id
+    end
+
+  end
+
+end

data/lib/tailnudge/version.rb

@@ -0,0 +1,3 @@
+module Tailnudge
+  VERSION = "0.0.1"
+end

data/tailnudge.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tailnudge/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tailnudge"
+  spec.version       = Tailnudge::VERSION
+  spec.authors       = ["Bruce Williams"]
+  spec.email         = ["brwcodes@gmail.com"]
+  spec.summary       = %q{Display OSX notification when a tailed file matches a pattern}
+  spec.description   = %q{Tailnudge displays OS notifications when a tailed file matches a pattern; useful for being nudged more forcibly when you encounter deprecation, errors in log files.}
+  spec.homepage      = "http://github.com/bruce/tailnudge"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "terminal-notifier"
+  spec.add_dependency "eventmachine-tail"
+  spec.add_dependency "thor"
+
+  spec.add_development_dependency "bundler", "~> 1.4"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: tailnudge
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bruce Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: eventmachine-tail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Tailnudge displays OS notifications when a tailed file matches a pattern;
+  useful for being nudged more forcibly when you encounter deprecation, errors in
+  log files.
+email:
+- brwcodes@gmail.com
+executables:
+- tailnudge
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/tailnudge
+- lib/tailnudge.rb
+- lib/tailnudge/cli.rb
+- lib/tailnudge/notification.rb
+- lib/tailnudge/reader.rb
+- lib/tailnudge/result.rb
+- lib/tailnudge/version.rb
+- tailnudge.gemspec
+homepage: http://github.com/bruce/tailnudge
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Display OSX notification when a tailed file matches a pattern
+test_files: []