apnserver 0.1.9

data/README.textile

@@ -0,0 +1,166 @@
+h1. Apple Push Notification Server Toolkit
+
+* http://github.com/bpoweski/apnserver
+
+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 
+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
+
+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 
+    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 
+    # openssl pkcs12 -in cert.p12 -out cert.pem -nodes -clcerts
+ 
+  --help
+    usage message  
+  
+  --daemon
+    Runs process as daemon, not available on Windows
+  </code>
+</pre>
+
+h2. APN Server Client
+
+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.
+
+<pre>
+  <code>
+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 
+                                       defaults to gateway.push.apple.com:2195
+  --alert <message>                    the message to send"
+  --sound <default>                    the sound to play, defaults to 'default'
+  --badge <number>                     the badge number
+  --custom <json string>               a custom json string to be added to the main object
+  --b64-token <token>                  a base 64 encoded device token
+  --hex-token <token>                  a hex encoded device token
+  --help                               this message
+  </code>
+</pre>
+
+To send a base64 encoded push notification via the command line execute the following:
+
+<pre>
+  <code>
+  $ apnsend --server gateway.push.apple.com --port 2195 --pem key.pem \
+     --b64-token j92f12jh8lqcAwcOVeSIrsBxibaJ0xyCi8/AkmzNlk8= --sound default \
+     --alert Hello
+  </code>
+</pre>
+
+h2. Sending Notifications from Ruby
+
+To configure the client to send to the local apnserverd process configure the ApnServer client with the following.
+
+<pre>
+  <code>
+  # configured for a using the apnserverd proxy
+  ApnServer::Config.host = 'localhost'
+  ApnServer::Config.port = 22195
+  </code>
+</pre>
+
+To configure the client to send directly to Apple's push notification server, bypassing the apnserverd process configure the following.
+
+<pre>
+  <code>
+  ApnServer::Config.pem = '/path/to/pem'
+  ApnServer::Config.host = 'gateway.push.apple.com'
+  ApnServer::Config.port = 2195
+  </code>
+</pre>
+
+Finally within we can send a push notification using the following code
+
+<pre>
+  <code>
+  notification = ApnServer::Notification.new
+  notification.device_token = Base64.decode64(apns_token) # if base64 encoded
+  notification.alert = message
+  notification.badge = 1
+  notification.sound = 'default'
+  notification.push
+  </code>
+</pre>
+
+
+h2. Installation
+
+To install apnserver execute the following gem command:
+
+<pre>
+<code>
+  $ gem install bpoweski-apnserver --source http://gems.github.com
+</code>
+</pre>
+
+Adding apnserver to your Rails application
+
+<pre>
+  <code>
+  config.gem "bpoweski-apnserver", :lib => 'apnserver', :source => "http://gems.github.com"
+  </code>
+</pre>
+
+h2. License
+
+(The MIT License)
+
+Copyright (c) 2009 Ben Poweski
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/Rakefile

@@ -0,0 +1,34 @@
+require 'rubygems'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "apnserver"
+    gemspec.summary = "Apple Push Notification Server"
+    gemspec.description = "A toolkit for proxying and sending Apple Push Notifications"
+    gemspec.email = "bpoweski@3factors.com"
+    gemspec.homepage = "http://github.com/bpoweski/apnserver"
+    gemspec.authors = ["Ben Poweski"]
+    gemspec.add_dependency 'eventmachine'
+    gemspec.add_dependency 'daemons'
+    gemspec.add_dependency 'json'
+    gemspec.rubyforge_project = 'apnserver'
+    gemspec.files = FileList['lib/**/*.rb', 'bin/*', '[A-Z]*', 'test/**/*'].to_a
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.test_files = FileList.new('test/**/test_*.rb') do |list|
+    list.exclude 'test/test_helper.rb'
+  end
+  test.libs << 'test'
+  test.verbose = true
+end
+
+Jeweler::RubyforgeTasks.new do |rubyforge|
+end
+
+task :default => [:test]

data/VERSION

@@ -0,0 +1 @@
+0.1.9

