fastprowl 0.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Matthew Riley MacPherson
+
+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.markdown

@@ -0,0 +1,59 @@
+# FastProwl
+## Ruby Prowl library that uses libcurl-multi for parallel requests
+
+*FastProwl* is a Ruby library for interacting with the Prowl API **using Typhoeus** (a libcurl-multi interface written in Ruby). It is inspired heavily by [August Lilleaas](http://august.lilleaas.net/)'s [ruby-prowl](http://github.com/augustl/ruby-prowl) library (the class method `FastProwl.add()` still works if you include this library instead).
+
+*FastProwl* lets you queue up many Prowl API requests then make them concurrently, which is handy if you make a bunch of requests in quick succession. It was developed for [Prey Fetcher](http://preyfetcher.com), which sends too many notifications requests to wait on blocking HTTP calls.
+
+Please fork away and send me a pull request if you think you can make it better or whatnot.
+
+## Installation
+
+Assuming you have [Gemcutter](http://gemcutter.org/) setup as a gem source, install like any other Ruby gem:
+
+	gem install fastprowl
+
+If you don't already have [Gemcutter](http://gemcutter.org/) setup as one of your gem sources, install FastProwl with the following command:
+
+	gem install fastprowl --source http://gemcutter.org/
+
+## Usage
+
+Pretty simple -- you can send single notifications without bothering with queuing and all that by using the class method `FastProwl.add()`:
+
+	FastProwl.add(
+      :apikey => 'valid_api_key',
+      :application => 'Car Repair Shop',
+      :event => 'Your car is now ready!',
+      :description => 'We had to replace a part. Bring your credit card.'
+    )
+
+As mentioned, this is the same as using [ruby-prowl](http://github.com/augustl/ruby-prowl). It will return `true` on success; `false` otherwise.
+
+If you want to send concurrent requests (presumably you do), create an instance object and use the `add()` method to queue up your requests. When all of your requests are ready, use the `run()` method to send all of your queued notifications:
+
+	# You can put any attributes you want in the constructor
+	# to save repeatly supplying them when you call add()
+	prowl = FastProwl.new(
+	  :application => 'Car Repair Shop',
+	  :event => 'Your car has been ready for ages!',
+	  :description => 'Hurry up! Bring your credit card!'
+	)
+	
+	users.each do |user|
+	  prowl.add(
+	    :apikey => user.prowl_apikey,
+      )
+	end
+	
+	prowl.run
+
+You get the idea.
+
+## License
+
+This program is free software; it is distributed under an [MIT-style License](http://fosspass.org/license/mit?author=Matthew+Riley+MacPherson&year=2010).
+
+---
+
+Copyright (c) 2010 [Matthew Riley MacPherson](http://lonelyvegan.com).

data/fastprowl.gemspec

@@ -0,0 +1,17 @@
+require 'rake'
+
+Gem::Specification.new do |s|
+  s.name = "fastprowl"
+  s.version = "0.1"
+  s.date = Time.now
+  s.authors = ["Matthew Riley MacPherson"]
+  s.email = "matt@lonelyvegan.com"
+  s.has_rdoc = true
+  s.rdoc_options << '--title' << "FastProwl - Ruby Prowl library that uses libcurl-multi for parallel requests" << '--main' << 'README.markdown' << '--line-numbers'
+  s.summary = "Ruby Prowl library that uses libcurl-multi for parallel requests"
+  s.homepage = "http://github.com/tofumatt/FastProwl"
+  s.files = FileList['lib/*.rb', '[A-Z]*', 'fastprowl.gemspec', 'test/*.rb'].to_a
+  s.test_file = 'test/fastprowl_test.rb'
+  s.add_dependency('typhoeus')
+  s.add_development_dependency('mocha') # Used to run the tests, that's all...
+end

data/lib/fastprowl.rb

@@ -0,0 +1,101 @@
+require 'rubygems'
+require 'typhoeus'
+
+class FastProwl
+  
+  class MissingAPIKey < Exception; end
+  class PriorityOutOfRange < Exception; end
+  class TooManyAPIKeys < Exception; end
+  
+  API_URL = 'https://prowl.weks.net/publicapi/'
+  PRIORITY_RANGE = -2..2
+  # You can change this using the user_agent() method
+  USER_AGENT = 'FastProwl 0.1 (http://github.com/tofumatt/FastProwl)'
+  
+  # Supply Prowl defaults in a hash (:apikey, :providerkey, etc.), along
+  # with optional Typhoeus Hydra options.
+  def initialize(defaults = {}, hydra = {})
+    @defaults = defaults
+    @responses = []
+    @hydra = Typhoeus::Hydra.new(hydra)
+    @user_agent = USER_AGENT
+  end
+  
+  # Queue a notification request in the Hydra.
+  def add(params = {})
+    @hydra.queue(request('add', params))
+  end
+  
+  # Modify this instance's defaults
+  def defaults(params)
+    @defaults = @defaults.merge(params)
+  end
+  
+  # Run all queued Hydra requests.
+  def run
+    @hydra.run
+    status
+  end
+  
+  # Change the user-agent sent to the Prowl server.
+  def user_agent(user_agent)
+    @user_agent = user_agent
+  end
+  
+  # Send a single Prowl notification _immediately_ (don't queue it in
+  # the Hydra). Returns the response code of the action
+  def self.add(params = {})
+    prowl = new
+    prowl.add(params)
+    prowl.run
+  end
+  
+  private
+  
+  # Setup and return a Typhoeus HTTP request
+  def request(action, params = {})
+    # Merge the default params with any custom ones
+    params = @defaults.merge(params) unless !@defaults
+    
+    # Exception checks
+    if !params[:apikey] || (params[:apikey].is_a?(Array) && params[:apikey].size < 1)
+      raise MissingAPIKey
+    end
+    
+    if params[:priority] && !PRIORITY_RANGE.include?(params[:priority])
+      raise PriorityOutOfRange
+    end
+    
+    # Raise an exception if we're trying to use more API keys than allowed for this action
+    if params[:apikey].is_a?(Array) && ((action == 'verify' && params[:apikey].size > 1) || params[:apikey].size > MAX_API_KEYS)
+      raise TooManyAPIKeys
+    end
+    
+    # If there are multiple API Keys in an array, merge them into a comma-delimited string
+    if params[:apikey].is_a?(Array)
+      params[:apikey] = params[:apikey].collect{|v| v + ','}.to_s.chop
+    end
+    
+    # Return the request (to either a Hydra or a quick Typhoeus action)
+    req = Typhoeus::Request.new(API_URL + action,
+			:user_agent => @user_agent,
+			:method => (action == 'add') ? :post : :get,
+			:params => (action == 'add') ? params : {:apikey => params[:apikey]}
+		)
+		
+		req.on_complete do |response|
+		  @responses << response.code
+		end
+		
+		req
+  end
+  
+  # Check to see if any notifications succeeded. Like the Prowl API with multiple
+  # API keys, we'll only return false if *zero* requests succeeded.
+  def status
+    return false if !@responses.include?(200)
+    
+    true
+  end
+  
+end

data/test/fastprowl_test.rb

@@ -0,0 +1,72 @@
+require 'test/unit'
+
+$LOAD_PATH << File.expand_path("#{File.dirname(__FILE__)}/../lib")
+require 'fastprowl'
+
+require 'rubygems'
+require 'mocha'
+
+class FastProwlTest < Test::Unit::TestCase
+  
+  APPLICATION = 'FastProwl Unit Tests (http://github.com/tofumatt/FastProwl)'
+  BAD_API_KEY = 'badapikeyftw'
+  # This is a <b>valid API key</b> for an account with no devices. I'm not sure how
+  # you'd go about abusing it, but please don't.
+  VALID_API_KEY = 'c7634829dfafb02cc966df2f3dfc2c75fe2c9ef1'
+  
+  # Priority range is -2..2
+  def test_invalid_priority
+    assert_raises(FastProwl::PriorityOutOfRange) { FastProwl.add(:apikey => VALID_API_KEY, :priority => 10) }
+  end
+  
+  # API key(s) are _required_
+  def test_no_api_key
+    assert_raises(FastProwl::MissingAPIKey) { FastProwl.add(:apikey => nil) }
+  end
+  
+  # This key will fail
+  def test_invalid_api_key
+    assert !FastProwl.add(:apikey => BAD_API_KEY, :application => APPLICATION, :event => 'test_invalid_api_key', :description => "This shouldn't work.")
+  end
+  
+  # Sending works
+  def test_valid_api_key
+    assert FastProwl.add(:apikey => VALID_API_KEY, :application => APPLICATION, :event => 'test_valid_api_key', :description => "This should work.")
+  end
+  
+  # Concurrency test -- try to send a bunch of notifications
+  def test_multi
+    prowl = FastProwl.new
+    
+    10.times do
+      prowl.add(:apikey => VALID_API_KEY, :application => APPLICATION, :event => 'test_multi', :description => "This is a concurrency test -- it should work.")
+    end
+    
+    assert prowl.run
+  end
+  
+  # Concurrency test -- try to send a bunch of notifications, including one with a bad API key
+  def test_multi_onefails
+    prowl = FastProwl.new
+    
+    prowl.add(:apikey => BAD_API_KEY, :application => APPLICATION, :event => 'test_multi_onefails', :description => "This is a concurrency test -- it should work, but one key is bad.")
+    
+    9.times do
+      prowl.add(:apikey => VALID_API_KEY, :application => APPLICATION, :event => 'test_multi_onefails', :description => "This is a concurrency test -- it should work, but one key is bad.")
+    end
+    
+    assert prowl.run
+  end
+  
+  # Concurrency test -- try to send a bunch of notifications, all with a bad API keys
+  def test_multi_allfail
+    prowl = FastProwl.new
+    
+    10.times do
+      prowl.add(:apikey => BAD_API_KEY, :application => APPLICATION, :event => 'test_multi_allfail', :description => "This is a concurrency test -- it shouldn't work.")
+    end
+    
+    assert !prowl.run
+  end
+  
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: fastprowl
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Matthew Riley MacPherson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-15 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: typhoeus
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: matt@lonelyvegan.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/fastprowl.rb
+- LICENSE
+- README.markdown
+- fastprowl.gemspec
+- test/fastprowl_test.rb
+has_rdoc: true
+homepage: http://github.com/tofumatt/FastProwl
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --title
+- FastProwl - Ruby Prowl library that uses libcurl-multi for parallel requests
+- --main
+- README.markdown
+- --line-numbers
+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: Ruby Prowl library that uses libcurl-multi for parallel requests
+test_files: 
+- test/fastprowl_test.rb