prowl 0.1.2 → 0.1.3

data/README

@@ -22,11 +22,12 @@
      together and lets you send push notifications via HTTP
      to any iPhone that has the prowl app installed.
      
-          Prowl.add("api key abc123def456", {
+          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
@@ -35,18 +36,19 @@
       
       --~~ Usage ~~--
       
-      Three required parameters:
-      
-          :application
-          :event
-          :description
+      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", :application => "Foo", ...)
+      Prowl.add(:apikey => "123abc", :application => "Foo", ...)
       Prowl.verify("apikey")
   
-      p = Prowl.new("apikey123abc")
+      p = Prowl.new(:apikey => "apikey123abc", :application => "FooApp")
       p.valid?
-      p.add(...)
+      p.add(:event => "It's valid", ...)

data/lib/prowl.rb

@@ -5,45 +5,65 @@ 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(api_key)
-    @api_key = api_key
+  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(api_key, params = {})
-    new(api_key).add(params)
+  def self.add(params = {})
+    new(params).add
   end
   
   # Utility function to verify API keys
-  def self.verify(api_key)
-    new(api_key).valid?
+  def self.verify(apikey)
+    new({:apikey => apikey}).valid?
   end
   
   private
   
-  def perform(action, params)
-    if !@api_key
+  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
     
-    params[:apikey] = @api_key
+    # 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)
@@ -60,6 +80,6 @@ end
 if __FILE__ == $0
   api_key = "change me"
   
-  p Prowl.add(api_key, :application => "Fishes", :event => "silly", :description => "Awwawaw.", :priority => 1)
-  p Prowl.new(api_key).valid?
+  p Prowl.add(:apikey => api_key, :application => "Fishes", :event => "silly", :description => "Awwawaw.", :priority => 1)
+  p Prowl.verify(api_key)
 end

data/prowl.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "prowl"
-  s.version = "0.1.2"
+  s.version = "0.1.3"
   s.date = "2009-07-08"
   s.authors = ["August Lilleaas"]
   s.email = "augustlilleaas@gmail.com"

data/test/prowl_test.rb

@@ -8,22 +8,22 @@ require 'mocha'
 
 class ProwlTest < Test::Unit::TestCase
   def test_not_without_an_api_key
-    assert_raises(Prowl::MissingAPIKey) { Prowl.add(nil) }
+    assert_raises(Prowl::MissingAPIKey) { Prowl.add(:apikey => nil) }
   end
   
   def test_invalid_priority
-    assert_raises(Prowl::PriorityOutOfRange) { Prowl.add("foo", :priority => 10)}
+    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("my api key", :application => "Fishes", :event => "Silly", :description => "Blah")
+    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("my api key", :application => "Fishes", :event => "Silly", :description => "Blah")
+    assert_equal 666, Prowl.add(:apikey => "my api key", :application => "Fishes", :event => "Silly", :description => "Blah")
   end
   
   def test_verify_with_api_key

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: prowl
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - August Lilleaas