data/bin/apnsend

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'logger'
+require 'getoptlong'
+require 'rubygems'
+require 'apnserver'
+require 'base64'
+require 'socket'
+
+def usage
+  puts "Usage: apnsend [switches] (--b64-token | --hex-token) <token>"
+  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 " --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 " --b64-token <token>                  a base 64 encoded device token"
+  puts " --hex-token <token>                  a hex encoded device token"  
+  puts " --help                               this message"
+end
+
+opts = GetoptLong.new(
+  ["--server", "-s", GetoptLong::REQUIRED_ARGUMENT],
+  ["--port", "-p", GetoptLong::REQUIRED_ARGUMENT],
+  ["--pem", "-c", GetoptLong::REQUIRED_ARGUMENT],
+  ["--alert", "-a", GetoptLong::REQUIRED_ARGUMENT],
+  ["--sound", "-S", GetoptLong::REQUIRED_ARGUMENT],
+  ["--badge", "-b", 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]
+)
+
+notification = ApnServer::Notification.new
+
+opts.each do |opt, arg|
+  case opt
+  when '--help'
+    usage
+    exit
+  when '--server'
+    ApnServer::Config.host = arg
+  when '--port'
+    ApnServer::Config.port = arg.to_i
+  when '--pem'
+    ApnServer::Config.pem = arg
+  when '--alert'
+    notification.alert = arg
+  when '--sound'
+    notification.sound = arg
+  when '--badge'
+    notification.badge = arg.to_i
+  when '--custom'
+    notification.custom = arg
+  when '--b64-token'
+    notification.device_token = Base64::decode64(arg)
+  when '--hex-token'
+    notification.device_token  = arg.unpack('H*')
+  end
+end
+
+if notification.device_token.nil?
+  usage  
+  exit
+else
+  notification.push
+end

data/bin/apnserverd

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'getoptlong'
+require 'rubygems'
+require 'daemons'
+require 'apnserver'
+
+def usage
+  puts "Usage: apnserverd [switches] --pem <path>"
+  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 " --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
+  open(@pid_file,"w") do |f|
+    f.write(Process.pid)
+    File.chmod(0644, @pid_file)
+  end 
+end
+
+opts = GetoptLong.new(
+  ["--bind-address", "-b", GetoptLong::REQUIRED_ARGUMENT],
+  ["--proxy-port", "-P", GetoptLong::REQUIRED_ARGUMENT],
+  ["--server", "-s", GetoptLong::REQUIRED_ARGUMENT],
+  ["--port", "-p", GetoptLong::REQUIRED_ARGUMENT],
+  ["--pem", "-c", GetoptLong::REQUIRED_ARGUMENT],
+  ["--help", "-h", GetoptLong::NO_ARGUMENT],
+  ["--daemon", "-d", GetoptLong::NO_ARGUMENT]
+)
+
+bind_address = '0.0.0.0'
+proxy_port = 22195
+host = 'gateway.push.apple.com'
+port = 2195
+pem = nil
+daemon = false
+
+opts.each do |opt, arg|
+  case opt
+  when '--help'
+    usage
+  when '--bind-address'
+    bind_address = arg
+  when '--proxy-port'
+    proxy_port = arg.to_i
+  when '--server'
+  	host = arg
+  when '--port'
+  	port = arg.to_i
+  when '--pem'
+    pem = arg
+  when '--daemon'
+    daemon = true
+  end
+end
+
+if pem.nil?
+  usage
+  exit 1
+else
+  daemonize if daemon
+  server = ApnServer::Server.new(pem, bind_address, proxy_port)
+  server.client.host = host
+  server.client.port = port
+  server.start!
+end

data/bin/apnserverd.fedora.init

@@ -0,0 +1,71 @@
+#!/bin/bash
+#
+#       /etc/rc.d/init.d/apnserverd
+# apnserverd    This shell script takes care of starting and stopping
+#               the APN Server Proxy
+#
+# chkconfig: 345 20 80
+# Author: Ben Poweski bpoweski@gmail.com
+#
+# Source function library.
+. /etc/init.d/functions
+
+NAME=apnserverd
+APNSERVERD=/usr/bin/$NAME
+PIDFILE=/var/run/$NAME.pid
+
+if [ -f /etc/sysconfig/$NAME ]; then
+        . /etc/sysconfig/$NAME
+fi
+
+
+start() {
+        echo -n "Starting APN Server:  "
+        if [ -f $PIDFILE ]; then
+                PID=`cat $PIDFILE`
+                echo $NAME already running: $PID
+                exit 2;
+        elif [ -f $PIDFILE ]; then
+                PID=`cat $PIDFILE`
+                echo $NAME already running: $PID
+                exit 2;
+        else
+                daemon $APNSERVERD $OPTIONS
+                RETVAL=$?
+		echo 
+                [ $RETVAL -eq 0 ] && touch /var/lock/subsys/$NAME
+                return $RETVAL
+        fi
+
+}
+
+stop() {
+        echo -n "Shutting down APN Server: "
+        echo
+        kill `cat $PIDFILE`
+        echo
+        rm -f /var/lock/subsys/$NAME
+		rm -f $PIDFILE
+        return 0
+}
+
+case "$1" in
+    start)
+        start
+        ;;
+    stop)
+        stop
+        ;;
+    status)
+        status $NAME
+        ;;
+    restart)
+        stop
+        start
+        ;;
+    *)
+        echo "Usage:  {start|stop|status|restart}"
+        exit 1
+        ;;
+esac
+exit $?

