pushover 0.2.0 → 0.3.1

data/.gitignore

@@ -15,3 +15,6 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+spec/test_config
+.rspec
+*.tmp

data/README.md

@@ -2,13 +2,19 @@
 
 This gem provides a CLI and an API interface to http://pushover.net
 
-Currently it's a work in process and I haven't built out the CLI yet, that will happen shortly.
+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.
 
 ## Installation
 
 To install:
 
-    $ gem install pushover
+		$ gem install pushover
 
 To use inside of an application, add this to the your gemfile:
 
@@ -16,24 +22,58 @@ To use inside of an application, add this to the your gemfile:
 
 and run bundle to make it available:
 
-		$ Bundle
+		$ bundle
 
 ## Usage
 
-Progmatic usage:
+### API:
+
+    require 'pushover'
+
+To send with the very minimum amount of information.
+
+    Pushover.notification('message', 'title', user:'USER_TOKEN', token:'APP_TOKEN')
+
+Optional #configuration method:
+
+		Pushover.configure do |config|
+		  config.user='USER_TOKEN'
+		  config.token='APP_TOKEN'
+		end
+
+		Pushover.notification('message', 'title')
+
+### CLI:
+
+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.
+
+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
+
+Application:
+
+		$ pushover -a app_key --save-user application
+
+This will allow you to do:
+
+		$ pushover -a new_app -u username message body.
 
-```ruby
-require 'pushover'
+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.notification('your_token', 'app_token', 'message', 'title')
-```
+Delete coming soon.
 
-Title is currently optional, it doesn't do more then this yet.
+## Testing
 
 CLI usage:
 
-		$ pushover -a apitoken -t token -m 'message goes in here' -t 'title is optional.'
+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.
 
+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.
 
 ## Contributing
 

data/bin/pushover

@@ -5,39 +5,50 @@ require 'pushover'
 include Pushover
 Options.parse!
 
+# Order is important.
+if Options[:config_file]
+	puts "Selecting config file: #{Options[:config_file]}"
+	Pushover::Config.save_file = Options[:config_file]
+end
+
 if Options[:save_app]
 	puts "Saving application #{Options[:save_app][0]} to #{Options[:save_app][1]}."
-	Pushover::App.add Options[:save_app][0], Options[:save_app][1]
+	App.add Options[:save_app][0], Options[:save_app][1]
+	puts "Save successful."
 	exit
 end
 
 if Options[:save_user]
 	puts "Saving user #{Options[:save_user][0]} to #{Options[:save_user][1]}."
-	Pushover::User.add Options[:save_user][0], Options[:save_user][1]
+	User.add Options[:save_user][0], Options[:save_user][1]
+	puts "Save successful."
 	exit
 end
-
 puts "Try pushover -h for help." if Options.empty? && ARGV.empty?
 
-if ARGV
-	if !Options[:appkey]
-			puts "Must supply the api_key or keyname via --(a)pp"
-			exit
-	end
-
-	if !Options[:user]
-		puts "Must supply the username or token via --(u)ser."
-		exit
-	end
-
-	api_key = Pushover::App.find Options[:appkey]
-	user = Pushover::User.find Options[:user]
-
-	response = Pushover.notification user, api_key, ARGV.join(" ")
-	if response.code == 200
-		puts "Message sent successfully!"
-	else
-		puts "#{response.code}: #{response.body}"
-	end
+bail = false
+message = ARGV.join(" ")
+
+if !message
+	puts "Must supply a message to be sent."
+	bail = true
 end
 
+if !App.current_app?
+	puts "Couldn't find an app via the cli or save file."
+	bail = true
+end
+
+if !User.current_user?
+	puts "Couldn't find a user via the cli or save file."
+	bail = true
+end
+exit if bail
+title = nil
+response = Pushover.notification message, title, user:User.current_user, token:App.current_app
+
+if response.code == "200"
+	puts "Message sent successfully!"
+else
+	puts "#{response.code} #{response.message}:#{response.body}"
+end

data/dev_notes.md

@@ -0,0 +1 @@
+* the file spec/test_config is ignored intentionally, you can load your personal pushover details into this file for running specs successfully.

data/lib/pushover.rb

@@ -7,15 +7,55 @@ require "pushover/user"
 require "pushover/config"
 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 self.notification(token, application, message, title = nil)
