prowler 1.1.1 → 1.2.0

data/CHANGELOG

@@ -1,3 +1,12 @@
+* Support usage as a gem plugin
+
+* Add option for custom url
+
+* Optional parameters are deprecated in favor of an options hash
+
+* Verify SSL certificates by default
+
+
 *1.1.1 (August 4th, 2009)
 
 * Add support for verifying server certificate

data/INSTALL

@@ -1,14 +1,29 @@
 Prowler
 =======
 
-This is a plugin for integrating apps with the Prowl iPhone application.
+This is a plugin/gem for integrating apps with the Prowl iPhone application.
 
 INSTALLATION
 
-From your project's RAILS_ROOT, run:
+To install as a plugin from your application root, run:
 
+Rails 2.x:
   script/plugin install git://github.com/pixeltrix/prowler.git
 
+Rails 3.x:
+  script/rails plugin install git://github.com/pixeltrix/prowler.git
+
+To install as a gem configure your config.gems or Gemfile:
+
+Rails 2.x:
+  config.gems 'prowler', :version => '~> 1.2'
+
+Rails 3.x:
+  gem 'prowler', '~> 1.2'
+
+Prowler is not limited to Rails apps - it can be used in any situation
+where you need to send push notifications to your iPhone.
+
 CONFIGURATION
 
 You should have something like this in config/initializers/prowler.rb.
@@ -19,24 +34,24 @@ You should have something like this in config/initializers/prowler.rb.
   end
 
 You can test that Prowler is working in your production environment by using
-this rake task (from RAILS_ROOT):
+this rake task (from your application root):
 
   rake prowler:test
 
 If everything is configured properly the task will send a request to
-prowl.weks.net which will be appear on your iPhone after a short delay.
+prowlapp.com which will be appear on your iPhone after a short delay.
 
 USAGE
 
 To use Prowler within your application just call the notify method, e.g.
 
-  Prowler.notify "Event", "Description", Prowler::Priority::NORMAL
+  Prowler.notify "Event", "Description"
 
 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.notify "Event", "Description", Prowler::Priority::NORMAL
+  prowler.notify "Event", "Description"
 
 If performance is a concern then there is built in support for Delayed::Job.
 This can done either on a global basis, e.g.
@@ -47,7 +62,7 @@ This can done either on a global basis, e.g.
 
 or on a individual message basis, e.g.
 
-  Prowler.notify "Event", "Description", Prowler::Priority::NORMAL, true
+  Prowler.notify "Event", "Description", :delayed => true
 
 ABOUT
 
@@ -56,4 +71,4 @@ a Growl notification forwarder from your Mac. However they provide an API
 which can be called by a generic script which allows you to use the
 application as a general push notification application for your iPhone.
 
-For more about the Prowl application see: http://prowl.weks.net/
+For more about the Prowl application see: http://prowlapp.com/

data/README

@@ -1,14 +1,28 @@
-Prowler
-=======
+== Prowler
 
-This is a plugin for integrating apps with the Prowl iPhone application.
+This is a plugin/gem for integrating apps with the Prowl iPhone application.
 
 INSTALLATION
 
-From your project's RAILS_ROOT, run:
+To install as a plugin from your application root, run:
 
+Rails 2.x:
   script/plugin install git://github.com/pixeltrix/prowler.git
 
+Rails 3.x:
+  script/rails plugin install git://github.com/pixeltrix/prowler.git
+
+To install as a gem configure your config.gems or Gemfile:
+
+Rails 2.x:
+  config.gems 'prowler', :version => '~> 1.2'
+
+Rails 3.x:
+  gem 'prowler', '~> 1.2'
+
+Prowler is not limited to Rails apps - it can be used in any situation
+where you need to send push notifications to your iPhone.
+
 CONFIGURATION
 
 You should have something like this in config/initializers/prowler.rb.
@@ -19,24 +33,24 @@ You should have something like this in config/initializers/prowler.rb.
   end
 
 You can test that Prowler is working in your production environment by using
