peterc-prowl 0.1.3

data/README

@@ -0,0 +1,54 @@
+     --~~ Prowl ~~--
+     
+     Ruby wrapper for http://prowl.weks.net/.
+     Written by August Lilleaas (http://august.lilleaas.net/).
+     
+     Note: `send` has been renamed to `add`.
+     
+     
+     --~~ Installation ~~--
+     
+        gem install prowl
+        
+     or
+     
+        gem install augustl-prowl --source=http://gems.github.com/
+        
+     Code available here: http://github.com/augustl/ruby-prowl/tree
+     
+     --~~ About ~~--
+     
+     Prowl rocks! It's a webapp and a iPhone app that works
+     together and lets you send push notifications via HTTP
+     to any iPhone that has the prowl app installed.
+     
+          Prowl.add(
+            :apikey => "api key abc123def456",
+            :application => "World Saving Project Manager",
+            :event => "Canceled",
+            :description => "It sucked, so I canceled it. Sorry :("
+          )
+
+      The user has given you its API key. That lets you
+      send push notifications to the users iPhone, through
+      the Prowl iPhone app.
+      
+      
+      --~~ Usage ~~--
+      
+      Four required parameters:
+          
+          :apikey (string / array of strings)
+          :application (string)
+          :event (string)
+          :description (string)
+          
+      You can use Prowl.add, or create instances of Prowl
+      manually.
+      
+      Prowl.add(:apikey => "123abc", :application => "Foo", ...)
+      Prowl.verify("apikey")
+  
+      p = Prowl.new(:apikey => "apikey123abc", :application => "FooApp")
+      p.valid?
+      p.add(:event => "It's valid", ...)

data/Rakefile

@@ -0,0 +1,6 @@
+task :upload_rubyforge_site do
+  content = "<pre>#{File.read('README')}</pre>"
+  File.open("index.html", "w+") {|f| f << content }
+  `scp index.html leethal@rubyforge.org:/var/www/gforge-projects/prowl`
+  File.delete("index.html")
+end

data/lib/prowl.rb

@@ -0,0 +1,85 @@
+require 'cgi'
+require 'net/https'
+require 'uri'
+
+
+class Prowl
+  class MissingAPIKey < RuntimeError; end
+  class TooManyAPIKeys < RuntimeError; end
+  class PriorityOutOfRange < RuntimeError; end
+  
+  API_URL = "https://prowl.weks.net:443/publicapi"
+  MAX_API_KEYS = 5
+  PRIORITY_RANGE = -2..2
+  
+  def initialize(defaults = {})
+    @defaults = defaults
+  end
+  
+  def add(params = {})
+    perform("add", params)
+  end
+  
+  # Modify this instance's defaults
+  def defaults(params)
+    @defaults = @defaults.merge(params)
+  end
+  
+  def valid?
+    @valid ||= (perform("verify") == 200)
+  end
+  
+  # Utility function that creates an instance and sends a prowl
+  def self.add(params = {})
+    new(params).add
+  end
+  
+  # Utility function to verify API keys
+  def self.verify(apikey)
+    new({:apikey => apikey}).valid?
+  end
+  
+  private
+  
+  def perform(action, params = {})
+    # Merge the default params with any custom ones
+    unless !@defaults
+      params = @defaults.merge(params)
+    end
+    
+    if !params[:apikey] || (params[:apikey].is_a?(Array) && params[:apikey].size < 1)
+      raise MissingAPIKey
+    end
+    
+    # Raise an exception if we're trying to use more API keys than allowed for this action
+    if params[:apikey].is_a?(Array) && ((action == "verify" && params[:apikey].size > 1) || params[:apikey].size > MAX_API_KEYS)
+      raise TooManyAPIKeys
+    end
+    
+    if params[:priority] && !PRIORITY_RANGE.include?(params[:priority])
+      raise PriorityOutOfRange
+    end
+    
+    # If there are multiple API Keys in an array, merge them into a comma-delimited string
+    if params[:apikey].is_a?(Array)
+      params[:apikey] = params[:apikey].collect{|v| v + ","}.to_s.chop.chop
+    end
+    
+    uri = URI.parse("#{API_URL}/#{action}")
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    
+    request = Net::HTTP::Get.new(uri.request_uri + "?" + params.map {|k, v| "#{k}=#{CGI.escape(v.to_s)}"}.join("&"))
+    response = http.request(request)
+    return response.code.to_i
+  end
+end
+
+# For me and my good friend friend Textmate.
+if __FILE__ == $0
+  api_key = "change me"
+  
+  p Prowl.add(:apikey => api_key, :application => "Fishes", :event => "silly", :description => "Awwawaw.", :priority => 1)
+  p Prowl.verify(api_key)
+end

data/peterc-prowl.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name = "peterc-prowl"
+  s.version = "0.1.3"
+  s.date = "2009-07-08"
+  s.authors = ["August Lilleaas"]
+  s.email = "augustlilleaas@gmail.com"
+  s.rubyforge_project = "prowl"
+  s.has_rdoc = true
+  s.summary = "Wrapprer for prowl, http://prowl.weks.net/."
+  s.homepage = "http://prowl.rubyforge.org/"
+  s.files = [
+    "lib/prowl.rb",
+    "peterc-prowl.gemspec",
+    "Rakefile",
+    "README",
+    "test/prowl_test.rb"
+  ]
+end

data/test/prowl_test.rb

@@ -0,0 +1,36 @@
+require 'test/unit'
+
+$LOAD_PATH << File.expand_path("#{File.dirname(__FILE__)}/../lib")
+require 'prowl'
+
+require 'rubygems'
+require 'mocha'
+
+class ProwlTest < Test::Unit::TestCase
+  def test_not_without_an_api_key
+    assert_raises(Prowl::MissingAPIKey) { Prowl.add(:apikey => nil) }
+  end
+  
+  def test_invalid_priority
+    assert_raises(Prowl::PriorityOutOfRange) { Prowl.add(:apikey => "foo", :priority => 10)}
+  end
+  
+  def test_valid_api_key
+    Prowl.any_instance.expects(:perform).returns(200)
+    assert_equal 200, Prowl.add(:apikey => "my api key", :application => "Fishes", :event => "Silly", :description => "Blah")
+  end
+  
+  # Uh.. Such a silly test.
+  def test_invalid_api_key
+    Prowl.any_instance.expects(:perform).returns(666)
+    assert_equal 666, Prowl.add(:apikey => "my api key", :application => "Fishes", :event => "Silly", :description => "Blah")
+  end
+  
+  def test_verify_with_api_key
+    Prowl.any_instance.expects(:perform).returns(200)
+    assert Prowl.verify("my api key")
+    
+    Prowl.any_instance.expects(:perform).returns(666)
+    assert !Prowl.verify("my api key")
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: peterc-prowl
+version: !ruby/object:Gem::Version 
+  version: 0.1.3
+platform: ruby
+authors: 
+- August Lilleaas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-08 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: augustlilleaas@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/prowl.rb
+- peterc-prowl.gemspec
+- Rakefile
+- README
+- test/prowl_test.rb
+has_rdoc: true
+homepage: http://prowl.rubyforge.org/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: []
+
+rubyforge_project: prowl
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Wrapprer for prowl, http://prowl.weks.net/.
+test_files: []
+