handy_apn 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5fba04dc68ed06ffc27ca3c4ce9704a13e4da0f
-  data.tar.gz: 8b79dd6e4c98b45c81287e0524a9920eba04016a
+  metadata.gz: 3e01a9c1ab9a2c9d7d5d1c3b48c6ae08a9adcdde
+  data.tar.gz: e77a6a449c25ce239f71744fbffe2a1f9ab690f2
 SHA512:
-  metadata.gz: 8093d252a6a7705726c90980940c77a176278925065f415e3411e1f6c3735dd6c8c59a0e79d6bc01692ef012aae12b8dc594fafadb485e05b030fcf6705e6141
-  data.tar.gz: a4ba4cfbebe20c63ecb5e1388ee858292e7e99f34c1940fd4963dbb457ee1dc204fe39d24b37eafd3ca6caa53a998a295319feec739184684f05df7790a0f8e9
+  metadata.gz: 4067f2d2d0d3ad5c6d9cb56e53621d16c046407d86a365bae823453f0d644ea2cfc3c14820284a2bad34980683dbb4973f0a84ab4772ebe0842329ae568f9cae
+  data.tar.gz: f1a0c08576572c0578dff02c6b86cdf01eaeb553e460264fc532b54e66919884dc4c4ff3940b96a92aca6294dd2a176b55fb9b77b8f4efd4e07ad733e2e483ee

data/Rakefile

@@ -1,6 +1,11 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
-require "./lib/handy_apn/rakefile.rb"
+require "bundler"
+Bundler.setup
+
+gemspec = eval(File.read("handy_apn.gemspec"))
+
+require "handy_apn/rakefile"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/bin/handy_apn

@@ -0,0 +1,101 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "commander/import"
+require "handy_apn"
+
+HighLine.track_eof = false # Fix for built-in Ruby
+Signal.trap("INT") {} # Suppress backtrace when exiting command
+
+program :version, HandyApn::VERSION
+program :description, 'A command-line interface for sending push notifications'
+
+program :help, 'Author', 'Sushma Satish <sushmasatish@gmail.com>'
+program :help, 'Website', 'https://github.com/sushmasatish'
+program :help_formatter, :compact
+
+default_command :help
+
+command :push do |c|
+  c.syntax = 'handy_apn push TOKEN [...]'
+  c.summary = 'Sends an Apple Push Notification to specified devices'
+  c.description = ''
+
+  c.example 'description', 'handy_apn push <token> -m "Hello, World"'
+  c.option '-m', '--alert ALERT', 'Body of the alert to send in the push notification'
+  c.option '-e', '--environment ENV', [:production, :development], 'Environment to send push notification (production or development (default))'
+  c.option '-c', '--certificate CERTIFICATE', 'Path to certificate (.pem) file'
+  c.option '-p', '--[no]-passphrase', 'Prompt for a certificate passphrase'
+
+  c.action do |args, options|
+    say_error "One or more device tokens required" and abort if args.empty?
+
+    @environment = options.environment.downcase.to_sym rescue :development
+    say_error "Invalid environment,'#{@environment}' (should be either :development or :production)" and abort unless [:development, :production].include?(@environment)
+
+    @should_send_message_to_apn_prod = (@environment == :production)
+
+    @certificate = options.certificate
+    say_error "Missing certificate file option (-c /path/to/certificate.pem)" and abort unless @certificate
+    say_error "Could not find certificate file '#{@certificate}'" and abort unless File.exists?(@certificate)
+
+    @passphrase = options.passphrase ? password : ""
+
+    @alert = options.alert
+
+    unless @alert or @badge or @content_available or @data
+      placeholder = "Enter your alert message"
+      @alert = ask_editor placeholder
+      say_error "Payload contents required" and abort if @alert.nil? or @alert == placeholder
+    end
+
+    args.each do |token|
+	    ApnSendHelper.new(@certificate, 
+				@passphrase,
+				token, 
+				@should_send_message_to_apn_prod, 
+				@alert).send_push_notification()
+   	end
+  end
+end
+
+# command :feedback do |c|
+#   c.syntax = 'apn feedback [...]'
+#   c.summary = 'Queries the APN Feedback Service for failed device tokens.'
+#   c.description = ''
+
+#   c.example 'description', 'apn feedback -c /path/to/apple_push_certificate.pem'
+#   c.option '-c', '--certificate CERTIFICATE', 'Path to certificate (.pem) file'
+#   c.option '-e', '--environment ENV', [:production, :development], 'Environment to send push notification (production or development (default))'
+#   c.option '-p', '--[no]-passphrase', 'Prompt for a certificate passphrase'
+
+#   c.action do |args, options|
+
+#     @environment = options.environment.downcase.to_sym rescue :development
+#     say_error "Invalid environment,'#{@environment}' (should be either :development or :production)" and abort unless [:development, :production].include?(@environment)
+
+#     @certificate = options.certificate
+#     say_error "Missing certificate file option (-c /path/to/certificate.pem)" and abort unless @certificate
+#     say_error "Could not find certificate file '#{@certificate}'" and abort unless File.exists?(@certificate)
+
+#     @passphrase = options.passphrase ? password : ""
+
+#     client = (@environment == :production) ? Houston::Client.production : Houston::Client.development
+#     client.certificate = File.read(@certificate)
+#     client.passphrase = @passphrase
+
+#     begin
+#       feedbackDevices = client.unregistered_devices
+
+#       if feedbackDevices.any? && feedbackDevices.length > 0
+#         puts feedbackDevices.to_json
+#       else
+#         say_ok "No feedback available"
+#       end
+
+#     rescue => message
+#       say_error "Exception querying feedback: #{message}" and abort
+#     end
+
+#   end
+# end

data/handy_apn.gemspec

@@ -1,29 +1,31 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
 require 'handy_apn/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "handy_apn"
-  spec.version       = HandyApn::VERSION
   spec.authors       = ["Sushma Satish"]
   spec.email         = ["sushmasatish@gmail.com"]
-
+  spec.license       = "MIT"
+  spec.homepage      = "https://github.com/sushmasatish/handy_apn"
+  spec.version       = HandyApn::VERSION
+  spec.platform      = Gem::Platform::RUBY
   spec.summary       = %q{Provides a handy tool to check your certificate and send apple push notification instantly.}
   spec.description   = %q{Once the Apple push notification certificates are created, use the rake task to send push notification to the device instantly.}
-  spec.homepage      = "https://github.com/sushmasatish/handy_apn"
-
-  spec.rubyforge_project = "handy_apn"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
+  
   spec.add_dependency "configatron"
+  spec.add_dependency "coloured_logger"
+  spec.add_dependency "commander", "~> 4.1"
+  spec.add_dependency "json"
+  spec.add_dependency "houston"
 
   spec.add_development_dependency "bundler", "~> 1.9"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "json"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths  = ["lib"]
+
 end

data/lib/handy_apn.rb

@@ -1,4 +1,11 @@
+require "coloured_logger"
+require "configatron"
+require "json"
 require "handy_apn/version"
+require "handy_apn/string_helper"
+require "handy_apn/apn_configuration"
+require "handy_apn/apn_connection"
+require "handy_apn/apn_send_helper"
 
 module HandyApn
   # Your code goes here...

data/lib/handy_apn/apn_configuration.rb

@@ -0,0 +1,7 @@
+configatron.apn.port = 2195
+configatron.apn.dev.host = 'gateway.sandbox.push.apple.com'
+configatron.apn.prod.host = 'gateway.push.apple.com'
+
+configatron.apn.feedback.port = 2196
+configatron.apn.dev.feedback.host = 'feedback.sandbox.push.apple.com'
+configatron.apn.prod.feedback.host = 'gateway.push.apple.com'

data/lib/handy_apn/apn_connection.rb

@@ -1,6 +1,5 @@
 require 'socket'
 require 'openssl'
-require 'configatron'
 
 module ApnConnection
     

data/lib/handy_apn/apn_send_helper.rb

@@ -1,55 +1,56 @@
-require "./lib/handy_apn/colored_logger.rb"
-require "./lib/handy_apn/string_helper.rb"
-require "./lib/handy_apn/apn_connection.rb"
-require "./lib/handy_apn/apn_send_helper.rb"
-
 class ApnSendHelper
 
 	attr_reader :device_token
-	attr_reader :is_dev_or_prod
-	attr_reader :apn_cer_file_full_path
+	attr_reader :should_send_message_to_apn_prod
+	attr_reader :apn_pem_file_path
 	attr_reader :apn_pass_phrase
+	attr_reader :message
 
-	def initialize(apn_cer_file_full_path, apn_pass_phrase, device_token, is_dev_or_prod)
-		@apn_cer_file_full_path = apn_cer_file_full_path
+	def initialize(apn_pem_file_path, apn_pass_phrase, device_token, should_send_message_to_apn_prod, message)
+		@apn_pem_file_path = apn_pem_file_path
 		@apn_pass_phrase = apn_pass_phrase
 		@device_token = device_token
-		@is_dev_or_prod = is_dev_or_prod
+		@should_send_message_to_apn_prod = should_send_message_to_apn_prod
+		@message = "Testing: #{Time.now}"
+		if (message && 
+			message.strip.length > 0) 
+			@message = message.strip
+		end
 	end
 
 	def send_push_notification
 		result = false
 
-		if !StringHelper.is_valid(apn_cer_file_full_path)
-			ColoredLogger.debug(__method__, 
+		if !StringHelper.is_valid(apn_pem_file_path)
+			ColouredLogger::CLogger.debug(__method__, 
 				"Cannot send push notification as no certificate file is provided.")
 			return result
 		end
 
 		if !StringHelper.is_valid(apn_pass_phrase)
-			ColoredLogger.debug(__method__, 
+			ColouredLogger::CLogger.debug(__method__, 
 				"Cannot send push notification as pass-pharse is not provided for the certificate.")
 			return result
 		end
 
 		if !StringHelper.is_valid(device_token)
-			ColoredLogger.debug(__method__, 
+			ColouredLogger::CLogger.debug(__method__, 
 				"Cannot send push notification as device_token is not provided.")
 			return result
 		end
 
-		ColoredLogger.debug(__method__, 
-			"Sending push notification to device_token #{@device_token} - #{@is_dev_or_prod}")
+		ColouredLogger::CLogger.debug(__method__, 
+			"Sending push notification to device_token #{@device_token} - #{@should_send_message_to_apn_prod}")
 
 		reset_apn_configurations
 
 		begin
 	      ApnConnection.open_for_delivery() do |conn, sock|
-	        conn.write(ApnSendHelper.data_to_send(@device_token))
+	        conn.write(ApnSendHelper.data_to_send(@device_token, @message))
 	      end
 	      result = true
 	    rescue Exception => err
-	      ColoredLogger.debug(__method__, 
+	      ColouredLogger::CLogger.debug(__method__, 
 	      "Incurred while sending notifications [#{err.message}]")
 	    end
 
@@ -57,18 +58,18 @@ class ApnSendHelper
 	end
 
 	def reset_apn_configurations
-		configatron.apn.cert = @apn_cer_file_full_path
+		configatron.apn.cert = @apn_pem_file_path
 		configatron.apn.passphrase = @apn_pass_phrase
 
-		if @is_dev_or_prod
+		if @should_send_message_to_apn_prod
 			configatron.apn.host = configatron.apn.prod.host
 		else
 			configatron.apn.host = configatron.apn.dev.host
 		end
 	end
 
-	def self.data_to_send(device_token)
-	  json = self.to_apple_json
+	def self.data_to_send(device_token, msg)
+	  json = self.to_apple_json(msg)
 	  message = "\0\0 #{self.to_hexa(device_token)}\0#{json.length.chr}#{json}"
 	  raise ApnErrorsHelper::ExceededMessageSizeError.new(message) if message.size.to_i > 256
 	  message
@@ -78,16 +79,19 @@ class ApnSendHelper
 	  [device_token.delete(' ')].pack('H*')
 	end
 
-	def self.apple_hash
+	def self.apple_hash(msg)
 	  result = {}
 	  result['aps'] = {}
-	  result['aps']['alert'] = "Testing: #{Time.now}"
+	  result['aps']['alert'] = msg
 	  result['aps']['badge'] = 1
 	  result['aps']['sound'] = "1.aiff"
+
+	  ColouredLogger::CLogger.info(__method__, "Message: #{result}")
+
 	  result
 	end
 
-	def self.to_apple_json
-	  self.apple_hash.to_json
+	def self.to_apple_json(msg)
+	  self.apple_hash(msg).to_json
 	end
 end

data/lib/handy_apn/rakefile.rb

@@ -1,38 +1,29 @@
-require "configatron"
-require "json"
-require "./lib/handy_apn/colored_logger.rb"
-require "./lib/handy_apn/apn_send_helper.rb"
-
-configatron.apn.port = 2195
-configatron.apn.dev.host = 'gateway.sandbox.push.apple.com'
-configatron.apn.prod.host = 'gateway.push.apple.com'
-
-configatron.apn.feedback.port = 2196
-configatron.apn.dev.feedback.host = 'feedback.sandbox.push.apple.com'
-configatron.apn.prod.feedback.host = 'gateway.push.apple.com'
+require "handy_apn"
 
 namespace :apn do
 
-	desc "send_push_notification - Params: apn_cer_file_full_path, apn_pass_phrase, device_token, is_dev_or_prod"
-	task :send_push_notification, [:apn_cer_file_full_path, :apn_pass_phrase, :device_token, :is_dev_or_prod] do |task, args|
-		ColoredLogger.info(task, "STARTED - Running send_push_notification Task.")
+	desc "send_message - Params: apn_pem_file_path, apn_pass_phrase, device_token, should_send_message_to_apn_prod, message_text"
+	task :send_message, [:apn_pem_file_path, :apn_pass_phrase, :device_token, :should_send_message_to_apn_prod, :message_text] do |task, args|
+		ColouredLogger::CLogger.info(task, "STARTED - Running send_message Task.")
 
         device_token = args[:device_token]
-        is_dev_or_prod = false # False means dev.
-        apn_cer_file_full_path = args[:apn_cer_file_full_path]
+        should_send_message_to_apn_prod = false # False means dev.
+        apn_pem_file_path = args[:apn_pem_file_path]
 		apn_pass_phrase = args[:apn_pass_phrase]
+		message_text = args[:message_text]
 		
-		unless args[:is_dev_or_prod].nil?
-			if args[:is_dev_or_prod].downcase == "true"
-        		is_dev_or_prod = true
+		unless args[:should_send_message_to_apn_prod].nil?
+			if args[:should_send_message_to_apn_prod].downcase == "true"
+        		should_send_message_to_apn_prod = true
 	        end
 		end
         
-		ApnSendHelper.new(apn_cer_file_full_path, 
+		ApnSendHelper.new(apn_pem_file_path, 
 			apn_pass_phrase,
 			device_token, 
-			is_dev_or_prod).send_push_notification()
+			should_send_message_to_apn_prod, 
+			message_text).send_push_notification()
 
-		ColoredLogger.info(task, "FINISHED - Running send_push_notification Task.")
+		ColouredLogger::CLogger.info(task, "FINISHED - Running send_message Task.")
 	end
 end

data/lib/handy_apn/version.rb

@@ -1,3 +1,3 @@
 module HandyApn
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: handy_apn
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Sushma Satish
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2015-07-06 00:00:00.000000000 Z
+date: 2015-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: configatron
@@ -25,41 +25,41 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: coloured_logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: commander
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: '4.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -67,7 +67,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: houston
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -84,7 +126,8 @@ description: Once the Apple push notification certificates are created, use the
   task to send push notification to the device instantly.
 email:
 - sushmasatish@gmail.com
-executables: []
+executables:
+- handy_apn
 extensions: []
 extra_rdoc_files: []
 files:
@@ -95,20 +138,19 @@ files:
 - Gemfile
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
+- bin/handy_apn
 - handy_apn.gemspec
 - lib/handy_apn.rb
+- lib/handy_apn/apn_configuration.rb
 - lib/handy_apn/apn_connection.rb
 - lib/handy_apn/apn_errors_helper.rb
 - lib/handy_apn/apn_send_helper.rb
-- lib/handy_apn/colored_logger.rb
-- lib/handy_apn/logger.rb
 - lib/handy_apn/rakefile.rb
 - lib/handy_apn/string_helper.rb
 - lib/handy_apn/version.rb
 homepage: https://github.com/sushmasatish/handy_apn
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -125,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: handy_apn
+rubyforge_project: 
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "handy_apn"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,7 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/handy_apn/colored_logger.rb

@@ -1,44 +0,0 @@
-require 'singleton'
-require "./lib/handy_apn/logger.rb"
-
-class ColoredLogger
-	include Singleton
-
-	attr_reader :logger
-
-	SEVERITY_TO_COLOR_MAP = {'DEBUG'=>'36', 'INFO'=>'32', 'WARN'=>'33', 'ERROR'=>'31', 'FATAL'=>'31', 'UNKNOWN'=>'37', 'PERF'=>'35'}
-
-  	def initialize
-		@logger = Logger.new(STDOUT)
-# 		Logger.LEVEL = DEBUG - logs all levels, INFO - would not log debug level.
-		@logger.level = Logger::DEBUG
-		@logger.formatter = proc do |severity, time, progname, msg|
-      		formatted_severity = sprintf("%-5s",severity.to_s)
-      		formatted_time = sprintf("[%s]", time.strftime("%Y-%m-%d %H:%M:%S"))
-      		date_color ='1;34'
-      		severity_color = SEVERITY_TO_COLOR_MAP[severity]
-      		"\033[#{date_color}m#{formatted_time} \033[#{severity_color}m #{formatted_severity} \033[0m-- #{msg.to_s.strip}\n"
-    	end
-	end
-
-# 	low-level information for developers
-	def self.debug(method, message)
-		formatted_method = sprintf("%-20s", method)
-		ColoredLogger.instance.logger.debug("#{formatted_method}: #{message}");
-	end
-
-# 	generic (useful) information about system operation
-	def self.info(method, message)
-		formatted_method = sprintf("%-20s", method)
-		ColoredLogger.instance.logger.info("#{formatted_method}: #{message}");
-	end
-
-# 	Logs time taken to execute a task
-	def self.log_time(method, start_time, task_name)
-		end_time = Time.now
-		formatted_method = sprintf("%-20s", method)
-		time_taken = end_time - start_time
-		formatted_time_taken = sprintf("[%.4f sec]", time_taken)
-		ColoredLogger.instance.logger.perf("#{formatted_method}: Time taken to #{task_name} - \033[35m#{formatted_time_taken}\033[0m");
-	end
-end

data/lib/handy_apn/logger.rb

@@ -1,15 +0,0 @@
-require 'logger'
-
-class Logger
-  def self.custom_level(tag)
-    SEV_LABEL << tag
-    idx = SEV_LABEL.size - 1
-
-    define_method(tag.downcase.gsub(/\W+/, '_').to_sym) do |progname, &block|
-      add(idx, nil, progname, &block)
-    end
-  end
-
-# Adding PERF custom level
-  custom_level 'PERF'
-end