pixeltrix-prowler 1.0.2 → 1.0.3

data/CHANGELOG

@@ -1,3 +1,10 @@
+*1.0.3 (July 9th, 2009)
+
+* Add verify method for configured API key
+
+* Use POST to send notifications
+
+
 *1.0.2 (July 8th, 2009)
 
 * Switch to new API using apikey and deprecate old API

data/VERSION

@@ -1 +1 @@
-1.0.2
+1.0.3

data/lib/prowler.rb

@@ -44,6 +44,11 @@ require 'net/https'
 
 module Prowler
 
+  API_PATH = "/publicapi/add"
+  DEPRECATED_API_PATH = "/api/add_notification.php?application=%s&event=%s&description=%s"
+  VERIFY_PATH = "/publicapi/verify?apikey=%s"
+  USER_AGENT = "Prowler/1.0.3"
+
   module Priority
     VERY_LOW  = -2
     MODERATE  = -1
@@ -98,14 +103,6 @@ module Prowler
       !@application.nil? && (!@api_key.nil? || !(@username.nil? || @password.nil?))
     end
 
-    def path(*params) #:nodoc:
-      sprintf("/publicapi/add?apikey=%s&priority=%d&application=%s&event=%s&description=%s", *params)
-    end
-
-    def deprecated_path(*params) #:nodoc:
-      sprintf("/api/add_notification.php?application=%s&event=%s&description=%s", *params)
-    end
-
     # Returns the default logger or a logger that prints to STDOUT.
     def logger
       ActiveRecord::Base.logger
@@ -125,14 +122,15 @@ module Prowler
       http.verify_mode = OpenSSL::SSL::VERIFY_NONE
       http.start do
         headers = {
-          'User-Agent' => 'ProwlScript/1.0'
+          'User-Agent' => USER_AGENT
         }
         http.read_timeout = 5 # seconds
         http.open_timeout = 2 # seconds
         if api_key
-          request = Net::HTTP::Get.new(path(api_key, priority, URI.escape(application), URI.escape(event), URI.escape(message)), headers)
+          request = Net::HTTP::Post.new(API_PATH, headers)
+          request.set_form_data({ 'apikey' => api_key, 'priority' => priority, 'application' => application, 'event' => event, 'description' => message })
         else
-          request = Net::HTTP::Get.new(deprecated_path(URI.escape(application), URI.escape(event), URI.escape(message)), headers)
+          request = Net::HTTP::Get.new(sprintf(DEPRECATED_API_PATH, URI.escape(application), URI.escape(event), URI.escape(message)), headers)
           request.basic_auth(username, password)
         end
         response = begin
@@ -151,5 +149,36 @@ module Prowler
         end
       end
     end
+
+    # Verify the configured API key is valid
+    def verify
+      raise RuntimeError, "Prowler needs to be configured first before using it" unless api_key
+
+      http = Net::HTTP.new(host, port)
+      http.use_ssl = secure
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      http.start do
+        headers = {
+          'User-Agent' => USER_AGENT
+        }
+        http.read_timeout = 5 # seconds
+        http.open_timeout = 2 # seconds
+        request = Net::HTTP::Get.new(sprintf(VERIFY_PATH, api_key), headers)
+        response = begin
+                     http.request(request) if send_notifications?
+                   rescue TimeoutError => e
+                     logger.error "Timeout while contacting the Prowl server."
+                     nil
+                   end
+        case response
+        when Net::HTTPSuccess then
+          logger.info "Prowl Success: #{response.class}"
+          true
+        else
+          logger.error "Prowl Failure: #{response.class}\n#{response.body if response.respond_to? :body}"
+          false
+        end
+      end
+    end
   end
 end

data/prowler.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{prowler}
-  s.version = "1.0.2"
+  s.version = "1.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrew White"]
-  s.date = %q{2009-07-08}
+  s.date = %q{2009-07-09}
   s.description = %q{A simple wrapper class that provides basic access to the Prowl API.}
   s.email = %q{andyw@pixeltrix.co.uk}
   s.extra_rdoc_files = [

data/test/prowler_test.rb

@@ -105,13 +105,6 @@ class ProwlerTest < Test::Unit::TestCase
       Prowler.send_notifications = false
     end
 
-    should "encode the url parameters" do
-      expectation = Prowler.expects(:path)
-      expectation.with("apikey", 0, "Application%20Name", "Event%20Name", "Message%20Text")
-      expectation.returns("/publicapi/add?apikey=apikey&priority=0application=Application%20Name&event=Event%20Name&description=Message%20Text")
-      Prowler.notify("Event Name", "Message Text", Prowler::Priority::NORMAL)
-    end
-
     should "not verify SSL certificates" do
       Net::HTTP.any_instance.expects(:use_ssl=).with(true)
       Net::HTTP.any_instance.expects(:verify_mode=).with(OpenSSL::SSL::VERIFY_NONE)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pixeltrix-prowler
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors: 
 - Andrew White
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-08 00:00:00 -07:00
+date: 2009-07-09 00:00:00 -07:00
 default_executable: 
 dependencies: []