prowler 1.2.1 → 1.3.0

data/CHANGELOG

@@ -1,4 +1,13 @@
-*1.2.1 (January 27th, 2011)
+*1.3.0 (January 31st, 2011)
+
+* Add retrive_token and retrieve_api_key commands
+
+* Allow passing of API keys to notify and verify
+
+* Use an options hash to initialize instance
+
+
+*1.2.1 (January 30th, 2011)
 
 * Correct typo in providerkey url parameter
 

data/INSTALL

@@ -50,7 +50,7 @@ To use Prowler within your application just call the notify method, e.g.
 If you need to send to multiple accounts from within a single application you
 can create an instance of the Prowler class to override the global settings, e.g.
 
-  prowler = Prowler.new('apikey', 'application')
+  prowler = Prowler.new(:application => 'application', :api_key => 'apikey')
   prowler.notify "Event", "Description"
 
 If performance is a concern then there is built in support for Delayed::Job.

data/README

@@ -49,7 +49,7 @@ To use Prowler within your application just call the notify method, e.g.
 If you need to send to multiple accounts from within a single application you
 can create an instance of the Prowler class to override the global settings, e.g.
 
-  prowler = Prowler.new('apikey', 'application')
+  prowler = Prowler.new(:application => 'application', :api_key => 'apikey')
   prowler.notify "Event", "Description"
 
 If performance is a concern then there is built in support for Delayed::Job.

data/VERSION

@@ -1 +1 @@
-1.2.1
+1.3.0

data/lib/prowler/application.rb

@@ -1,6 +1,7 @@
 require 'prowler/configuration'
 require 'prowler/delayed_job'
 require 'prowler/priority'
+require 'prowler/response'
 require 'prowler/version'
 
 module Prowler
@@ -8,6 +9,7 @@ module Prowler
   SERVICE_URL = "https://prowlapp.com/publicapi"
   USER_AGENT = "Prowler/#{VERSION}"
   MULTIPLE_APIKEY_COMMANDS = %w(add)
+  CONFIG_ATTRS = [:application, :provider_key, :api_key]
 
   class ConfigurationError < StandardError; end
 
@@ -16,75 +18,103 @@ module Prowler
     attr_accessor :application, :send_notifications #:nodoc:
 
     # Create an instance for sending to different accounts within a single Rails application
-    # * api_key:      Your API key.
-    # * application:  The name of your application.
-    # * provider_key: Key to override the rate limit of 1000 requests per hour. (Optional)
-    def initialize(api_key, application, provider_key = nil)
-      @api_key, @application, @provider_key = api_key, application, provider_key
+    # Pass any of the following options to override the global configuration:
+    # * :application:  The name of your application.
+    # * :provider_key: Key to override the rate limit of 1000 requests per hour.
+    # * :api_key:      Your API key.
+    def initialize(*args)
+      if args.empty?
+        CONFIG_ATTRS.each{ |attr| send("#{attr}=".to_sym, Prowler.send(attr)) }
+      elsif args.first.is_a?(Hash)
+        CONFIG_ATTRS.each do |attr|
+          send("#{attr}=".to_sym, args[0][attr] || Prowler.send(attr))
+        end
+      else
+        @api_key, @application, @provider_key = args[0], args[1], args[2]
+      end
     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.
+    # * event:   The title of notification you want to send.
+    # * message: The text of the notification message you want to send.
+    # * api_key: One or more API keys to be notified - uses the configured key(s) if not provided.
     #
     # The following options are supported:
-    # * +:delayed+:  Whether to use Delayed::Job to send notifications. (Optional)
-    # * +:priority+: The priority of the notification - see Prowler::Priority. (Optional)
-    # * +:url+:      A custom url for the Prowl application to open. (Optional)
+    # * :delayed:  Whether to use Delayed::Job to send notifications.
+    # * :priority: The priority of the notification - see Prowler::Priority.
+    # * :url:      A custom url for the Prowl application to open.
     def notify(event, message, *args)
+      api_key = args.first.is_a?(String) || args.first.is_a?(Array) ? args.shift : self.api_key
+
       raise ConfigurationError, "You must provide an API key to send notifications" if api_key.nil?
       raise ConfigurationError, "You must provide an application name to send notifications" if application.nil?
 
-      if args.first.is_a?(Hash)
-        options = args.first
-        options[:priority] ||= Prowler::Priority::NORMAL
-        options[:delayed] ||= Prowler.delayed
+      if args.first.is_a?(Fixnum)
+        options = { :priority => args.shift, :delayed => args.shift || Prowler.delayed }
       else
-        options = {
-          :priority => args.shift || Prowler::Priority::NORMAL,
-          :delayed => args.shift || Prowler.delayed
-        }
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        options = { :priority => Prowler::Priority::NORMAL, :delayed => Prowler.delayed }.merge(options)
       end
 
+      options.merge!(
+        :application => application, :providerkey => provider_key,
+        :apikey => api_key, :event => event, :description => message
+      )
+
       if options.delete(:delayed)
