prowly 0.2.4 → 0.3.0

data/CONTRIBUTORS.md

@@ -0,0 +1,5 @@
+## Ruby 1.9 compatibility
+* Contributed by [Chris Hoffman](https://github.com/cehoffman "cehoffman")
+
+## Prowl API v1.2
+* Contributed by [Ken Pepple](https://github.com/slashk "slashk")

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Rafael Magaña
+Copyright (c) 2009 Rafael Magana
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -8,12 +8,15 @@ Yet another Ruby interface to Prowl with command line utility
 
 == Usage as a Gem
 	
+Sending a notification via prowly gem
+
 	Prowly.notify do |n| # :notify is an alias of :add
 	  n.apikey = "apikey" or n.apikeys = ["apikey_1", "apikey_2", "apikey_n"]
 	  n.priority = Prowly::Notification::Priority::MODERATE
 	  n.application = "Prowly"
 	  n.event = "Notification"
 	  n.description = "Your server is under attack!!!"
+	  n.url = "http://www.myserver.com"
 	end
 	
 	notification = Prowly::Notification.new(:apikey => "apikey", :application => "Prowly", :description => "Testing...")
@@ -21,6 +24,30 @@ Yet another Ruby interface to Prowl with command line utility
 	
 	result = Prowly.notify(notification)
 
+Obtaining a user's API key with the prowly gem is a three step process:
+
+- provider gets a token with their provider key via the retrieve_token call
+- user approves the request at a special web URL (in their browser)
+- provider gets user's API key with their provider key and the token via retrieve_apikey
+
+This is somewhat similar to the OAuth scheme.
+
+  # obtain a token first with your provider key first
+  provider_key = "2b33d3f3f8522aaed4b2fc44382f1519791db6a2"
+  token_result = Prowly.retrieve_token(provider_key)
+  if token_result.succeeded?
+    # if the call succeeded, the user will need to approve the request in their browser
+    puts "go to this #{token_result.url} to approve this request"
+    puts "then press <ENTER> to continue "
+    dummy = STDIN.gets
+
+    apikey_result = Prowly.retrieve_apikey(options[:provider], token_result.token)
+
+    if apikey_result.succeeded?
+      puts "The user apikey is #{apikey_result.apikey}"
+    end
+  end
+
 == Usage in the command line
 	
 	$prowly -h # help
@@ -33,15 +60,17 @@ Yet another Ruby interface to Prowl with command line utility
 	  -d, --description DESCRIPTION    Description
 	  -e, --event EVENT                Event
 	  -p, --priority PRIORITY          VERY_LOW, MODERATE, NORMAL (default), HIGH, EMERGENCY
+	  -u, --url                        URL for redirect (v1.2 feature)
 	  -v, --version                    Print the version number and exit
-	
+
 	  If you only specify the apikey prowly will use the defaults: 
-      
+
 	  :description => "I am testing Prowly, and it works!"
 	  :event => "Prowly notification"
 	  :application => "Prowly"
 	  :priority => NORMAL
-		
+	  :url => nil
+
 == Handling the Prowl API response
 	
 	ON SUCCESS
@@ -50,9 +79,9 @@ Yet another Ruby interface to Prowl with command line utility
 
 	if result.succeeded?
 	  result.remaining # => "977"
-	  resetdate.resetdate # => "1266272588"
+	  result.resetdate # => "1266272588"
 	else
-	  resetdate.message # => 
+	  result.message # => 
 	end
 	
 	ON ERROR
@@ -61,12 +90,10 @@ Yet another Ruby interface to Prowl with command line utility
 
 	if result.succeeded?
 	  result.remaining # =>
-	  resetdate.resetdate # =>
+	  result.resetdate # =>
 	else
-	  resetdate.message # => "Invalid API Key(s)" <= This depends on the message sent by the prowl API
+	  result.message # => "Invalid API Key(s)" <= This depends on the message sent by the prowl API
 	end
-	
-
 
 == Note on Patches/Pull Requests
  
@@ -78,6 +105,4 @@ Yet another Ruby interface to Prowl with command line utility
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-== Copyright
-
-Copyright (c) 2010 Rafael Magaña. See LICENSE for details.
+See LICENSE for details

data/Rakefile

@@ -10,9 +10,7 @@ begin
     gem.description = "The Prowly gem is a simple wrapper to the Prowl API, you can use it to send messages to your iPhone in a Rails or pure Ruby application."
     gem.email = "raf.magana@gmail.com"
     gem.homepage = "http://github.com/rafmagana/prowly"
-    gem.authors = ["Rafael Magaña"]
-    gem.add_development_dependency "shoulda", ">= 0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.authors = ["Rafael Magana"]
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.2.4
+0.3.0

data/bin/prowly

@@ -15,7 +15,8 @@ options = {
             :description => "I am testing Prowly, and it works!", 
             :event => "Prowly notification", 
             :application => "Prowly", 
-            :priority => "NORMAL"}
+            :priority => "NORMAL",
+            :url => nil}
 
 
 opts = OptionParser.new do |opts|
@@ -51,6 +52,10 @@ EOF
     options[:priority] = priority
   end
   
+  opts.on("-uURL", "--url URL", "URL") do |url|
+    options[:url] = url
+  end
+  
   opts.on("-v", "--version", "Print the version number and exit") do
     options[:version] = true
   end  
@@ -88,6 +93,7 @@ result = Prowly.notify do |n|
   n.application = options[:application]
   n.event       = options[:event]
   n.description = options[:description]
+  n.url         = options[:url]
 end
 
 if result.succeeded?

data/bin/prowly_retrieve_apikey

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+STDOUT.sync = true
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'rubygems'
+require 'prowly'
+require 'optparse'
+
+options = {}
+
+ORIGINAL_ARGV = ARGV.dup
+
+opts = OptionParser.new do |opts|
+  opts.banner = <<-EOF
+Usage:
+    prowly_retrieve -p providerkey
+
+  Options:
+EOF
+
+  opts.on("-pPROVIDERKEY", "--provider PRIORITY", "Provider Key") do |priority|
+    options[:provider] = priority
+  end
+  
+  opts.on("-v", "--version", "Print the version number and exit") do
+    options[:version] = true
+  end  
+end
+
+opts.parse!
+
+if options[:version]
+  abort("Version " + Prowly.version)
+end
+
+token_result = Prowly.retrieve_token(options[:provider])
+
+if token_result.succeeded?
+  puts "go to this #{token_result.url} to approve this request"
+  puts "then press <ENTER> to continue "
+  dummy = STDIN.gets
+
+  apikey_result = Prowly.retrieve_apikey(options[:provider], token_result.token)
+
+  if apikey_result.succeeded?
+    puts "The user apikey is #{apikey_result.apikey}"
+    exit(0)
+  else
+    puts "Error: #{apikey_result.message}"
+    exit(1)
+  end
+else
+  puts "Error: #{token_result.message}"
+  exit(1)
+end

data/lib/prowly.rb

@@ -1,26 +1,3 @@
-#--
-# Copyright (c) 2010 Rafael Magaña Ávalos
-#
-# 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.
-#++
-
 require 'prowly/interface'
 require 'prowly/notification'
 
@@ -53,6 +30,14 @@ module Prowly
   def verify(apikey)
     api.call Interface::Command::VERIFY, "apikey=#{apikey}"
   end
+
+  def retrieve_token(providerkey)
+    api.call Interface::Command::RETRIEVE_TOKEN, "providerkey=#{providerkey}"
+  end
+  
+  def retrieve_apikey(providerkey, token)
+    api.call Interface::Command::RETRIEVE_APIKEY, "providerkey=#{providerkey}&token=#{token}"
+  end
   
   def valid_key?(key)
     result = verify(key)

data/lib/prowly/interface.rb

@@ -1,26 +1,3 @@
-#--
-# Copyright (c) 2010 Rafael Magaña Ávalos
-#
-# 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.
-#++
-
 require 'net/https'
 require 'prowly/response'
 require 'prowly/notification'
@@ -41,7 +18,7 @@ module Prowly
     include Singleton
     
     def initialize
-      @url = "https://prowl.weks.net/publicapi"
+      @url = "https://api.prowlapp.com/publicapi"
     end
     
     ## Make the actual call to the prowl api
@@ -68,6 +45,8 @@ module Prowly
     module Command
       ADD     = "add"
       VERIFY  = "verify"
+      RETRIEVE_TOKEN = "retrieve/token"
+      RETRIEVE_APIKEY = "retrieve/apikey"
     end
     
     ## EXCEPTIONS

data/lib/prowly/notification.rb

@@ -58,7 +58,7 @@ module Prowly
     ## EXCEPTIONS
     class PriorityNotAvailable < RuntimeError; end
   
-    attr_accessor :providerkey, :priority, :event
+    attr_accessor :providerkey, :priority, :event, :url
   
     def initialize(params = {})
       @apikey       = (params[:apikey] || params[:apikeys]) || "fffffffffffffffffffffffffffffffffffffffff"
@@ -66,6 +66,7 @@ module Prowly
       @event        = params[:event]        || "Prowly is working!!"
       @description  = params[:description]   || "This is the default description"
       @priority     = params[:priority]     || Priority::NORMAL
+      @url          = params[:url]          || nil
       super
     end
     

data/lib/prowly/response.rb

@@ -4,7 +4,7 @@ module Prowly
   
   #This is a Prowl API response wrapper
   class Response
-  
+    
     attr_writer :response
     attr_accessor :http_response
 
@@ -17,28 +17,29 @@ module Prowly
     def self.map_xml(response)
       response_info = parse_xml(response)
       
-      #define dynamic methods based on the prowl api response
-      #posible methods on success: code, remaining, resetdate
-      #posible methods on error: code
-      response_info.attributes.each do |key, value|
-        add_instance_method(key, value)
+      response_info.elements.each do |r|
+        #define dynamic methods based on the prowl api response
+        #posible methods on success: code, remaining, resetdate
+        #posible methods on error: code
+        r.attributes.each do |key, value|
+          # puts "attribute #{key}: #{value}"
+          if key == "code"
+            add_instance_method(:status, value == "200" ? "success" : "error") 
+            #define a method named status and it'll return "success" or "error"
+            boolean_status = value == "200" ? true : false
+            add_instance_method(:succeeded?, boolean_status)
+            add_instance_method(:message, response_info[1].text) unless boolean_status
+          end
+          add_instance_method(key, value)
+        end
       end
       
-      response_info_name = response_info.name
-      #define a method named status and it'll return "success" or "error"
-      add_instance_method(:status, response_info_name)
-    
-      boolean_status = response_info_name == "success" ? true : false
-    
-      add_instance_method(:message, response_info.text) unless boolean_status
-    
-      add_instance_method(:succeeded?, boolean_status)
       true
     end
     
     def self.parse_xml(response)
       data = REXML::Document.new response
-      data.root[1]
+      data.root
     end
     
     #define dynamic methods
@@ -46,7 +47,7 @@ module Prowly
       define_method(name) { content }
     end
   
-    ## ERRORCODES are documented in http://prowl.weks.net/api.php
+    ## ERRORCODES are documented in http://www.prowlapp.com/api.php
     module ErrorCode
       BAD                   = 400 #Bad request, the parameters you provided did not validate, see ERRORMESSAGE.
       NOT_AUTHORIZED        = 401 #Not authorized, the API key given is not valid, and does not correspond to a user.

data/prowly.gemspec

@@ -1,47 +1,46 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{prowly}
-  s.version = "0.2.4"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Rafael Magaña"]
-  s.date = %q{2010-07-28}
-  s.default_executable = %q{prowly}
+  s.authors = ["Rafael Magana"]
+  s.date = %q{2011-03-28}
   s.description = %q{The Prowly gem is a simple wrapper to the Prowl API, you can use it to send messages to your iPhone in a Rails or pure Ruby application.}
   s.email = %q{raf.magana@gmail.com}
-  s.executables = ["prowly"]
+  s.executables = ["prowly_retrieve_apikey", "prowly"]
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+    "README.rdoc"
   ]
   s.files = [
     ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "bin/prowly",
-     "lib/prowly.rb",
-     "lib/prowly/interface.rb",
-     "lib/prowly/notification.rb",
-     "lib/prowly/response.rb",
-     "prowly.gemspec",
-     "test/helper.rb",
-     "test/test_prowly.rb"
+    "CONTRIBUTORS.md",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bin/prowly",
+    "bin/prowly_retrieve_apikey",
+    "lib/prowly.rb",
+    "lib/prowly/interface.rb",
+    "lib/prowly/notification.rb",
+    "lib/prowly/response.rb",
+    "prowly.gemspec",
+    "test/helper.rb",
+    "test/test_prowly.rb"
   ]
   s.homepage = %q{http://github.com/rafmagana/prowly}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{A Ruby interface to Prowl (http://prowl.weks.net/)}
   s.test_files = [
     "test/helper.rb",
-     "test/test_prowly.rb"
+    "test/test_prowly.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -49,12 +48,9 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
     else
-      s.add_dependency(%q<shoulda>, [">= 0"])
     end
   else
-    s.add_dependency(%q<shoulda>, [">= 0"])
   end
 end
 

data/test/helper.rb

@@ -1,6 +1,5 @@
 require 'rubygems'
 require 'test/unit'
-require 'shoulda'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))

