ruby-notify-my-android 0.3.2 → 0.4.0

data/README.rdoc

@@ -4,22 +4,40 @@ Send notifications to Android devices via the Notify My Android API. Details abo
 
 == Installation
 	
-	gem install ruby-notify-my-android
+  gem install ruby-notify-my-android
+
+== Usage from command line
+
+You can send notifications from the command line with the notify-my-android script:
+
+  $ notify-my-android -k 9d0538ab7b52360e906e0e766f34501b69edde92fe3409e9
+  Notification sent !
+
+Here are the full set of parameters that it accepts:
+
+  Usage: notify-my-android [options]
+      -k, --apikey APIKEY              Your API Key
+      -p, --priority PRIORITY          Priority (-2,-1,0,1,2)
+      -a, --application APPNAME        Name of app
+      -e, --event EVENTNAME            Name of event
+      -d, --description DESCRIPTION     Notify text
+
+Any parameters unset will use default values except --apikey
 
 == Usage as a Gem
 	
 Sending a notification via ruby-notify-my-android gem
 
+  require 'rubygems'
   require 'ruby-notify-my-android'
 
-	NMA.notify do |n| 
-	  n.apikey = "9d1538ab7b52360e906e0e766f34501b69edde92fe3409e9" # can also be list such as ["key1", "key2"]
-	  n.priority = NMA::Priority::MODERATE
-	  n.application = "NMA"
-	  n.event = "Notification"
-	  n.description = "Your server is under attack!!!"
-	  n.url = "http://www.nma.bz"
-	end
+  NMA.notify do |n| 
+    n.apikey = "9d1538ab7b52360e906e0e766f34501b69edde92fe3409e9" # can also be list such as ["key1", "key2"]
+    n.priority = NMA::Priority::MODERATE
+    n.application = "NMA"
+    n.event = "Notification"
+    n.description = "Your server is under attack!!!"
+  end
 
 == Using the API
 

data/Rakefile

