pixeltrix-prowler 1.0.1 → 1.0.2

data/CHANGELOG

@@ -0,0 +1,15 @@
+*1.0.2 (July 8th, 2009)
+
+* Switch to new API using apikey and deprecate old API
+
+
+*1.0.1 (July 7th, 2009)
+
+* Update RDoc documentation
+
+* Use Jeweler for gem management
+
+
+*1.0.0 (July 7th, 2009)
+
+* First release

data/INSTALL

@@ -14,8 +14,7 @@ CONFIGURATION
 You should have something like this in config/initializers/prowler.rb.
 
   Prowler.configure do |config|
-    config.username = 'username'
-    config.password = 'password'
+    config.api_key = 'ffffffffffffffffffffffffffffffffffffffff'
     config.application = 'www.example.com'
   end
 
@@ -31,7 +30,7 @@ USAGE
 
 To use Prowler within your application just call the notify method, e.g.
 
-  Prowler.notify "Event", "Description"
+  Prowler.notify "Event", "Description", Prowler::Priority::NORMAL
 
 ABOUT
 

data/README

@@ -14,8 +14,7 @@ CONFIGURATION
 You should have something like this in config/initializers/prowler.rb.
 
   Prowler.configure do |config|
-    config.username = 'username'
-    config.password = 'password'
+    config.api_key = 'ffffffffffffffffffffffffffffffffffffffff'
     config.application = 'www.example.com'
   end
 
@@ -31,7 +30,7 @@ USAGE
 
 To use Prowler within your application just call the notify method, e.g.
 
-  Prowler.notify "Event", "Description"
+  Prowler.notify "Event", "Description", Prowler::Priority::NORMAL
 
 ABOUT
 

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.0.2

data/lib/prowler.rb

@@ -11,8 +11,7 @@
 # You should have something like this in config/initializers/prowler.rb.
 #
 #   Prowler.configure do |config|
-#     config.username = 'username'
-#     config.password = 'password'
+#     config.api_key = 'ffffffffffffffffffffffffffffffffffffffff'
 #     config.application = 'www.example.com'
 #   end
 #
@@ -28,7 +27,7 @@
 #
 # To use Prowler within your application just call the notify method, e.g.
 #
-#   Prowler.notify "Event", "Description"
+#   Prowler.notify "Event", "Description", Prowler::Priority::NORMAL
 #
 # === About
 #
@@ -44,9 +43,18 @@ require 'net/http'
 require 'net/https'
 
 module Prowler
+
+  module Priority
+    VERY_LOW  = -2
+    MODERATE  = -1
+    NORMAL    = 0
+    HIGH      = 1
+    EMERGENCY = 2
+  end
+
   class << self
     attr_accessor :host, :port, :secure
-    attr_accessor :username, :password
+    attr_accessor :api_key, :username, :password
     attr_accessor :application, :send_notifications
 
     # The host to connect to.
@@ -69,6 +77,11 @@ module Prowler
       yield self
     end
 
+    def username=(value) #:nodoc:
+      logger.warn "The username/password API has been deprecated please switch to using an API key."
+      @username = value
+    end
+
     # Whether to send notifications
     def send_notifications
       @send_notifications.nil? ? true : !!@send_notifications
@@ -77,15 +90,19 @@ module Prowler
 
     # Reset configuration
     def reset_configuration
-      @host = @port = @secure = @application = @username = @password = nil
+      @host = @port = @secure = @application = @username = @password = @api_key = nil
     end
 
     # Whether the library has been configured
     def configured?
-      !(@application.nil? || @username.nil? || @password.nil?)
+      !@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
 
@@ -97,9 +114,10 @@ module Prowler
     end
 
     # Send a notification to your iPhone:
-    # * event: The title of notification you want to send.
-    # * message: The text of the notification message you want to send.
-    def notify(event, message)
+    # * event:    The title of notification you want to send.
+    # * message:  The text of the notification message you want to send.
+    # * priority: The priority of the notification - see Prowler::Priority. (Optional)
+    def notify(event, message, priority = Priority::NORMAL)
       raise RuntimeError, "Prowler needs to be configured first before using it" unless configured?
 
       http = Net::HTTP.new(host, port)
@@ -111,8 +129,12 @@ module Prowler
         }
         http.read_timeout = 5 # seconds
         http.open_timeout = 2 # seconds
-        request = Net::HTTP::Get.new(path(URI.escape(application), URI.escape(event), URI.escape(message)), headers)
-        request.basic_auth(username, password)
+        if api_key
+          request = Net::HTTP::Get.new(path(api_key, priority, URI.escape(application), URI.escape(event), URI.escape(message)), headers)
+        else
+          request = Net::HTTP::Get.new(deprecated_path(URI.escape(application), URI.escape(event), URI.escape(message)), headers)
+          request.basic_auth(username, password)
+        end
         response = begin
                      http.request(request) if send_notifications?
                    rescue TimeoutError => e

data/prowler.gemspec

@@ -2,18 +2,19 @@
 
 Gem::Specification.new do |s|
   s.name = %q{prowler}
-  s.version = "1.0.1"
+  s.version = "1.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrew White"]
-  s.date = %q{2009-07-07}
+  s.date = %q{2009-07-08}
   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 = [
     "README"
   ]
   s.files = [
-    "INSTALL",
+    "CHANGELOG",
+     "INSTALL",
      "MIT-LICENSE",
      "README",
      "Rakefile",

data/test/prowler_test.rb

@@ -16,17 +16,15 @@ class ProwlerTest < Test::Unit::TestCase
         config.host = "prowler"
         config.port = 666
         config.secure = false
+        config.api_key = "apikey"
         config.application = "application"
-        config.username = "username"
-        config.password = "password"
       end
 
       assert_equal "prowler",     Prowler.host
       assert_equal 666,           Prowler.port
       assert_equal false,         Prowler.secure
+      assert_equal "apikey",      Prowler.api_key
       assert_equal "application", Prowler.application
-      assert_equal "username",    Prowler.username
-      assert_equal "password",    Prowler.password
     end
 
     should "set a default host" do
@@ -45,6 +43,43 @@ class ProwlerTest < Test::Unit::TestCase
       assert_equal nil, Prowler.application
     end
 
+    should "not set a default API key" do
+      assert_equal nil, Prowler.api_key
+    end
+
+    should "raise an exception if not configured" do
+      assert_raises RuntimeError do
+        Prowler.notify("Event", "Description", Prowler::Priority::NORMAL)
+      end
+    end
+  end
+
+  context "Prowler deprecated configuration" do
+    setup do
+      Logger.any_instance.stubs(:warn)
+      Prowler.reset_configuration
+      Prowler.send_notifications = false
+    end
+
+    should "be done with a block" do
+      Prowler.configure do |config|
+        config.host = "prowler"
+        config.port = 666
+        config.secure = false
+        config.application = "application"
+        config.username = "username"
+        config.password = "password"
+      end
+
+      assert_equal "username",    Prowler.username
+      assert_equal "password",    Prowler.password
+    end
+
+    should "log a warning when using the deprecated API" do
+      Logger.any_instance.expects(:warn).with("The username/password API has been deprecated please switch to using an API key.")
+      Prowler.configure { |config| config.username = "username" }
+    end
+
     should "not set a default username" do
       assert_equal nil, Prowler.username
     end
@@ -55,7 +90,7 @@ class ProwlerTest < Test::Unit::TestCase
 
     should "raise an exception if not configured" do
       assert_raises RuntimeError do
-        Prowler.notify "Event", "Description"
+        Prowler.notify("Event", "Description", Prowler::Priority::NORMAL)
       end
     end
   end
@@ -64,34 +99,28 @@ class ProwlerTest < Test::Unit::TestCase
     setup do
       Prowler.reset_configuration
       Prowler.configure do |config|
+        config.api_key = "apikey"
         config.application = "Application Name"
-        config.username = "username"
-        config.password = "password"
       end
       Prowler.send_notifications = false
     end
 
     should "encode the url parameters" do
       expectation = Prowler.expects(:path)
-      expectation.with("Application%20Name", "Event%20Name", "Message%20Text")
-      expectation.returns("/api/add_notification.php?application=Application%20Name&event=Event%20Name&description=Message%20Text")
-      Prowler.notify("Event Name", "Message Text")
+      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)
-      Prowler.notify("Event Name", "Message Text")
-    end
-
-    should "use HTTP Basic Authentication" do
-      Net::HTTP::Get.any_instance.expects(:basic_auth).with(Prowler.username, Prowler.password)
-      Prowler.notify("Event Name", "Message Text")
+      Prowler.notify("Event Name", "Message Text", Prowler::Priority::NORMAL)
     end
 
     should "not send notifications if send_notifications is false" do
       Net::HTTP.any_instance.expects(:request).never
-      Prowler.notify("Event Name", "Message Text")
+      Prowler.notify("Event Name", "Message Text", Prowler::Priority::NORMAL)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pixeltrix-prowler
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors: 
 - Andrew White
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-07 00:00:00 -07:00
+date: 2009-07-08 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -22,6 +22,7 @@ extensions: []
 extra_rdoc_files: 
 - README
 files: 
+- CHANGELOG
 - INSTALL
 - MIT-LICENSE
 - README