prowl 0.1.0

data/README

@@ -0,0 +1,40 @@
+     --~~ Prowl ~~--
+     
+     Ruby wrapper for http://prowl.weks.net/.
+     Written by August Lilleaas (http://august.lilleaas.net/).
+     
+     Prowl rocks! It's a webapp and a iPhone app that works
+     together and lets you send push notifications via HTTP
+     to any iPhone that has the prowl app installed.
+     
+          Prowl.send({
+            :application => "World Saving Project Manager",
+            :event => "Canceled",
+            :description => "It sucked, so I canceled it. Sorry :(",
+            :apikey => "abc123def456"
+          })
+
+      The user has given you its API key. That lets you
+      send push notifications to the users iPhone, through
+      the Prowl iPhone app.
+      
+      
+      --~~ Usage ~~--
+      
+      Three required parameters:
+      
+          :application
+          :event
+          :description
+          
+      Other than that, you're free to choose from any of these
+      highly convenient methods.
+      
+      Prowl.send({:apikey => "...", ...})
+      Prowl.send({:username => "...", :password => "...", ...})
+      
+      p = Prowl.new("username", "password")
+      p.send(...)
+      
+      p = Prowl.new("apikey123abc")
+      p.send(...)

data/lib/prowl.rb

@@ -0,0 +1,71 @@
+require 'cgi'
+require 'net/https'
+require 'uri'
+
+require 'prowl/api_key_handler'
+require 'prowl/http_auth_handler'
+
+class Prowl
+  # new('username', 'password') or new('apikeyhere').
+  def initialize(*args)
+    case args.length
+    when 1 # api key
+      @handler = Prowl::ApiKeyHandler.new(*args)
+    when 2 # username/password
+      @handler = Prowl::HttpAuthHandler.new(*args)
+    else
+      raise ArgumentError
+    end
+  end
+  
+  def send(params)
+    @handler.add(params)
+  end
+  
+  # Utility function that creates an instance and sends a prowl
+  def self.send(*args)
+    params = args.pop
+    new(*args).send(params)
+  end
+  
+  # Utility function to verify API keys
+  def self.verify(api_key)
+    new(api_key).valid?
+  end
+  
+  def valid?
+    @handler.valid?
+  end
+end
+
+# For me and my good friend friend Textmate.
+if __FILE__ == $0
+  puts "Your API key, please."
+  api_key = gets
+  
+  if api_key
+    api_key.chomp!
+    p Prowl.send(api_key, :application => "Fishes", :event => "silly", :description => "Awwawaw.")
+  end
+  
+  
+  puts "Test verification?"
+  api_key = gets
+  
+  if api_key
+    api_key.chomp!
+    p Prowl.new(api_key).valid?
+  end
+  
+  puts "Your username, please."
+  username = gets.chomp
+  
+  puts "Your password, please."
+  password = gets.chomp
+  
+  if username
+    username.chomp!
+    password.chomp!
+    p Prowl.send(username, password, :application => "Fishes", :event => "silly", :description => "Awwawaw.")
+  end
+end

data/lib/prowl/api_key_handler.rb

@@ -0,0 +1,33 @@
+class Prowl
+  class ApiKeyHandler
+    API_URL = "https://prowl.weks.net:443/publicapi"
+    
+    def initialize(api_key)
+      @api_key = api_key
+    end
+    
+    def valid?
+      @valid ||= (perform("verify", :apikey => @api_key) == 200)
+    end
+    
+    def add(params)
+      perform("add", params)
+    end
+    
+    private
+    
+    def perform(action, params)
+      uri = URI.parse("#{API_URL}/#{action}")
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      
+      params[:apikey] = @api_key
+      u = uri.request_uri + "?" + params.map {|k, v| "#{k}=#{CGI.escape(v)}"}.join("&")
+      p u
+      request = Net::HTTP::Get.new(u)
+      response = http.request(request)
+      return response.code.to_i
+    end
+  end
+end

data/lib/prowl/http_auth_handler.rb

@@ -0,0 +1,24 @@
+class Prowl
+  class HttpAuthHandler
+    API_URL = URI.parse("https://prowl.weks.net:443/api/add_notification.php")
+    
+    def initialize(username, password)
+      @username, @password = username, password
+    end
+    
+    def valid?
+      raise RuntimeError, "The API doesn't provide a method for determining if a username/password is valid."
+    end
+    
+    def add(params)
+      http = Net::HTTP.new(API_URL.host, API_URL.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      
+      request = Net::HTTP::Get.new(API_URL.request_uri + "?" + params.map {|k, v| "#{k}=#{CGI.escape(v)}"}.join("&"))
+      request.basic_auth @username, @password
+      response = http.request(request)
+      return response.code.to_i
+    end
+  end
+end

data/prowl.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name = "prowl"
+  s.version = "0.1.0"
+  s.date = "2009-07-08"
+  s.authors = ["August Lilleaas"]
+  s.email = "augustlilleaas@gmail.com"
+  s.rubyforge_project = "prowl"
+  s.has_rdoc = true
+  s.summary = "Wrapprer for prowl, http://prowl.weks.net/."
+  s.homepage = "http://github.com/augustl/prowl"
+  s.files = [
+    "lib/prowl.rb",
+    "lib/prowl/api_key_handler.rb",
+    "lib/prowl/http_auth_handler.rb",
+    "prowl.gemspec",
+    "README",
+    "test/prowl_test.rb"
+  ]
+end

data/test/prowl_test.rb

@@ -0,0 +1,43 @@
+require 'test/unit'
+
+$LOAD_PATH << File.expand_path("#{File.dirname(__FILE__)}/../lib")
+require 'prowl'
+
+require 'rubygems'
+require 'mocha'
+
+class ProwlTest < Test::Unit::TestCase
+  def test_valid_api_key
+    Prowl::ApiKeyHandler.any_instance.expects(:perform).returns(200)
+    assert_equal 200, Prowl.send("my api key", :application => "Fishes", :event => "Silly", :description => "Blah")
+  end
+  
+  # Uh.. Such a silly test.
+  def test_invalid_api_key
+    Prowl::ApiKeyHandler.any_instance.expects(:perform).returns(666)
+    assert_equal 666, Prowl.send("my api key", :application => "Fishes", :event => "Silly", :description => "Blah")
+  end
+  
+  def test_valid_with_api_key
+    Prowl::ApiKeyHandler.any_instance.expects(:perform).returns(200)
+    assert Prowl.verify("my api key")
+    
+    Prowl::ApiKeyHandler.any_instance.expects(:perform).returns(666)
+    assert !Prowl.verify("my api key")
+  end
+  
+  def test_http_auth
+    Prowl::HttpAuthHandler.any_instance.expects(:add).returns(200)
+    assert_equal 200, Prowl.send("username", "password", :application => "Fishes", :event => "Silly", :description => "Blah")
+  end
+  
+  # Also uh..
+  def test_failed_http_auth
+    Prowl::HttpAuthHandler.any_instance.expects(:add).returns(666)
+    assert_equal 666, Prowl.send("username", "password", :application => "Fishes", :event => "Silly", :description => "Blah")
+  end
+  
+  def test_valid_with_username_and_password
+    assert_raises(RuntimeError) { Prowl.new("username", "password").valid? }
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: prowl
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- August Lilleaas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-08 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: augustlilleaas@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/prowl.rb
+- lib/prowl/api_key_handler.rb
+- lib/prowl/http_auth_handler.rb
+- prowl.gemspec
+- README
+- test/prowl_test.rb
+has_rdoc: true
+homepage: http://github.com/augustl/prowl
+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: []
+
+rubyforge_project: prowl
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Wrapprer for prowl, http://prowl.weks.net/.
+test_files: []
+