-this rake task (from RAILS_ROOT):
+this rake task (from your application root):
 
   rake prowler:test
 
 If everything is configured properly the task will send a request to
-prowl.weks.net which will be appear on your iPhone after a short delay.
+prowlapp.com which will be appear on your iPhone after a short delay.
 
 USAGE
 
 To use Prowler within your application just call the notify method, e.g.
 
-  Prowler.notify "Event", "Description", Prowler::Priority::NORMAL
+  Prowler.notify "Event", "Description"
 
 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.notify "Event", "Description", Prowler::Priority::NORMAL
+  prowler.notify "Event", "Description"
 
 If performance is a concern then there is built in support for Delayed::Job.
 This can done either on a global basis, e.g.
@@ -47,7 +61,7 @@ This can done either on a global basis, e.g.
 
 or on a individual message basis, e.g.
 
-  Prowler.notify "Event", "Description", Prowler::Priority::NORMAL, true
+  Prowler.notify "Event", "Description", :delayed => true
 
 ABOUT
 
@@ -56,4 +70,4 @@ a Growl notification forwarder from your Mac. However they provide an API
 which can be called by a generic script which allows you to use the
 application as a general push notification application for your iPhone.
 
-For more about the Prowl application see: http://prowl.weks.net/
+For more about the Prowl application see: http://prowlapp.com/

data/Rakefile

@@ -25,10 +25,10 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gemspec|
     gemspec.name = "prowler"
-    gemspec.summary = "Provides access to the Prowl API."
+    gemspec.summary = "Provides access to the Prowl API (http://prowlapp.com)."
     gemspec.email = "andyw@pixeltrix.co.uk"
     gemspec.homepage = "http://github.com/pixeltrix/prowler/"
-    gemspec.description = "A simple wrapper class that provides basic access to the Prowl API."
+    gemspec.description = "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."
     gemspec.authors = ["Andrew White"]
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-1.1.1
+1.2.0

data/init.rb

@@ -0,0 +1 @@
+require 'prowler'

data/lib/prowler.rb

@@ -2,7 +2,7 @@
 #
 # === Installation
 #
-# From your project's RAILS_ROOT, run:
+# From your application root, run:
 #
 #   script/plugin install git://github.com/pixeltrix/prowler.git
 #
@@ -16,12 +16,12 @@
 #   end
 #
 # You can test that Prowler is working in your production environment by using
-# this rake task (from RAILS_ROOT):
+# this rake task (from your application root):
 #
 #   rake prowler:test
 #
 # If everything is configured properly the task will send a request to
-# prowl.weks.net which will be appear on your iPhone after a short delay.
+# prowlapp.com which will be appear on your iPhone after a short delay.
 #
 # === Usage
 #
@@ -53,244 +53,43 @@
 # which can be called by a generic script which allows you to use the
 # application as a general push notification application for your iPhone.
 #
-# For more about the Prowl application see: http://prowl.weks.net/
+# For more about the Prowl application see: http://prowlapp.com/
 
 require 'logger'
 require 'net/https'
 require 'uri'
 
-class Prowler
-
-  SERVICE_URL = "https://prowl.weks.net/publicapi"
-  USER_AGENT = "Prowler/1.1.1"
-  MULTIPLE_APIKEY_COMMANDS = %w(add)
-
-  module Priority
-    VERY_LOW  = -2
-    MODERATE  = -1
-    NORMAL    = 0
-    HIGH      = 1
-    EMERGENCY = 2
-  end
-
-  class ConfigurationError < StandardError; end
-
-  class DelayedJob
-    attr_accessor :api_key, :provider_key, :application
-    attr_accessor :event, :message, :priority
-
-    def initialize #:nodoc:
-      yield self if block_given?
-    end
-
-    # Send notification
-    def perform
-      prowler = Prowler.new(api_key, application, provider_key)
-      prowler.notify(event, message, priority, false)
-    end
-  end
+require 'prowler/application'
+require 'prowler/railtie' if defined?(Rails::Railtie)
 
+module Prowler
   class << self