-        enqueue_delayed_job(event, message, options)
+        enqueue_delayed_job(options)
       else
-        perform(
-          :add, api_key, provider_key,
-          options.merge({
-            :application => application,
-            :event => event,
-            :description => message
-          })
-        )
+        perform(:add, options, :post, Success)
       end
     end
 
     # Verify the configured API key is valid
-    def verify
-      raise ConfigurationError, "You must provide an API key to verify" if api_key.nil?
-      perform(:verify, api_key, provider_key, {}, :get)
+    def verify(api_key = nil)
+      raise ConfigurationError, "You must provide an API key to verify" if api_key.nil? && self.api_key.nil?
+      perform(:verify, { :providerkey => provider_key, :apikey => api_key || self.api_key }, :get, Success)
+    end
+
+    # Retrieve a registration token and confirmation url for the initial phase
+    # of fetching an API key for a user. The token is valid for 24 hours.
+    # This API command requires the provider_key to be configured.
+    #
+    # Returns either Prowler::Token object if successful or nil if an error occurs.
+    def retrieve_token
+      raise ConfigurationError, "You must have a provider key to retrieve API keys" if provider_key.nil?
+      perform("retrieve/token", { :providerkey => provider_key }, :get, Token)
+    end
+
+    # Retrieve an API key for a user using the token provided by retrieve_token.
+    # This API command requires the provider_key to be configured.
+    # * token: Token returned by retrieve_token command.
+    #
+    # Returns either Prowler::ApiKey object if successful or nil if an error occurs.
+    def retrieve_api_key(token)
+      raise ConfigurationError, "You must have a provider key to retrieve API keys" if provider_key.nil?
+      perform("retrieve/apikey", { :providerkey => provider_key, :token => token }, :get, ApiKey)
     end
 
     private
-      def perform(command, api_key, provider_key, data = {}, method = :post) #:nodoc:
-        params = { :apikey => format_api_key(command, api_key), :providerkey => provider_key }.merge(data).delete_if { |k,v| v.nil? }
+      def perform(command, params = {}, method = :post, klass = Success) #:nodoc:
+        params[:apikey] = format_api_key(command, params[:apikey]) if params.key?(:apikey)
+        params.delete_if { |k,v| v.nil? }
+
         case method
         when :post
-          perform_post(command, params)
+          perform_post(command, params, klass)
         else
-          perform_get(command, params)
+          perform_get(command, params, klass)
         end
       end
 
-      def enqueue_delayed_job(event, message, options) #:nodoc:
+      def enqueue_delayed_job(options) #:nodoc:
         record = Delayed::Job.enqueue(Prowler::DelayedJob.new do |job|
-          job.api_key = api_key
-          job.provider_key = provider_key
-          job.application = application
-          job.event = event
-          job.message = message
-          job.priority = options[:priority] || Priority::NORMAL
+          job.api_key = options[:apikey]
+          job.provider_key = options[:providerkey]
+          job.application = options[:application]
+          job.event = options[:event]
+          job.message = options[:description]
+          job.priority = options[:priority]
           job.url = options[:url]
         end)
         !record.new_record?
@@ -114,20 +144,20 @@ module Prowler
         send_notifications && Prowler.send_notifications
       end
 
-      def perform_get(command, params) #:nodoc:
+      def perform_get(command, params, klass) #:nodoc:
         url = URI.parse("#{SERVICE_URL}/#{command}?#{params.map{ |k,v| %(#{URI.encode(k.to_s)}=#{URI.encode(v.to_s)}) }.join('&')}")
         request = Net::HTTP::Get.new("#{url.path}?#{url.query}", headers)
-        perform_request(url, request)
+        perform_request(url, request, klass)
       end
 
-      def perform_post(command, params) #:nodoc:
+      def perform_post(command, params, klass) #:nodoc:
         url = URI.parse("#{SERVICE_URL}/#{command}")
         request = Net::HTTP::Post.new(url.path, headers)
         request.form_data = params
-        perform_request(url, request)
+        perform_request(url, request, klass)
       end
 
-      def perform_request(url, request) #:nodoc:
+      def perform_request(url, request, klass) #:nodoc:
         http = Net::HTTP.new(url.host, url.port)
         http.use_ssl = true
         if verify_certificate?
@@ -140,15 +170,25 @@ module Prowler
         http.open_timeout = Prowler.open_timeout
         http.start do
           begin
-            return true unless send_notifications?
-            response = http.request(request)
-            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
+            if send_notifications?
+              response = http.request(request)
+              case response
+              when Net::HTTPSuccess then
+                logger.info "Prowl Success: #{response.class}"
+              else
+                logger.error "Prowl Failure: #{response.class}"
+                klass = Error
+              end
+
+              unless response.body.empty?
+                document = REXML::Document.new(response.body)
+
+                if document && klass == Error
+                  raise klass.new(document) if Prowler.raise_errors
+                elsif document
+                  klass.new(document)
+                end
+              end
             end
           rescue TimeoutError => e
             logger.error "Timeout while contacting the Prowl server."

