fastprowl 0.2 → 0.3

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Matthew Riley MacPherson
+Copyright (c) 2011 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
@@ -16,4 +16,4 @@ 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.
+THE SOFTWARE.

data/README.markdown

@@ -1,21 +1,19 @@
 # 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* is a Ruby library for interacting with the [Prowl API](http://prowl.weks.net/api.php) **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.
+*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 notification 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:
+Install with RubyGems:
 
 	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/
+You'll need [Paul Dix](http://www.pauldix.net/)'s [Typhoeus](http://github.com/pauldix/typhoeus), which will automatically install as a dependency, but does require a reasonably current version of [libcurl](http://curl.haxx.se/libcurl/) installed. Check out the [Typhoeus README](http://github.com/pauldix/typhoeus/blob/master/README.textile) for more info. If you're having trouble getting that to work and just need a simple Prowl library with no dependancies/native extensions, check out [ruby-prowl](http://github.com/augustl/ruby-prowl).
 
 ## Usage
 
@@ -33,7 +31,7 @@ As mentioned, this is the same as using [ruby-prowl](http://github.com/augustl/r
 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()
+	# to save repeatedly supplying them when you call add()
 	prowl = FastProwl.new(
 	  :application => 'Car Repair Shop',
 	  :event => 'Your car has been ready for ages!',
@@ -52,8 +50,8 @@ 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).
+This program is free software; it is distributed under an MIT-style License.
 
 ---
 
-Copyright (c) 2010 [Matthew Riley MacPherson](http://lonelyvegan.com).
+Copyright (c) 2011 [Matthew Riley MacPherson](http://lonelyvegan.com).

data/fastprowl.gemspec

@@ -2,7 +2,7 @@ require 'rake'
 
 Gem::Specification.new do |s|
   s.name = "fastprowl"
-  s.version = "0.2"
+  s.version = "0.3"
   s.date = Time.now
   s.authors = ["Matthew Riley MacPherson"]
   s.email = "matt@lonelyvegan.com"

data/lib/fastprowl.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'typhoeus'
 
+# Create a FastProwl instance and iPhone-spam away via Prowl! ;-)
 class FastProwl
   
   class MissingAPIKey < Exception; end
@@ -10,7 +11,7 @@ class FastProwl
   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)'
+  USER_AGENT = 'FastProwl 0.3 (http://github.com/tofumatt/FastProwl)'
   
   # Supply Prowl defaults in a hash (:apikey, :providerkey, etc.), along
   # with optional Typhoeus Hydra options.
@@ -47,16 +48,15 @@ class FastProwl
     @hydra.queue(request('verify'))
   end
   
-  # Send a single Prowl notification _immediately_ (don't queue it in
-  # the Hydra). Returns the response code of the action
+  # Send a single Prowl notification _immediately_.
   def self.add(params = {})
     prowl = new
     prowl.add(params)
     prowl.run
   end
   
-  # Send a single Prowl notification _immediately_ (don't queue it in
-  # the Hydra). Returns the response code of the action
+  # Verify a Prowl API key _immediately_. Returns true if the key is
+  # valid; false otherwise.
   def self.verify(apikey)
     prowl = new(:apikey => apikey)
     prowl.valid?
@@ -86,21 +86,26 @@ class FastProwl
     
     # 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
+      params[:apikey] = params[:apikey].collect{|v| v + ',' }.to_s.chop
     end
     
-    # Return the request (to either a Hydra or a quick Typhoeus action)
+    # Delete any empty key/value sets
+    params.delete_if {|key, value| value.nil? }
+    
+    # Make the request
     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
+      :user_agent => @user_agent,
+      :method => (action == 'add') ? :post : :get,
+      :params => (action == 'add') ? params : {:apikey => params[:apikey]}
+    )
+    
+    # Typhoeus request on_complete method adds the HTTP code to an array
+    req.on_complete do |response|
+      @responses << response.code
+    end
+    
+    # Return the request
+    req
   end
   
   # Check to see if any notifications succeeded. Like the Prowl API with multiple

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: fastprowl
 version: !ruby/object:Gem::Version 
-  version: "0.2"
+  hash: 13
+  prerelease: 
+  segments: 
+  - 0
+  - 3
+  version: "0.3"
 platform: ruby
 authors: 
 - Matthew Riley MacPherson
@@ -9,29 +14,39 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-16 00:00:00 -04:00
+date: 2011-01-25 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: typhoeus
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 1
+        - 0
         version: 0.1.0
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: mocha
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id002
 description: 
 email: matt@lonelyvegan.com
 executables: []
@@ -60,21 +75,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: Ruby Prowl library that uses libcurl-multi for parallel requests