pixeltrix-prowler 1.1.0 → 1.1.1

data/CHANGELOG

@@ -1,3 +1,10 @@
+*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

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.1.1

data/lib/prowler.rb

@@ -62,7 +62,8 @@ require 'uri'
 class Prowler
 
   SERVICE_URL = "https://prowl.weks.net/publicapi"
-  USER_AGENT = "Prowler/1.1.0"
+  USER_AGENT = "Prowler/1.1.1"
+  MULTIPLE_APIKEY_COMMANDS = %w(add)
 
   module Priority
     VERY_LOW  = -2
@@ -93,7 +94,7 @@ class Prowler
     attr_accessor :api_key, :provider_key
     attr_accessor :application, :send_notifications
     attr_accessor :read_timeout, :open_timeout #:nodoc:
-    attr_accessor :delayed
+    attr_accessor :delayed, :verify_certificate, :root_certificates
 
     # Call this method to configure your account details in an initializer.
     def configure
@@ -111,6 +112,7 @@ class Prowler
     # Reset configuration
     def reset_configuration
       @application = @api_key = @provider_key = nil
+      @delayed = @verify_certificate = @root_certificates = nil
     end
 
     # Whether the library has been configured
@@ -118,6 +120,17 @@ class Prowler
       !@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
@@ -163,7 +176,7 @@ class Prowler
     end
 
     def perform(command, api_key, provider_key, data = {}, method = :post) #:nodoc:
-      params = { :apikey => api_key, :provider_key => provider_key }.merge(data).delete_if { |k,v| v.nil? }
+      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)
@@ -205,7 +218,12 @@ class Prowler
       def perform_request(url, request) #:nodoc:
         http = Net::HTTP.new(url.host, url.port)
         http.use_ssl = true
-        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        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
@@ -226,6 +244,14 @@ class Prowler
           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:

data/prowler.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{prowler}
-  s.version = "1.1.0"
+  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-07-10}
+  s.date = %q{2009-08-04}
   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 = [
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
      "lib/prowler.rb",
      "prowler.gemspec",
      "tasks/prowler.rake",
+     "test/config/cacert.pem",
      "test/prowler_test.rb"
   ]
   s.has_rdoc = true

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

@@ -4,6 +4,8 @@ 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
@@ -73,16 +75,40 @@ class ProwlerTest < Test::Unit::TestCase
       end
     end
 
-    should "not verify SSL certificates" do
+    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
@@ -107,12 +133,30 @@ class ProwlerTest < Test::Unit::TestCase
       end
     end
 
-    should "not verify SSL certificates" do
+    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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pixeltrix-prowler
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors: 
 - Andrew White
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-10 00:00:00 -07:00
+date: 2009-08-04 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -32,9 +32,11 @@ files:
 - 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
@@ -55,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
 summary: Provides access to the Prowl API.