prowler 1.1.1

data/CHANGELOG

@@ -0,0 +1,46 @@
+*1.1.1 (August 4th, 2009)
+
+* Add support for verifying server certificate
+
+* Add support for passing multiple API keys
+
+
+*1.1.0 (July 10th, 2009)
+
+* Add support for Delayed::Job background processing
+
+* Update documentation for instance level configuration
+
+* Add support for instance level configuration
+
+* Add support for provider key
+
+* Clean up implementation
+
+* Remove unnecessary configuration
+
+* Remove deprecated API
+
+
+*1.0.3 (July 9th, 2009)
+
+* Add verify method for configured API key
+
+* Use POST to send notifications
+
+
+*1.0.2 (July 8th, 2009)
+
+* Switch to new API using apikey and deprecate old API
+
+
+*1.0.1 (July 7th, 2009)
+
+* Update RDoc documentation
+
+* Use Jeweler for gem management
+
+
+*1.0.0 (July 7th, 2009)
+
+* First release

data/INSTALL

@@ -0,0 +1,59 @@
+Prowler
+=======
+
+This is a plugin for integrating apps with the Prowl iPhone application.
+
+INSTALLATION
+
+From your project's RAILS_ROOT, run:
+
+  script/plugin install git://github.com/pixeltrix/prowler.git
+
+CONFIGURATION
+
+You should have something like this in config/initializers/prowler.rb.
+
+  Prowler.configure do |config|
+    config.api_key = 'ffffffffffffffffffffffffffffffffffffffff'
+    config.application = 'www.example.com'
+  end
+
+You can test that Prowler is working in your production environment by using
+this rake task (from RAILS_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.
+
+USAGE
+
+To use Prowler within your application just call the notify method, e.g.
+
+  Prowler.notify "Event", "Description", Prowler::Priority::NORMAL
+
+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
+
+If performance is a concern then there is built in support for Delayed::Job.
+This can done either on a global basis, e.g.
+
+  Prowler.configure do |config|
+    config.delayed = true
+  end
+
+or on a individual message basis, e.g.
+
+  Prowler.notify "Event", "Description", Prowler::Priority::NORMAL, true
+
+ABOUT
+
+Prowler relies upon the Prowl iPhone application which is advertised as
+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/

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006 Jordan Brock
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,59 @@
+Prowler
+=======
+
+This is a plugin for integrating apps with the Prowl iPhone application.
+
+INSTALLATION
+
+From your project's RAILS_ROOT, run:
+
+  script/plugin install git://github.com/pixeltrix/prowler.git
+
+CONFIGURATION
+
+You should have something like this in config/initializers/prowler.rb.
+
+  Prowler.configure do |config|
+    config.api_key = 'ffffffffffffffffffffffffffffffffffffffff'
+    config.application = 'www.example.com'
+  end
+
+You can test that Prowler is working in your production environment by using
+this rake task (from RAILS_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.
+
+USAGE
+
+To use Prowler within your application just call the notify method, e.g.
+
+  Prowler.notify "Event", "Description", Prowler::Priority::NORMAL
+
+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
+
+If performance is a concern then there is built in support for Delayed::Job.
+This can done either on a global basis, e.g.
+
+  Prowler.configure do |config|
+    config.delayed = true
+  end
+
+or on a individual message basis, e.g.
+
+  Prowler.notify "Event", "Description", Prowler::Priority::NORMAL, true
+
+ABOUT
+
+Prowler relies upon the Prowl iPhone application which is advertised as
+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/

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the prowler plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the prowler plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Prowler'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "prowler"
+    gemspec.summary = "Provides access to the Prowl API."
+    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.authors = ["Andrew White"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+1.1.1

data/install.rb

@@ -0,0 +1 @@
+puts IO.read(File.join(File.dirname(__FILE__), 'INSTALL'))

data/lib/prowler.rb

@@ -0,0 +1,296 @@
+# Prowler is a plugin for integrating apps with the Prowl iPhone application.
+#
+# === Installation
+#
+# From your project's RAILS_ROOT, run:
+#
+#   script/plugin install git://github.com/pixeltrix/prowler.git
+#
+# === Configuration
+#
+# You should have something like this in config/initializers/prowler.rb.
+#
+#   Prowler.configure do |config|
+#     config.api_key = 'ffffffffffffffffffffffffffffffffffffffff'
+#     config.application = 'www.example.com'
+#   end
+#
+# You can test that Prowler is working in your production environment by using
+# this rake task (from RAILS_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.
+#
+# === Usage
+#
+# To use Prowler within your application just call the notify method, e.g.
+#
+#   Prowler.notify "Event", "Description", Prowler::Priority::NORMAL
+#
+# 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
+#
+# If performance is a concern then there is built in support for Delayed::Job.
+# This can done either on a global basis, e.g.
+#
+#   Prowler.configure do |config|
+#     config.delayed = true
+#   end
+#
+# or on a individual message basis, e.g.
+#
+#   Prowler.notify "Event", "Description", Prowler::Priority::NORMAL, true
+#
+# === About
+#
+# Prowler relies upon the Prowl iPhone application which is advertised as
+# 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/
+
+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
+
+  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
+    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
+    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?
+    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/prowler.gemspec

@@ -0,0 +1,50 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# 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.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.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"
+  ]
+  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.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
+    else
+    end
+  else
+  end
+end

data/tasks/prowler.rake

@@ -0,0 +1,6 @@
+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

data/test/config/cacert.pem

@@ -0,0 +1,17 @@
+-----BEGIN CERTIFICATE-----
+MIIDIDCCAomgAwIBAgIENd70zzANBgkqhkiG9w0BAQUFADBOMQswCQYDVQQGEwJVUzEQMA4GA1UE
+ChMHRXF1aWZheDEtMCsGA1UECxMkRXF1aWZheCBTZWN1cmUgQ2VydGlmaWNhdGUgQXV0aG9yaXR5
+MB4XDTk4MDgyMjE2NDE1MVoXDTE4MDgyMjE2NDE1MVowTjELMAkGA1UEBhMCVVMxEDAOBgNVBAoT
+B0VxdWlmYXgxLTArBgNVBAsTJEVxdWlmYXggU2VjdXJlIENlcnRpZmljYXRlIEF1dGhvcml0eTCB
+nzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAwV2xWGcIYu6gmi0fCG2RFGiYCh7+2gRvE4RiIcPR
+fM6fBeC4AfBONOziipUEZKzxa1NfBbPLZ4C/QgKO/t0BCezhABRP/PvwDN1Dulsr4R+AcJkVV5MW
+8Q+XarfCaCMczE1ZMKxRHjuvK9buY0V7xdlfUNLjUA86iOe/FP3gx7kCAwEAAaOCAQkwggEFMHAG
+A1UdHwRpMGcwZaBjoGGkXzBdMQswCQYDVQQGEwJVUzEQMA4GA1UEChMHRXF1aWZheDEtMCsGA1UE
+CxMkRXF1aWZheCBTZWN1cmUgQ2VydGlmaWNhdGUgQXV0aG9yaXR5MQ0wCwYDVQQDEwRDUkwxMBoG
+A1UdEAQTMBGBDzIwMTgwODIyMTY0MTUxWjALBgNVHQ8EBAMCAQYwHwYDVR0jBBgwFoAUSOZo+SvS
+spXXR9gjIBBPM5iQn9QwHQYDVR0OBBYEFEjmaPkr0rKV10fYIyAQTzOYkJ/UMAwGA1UdEwQFMAMB
+Af8wGgYJKoZIhvZ9B0EABA0wCxsFVjMuMGMDAgbAMA0GCSqGSIb3DQEBBQUAA4GBAFjOKer89961
+zgK5F7WF0bnj4JXMJTENAKaSbn+2kmOeUJXRmm/kEd5jhW6Y7qj/WsjTVbJmcVfewCHrPSqnI0kB
+BIZCe/zuf6IWUrVnZ9NA2zsmWLIodz2uFHdh1voqZiegDfqnc1zqcPGUIWVEX/r87yloqaKHee95
+70+sB3c4
+-----END CERTIFICATE-----

data/test/prowler_test.rb

@@ -0,0 +1,165 @@
+require 'test/unit'
+require 'rubygems'
+require 'mocha'
+require 'shoulda'
+require File.join(File.dirname(__FILE__), "..", "lib", "prowler")
+
+RAILS_ROOT = File.dirname(__FILE__)
+
+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
+      Prowler.configure do |config|
+        config.api_key = "apikey"
+        config.application = "application"
+      end
+
+      assert_equal "apikey",      Prowler.api_key
+      assert_equal "application", Prowler.application
+    end
+
+    should "not set a default application" do
+      assert_equal nil, Prowler.application
+    end
+
+    should "not set a default API key" do
+      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
+    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
+      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)
+      end
+
+      prowler = Prowler.new(nil, nil)
+      assert_raises Prowler::ConfigurationError do
+        prowler.notify("Event", "Description", Prowler::Priority::NORMAL)
+      end
+    end
+
+    should "raise an exception if application not configured" do
+      Prowler.reset_configuration
+      Prowler.configure do |config|
+        config.api_key = "apikey"
+      end
+      assert_raises Prowler::ConfigurationError do
+        Prowler.notify("Event", "Description", Prowler::Priority::NORMAL)
+      end
+
+      prowler = Prowler.new("apikey", nil)
+      assert_raises Prowler::ConfigurationError do
+        prowler.notify("Event", "Description", Prowler::Priority::NORMAL)
+      end
+    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.notify("Event Name", "Message Text", Prowler::Priority::NORMAL)
+    end
+
+    should "verify SSL certificates if verification is turned on" do
+      Prowler.configure do |config|
+        config.verify_certificate = true
+      end
+      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)
+    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)
+    end
+
+    should "send multiple API keys if configured" do
+      Prowler.configure do |config|
+        config.api_key = %w(apikey1 apikey2)
+      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
+  end
+
+  context "Verifying an API key" do
+    setup do
+      Prowler.reset_configuration
+      Prowler.configure do |config|
+        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.verify
+      end
+
+      prowler = Prowler.new(nil, nil)
+      assert_raises Prowler::ConfigurationError do
+        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
+    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
+    end
+
+    should "verify SSL certificates if verification is turned on" do
+      Prowler.configure do |config|
+        config.verify_certificate = true
+      end
+      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.verify
+    end
+
+    should "not send notifications if send_notifications is false" do
+      Net::HTTP.any_instance.expects(:request).never
+      Prowler.verify
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: prowler
+version: !ruby/object:Gem::Version 
+  version: 1.1.1
+platform: ruby
+authors: 
+- Andrew White
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-05 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: A simple wrapper class that provides basic access to the Prowl API.
+email: andyw@pixeltrix.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+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
+has_rdoc: true
+homepage: http://github.com/pixeltrix/prowler/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Provides access to the Prowl API.
+test_files: 
+- test/prowler_test.rb