pushover 0.3.1 → 0.4.0

data/README.md

@@ -1,71 +1,88 @@
 # Pushover
 
-This gem provides a CLI and an API interface to http://pushover.net
-
-It's main usage as a CLI, see below for specifics.
-
-Some CLI features:
-
-  * Multiple users/applications can be stored.
-  * Do not need to supply either, will find the first one available.
-  * Supplying on the CLI will always override the stored variables.
+This gem provides a CLI and an API interface to http://pushover.net.
 
 ## Installation
 
 To install:
 
-		$ gem install pushover
+		% gem install pushover
 
 To use inside of an application, add this to the your gemfile:
 
-		$ gem 'pushover'
+		% gem 'pushover'
 
 and run bundle to make it available:
 
-		$ bundle
+		% bundle
 
 ## Usage
 
 ### API:
-
-    require 'pushover'
+```ruby
+require 'pushover'
+```
 
 To send with the very minimum amount of information.
 
-    Pushover.notification('message', 'title', user:'USER_TOKEN', token:'APP_TOKEN')
+```ruby
+Pushover.notification('message', 'title', user:'USER_TOKEN', token:'APP_TOKEN')
+```
 
 Optional #configuration method:
+```ruby
+Pushover.configure do |config|
+  config.user='USER_TOKEN'
+  config.token='APP_TOKEN'
+end
+
+Pushover.notification('message', 'title')
+```
+### CLI:
 
-		Pushover.configure do |config|
-		  config.user='USER_TOKEN'
-		  config.token='APP_TOKEN'
-		end
+To get help do, try ```--(h)elp```
 
-		Pushover.notification('message', 'title')
 
-### CLI:
+		% pushover --h
+
+To send a message.
 
-To send a message.  This will override any saved information available.
+		% pushover -u user_token -a app_key message is the rest of the cli.
 
-		$ pushover -u user_token -a app_key message is the rest of the cli.
+#### Optional parameters
+
+* Title: Title of your notifcation
+* Config_file: the file to use for stored credentials.
+* Priority: Priority of the message, as an integer (for now).
+	* -1: low
+	*  0: normal
+	*	1: high
+* Device: specific device to send the notification to.
+
+
+#### Saving user and application.
 
 You can also save and use stored information.  The username/application are titles.  They can be anything you want to reference them.
 
 User:
 
-		$ pushover -u user_token --save-user username
+		% pushover -u user_token --save-user email@somewhere.net
 
 Application:
 
-		$ pushover -a app_key --save-user application
+		% pushover -a app_key --save-app myApp
 
-This will allow you to do:
+Delete coming soon.
 
-		$ pushover -a new_app -u username message body.
+Now, you can use these to send messages instead of having to remeber the key:
 
-If you don't supply any credentials, and it has them saved, it will use the first set saved.  This allows for a completely lazy mode ```pushover message body here``` for sending without having to constantly specify credentials.
+		% pushover -a myApp -u email@somewhere.net Hello from somewhere!
 
-Delete coming soon.
+If you don't supply the application or user name, it will use the first one in the save file.
+
+		% pushover so now I can just send an app.
+
+Anytime you supply token's directly to the cli, it will ignore any saved information and try them.  This allows you to use it as a once-off tool while keeping credentials stored.
 
 ## Testing
 

data/bin/pushover

@@ -24,8 +24,11 @@ if Options[:save_user]
 	puts "Save successful."
 	exit
 end
-puts "Try pushover -h for help." if Options.empty? && ARGV.empty?
 
+if ARGV.empty?
+	puts "You must supply a message."
+	exit
+end
 bail = false
 message = ARGV.join(" ")
 
@@ -44,11 +47,21 @@ if !User.current_user?
 	bail = true
 end
 exit if bail
-title = nil
-response = Pushover.notification message, title, user:User.current_user, token:App.current_app
+
+Pushover.configure do |c|
+	c.user 			= User.current_user
+	c.token	 		= App.current_app
+	c.message 	= message
+	c.title 		= Options[:title]
+	c.priority 	= Options[:priority]
+	c.device 		= Options[:device]
+end
+
+response = Pushover.notification
 
 if response.code == "200"
 	puts "Message sent successfully!"
 else
-	puts "#{response.code} #{response.message}:#{response.body}"
+	j = Yajl.load response.body
+	puts "ErrorCode (#{response.code}): #{j['errors'].first}."
 end

data/lib/pushover.rb

@@ -10,27 +10,41 @@ require "pushover/optparser"
 # The primary pushover namespace.
 module Pushover
 
-	def params
-		Pushover.parameters
-	end
-
-	extend self
-
-	attr_accessor :token, :user
-
-	# push a message to across pushover, must supply all variables.
-	def notification(message, title = nil, tokens={})
-		url = URI.parse("https://api.pushover.net/1/messages.json")
-		req = Net::HTTP::Post.new(url.path)
-		req.set_form_data((params.merge(tokens.merge({:message => message, :title => title}))))
-		res = Net::HTTP.new(url.host, url.port)
-		res.use_ssl = true
-		res.verify_mode = OpenSSL::SSL::VERIFY_PEER
-		res.start {|http| http.request(req) }
-	end
-
-	# Adds a rails style configure method
-	def configure
+  extend self
+
+  # [String] The api key to be used for the notifcation.
+  attr_accessor :token
+  # [String] of the user token currently being used.
+  attr_accessor :user
+  # [String] message the message to be sent.
+  attr_accessor :message
+  # [optional,String] Title of the message.
+  attr_accessor :title
+  # [optional,Fixnum] priority The priority of the message, from -1 to 1.
+  attr_accessor :priority
+  # [optional,String] device to recieve the message.
+  attr_accessor :device
+
+  # push a message to  pushover, must supply all variables.
+  # @param [String] message The message to be sent
+  # @param [optional, String] title The title of the message
+  # @param [optional, Fixnum] priority of the message to be sent, from -1 to 1.
+  # @param [optional, String] device The specific device to be notified.
+  # @param [optional, String] app api key.
+  # @param [optional, String] user the user token.
+  # @return [String] the response from pushover.net, in json.
+  def notification(tokens={})
+    url = URI.parse("https://api.pushover.net/1/messages.json")
+    req = Net::HTTP::Post.new(url.path)
+    req.set_form_data(params.merge tokens)
+    res = Net::HTTP.new(url.host, url.port)
+    res.use_ssl = true
+    res.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    res.start {|http| http.request(req) }
+  end
+
+  # Adds a rails style configure method
+  def configure
     yield self
     parameters
   end
