pushover 1.0.4 → 2.0.0

data/Rakefile

@@ -1,7 +1,6 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
-
+task default: :spec

data/bin/pushover

@@ -1,154 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'pushover'
-
-include Bini
-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[:token] = o}
-Options.on("-t", "--title [TITLE]", "Set the title of the notification (optional).") { |o| Options[:title] = o}
-Options.on("-p", "--priority [PRIORITY]", "Set the priority of the notification from (low,normal,high,emergency) (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] = o}
-Options.on("--save-user NAME", "Saves the user to the config file under NAME.") { |o| Options[:save_user] = o}
-Options.on("--sound [SOUND]", "Specify the sound to use.  Can be a partial string as long as it is unambiguous enough.") { |o| Options[:sound] = o}
-Options.on("--sound_list", "Display the current list of available sounds.  Requires an app token.") { |o| Options[:sound_list] = true}
-Options.on("--emergency_retry [TIME]", "The time in seconds between retries.") { |o| Options[:retry] = o}
-Options.on("--emergency_expire [TIME]", "How long the emergency notification will hang around.") { |o| Options[:expire] = o}
-Options.on("--emergency_callback_url [URL]", "A callback url to use when the notification is acknowledged.") { |o| Options[:callback] = o}
-Options.on("--receipts", "List the receipts cached and if they have been acknowledged or not.") {|o| Options[:receipts] = true}
-
-Options.parse!
-bail = false
-
-# Order is important.
-if Options[:config_file]
-	Bini::Config.options[:file] = Options[:config_file]
-	puts "Selected config file: #{Options[:config_file]}"
-	# TODO: Make a healper for changing config so it clears/loads automatically.
-	Bini::Config.clear
-	Bini::Config.load
-end
-
-if Options[:save_app]
-	App.add Options[:save_app], Options[:token]
-	puts "Saved application #{Options[:token]} to #{Options[:save_app]}."
-	bail = true
-end
-
-if Options[:save_user]
-	User.add Options[:save_user], Options[:user]
-	puts "Saved user #{Options[:user]} to #{Options[:save_user]}."
-	bail = true
-end
-
-exit if bail # We don't care if we have a message, we should exit here.
-
-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
-
-if Options[:sound_list]
-	puts "Current Sound List:"
-	if Pushover.sounds
-		Pushover.sounds.each { |k,v| puts "  #{v}" }
-	else
-		puts "Error retrieving sound list, are you connected to the internet?  are your credentials correct?"
-		exit
-	end
-	bail = true
-end
-
-if Options[:receipts]
-	puts 'Updating receipts'
-	Pushover::Priority.update_receipts
-	Pushover::Priority::Receipts.each do |k,v|
-		if v["acknowledged"] != 0
-			print "Receipt #{k} was acknowledged at #{Time.at v["acknowledged_at"]}, "
-		else
-			print "Receipt #{k} has not been acknowledged yet, "
-		end
-
-		if v["expired"] == 0
-			puts "and will expire at: #{Time.at v["expires_at"]}."
-		else
-			puts "and expired at: #{Time.at v["expires_at"]}."
-		end
-	end
-	exit
-end
-
-if Options[:sound]
-	sounds = Pushover.sounds
-	if !sounds
-		puts "Error retrieving sound list, are you connected to the internet?  are your credentials correct?"
-		exit
-	end
-	match = sounds.select { |k,v| v.downcase.start_with? Options[:sound].downcase}
-	if !match || match.count == 0
-		puts "No such sound: #{Options[:sound]}."
-		bail = true
-	elsif match.count > 1
-		print "Sound is ambiguous, possible matches: "
-		match.each {|k,v| print "#{v} "}
-		print "\n"
-		bail = true
-	else
-		Options[:sound] = match.first[0]
-	end
-end
-
-if Options[:priority]
-	# Is this an emergency, did we include everything we need?
-	if Priority.is_emergency?(Options[:priority])
-		Options[:retry] = 30 if !Options[:retry]
-		Options[:expire] = 86400 if !Options[:expire]
-	end
-end
-
-exit if bail
-
-message = ARGV.join(" ")
-if !message
-	puts "Must supply a message to be sent."
-	bail = true
-end
-
-exit if bail
-
-options = Options[].select { |k,v| v}
-options[:token] = Pushover::App.current_app
-options[:user] = Pushover::User.current_user
-
-options.delete :config_file
-options.merge! message:message
-
-response = Pushover.notification options
-if response.code == 500
-	puts "Something is broken at pushover.net and it is returning 500's (server errors).  Here is the response body."
-	puts response.body
-	exit
-end
-j = Yajl.load response.body
-
-if response.code == 200
-	if Priority.is_emergency?(Options[:priority])
-		j = Yajl.load response.body
-		Pushover::Priority.process_receipt j["receipt"]
-		puts "emergency notification receipt: #{j["receipt"]}"
-	end
-	puts "Message sent successfully!"
-else
-	puts "ErrorCode (#{response.code}): #{j['errors'].first}."
-end
-

data/lib/pushover.rb

@@ -1,148 +1,12 @@
-require 'httparty'
-require "yajl"
-require 'time'
-require 'bini'
-require 'bini/config'
-require 'bini/optparser'
-require 'open-uri'
-require 'pushover/mixins.rb'
+require 'oj'
+require 'creatable'
 
-module Pushover
-  autoload :VERSION,  "pushover/version"
-  autoload :App,      "pushover/app"
-  autoload :User,     "pushover/user"
-  autoload :Priority, "pushover/priority"
-end
+require 'pushover/api'
+require 'pushover/message'
+require 'pushover/receipt'
+require 'pushover/response'
+require 'pushover/request'
 
-# The primary pushover namespace.
+# pushover interface for ruby
 module Pushover
-  # Unfuckingbelievable.  My code, and I still can't get it to work as expected.
-  Bini.long_name = 'pushover'
-  # lets save our config to it's own dir, just because.
-  Bini::Config.options[:file] = "#{Dir.home}/.config/pushover/credentials.yaml"
-  Bini::Config.load
-
-  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,String] device to recieve the message.
-  attr_accessor :device
-  attr_reader   :priority
-  attr_accessor :url
-  attr_accessor :url_title
-  attr_accessor :emergency_retry
-  attr_accessor :emergency_expire
-  attr_accessor :emergency_callback
-  # [optional,String, Fixnum] time a time stamp im one of three forms (epoch, strfmt, rails)
-  attr_reader   :timestamp
-
-  # 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)
-    @timestamp = timestamp_magic time_string
-  end
-
-  # 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={})
-    tokens[:timestamp] = timestamp_magic tokens[:timestamp] if tokens[:timestamp]
-    tokens[:priority]  = Pushover::Priority.parse tokens[:priority] if tokens[:priority]
-    tokens[:user]      ||= @user
-    tokens[:token]     ||= @token
-
-    HTTParty.post('https://api.pushover.net/1/messages.json', body:tokens)
-  end
-
-  # Return a [Hash] of sounds.
-  def sounds
-    cache_file = "#{Bini.cache_dir}/sounds.json"
-    sounds = {}
-
-    cache_sounds if File.exists?(cache_file) && File.stat(cache_file).mtime < Time.at(Time.now.day - 1)
-
-    return nil if !cache_sounds
-    sounds = Yajl.load open(cache_file).read
-    sounds["sounds"]
-  end
-
-  # Adds a rails style configure method
-  def configure
-    yield self
-    parameters
-  end
-
-  # List available parameters and values in those params
-  def parameters
-    h = {}
-    keys.each { |k| h[k.to_sym] = Pushover.instance_variable_get("@#{k}") }
-    return h
-  end
-  alias_method :params, :parameters
-
-  # Returns true or false if all parameters are set.
-  def parameters?
-    parameters.values.all?
-  end
-
-  # Clear all the currently set parameters
-  def clear
-    keys.each do |k|
-      Pushover.instance_variable_set("@#{k}", nil)
-    end
-  end
-
-  # A [Array] of keys available in Pushover.
-  def keys
-    Pushover.instance_methods.select do |m|
-      m =~ /=$/
-    end.map do |m|
-      m[0..-2]
-    end
-  end
-
-
-  private
-
-  def timestamp_magic(time_string)
-    if time_string.class == String
-      begin
-        return Time.parse(time_string).to_i
-      rescue ArgumentError
-        return time_string.to_i
-      end
-    elsif
-      time_string.class == Fixnum
-      return time_string
-    end
-  end
-
-  def cache_sounds
-    cache_file = "#{Bini.cache_dir}/sounds.json"
-
-    response = HTTParty.get('https://api.pushover.net/1/sounds.json', query:{token:Pushover::App.current_app})
-
-    return nil if response.code != 200
-    FileUtils.mkdir_p Bini.cache_dir
-    f = open(cache_file, 'w')
-    f.write response.body
-    f.flush
-    f.close
-    return true
-  end
 end

data/lib/pushover/api.rb

@@ -0,0 +1,35 @@
+require 'creatable'
+require 'excon'
+require 'oj'
+
+require 'pushover/response'
+
+module Pushover
+  # Api module
+  module Api
+    module_function
+
+    def endpoints
+      %i[messages sounds limits receipts validate]
+    end
+
+    def sounds
+      %i[ pushover bike bugle cashregister classical cosmic falling gamelan incoming
+          intermission magic mechanical pianobar siren spacealarm tugboat alien
+          climb persistent echo updown none]
+    end
+
+    def connection
+      Excon.new url
+    end
+
+    def initialize
+      Excon.defaults[:headers]['Content-Type'] = 'application/json'
+      Excon.defaults[:headers]['User-Agent'] = "pushover (ruby gem) v#{Pushover::VERSION}"
+    end
+
+    def url
+      "https://api.pushover.net"
+    end
+  end
+end

data/lib/pushover/message.rb

@@ -0,0 +1,38 @@
+# Pushover interface
+module Pushover
+  class Message
+    include Creatable
+
+    attribute name: 'attachment'
+    attribute name: 'device', kind_of: String
+    attribute name: 'html', kind_of: TrueClass
+    attribute name: 'message', kind_of: String
+    attribute name: 'priority', kind_of: String
+    attribute name: 'sound', kind_of: String
+    attribute name: 'timestamp', kind_of: Numeric
+    attribute name: 'title', kind_of: String
+    attribute name: 'token', kind_of: String
+    attribute name: 'response', kind_of: Pushover::Response
+    attribute name: 'url_title', kind_of: String
+    attribute name: 'url', kind_of: String
+    attribute name: 'user', kind_of: String
+
+    def initialize
+      @timestamp = Time.now.to_i
+    end
+
+    def push
+      raise ArgumentError, 'user is a required parameter' unless user
+      raise ArgumentError, 'token is a required parameter' unless token
+      raise ArgumentError, 'message is a required parameter' unless message
+
+      query = {}
+
+      attributes.each { |e| query.store e[:name], instance_variable_get("@#{e[:name]}") if instance_variable_get("@#{e[:name]}") }
+
+      response = Request.create.push(:messages, query)
+      response.process
+      @response = response
+    end
+  end
+end

