armin-joellenbeck-smilies 0.0.1

data/README

@@ -0,0 +1,74 @@
+=Smilies
+
+This library consists of a notification server for linux desktops and a
+correspondent ruby client API. It further contains a binary named *smile*
+which runs a given shell command and reports its output and return status.
+
+=Installation
+
+You have to install first:
+* notification-daemon >= 0.3.7
+* RNotify.rb >= 0.3.3
+
+Install the *smilies* gem itself by the following command:
+
+  $ gem install --source=http://gems.github.com armin-joellenbeck-smilies
+
+=Usage
+
+Start the notification server as follows:
+
+  $ smilies
+
+Then run the binary *smile* with a command line as parameter, for example:
+
+  $ smile rake
+
+You get a notification if the command line has passed or failed with the
+last line of its output (stdout and stderr together). You can click the
+button '*Details*' to get the full output.
+
+For writing a client for the *smilies* notification server see the binary
+*smile*:
+
+  :include:bin/smile
+
+=Support
+
+The project home is at GitHub[http://github.com/armin-joellenbeck/smilies/tree/master]:
+  http://github.com/armin-joellenbeck/smilies/tree/master
+
+Feel free to send:
+* bug reports
+* support requests
+* feature requests
+* patches
+
+=Copyright
+
+Copyright (c) 2008 by Armin Jöllenbeck
+<armin@joellenbeck.net[mailto:armin@joellenbeck.net]>
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. The names of the contributors may not be used to endorse or promote products
+   derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile

@@ -0,0 +1,32 @@
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'rake/rdoctask'
+
+
+task :default => [:spec]
+
+
+task :all =>  [:spec, :doc]
+
+
+Spec::Rake::SpecTask.new do |t|
+  t.libs << 'spec' << 'lib'
+  t.spec_opts << '--format' << 'specdoc'
+end
+
+
+Rake::RDocTask.new(:doc) do |t|
+  t.rdoc_dir = 'doc'
+  t.rdoc_files.include('README', 'lib/**/*.rb')
+  t.options = [
+    '--all',
+    '--charset', 'utf8',
+    '--inline-source',
+    '--main', 'README',
+    '--title', 'Smilies'
+  ]
+end
+
+
+Rake::GemPackageTask.new(eval(File.read('smilies.gemspec'))) do |pkg|
+end

data/bin/smile

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+require 'smilies/client'
+
+if ARGV.empty?
+  puts 'smile: usage: smile <command line>'
+  puts 'smile: command line cannot be blank'
+  exit(-1)
+end
+
+command = ARGV.join(' ')
+
+client = Smilies::Client.new
+
+client.yellow("Running: #{command}")
+output= nil
+IO.popen("#{command} 2>&1") do |io|
+  output = io.read
+end
+exitstatus = $?.exitstatus
+if exitstatus == 0
+  client.green("Passed: #{command}", output)
+else
+  client.red("Failed: #{command}", output)
+end

data/bin/smilies

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+require 'smilies/server'
+
+Smilies::Server.start
+
+trap 'INT' do
+  Smilies::Server.stop
+end
+
+trap 'TERM' do
+  Smilies::Server.stop
+end
+
+Smilies::Server.join

data/lib/smilies/client.rb

@@ -0,0 +1,30 @@
+require 'drb'
+
+
+module Smilies
+
+  class Client
+
+    def initialize(server=nil)
+      if server
+        @server = server
+      else
+        @server = DRb::DRbObject.new(nil, 'druby://localhost:8809')
+      end
+    end
+
+    def green(summary=nil, message=nil)
+      @server.green(summary, message)
+    end
+
+    def yellow(summary=nil, message=nil)
+      @server.yellow(summary, message)
+    end
+
+    def red(summary=nil, message=nil)
+      @server.red(summary, message)
+    end
+
+  end
+
+end

data/lib/smilies/helper.rb

@@ -0,0 +1,23 @@
+module Smilies
+
+  module Helper
+
+    def self.smilies_directory
+      File.dirname(__FILE__) + '/../../icons'
+    end
+
+    def self.green_smiley_path
+      smilies_directory + '/green.png'
+    end
+
+    def self.yellow_smiley_path
+      smilies_directory + '/yellow.png'
+    end
+
+    def self.red_smiley_path
+      smilies_directory + '/red.png'
+    end
+
+  end
+
+end

data/lib/smilies/server.rb

@@ -0,0 +1,82 @@
+require 'drb'
+require 'RNotify'
+require 'singleton'
+
+require 'smilies/helper'
+
+
+module Smilies
+
+  class Server
+
+    include DRbUndumped
+    include Singleton
+
+    def self.start
+      @gtk_thread = Thread.new { Gtk.main }
+      DRb.start_service('druby://localhost:8809', self.instance)
+    end
+
+    def self.stop
+      DRb.stop_service
+      @gtk_thread.terminate
+    end
+
+    def self.join
+      DRb.thread.join
+    end
+
+    def initialize
+      @green_smiley = read_icon(Helper.green_smiley_path)
+      @yellow_smiley = read_icon(Helper.yellow_smiley_path)
+      @red_smiley = read_icon(Helper.red_smiley_path)
+      Notify.init('Smilies')
+      @tray_icon = Gtk::StatusIcon.new
+      @tray_icon.pixbuf = @yellow_smiley
+      @tray_icon.tooltip = 'Started'
+      @notification = Notify::Notification.new('Start',nil,nil,@tray_icon)
+      @notification.urgency = Notify::Notification::URGENCY_LOW
+      @notification.timeout = 10000
+      @notification.add_action('details', 'Details') { |action| send(action) }
+    end
+
+    def details
+      puts @message
+    end
+
+    def green(summary=nil, message=nil)
+      message(@green_smiley, summary, message)
+    end
+
+    def yellow(summary=nil, message=nil)
+      message(@yellow_smiley, summary, message)
+    end
+
+    def red(summary=nil, message=nil)
+      message(@red_smiley, summary, message)
+    end
+
+    private
+
+    def read_icon(icon_path)
+      Gdk::Pixbuf.new(icon_path, 64, 64)
+    end
+
+    def message(icon, summary=nil, message=nil)
+      @tray_icon.pixbuf = icon
+      @message = message
+      if summary
+        @tray_icon.tooltip = summary
+      end
+      if message
+        tail = message.split("\n")[-1]
+        @notification.update(summary, tail, nil)
+        @notification.pixbuf_icon = icon
+        @notification.show
+      end
+      nil
+    end
+
+  end
+
+end

data/smilies.gemspec

@@ -0,0 +1,35 @@
+Gem::Specification.new do |s|
+  s.name = 'smilies'
+  s.version = '0.0.1'
+  s.summary = 'Notification for linux desktops'
+  s.author = 'Armin Joellenbeck'
+  s.email = 'armin@joellenbeck.net'
+  s.homepage = 'http://github.com/armin-joellenbeck/smilies/tree/master'
+  s.description = <<-EOF
+    This library consists of a notification server for linux desktops and a
+    correspondent ruby client API. It further contains a binary named smile
+    which runs a given shell command and reports its output and return status.
+  EOF
+  s.requirements <<
+    'notification-daemon >= 0.3.7' <<
+    'RNotify.rb >= 0.3.3'
+  s.files = Dir.glob([
+    'README',
+    'Rakefile',
+    '*.gemspec',
+    'bin/*',
+    'icons/*',
+    'lib/**/*',
+    'spec/**/*'
+  ])
+  s.bindir = 'bin'
+  s.executables << 'smilies' << 'smile'
+  s.has_rdoc = true
+  s.extra_rdoc_files << 'README'
+  s.rdoc_options = [
+    '--all',
+    '--charset', 'utf8',
+    '--main', 'README',
+    '--title', 'Smilies'
+  ]
+end

data/spec/smilies/client_spec.rb

@@ -0,0 +1,30 @@
+require 'smilies/client'
+
+
+module Smilies
+
+  describe Client do
+
+    before do
+      @server = mock :server
+      @client = Client.new(@server)
+    end
+
+    it 'should send a green message to server' do
+      @server.should_receive(:green).with('green', 'Really green!')
+      @client.green('green', 'Really green!')
+    end
+
+    it 'should send a yellow message to server' do
+      @server.should_receive(:yellow).with('yellow', 'Really yellow!')
+      @client.yellow('yellow', 'Really yellow!')
+    end
+
+    it 'should send a red message to server' do
+      @server.should_receive(:red).with('red', 'Really red!')
+      @client.red('red', 'Really red!')
+    end
+
+  end
+
+end

data/spec/smilies/helper_spec.rb

@@ -0,0 +1,30 @@
+require 'smilies/helper'
+
+
+module Smilies
+
+  describe Helper do
+
+    it 'should give the smilies directory' do
+      path = Helper.smilies_directory
+      File.directory?(path).should be_true
+    end
+
+    it 'should give the green smiley' do
+      path = Helper.green_smiley_path
+      File.file?(path).should be_true
+    end
+
+    it 'should give the yellow smiley' do
+      path = Helper.yellow_smiley_path
+      File.file?(path).should be_true
+    end
+
+    it 'should give the red smiley' do
+      path = Helper.red_smiley_path
+      File.file?(path).should be_true
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: armin-joellenbeck-smilies
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Armin Joellenbeck
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-14 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: This library consists of a notification server for linux desktops and a correspondent ruby client API. It further contains a binary named smile which runs a given shell command and reports its output and return status.
+email: armin@joellenbeck.net
+executables: 
+- smilies
+- smile
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- Rakefile
+- smilies.gemspec
+- bin/smile
+- bin/smilies
+- icons/green.png
+- icons/yellow.png
+- icons/red.png
+- lib/smilies
+- lib/smilies/server.rb
+- lib/smilies/client.rb
+- lib/smilies/helper.rb
+- spec/smilies
+- spec/smilies/helper_spec.rb
+- spec/smilies/client_spec.rb
+has_rdoc: true
+homepage: http://github.com/armin-joellenbeck/smilies/tree/master
+post_install_message: 
+rdoc_options: 
+- --all
+- --charset
+- utf8
+- --main
+- README
+- --title
+- Smilies
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: 
+- notification-daemon >= 0.3.7
+- RNotify.rb >= 0.3.3
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Notification for linux desktops
+test_files: []
+