@@ -41,14 +55,16 @@ module Pushover
     keys.each { |k| @values.merge! k => get_var("@#{k}") }
     @values
   end
+  alias_method :params, :parameters
 
   # Returns true or false if all parameters are set.
   def parameters?
     parameters.values.all?
   end
 
+  # A [Array] of keys available in Pushover.
   def keys
-    keys ||= [:token, :user]
+    keys ||= [:token, :user, :message, :title, :priority, :device]
   end
 
   private

data/lib/pushover/optparser.rb

@@ -12,7 +12,9 @@ module Pushover
       on("-V", "--version", "Print version") { |version| @options[:version] = true}
       on("-u", "--user USER", "Which user, can be a saved name or token.") { |o| @options[:user] = o}
       on("-a", "--app APPKEY", "Which app to notify, can be a saved name or apikey.") { |o| @options[:appkey] = o}
-      on("-T", "--title [TITLE]", "Set the title of the notification (optional).") { |o| @options[:title] = o}
+      on("-t", "--title [TITLE]", "Set the title of the notification (optional).") { |o| @options[:title] = o}
+      on("-p", "--priority [PRIORITY]", DecimalInteger , "Set the priority of the notification from -1 to 1 (optional).") { |o| @options[:priority] = o}
+      on("-d", "--device [DEVICE]", "Specify the device to send the notifcation to. (optional).") { |o| @options[:device] = o}
       on("-c", "--config_file [FILE]", "Set the target config file.") {|o| @options[:config_file] = o}
       on("--save-app NAME", "Saves the application to the config file under NAME.") { |o| @options[:save_app] = [@options[:appkey], o]}
       on("--save-user NAME", "Saves the user to the config file under NAME.") { |o| @options[:save_user] = [@options[:user], o]}

data/lib/pushover/version.rb

@@ -1,4 +1,4 @@
 module Pushover
 	# The current version of Pushover.
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/pushover.gemspec

@@ -2,18 +2,30 @@
 require File.expand_path('../lib/pushover/version', __FILE__)
 
 Gem::Specification.new do |gem|
+  gem.name          = "pushover"
   gem.authors       = ["Ernie Brodeur"]
   gem.email         = ["ebrodeur@ujami.net"]
+  gem.date          = Time.now.strftime('%Y-%m-%d')
+  gem.version       = Pushover::VERSION
+  gem.platform      = Gem::Platform::RUBY
+
+  # descriptions
   gem.description   = "App (and CLI) to interface with pushover.net"
   gem.summary       = "This gem will provide both an API and CLI interface to pushover.net."
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/erniebrodeur/pushover"
 
+  #files
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "pushover"
   gem.require_paths = ["lib"]
-  gem.version       = Pushover::VERSION
+
+  # documentation
+  gem.extra_rdoc_files = Dir.glob("*.md")
+  gem.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Pushover", "--main", "README.md", "--encoding=UTF-8"]
+  gem.has_rdoc = 'yard'
+
+  # dependencies.
   gem.add_development_dependency('pry')
   gem.add_runtime_dependency('yajl-ruby')
 end

data/whatsnew.md

@@ -1,7 +1,17 @@
+Unreleased:
+	* Added priority and device specification.
+	* Moved all the variables, including message, into the configure block.
+  * Documentation push, 100% passage and updated for yardoc.
+  * Updated the gemspec with some more information.
+  * Better output for error messages.
+0.3.1
+	* Added benwoody's changes back to the system, this allows for some nifty generators.
+	* Fixed the nasty bug where it wasn't working once installed.
 0.3.0
  * No longer need to supply credentials at all if you have some saved.
  * Fixed up a ton of documentation and spelling mistakes.
  * Various bug fixes.
  * About thirty percent of the tests are complete.
- * Added convience methods for App.current_app and User.current_user to supply the correctly inherited credentials.
+ * Added convenience methods for App.current_app and User.current_user to supply the correctly inherited credentials.
  * Will only create the save directory if you attempt to save.
+ * You can specify config on the command line via --config_file

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pushover
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-27 00:00:00.000000000 Z
+date: 2012-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -49,7 +49,10 @@ email:
 executables:
 - pushover
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- whatsnew.md
+- dev_notes.md
 files:
 - .gitignore
 - Gemfile
@@ -73,10 +76,17 @@ files:
 - spec/spec_helper.rb
 - spec/user_spec.rb
 - whatsnew.md
-homepage: ''
+homepage: https://github.com/erniebrodeur/pushover
 licenses: []
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- Pushover
+- --main
+- README.md
+- --encoding=UTF-8
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -105,4 +115,4 @@ test_files:
 - spec/pushover_spec.rb
 - spec/spec_helper.rb
 - spec/user_spec.rb
-has_rdoc: 
+has_rdoc: yard