-		url = URI.parse("https://api.pushover.net/1/messages")
+	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({:token => token, :user => application, :message => message, :title => title})
+		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
+    yield self
+    parameters
+  end
+
+  # List available parameters and values in those params
+  def parameters
+    @values = {}
+    keys.each { |k| @values.merge! k => get_var("@#{k}") }
+    @values
+  end
+
+  # Returns true or false if all parameters are set.
+  def parameters?
+    parameters.values.all?
+  end
+
+  def keys
+    keys ||= [:token, :user]
+  end
+
+  private
+
+  # Helper to clean up recursive method in #parameters
+  def get_var(var)
+    self.instance_variable_get(var)
+  end
+
 end

data/lib/pushover/app.rb

@@ -1,5 +1,11 @@
 module Pushover
+	# Stores a application definition in the config file.
 	module App
+		# an instance of an application.
+		# @!attribute name
+		# 	@return [String] the name of the application.
+		# @!attribute api_key
+		#   @return [String] the api_key of the application.
 		class App
 			attr_accessor :name
 			attr_accessor :api_key
@@ -7,21 +13,22 @@ module Pushover
 			def initialize(api_key, name)
 				@name = name
 				@api_key = api_key
-				Pushover::Config[:applications] = {} if !Pushover::Config[:applications]
+				Config[:applications] = {} if !Config[:applications]
 				if name
-					Pushover::Config[:applications][name] = api_key
+					Config[:applications][name] = api_key
 				else
-					Pushover::Config[:applications][api_key] = api_key
+					Config[:applications][api_key] = api_key
 				end
 			end
-
 		end
 
+		extend self
+
 		# Find the apikey in the applications, or pass on the word to try direct access.
 		# @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 self.find(word)
-			return Config[:applications][word] if Config[:applications] && Config[:applications].include?(word)
+		def find(word)
+			return Config[:applications][word] if Config[:applications][word]
 			word
 		end
 
@@ -29,9 +36,31 @@ module Pushover
 		# @param [String] api_key is the api_key to be used.
 		# @param [String] name is the short name that can be referenced later.
 		# @return [Boolean] return the results of the save attempt.
-		def self.add(api_key, name)
+		def add(api_key, name)
 			App.new api_key, name
 			Pushover::Config.save!
 		end
+
+		# Return the current app selected, or the first one saved.
+		def current_app
+			return @current_app if @current_app
+
+			# did something get supplied on the cli? try to find it.
+			if Options[:appkey]
+				@current_app = Pushover::App.find Options[:appkey]
+			end
+
+			# no?  do we have anything we can return?
+			if !@current_app
+				@current_app = Config[:applications].first
+			end
+			@current_app
+		end
+
+		# 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 nil
+		end
 	end
 end

data/lib/pushover/config.rb

@@ -1,40 +1,62 @@
 require 'fileutils'
 
 module Pushover
+  # This is an extended [Hash] that adds some saving features via yajl.
   class ConfigBlob < Hash
-    BaseDir = "#{Dir.home}/.config/pushover"
+    attr_accessor :save_file
+
+    # @return [String] the dirname of the save file.
+    def save_dir
+      File.dirname @save_file
+    end
 
     def initialize(load = true)
-      FileUtils.mkdir_p BaseDir if !Dir.exist? BaseDir
+      @save_file = "#{Dir.home}/.config/pushover/config.json"
+
       self.load if load
     end
 
-    def file
-      "#{BaseDir}/config.json"
+    # Clear the config file (not implemented)
+    def clear
     end
 
+    # Save the config, will raise an exception if the file exists.
     def save
+      FileUtils.mkdir_p save_dir if !Dir.exist? save_dir
       if any?
         # I do this the long way because I want an immediate sync.
-        f = open(file, 'w')
+        f = open(@save_file, 'w')
         f.write Yajl.dump self
         f.sync
         f.close
       end
     end
 
-    def save!
-      FileUtils.rm file if File.file? file
+    # Backup our save file, will remove original in the process.
+    def backupSave
+      FileUtils.mv @save_file, "#{@save_file}.bak" if File.file? @save_file
+    end
+
+    # Save the config, removing the existing one if necessary.
+    def save!(backup = true)
+      if backup
+        backupSave
+      else
+        FileUtils.rm @save_file if File.file? @save_file
+      end
+
       save
     end
 
+    # Load the config file if it is available.
     def load