data/lib/apnserver.rb

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

@@ -0,0 +1,44 @@
+require 'openssl'
+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}"
+      @ssl.write(notification.to_bytes)
+    end
+    
+    def connected?
+      @ssl
+    end
+  end
+end

data/lib/apnserver/notification.rb

@@ -0,0 +1,92 @@
+require 'apnserver/payload'
+require 'json'
+require 'json/add/rails'
+require 'base64'
+
+module ApnServer
+  
+  class Config
+    class << self
+      attr_accessor :host, :port, :pem, :password
+    end
+  end
+  
+  
+  class Notification
+    include ApnServer::Payload
+    
+    attr_accessor :device_token, :alert, :badge, :sound, :custom
+    
+    
+    def payload
+      p = Hash.new
+      [:badge, :alert, :sound, :custom].each do |k|
+        p[k] = send(k) if send(k)        
+      end
+      create_payload(p)
+    end
+    
+    def json_payload      
+      j = defined?(Rails) ? payload.to_json : JSON.generate(payload)
+      raise PayloadInvalid.new("The payload is larger than allowed: #{j.length}") if j.size > 256
+      j
+    end
+    
+    def push
+      if Config.pem.nil?
+        socket = TCPSocket.new(Config.host || 'localhost', Config.port.to_i || 22195)
+        socket.write(to_bytes)  
+        socket.close
+      else
+        client = ApnServer::Client.new(Config.pem, Config.host || 'gateway.push.apple.com', Config.port.to_i || 2195)
+        client.connect!
+        client.write(self)
+        client.disconnect!
+      end      
+    end
+    
+    def to_bytes
+      j = json_payload
+      [0, 0, device_token.size, device_token, 0, j.size, j].pack("ccca*cca*")
+    end
+    
+    def self.valid?(p)
+      begin
+        Notification.parse(p)
+      rescue PayloadInvalid => p
+        puts "PayloadInvalid: #{p}"
+        false
+      rescue JSON::ParserError => p
+        false
+      rescue RuntimeError
+        false
+      end
+    end
+    
+    def self.parse(p)
+      buffer = p.dup
+      notification = Notification.new
+      
+      header = buffer.slice!(0, 3).unpack('ccc')
+      if header[0] != 0
+        raise RuntimeError.new("Header of notification is invalid: #{header.inspect}")
+      end
+            
+      # parse token
+      notification.device_token = buffer.slice!(0, 32).unpack('a*').first
+      
+      # parse json payload
+      payload_len = buffer.slice!(0, 2).unpack('CC')
+      j = buffer.slice!(0, payload_len.last)
+      result = JSON.parse(j)
+      
+      ['alert', 'badge', 'sound'].each do |k|
+        notification.send("#{k}=", result['aps'][k]) if result['aps'] && result['aps'][k]
+      end
+      result.delete('aps')
+      notification.custom = result
+      
+      notification
+    end
+  end
+end

data/lib/apnserver/payload.rb

@@ -0,0 +1,23 @@
+module ApnServer
+  
+  module Payload
+    
+    class PayloadInvalid < RuntimeError
+    end
+    
+    def create_payload(payload)
+      case payload
+        when String then { :aps => { :alert =>  payload } }
+        when Hash then create_payload_from_hash(payload)
+      end
+    end
+    
+    def create_payload_from_hash(payload)
+      custom = payload.delete(:custom)
+      aps = {:aps => payload }
+      aps.merge!(custom) if custom
+      aps
+    end
+  end
+  
+end

data/lib/apnserver/protocol.rb

@@ -0,0 +1,24 @@
+module ApnServer
+  module Protocol
+    
+    def post_init
+      @address = Socket.unpack_sockaddr_in(self.get_peername)
+      puts "#{Time.now} [#{address.last}:#{address.first}] CONNECT"
+    end
+    
+    def unbind
+      puts "#{Time.now} [#{address.last}:#{address.first}] DISCONNECT"    
+    end
+    
+    def receive_data(data)
+      (@buf ||= "") << data
+      if notification = ApnServer::Notification.valid?(@buf)
+        puts "#{Time.now} [#{address.last}:#{address.first}] found valid Notification: #{notification}"
+        queue.push(notification)
+      else
+        puts "#{Time.now} [#{address.last}:#{address.first}] invalid notification: #{@buf}"
+      end
+    end
+    
+  end
+end