data/test/test_prowly.rb

@@ -1,7 +1,80 @@
 require 'helper'
 
 class TestProwly < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
+
+# TODO(slashk): add mock/stubs to simulate calls
+
+  def test_parse_good_retrieve_token_response
+    xml_response =
+<<EOF
+<?xml version="1.0" encoding="UTF-8"?>
+<prowl>
+    <success code="200" remaining="999" resetdate="1300659778" />
+    <retrieve token="2e948b117a965a0ead02b106a18fb038b7f05809" url="https://www.prowlapp.com/retrieve.php?token=2e948b117a965a0ead02b106a18fb038b7f05809" />
+</prowl>
+EOF
+    full_http_response = "200"
+    rt = Prowly::Response.new(xml_response, full_http_response)
+    assert_equal(rt.code, "200")
+    assert_equal(true, rt.succeeded?)
+    assert_equal("2e948b117a965a0ead02b106a18fb038b7f05809", rt.token)
+  end
+
+  def test_parse_good_notify_response
+    xml_response =
+<<EOF
+<?xml version="1.0" encoding="UTF-8"?>
+<prowl>
+	<success code="200" remaining="999" resetdate="1300659778" />
+</prowl>
+EOF
+    full_http_response = "200"
+    rt = Prowly::Response.new(xml_response, full_http_response)
+    assert_equal(rt.code, "200")
+    assert_equal(true, rt.succeeded?)
+  end
+
+  def test_parse_error_notify_response
+    xml_response =
+<<EOF
+<?xml version="1.0" encoding="UTF-8"?>
+<prowl>
+	<error code="401">the API key given is not valid</error>
+</prowl>
+EOF
+    full_http_response = "401"
+    rt = Prowly::Response.new(xml_response, full_http_response)
+    assert_equal(rt.message, "the API key given is not valid")
   end