-    attr_accessor :api_key, :provider_key
-    attr_accessor :application, :send_notifications
-    attr_accessor :read_timeout, :open_timeout #:nodoc:
-    attr_accessor :delayed, :verify_certificate, :root_certificates
-
-    # Call this method to configure your account details in an initializer.
-    def configure
-      yield self
-    end
-
-    def send_notifications #:nodoc:
-      @send_notifications.nil? ? true : !!@send_notifications
-    end
-
-    def delayed #:nodoc:
-      @delayed.nil? ? false : !!@delayed
-    end
-
-    # Reset configuration
-    def reset_configuration
-      @application = @api_key = @provider_key = nil
-      @delayed = @verify_certificate = @root_certificates = nil
-    end
-
-    # Whether the library has been configured
-    def configured?
-      !@application.nil? && !@api_key.nil?
-    end
-
-    # Whether to verify the server's SSL certificate
-    def verify_certificate?
-      @verify_certificate ||= false
-    end
-
-    # Location of the root certificates file.
-    # Default: RAILS_ROOT/config/cacert.pem
-    def root_certificates
-      @root_certificates ||= File.join(RAILS_ROOT, "config", "cacert.pem")
-    end
-
-    # Returns the default logger or a logger that prints to STDOUT.
-    def logger
-      ActiveRecord::Base.logger
-    rescue
-      @logger ||= Logger.new(STDERR)
-    end
-
-    def read_timeout #:nodoc:
-      @read_timeout ||= 5
-    end
-
-    def open_timeout #:nodoc:
-      @open_timeout ||= 2
-    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.
-    # * priority: The priority of the notification - see Prowler::Priority. (Optional)
-    # * delayed:  Whether to use Delayed::Job to send notifications. (Optional)
-    def notify(event, message, priority = Priority::NORMAL, delayed = self.delayed)
-      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 delayed
-        enqueue_delayed_job(self, event, message, priority)
-      else
-        perform(
-          :add, api_key, provider_key,
-          {
-            :application => application,
-            :event => event,
-            :description => message,
-            :priority => priority
-          }
-        )
-      end
+    #
+    # 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)
+    def notify(event, message, *args)
+      app = new(api_key, application, provider_key)
+      app.notify(event, message, *args)
     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)
-    end
-
-    def perform(command, api_key, provider_key, data = {}, method = :post) #:nodoc:
-      params = { :apikey => format_api_key(command, api_key), :provider_key => provider_key }.merge(data).delete_if { |k,v| v.nil? }
-      case method
-      when :post
-        perform_post(command, params)
-      else
-        perform_get(command, params)
-      end
+      app = new(api_key, application, provider_key)
+      app.verify
     end
 
-    def enqueue_delayed_job(config, event, message, priority) #:nodoc:
-      record = Delayed::Job.enqueue(DelayedJob.new do |job|
-        job.api_key = config.api_key
-        job.provider_key = config.provider_key
-        job.application = config.application
-        job.event = event
-        job.message = message
-        job.priority = priority
-      end)
-      !record.new_record?
+    # 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)
     end
-
-    private
-      def headers(extra_headers = {}) #:nodoc:
-        { 'User-Agent' => USER_AGENT }.merge(extra_headers)
-      end
-
-      def perform_get(command, params) #: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)
-      end
-
-      def perform_post(command, params) #:nodoc:
-        url = URI.parse("#{SERVICE_URL}/#{command}")
-        request = Net::HTTP::Post.new(url.path, headers)
-        request.form_data = params
-        perform_request(url, request)
-      end
-
-      def perform_request(url, request) #:nodoc:
-        http = Net::HTTP.new(url.host, url.port)
-        http.use_ssl = true
-        if verify_certificate?
-          http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-          http.ca_file = root_certificates
-        else
-          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-        end
-        http.read_timeout = read_timeout
-        http.open_timeout = 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
-            end
-          rescue TimeoutError => e
-            logger.error "Timeout while contacting the Prowl server."
-            false
-          end
-        end
-      end
-
-      def format_api_key(command, api_key)
-        if api_key.is_a?(Array)
-          MULTIPLE_APIKEY_COMMANDS.include?(command.to_s) ? api_key.join(",") : api_key.first.to_s
-        else
-          api_key.to_s
-        end
-      end
-  end
-
-  attr_accessor :api_key, :provider_key #:nodoc:
-  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
-  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.
-  # * priority: The priority of the notification - see Prowler::Priority. (Optional)
-  # * delayed:  Whether to use Delayed::Job to send notifications. (Optional)
-  def notify(event, message, priority = Priority::NORMAL, delayed = self.class.delayed)
-    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 delayed
-      self.class.enqueue_delayed_job(self, event, message, priority)
-    else
-      self.class.perform(
-        :add, api_key, provider_key,
-        {
-          :application => application,
-          :event => event,
-          :description => message,
-          :priority => priority
-        }
-      )
-    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?
-    self.class.perform(:verify, api_key, provider_key, {}, :get)
   end
 end
