apnserver 0.1.10 → 0.2.1

data/README.textile

@@ -5,48 +5,54 @@ h1. Apple Push Notification Server Toolkit
 h2. Description
 
 apnserver is a server and set of command line programs to send push notifications to the iPhone.
-Apple recomends to maintain an open connection to the push notification service and refrain from 
-opening up and tearing down SSL connections reapeated.  To solve this problem an intermediate 
-network server is introduced that queues are requests to the APN service and sends them via a 
+Apple recommends to maintain an open connection to the push notification service and refrain from
+opening up and tearing down SSL connections repeated.  To solve this problem an intermediate
+network server is introduced that queues are requests to the APN service and sends them via a
 persistent connection.
 
 h2. Remaining Tasks
- 
+
  * Implement feedback service mechanism
  * Implement robust notification sending in reactor periodic scheduler
- 
+
 h2. Issues Fixed
 
  * second attempt at retry logic, SSL Errors close down sockets now
  * apnsend --badge option correctly sends integer number rather than string of number for aps json payload
  * connections are properly closed in Notification#push method now
- * better compatibility with Rails
+ * removed json gem in favor of ActiveSupport
+ * Rails 3.x support
+ * drop the erroneous puts statements in favor a configurable logger
+ * moved to Rspec
 
 h2. APN Server Daemon
-   
+
 <pre>
   <code>
 Usage: apnserverd [options] --pem /path/to/pem
   --bind-address bind address (defaults to 0.0.0.0)
     bind address of the server daemon
-  
-  --proxy-port port 
+
+  --proxy-port port
     the port that the daemon will listen on (defaults to 22195)
-  
+
   --server server
     APN Server (defaults to gateway.push.apple.com)
-  
+
   --port port of the APN Server
     APN server port (defaults to 2195)
-  
+
   --pem pem file path
     The PEM encoded private key and certificate.
-    To export a PEM ecoded file execute 
+    To export a PEM ecoded file execute
     # openssl pkcs12 -in cert.p12 -out cert.pem -nodes -clcerts
- 
+
+  --pem-passphrase passphrase
+    The PEM passphrase to decode key.
+
   --help
-    usage message  
-  
+    usage message
+
   --daemon
     Runs process as daemon, not available on Windows
   </code>
@@ -54,7 +60,7 @@ Usage: apnserverd [options] --pem /path/to/pem
 
 h2. APN Server Client
 
-With the APN server client script you can send push notifications directly to 
+With the APN server client script you can send push notifications directly to
 Apple's APN server over an SSL connection or to the above daemon using a plain socket.
 To send a notification to Apple's APN server using SSL the *--pem* option must be used.
 
@@ -63,8 +69,9 @@ To send a notification to Apple's APN server using SSL the *--pem* option must b
 Usage: apnsend [switches] (--b64-token | --hex-token) <token>
   --server <localhost>                 the apn server defaults to a locally running apnserverd
   --port <2195>                        the port of the apn server
-  --pem <path>                         the path to the pem file, if a pem is supplied the server 
+  --pem <path>                         the path to the pem file, if a pem is supplied the server
                                        defaults to gateway.push.apple.com:2195
+  --pem-passphrase <passphrase>        the pem passphrase
   --alert <message>                    the message to send"
   --sound <default>                    the sound to play, defaults to 'default'
   --badge <number>                     the badge number
@@ -94,6 +101,7 @@ To configure the client to send to the local apnserverd process configure the Ap
   # configured for a using the apnserverd proxy
   ApnServer::Config.host = 'localhost'
   ApnServer::Config.port = 22195
+  ApnServer::Config.logger = Rails.logger
   </code>
 </pre>
 
@@ -123,11 +131,11 @@ Finally within we can send a push notification using the following code
 
 h2. Installation
 
-To install apnserver execute the following gem command:
+Apnserver is hosted on "rubygems":https://rubygems.org/gems/apnserver
 
 <pre>
 <code>
-  $ gem install bpoweski-apnserver --source http://gems.github.com
+  $ gem install apnserver
 </code>
 </pre>
 