data/lib/apnserver/server.rb

@@ -0,0 +1,45 @@
+module ApnServer
+  
+  class Server
+    attr_accessor :client, :bind_address, :port
+    
+    def initialize(pem, bind_address = '0.0.0.0', port = 22195)
+      @queue = EM::Queue.new
+      @client = ApnServer::Client.new(pem)
+      @bind_address, @port = bind_address, port
+    end
+    
+    def start!
+      EventMachine::run do
+        puts "#{Time.now} Starting APN Server on #{bind_address}:#{port}"
+        
+        EM.start_server(bind_address, port, ApnServer::ServerConnection) do |s|
+          s.queue = @queue
+        end 
+         
+        EventMachine::PeriodicTimer.new(1) do
+          unless @queue.empty?
+            size = @queue.size
+            size.times do 
+              @queue.pop do |notification|
+                begin
+                  @client.connect! unless @client.connected?
+                  @client.write(notification)
+                rescue Errno::EPIPE
+                  puts "Caught Errno::EPIPE adding notification back to queue"
+                  @queue.push(notification)
+                rescue OpenSSL::SSL::SSLError
+                  puts "Caught OpenSSL Error, closing connecting and adding notification back to queue"
+                  @client.disconnect!
+                  @queue.push(notification)
+                rescue RuntimeError => e
+                  puts "Unable to handle: #{e}"
+                end
+              end
+            end
+          end
+        end
+      end   
+    end
+  end
+end

data/lib/apnserver/server_connection.rb

@@ -0,0 +1,9 @@
+require 'socket'
+require 'apnserver/protocol'
+
+module ApnServer
+  class ServerConnection < EventMachine::Connection
+    include Protocol
+    attr_accessor :queue, :address
+  end
+end

data/test/test_client.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class TestClient < Test::Unit::TestCase
+  
+  def test_creates_client
+    client = ApnServer::Client.new('cert.pem', 'gateway.sandbox.push.apple.com', 2196)
+    assert_equal 'cert.pem', client.pem
+    assert_equal 'gateway.sandbox.push.apple.com', client.host
+    assert_equal 2196, client.port
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'stringio'
+require 'test/unit'
+require 'rubygems'
+require File.dirname(__FILE__) + '/../lib/apnserver'

data/test/test_notification.rb

@@ -0,0 +1,79 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require 'base64'
+
+class NotificationTest < Test::Unit::TestCase
+  include ApnServer
+  
+  def setup
+    @notification = Notification.new
+  end
+  
+  def test_should_generate_byte_array
+    payload = '{"aps":{"alert":"You have not mail!"}}'
+    device_token = "12345678123456781234567812345678"
+    @notification.device_token = device_token
+    @notification.alert = "You have not mail!"
+    expected = [0, 0, device_token.size, device_token, 0, payload.size, payload]
+    assert_equal expected.pack("ccca*CCa*"), @notification.to_bytes
+  end
+  
+  def test_should_create_payload_with_badge_attribute
+    expected = { :aps => { :badge => 1 }}
+    @notification.badge = 1
+    assert_equal expected, @notification.payload
+  end
+  
+  def test_should_create_payload_with_alert_attribute
+    expected = { :aps => { :alert => 'Hi' }}
+    @notification.alert = 'Hi'
+    assert_equal expected, @notification.payload  
+  end
+  
+  def test_should_create_json_payload
+    expected = '{"aps":{"alert":"Hi"}}'
+    @notification.alert = 'Hi'
+    assert_equal expected, @notification.json_payload
+  end
+  
+  def test_should_not_allow_for_payloads_larger_than_256_chars
+    assert_raise Payload::PayloadInvalid do 
+      alert = []
+      256.times { alert << 'Hi' }
+      @notification.alert = alert.join
+      @notification.json_payload
+    end
+  end
+  
+  def test_should_recognize_valid_request
+    device_token = '12345678123456781234567812345678'
+    payload = '{"aps":{"alert":"You have not mail!"}}'
+    request = [0, 0, device_token.size, device_token, 0, payload.size, payload].pack("CCCa*CCa*")
+    assert Notification.valid?(request)
+    notification = Notification.parse(request)
+    assert_equal device_token, notification.device_token
+    assert_equal "You have not mail!", notification.alert
+  end
+  
+  def test_should_not_recognize_invalid_request
+    device_token = '123456781234567812345678'
+    payload = '{"aps":{"alert":"You have not mail!"}}'
+    request = [0, 0, 32, device_token, 0, payload.size, payload].pack("CCCa*CCa*")
+    assert !Notification.valid?(request), request
+  end
+  
+  def test_should_pack_and_unpack_json
+    device_token = '12345678123456781234567812345678'
+    notification = Notification.new
+    notification.device_token = device_token
+    notification.badge = 10
+    notification.alert = 'Hi'
+    notification.sound = 'default'
+    notification.custom = { 'acme1' => "bar", 'acme2' => 42}
+    
+    parsed = Notification.parse(notification.to_bytes)
+    [:device_token, :badge, :alert, :sound, :custom].each do |k|
+      expected = notification.send(k)
+      assert_equal expected, parsed.send(k), "Expected #{k} to be #{expected}"
+    end
+  end
+end