data/lib/prowler/configuration.rb

@@ -4,6 +4,7 @@ module Prowler
     attr_accessor :application, :send_notifications
     attr_accessor :read_timeout, :open_timeout #:nodoc:
     attr_accessor :delayed, :verify_certificate, :root_certificates
+    attr_accessor :raise_errors
 
     # Call this method to configure your account details in an initializer.
     def configure
@@ -18,6 +19,10 @@ module Prowler
       @delayed.nil? ? false : !!@delayed
     end
 
+    def raise_errors #:nodoc:
+      @raise_errors.nil? ? false : !!@raise_errors
+    end
+
     # Reset configuration
     def reset_configuration
       @application = @api_key = @provider_key = nil

data/lib/prowler/response.rb

@@ -0,0 +1,63 @@
+module Prowler
+  class Error < StandardError
+    # The status code returned by the Prowl API
+    attr_reader :status
+
+    # The error message returned by the Prowl API
+    attr_reader :message
+
+    def initialize(document) #:nodoc:
+      error = document.elements["prowl/error"]
+
+      @status = error.attributes["code"].to_i
+      @message = "Prowl Failure: #{error.text}"
+    end
+  end
+
+  class Success
+    # The status code returned by the Prowl API - always 200
+    attr_reader :status
+
+    # The number of remaining requests until the counter is reset
+    attr_reader :remaining
+
+    # The time when the request counter will be reset
+    attr_reader :reset_date
+
+    def initialize(document) #:nodoc:
+      success = document.elements["prowl/success"]
+
+      @status = success.attributes["code"].to_i
+      @remaining = success.attributes["remaining"].to_i
+      @reset_date = Time.at(success.attributes["resetdate"].to_i)
+    end
+  end
+
+  class Token < Success
+    # The token returned by the Prowl API to use in a retrieve_api_key request
+    attr_reader :token
+
+    # The url to redirect a user to for access confirmation
+    attr_reader :url
+
+    def initialize(document) #:nodoc:
+      super(document)
+
+      retrieve = document.elements["prowl/retrieve"]
+      @token = retrieve.attributes["token"]
+      @url = retrieve.attributes["url"]
+    end
+  end
+
+  class ApiKey < Success
+    # The API key returned by the Prowl API
+    attr_reader :api_key
+
+    def initialize(document) #:nodoc:
+      super(document)
+
+      retrieve = document.elements["prowl/retrieve"]
+      @api_key = retrieve.attributes["apikey"]
+    end
+  end
+end

data/lib/prowler/version.rb

@@ -1,3 +1,3 @@
 module Prowler
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/lib/prowler.rb

@@ -32,7 +32,7 @@
 # If you need to send to multiple accounts from within a single application you
 # can create an instance of the Prowler class to override the global settings, e.g.
 #
-#   prowler = Prowler.new('apikey', 'application')
+#   prowler = Prowler.new(:application => 'application', :api_key => 'apikey')
 #   prowler.notify "Event", "Description", Prowler::Priority::NORMAL
 #
 # If performance is a concern then there is built in support for Delayed::Job.
@@ -57,6 +57,7 @@
 
 require 'logger'
 require 'net/https'
+require 'rexml/document'
 require 'uri'
 
 require 'prowler/application'
@@ -65,31 +66,49 @@ require 'prowler/railtie' if defined?(Rails::Railtie)
 module Prowler
   class << self
     # 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.
+    # * event:   The title of notification you want to send.
+    # * message: The text of the notification message you want to send.
+    # * api_key: One or more API keys to be notified - uses the configured key(s) if not provided.
     #
     # The following options are supported:
-    # * +:delayed+:  Whether to use Delayed::Job to send notifications. (Optional)
-    # * +:priority+: The priority of the notification - see Prowler::Priority. (Optional)
-    # * +:url+:      A custom url for the Prowl application to open. (Optional)
+    # * :delayed:  Whether to use Delayed::Job to send notifications. (Optional)
+    # * :priority: The priority of the notification - see Prowler::Priority. (Optional)
+    # * :url:      A custom url for the Prowl application to open. (Optional)
     def notify(event, message, *args)
-      app = new(api_key, application, provider_key)
-      app.notify(event, message, *args)
+      new.notify(event, message, *args)
     end
 
     # Verify the configured API key is valid
