prowly 0.2.1 → 0.2.2

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/bin/prowly

@@ -38,6 +38,10 @@ EOF
   opts.on("-dDESCRIPTION", "--description DESCRIPTION", "Description") do |desc|
     options[:description] = desc
   end
+
+  opts.on("-aAPPLICATION", "--application APPLICATION", "Application") do |app|
+    options[:application] = app
+  end
   
   opts.on("-eEVENT", "--event EVENT", "Event") do |event|
     options[:event] = event

data/lib/prowly.rb

@@ -1,6 +1,46 @@
+#--
+# 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'
 
+# This is the main Prowly module
+#
+# Usage:
+#
+#   Prowly.notify do |n|
+#     n.apikey = "the apikey" or
+#     n.apikeys = ["apikey_1", "apikey_2", "apikey_n"]
+#     n.priority = Prowly::Notification::Priority::MODERATE
+#     n.application = "Prowly"
+#     n.event = "Notification"
+#     n.description = "put description here"
+#   end
+#
+#   notification = Prowly::Notification.new(:apikey => "apikey", :application => "Prowly", :description => "Testing...")
+#   result = Prowly.notify(notification)
+#
+#
 module Prowly
   
   extend self

data/lib/prowly/interface.rb

@@ -1,3 +1,26 @@
+#--
+# 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'
@@ -5,6 +28,14 @@ require 'singleton'
 
 module Prowly
   
+  # This is the actual Prowl API wrapper
+  #
+  # Usage:
+  #
+  #  prowl_api = Prowly::Interface.instance
+  #
+  #  prowl_api.call(Prowly::Command::ADD, params)
+  
   class Interface
   
     include Singleton

data/lib/prowly/notification.rb

@@ -28,8 +28,7 @@ module Prowly
       if params[:apikeys] and params[:apikey]
         raise DuplicatedAssignmentOfApiKey, "Use apikey or apikeys, not both"
       else
-        @apikey =     params[:apikeys] unless params[:apikeys].nil?
-        @apikey =     params[:apikey] unless params[:apikey].nil?
+        @apikey = params[:apikeys] || params[:apikey]
       end
     end
   

data/lib/prowly/response.rb

@@ -2,44 +2,45 @@ require 'rexml/document'
 
 module Prowly
   
+  #This is a Prowl API response wrapper
   class Response
   
     attr_writer :response
     attr_accessor :http_response
 
-    def initialize(xml_response, full_http_response)    
+    def initialize(xml_response, full_http_response)
       @response = xml_response
       @http_response = full_http_response
       Response.map_xml @response
     end
   
     def self.map_xml(response)
-      #parse xml
-      data = REXML::Document.new response
-      response_info = data.root[1]
-    
+      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)
       end
-    
+      
+      response_info_name = response_info.name
       #define a method named status and it'll return "success" or "error"
-      Response.add_instance_method(:status, response_info.name)
+      add_instance_method(:status, response_info_name)
     
-      if response_info.name == "success"
-        boolean_status = true
-      elsif response_info.name == "error"
-        boolean_status = false
-      end
+      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]
+    end
+    
     #define dynamic methods
     def self.add_instance_method(name, content)
       define_method(name) { content }

data/prowly.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{prowly}
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rafael Maga\303\261a"]
-  s.date = %q{2010-02-15}
+  s.date = %q{2010-07-11}
   s.default_executable = %q{prowly}
   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}
@@ -37,7 +37,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/rafmagana/prowly}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{A Ruby interface to Prowl (http://prowl.weks.net/)}
   s.test_files = [
     "test/helper.rb",

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: prowly
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - "Rafael Maga\xC3\xB1a"
@@ -9,19 +14,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-15 00:00:00 -06:00
+date: 2010-07-11 00:00:00 -05:00
 default_executable: prowly
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: thoughtbot-shoulda
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id001
 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: 
@@ -59,18 +66,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A Ruby interface to Prowl (http://prowl.weks.net/)