@@ -135,15 +143,16 @@ Adding apnserver to your Rails application
 
 <pre>
   <code>
-  config.gem "bpoweski-apnserver", :lib => 'apnserver', :source => "http://gems.github.com"
+  gem 'apnserver', '>= 0.2.0
   </code>
 </pre>
 
+
 h2. License
 
 (The MIT License)
 
-Copyright (c) 2009 Ben Poweski
+Copyright (c) 2011 Ben Poweski
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/bin/apnsend

@@ -13,12 +13,13 @@ def usage
   puts " --server <localhost>                 the apn server defaults to a locally running apnserverd"
   puts " --port <2195>                        the port of the apn server"
   puts " --pem <path>                         the path to the pem file, if a pem is supplied the server defaults to gateway.push.apple.com:2195"
+  puts " --pem-passphrase <passphrase>        the pem passphrase"
   puts " --alert <message>                    the message to send"
   puts " --sound <default>                    the sound to play, defaults to 'default'"
   puts " --badge <number>                     the badge number"
-  puts " --custom <json string>               a custom json string to be added to the main object"  
+  puts " --custom <json string>               a custom json string to be added to the main object"
   puts " --b64-token <token>                  a base 64 encoded device token"
-  puts " --hex-token <token>                  a hex encoded device token"  
+  puts " --hex-token <token>                  a hex encoded device token"
   puts " --help                               this message"
 end
 
@@ -26,10 +27,11 @@ opts = GetoptLong.new(
   ["--server", "-s", GetoptLong::REQUIRED_ARGUMENT],
   ["--port", "-p", GetoptLong::REQUIRED_ARGUMENT],
   ["--pem", "-c", GetoptLong::REQUIRED_ARGUMENT],
+  ["--pem-passphrase", "-C", GetoptLong::REQUIRED_ARGUMENT],
   ["--alert", "-a", GetoptLong::REQUIRED_ARGUMENT],
   ["--sound", "-S", GetoptLong::REQUIRED_ARGUMENT],
   ["--badge", "-b", GetoptLong::REQUIRED_ARGUMENT],
-  ["--custom", "-j", GetoptLong::REQUIRED_ARGUMENT],  
+  ["--custom", "-j", GetoptLong::REQUIRED_ARGUMENT],
   ["--b64-token", "-B", GetoptLong::REQUIRED_ARGUMENT],
   ["--hex-token", "-H", GetoptLong::REQUIRED_ARGUMENT],
   ["--help", "-h", GetoptLong::NO_ARGUMENT]
@@ -48,6 +50,8 @@ opts.each do |opt, arg|
     ApnServer::Config.port = arg.to_i
   when '--pem'
     ApnServer::Config.pem = arg
+  when '--pem-passphrase'
+    ApnServer::Config.password = arg
   when '--alert'
     notification.alert = arg
   when '--sound'
@@ -55,16 +59,16 @@ opts.each do |opt, arg|
   when '--badge'
     notification.badge = arg.to_i
   when '--custom'
-    notification.custom = arg
+    notification.custom = ActiveSupport::JSON.decode(arg)
   when '--b64-token'
     notification.device_token = Base64::decode64(arg)
   when '--hex-token'
-    notification.device_token  = arg.unpack('H*')
+    notification.device_token  = arg.scan(/[0-9a-f][0-9a-f]/).map {|s| s.hex.chr}.join
   end
 end
 
 if notification.device_token.nil?
-  usage  
+  usage
   exit
 else
   notification.push

data/bin/apnserverd

@@ -5,24 +5,28 @@ require 'getoptlong'
 require 'rubygems'
 require 'daemons'
 require 'apnserver'
+require 'apnserver/server'
 
 def usage
   puts "Usage: apnserverd [switches] --pem <path>"
+  puts " --pem-passphrase <passphrase>        pem passphrase"
   puts " --bind-address [0.0.0.0]             bind address of proxy"
   puts " --proxy-port [22195]                 port proxy listens on"
   puts " --server <gateway.push.apple.com>    the apn server to send messages to"
   puts " --port <2195>                        the port of the apn server"
+  puts " --pid </var/run/apnserverd.pid       the path to store the pid"
+  puts " --log </var/log/apnserverd.log       the path to store the log"
+  puts " --daemon                             to daemonize the server"
   puts " --help                               this message"
 end
 
 def daemonize
-  Daemonize.daemonize('/var/log/apnserverd.log', 'apnserverd')
-  @pid_file = '/var/run/apnserverd.pid'
-  open(@pid_file,"w") {|f| f.write(Process.pid) } # copied from mongrel
+  Daemonize.daemonize(@log_file, 'apnserverd')
+  open(@pid_file,"w") { |f| f.write(Process.pid) }
   open(@pid_file,"w") do |f|
     f.write(Process.pid)
     File.chmod(0644, @pid_file)
-  end 
+  end
 end
 
 opts = GetoptLong.new(
@@ -30,7 +34,10 @@ opts = GetoptLong.new(
   ["--proxy-port", "-P", GetoptLong::REQUIRED_ARGUMENT],
   ["--server", "-s", GetoptLong::REQUIRED_ARGUMENT],
   ["--port", "-p", GetoptLong::REQUIRED_ARGUMENT],
+  ["--pid", "-i", GetoptLong::REQUIRED_ARGUMENT],
+  ["--log", "-l", GetoptLong::REQUIRED_ARGUMENT],
   ["--pem", "-c", GetoptLong::REQUIRED_ARGUMENT],
+  ["--pem-passphrase", "-C", GetoptLong::REQUIRED_ARGUMENT],
   ["--help", "-h", GetoptLong::NO_ARGUMENT],
   ["--daemon", "-d", GetoptLong::NO_ARGUMENT]
 )
@@ -40,22 +47,32 @@ proxy_port = 22195
 host = 'gateway.push.apple.com'
 port = 2195
 pem = nil
+pem_passphrase = nil
+@pid_file = '/var/run/apnserverd.pid'
+@log_file = '/var/log/apnserverd.log'
 daemon = false
 
 opts.each do |opt, arg|
   case opt
   when '--help'
     usage
+    exit 1
   when '--bind-address'
     bind_address = arg
   when '--proxy-port'
     proxy_port = arg.to_i
   when '--server'
-  	host = arg
+    host = arg
   when '--port'
-  	port = arg.to_i
+    port = arg.to_i
+  when '--pid'
+    @pid_file = arg
+  when '--log'
+    @log_file = arg
   when '--pem'
     pem = arg
+  when '--pem-passphrase'
+    pem_passphrase = arg
   when '--daemon'
     daemon = true
   end
@@ -69,5 +86,6 @@ else
   server = ApnServer::Server.new(pem, bind_address, proxy_port)
   server.client.host = host
   server.client.port = port
+  server.client.password = pem_passphrase
   server.start!
 end

data/bin/apnserverd.ubuntu.init

@@ -0,0 +1,116 @@
+#! /bin/sh
+### BEGIN INIT INFO
+# Provides:          apnserverd
+# Required-Start:    $remote_fs
+# Required-Stop:     $remote_fs
+# Default-Start:     2 3 4 5
+# Default-Stop:      0 1 6
+# Short-Description: Apple Push Notification Server Daemon
+### END INIT INFO
+
+# Author: Philipp Schmid <philipp.schmid@openresearch.com>
+
+PATH=/sbin:/usr/sbin:/bin:/usr/bin
+DESC="Apple Push Notification Server Daemon"
+NAME=apnserverd
+DAEMON=/usr/bin/$NAME
+PEMPATH=""
+DAEMON_ARGS="--daemon --pem $PEMPATH"
+PIDFILE=/var/run/$NAME.pid
+SCRIPTNAME=/etc/init.d/$NAME
+
+# Exit if the package is not installed
+[ -x "$DAEMON" ] || exit 0
+
+# Load the VERBOSE setting and other rcS variables
+. /lib/init/vars.sh
+
+# Define LSB log_* functions.
+# Depend on lsb-base (>= 3.0-6) to ensure that this file is present.
+. /lib/lsb/init-functions
+
+#
+# Function that starts the daemon/service
+#
+do_start()
+{
+	# Return
+	#   0 if daemon has been started
+	#   1 if daemon was already running
+	#   2 if daemon could not be started
+	start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON --test > /dev/null \
+		|| return 1
+	start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON -- \
+		$DAEMON_ARGS \
+		|| return 2
+}
+
+#
+# Function that stops the daemon/service
+#
+do_stop()
+{
+	# Return
+	#   0 if daemon has been stopped
+	#   1 if daemon was already stopped
+	#   2 if daemon could not be stopped
+	#   other if a failure occurred
+	start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE --name $NAME
+	RETVAL="$?"
+	[ "$RETVAL" = 2 ] && return 2
+	# Wait for children to finish too if this is a daemon that forks
+	# and if the daemon is only ever run from this initscript.
+	# If the above conditions are not satisfied then add some other code
+	# that waits for the process to drop all resources that could be
+	# needed by services started subsequently.  A last resort is to
+	# sleep for some time.
+	start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON
+	[ "$?" = 2 ] && return 2
+	# Many daemons don't delete their pidfiles when they exit.
+	rm -f $PIDFILE
+	return "$RETVAL"
+}
+
+
+case "$1" in
+  start)
+	[ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
+	do_start
+	case "$?" in
+		0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
+		2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
+	esac
+	;;
+  stop)
+	[ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
+	do_stop
+	case "$?" in
+		0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
+		2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
+	esac
+	;;
+  restart|force-reload)
+	log_daemon_msg "Restarting $DESC" "$NAME"
+	do_stop
+	case "$?" in
+	  0|1)
+		do_start
+		case "$?" in
+			0) log_end_msg 0 ;;
+			1) log_end_msg 1 ;; # Old process is still running
+			*) log_end_msg 1 ;; # Failed to start
+		esac
+		;;
+	  *)
+	  	# Failed to stop
+		log_end_msg 1
+		;;
+	esac
+	;;
+  *)
+	echo "Usage: $SCRIPTNAME {start|stop|restart|force-reload}" >&2
+	exit 3
+	;;
+esac
+
+:

data/lib/apnserver.rb

@@ -1,8 +1,4 @@
 require 'logger'
-require 'eventmachine'
 require 'apnserver/payload'
 require 'apnserver/notification'
-require 'apnserver/protocol'
 require 'apnserver/client'
-require 'apnserver/server_connection'
-require 'apnserver/server'

data/lib/apnserver/client.rb

@@ -3,40 +3,39 @@ require 'socket'
 
 module ApnServer
   class Client
-    
     attr_accessor :pem, :host, :port, :password
-    
+
     def initialize(pem, host = 'gateway.push.apple.com', port = 2195, pass = nil)
       @pem, @host, @port, @password = pem, host, port, pass
     end
-    
+
     def connect!
       raise "The path to your pem file is not set." unless self.pem
       raise "The path to your pem file does not exist!" unless File.exist?(self.pem)
-      
+
       @context      = OpenSSL::SSL::SSLContext.new
       @context.cert = OpenSSL::X509::Certificate.new(File.read(self.pem))
       @context.key  = OpenSSL::PKey::RSA.new(File.read(self.pem), self.password)
-      
+
       @sock         = TCPSocket.new(self.host, self.port.to_i)
       @ssl          = OpenSSL::SSL::SSLSocket.new(@sock, @context)
       @ssl.connect
-      
+
       return @sock, @ssl
     end
-    
+
     def disconnect!
       @ssl.close
       @sock.close
       @ssl = nil
       @sock = nil
     end
-    
+
     def write(notification)
-      puts "#{Time.now} [#{host}:#{port}] Device: #{notification.device_token.unpack('H*')} sending #{notification.json_payload}"
+      Config.logger.debug "#{Time.now} [#{host}:#{port}] Device: #{notification.device_token.unpack('H*')} sending #{notification.json_payload}"
       @ssl.write(notification.to_bytes)
     end
-    
+
     def connected?
       @ssl
     end