-    def verify
-      app = new(api_key, application, provider_key)
-      app.verify
+    # * api_key: API key to be verified - uses the first configured key(s) if not provided.
+    def verify(api_key = nil)
+      new.verify(api_key)
+    end
+
+    # Retrieve a registration token and confirmation url for the initial phase
+    # of fetching an API key for a user. The token is valid for 24 hours.
+    # This API command requires the provider_key to be configured.
+    #
+    # Returns either Prowler::Token object if successful or nil if an error occurs.
+    def retrieve_token
+      new.retrieve_token
+    end
+
+    # Retrieve an API key for a user using the token provided by retrieve_token.
+    # This API command requires the provider_key to be configured.
+    # * token: Token returned by retrieve_token command.
+    #
+    # Returns either Prowler::ApiKey object if successful or nil if an error occurs.
+    def retrieve_api_key(token)
+      new.retrieve_api_key(token)
     end
 
     # Create an instance for sending to different accounts within a single Rails application
-    # * api_key:      Your API key.
-    # * application:  The name of your application.
-    # * provider_key: Key to override the rate limit of 1000 requests per hour. (Optional)
-    def new(api_key, application, provider_key = nil)
-      Prowler::Application.new(api_key, application, provider_key)
+    # Pass any of the following options to override the global configuration:
+    # * :application:  The name of your application.
+    # * :provider_key: Key to override the rate limit of 1000 requests per hour.
+    # * :api_key:      Your API key.
+    def new(*args)
+      Prowler::Application.new(*args)
     end
   end
 end
-

