notifiers 1.0

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/.infinity_test

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+infinity_test do
+  use :rubies => %w(1.9.2 ree 1.8.7 jruby), :test_framework => :rspec
+end

data/README.markdown

@@ -0,0 +1,26 @@
+# Notifier
+
+Use notifications in a simple and elegant way. :)
+
+## Install
+
+     gem install notifiers
+
+# Usage
+
+     require 'notifiers'
+     include Notifiers
+
+## Growl
+
+     growl.message('Hi Growl!').image('my_image.png').priority(2).name('my_app').notify!
+
+## Lib_Notify
+
+     notify_send.image('my_image.png').message('Hi Growl').notify!
+
+# Why I created this gem?
+
+## Only one explanation:
+
+### <b>Because is fun! =)</b>

data/Tasks

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+class Tasks < Morpheus::Base
+  rspec
+end

data/lib/notifiers/growl.rb

@@ -0,0 +1,54 @@
+class Growl
+  COMMAND = "growlnotify"
+
+  def image(icon)
+    @image = icon
+    self
+  end
+  
+  def title(text)
+    @title = text
+    self
+  end
+
+  def message(text)
+    @message = text
+    self
+  end
+  
+  def priority(number)
+    @priority = number
+    self
+  end
+  
+  def host(hostname)
+    @host = hostname
+    self
+  end
+  
+  def password(secret)
+    @password = secret
+    self
+  end
+  
+  def auth(authentication)
+    @auth = authentication
+    self
+  end
+  
+  def to_s
+    command = COMMAND.clone
+    command << " --title '#{@title}'" if @title
+    command << " --message '#{@message}'"
+    [:image, :priority, :host, :password, :auth].each do |option|
+      variable = instance_variable_get("@#{option}")
+      command << " --#{option} #{variable}" if variable
+    end
+    command
+  end
+  
+  def notify!
+    system(to_s)
+  end
+
+end

data/lib/notifiers/knotify.rb

@@ -0,0 +1,7 @@
+class Knotify
+  
+  def new
+    raise 'Dont support Knotify (YET)'
+  end
+  
+end

data/lib/notifiers/notify_send.rb

@@ -0,0 +1,53 @@
+class NotifySend
+  COMMAND = 'notify-send'
+
+  def message(text)
+    @message = text
+    self
+  end
+  
+  def title(text)
+    @title = text
+    self
+  end
+  
+  def image(icon)
+    @icon = icon
+    self
+  end
+  
+  def urgency(level)
+    @urgency = level.to_s
+    self
+  end
+  
+  def expire_time(time)
+    @expire_time = time
+    self
+  end
+  
+  def hint(values)
+    @hint = values.collect.each { |element| element.to_s}.join(':')
+    self
+  end
+  
+  def to_s
+    command = COMMAND.clone
+    [:hint, :priority, :icon, :urgency].each do |option|
+      variable = instance_variable_get("@#{option}")
+      command << " --#{option}=#{variable}" if variable
+    end
+    command << " --expire-time=#{@expire_time}" if @expire_time
+    [:title, :message].each do |option|
+      variable = instance_variable_get("@#{option}")
+      command << " '#{variable}'" if variable
+    end
+    command
+  end
+  
+  # Extract this to a module or something
+  def notify!
+    system(to_s)
+  end
+  
+end

data/lib/notifiers.rb

@@ -0,0 +1,19 @@
+[ :growl, :knotify, :notify_send].each do |notifier|
+  require "notifiers/#{notifier}"
+end
+
+module Notifiers
+
+  def growl
+    Growl.new
+  end
+  
+  def knotify
+    Knotify.new
+  end
+  
+  def notify_send
+    NotifySend.new
+  end
+  
+end

