prowl 0.1.1 → 0.1.2

data/README

@@ -3,6 +3,8 @@
      Ruby wrapper for http://prowl.weks.net/.
      Written by August Lilleaas (http://august.lilleaas.net/).
      
+     Note: `send` has been renamed to `add`.
+     
      
      --~~ Installation ~~--
      
@@ -20,11 +22,10 @@
      together and lets you send push notifications via HTTP
      to any iPhone that has the prowl app installed.
      
-          Prowl.send({
+          Prowl.add("api key abc123def456", {
             :application => "World Saving Project Manager",
             :event => "Canceled",
-            :description => "It sucked, so I canceled it. Sorry :(",
-            :apikey => "abc123def456"
+            :description => "It sucked, so I canceled it. Sorry :("
           })
 
       The user has given you its API key. That lets you
@@ -40,14 +41,12 @@
           :event
           :description
           
-      Other than that, you're free to choose from any of these
-      highly convenient methods.
-      
-      Prowl.send({:apikey => "...", ...})
-      Prowl.send({:username => "...", :password => "...", ...})
-      
-      p = Prowl.new("username", "password")
-      p.send(...)
+      You can use Prowl.add, or create instances of Prowl
+      manually.
       
+      Prowl.add("apikey", :application => "Foo", ...)
+      Prowl.verify("apikey")
+  
       p = Prowl.new("apikey123abc")
-      p.send(...)
+      p.valid?
+      p.add(...)

data/lib/prowl.rb

@@ -2,30 +2,29 @@ require 'cgi'
 require 'net/https'
 require 'uri'
 
-require 'prowl/api_key_handler'
-require 'prowl/http_auth_handler'
 
 class Prowl
-  # new('username', 'password') or new('apikeyhere').
-  def initialize(*args)
-    case args.length
-    when 1 # api key
-      @handler = Prowl::ApiKeyHandler.new(*args)
-    when 2 # username/password
-      @handler = Prowl::HttpAuthHandler.new(*args)
-    else
-      raise ArgumentError
-    end
+  class MissingAPIKey < RuntimeError; end
+  class PriorityOutOfRange < RuntimeError; end
+  
+  API_URL = "https://prowl.weks.net:443/publicapi"
+  PRIORITY_RANGE = -2..2
+  
+  def initialize(api_key)
+    @api_key = api_key
+  end
+  
+  def add(params = {})
+    perform("add", params)
   end
   
-  def send(params)
-    @handler.add(params)
+  def valid?
+    @valid ||= (perform("verify") == 200)
   end
   
   # Utility function that creates an instance and sends a prowl
-  def self.send(*args)
-    params = args.pop
-    new(*args).send(params)
+  def self.add(api_key, params = {})
+    new(api_key).add(params)
   end
   
   # Utility function to verify API keys
@@ -33,39 +32,34 @@ class Prowl
     new(api_key).valid?
   end
   
-  def valid?
-    @handler.valid?
+  private
+  
+  def perform(action, params)
+    if !@api_key
+      raise MissingAPIKey
+    end
+    
+    if params[:priority] && !PRIORITY_RANGE.include?(params[:priority])
+      raise PriorityOutOfRange
+    end
+    
+    params[:apikey] = @api_key
+    
+    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
-  puts "Your API key, please."
-  api_key = gets
+  api_key = "change me"
   
-  if api_key
-    api_key.chomp!
-    p Prowl.send(api_key, :application => "Fishes", :event => "silly", :description => "Awwawaw.")
-  end
-  
-  
-  puts "Test verification?"
-  api_key = gets
-  
-  if api_key
-    api_key.chomp!
-    p Prowl.new(api_key).valid?
-  end
-  
-  puts "Your username, please."
-  username = gets.chomp
-  
-  puts "Your password, please."
-  password = gets.chomp
-  
-  if username
-    username.chomp!
-    password.chomp!
-    p Prowl.send(username, password, :application => "Fishes", :event => "silly", :description => "Awwawaw.")
-  end
+  p Prowl.add(api_key, :application => "Fishes", :event => "silly", :description => "Awwawaw.", :priority => 1)
+  p Prowl.new(api_key).valid?
 end

data/prowl.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "prowl"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
   s.date = "2009-07-08"
   s.authors = ["August Lilleaas"]
   s.email = "augustlilleaas@gmail.com"
@@ -10,8 +10,6 @@ Gem::Specification.new do |s|
   s.homepage = "http://prowl.rubyforge.org/"
   s.files = [
     "lib/prowl.rb",
-    "lib/prowl/api_key_handler.rb",
-    "lib/prowl/http_auth_handler.rb",
     "prowl.gemspec",
     "Rakefile",
     "README",

data/test/prowl_test.rb

@@ -7,37 +7,30 @@ require 'rubygems'
 require 'mocha'
 
 class ProwlTest < Test::Unit::TestCase
+  def test_not_without_an_api_key
+    assert_raises(Prowl::MissingAPIKey) { Prowl.add(nil) }
+  end
+  
+  def test_invalid_priority
+    assert_raises(Prowl::PriorityOutOfRange) { Prowl.add("foo", :priority => 10)}
+  end
+  
   def test_valid_api_key
-    Prowl::ApiKeyHandler.any_instance.expects(:perform).returns(200)
-    assert_equal 200, Prowl.send("my api key", :application => "Fishes", :event => "Silly", :description => "Blah")
+    Prowl.any_instance.expects(:perform).returns(200)
+    assert_equal 200, Prowl.add("my api key", :application => "Fishes", :event => "Silly", :description => "Blah")
   end
   
   # Uh.. Such a silly test.
   def test_invalid_api_key
-    Prowl::ApiKeyHandler.any_instance.expects(:perform).returns(666)
-    assert_equal 666, Prowl.send("my api key", :application => "Fishes", :event => "Silly", :description => "Blah")
+    Prowl.any_instance.expects(:perform).returns(666)
+    assert_equal 666, Prowl.add("my api key", :application => "Fishes", :event => "Silly", :description => "Blah")
   end
   
-  def test_valid_with_api_key
-    Prowl::ApiKeyHandler.any_instance.expects(:perform).returns(200)
+  def test_verify_with_api_key
+    Prowl.any_instance.expects(:perform).returns(200)
     assert Prowl.verify("my api key")
     
-    Prowl::ApiKeyHandler.any_instance.expects(:perform).returns(666)
+    Prowl.any_instance.expects(:perform).returns(666)
     assert !Prowl.verify("my api key")
   end
-  
-  def test_http_auth
-    Prowl::HttpAuthHandler.any_instance.expects(:add).returns(200)
-    assert_equal 200, Prowl.send("username", "password", :application => "Fishes", :event => "Silly", :description => "Blah")
-  end
-  
-  # Also uh..
-  def test_failed_http_auth
-    Prowl::HttpAuthHandler.any_instance.expects(:add).returns(666)
-    assert_equal 666, Prowl.send("username", "password", :application => "Fishes", :event => "Silly", :description => "Blah")
-  end
-  
-  def test_valid_with_username_and_password
-    assert_raises(RuntimeError) { Prowl.new("username", "password").valid? }
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: prowl
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - August Lilleaas
@@ -23,14 +23,14 @@ extra_rdoc_files: []
 
 files: 
 - lib/prowl.rb
-- lib/prowl/api_key_handler.rb
-- lib/prowl/http_auth_handler.rb
 - prowl.gemspec
 - Rakefile
 - README
 - test/prowl_test.rb
 has_rdoc: true
 homepage: http://prowl.rubyforge.org/
+licenses: []
+
 post_install_message: 
 rdoc_options: []
 
@@ -51,9 +51,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: prowl
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Wrapprer for prowl, http://prowl.weks.net/.
 test_files: []
 

data/lib/prowl/api_key_handler.rb

@@ -1,31 +0,0 @@
-class Prowl
-  class ApiKeyHandler
-    API_URL = "https://prowl.weks.net:443/publicapi"
-    
-    def initialize(api_key)
-      @api_key = api_key
-    end
-    
-    def valid?
-      @valid ||= (perform("verify", :apikey => @api_key) == 200)
-    end
-    
-    def add(params)
-      perform("add", params)
-    end
-    
-    private
-    
-    def perform(action, params)
-      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
-      
-      params[:apikey] = @api_key
-      request = Net::HTTP::Get.new(uri.request_uri + "?" + params.map {|k, v| "#{k}=#{CGI.escape(v)}"}.join("&"))
-      response = http.request(request)
-      return response.code.to_i
-    end
-  end
-end

data/lib/prowl/http_auth_handler.rb

@@ -1,24 +0,0 @@
-class Prowl
-  class HttpAuthHandler
-    API_URL = URI.parse("https://prowl.weks.net:443/api/add_notification.php")
-    
-    def initialize(username, password)
-      @username, @password = username, password
-    end
-    
-    def valid?
-      raise RuntimeError, "The API doesn't provide a method for determining if a username/password is valid."
-    end
-    
-    def add(params)
-      http = Net::HTTP.new(API_URL.host, API_URL.port)
-      http.use_ssl = true
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      
-      request = Net::HTTP::Get.new(API_URL.request_uri + "?" + params.map {|k, v| "#{k}=#{CGI.escape(v)}"}.join("&"))
-      request.basic_auth @username, @password
-      response = http.request(request)
-      return response.code.to_i
-    end
-  end
-end