-      if File.exist?(self.file) && File.stat(self.file).size > 0
-        h = Yajl.load open(file, 'r').read
+      if File.exist?(@save_file) && File.stat(@save_file).size > 0
+        h = Yajl.load open(@save_file, 'r').read
         h.each { |k,v| self[k.to_sym] = v}
       end
     end
   end
 
+  # A convenience instance of config, provides Pushover.Config.
   Config = ConfigBlob.new
 end

data/lib/pushover/optparser.rb

@@ -1,6 +1,9 @@
 require 'optparse'
 
 module Pushover
+  # override the built-in [OptionParser], adding some nifty features.
+  # Options[] is a hash value designed to collect the contents added to @options.
+
   class OptionParser < ::OptionParser
     def initialize
       super
@@ -10,6 +13,7 @@ module Pushover
       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("-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]}
     end
@@ -22,8 +26,10 @@ module Pushover
       end
     end
 
+    # Build out the banner and calls the built in parse!
+    # Loads any saved options automatically.
     def parse!
-      @banner = Pushover::VERSION
+      @banner = "Send notifications over to pushover.net.\n\n"
       super
 
       if @options[:version]
@@ -38,20 +44,26 @@ module Pushover
       end
     end
 
+    # Entry point to the options hash
+    # @return will return the value of key if provided, else the entire [Hash]
     def [](k = nil)
       return @options[k] if k
       return @options if @options.any?
       nil
     end
 
+    # Set a value in the option array, used as a way to store the results of the parsed value.
     def []=(k,v)
       @options[k] = v
     end
 
+    # Check to see if the option hash has any k/v pairs.
+    # @return [Boolean] true if any pairs at all, false otherwise.
     def empty?
       @options.empty?
     end
   end
 
+  # Add a built in Options to the Pushover namespace, purely a convenience thing.
   Options = OptionParser.new
 end

data/lib/pushover/user.rb

@@ -1,5 +1,11 @@
 module Pushover
+	# The user module, saves any user information provided.
 	module User
+		# The User class, for a single instance of it.
+		# @!attribute name
+		# 	@return [String] the name of the user.
+		# @!attribute token
+		#   @return [String] the token of the user.
 		class User
 			attr_accessor :name
 			attr_accessor :token
@@ -7,17 +13,19 @@ module Pushover
 			def initialize(token, name)
 				@name = name
 				@token = token
-				Pushover::Config[:users] = {} if !Pushover::Config[:users]
-				Pushover::Config[:users][name] = token
+				Config[:users] = {} if !Config[:users]
+				Config[:users][name] = token
 			end
 
 		end
 
+		extend self
+
 		# Find the apikey in the applications, or pass on the word to try direct access.
 		# @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 self.find(word)
-			return Config[:users][word] if Config[:users] && Config[:users].include?(word)
+		def find(word)
+			return Config[:users][word] if Config[:users][word]
 			word
 		end
 
@@ -25,9 +33,31 @@ module Pushover
 		# @param [String] token is the token to be used.
 		# @param [String] name is the short name that can be referenced later.
 		# @return [Boolean] return the results of the save attempt.
-		def self.add(token, name)
+		def add(token, name)
 			User.new token, name
 			Pushover::Config.save!
 		end
+
+		# Return the current user selected, or the first one saved.
+		def current_user
+			return @current_user if @current_user
+
+			# did something get supplied on the cli? try to find it.
+			if Options[:user]
+				@current_user = Pushover::User.find Options[:user]
+			end
+
+			# no?  do we have anything we can return?
+			if !@current_user
+				@current_user = Config[:users].first
+			end
+			@current_user
+		end
+
+		# 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 nil
+		end
 	end
 end

data/lib/pushover/version.rb

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

data/spec/app_spec.rb

@@ -0,0 +1,19 @@
+require 'pushover'
+
+describe "application" do
+	before(:each) do
+		Pushover::Config.save_file = "test.save"
+		Pushover::Config.clear
+	end
+
+	it "can add a application to the Config[:application] hash." do
+		Pushover::App.add "bar", "foo"
+		Pushover::Config[:applications]["foo"].should eq("bar")
+	end
+
+	it "can remove a application from the hash."
+	it "can find the apikey from the name" do
+		Pushover::App.add "bar", "foo"
+		Pushover::App.find("foo").should eq("bar")
+	end
+end

data/spec/cli_spec.rb

@@ -0,0 +1,42 @@
+describe "CLI Interface" do
+	# the save file to be used.
+	SaveFile = 'spec/test_config'
+	# the exact string to execute the test version of pushover.
+	Exec = "bundle exec bin/pushover"
+	ExecConfig = Exec + " -c #{SaveFile}"
+	describe "Can select the config file" do
+		it "short form (-c)" do
+			output = `#{ExecConfig}`
+			output.include? "Selecting config file: #{SaveFile}"
+		end
+
+		it "long form (--config_file)" do
+			output = `#{Exec} -c #{SaveFile}`
+			output.include? "Selecting config file: #{SaveFile}"
+		end
+	end
+	describe "Saving" do
+		it "Application." do
+			output = `#{ExecConfig} --app 'test_app_api_key' --save-app test_app`
+			output.include?("Save successful").should be_true
+		end
+		it "User." do
+			output = `#{ExecConfig} --user 'test_user_key' --save-app test_user`
+			output.include?("Save successful").should be_true
+		end
+	end
+	describe "Sending a message" do
+		it "With no saved info."
+		context "With saved information" do
+			it "With a saved user"
+			it "With a saved app"
+			it "With both"
+		end
+		describe "Title" do
+			it "can send with a title"
+			it "can send without a title"
+		end
+	end
+	it "provides the proper version number"
+end
+

data/spec/config_spec.rb

@@ -0,0 +1,29 @@
+require 'pushover'
+
+describe "Config" do
+	before(:all) do
+		Pushover::Config.save_file = "config_spec.tmp"
+		Pushover::Config.clear
+	 	Pushover::Config[:test] = true
+	 	Pushover::Config.save!
+	end
+
+	it "should exist" do
+		expect { Pushover::Config }.to_not be(nil)
+	end
+
+	it "should have a save_file" do
+		Pushover::Config.save_file.should eq("config_spec.tmp")
+	end
+
+	it "save_dir should be the basename of save_file" do
+		Pushover::Config.save_dir.should eq(File.dirname Pushover::Config.save_file)
+	end
+
+	it "should save if not empty"
+	it "should make a backup"
+	it "should load" do
+		Pushover::Config.load
+		Pushover::Config[:test].should eq(true)
+	end
+end

data/spec/pushover_spec.rb

@@ -0,0 +1,5 @@
+require 'pushover'
+
+describe "Pushover" do
+	it "can send a notification"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/user_spec.rb

@@ -0,0 +1,21 @@
+require 'pushover'
+
+describe "user" do
+	before(:each) do
+		Pushover::Config.save_file = "test.save"
+		Pushover::Config.clear
+	end
+
+	it "can add a user to the Config[:application] hash." do
+		Pushover::User.add "bar", "foo"
+		Pushover::Config[:users]["foo"].should eq("bar")
+	end
+
+	it "can remove a user from the hash."
+	it "can find the token from the name" do
+		Pushover::User.add "bar", "foo"
+		Pushover::User.find("foo").should eq("bar")
+	end
+end
+
+

data/whatsnew.md

@@ -0,0 +1,7 @@
+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.
+ * Will only create the save directory if you attempt to save.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pushover
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-15 00:00:00.000000000 Z
+date: 2012-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -57,6 +57,7 @@ files:
 - README.md
 - Rakefile
 - bin/pushover
+- dev_notes.md
 - lib/pushover.rb
 - lib/pushover/app.rb
 - lib/pushover/config.rb
@@ -64,6 +65,14 @@ files:
 - lib/pushover/user.rb
 - lib/pushover/version.rb
 - pushover.gemspec
+- spec/app_spec.rb
+- spec/cli_spec.rb
+- spec/config_spec.rb
+- spec/optparser_spec.rb
+- spec/pushover_spec.rb
+- spec/spec_helper.rb
+- spec/user_spec.rb
+- whatsnew.md
 homepage: ''
 licenses: []
 post_install_message: 
@@ -88,5 +97,12 @@ rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: This gem will provide both an API and CLI interface to pushover.net.
-test_files: []
+test_files:
+- spec/app_spec.rb
+- spec/cli_spec.rb
+- spec/config_spec.rb
+- spec/optparser_spec.rb
+- spec/pushover_spec.rb
+- spec/spec_helper.rb
+- spec/user_spec.rb
 has_rdoc: