prowly 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Rafael Magaña
+
+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.rdoc

@@ -0,0 +1,62 @@
+= prowly
+
+Yet another Ruby interface to Prowl
+
+== Installation
+	
+	gem install prowly
+
+== Usage
+	
+	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!!!"
+	end
+	
+	notification = Prowly::Notification.new(:apikey => "apikey", :application => "Prowly", :description => "Testing...")
+	notification = Prowly::Notification.new(:apikeys => ["apikey_1", "apikey_2", "apikey_n"], :application => "Prowly", :description => "Testing...")
+	
+	result = Prowly.notify(notification)
+
+== Handling the Prowl API response
+	
+	ON SUCCESS
+	result.status # => "success"
+	result.code # => "200"
+
+	if result.succeeded?
+	  result.remaining # => "977"
+	  resetdate.resetdate # => "1266272588"
+	else
+	  resetdate.message # => 
+	end
+	
+	ON ERROR
+	result.status # => "error"
+	result.code # => "401" <= This depends on the error code sent by the prowl API
+
+	if result.succeeded?
+	  result.remaining # =>
+	  resetdate.resetdate # =>
+	else
+	  resetdate.message # => "Invalid API Key(s)" <= This depends on the message sent by the prowl API
+	end
+	
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (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.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "prowly"
+    gem.summary = "A Ruby interface to Prowl (http://prowl.weks.net/)"
+    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 "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "prowly #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/prowly

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+
+STDOUT.sync = true
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'rubygems'
+require 'prowly'
+require 'optparse'
+
+ORIGINAL_ARGV = ARGV.dup
+
+#the defaults
+options = {
+            :description => "I am testing Prowly, and it works!", 
+            :event => "Prowly notification", 
+            :application => "Prowly", 
+            :priority => Prowly::Notification::Priority::NORMAL}
+
+
+opts = OptionParser.new do |opts|
+  opts.banner = <<-EOF
+Usage:
+    prowly -k onekey -e "the event"
+    prowly -k apikey_1,apikey_2,apikey_n -e "the event"
+        
+  Options:
+EOF
+
+  opts.on("-cCOMMAND", "--api-command COMMAND", "API Command, notify or verify so far") do |command|
+    options[:command] = command
+  end
+
+  opts.on("-kAPIKEY", "--api-key APIKEY", "Prowl API Key") do |apikey|
+    options[:apikey] = apikey
+  end
+  
+  opts.on("-dDESCRIPTION", "--description DESCRIPTION", "Description") do |desc|
+    options[:description] = desc
+  end
+  
+  opts.on("-eEVENT", "--event EVENT", "Event") do |event|
+    options[:event] = event
+  end
+  
+  opts.on("-pPRIORITY", "--priority PRIORITY", "VERY_LOW, MODERATE, NORMAL (default), HIGH, EMERGENCY") do |priority|
+    options[:priority] = 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
+
+# validate
+unless options[:command]
+  options[:command] == "notify"
+end
+
+unless options[:apikey]
+  abort("You must specify an API Key")
+end
+
+if options[:apikey].size < 40
+  abort("Each API key must be a 40-byte hexadecimal string")
+else
+  options[:apikey] = options[:apikey].split(",") if options[:apikey].include? ","
+end
+
+available_priorities = Prowly::Notification::Priority.constants
+unless available_priorities.include? options[:priority]
+  abort("Invalid priority. Valid options are: " + available_priorities.join(", "))
+end
+
+result = Prowly.notify do |n|
+  n.apikey      = options[:apikey]
+  n.priority    = options[:priority]
+  n.application = options[:application]
+  n.event       = options[:event]
+  n.description = options[:description]
+end
+
+if result.succeeded?
+  exit 1
+else
+  puts result.message
+  exit 0
+end

data/lib/prowly.rb

@@ -0,0 +1,40 @@
+require 'prowly/interface'
+require 'prowly/notification'
+
+module Prowly
+  
+  extend self
+  
+  def add(notification = Notification.new)
+    yield notification if block_given?
+    api.call Interface::Command::ADD, notification.to_params
+  end
+
+  def verify(apikey)
+    api.call Interface::Command::VERIFY, "apikey=#{apikey}"
+  end
+  
+  def valid_key?(key)
+    result = verify(key)
+    result.succeeded?
+  end
+  
+  def remaining_calls(key)
+    result = verify(key)
+    return result.remaining if result.succeeded?
+    result.message
+  end
+  
+  def version
+    File.read(File.join(File.dirname(__FILE__), *%w[.. VERSION]))
+  end
+  
+  private
+  def api
+    Interface.instance
+  end
+  
+  #aliases
+  alias :notify :add
+    
+end

data/lib/prowly/interface.rb

@@ -0,0 +1,47 @@
+require 'net/https'
+require 'prowly/response'
+require 'prowly/notification'
+require 'singleton'
+
+module Prowly
+  
+  class Interface
+  
+    include Singleton
+    
+    def initialize
+      @url = "https://prowl.weks.net/publicapi"
+    end
+    
+    ## Make the actual call to the prowl api
+    def call(command, params)
+      @command = command
+      request = Net::HTTP::Get.new(uri.request_uri + "?" + params)
+      response = http.request(request)
+      Response.new(response.body, response)
+    end
+          
+    private
+    def http
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      http
+    end
+
+    def uri
+      URI.parse("#{@url}/#{@command}")
+    end        
+            
+    ## Available commands are documented in http://prowl.weks.net/api.php
+    module Command
+      ADD     = "add"
+      VERIFY  = "verify"
+    end
+    
+    ## EXCEPTIONS
+    class NoAPIKeyGiven < RuntimeError; end
+    
+  end
+
+end

data/lib/prowly/notification.rb

@@ -0,0 +1,88 @@
+require 'cgi'
+
+module Prowly
+
+  class BasicNotification
+
+    ## EXCEPTIONS
+    class NoAPIKeyGiven < RuntimeError; end
+    class NoDescriptionGiven < RuntimeError; end
+    class NoApplicationNameGiven < RuntimeError; end
+    class DuplicatedAssignmentOfApiKey < RuntimeError; end
+  
+    attr_accessor :application, :description
+    attr_writer :apikey
+  
+    alias :apikeys= :apikey=
+  
+    def apikey
+      if @apikey.is_a? Array
+        @apikey.join(',')
+      else
+        @apikey
+      end
+    end
+    alias :apikeys :apikey
+  
+    def initialize(params = {})
+      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?
+      end
+    end
+  
+    def to_params
+      raise NoAPIKeyGiven if apikey.nil?
+      raise NoApplicationNameGiven if @application.nil?
+      raise NoDescriptionGiven if @description.nil?
+      params.join('&')
+    end
+  
+    private
+    def params
+      attributes = []
+      instance_variables.each do |var|
+        raw_attr = "#{var.sub('@','')}"
+        value = send("#{raw_attr}")
+        next if value.nil?
+        attributes << "#{raw_attr}=" + CGI.escape(value.to_s)
+      end
+      attributes.sort
+    end
+  
+  end
+
+  class Notification < BasicNotification
+  
+    ## EXCEPTIONS
+    class PriorityNotAvailable < RuntimeError; end
+  
+    attr_accessor :providerkey, :priority, :event
+  
+    def initialize(params = {})
+      @apikey       = (params[:apikey] || params[:apikeys]) || "fffffffffffffffffffffffffffffffffffffffff"
+      @application  = params[:application]  || "Prowly"
+      @event        = params[:event]        || "Prowly is working!!"
+      @description  = params[:description]   || "This is the default description"
+      @priority     = params[:priority]     || Priority::NORMAL
+      super
+    end
+    
+    public
+    ## Priorities are documented in http://prowl.weks.net/api.php
+    module Priority
+       VERY_LOW  = -2
+       MODERATE  = -1
+       NORMAL    = 0
+       HIGH      = 1
+       EMERGENCY = 2
+     
+       def self.const_missing(const)
+         raise PriorityNotAvailable, const
+       end  
+    end  
+  end
+  
+end

data/lib/prowly/response.rb

@@ -0,0 +1,63 @@
+require 'rexml/document'
+
+module Prowly
+  
+  class Response
+  
+    attr_writer :response
+    attr_accessor :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]
+    
+      #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
+    
+      #define a method named status and it'll return "success" or "error"
+      Response.add_instance_method(:status, response_info.name)
+    
+      if response_info.name == "success"
+        boolean_status = true
+      elsif response_info.name == "error"
+        boolean_status = false
+      end
+    
+      add_instance_method(:message, response_info.text) unless boolean_status
+    
+      add_instance_method(:succeeded?, boolean_status)
+      true
+    end
+  
+    #define dynamic methods
+    def self.add_instance_method(name, content)
+      define_method(name) { content }
+    end
+  
+    ## ERRORCODES are documented in http://prowl.weks.net/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.
+      METHOD_NOT_ALLOWED    = 405 #Method not allowed, you attempted to use a non-SSL connection to Prowl.
+      NOT_ACCEPTABLE        = 406 #Not acceptable, your IP address has exceeded the API limit.
+      INTERNAL_SERVER_ERROR = 500 #Internal server error, something failed to execute properly on the Prowl side.
+    end
+
+    module SuccessCode
+      SUCCESS = 200 #Everything went fine
+    end
+    
+  end
+
+end

data/prowly.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{prowly}
+  s.version = "0.1.0"
+
+  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.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}
+  s.executables = ["prowly"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "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.5}
+  s.summary = %q{A Ruby interface to Prowl (http://prowl.weks.net/)}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_prowly.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'prowly'
+
+class Test::Unit::TestCase
+end

data/test/test_prowly.rb

@@ -0,0 +1,7 @@
+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"
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: prowly
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Rafael Maga\xC3\xB1a"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-15 00:00:00 -06:00
+default_executable: prowly
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+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
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/prowly.rb
+- lib/prowly/interface.rb
+- lib/prowly/notification.rb
+- lib/prowly/response.rb
+- prowly.gemspec
+- test/helper.rb
+- test/test_prowly.rb
+has_rdoc: true
+homepage: http://github.com/rafmagana/prowly
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: A Ruby interface to Prowl (http://prowl.weks.net/)
+test_files: 
+- test/helper.rb
+- test/test_prowly.rb