pixeltrix-prowler 1.0.0

data/INSTALL

@@ -0,0 +1,43 @@
+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.username = 'username'
+    config.password = 'password'
+    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"
+
+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,43 @@
+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.username = 'username'
+    config.password = 'password'
+    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"
+
+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,22 @@
+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

data/install.rb

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

data/lib/prowler.rb

@@ -0,0 +1,92 @@
+require 'logger'
+require 'net/http'
+require 'net/https'
+
+module Prowler
+  class << self
+    attr_accessor :host, :port, :secure
+    attr_accessor :username, :password
+    attr_accessor :application, :send_notifications
+
+    # The host to connect to.
+    def host
+      @host ||= 'prowl.weks.net'
+    end
+
+    # The port on which the service runs.
+    def port
+      @port || (secure ? 443 : 80)
+    end
+
+    # Whether the service is running over SSL.
+    def secure
+      @secure.nil? ? true : !!@secure
+    end
+
+    # Call this method to configure your account details in an initializer.
+    def configure
+      yield self
+    end
+
+    # Whether to send notifications
+    def send_notifications
+      @send_notifications.nil? ? true : !!@send_notifications
+    end
+    alias :send_notifications? :send_notifications
+
+    # Reset configuration
+    def reset_configuration
+      @host = @port = @secure = @application = @username = @password = nil
+    end
+
+    # Whether the library has been configured
+    def configured?
+      !(@application.nil? || @username.nil? || @password.nil?)
+    end
+
+    def path(*params) #:nodoc:
+      sprintf("/api/add_notification.php?application=%s&event=%s&description=%s", *params)
+    end
+
+    # Returns the default logger or a logger that prints to STDOUT.
+    def logger
+      ActiveRecord::Base.logger
+    rescue
+      @logger ||= Logger.new(STDERR)
+    end
+
+    # Send a notification to your iPhone:
+    # * event: The title of notification you want to send.
+    # * message: The text of the notification message you want to send.
+    def notify(event, message)
+      raise RuntimeError, "Prowler needs to be configured first before using it" unless configured?
+
+      http = Net::HTTP.new(host, port)
+      http.use_ssl = secure
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      http.start do
+        headers = {
+          'User-Agent' => 'ProwlScript/1.0'
+        }
+        http.read_timeout = 5 # seconds
+        http.open_timeout = 2 # seconds
+        request = Net::HTTP::Get.new(path(URI.escape(application), URI.escape(event), URI.escape(message)), headers)
+        request.basic_auth(username, password)
+        response = begin
+                     http.request(request) if send_notifications?
+                   rescue TimeoutError => e
+                     logger.error "Timeout while contacting the Prowl server."
+                     nil
+                   end
+        case response
+        when Net::HTTPSuccess then
+          logger.info "Prowl Success: #{response.class}"
+        when NilClass then
+          # Do nothing
+        else
+          logger.error "Prowl Failure: #{response.class}\n#{response.body if response.respond_to? :body}"
+        end
+      end
+    end
+  end
+end

data/prowler.gemspec

@@ -0,0 +1,30 @@
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'prowler'
+  s.version     = "1.0.0"
+  s.summary     = 'Provides access to the Prowl API.'
+  s.description = <<-EOF
+    A simple wrapper class that provides basic access to the Prowl API.
+  EOF
+  s.author      = 'Andrew White'
+  s.email       = 'andyw@pixeltrix.co.uk'
+  s.homepage    = 'http://github.com/pixeltrix/prowler/'
+  s.has_rdoc    = true
+
+  s.requirements << 'none'
+  s.require_path = 'lib'
+
+  s.files = [
+      'prowler.gemspec',
+      'INSTALL',
+      'install.rb',
+      'lib/prowler.rb',
+      'MIT-LICENSE',
+      'Rakefile',
+      'README',
+      'tasks/prowler.rake',
+      'test/prowler_test.rb',
+    ]
+
+  s.test_file = 'test/prowler_test.rb'
+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/prowler_test.rb

@@ -0,0 +1,97 @@
+require 'test/unit'
+require 'rubygems'
+require 'mocha'
+require 'shoulda'
+require File.join(File.dirname(__FILE__), "..", "lib", "prowler")
+
+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.host = "prowler"
+        config.port = 666
+        config.secure = false
+        config.application = "application"
+        config.username = "username"
+        config.password = "password"
+      end
+
+      assert_equal "prowler",     Prowler.host
+      assert_equal 666,           Prowler.port
+      assert_equal false,         Prowler.secure
+      assert_equal "application", Prowler.application
+      assert_equal "username",    Prowler.username
+      assert_equal "password",    Prowler.password
+    end
+
+    should "set a default host" do
+      assert_equal "prowl.weks.net", Prowler.host
+    end
+
+    should "set a default port" do
+      assert_equal 443, Prowler.port
+    end
+
+    should "default to secure" do
+      assert_equal true, Prowler.secure
+    end
+
+    should "not set a default application" do
+      assert_equal nil, Prowler.application
+    end
+
+    should "not set a default username" do
+      assert_equal nil, Prowler.username
+    end
+
+    should "not set a default password" do
+      assert_equal nil, Prowler.password
+    end
+
+    should "raise an exception if not configured" do
+      assert_raises RuntimeError do
+        Prowler.notify "Event", "Description"
+      end
+    end
+  end
+
+  context "Sending a notification" do
+    setup do
+      Prowler.reset_configuration
+      Prowler.configure do |config|
+        config.application = "Application Name"
+        config.username = "username"
+        config.password = "password"
+      end
+      Prowler.send_notifications = false
+    end
+
+    should "encode the url parameters" do
+      expectation = Prowler.expects(:path)
+      expectation.with("Application%20Name", "Event%20Name", "Message%20Text")
+      expectation.returns("/api/add_notification.php?application=Application%20Name&event=Event%20Name&description=Message%20Text")
+      Prowler.notify("Event Name", "Message Text")
+    end
+
+    should "not verify SSL certificates" do
+      Net::HTTP.any_instance.expects(:use_ssl=).with(true)
+      Net::HTTP.any_instance.expects(:verify_mode=).with(OpenSSL::SSL::VERIFY_NONE)
+      Prowler.notify("Event Name", "Message Text")
+    end
+
+    should "use HTTP Basic Authentication" do
+      Net::HTTP::Get.any_instance.expects(:basic_auth).with(Prowler.username, Prowler.password)
+      Prowler.notify("Event Name", "Message Text")
+    end
+
+    should "not send notifications if send_notifications is false" do
+      Net::HTTP.any_instance.expects(:request).never
+      Prowler.notify("Event Name", "Message Text")
+    end
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: pixeltrix-prowler
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Andrew White
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-16 00:00:00 -07: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: []
+
+files: 
+- prowler.gemspec
+- INSTALL
+- install.rb
+- lib/prowler.rb
+- MIT-LICENSE
+- Rakefile
+- README
+- tasks/prowler.rake
+- test/prowler_test.rb
+has_rdoc: true
+homepage: http://github.com/pixeltrix/prowler/
+post_install_message: 
+rdoc_options: []
+
+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: 
+- none
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Provides access to the Prowl API.
+test_files: 
+- test/prowler_test.rb