notis 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    M2UzZGU4OTAxNWYwODdhY2Y3OGQzNWM3MTZhZTQ2MjA5MjFhYTU2Yw==
+  data.tar.gz: !binary |-
+    MTk4MDNiODFjZTdhZGUwYTFjMGVjMDEwOWY2NGFhNGMxMDMzZWZiOQ==
+SHA512:
+  metadata.gz: !binary |-
+    ZTA2N2RhNTJmMzhiODVhMDgyMTAzMGU3YWYyZTBhYzExOWRjNWExOTJlYjYx
+    NTVmMzcwMThjOGY3MzA0YzdiYTJhMmQ1N2IzNmVmMzg4NWViYWU5ZjZkYWU1
+    ZjE4OWFmZGY4YjMwODczM2VlYWQ3MGFlOWE0ZGExNmQ4ZWM3MTU=
+  data.tar.gz: !binary |-
+    MjJiYmVkYmZlYTM2ZWJjY2FjZWM2YzljNWJkNDAwODZmMTE1NGFjYjA5YjE1
+    ZDY3OGY0NzUyNzA4MzkyYWQwYzdlZTQxMjlhNDNjYmMxYzA2MzVmMzVmMTRj
+    MDc3OTNiYTRkYjBjYzU1MWIwMTlmZDM3ODIzZjRjOWM5YzgzMTA=

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    notis (0.1.0)
+      methadone (~> 1.3.1)
+      terminal-notifier (~> 1.5.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.5.3)
+      childprocess (>= 0.3.6)
+      cucumber (>= 1.1.1)
+      rspec-expectations (>= 2.7.0)
+    builder (3.2.2)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    cucumber (1.3.10)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.0.2)
+    diff-lcs (1.2.5)
+    ffi (1.9.3)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
+    json (1.8.1)
+    methadone (1.3.1)
+      bundler
+    multi_json (1.8.2)
+    multi_test (0.0.2)
+    rake (0.9.6)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    terminal-notifier (1.5.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  bundler
+  notis!
+  rake (~> 0.9.2)
+  rdoc

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chris Simpkins
+
+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,55 @@
+# Notis
+### Mac OSX Command Line Application Notifier
+
+notis is a Mac OSX utility that allows you to display a standard OSX toast message notification at the completion of a long-running command with the option to emit an audio signal.
+
+## Installation
+
+Install the Ruby gem with the following command:
+
+``` bash
+gem install notis
+```
+
+## Usage
+You can run the command that is to be tracked as an argument to notis or you can pipe the standard output from the command to notis.  The way that you run it influences the level of detail that you receive in the notification text.
+
+### Run Command as an Argument to notis
+Use the command to be tracked as an argument to notis and enclose it in quotes if it includes spaces or special shell characters.  For example, if you are running the command `longrunner bigfile.baf`:
+
+```
+notis "longrunner bigfile.baf"
+```
+When you run notis with this syntax, you will receive a notification that identifies the completed command with up to 20 characters of the original command string.
+
+### Pipe Standard Output from Command to notis
+You can also use notis by piping the standard output stream of another command to the notis standard input stream.  Assuming that you are running the command `longrunner bigfile.baf`:
+
+```
+longrunner bigfile.baf | notis
+```
+
+## Options
+
+This utility provides the option to mute the standard output from the original command and to emit an audio signal that the command completed along with the notification toast message.  These options can combined.
+
+### Mute Standard Output from the Tracked Command (`-m, --mute`)
+
+```
+notis -m "longrunner bigfile.baf"
+```
+or
+```
+longrunner bigfile.baf | notis -m
+```
+
+### Emit Audio Signal as Part of the Notification (`-b, --bell`)
+
+```
+notis -b "longrunner bigfile.baf"
+```
+or
+```
+longrunner bigfile.baf | notis -b
+```
+

data/README.rdoc

@@ -0,0 +1,23 @@
+= notis - a Mac OSX toast message notification utility for command line applications
+
+Author::  Christopher Simpkins (git.simpkins@gmail.com)
+Copyright:: Copyright (c) 2013 Christopher Simpkins
+
+
+notis is a Mac OSX utility that allows you to display a standard OSX toast message notification at the completion of a long-running command with the option to emit an audio signal.
+
+== Links
+
+* {Source on Github}[https://github.com/chrissimpkins/notis]
+
+== Install
+
+	$ gem install notis
+
+== Examples
+
+	notis "longrunner bigfile.baf"
+
+	longrunner bigfile.baf | notis
+
+

data/Rakefile

@@ -0,0 +1,61 @@
+def dump_load_path
+  puts $LOAD_PATH.join("\n")
+  found = nil
+  $LOAD_PATH.each do |path|
+    if File.exists?(File.join(path,"rspec"))
+      puts "Found rspec in #{path}"
+      if File.exists?(File.join(path,"rspec","core"))
+        puts "Found core"
+        if File.exists?(File.join(path,"rspec","core","rake_task"))
+          puts "Found rake_task"
+          found = path
+        else
+          puts "!! no rake_task"
+        end
+      else
+        puts "!!! no core"
+      end
+    end
+  end
+  if found.nil?
+    puts "Didn't find rspec/core/rake_task anywhere"
+  else
+    puts "Found in #{path}"
+  end
+end
+require 'bundler'
+require 'rake/clean'
+
+require 'rake/testtask'
+
+require 'cucumber'
+require 'cucumber/rake/task'
+gem 'rdoc' # we need the installed RDoc gem, not the system one
+require 'rdoc/task'
+
+include Rake::DSL
+
+Bundler::GemHelper.install_tasks
+
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/tc_*.rb'
+end
+
+
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty --no-source -x"
+  t.fork = false
+end
+
+Rake::RDocTask.new do |rd|
+  
+  rd.main = "README.rdoc"
+  
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+end
+
+task :default => [:test,:features]
+

data/bin/notis

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'methadone'
+require 'open3'
+require 'terminal-notifier'
+require 'notis.rb'
+
+class App
+  include Methadone::Main
+
+  main do | user_command |
+    begin
+      # STD IN BLOCK
+      unless user_command   # if user pipes a command to the Notis standard input stream (instead of using Notis as primary command)
+        unless options["m"] # mute original command std out switch
+          #print the original command's std out stream
+          puts ARGF.read
+        end
+        if options["b"] # ring bell switch
+          Notis.runit("terminal-notifier -sound default -title Notis -message 'The piped process is complete.'")
+          exit 0
+        end
+        Notis.runit("terminal-notifier -title Notis -message 'The piped process is complete.'")
+        exit 0
+      end
+      # END STD IN BLOCK
+
+      # MAIN COMMAND BLOCK
+      thecommand = Notis.runit("#{user_command}")
+      # If command returned exit code 0, then echo the std output from the command unless mute switch
+      unless options["m"]
+        puts("#{thecommand}")
+      end
+      # decrease length of the string for display if > 20 char
+      if user_command.length > 20
+        user_command = user_command[0..19] + "... "
+      end
+      # and then launch the Mac OSX notification that the process completed
+      if options["b"] # ring bell switch
+        Notis.runit("terminal-notifier -title Notis -sound default -message '#{user_command} completed successfully.'")
+        exit 0
+      end
+      Notis.runit("terminal-notifier -title Notis -message '#{user_command} completed successfully.'")
+      exit 0
+      # END MAIN COMMAND BLOCK
+      # TODO: handle exit status 1 in original command with appropriate message to user
+    end
+
+  end #end main
+
+    description "Launch a Mac OSX notification at the completion of another command.  Include the command to be run as the argument to notis, or pipe the command's standard output to the notis standard input stream.  This utility provides the option to mute the standard output from the original command and to emit an audio signal that the command completed along with the notification toast message.\n\nExamples:\n\n  Run command as argument to notis:\n\tnotis 'curl -L http://bigsite.com'\n\n  Pipe Standard Output to notis:\n\tcurl -L http://bigsite.com | notis"
+
+  # Switches:
+  on("--bell","-b","Provide an audio alert with notification")
+  on("--mute","-m","Mute standard output from running process")
+
+  # Optional argument
+   arg :user_command, :optional
+
+  version Notis::VERSION
+
+  begin
+    go!
+  rescue => e
+    STDERR.puts("There was an error with Notis.")
+    STDERR.puts e.message
+    exit 1
+  end
+end

data/features/notis.feature

@@ -0,0 +1,13 @@
+Feature: My bootstrapped app kinda works
+  In order to get going on coding my awesome app
+  I want to have aruba and cucumber setup
+  So I don't have to do it myself
+
+  Scenario: App just runs
+    When I get help for "notis"
+    Then the exit status should be 0
+    And the banner should be present
+    And the banner should document that this app takes options
+    And the following options should be documented:
+      |--version|
+    And the banner should document that this app takes no arguments

data/features/step_definitions/notis_steps.rb

@@ -0,0 +1 @@
+# Put your step definitions here

data/features/support/env.rb

@@ -0,0 +1,16 @@
+require 'aruba/cucumber'
+require 'methadone/cucumber'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+end

data/gemify.sh

@@ -0,0 +1,41 @@
+#!/bin/sh
+# Scriptacular - gemify.sh
+# Create a Ruby gem and push it to rubygems.org
+# Copyright 2013 Christopher Simpkins
+# MIT License
+
+# Enter your gem name below (do not enter version number)
+# or pass it as the first argument to the shell script
+GEM_NAME="notis"
+
+# Don't touch these
+GEMSPEC_SUFFIX=".gemspec"
+GEM_BUILD_CMD="gem build"
+GEM_PUSH_CMD="gem push"
+
+# if there is an argument to the script, define the gem name with it
+if [ $# -eq 1 ]; then
+        GEM_NAME=$1
+elif [ $# -gt 1 ]; then
+        echo "You entered too many arguments.  Please specify the name of your gem as the argument to the script." >&2
+        exit 1
+fi
+
+# if the gem name has not been defined, print error message and exit
+if [ -z "$GEM_NAME" ]; then
+        echo "You did not enter a gem name.  Please include it as an argument to the script or hard code it as a variable in the script." >&2
+        exit 1
+fi
+
+# run the gem build and parse for the gem release filename
+GEM_BUILD_NAME=$(gem build "$GEM_NAME$GEMSPEC_SUFFIX" |  awk '/File/ {print $2}' -)
+
+# if the build failed (i.e. no file name obtained above), print error message and exit
+if [ -z "$GEM_BUILD_NAME" ]; then
+        echo "The gem build failed.  Please confirm the gem name and try again." >&2
+        exit 1
+fi
+
+# if above succeeded, then push to rubygems.org using the gem that was compiled
+gem push $GEM_BUILD_NAME
+exit 0

data/lib/notis.rb

@@ -0,0 +1,19 @@
+require "notis/version"
+require 'open3'
+
+module Notis
+    def Notis.runit(command)
+	  	begin
+		    stdout_str, stderr_str, status = Open3.capture3(command)
+		    if status.exitstatus == 0
+		    	return "#{stdout_str}"
+		    else
+		      	STDERR.puts stderr_str #if the primary application fails, pass the error message to the user
+		      	exit 1
+		    end
+	  	rescue => e
+		    STDERR.puts e.message
+		    exit 1
+		end #end begin/rescue blocks
+	end #end runit
+end #end Notis module

data/lib/notis/version.rb

@@ -0,0 +1,3 @@
+module Notis
+  VERSION = "0.1.0"
+end

data/notis.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'notis/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "notis"
+  spec.version       = Notis::VERSION
+  spec.authors       = ["Chris Simpkins"]
+  spec.email         = ["git.simpkins@gmail.com"]
+  spec.description   = %q{notis is a Mac OSX utility that allows you to display a standard OSX toast message notification at the completion of a long-running command with the option to emit an audio signal.}
+  spec.summary       = %q{notis}
+  spec.homepage      = "https://github.com/chrissimpkins/notis"
+  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_development_dependency('bundler')
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency('rdoc')
+  spec.add_development_dependency('aruba')
+  spec.add_development_dependency('rake', '~> 0.9.2')
+  spec.add_dependency('methadone', '~> 1.3.1')
+  spec.add_dependency('terminal-notifier', '~> 1.5.1')
+end

data/test/tc_something.rb

@@ -0,0 +1,7 @@
+require 'test/unit'
+
+class TestSomething < Test::Unit::TestCase
+  def test_truth
+    assert true
+  end
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: notis
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Simpkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  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'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: methadone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+description: notis is a Mac OSX utility that allows you to display a standard OSX
+  toast message notification at the completion of a long-running command with the
+  option to emit an audio signal.
+email:
+- git.simpkins@gmail.com
+executables:
+- notis
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- README.rdoc
+- Rakefile
+- bin/notis
+- features/notis.feature
+- features/step_definitions/notis_steps.rb
+- features/support/env.rb
+- gemify.sh
+- lib/notis.rb
+- lib/notis/version.rb
+- notis.gemspec
+- test/tc_something.rb
+homepage: https://github.com/chrissimpkins/notis
+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.1.10
+signing_key: 
+specification_version: 4
+summary: notis
+test_files:
+- features/notis.feature
+- features/step_definitions/notis_steps.rb
+- features/support/env.rb
+- test/tc_something.rb