+

data/lib/prowler/application.rb

@@ -0,0 +1,168 @@
+require 'prowler/configuration'
+require 'prowler/delayed_job'
+require 'prowler/priority'
+require 'prowler/version'
+
+module Prowler
+
+  SERVICE_URL = "https://prowlapp.com/publicapi"
+  USER_AGENT = "Prowler/#{VERSION}"
+  MULTIPLE_APIKEY_COMMANDS = %w(add)
+
+  class ConfigurationError < StandardError; end
+
+  class Application
+    attr_accessor :api_key, :provider_key #:nodoc:
+    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
+    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.
+    #
+    # 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)
+    def notify(event, message, *args)
+      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
+      else
+        options = {
+          :priority => args.shift || Prowler::Priority::NORMAL,
+          :delayed => args.shift || Prowler.delayed
+        }
+      end
+
+      if options.delete(:delayed)
+        enqueue_delayed_job(event, message, options)
+      else
+        perform(
+          :add, api_key, provider_key,
+          options.merge({
+            :application => application,
+            :event => event,
+            :description => message
+          })
+        )
+      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)
+    end
+
+    private
+      def perform(command, api_key, provider_key, data = {}, method = :post) #:nodoc:
+        params = { :apikey => format_api_key(command, api_key), :provider_key => provider_key }.merge(data).delete_if { |k,v| v.nil? }
+        case method
+        when :post
+          perform_post(command, params)
+        else
+          perform_get(command, params)
+        end
+      end
+
+      def enqueue_delayed_job(event, message, 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.url = options[:url]
+        end)
+        !record.new_record?
+      end
+
+      def headers(extra_headers = {}) #:nodoc:
+        { 'User-Agent' => USER_AGENT }.merge(extra_headers)
+      end
+
+      def logger #:nodoc:
+        Prowler.logger
+      end
+
+      def verify_certificate? #:nodoc:
+        Prowler.verify_certificate?
+      end
+
+      def root_certificates #:nodoc:
+        Prowler.root_certificates
+      end
+
+      def send_notifications #:nodoc:
+        @send_notifications.nil? ? true : !!@send_notifications
+      end
+
+      def send_notifications? #:nodoc:
+        send_notifications && Prowler.send_notifications
+      end
+
+      def perform_get(command, params) #: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)
+      end
+
+      def perform_post(command, params) #:nodoc:
+        url = URI.parse("#{SERVICE_URL}/#{command}")
+        request = Net::HTTP::Post.new(url.path, headers)
+        request.form_data = params
+        perform_request(url, request)
+      end
+
+      def perform_request(url, request) #:nodoc:
+        http = Net::HTTP.new(url.host, url.port)
+        http.use_ssl = true
+        if verify_certificate?
+          http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+          http.ca_file = root_certificates
+        else
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+        http.read_timeout = Prowler.read_timeout
+        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
+            end
+          rescue TimeoutError => e
+            logger.error "Timeout while contacting the Prowl server."
+            false
+          end
+        end
+      end
+
+      def format_api_key(command, api_key) #:nodoc:
+        if api_key.is_a?(Array)
+          MULTIPLE_APIKEY_COMMANDS.include?(command.to_s) ? api_key.join(",") : api_key.first.to_s
+        else
+          api_key.to_s
+        end
+      end
+  end
+end