data/notifiers.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name        = "notifiers"
+  s.version     = '1.0'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Tomás D'Stefano"]
+  s.email       = ["tomasdestefi@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/notifiers"
+  s.summary     = "Use notifications in a simple and elegant way."
+  s.description = "Use Growl and Lib-Notify in a simple and clean way."
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "notifiers"
+  
+  s.add_development_dependency('rspec', ">= 2.0.1")
+  s.add_development_dependency('bundler', ">= 1.0.0")
+    
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

data/spec/notifiers/growl_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+describe Growl do
+  
+  before do
+    @growl = growl
+  end
+  
+  describe '#image' do
+  
+    it "should keep the image" do
+      @growl.image('my_image.png')
+      @growl.instance_variable_get(:@image).should eql 'my_image.png'
+    end
+    
+    it "should set the image" do
+      @growl.image('wario.png')
+      @growl.instance_variable_get(:@image).should eql 'wario.png'
+    end
+
+  end
+  
+  describe '#message' do
+  
+    it "should set the message option" do
+      @growl.message('Hello World!')
+      @growl.instance_variable_get(:@message).should eql 'Hello World!'
+    end
+    
+    it "should set the message" do
+      @growl.message('May the Force be with you')
+      @growl.instance_variable_get(:@message).should eql 'May the Force be with you'
+    end
+  end
+  
+  describe '#title' do
+    it "should set the title" do
+      @growl.title('Nirvana')
+      @growl.instance_variable_get(:@title).should eql 'Nirvana'
+    end
+    
+    it "should set the title option" do
+      @growl.title('Pearl Jam')
+      @growl.instance_variable_get(:@title).should eql 'Pearl Jam'
+    end
+  end
+  
+  describe '#priority' do
+  
+    it "should set the priority" do
+      @growl.priority(0)
+      @growl.instance_variable_get(:@priority).should be 0
+    end
+    
+    it "should set the priority number" do
+      @growl.priority(1)
+      @growl.instance_variable_get(:@priority).should be 1
+    end
+  end
+  
+  describe '#host' do
+  
+    it "should set the hostname" do
+      @growl.host('localhost')
+      @growl.instance_variable_get(:@host).should eql 'localhost'
+    end
+    
+    it "should set the host" do
+      @growl.host('beer_duff.com')
+      @growl.instance_variable_get(:@host).should eql 'beer_duff.com'
+    end
+  end
+  
+  describe '#password' do
+  
+    it "should set the password" do
+      @growl.password('top_secret')
+      @growl.instance_variable_get(:@password).should eql 'top_secret'
+    end
+    
+    it "should set the secret password" do
+      @growl.password('paradise_city')
+      @growl.instance_variable_get(:@password).should eql 'paradise_city'
+    end
+  end
+  
+  describe '#auth' do
+    it "should set the auth option" do
+      @growl.auth('SHA256')
+      @growl.instance_variable_get(:@auth).should eql 'SHA256'
+    end
+  end
+  
+  describe '#to_s' do
+  
+    it "should construct the command" do
+      command = @growl.message('Hello World!').priority(1).image('mario.png').to_s # What Mario?
+      command.should eql "growlnotify --message 'Hello World!' --image mario.png --priority 1"
+    end
+    
+    it "should construct the command with host password and auth" do
+      command = @growl.message('Donuts').host('duff_bear').auth('SHA256').password('welcome_to_the_jungle').to_s
+      command.should eql "growlnotify --message 'Donuts' --host duff_bear --password welcome_to_the_jungle --auth SHA256"
+    end
+    
+    it "should construct the command with title and message" do
+      command = @growl.message('Last Kiss').title('Pearl Jam').to_s
+      command.should eql "growlnotify --title 'Pearl Jam' --message 'Last Kiss'"
+    end
+    
+  end
+  
+end

data/spec/notifiers/notify_send_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+describe NotifySend do
+  
+  before do
+    @notify_send = notify_send
+  end
+  
+  describe '#image' do
+    
+    it "should set the image" do
+      @notify_send.image('my_image.png')
+      @notify_send.instance_variable_get(:@icon).should eql 'my_image.png'
+    end
+    
+    it "should set the icon option" do
+      @notify_send.image('homer_simpson.png')
+      @notify_send.instance_variable_get(:@icon).should eql 'homer_simpson.png'
+    end
+
+  end
+  
+  describe '#message' do
+    
+    it "should set the message" do
+      @notify_send.message('Oh Donuts!')
+      @notify_send.instance_variable_get(:@message).should eql 'Oh Donuts!'
+    end
+    
+    it "should set the message option" do
+      @notify_send.message('Duff Beer')
+      @notify_send.instance_variable_get(:@message).should eql 'Duff Beer'
+    end
+    
+  end
+  
+  describe '#title' do
+    
+    it "should set the title" do
+      @notify_send.title('W00T!!')
+      @notify_send.instance_variable_get(:@title).should == 'W00T!!'
+    end
+    
+    it "should set a title as intance variable" do
+      @notify_send.title('Joker Owned Batman!')
+      @notify_send.instance_variable_get(:@title).should == 'Joker Owned Batman!'
+    end
+    
+  end
+  
+  describe '#urgency' do
+    
+    it "should set the urgency instance variable to low" do
+      @notify_send.urgency(:low)
+      @notify_send.instance_variable_get(:@urgency).should == 'low'
+    end
+    
+    it "should set he urgency instance variable to normal" do
+      @notify_send.urgency(:normal)
+      @notify_send.instance_variable_get(:@urgency).should == 'normal'
+    end
+    
+    it "should set the urgency to critical" do
+      @notify_send.urgency(:critical)
+      @notify_send.instance_variable_get(:@urgency).should == 'critical'
+    end
+    
+  end
+  
+  describe '#expire_time' do
+    
+    it "should set the expire time" do
+      @notify_send.expire_time(1000)
+      @notify_send.instance_variable_get(:@expire_time).should == 1000
+    end
+    
+    it "should set the expire time in miliseconds" do
+      @notify_send.expire_time(2000)
+      @notify_send.instance_variable_get(:@expire_time).should == 2000
+    end
+    
+  end
+  
+  describe '#hint' do
+    
+    it "should set the hint" do
+      @notify_send.hint([:string, :me, :yeah])
+      @notify_send.instance_variable_get(:@hint).should == 'string:me:yeah'
+    end
+    
+    it "should set the hint in int" do
+      @notify_send.hint([:int, :me, 1])
+      @notify_send.instance_variable_get(:@hint).should == 'int:me:1'
+    end
+    
+  end
+ 
+  describe '#to_s' do
+    
+    it "should transform in a command" do
+      command = @notify_send.title('Inception').message('3 levels').image('my_image.png').to_s
+      command.should == "notify-send --icon=my_image.png 'Inception' '3 levels'"
+    end
+    
+    it "should transform in a command to execute" do
+      command = @notify_send.title('Joker').message('Haha ha!').expire_time(1000).hint([:string, :me, :woot]).to_s
+      command.should == "notify-send --hint=string:me:woot --expire-time=1000 'Joker' 'Haha ha!'"
+    end
+    
+    it "should transform in a command to execute" do
+      command = @notify_send.title('Batman').urgency(:critical).to_s
+      command.should == "notify-send --urgency=critical 'Batman'"
+    end
+    
+  end
+ 
+end

data/spec/notifiers_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe 'notifiers' do
+
+  it { growl.should be_instance_of(Growl) }
+  
+  it { knotify.should be_instance_of(Knotify) }
+  
+  it { notify_send.should be_instance_of(NotifySend)}
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+
+require 'notifiers'
+
+RSpec.configure do |config|
+  config.include Notifiers
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: notifiers
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- "Tom\xC3\xA1s D'Stefano"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-28 00:00:00 -02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 1
+        version: 2.0.1
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id002
+description: Use Growl and Lib-Notify in a simple and clean way.
+email: 
+- tomasdestefi@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .infinity_test
+- README.markdown
+- Tasks
+- lib/notifiers.rb
+- lib/notifiers/growl.rb
+- lib/notifiers/knotify.rb
+- lib/notifiers/notify_send.rb
+- notifiers.gemspec
+- spec/notifiers/growl_spec.rb
+- spec/notifiers/notify_send_spec.rb
+- spec/notifiers_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/notifiers
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: notifiers
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Use notifications in a simple and elegant way.
+test_files: []
+