pushover 0.5.1 → 0.99.0

data/README.md

@@ -1,32 +1,22 @@
 # Pushover
+**Master** [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/erniebrodeur/pushover) [![Build Status](https://travis-ci.org/erniebrodeur/pushover.png?branch=master)](https://travis-ci.org/erniebrodeur/pushover) [![Dependency Status](https://gemnasium.com/erniebrodeur/pushover.png)](https://gemnasium.com/erniebrodeur/pushover)
+**Development** [![Build Status](https://travis-ci.org/erniebrodeur/pushover.png?branch=development)](https://travis-ci.org/erniebrodeur/pushover)
 
 This gem provides a CLI and an API interface to http://pushover.net.
 
-#### Build Status
-<table border="0">
-  <tr>
-    <td>master</td>
-    <td><a href=http://travis-ci.org/erniebrodeur/pushover?branch=master><img src="https://secure.travis-ci.org/erniebrodeur/pushover.png?branch=master"/></h> </td>
-  </tr>
-  <tr>
-    <td>development</td>
-    <td><a href=http://travis-ci.org/erniebrodeur/pushover?branch=development><img src="https://secure.travis-ci.org/erniebrodeur/pushover.png?branch=development"/></h> </td>
-  </tr>
-</table>
-
 ## 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
 
@@ -50,59 +40,107 @@ end
 
 Pushover.notification('message', 'title')
 ```
+
 ### CLI:
 
 To get help do, try ```--(h)elp```
 
-
-		% pushover --h
+		$ pushover -h
 
 To send a message.
 
-		% 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.
+Most optional parameters have a shorter form you can use.  If that's the case, they will be displayed like ```--(h)elp```.
 
+#### Config_file
 
-#### Saving user and application.
+The file to use for stored settings (including credentials).
 
-You can also save and use stored information.  The username/application are titles.  They can be anything you want to reference them.
+		$ pushover --(c)onfig_file /tmp/config_file
 
-User:
 
-		% pushover -u user_token --save-user email@somewhere.net
+#### Title
 
-Application:
+The title of the message, if not supplied it will end up being the app name.
 
-		% pushover -a app_key --save-app myApp
+		$ pushover --(t)itle "A title"
 
-Delete coming soon.
+		$ pushover --(t)itle "A title"
 
-Now, you can use these to send messages instead of having to remeber the key:
+#### Priority
 
-		% pushover -a myApp -u email@somewhere.net Hello from somewhere!
+Priority of the message, either (low,normal,high) or (-1,0,1).  For the string you only need the first letter.
 
-If you don't supply the application or user name, it will use the first one in the save file.
+		$ pushover --(p)riority high
 
-		% pushover so now I can just send an app.
+		$ pushover --(p)riority h
 
-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.
+		$ pushover --(p)riority -1
+
+#### Device
+
+Specific device to send the message too, must be registered at pushover.net
+
+		$ pushover --(d)evice "Device name"
+
+#### URL
+
+Supplementary URL that can be passed with the message.
+
+		$ pushover --url "http://www.github.com/erniebrodeur/pushover"
+
+##### URL Title
+
+The display string of the supplementary URL.
+
+		$ pushover --url "http://www.git.com/erniebrodeur/pushover" --url_title "This repo."
+
+#### Time
+
+Time is tricky, I just pass the string off to the stdlib ```Time.parse```.  Therefore, if it fails I can't do much about it.  Though, it shouldn't fail, it seems to take just a ton of stuff.  You can always handle this yourself and just pass in an epoch (string or fixnum).
 
-## Testing
+    $ pushover --time 1331249662
 
-CLI usage:
+    $ pushover --time "6:30"
 
-Testing, like this utility, it is a work in progress.  I'm in the process of lifting some of the code into another library (config, options), so I will likely not be making more tests for those pieces.
+##### String examples
 
-The app testing itself requires you to use your own credentials, that way you get the spam from pushover and not me.  I haven't figured out how to do this just yet.
+As far as I can tell, you can toss a ton of different things and get an output.
+
+* rfc822: Tue, 14 Nov 2000 14:55:07 -0500
+* xml: 1979-08-13T06:30:00.313UTC
+* Aug 13, 1979 6:30
+* 1979/08/13, 6:30:50 UTC
+* 6:30
+* 14:30
+* Aug 21
+
+#### Saving
+
+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 email@somewhere.net
+
+##### Application
+
+		$ pushover -a app_key --save-app myApp
+
+Delete done in the api, not lifted to the cli.
+
+Now, you can use these to send messages instead of having to remeber the key:
+
+		$ pushover -a myApp -u email@somewhere.net Hello from somewhere!
+
+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.
 
 ## Contributing
 

data/bin/pushover

@@ -7,9 +7,12 @@ include Pushover
 Options.on("-u", "--user USER", "Which user, can be a saved name or token.") { |o| Options[:user] = o}
 Options.on("-a", "--app APPKEY", "Which app to notify, can be a saved name or apikey.") { |o| Options[:appkey] = o}
 Options.on("-t", "--title [TITLE]", "Set the title of the notification (optional).") { |o| Options[:title] = o}
-Options.on("-p", "--priority [PRIORITY]", OptionParser::DecimalInteger , "Set the priority of the notification from -1 to 1 (optional).") { |o| Options[:priority] = o}
+Options.on("-p", "--priority [PRIORITY]", "Set the priority of the notification from (low,normal,high) (optional).") { |o| Options[:priority] = o}
 Options.on("-d", "--device [DEVICE]", "Specify the device to send the notifcation to. (optional).") { |o| Options[:device] = o}
 Options.on("-c", "--config_file [FILE]", "Set the target config file.") {|o| Options[:config_file] = o}
+Options.on("--url [URL]", "Supplementary URL") { |o| Options[:url] = o }
+Options.on("--url_title [TITLE]", "Supplementary URL title.") { |o| Options[:url_title] = o }
+Options.on("--time [TIME]", "Set the messages time.") {|o| Options[:timestamp] = o}
 Options.on("--save-app NAME", "Saves the application to the config file under NAME.") { |o| Options[:save_app] = [Options[:appkey], o]}
 Options.on("--save-user NAME", "Saves the user to the config file under NAME.") { |o| Options[:save_user] = [Options[:user], o]}
 
@@ -53,6 +56,7 @@ if !App.current_app?
 end
 
 if !User.current_user?
+	puts User.current_user?
 	puts "Couldn't find a user via the cli or save file."
 	bail = true
 end
@@ -66,8 +70,10 @@ Pushover.configure do |c|
 end
 
 # Or in real time, which will also overwrite the .configure block.
-response = Pushover.notification message:message, title:Options[:title],
-	priority:Options[:priority], device:Options[:device]
+options = Options[].select { |k,v| v}
+
+options.merge! message:message
+response = Pushover.notification options
 
 if response.code == "200"
 	puts "Message sent successfully!"
@@ -75,4 +81,3 @@ else
 	j = Yajl.load response.body
 	puts "ErrorCode (#{response.code}): #{j['errors'].first}."
 end
-

data/lib/pushover.rb

@@ -1,5 +1,6 @@
 require "net/https"
 require "yajl"
+require 'time'
 require 'bini'
 require 'bini/config'
 require 'bini/optparser'
@@ -10,8 +11,8 @@ require "pushover/user"
 # The primary pushover namespace.
 module Pushover
   # lets save our config to it's own dir, just because.
-  Bini.config.file = "#{Dir.home}/.config/pushover/credentials.yaml"
-  Bini.config.load
+  Bini::Config.file = "#{Dir.home}/.config/pushover/credentials.yaml"
+  Bini::Config.load
 
   extend self
 
@@ -23,10 +24,44 @@ module Pushover
   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
+  attr_accessor :url
+  attr_accessor :url_title
+  # [optional,String, Fixnum] time a time stamp im one of three forms (epoch, strfmt, rails)
+  attr_reader   :timestamp
+  attr_reader   :priority
+  def priority=(level)
+    if level.class == String
+      if level =~ /^[lL]/
+        @priority = -1
+      elsif level =~ /^[hH]/
+        @priority = 1
+      else
+        @priority = 0
+      end
+    elsif level.class == Fixnum
+      @priority = level
+    end
+  end
+
+  # Stdlib time, seems to take a shitload of options.
+  # rfc822: Tue, 14 Nov 2000 14:55:07 -0500
+  # xml: 1979-08-13T06:30:00.313UTC
+  # Time.parse 'Aug 13, 1979 6:30'
+  # Time.parse '1979/08/13, 6:30:50 UTC'
+  def timestamp=(time_string)
+    if time_string.class == String
+      begin
+        @timestamp = Time.parse(time_string).to_i
+      rescue ArgumentError
+        @timestamp = time_string.to_i
+      end
+    elsif
+      time_string.class == Fixnum
+      @timestamp = time_string
+    end
+  end
 
   # push a message to  pushover, must supply all variables.
   # @param [String] message The message to be sent
@@ -37,9 +72,10 @@ module Pushover
   # @param [optional, String] user the user token.
   # @return [String] the response from pushover.net, in json.
   def notification(tokens={})
+    tokens.each {|k,v| send("#{k}=", tokens[k])}
     url = URI.parse("https://api.pushover.net/1/messages.json")
     req = Net::HTTP::Post.new(url.path)
-    req.set_form_data(params.merge tokens)
+    req.set_form_data(params)
     res = Net::HTTP.new(url.host, url.port)
     res.use_ssl = true
     res.verify_mode = OpenSSL::SSL::VERIFY_PEER
@@ -74,7 +110,6 @@ module Pushover
 
   # A [Array] of keys available in Pushover.
   def keys
-    keys ||= [:token, :user, :message, :title, :priority, :device]
+    keys ||= [:token, :user, :message, :title, :priority, :device, :timestamp, :url, :url_title]
   end
 end
-

data/lib/pushover/app.rb

@@ -13,8 +13,8 @@ module Pushover
 			def initialize(name, api_key)
 				@name = name
 				@api_key = api_key
-				Bini.config[:applications] = {} if !Bini.config[:applications]
-				Bini.config[:applications][name] = api_key
+				Bini::Config[:applications] = {} if !Bini::Config[:applications]
+				Bini::Config[:applications][name] = api_key
 			end
 		end
 
@@ -24,7 +24,7 @@ module Pushover
 		# @param [String] word the search token, can be an apikey or appname.
 		# @return [String] return the apikey (if it can find one) or the word itself.
 		def find(word)
-			return Bini.config[:applications][word] if Bini.config[:applications] && Bini.config[:applications][word]
+			return Bini::Config[:applications][word] if Bini::Config[:applications] && Bini::Config[:applications][word]
 			word
 		end
 
@@ -34,11 +34,11 @@ module Pushover
 		# @return [Boolean] return the results of the save attempt.
 		def add(name, api_key)
 			App.new name, api_key
-			Bini.config.save!
+			Bini::Config.save!
 		end
 
 		def remove(name)
-			Bini.config[:applications].delete name if Bini.config[:applications]
+			Bini::Config[:applications].delete name if Bini::Config[:applications]
 		end
 		# Return the current app selected, or the first one saved.
 		def current_app
@@ -49,7 +49,7 @@ module Pushover
 
 			# no?  do we have anything we can return?
 			if !@current_app
-				@current_app = find Bini.config[:applications].first[0] if Bini.config[:applications]
+				@current_app = find Bini::Config[:applications].first[0] if Bini::Config[:applications]
 			end
 			@current_app
 		end
@@ -60,7 +60,7 @@ module Pushover
 
 		# Will return true if we can find an application either via the cli or save file.
 		def current_app?
-			return true if @current_app
+			return true if current_app
 			return nil
 		end
 	end

data/lib/pushover/user.rb

@@ -13,8 +13,8 @@ module Pushover
 			def initialize(name, token)
 				@name = name
 				@token = token
-				Bini.config[:users] = {} if !Bini.config[:users]
-				Bini.config[:users][name] = token
+				Bini::Config[:users] = {} if !Bini::Config[:users]
+				Bini::Config[:users][name] = token
 			end
 
 		end
@@ -25,7 +25,7 @@ module Pushover
 		# @param [String] word the search token, can be an apikey or appname.
 		# @return [String] return the apikey (if it can find one) or the word itself.
 		def find(word)
-			return Bini.config[:users][word] if Bini.config[:users] && Bini.config[:users][word]
+			return Bini::Config[:users][word] if Bini::Config[:users] && Bini::Config[:users][word]
 			word
 		end
 
@@ -35,11 +35,11 @@ module Pushover
 		# @return [Boolean] return the results of the save attempt.
 		def add(name, token)
 			User.new name, token
-			Bini.config.save!
+			Bini::Config.save!
 		end
 
 		def remove(name)
-			Bini.config[:users].delete name if Bini.config[:users]
+			Bini::Config[:users].delete name if Bini::Config[:users]
 		end
 
 		# Return the current user selected, or the first one saved.
@@ -51,7 +51,7 @@ module Pushover
 
 			# no?  do we have anything we can return?
 			if !@current_user
-				@current_user = find Bini.config[:users].first[0] if Bini.config[:users]
+				@current_user = find Bini::Config[:users].first[0] if Bini::Config[:users]
 			end
 			@current_user
 		end
@@ -63,7 +63,7 @@ module Pushover
 
 		# Will return true if it can find a user either via the cli or save file.
 		def current_user?
-			return true if @current_user
+			return true if current_user
 			return nil
 		end
 	end

data/lib/pushover/version.rb

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

data/pushover.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |gem|
   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.description   = "Api (and CLI) to interface with pushover.net"
+  gem.summary       = "This gem provides both an API and CLI interface to pushover.net."
   gem.homepage      = "https://github.com/erniebrodeur/pushover"
 
   #files

data/spec/lib/pushover/app_spec.rb

@@ -2,20 +2,21 @@ require 'spec_helper'
 
 describe "application" do
 	before(:each) do
-		Bini.config.file = "tmp/test.save"
-		Bini.config.clear
+		Bini::Config.file = "tmp/test.save"
+		Bini::Config.clear
+		Bini::Options.clear
 		App.current_app = nil
 	end
 
 	it "can add a application to the Config[:application] hash." do
 		App.add "foo", "bar"
-		Bini.config[:applications]["foo"].should eq("bar")
+		Bini::Config[:applications]["foo"].should eq("bar")
 	end
 
 	it "can remove a application from the hash." do
 		App.add "foo", "bar"
 		App.remove "foo"
-		Bini.config[:applications]["foo"].should be_nil
+		Bini::Config[:applications]["foo"].should be_nil
 	end
 
 	describe "#find" do
@@ -35,7 +36,7 @@ describe "application" do
 		end
 		it "will grab the first app in the config as a last resort" do
 			App.add "foo", "bar2"
-			Bini.config.save
+			Bini::Config.save
 			Bini::Options[:apikey] = nil
 			App.current_app.should eq "bar2"
 		end

data/spec/lib/pushover/pushover_spec.rb

@@ -17,7 +17,13 @@ describe "Pushover" do
 
   describe "#parameters?" do
     it 'will return true only if every key is set to something.' do
-      keys.each {|k| Pushover.send("#{k}=", 'ladeda')}
+      keys.each do |k|
+        if k == :timestamp
+          Pushover.send("timestamp=", '1970-01-01 00:00:01 UTC')
+        else
+          Pushover.send("#{k}=", 'ladeda')
+        end
+      end
       parameters?.should eq true
     end
     it 'will return false otherwise.' do
@@ -41,8 +47,44 @@ describe "Pushover" do
   describe "#notification" do
     it "can send a notification" do
       setup_webmocks
-      resp = Pushover.notification message:'a message', token:'good_token', user:'good_user'
-      resp.code.should eq "200"
+      Pushover.notification message:'a message', token:'good_token', user:'good_user'
+      WebMock.should have_requested(:post, /.*api.pushover.net.*/).with do |req|
+        puts req.body hash_including(priority:'ajkasdfj')
+      end
+    end
+  end
+
+  describe "extra behavior" do
+    describe "Priority" do
+      it "can be set by text" do
+        setup_webmocks
+        Pushover.notification message:'a message', token:'good_token', user:'good_user', priority:'low'
+        WebMock.should have_requested(:post, /.*api.pushover.net.*/).with { |req| req.body.include? 'priority=-1'}
+        setup_webmocks
+        Pushover.notification message:'a message', token:'good_token', user:'good_user', priority:'high'
+        WebMock.should have_requested(:post, /.*api.pushover.net.*/).with { |req| req.body.include? 'priority=1'}
+      end
+      it "falls back to normal" do
+        setup_webmocks
+        Pushover.notification message:'a message', token:'good_token', user:'good_user', priority:'kwkru'
+        WebMock.should have_requested(:post, /api.pushover.net/).with { |req| req.body.include? 'priority=0' }
+      end
+    end
+
+    describe "Time" do
+      it "can be set by epoch" do
+        setup_webmocks
+        Pushover.notification message:'a message', token:'good_token', user:'good_user', timestamp:1000
+        Pushover.notification message:'a message', token:'good_token', user:'good_user', timestamp:'1000'
+        WebMock.should have_requested(:post, /api.pushover.net/).with { |req| req.body.include? 'timestamp=1000' }.twice
+      end
+
+      it "can be set by a text string" do
+        setup_webmocks
+        Pushover.notification message:'a message', token:'good_token', user:'good_user', timestamp:'1970-01-01 00:00:01 UTC'
+        WebMock.should have_requested(:post, /api.pushover.net/).with { |req| req.body.include? 'timestamp=1' }
+      end
     end
   end
 end
+

data/spec/lib/pushover/user_spec.rb

@@ -2,20 +2,21 @@ require 'spec_helper'
 
 describe "user" do
 	before(:each) do
-		Bini.config.file = "tmp/test.save"
-		Bini.config.clear
+		Bini::Config.file = "tmp/test.save"
+		Bini::Config.clear
+		Bini::Options.clear
 		User.current_user = nil
 	end
 
 	it "can add a user to the Config[:users] hash." do
 		User.add "foo", "bar"
-		Bini.config[:users]["foo"].should eq("bar")
+		Bini::Config[:users]["foo"].should eq("bar")
 	end
 
 	it "can remove a user from the hash." do
 		User.add "foo", "bar"
 		User.remove "foo"
-		Bini.config[:users]["foo"].should be_nil
+		Bini::Config[:users]["foo"].should be_nil
 	end
 
 	describe "#find" do
@@ -35,7 +36,7 @@ describe "user" do
 		end
 		it "will grab the first user in the config as a last resort" do
 			User.add "foo", "bar2"
-			Bini.config.save
+			Bini::Config.save
 			Bini::Options[:token] = nil
 			User.current_user.should eq "bar2"
 		end
@@ -44,7 +45,7 @@ describe "user" do
 	describe "#current_user?" do
 		it "Will return true if we have a current_user" do
 			Bini::Options[:token] = 'somethingsilly'
-			User.current_user.should eq 'somethingsilly'
+			User.current_user?.should be_true
 		end
 		it "Will return nil otherwise" do
 			User.current_user?.should be_nil

data/spec/spec_helper.rb

@@ -10,8 +10,8 @@ if ENV["COVERAGE"] == 'true'
     add_filter "/spec/"
   end
 end
-require 'webmock/rspec'
 
+require 'webmock/rspec'
 require 'pushover'
 
 include Pushover
@@ -36,6 +36,3 @@ def setup_webmocks
   stub_http_request(:post, "https://api.pushover.net/1/messages.json").to_return(:status => 200,
   :headers => {}, :body => bad_user).with(:body => hash_including({token:'good_token', user:'bad_user'}))
 end
-
-
-

data/whatsnew.md

@@ -1,22 +1,33 @@
-0.5.1:
+## 0.99.0 (unreleased):
+  * Added url and a url_title.
+  * Added time, we can take an epoch or string.  The string is run through stdlib Time#parse, so effectively takes rfc822, html, xml, and a bunch of random bits.
+  * Added gemnasium to the readme.
+  * Added code climate to the readme.
+  * Updated for Bini 0.6.0
+  * Priority takes a text or integer argument now.
+
+## 0.5.1:
   * SimpleCov and 100% test coverage
-  * Webmock based testing for Pushover#notification.
+  * Webmock based testing for Pushover##notification.
   * Added intergration to http://travis-ci.org
 
-0.5.0:
+## 0.5.0:
   * Switched the order of App and it's derivatives so that it's name, api_key to make it more human readable.
    * Ditto for User.
   * Merged in me bones.
   * Using bini's logic whenever possible now instead of reinventing the wheel.
-0.4.0:
-	* Added priority and device specification.
-	* Moved all the variables, including message, into the configure block.
+
+## 0.4.0:
+  * Added priority and device specification.
+  * Moved all the variables, including message, into the configure block.
   * 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
+
+## 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.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pushover
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.99.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-01 00:00:00.000000000 Z
+date: 2012-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
@@ -43,7 +43,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: App (and CLI) to interface with pushover.net
+description: Api (and CLI) to interface with pushover.net
 email:
 - ebrodeur@ujami.net
 executables:
@@ -102,7 +102,7 @@ rubyforge_project:
 rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
-summary: This gem will provide both an API and CLI interface to pushover.net.
+summary: This gem provides both an API and CLI interface to pushover.net.
 test_files:
 - spec/bin/pushover_spec.rb
 - spec/lib/pushover/app_spec.rb