data/lib/prowler/configuration.rb

@@ -0,0 +1,78 @@
+module Prowler
+  class << self
+    attr_accessor :api_key, :provider_key
+    attr_accessor :application, :send_notifications
+    attr_accessor :read_timeout, :open_timeout #:nodoc:
+    attr_accessor :delayed, :verify_certificate, :root_certificates
+
+    # Call this method to configure your account details in an initializer.
+    def configure
+      yield self
+    end
+
+    def send_notifications #:nodoc:
+      @send_notifications.nil? ? true : !!@send_notifications
+    end
+
+    def delayed #:nodoc:
+      @delayed.nil? ? false : !!@delayed
+    end
+
+    # Reset configuration
+    def reset_configuration
+      @application = @api_key = @provider_key = nil
+      @delayed = @verify_certificate = @root_certificates = nil
+      @send_notifications = @read_timeout = @open_timeout = nil
+    end
+
+    # Whether the library has been configured
+    def configured?
+      !@application.nil? && !@api_key.nil?
+    end
+
+    # Whether to verify the server's SSL certificate
+    def verify_certificate?
+      @verify_certificate.nil? ? true : !!@verify_certificate
+    end
+
+    # Location of the root certificates file.
+    # Default: #{Rails.root}/config/cacert.pem
+    def root_certificates
+      if defined?(Rails.root)
+        @root_certificates ||= File.expand_path('config/cacert.pem', Rails.root)
+      elsif defined?(RAILS_ROOT)
+        @root_certificates ||= File.expand_path('config/cacert.pem', RAILS_ROOT)
+      else
+        @root_certificates ||= File.expand_path('../config/cacert.pem', __FILE__)
+      end
+    end
+
+    # Returns the default logger or a logger that prints to STDOUT.
+    def logger
+      @logger ||= rails_logger
+    end
+
+    # Override the default logger
+    def logger=(new_logger)
+      @logger = new_logger
+    end
+
+    def rails_logger #:nodoc:
+      if defined?(Rails.logger)
+        Rails.logger
+      elsif defined?(RAILS_DEFAULT_LOGGER)
+        RAILS_DEFAULT_LOGGER
+      else
+        Logger.new(STDERR)
+      end
+    end
+
+    def read_timeout #:nodoc:
+      @read_timeout ||= 5
+    end
+
+    def open_timeout #:nodoc:
+      @open_timeout ||= 2
+    end
+  end
+end

data/lib/prowler/delayed_job.rb

@@ -0,0 +1,20 @@
+module Prowler
+  class DelayedJob
+    attr_accessor :api_key, :provider_key, :application
+    attr_accessor :event, :message, :priority, :url
+
+    def initialize #:nodoc:
+      yield self if block_given?
+    end
+
+    # Send notification
+    def perform
+      prowler = Prowler.new(api_key, application, provider_key)
+      prowler.notify(event, message, options)
+    end
+
+    def options #:nodoc:
+      { :priority => priority, :url => url, :delayed => false }
+    end
+  end
+end

data/lib/prowler/priority.rb

@@ -0,0 +1,9 @@
+module Prowler
+  module Priority
+    VERY_LOW  = -2
+    MODERATE  = -1
+    NORMAL    = 0
+    HIGH      = 1
+    EMERGENCY = 2
+  end
+end

data/lib/prowler/railtie.rb

@@ -0,0 +1,10 @@
+require 'prowler'
+require 'rails'
+
+module Prowler
+  class Railtie < Rails::Railtie #:nodoc:
+    rake_tasks do
+      require "prowler/tasks"
+    end
+  end
+end

data/lib/prowler/tasks.rb

@@ -0,0 +1,6 @@
+namespace :prowler do
+  desc "Verify your Prowler installation by sending a test notification to the Prowl iPhone application"
+  task :test => :environment do
+    Prowler.notify "Test Message", "Testing, testing, testing ..."
+  end
+end