+
+  def test_verify_good_apikey_response
+    xml_response =
+<<EOF
+<?xml version="1.0" encoding="UTF-8"?>
+<prowl>
+  <success code="200" remaining="998" resetdate="1300665013" />
+</prowl>
+EOF
+    full_http_response = "200"
+    rt = Prowly::Response.new(xml_response, full_http_response)
+    assert_equal(rt.code, "200")
+    assert_equal(true, rt.succeeded?)
+  end
+
+  def test_good_retrieve_apikey_response
+    xml_response =
+<<EOF
+<?xml version="1.0" encoding="UTF-8"?>
+<prowl>
+	<success code="200" remaining="999" resetdate="1300659778" />
+	<retrieve apikey="15c501d2e65cfd46316513da47355283db4652fc" />
+</prowl>
+EOF
+    full_http_response = "200"
+    rt = Prowly::Response.new(xml_response, full_http_response)
+    assert_equal(rt.code, "200")
+    assert_equal(true, rt.succeeded?)
+    assert_equal("15c501d2e65cfd46316513da47355283db4652fc", rt.apikey)
+  end
+
 end

metadata

@@ -1,38 +1,28 @@
 --- !ruby/object:Gem::Specification 
 name: prowly
 version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 4
-  version: 0.2.4
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
-- "Rafael Maga\xC3\xB1a"
+- Rafael Magana
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-07-28 00:00:00 -05:00
-default_executable: prowly
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: shoulda
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id001
+date: 2011-03-28 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
 description: The Prowly gem is a simple wrapper to the Prowl API, you can use it to send messages to your iPhone in a Rails or pure Ruby application.
 email: raf.magana@gmail.com
 executables: 
+- prowly_retrieve_apikey
 - prowly
 extensions: []
 
@@ -41,12 +31,13 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
-- .gitignore
+- CONTRIBUTORS.md
 - LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
 - bin/prowly
+- bin/prowly_retrieve_apikey
 - lib/prowly.rb
 - lib/prowly/interface.rb
 - lib/prowly/notification.rb
@@ -59,8 +50,8 @@ homepage: http://github.com/rafmagana/prowly
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -68,6 +59,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -76,6 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"

data/.gitignore

@@ -1,21 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC