handy_apn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d412598e9d97c0cd8e719e0edfcd5e950e1cc7c
+  data.tar.gz: b314841804c837ff5041eb1f22c7bbd999205934
+SHA512:
+  metadata.gz: b5c8eeafda384feab4882c75303ec34bdf53a547a5c0738c96240f7efa6fd21df4fdfc5e329fd1f93a7ef65b74c7b08773fd7ad22830997d6b59762af0339a41
+  data.tar.gz: 2a4bbc09c0f62d22588b810e1a61add2db5fc0c61733ac55a649056dcb2fe9271611e76c1a7024ceecf772c16a779793e5337b7a3f0a22115c4d2057ed8db5bd

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rvmrc

@@ -0,0 +1,60 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 2.1.2@handy_apn" > .rvmrc
+environment_id="ruby-2.1.2@handy_apn"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.26.11 (latest)" # 1.10.1 seems like a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | __rvm_awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  for __hook in "${rvm_path:-$HOME/.rvm}/hooks/after_use"*
+  do
+    if [[ -f "${__hook}" && -x "${__hook}" && -s "${__hook}" ]]
+    then \. "${__hook}" || true
+    fi
+  done
+  unset __hook
+  if (( ${rvm_use_flag:=1} >= 2 )) # display only when forced
+  then
+    if [[ $- == *i* ]] # check for interactive shells
+    then printf "%b" "Using: $(tput setaf 2 2>/dev/null)$GEM_HOME$(tput sgr0 2>/dev/null)\n" # show the user the ruby and gemset they are using in green
+    else printf "%b" "Using: $GEM_HOME\n" # don't use colors in non-interactive shells
+    fi
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS="" \command \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS="" \command \grep -vE '^Using|Your bundle is complete'
+# fi

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.10.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in handy_apn.gemspec
+gemspec

data/README.md

@@ -0,0 +1,55 @@
+# HandyApn
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/handy_apn`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'handy_apn'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install handy_apn
+
+## Usage
+
+	$ require 'handy_apn'
+	$ rake --tasks
+	$ rake apn:send_push_notification[full_file_path_to_dot_pem,pass_phrase_for_certificate,device_token,is_dev_or_prod]
+
+Note:
+
+* full_file_path_to_dot_cer - absolute location of the file along with file name and should be for .pem
+
+* device_token - should be separated by space after 8 characters as shown in example below.
+
+* is_dev_or_prod - false - connects to APN-Dev service - gateway.sandbox.push.apple.com
+
+
+	$ rake apn:send_push_notification["/Users/blah/apn_certificates/aps_development.pem","blah","eb8328c8 3f42a4dd e7eb8e96 5535b0c7 653032eb 070e54d9 c55133a6 da32c94f",false]
+
+## How to create apple push notification certificate
+
+ I have referred to instructions from raywenderlich.
+
+http://www.raywenderlich.com/32960/apple-push-notification-services-in-ios-6-tutorial-part-1
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sushmasatish/handy_apn.
+

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "./lib/handy_apn/rakefile.rb"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/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

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

data/handy_apn.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.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_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "json"
+  spec.add_development_dependency "configatron"
+end

data/lib/handy_apn.rb

@@ -0,0 +1,5 @@
+require "handy_apn/version"
+
+module HandyApn
+  # Your code goes here...
+end

data/lib/handy_apn/apn_connection.rb

@@ -0,0 +1,74 @@
+require 'socket'
+require 'openssl'
+require 'configatron'
+
+module ApnConnection
+    
+    class << self
+      
+      # Yields up an SSL socket to write notifications to.
+      # The connections are close automatically.
+      # 
+      #  Example:
+      #   APN::Configuration.open_for_delivery do |conn|
+      #     conn.write('my cool notification')
+      #   end
+      # 
+      # Configuration parameters are:
+      # 
+      #   configatron.apn.passphrase = ''
+      #   configatron.apn.port = 2195
+      #   configatron.apn.host = 'gateway.sandbox.push.apple.com' # Development
+      #   configatron.apn.host = 'gateway.push.apple.com' # Production
+      #   configatron.apn.cert = File.join(rails_root, 'config', 'apple_push_notification_development.pem')) # Development
+      #   configatron.apn.cert = File.join(rails_root, 'config', 'apple_push_notification_production.pem')) # Production
+      def open_for_delivery(options = {}, &block)
+        open(options, &block)
+      end
+      
+      # Yields up an SSL socket to receive feedback from.
+      # The connections are close automatically.
+      # Configuration parameters are:
+      # 
+      #   configatron.apn.feedback.passphrase = ''
+      #   configatron.apn.feedback.port = 2196
+      #   configatron.apn.feedback.host = 'feedback.sandbox.push.apple.com' # Development
+      #   configatron.apn.feedback.host = 'feedback.push.apple.com' # Production
+      #   configatron.apn.feedback.cert = File.join(rails_root, 'config', 'apple_push_notification_development.pem')) # Development
+      #   configatron.apn.feedback.cert = File.join(rails_root, 'config', 'apple_push_notification_production.pem')) # Production
+      def open_for_feedback(options = {}, &block)
+        options = {:cert => configatron.apn.feedback.cert,
+                   :passphrase => configatron.apn.feedback.passphrase,
+                   :host => configatron.apn.feedback.host,
+                   :port => configatron.apn.feedback.port}.merge(options)
+        open(options, &block)
+      end
+      
+      private
+      def open(options = {}, &block) # :nodoc:
+        options = {:cert => configatron.apn.cert,
+                   :passphrase => configatron.apn.passphrase,
+                   :host => configatron.apn.host,
+                   :port => configatron.apn.port}.merge(options)
+
+        cert = File.read(options[:cert])
+        # cert = options[:cert]
+        ctx = OpenSSL::SSL::SSLContext.new
+        ctx.key = OpenSSL::PKey::RSA.new(cert, options[:passphrase])
+        ctx.cert = OpenSSL::X509::Certificate.new(cert)
+        ctx.ca_file = options[:ca_file]
+  
+        sock = TCPSocket.new(options[:host], options[:port])
+        ssl = OpenSSL::SSL::SSLSocket.new(sock, ctx)
+        ssl.sync = true
+        ssl.connect
+  
+        yield ssl, sock if block_given?
+  
+        ssl.close
+        sock.close
+      end
+      
+    end
+    
+  end # Connection

data/lib/handy_apn/apn_errors_helper.rb

@@ -0,0 +1,16 @@
+module ApnErrorsHelper
+  # Raised when a notification message to Apple is longer than 256 bytes.
+  class ExceededMessageSizeError < StandardError
+
+    def initialize(message) # :nodoc:
+      super("The maximum size allowed for a notification payload is 256 bytes: '#{message}'")
+    end
+
+  end
+
+  class MissingCertificateError < StandardError
+    def initialize
+      super("This app has no certificate")
+    end
+  end
+end

data/lib/handy_apn/apn_send_helper.rb

@@ -0,0 +1,93 @@
+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 :apn_pass_phrase
+
+	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
+		@apn_pass_phrase = apn_pass_phrase
+		@device_token = device_token
+		@is_dev_or_prod = is_dev_or_prod
+	end
+
+	def send_push_notification
+		result = false
+
+		if !StringHelper.is_valid(apn_cer_file_full_path)
+			ColoredLogger.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__, 
+				"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__, 
+				"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}")
+
+		reset_apn_configurations
+
+		begin
+	      ApnConnection.open_for_delivery() do |conn, sock|
+	        conn.write(ApnSendHelper.data_to_send(@device_token))
+	      end
+	      result = true
+	    rescue Exception => err
+	      ColoredLogger.debug(__method__, 
+	      "Incurred while sending notifications [#{err.message}]")
+	    end
+
+		result
+	end
+
+	def reset_apn_configurations
+		configatron.apn.cert = @apn_cer_file_full_path
+		configatron.apn.passphrase = @apn_pass_phrase
+
+		if @is_dev_or_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
+	  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
+	end
+
+	def self.to_hexa(device_token)
+	  [device_token.delete(' ')].pack('H*')
+	end
+
+	def self.apple_hash
+	  result = {}
+	  result['aps'] = {}
+	  result['aps']['alert'] = "Testing: #{Time.now}"
+	  result['aps']['badge'] = 1
+	  result['aps']['sound'] = "1.aiff"
+	  result
+	end
+
+	def self.to_apple_json
+	  self.apple_hash.to_json
+	end
+end

data/lib/handy_apn/colored_logger.rb

@@ -0,0 +1,44 @@
+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

@@ -0,0 +1,15 @@
+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

data/lib/handy_apn/rakefile.rb

@@ -0,0 +1,38 @@
+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'
+
+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.")
+
+        device_token = args[:device_token]
+        is_dev_or_prod = false # False means dev.
+        apn_cer_file_full_path = args[:apn_cer_file_full_path]
+		apn_pass_phrase = args[:apn_pass_phrase]
+		
+		unless args[:is_dev_or_prod].nil?
+			if args[:is_dev_or_prod].downcase == "true"
+        		is_dev_or_prod = true
+	        end
+		end
+        
+		ApnSendHelper.new(apn_cer_file_full_path, 
+			apn_pass_phrase,
+			device_token, 
+			is_dev_or_prod).send_push_notification()
+
+		ColoredLogger.info(task, "FINISHED - Running send_push_notification Task.")
+	end
+end

data/lib/handy_apn/string_helper.rb

@@ -0,0 +1,19 @@
+class StringHelper
+	def self.is_valid(string_to_check)
+		result = true
+
+		if string_to_check.nil? ||
+			string_to_check.length == 0
+
+			result = false
+
+		elsif string_to_check.downcase == "nil"
+			string_to_check.downcase == "null"
+			
+			result = false
+
+		end
+
+		result
+	end
+end

data/lib/handy_apn/version.rb

@@ -0,0 +1,3 @@
+module HandyApn
+    VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: handy_apn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sushma Satish
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-07 00:00:00.000000000 Z
+dependencies:
+- !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:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: configatron
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Once the Apple push notification certificates are created, use the rake
+  task to send push notification to the device instantly.
+email:
+- sushmasatish@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rvmrc"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- handy_apn.gemspec
+- lib/handy_apn.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: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: handy_apn
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Provides a handy tool to check your certificate and send apple push notification
+  instantly.
+test_files: []