data/test/test_payload.rb

@@ -0,0 +1,59 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class NotificationTest < Test::Unit::TestCase
+  include ApnServer::Payload
+  
+  def test_should_create_payload_with_simple_string
+    expected = { :aps => { :alert => 'Hi' }}
+    assert_equal expected, create_payload('Hi')
+  end
+  
+  def test_should_create_payload_with_alert_key
+    expected = { :aps => { :alert => 'Hi' }}
+    assert_equal expected, create_payload(:alert => 'Hi')    
+  end
+  
+  def test_should_create_payload_with_badge_and_alert
+    expected = { :aps => { :alert => 'Hi', :badge => 1 }}
+    assert_equal expected, create_payload(:alert => 'Hi', :badge => 1)
+  end
+  
+  # example 1
+  def test_should_create_payload_with_custom_payload
+    alert = 'Message received from Bob'
+    expected = {
+      :aps => { :alert => alert },
+      :acme2 => [ "bang",  "whiz" ]
+    }
+    assert_equal expected, create_payload(:alert => alert, :custom => { :acme2 => ['bang', 'whiz']})
+  end
+  
+  # example 3
+  def test_should_create_payload_with_sound_and_multiple_custom
+    expected = {
+      :aps => {
+        :alert => "You got your emails.",
+        :badge => 9,
+        :sound => "bingbong.aiff"
+      },
+      :acme1 => "bar",
+      :acme2 => 42     
+    }
+    assert_equal expected, create_payload({
+      :alert => "You got your emails.",
+      :badge => 9,
+      :sound => "bingbong.aiff", 
+      :custom => { :acme1 => "bar", :acme2 => 42}
+    })
+  end
+  
+  # example 5
+  def test_should_create_payload_with_empty_aps
+    expected = {
+      :aps => {},
+      :acme2 => [ 5,  8 ]
+    }
+    assert_equal expected, create_payload(:custom => { :acme2 => [ 5,  8 ] })
+  end
+  
+end

data/test/test_protocol.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestServer
+  attr_accessor :queue
+  include ApnServer::Protocol
+  
+  def address
+    [12345, '127.0.0.1']
+  end
+end
+
+class TestProtocol < Test::Unit::TestCase
+  
+  def setup
+    @server = TestServer.new
+    @server.queue = Array.new # fake out EM::Queue
+  end
+  
+  def test_adds_notification_to_queue
+    token = "12345678123456781234567812345678"
+    @server.receive_data("\0\0 #{token}\0#{22.chr}{\"aps\":{\"alert\":\"Hi\"}}")
+    assert_equal 1, @server.queue.size
+  end
+  
+  def test_does_not_add_invalid_notification
+    @server.receive_data('fakedata')
+    assert @server.queue.empty?
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: apnserver
+version: !ruby/object:Gem::Version 
+  version: 0.1.9
+platform: ruby
+authors: 
+- Ben Poweski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-25 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: daemons
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A toolkit for proxying and sending Apple Push Notifications
+email: bpoweski@3factors.com
+executables: 
+- apnsend
+- apnserverd
+- apnserverd.fedora.init
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- README.textile
+- Rakefile
+- VERSION
+- bin/apnsend
+- bin/apnserverd
+- bin/apnserverd.fedora.init
+- lib/apnserver.rb
+- lib/apnserver/client.rb
+- lib/apnserver/notification.rb
+- lib/apnserver/payload.rb
+- lib/apnserver/protocol.rb
+- lib/apnserver/server.rb
+- lib/apnserver/server_connection.rb
+- test/test_client.rb
+- test/test_helper.rb
+- test/test_notification.rb
+- test/test_payload.rb
+- test/test_protocol.rb
+has_rdoc: true
+homepage: http://github.com/bpoweski/apnserver
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: apnserver
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Apple Push Notification Server
+test_files: 
+- test/test_client.rb
+- test/test_helper.rb
+- test/test_notification.rb
+- test/test_payload.rb
+- test/test_protocol.rb