battlecry 0.1

data/README.markdown

@@ -0,0 +1,27 @@
+#Battlecry - A simple abstraction for sydicating messages to OSX hosts via Growl
+
+##Installation
+
+	gem install ruby-growl
+	gem install battlecry -s http://gemcutter.org
+
+## Examples
+
+	battlecry = Battlecry.new [{
+		:host => "localhost"
+	},{
+		:host => "otherhost",
+		:password => "password"
+	}]
+
+	#shout a might shout, and all allies will know!
+	battlecry.shout "Victory is ours!"
+	
+	#add another ally
+	battlecry.add_ally "hostname", "password"
+	
+	#see the army size
+	battlecry.num_allies
+
+##Dependencies
+- ruby-growl

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+desc "Run All Specs"
+Spec::Rake::SpecTask.new("spec") do |t|
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+end

data/battlecry.gemspec

@@ -0,0 +1,22 @@
+spec = Gem::Specification.new do |s|
+	s.name = 'battlecry'
+	s.version = '0.1'
+	s.date = '2010-06-16'
+	s.summary = 'A simple abstraction for sydicating messages to OSX hosts via Growl'
+	s.email = 'dan.simpson@gmail.com'
+	s.homepage = 'http://github.com/dansimpson/battlecry'
+	s.description = 'A simple abstraction for sydicating messages to OSX hosts via Growl'
+	s.has_rdoc = true
+	
+	s.authors = ['Dan Simpson']
+	s.add_dependency('ruby-growl', '>= 2.0')
+
+	s.files = [
+	  'README.markdown',
+	  'battlecry.gemspec',
+	  'Rakefile',
+    'spec/helper.rb',
+    'spec/battlecry_spec.rb',
+    'lib/battlecry.rb'
+	]
+end

data/lib/battlecry.rb

@@ -0,0 +1,83 @@
+$:.unshift File.dirname(__FILE__)
+
+require "rubygems"
+require "ruby-growl"
+
+##
+# Battlecry is a simply abstraction for sending  growl messages 
+# to many hosts (allies)
+# 
+# See http://growl.info/
+# 
+# depends on the ruby-growl gem
+# gem install ruby-growl
+#
+# Allies must have OSX installed and must listen for incoming
+# notifcations to hear the cry.
+# You can enable this by going to the Growl configuration panel
+# under System Preferences.  Go to the network tab and check the following boxes
+# - Listen for incoming notifications
+# - Allow remote application registration
+# 
+# = Example
+#   
+#   battlecry = Battlecry.new [{
+#     :host => "localhost"
+#   },{
+#     :host => "myhost.com",
+#     :password => "test"
+#   }]
+#   battlecry.shout "We will defeat our enemies!"
+class Battlecry
+
+  VERSION = 0.1
+
+  ##
+  # Creates a Battlecry, which registers notificaitons with one or
+  # more remote machines, known as allies
+  #
+  # +allies+ is an array of allies which will be affected by
+  # a battlecry. An ally is a hash object with a :host param (hostname),
+  # and an optional :password param
+  # eg: { :host => "localhost", :password => "password" }
+  
+  def initialize allies
+    @allies = []
+    allies.each do |ally|
+      add_ally ally[:host], ally[:password]
+    end
+  end
+  
+  ##
+  # Battlecrys for all allies in the army
+  #
+  # +message+ the content of the battlecry
+  #
+  # +title+ the title, or context of the battlecry
+  #
+  # +priority+ the intensity of the cry from -2 to 2
+  #
+  # +sticky+ makes the cry stick in the heads of allies
+  def shout message, title = "Battlecry", priority = 0, sticky = false
+    @allies.each do |ally|
+      ally.notify "battlecry", title, message, priority, sticky
+    end
+  end
+  
+  ##
+  # Adds an ally to the army
+  #
+  # +host+ the hostname of the ally
+  #
+  # +title+ the password for the ally
+  def add_ally host, password = nil
+    @allies << Growl.new(host, "battlecry", ["battlecry"], nil, password)
+  end
+  
+  ##
+  # The size of the army
+  def num_allies
+    @allies.size
+  end
+
+end

data/spec/battlecry_spec.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + "/helper"
+
+describe Battlecry do
+
+  before do
+    @battlecry = Battlecry.new [{ :host => "localhost" }]
+  end
+  
+  it "should have a version" do
+      Battlecry.const_defined?("VERSION").should == true
+  end
+
+  it "should take a list of allies" do
+      @battlecry.num_allies.should equal(1)
+  end
+
+  it "should shout" do
+      @battlecry.should respond_to(:shout)
+  end
+ 
+  it "should allow additional allies" do
+      @battlecry.should respond_to(:add_ally)
+  end
+  
+  it "should increase the army size when adding an ally" do
+      @battlecry.add_ally "site.com"
+      @battlecry.num_allies.should equal(2)
+  end
+  
+  it "should shout and show a growl" do
+      @battlecry.shout "Test"
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,3 @@
+$:.unshift(File.dirname(__FILE__) + "/../lib/")
+
+require "battlecry"

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: battlecry
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Dan Simpson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-16 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-growl
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :runtime
+  version_requirements: *id001
+description: A simple abstraction for sydicating messages to OSX hosts via Growl
+email: dan.simpson@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- battlecry.gemspec
+- Rakefile
+- spec/helper.rb
+- spec/battlecry_spec.rb
+- lib/battlecry.rb
+has_rdoc: true
+homepage: http://github.com/dansimpson/battlecry
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simple abstraction for sydicating messages to OSX hosts via Growl
+test_files: []
+