@@ -19,7 +19,7 @@ Jeweler::Tasks.new do |gem|
   gem.description = %Q{Send notifications to Android devices via the Notify My Android API. Details about the API are available at https://nma.usk.bz/api.php .}
   gem.email = "ken.pepple@rabbityard.com"
   gem.authors = ["Ken Pepple"]
-  # gem.executables = [ 'notify-my-android' ] 
+  gem.executables = [ 'notify-my-android' ] 
   # gem.add_runtime_dependency "xml-simple", ">= 1.0.15"
   # gem.add_development_dependency 'webmock'
 end

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.4.0

data/bin/notify-my-android

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+begin
+  require "rubygems"
+  require "ruby-notify-my-android"
+  require "optparse"
+rescue LoadError
+  STDERR.puts "The ruby gems ruby-notify-my-android and optparse are required."
+  STDERR.puts "Please install them via gem install ruby-notify-my-android."
+  exit 1
+end
+
+
+# parse options 
+o = {}
+opts = OptionParser.new
+opts.on("-k", "--apikey APIKEY", "Your API Key", String)                {|val| o[:apikey] = val }
+opts.on("-p", "--priority PRIORITY", "Priority (-2,-1,0,1,2)", Integer) {|val| o[:priority] = val }
+opts.on("-a", "--application APPNAME", "Name of app", String)           {|val| o[:application] = val }
+opts.on("-e", "--event EVENTNAME", "Name of event", String)             {|val| o[:event] = val }
+opts.on("-d", "--description DESCRIPTION", "Notify text", String)        {|val| o[:priority] = val }
+z = opts.parse(ARGV)
+
+# set defaults
+options = { :apikey => o[:apikey] || nil,
+            :description => o[:description] || nil, 
+            :event => o[:event] || nil, 
+            :application => o[:application] || nil, 
+            :priority => o[:priority] || nil }
+
+# send notification
+unless options[:apikey].nil?
+  result = NMA.notify do |n|
+    n.apikey      = options[:apikey]
+    n.priority    = options[:priority] unless options[:priority].nil? 
+    n.application = options[:application] unless options[:application].nil?
+    n.event       = options[:event] unless options[:event].nil?
+    n.description = options[:description] unless options[:description].nil?
+  end
+else
+  puts opts.to_s
+  exit 2
+end
+
+if result.succeeded?
+  puts "Notification sent !"
+  exit 0
+else
+  puts "Error in notification: #{result.response["content"]}"
+  exit 3
+end

data/lib/ruby-notify-my-android.rb

@@ -5,9 +5,9 @@ require 'ruby-notify-my-android/notification'
 # This is the main Notify My Andoid module
 
 module NMA
-  
+
   extend self
-  
+
   def notify(notification = Notification.new)
     yield notification if block_given?
     Request.instance.call Request::Command::NOTIFY, notification.to_params
@@ -31,5 +31,7 @@ module NMA
   def version
     File.read(File.join(File.dirname(__FILE__), *%w[.. VERSION]))
   end
+  
+  VERSION = self.version
 
 end

data/lib/ruby-notify-my-android/response.rb

@@ -1,5 +1,10 @@
-require 'rubygems'
-require 'xmlsimple'
+begin
+  require 'xmlsimple'
+rescue LoadError
+  STDERR.puts "No valid xml-simple library detected, please install one of 'xml-simple'."
+  exit -2
+end
+
 
 module NMA
 
@@ -14,10 +19,10 @@ module NMA
 
     # A hash of the returned XML response
     attr_accessor :body
-    
+
     # A hash of the cooked XML
     attr_accessor :response
-    
+
     def initialize(response)
       self.raw = response.body
       self.code = response.code

data/ruby-notify-my-android.gemspec

@@ -5,15 +5,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruby-notify-my-android}
-  s.version = "0.3.2"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ken Pepple"]
-  s.date = %q{2011-04-18}
-  s.default_executable = %q{notify-my-andoid}
+  s.date = %q{2011-04-21}
+  s.default_executable = %q{notify-my-android}
   s.description = %q{Send notifications to Android devices via the Notify My Android API. Details about the API are available at https://nma.usk.bz/api.php .}
   s.email = %q{ken.pepple@rabbityard.com}
-  s.executables = ["notify-my-andoid"]
+  s.executables = ["notify-my-android"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
     "README.rdoc",
     "Rakefile",
     "VERSION",
-    "bin/notify-my-andoid",
+    "bin/notify-my-android",
     "lib/ruby-notify-my-android.rb",
     "lib/ruby-notify-my-android/notification.rb",
     "lib/ruby-notify-my-android/request.rb",

data/test/test_ruby-notify-my-android.rb

@@ -47,6 +47,7 @@ class TestRubyNotifyMyAndroid < Test::Unit::TestCase
     assert_equal("799", result.response["remaining"])
     assert_equal("200", result.response["code"])
     assert_equal("60", result.response["resettimer"])
+    assert(result.succeeded?)
   end
   
   def test_should_verify_bad_but_valid_size_apikey
@@ -115,6 +116,7 @@ class TestRubyNotifyMyAndroid < Test::Unit::TestCase
   def test_version
     v = File.read(File.join(File.dirname(__FILE__), '..', 'VERSION'))
     assert_equal(v, NMA.version)
+    assert_equal(NMA.version, NMA::VERSION)
   end
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-notify-my-android
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 15
   prerelease: 
   segments: 
   - 0
-  - 3
-  - 2
-  version: 0.3.2
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Ken Pepple
@@ -15,8 +15,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-18 00:00:00 -07:00
-default_executable: notify-my-andoid
+date: 2011-04-21 00:00:00 -07:00
+default_executable: notify-my-android
 dependencies: 
 - !ruby/object:Gem::Dependency 
   prerelease: false
@@ -111,7 +111,7 @@ dependencies:
 description: Send notifications to Android devices via the Notify My Android API. Details about the API are available at https://nma.usk.bz/api.php .
 email: ken.pepple@rabbityard.com
 executables: 
-- notify-my-andoid
+- notify-my-android
 extensions: []
 
 extra_rdoc_files: 
@@ -124,7 +124,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
-- bin/notify-my-andoid
+- bin/notify-my-android
 - lib/ruby-notify-my-android.rb
 - lib/ruby-notify-my-android/notification.rb
 - lib/ruby-notify-my-android/request.rb

data/bin/notify-my-andoid

@@ -1,29 +0,0 @@
-#!/usr/bin/env ruby
-
-$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
-
-require 'ruby-notify-my-android'
-require 'yaml'
-
-# set defaults
-options = { :apikey => nil,
-            :description => "test description", 
-            :event => "test event", 
-            :application => "NMA", 
-            :priority => Priority::NORMAL }
-
-# use first argument on command line as API key
-options[:apikey] = ARGV[0]
-
-# send notification
-result = NMA.notify do |n|
-  n.apikey      = options[:apikey]
-  n.priority    = options[:priority]
-  n.application = options[:application]
-  n.event       = options[:event]
-  n.description = options[:description]
-  n.url         = options[:url]
-end
-
-# putput raw XML response
-puts result.raw