prowler 1.3.0 → 1.3.1

data/CHANGELOG

@@ -1,3 +1,8 @@
+*1.3.1 (April 20th, 2011)
+
+* Add configuration option for service url so Prowl clones can be used
+
+
 *1.3.0 (January 31st, 2011)
 
 * Add retrive_token and retrieve_api_key commands

data/{INSTALL → README.md}

@@ -3,68 +3,96 @@ Prowler
 
 This is a plugin/gem for integrating apps with the Prowl iPhone application.
 
-INSTALLATION
+Installation
+------------
 
 To install as a plugin from your application root, run:
 
 Rails 2.x:
-  script/plugin install git://github.com/pixeltrix/prowler.git
+
+``` sh
+script/plugin install git://github.com/pixeltrix/prowler.git
+```
 
 Rails 3.x:
-  script/rails plugin install git://github.com/pixeltrix/prowler.git
+
+``` sh
+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'
+
+``` ruby
+config.gems 'prowler', :version => '~> 1.2'
+```
 
 Rails 3.x:
-  gem 'prowler', '~> 1.2'
+
+``` ruby
+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
+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
+``` ruby
+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 your application root):
 
-  rake prowler:test
+``` sh
+rake prowler:test
+```
 
 If everything is configured properly the task will send a request to
 prowlapp.com which will be appear on your iPhone after a short delay.
 
-USAGE
+Usage
+-----
 
 To use Prowler within your application just call the notify method, e.g.
 
-  Prowler.notify "Event", "Description"
+``` ruby
+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(:application => 'application', :api_key => 'apikey')
-  prowler.notify "Event", "Description"
+``` ruby
+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.
 This can done either on a global basis, e.g.
 
-  Prowler.configure do |config|
-    config.delayed = true
-  end
+``` ruby
+Prowler.configure do |config|
+  config.delayed = true
+end
+```
 
 or on a individual message basis, e.g.
 
-  Prowler.notify "Event", "Description", :delayed => true
+``` ruby
+Prowler.notify "Event", "Description", :delayed => true
+```
 
-ABOUT
+About
+-----
 
 Prowler relies upon the Prowl iPhone application which is advertised as
 a Growl notification forwarder from your Mac. However they provide an API
@@ -72,3 +100,14 @@ 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://prowlapp.com/
+
+Contributions
+-------------
+
+Bug fixes and new feature patches are welcome. Please provide tests and
+documentation wherever possible - without them it is unlikely your patch
+will be accepted. If you're fixing a bug then a failing test for the bug
+is essential. Once you have completed your patch please open a GitHub
+pull request and I will review it and respond as quickly as possible.
+
+Copyright (c) 2011 Andrew White, released under the MIT license

data/Rakefile

@@ -1,37 +1,24 @@
 require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
+require 'bundler'
 
-desc 'Default: run unit tests.'
+Bundler::GemHelper.install_tasks
+
+desc 'Default: run prowler unit tests.'
 task :default => :test
 
-desc 'Test the prowler plugin.'
+desc 'Test the prowler gem.'
 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.'
+desc 'Generate documentation for the prowler gem.'
 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 (http://prowlapp.com)."
-    gemspec.email = "andyw@pixeltrix.co.uk"
-    gemspec.homepage = "http://github.com/pixeltrix/prowler/"
-    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
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
-end

data/lib/prowler/application.rb

@@ -6,15 +6,15 @@ require 'prowler/version'
 
 module Prowler
 
-  SERVICE_URL = "https://prowlapp.com/publicapi"
+  SERVICE_URL = "https://api.prowlapp.com/publicapi"
   USER_AGENT = "Prowler/#{VERSION}"
   MULTIPLE_APIKEY_COMMANDS = %w(add)
-  CONFIG_ATTRS = [:application, :provider_key, :api_key]
+  CONFIG_ATTRS = [:application, :provider_key, :api_key, :service_url]
 
   class ConfigurationError < StandardError; end
 
   class Application
-    attr_accessor :api_key, :provider_key #:nodoc:
+    attr_accessor :service_url, :api_key, :provider_key #:nodoc:
     attr_accessor :application, :send_notifications #:nodoc:
 
     # Create an instance for sending to different accounts within a single Rails application
@@ -22,6 +22,7 @@ module Prowler
     # * :application:  The name of your application.
     # * :provider_key: Key to override the rate limit of 1000 requests per hour.
     # * :api_key:      Your API key.
+    # * :service_url:  Override the configured service url
     def initialize(*args)
       if args.empty?
         CONFIG_ATTRS.each{ |attr| send("#{attr}=".to_sym, Prowler.send(attr)) }
@@ -30,6 +31,7 @@ module Prowler
           send("#{attr}=".to_sym, args[0][attr] || Prowler.send(attr))
         end
       else
+        @service_url = Prowler.service_url
         @api_key, @application, @provider_key = args[0], args[1], args[2]
       end
     end
@@ -145,13 +147,13 @@ module Prowler
       end
 
       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('&')}")
+        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, klass)
       end
 
       def perform_post(command, params, klass) #:nodoc:
-        url = URI.parse("#{SERVICE_URL}/#{command}")
+        url = URI.parse("#{service_url}/#{command}")
         request = Net::HTTP::Post.new(url.path, headers)
         request.form_data = params
         perform_request(url, request, klass)

data/lib/prowler/configuration.rb

@@ -1,6 +1,6 @@
 module Prowler
   class << self
-    attr_accessor :api_key, :provider_key
+    attr_accessor :service_url, :api_key, :provider_key
     attr_accessor :application, :send_notifications
     attr_accessor :read_timeout, :open_timeout #:nodoc:
     attr_accessor :delayed, :verify_certificate, :root_certificates
@@ -11,6 +11,10 @@ module Prowler
       yield self
     end
 
+    def service_url #:nodoc:
+      @service_url ||= SERVICE_URL
+    end
+
     def send_notifications #:nodoc:
       @send_notifications.nil? ? true : !!@send_notifications
     end
@@ -25,7 +29,7 @@ module Prowler
 
     # Reset configuration
     def reset_configuration
-      @application = @api_key = @provider_key = nil
+      @service_url = @application = @api_key = @provider_key = nil
       @delayed = @verify_certificate = @root_certificates = nil
       @send_notifications = @read_timeout = @open_timeout = nil
     end

data/lib/prowler/version.rb

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

data/prowler.gemspec

@@ -1,25 +1,26 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "prowler/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{prowler}
-  s.version = "1.3.0"
+  s.name        = "prowler"
+  s.version     = Prowler::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Andrew White"]
+  s.email       = ["andyw@pixeltrix.co.uk"]
+  s.homepage    = %q{http://github.com/pixeltrix/prowler/}
+  s.summary     = %q{Provides access to the Prowl API (http://prowlapp.com).}
+  s.description = <<-EOF
+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.
+EOF
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Andrew White"]
-  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 = [
-    "README"
-  ]
   s.files = [
+    ".gemtest",
     "CHANGELOG",
-    "INSTALL",
     "MIT-LICENSE",
-    "README",
+    "README.md",
     "Rakefile",
     "VERSION",
     "init.rb",
@@ -38,21 +39,14 @@ Gem::Specification.new do |s|
     "test/config/cacert.pem",
     "test/prowler_test.rb"
   ]
-  s.homepage = %q{http://github.com/pixeltrix/prowler/}
+
+  s.test_files    = ["test/prowler_test.rb"]
   s.require_paths = ["lib"]
-  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
-    s.specification_version = 3
+  s.add_development_dependency "bundler", "~> 1.0.10"
+  s.add_development_dependency "mocha", "~> 0.9.12"
+  s.add_development_dependency "shoulda", "~> 2.11.3"
+  s.add_development_dependency "webmock", "~> 1.6.2"
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
 end
 

data/test/prowler_test.rb

@@ -24,11 +24,13 @@ class ProwlerTest < Test::Unit::TestCase
 
     should "be done with a block" do
       Prowler.configure do |config|
+        config.service_url = "test.host"
         config.api_key = "apikey"
         config.application = "application"
         config.provider_key = "providerkey"
       end
 
+      assert_equal "test.host",   Prowler.service_url
       assert_equal "apikey",      Prowler.api_key
       assert_equal "application", Prowler.application
       assert_equal "providerkey", Prowler.provider_key
@@ -513,6 +515,11 @@ class ProwlerTest < Test::Unit::TestCase
         assert_equal "application2", prowler.application
         assert_equal "providerkey2", prowler.provider_key
       end
+
+      should "configure default service url" do
+        prowler = Prowler.new("apikey", "application")
+        assert_equal Prowler::SERVICE_URL, prowler.service_url
+      end
     end
 
     context "Sending a notification" do
@@ -553,4 +560,35 @@ class ProwlerTest < Test::Unit::TestCase
       end
     end
   end
+
+  context "When using a custom service url" do
+    setup do
+      Prowler.reset_configuration
+      Prowler.configure do |config|
+        config.service_url = "https://test.host/publicapi"
+        config.api_key = "apikey"
+        config.application = "Application Name"
+      end
+    end
+
+    should "send notifications to the custom service url" do
+      stub_request(:post, "https://test.host/publicapi/add")
+
+      Prowler.notify "Event Name", "Message Text"
+
+      assert_requested :post, "https://test.host/publicapi/add", :body => {
+        :application => "Application Name",
+        :apikey => "apikey",
+        :event => "Event Name",
+        :description => "Message Text",
+        :priority => Prowler::Priority::NORMAL.to_s
+      }
+    end
+
+    should "verify the API key with the custom url" do
+      stub_request :get, "https://test.host/publicapi/verify?apikey=apikey"
+      Prowler.verify
+      assert_requested :get, "https://test.host/publicapi/verify?apikey=apikey"
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: prowler
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 1
   - 3
-  - 0
-  version: 1.3.0
+  - 1
+  version: 1.3.1
 platform: ruby
 authors: 
 - Andrew White
@@ -15,23 +15,91 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-31 00:00:00 +00:00
+date: 2011-04-20 00:00:00 +01:00
 default_executable: 
-dependencies: []
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 0
+        - 10
+        version: 1.0.10
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 0
+        - 9
+        - 12
+        version: 0.9.12
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 37
+        segments: 
+        - 2
+        - 11
+        - 3
+        version: 2.11.3
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 6
+        - 2
+        version: 1.6.2
+  type: :development
+  version_requirements: *id004
+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.
 
-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
+email: 
+- andyw@pixeltrix.co.uk
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README
+extra_rdoc_files: []
+
 files: 
+- .gemtest
 - CHANGELOG
-- INSTALL
 - MIT-LICENSE
-- README
+- README.md
 - Rakefile
 - VERSION
 - init.rb
@@ -79,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Provides access to the Prowl API (http://prowlapp.com).

data/README

@@ -1,73 +0,0 @@
-== Prowler
-
-This is a plugin/gem for integrating apps with the Prowl iPhone application.
-
-INSTALLATION
-
-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.
-
-  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 your application root):
-
-  rake prowler:test
-
-If everything is configured properly the task will send a request to
-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"
-
-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(:application => 'application', :api_key => 'apikey')
-  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.
-
-  Prowler.configure do |config|
-    config.delayed = true
-  end
-
-or on a individual message basis, e.g.
-
-  Prowler.notify "Event", "Description", :delayed => 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://prowlapp.com/