data/prowler.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{prowler}
-  s.version = "1.2.1"
+  s.version = "1.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrew White"]
-  s.date = %q{2011-01-30}
+  s.date = %q{2011-01-31}
   s.description = %q{A plugin/gem that provides access to the Prowl API (http://prowlapp.com). Works with Rails 2 or 3 as well as any other Ruby web frameworks or in your own scripts.}
   s.email = %q{andyw@pixeltrix.co.uk}
   s.extra_rdoc_files = [
@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
     "lib/prowler/delayed_job.rb",
     "lib/prowler/priority.rb",
     "lib/prowler/railtie.rb",
+    "lib/prowler/response.rb",
     "lib/prowler/tasks.rb",
     "lib/prowler/version.rb",
     "prowler.gemspec",

data/test/prowler_test.rb

@@ -26,10 +26,12 @@ class ProwlerTest < Test::Unit::TestCase
       Prowler.configure do |config|
         config.api_key = "apikey"
         config.application = "application"
+        config.provider_key = "providerkey"
       end
 
       assert_equal "apikey",      Prowler.api_key
       assert_equal "application", Prowler.application
+      assert_equal "providerkey", Prowler.provider_key
     end
 
     should "not set a default application" do
@@ -40,10 +42,38 @@ class ProwlerTest < Test::Unit::TestCase
       assert_equal nil, Prowler.api_key
     end
 
-    should "override class configuration when using an instance" do
-      prowler = Prowler.new("apikey2", "application2")
-      assert_equal "apikey2",      prowler.api_key
-      assert_equal "application2", prowler.application
+    context "when using an instance" do
+      setup do
+        Prowler.reset_configuration
+
+        Prowler.configure do |config|
+          config.api_key = "apikey"
+          config.application = "application"
+          config.provider_key = "providerkey"
+        end
+      end
+
+      should "inheirit config from global scope" do
+        prowler = Prowler.new
+        assert_equal "apikey",      prowler.api_key
+        assert_equal "application", prowler.application
+        assert_equal "providerkey", prowler.provider_key
+      end
+
+      should "override application config" do
+        prowler = Prowler.new(:application => "application2")
+        assert_equal "application2", prowler.application
+      end
+
+      should "override provider_key config" do
+        prowler = Prowler.new(:provider_key => "providerkey2")
+        assert_equal "providerkey2", prowler.provider_key
+      end
+
+      should "override api_key config" do
+        prowler = Prowler.new(:api_key => "apikey2")
+        assert_equal "apikey2", prowler.api_key
+      end
     end
   end
 
@@ -59,12 +89,12 @@ class ProwlerTest < Test::Unit::TestCase
     should "raise an exception if API key not configured" do
       Prowler.reset_configuration
       assert_raises Prowler::ConfigurationError do
-        Prowler.notify("Event", "Description")
+        Prowler.notify "Event", "Description"
       end
 
       prowler = Prowler.new(nil, nil)
       assert_raises Prowler::ConfigurationError do
-        prowler.notify("Event", "Description")
+        prowler.notify "Event", "Description"
       end
     end
 
@@ -74,12 +104,12 @@ class ProwlerTest < Test::Unit::TestCase
         config.api_key = "apikey"
       end
       assert_raises Prowler::ConfigurationError do
-        Prowler.notify("Event", "Description", Prowler::Priority::NORMAL)
+        Prowler.notify "Event", "Description"
       end
 
       prowler = Prowler.new("apikey", nil)
       assert_raises Prowler::ConfigurationError do
-        prowler.notify("Event", "Description", Prowler::Priority::NORMAL)
+        prowler.notify "Event", "Description"
       end
     end
 
@@ -89,7 +119,7 @@ class ProwlerTest < Test::Unit::TestCase
       Net::HTTP.any_instance.expects(:ca_file=).with(File.expand_path('config/cacert.pem', RAILS_ROOT))
 
       Prowler.send_notifications = false
-      Prowler.notify("Event Name", "Message Text")
+      Prowler.notify "Event Name", "Message Text"
     end
 
     should "not verify SSL certificates if verification is turned off" do
@@ -98,61 +128,199 @@ class ProwlerTest < Test::Unit::TestCase
 
       Prowler.send_notifications = false
       Prowler.verify_certificate = false
-      Prowler.notify("Event Name", "Message Text")
+      Prowler.notify "Event Name", "Message Text"
     end
 
     should "not send notifications if send_notifications is false" do
+      stub_request(:post, "#{Prowler::SERVICE_URL}/add")
+
       Prowler.send_notifications = false
-      assert_not_notified Prowler, "Event Name", "Message Text"
+      Prowler.notify "Event Name", "Message Text"
+
+      assert_not_requested :post, "#{Prowler::SERVICE_URL}/add"
     end
 
     should "send multiple API keys if configured" do
+      stub_request :post, "#{Prowler::SERVICE_URL}/add"
+
       Prowler.api_key = %w(apikey1 apikey2)
-      assert_notified Prowler, "Event Name", "Message Text"
+      Prowler.notify "Event Name", "Message Text"
+
+      assert_requested :post, "#{Prowler::SERVICE_URL}/add", :body => {
+        :application => "Application Name",
+        :apikey => "apikey1,apikey2",
+        :event => "Event Name",
+        :description => "Message Text",
+        :priority => Prowler::Priority::NORMAL.to_s
+      }
     end
 
     should "log a successful response" do
+      stub_request(:post, "#{Prowler::SERVICE_URL}/add")
+
       Prowler.logger.expects(:info).with("Prowl Success: Net::HTTPOK")
-      assert_notified Prowler, "Event Name", "Message Text"
+      Prowler.notify "Event Name", "Message Text"
+
+      assert_requested :post, "#{Prowler::SERVICE_URL}/add", :body => {
+        :application => "Application Name",
+        :apikey => "apikey",
+        :event => "Event Name",
+        :description => "Message Text",
+        :priority => Prowler::Priority::NORMAL.to_s
+      }
     end
 
     should "log an error response" do
-      Prowler.logger.expects(:error).with("Prowl Failure: Net::HTTPInternalServerError\n")
-      assert_notified Prowler, "Event Name", "Message Text" do |request|
-        request.to_return(:status => 500, :body => "", :headers => {})
-      end
+      stub_request(:post, "#{Prowler::SERVICE_URL}/add").
+        to_return(:status => 500, :headers => {}, :body => "")
+
+      Prowler.logger.expects(:error).with("Prowl Failure: Net::HTTPInternalServerError")
+      Prowler.notify "Event Name", "Message Text"
+
+      assert_requested :post, "#{Prowler::SERVICE_URL}/add", :body => {
+        :application => "Application Name",
+        :apikey => "apikey",
+        :event => "Event Name",
+        :description => "Message Text",
+        :priority => Prowler::Priority::NORMAL.to_s
+      }
     end
 
     should "delay sending if configured globally" do
-      Prowler.delayed = true
-      assert_delayed Prowler, "Event Name", "Message Text"
-    end
+      Prowler::Application.any_instance.expects(:enqueue_delayed_job).with(
+        :application => "Application Name",
+        :providerkey => nil,
+        :apikey => "apikey",
+        :event => "Event Name",
+        :description => "Message Text",
+        :priority => Prowler::Priority::NORMAL
+      )
 
-    should "delay sending using deprecated parameter" do
-      Prowler.delayed = false
-      assert_delayed Prowler, "Event Name", "Message Text", Prowler::Priority::NORMAL, true
+      Prowler.delayed = true
+      Prowler.notify "Event Name", "Message Text"
     end
 
     should "delay sending using options" do
+      Prowler::Application.any_instance.expects(:enqueue_delayed_job).with(
+        :application => "Application Name",
+        :providerkey => nil,
+        :apikey => "apikey",
+        :event => "Event Name",
+        :description => "Message Text",
+        :priority => Prowler::Priority::NORMAL
+      )
+
       Prowler.delayed = false
-      assert_delayed Prowler, "Event Name", "Message Text", :delayed => true
+      Prowler.notify "Event Name", "Message Text", :delayed => true
     end
 
     should "send a custom url" do
-      assert_notified Prowler, "Event Name", "Message Text", :url => "http://www.pixeltrix.co.uk"
-    end
+      stub_request(:post, "#{Prowler::SERVICE_URL}/add")
 
-    should "send with a high priority using deprecated parameter" do
-      assert_notified Prowler, "Event Name", "Message Text", Prowler::Priority::HIGH
+      Prowler.notify "Event Name", "Message Text", :url => "http://www.pixeltrix.co.uk"
+
+      assert_requested :post, "#{Prowler::SERVICE_URL}/add", :body => {
+        :application => "Application Name",
+        :apikey => "apikey",
+        :event => "Event Name",
+        :description => "Message Text",
+        :priority => Prowler::Priority::NORMAL.to_s,
+        :url => "http://www.pixeltrix.co.uk"
+      }
     end
 
     should "send with a high priority using options" do
-      assert_notified Prowler, "Event Name", "Message Text", :priority => Prowler::Priority::HIGH
+      stub_request(:post, "#{Prowler::SERVICE_URL}/add")
+
+      Prowler.notify "Event Name", "Message Text", :priority => Prowler::Priority::HIGH
+
+      assert_requested :post, "#{Prowler::SERVICE_URL}/add", :body => {
+        :application => "Application Name",
+        :apikey => "apikey",
+        :event => "Event Name",
+        :description => "Message Text",
+        :priority => Prowler::Priority::HIGH.to_s
+      }
     end
 
     should "send the provider key if configured" do
+      stub_request(:post, "#{Prowler::SERVICE_URL}/add")
+
       Prowler.provider_key = "providerkey"
-      assert_notified Prowler, "Event Name", "Message Text"
+      Prowler.notify "Event Name", "Message Text"
+
+      assert_requested :post, "#{Prowler::SERVICE_URL}/add", :body => {
+        :application => "Application Name",
+        :providerkey => "providerkey",
+        :apikey => "apikey",
+        :event => "Event Name",
+        :description => "Message Text",
+        :priority => Prowler::Priority::NORMAL.to_s
+      }
+    end
+
+    should "allow passing the API key as a parameter" do
+      stub_request(:post, "#{Prowler::SERVICE_URL}/add")
+
+      Prowler.notify "Event Name", "Message Text", "apikey1"
+
+      assert_requested :post, "#{Prowler::SERVICE_URL}/add", :body => {
+        :application => "Application Name",
+        :apikey => "apikey1",
+        :event => "Event Name",
+        :description => "Message Text",
+        :priority => Prowler::Priority::NORMAL.to_s
+      }
+    end
+
+    should "allow passing multiple API keys as a parameter" do
+      stub_request(:post, "#{Prowler::SERVICE_URL}/add")
+
+      Prowler.notify "Event Name", "Message Text", %w[apikey1 apikey2]
+
+      assert_requested :post, "#{Prowler::SERVICE_URL}/add", :body => {
+        :application => "Application Name",
+        :apikey => "apikey1,apikey2",
+        :event => "Event Name",
+        :description => "Message Text",
+        :priority => Prowler::Priority::NORMAL.to_s
+      }
+    end
+
+    context "when raise_errors is true" do
+      should "raise an exception if the Prowl API returns an error" do
+        stub_request(:post, "#{Prowler::SERVICE_URL}/add").
+          to_return(:status => 500, :headers => {}, :body => <<-EOF
+            <?xml version="1.0" encoding="UTF-8"?>
+            <prowl>
+              <error code="500">Internal Server Error</error>
+            </prowl>
+            EOF
+          )
+
+        assert_raises(Prowler::Error) do
+          Prowler.raise_errors = true
+          Prowler.notify "Event Name", "Message Text"
+        end
+      end
+    end
+
+    context "when raise_errors is false" do
+      should "not raise an exception if the the Prowl API returns an error" do
+        stub_request(:post, "#{Prowler::SERVICE_URL}/add").
+          to_return(:status => 500, :headers => {}, :body => <<-EOF
+            <?xml version="1.0" encoding="UTF-8"?>
+            <prowl>
+              <error code="500">Internal Server Error</error>
+            </prowl>
+            EOF
+          )
+
+        assert_nothing_raised do
+          Prowler.raise_errors = false
+          Prowler.notify "Event Name", "Message Text"
+        end
+      end
     end
   end
 
@@ -178,13 +346,21 @@ class ProwlerTest < Test::Unit::TestCase
     end
 
     should "only verify the first API key" do
+      stub_request :get, "#{Prowler::SERVICE_URL}/verify?apikey=apikey1"
+
       Prowler.api_key = %w(apikey1 apikey2)
-      assert_verified Prowler, "apikey1"
+      Prowler.verify
+
+      assert_requested :get, "#{Prowler::SERVICE_URL}/verify?apikey=apikey1"
     end
 
     should "not send notifications if send_notifications is false" do
+      stub_request :get, "#{Prowler::SERVICE_URL}/verify?apikey=apikey"
+
       Prowler.send_notifications = false
-      assert_not_verified Prowler
+      Prowler.verify
+
+      assert_not_requested :get, "#{Prowler::SERVICE_URL}/verify?apikey=apikey"
     end
 
     should "verify SSL certificates by default" do
@@ -206,108 +382,175 @@ class ProwlerTest < Test::Unit::TestCase
     end
 
     should "send the provider key if configured" do
+      stub_request :get, "#{Prowler::SERVICE_URL}/verify?apikey=apikey&providerkey=providerkey"
+
       Prowler.provider_key = "providerkey"
-      assert_verified Prowler, "apikey", "providerkey"
+      Prowler.verify
+
+      assert_requested :get, "#{Prowler::SERVICE_URL}/verify?apikey=apikey&providerkey=providerkey"
     end
-  end
 
-  private
-    def verify_url
-      "#{Prowler::SERVICE_URL}/verify"
+    should "allow passing an API key as a parameter" do
+      stub_request :get, "#{Prowler::SERVICE_URL}/verify?apikey=apikey1"
+      Prowler.verify "apikey1"
+      assert_requested :get, "#{Prowler::SERVICE_URL}/verify?apikey=apikey1"
     end
 
-    def build_url(config, api_key, provider_key)
-      if provider_key
-        "#{verify_url}?providerkey=#{provider_key}&apikey=#{api_key}"
-      else
-        "#{verify_url}?apikey=#{api_key}"
-      end
+    should "only verify the first API key passed as a parameter" do
+      stub_request :get, "#{Prowler::SERVICE_URL}/verify?apikey=apikey1"
+      Prowler.verify %w[apikey1 apikey2]
+      assert_requested :get, "#{Prowler::SERVICE_URL}/verify?apikey=apikey1"
     end
 
-    def assert_verified(config, api_key = "apikey", provider_key = nil, &block)
-      request = stub_request(:get, build_url(config, api_key, provider_key))
-      request.with(:headers => { "Accept" => "*/*" })
-      request.with(:headers => { "User-Agent" => Prowler::USER_AGENT })
+    context "when raise_errors is true" do
+      should "raise an exception if the Prowl API returns an error" do
+        stub_request(:get, "#{Prowler::SERVICE_URL}/verify?apikey=apikey").
+          to_return(:status => 500, :headers => {}, :body => <<-EOF
+            <?xml version="1.0" encoding="UTF-8"?>
+            <prowl>
+              <error code="500">Internal Server Error</error>
+            </prowl>
+            EOF
+          )
 
-      if block_given?
-        yield request
-      else
-        request.to_return(:status => 200, :body => "", :headers => {})
+        assert_raises(Prowler::Error) do
+          Prowler.raise_errors = true
+          Prowler.verify
+        end
       end
-
-      config.verify
-      assert_requested :get, build_url(config, api_key, provider_key)
     end
 
-    def assert_not_verified(config, api_key = "apikey", provider_key = nil)
-      config.verify
-      assert_not_requested :get, build_url(config, api_key, provider_key)
+    context "when raise_errors is false" do
+      should "not raise an exception if the the Prowl API returns an error" do
+        stub_request(:get, "#{Prowler::SERVICE_URL}/verify?apikey=apikey").
+          to_return(:status => 500, :headers => {}, :body => <<-EOF
+            <?xml version="1.0" encoding="UTF-8"?>
+            <prowl>
+              <error code="500">Internal Server Error</error>
+            </prowl>
+            EOF
+          )
+
+        assert_nothing_raised do
+          Prowler.raise_errors = false
+          Prowler.verify
+        end
+      end
     end
+  end
 
-    def notify_url
-      "#{Prowler::SERVICE_URL}/add"
+  context "Retrieving an API key" do
+    setup do
+      Prowler.reset_configuration
+      Prowler.configure do |config|
+        config.provider_key = "providerkey"
+      end
     end
 
-    def build_request(config, event, message, options)
-      body = {}
-      if options.is_a?(Hash)
-        body["priority"] = (options[:priority] || Prowler::Priority::NORMAL).to_s
-        body["url"] = options[:url] if options[:url]
-      else
-        body["priority"] = (options || Prowler::Priority::NORMAL).to_s
-      end
-      body["application"] = config.application
-      body["event"] = event
-      body["apikey"] = Array(config.api_key).join(",")
-      body["description"] = message
-      body["providerkey"] = config.provider_key if config.provider_key
-      body
-    end
-
-    def assert_notified(config, event, message, options = {}, &block)
-      body = build_request(config, event, message, options)
-
-      request = stub_request(:post, notify_url)
-      request.with(:headers => { "Accept" => "*/*" })
-      request.with(:headers => { "User-Agent" => Prowler::USER_AGENT })
-      request.with(:headers => { "Content-Type" => "application/x-www-form-urlencoded" })
-      request.with(:body => body)
-
-      if block_given?
-        yield request
-      else
-        request.to_return(:status => 200, :body => "", :headers => {})
+    should "raise an exception if the provider key is not configured" do
+      Prowler.reset_configuration
+      assert_raises Prowler::ConfigurationError do
+        Prowler.retrieve_token
       end
 
-      config.notify event, message, options
-      assert_requested :post, notify_url, :body => body
+      assert_raises Prowler::ConfigurationError do
+        Prowler.retrieve_api_key("token")
+      end
     end
 
-    def assert_not_notified(config, event, message, options = {})
-      config.notify event, message
-      assert_not_requested :post, notify_url, :body => build_request(config, event, message, options)
+    should "request a token and return a Prowler::Token instance when successful" do
+      stub_request(:get, "#{Prowler::SERVICE_URL}/retrieve/token?providerkey=providerkey").
+        to_return(:status => 200, :headers => {}, :body => <<-EOF
+          <?xml version="1.0" encoding="UTF-8"?>
+          <prowl>
+            <success code="200" remaining="999" resetdate="1234567890" />
+            <retrieve token="token" url="https://prowlapp.com/retrieve.php?token=token" />
+          </prowl>
+          EOF
+        )
+
+      response = Prowler.retrieve_token
+
+      assert_requested :get, "#{Prowler::SERVICE_URL}/retrieve/token?providerkey=providerkey"
+      assert_instance_of Prowler::Token, response
+      assert_equal response.remaining, 999
+      assert_equal response.reset_date, Time.at(1234567890)
+      assert_equal response.token, "token"
+      assert_equal response.url, "https://prowlapp.com/retrieve.php?token=token"
     end
 
-    def assert_delayed(config, event, message, *args, &block)
-      if args.first.is_a?(Hash) || args.empty?
-        options = args.first || {}
-        delayed = options.delete(:delayed)
-        options[:priority] ||= Prowler::Priority::NORMAL
+    should "request an API key and return a Prowler::ApiKey instance when successful" do
+      stub_request(:get, "#{Prowler::SERVICE_URL}/retrieve/apikey?providerkey=providerkey&token=token").
+        to_return(:status => 200, :headers => {}, :body => <<-EOF
+          <?xml version="1.0" encoding="UTF-8"?>
+          <prowl>
+            <success code="200" remaining="999" resetdate="1234567890" />
+            <retrieve apikey="apikey" />
+          </prowl>
+          EOF
+        )
 
-        Prowler::Application.any_instance.expects(:enqueue_delayed_job).with("Event Name", "Message Text", options)
-        config.notify event, message, options.merge(:delayed => delayed)
-      else
-        priority = args.shift
-        delayed = args.shift
-        options = { :priority => priority }
+      response = Prowler.retrieve_api_key("token")
 
-        Prowler::Application.any_instance.expects(:enqueue_delayed_job).with("Event Name", "Message Text", options)
-        config.notify event, message, priority, delayed
+      assert_requested :get, "#{Prowler::SERVICE_URL}/retrieve/apikey?providerkey=providerkey&token=token"
+      assert_instance_of Prowler::ApiKey, response
+      assert_equal response.remaining, 999
+      assert_equal response.reset_date, Time.at(1234567890)
+      assert_equal response.api_key, "apikey"
+    end
+
+  end
+
+  context "Using deprecated API" do
+    context "Prowler configuration" do
+      setup do
+        Prowler.reset_configuration
       end
 
-      if delayed
-        assert_not_requested :post, notify_url, :body => build_request(config, event, message, options)
+      should "override class configuration when using an instance" do
+        prowler = Prowler.new("apikey2", "application2", "providerkey2")
+        assert_equal "apikey2",      prowler.api_key
+        assert_equal "application2", prowler.application
+        assert_equal "providerkey2", prowler.provider_key
       end
     end
 
+    context "Sending a notification" do
+      setup do
+        Prowler.reset_configuration
+        Prowler.configure do |config|
+          config.api_key = "apikey"
+          config.application = "Application Name"
+        end
+      end
+
+      should "delay sending using parameter" do
+        Prowler::Application.any_instance.expects(:enqueue_delayed_job).with(
+          :application => "Application Name",
+          :providerkey => nil,
+          :apikey => "apikey",
+          :event => "Event Name",
+          :description => "Message Text",
+          :priority => Prowler::Priority::NORMAL
+        )
+
+        Prowler.delayed = false
+        Prowler.notify "Event Name", "Message Text", Prowler::Priority::NORMAL, true
+      end
+
+      should "send with a high priority using parameter" do
+        stub_request(:post, "#{Prowler::SERVICE_URL}/add")
+
+        Prowler.notify "Event Name", "Message Text", Prowler::Priority::HIGH
+
+        assert_requested :post, "#{Prowler::SERVICE_URL}/add", :body => {
+          :application => "Application Name",
+          :apikey => "apikey",
+          :event => "Event Name",
+          :description => "Message Text",
+          :priority => Prowler::Priority::HIGH.to_s
+        }
+      end
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: prowler
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 1
-  - 2
-  - 1
-  version: 1.2.1
+  - 3
+  - 0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Andrew White
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-30 00:00:00 +00:00
+date: 2011-01-31 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -42,6 +42,7 @@ files:
 - lib/prowler/delayed_job.rb
 - lib/prowler/priority.rb
 - lib/prowler/railtie.rb
+- lib/prowler/response.rb
 - lib/prowler/tasks.rb
 - lib/prowler/version.rb
 - prowler.gemspec