data/lib/prowler/version.rb

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

data/prowler.gemspec

@@ -1,50 +1,57 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{prowler}
-  s.version = "1.1.1"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrew White"]
-  s.date = %q{2009-10-05}
-  s.description = %q{A simple wrapper class that provides basic access to the Prowl API.}
+  s.date = %q{2011-01-27}
+  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 = [
     "README"
   ]
   s.files = [
     "CHANGELOG",
-     "INSTALL",
-     "MIT-LICENSE",
-     "README",
-     "Rakefile",
-     "VERSION",
-     "install.rb",
-     "lib/prowler.rb",
-     "prowler.gemspec",
-     "tasks/prowler.rake",
-     "test/config/cacert.pem",
-     "test/prowler_test.rb"
+    "INSTALL",
+    "MIT-LICENSE",
+    "README",
+    "Rakefile",
+    "VERSION",
+    "init.rb",
+    "install.rb",
+    "lib/prowler.rb",
+    "lib/prowler/application.rb",
+    "lib/prowler/configuration.rb",
+    "lib/prowler/delayed_job.rb",
+    "lib/prowler/priority.rb",
+    "lib/prowler/railtie.rb",
+    "lib/prowler/tasks.rb",
+    "lib/prowler/version.rb",
+    "prowler.gemspec",
+    "tasks/prowler.rake",
+    "test/config/cacert.pem",
+    "test/prowler_test.rb"
   ]
   s.homepage = %q{http://github.com/pixeltrix/prowler/}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Provides access to the Prowl API.}
+  s.rubygems_version = %q{1.4.2}
+  s.summary = %q{Provides access to the Prowl API (http://prowlapp.com).}
   s.test_files = [
     "test/prowler_test.rb"
   ]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
     else
     end
   else
   end
 end
+

data/tasks/prowler.rake

@@ -1,6 +1 @@
-namespace :prowler do
-  desc "Verify your plugin installation by sending a test notification to the Prowl iPhone application"
-  task :test => :environment do
-    Prowler.notify "Test Message", "Testing, testing, testing ..."
-  end
-end
+require File.expand_path('../../lib/prowler/tasks', __FILE__)

data/test/prowler_test.rb

@@ -2,15 +2,24 @@ require 'test/unit'
 require 'rubygems'
 require 'mocha'
 require 'shoulda'
-require File.join(File.dirname(__FILE__), "..", "lib", "prowler")
+require 'webmock/test_unit'
+require File.expand_path('../../lib/prowler', __FILE__)
+
+class FakeLogger
+  def info(*args); end
+  def debug(*args); end
+  def warn(*args); end
+  def error(*args); end
+  def fatal(*args); end
+end
 
 RAILS_ROOT = File.dirname(__FILE__)
+RAILS_DEFAULT_LOGGER = FakeLogger.new
 
 class ProwlerTest < Test::Unit::TestCase
   context "Prowler configuration" do
     setup do
       Prowler.reset_configuration
-      Prowler.send_notifications = false
     end
 
     should "be done with a block" do
@@ -45,18 +54,17 @@ class ProwlerTest < Test::Unit::TestCase
         config.api_key = "apikey"
         config.application = "Application Name"
       end
-      Prowler.send_notifications = false
     end
 
     should "raise an exception if API key not configured" do
       Prowler.reset_configuration
       assert_raises Prowler::ConfigurationError do
-        Prowler.notify("Event", "Description", Prowler::Priority::NORMAL)
+        Prowler.notify("Event", "Description")
       end
 
       prowler = Prowler.new(nil, nil)
       assert_raises Prowler::ConfigurationError do
-        prowler.notify("Event", "Description", Prowler::Priority::NORMAL)
+        prowler.notify("Event", "Description")
       end
     end
 
@@ -75,39 +83,71 @@ class ProwlerTest < Test::Unit::TestCase
       end
     end
 
-    should "not verify SSL certificates by default" do
+    should "verify SSL certificates by default" 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", Prowler::Priority::NORMAL)
+      Net::HTTP.any_instance.expects(:verify_mode=).with(OpenSSL::SSL::VERIFY_PEER)
+      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")
     end
 
-    should "verify SSL certificates if verification is turned on" do
-      Prowler.configure do |config|
-        config.verify_certificate = true
-      end
+    should "not verify SSL certificates if verification is turned off" do
       Net::HTTP.any_instance.expects(:use_ssl=).with(true)
-      Net::HTTP.any_instance.expects(:verify_mode=).with(OpenSSL::SSL::VERIFY_PEER)
-      Net::HTTP.any_instance.expects(:ca_file=).with(File.join(RAILS_ROOT, "config", "cacert.pem"))
-      Prowler.notify("Event Name", "Message Text", Prowler::Priority::NORMAL)
+      Net::HTTP.any_instance.expects(:verify_mode=).with(OpenSSL::SSL::VERIFY_NONE)
+
+      Prowler.send_notifications = false
+      Prowler.verify_certificate = false
+      Prowler.notify("Event Name", "Message Text")
     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::Priority::NORMAL)
+      Prowler.send_notifications = false
+      assert_not_notified Prowler, "Event Name", "Message Text"
     end
 
     should "send multiple API keys if configured" do
-      Prowler.configure do |config|
-        config.api_key = %w(apikey1 apikey2)
+      Prowler.api_key = %w(apikey1 apikey2)
+      assert_notified Prowler, "Event Name", "Message Text"
+    end
+
+    should "log a successful response" do
+      Prowler.logger.expects(:info).with("Prowl Success: Net::HTTPOK")
+      assert_notified Prowler, "Event Name", "Message Text"
+    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
-      Net::HTTP::Post.any_instance.expects(:form_data=).with({
-        :apikey => "apikey1,apikey2",
-        :application => "Application Name",
-        :event => "Event Name",
-        :description => "Message Text",
-        :priority => Prowler::Priority::NORMAL
-      })
-      Prowler.notify("Event Name", "Message Text", Prowler::Priority::NORMAL)
+    end
+
+    should "delay sending if configured globally" do
+      Prowler.delayed = true
+      assert_delayed Prowler, "Event Name", "Message Text"
+    end
+
+    should "delay sending using deprecated parameter" do
+      Prowler.delayed = false
+      assert_delayed Prowler, "Event Name", "Message Text", Prowler::Priority::NORMAL, true
+    end
+
+    should "delay sending using options" do
+      Prowler.delayed = false
+      assert_delayed Prowler, "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
+
+    should "send with a high priority using deprecated parameter" do
+      assert_notified Prowler, "Event Name", "Message Text", Prowler::Priority::HIGH
+    end
+
+    should "send with a high priority using options" do
+      assert_notified Prowler, "Event Name", "Message Text", :priority => Prowler::Priority::HIGH
     end
   end
 
@@ -118,7 +158,6 @@ class ProwlerTest < Test::Unit::TestCase
         config.api_key = "apikey"
         config.application = "Application Name"
       end
-      Prowler.send_notifications = false
     end
 
     should "raise an exception if API key not configured" do
@@ -129,37 +168,128 @@ class ProwlerTest < Test::Unit::TestCase
 
       prowler = Prowler.new(nil, nil)
       assert_raises Prowler::ConfigurationError do
-        prowler.verify
+        Prowler.verify
       end
     end
 
     should "only verify the first API key" do
-      Prowler.configure do |config|
-        config.api_key = %w(apikey1 apikey2)
-      end
-      Net::HTTP::Get.expects(:new).with("/publicapi/verify?apikey=apikey1", { 'User-Agent' => Prowler::USER_AGENT }).once
-      Prowler.verify
+      Prowler.api_key = %w(apikey1 apikey2)
+      assert_verified Prowler, "apikey1"
     end
 
-    should "not verify SSL certificates by default" do
-      Net::HTTP.any_instance.expects(:use_ssl=).with(true)
-      Net::HTTP.any_instance.expects(:verify_mode=).with(OpenSSL::SSL::VERIFY_NONE)
-      Prowler.verify
+    should "not send notifications if send_notifications is false" do
+      Prowler.send_notifications = false
+      assert_not_verified Prowler
     end
 
-    should "verify SSL certificates if verification is turned on" do
-      Prowler.configure do |config|
-        config.verify_certificate = true
-      end
+    should "verify SSL certificates by default" do
       Net::HTTP.any_instance.expects(:use_ssl=).with(true)
       Net::HTTP.any_instance.expects(:verify_mode=).with(OpenSSL::SSL::VERIFY_PEER)
-      Net::HTTP.any_instance.expects(:ca_file=).with(File.join(RAILS_ROOT, "config", "cacert.pem"))
+      Net::HTTP.any_instance.expects(:ca_file=).with(File.expand_path('config/cacert.pem', RAILS_ROOT))
+
+      Prowler.send_notifications = false
       Prowler.verify
     end
 
-    should "not send notifications if send_notifications is false" do
-      Net::HTTP.any_instance.expects(:request).never
+    should "not verify SSL certificates if verification is turned off" do
+      Net::HTTP.any_instance.expects(:use_ssl=).with(true)
+      Net::HTTP.any_instance.expects(:verify_mode=).with(OpenSSL::SSL::VERIFY_NONE)
+
+      Prowler.send_notifications = false
+      Prowler.verify_certificate = false
       Prowler.verify
     end
   end
+
+  private
+    def verify_url
+      "#{Prowler::SERVICE_URL}/verify"
+    end
+
+    def assert_verified(config, api_key = "apikey", &block)
+      request = stub_request(:get, "#{verify_url}?apikey=#{api_key}")
+      request.with(:headers => { "Accept" => "*/*" })
+      request.with(:headers => { "User-Agent" => Prowler::USER_AGENT })
+
+      if block_given?
+        yield request
+      else
+        request.to_return(:status => 200, :body => "", :headers => {})
+      end
+
+      config.verify
+      assert_requested :get, "#{verify_url}?apikey=#{api_key}"
+    end
+
+    def assert_not_verified(config, api_key = "apikey")
+      config.verify
+      assert_not_requested :get, "#{verify_url}?apikey=#{api_key}"
+    end
+
+    def notify_url
+      "#{Prowler::SERVICE_URL}/add"
+    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 => {})
+      end
+
+      config.notify event, message, options
+      assert_requested :post, notify_url, :body => body
+    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)
+    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
+
+        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 }
+
+        Prowler::Application.any_instance.expects(:enqueue_delayed_job).with("Event Name", "Message Text", options)
+        config.notify event, message, priority, delayed
+      end
+
+      if delayed
+        assert_not_requested :post, notify_url, :body => build_request(config, event, message, options)
+      end
+    end
+
 end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: prowler
 version: !ruby/object:Gem::Version 
-  version: 1.1.1
+  hash: 31
+  prerelease: 
+  segments: 
+  - 1
+  - 2
+  - 0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Andrew White
@@ -9,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-05 00:00:00 +01:00
+date: 2011-01-27 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
-description: A simple wrapper class that provides basic access to the Prowl API.
+description: 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.
 email: andyw@pixeltrix.co.uk
 executables: []
 
@@ -28,8 +34,16 @@ files:
 - README
 - Rakefile
 - VERSION
+- init.rb
 - install.rb
 - lib/prowler.rb
+- lib/prowler/application.rb
+- lib/prowler/configuration.rb
+- lib/prowler/delayed_job.rb
+- lib/prowler/priority.rb
+- lib/prowler/railtie.rb
+- lib/prowler/tasks.rb
+- lib/prowler/version.rb
 - prowler.gemspec
 - tasks/prowler.rake
 - test/config/cacert.pem
@@ -39,28 +53,34 @@ homepage: http://github.com/pixeltrix/prowler/
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
-summary: Provides access to the Prowl API.
+summary: Provides access to the Prowl API (http://prowlapp.com).
 test_files: 
 - test/prowler_test.rb