data/lib/pushover/receipt.rb

@@ -0,0 +1,5 @@
+module Pushover
+  # Receipt class
+  class Receipt
+  end
+end

data/lib/pushover/request.rb

@@ -0,0 +1,12 @@
+module Pushover
+  class Request
+    include Creatable
+
+    def push(endpoint, config = {})
+      excon_response = Api.connection.post path: "1/#{endpoint}.json", query: config
+      response = Response.create original: excon_response
+      response.process
+      @response = response
+    end
+  end
+end

data/lib/pushover/response.rb

@@ -0,0 +1,40 @@
+module Pushover
+  class Response
+    include Creatable
+
+    attribute name: 'user', kind_of: String
+    attribute name: 'errors', kind_of: Array
+    attribute name: 'status', kind_of: Numeric
+    attribute name: 'receipt', kind_of: String
+    attribute name: 'request', kind_of: String
+    attribute name: 'original', kind_of: String
+    attribute name: 'limit', kind_of: String
+    attribute name: 'remaining', kind_of: String
+    attribute name: 'reset', kind_of: String
+
+    def initialize
+      @status = 0
+      @errors = []
+    end
+
+    def process
+      process_body
+      process_headers
+    end
+
+    def process_body
+      body = Oj.load original[:body]
+
+      @status = body["status"]
+      @request = body["request"]
+      @receipt = body["receipt"] if body["receipt"]
+      @errors = body["errors"] if body["errors"]
+    end
+
+    def process_headers
+      @limit = original.headers['X-Limit-App-Limit']
+      @remaining = original.headers['X-Limit-App-Remaining']
+      @reset = original.headers['X-Limit-App-Reset']
+    end
+  end
+end