bpoweski-apnserver 0.0.12 → 0.0.14

data/README.textile

@@ -10,9 +10,13 @@ opening up and tearing down SSL connections reapeated.  To solve this problem an
 network server is introduced that queues are requests to the APN service and sends them via a 
 persistent connection.
 
+h2. TODO
+ 
+ * Implement feedback service mechanism
+ * Investigate possible badge number issue
+ * Implement a robust logging mechanism for transactions
 
 h2. APN Server Daemon
-
    
 <pre>
   <code>
@@ -66,6 +70,51 @@ Usage: apnsend [switches] (--b64-token | --hex-token) <token>
   </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
 
@@ -76,7 +125,14 @@ To install apnserver execute the following gem command:
   $ 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
 

data/VERSION

@@ -1 +1 @@
-0.0.12
+0.0.14

data/apnserver.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{apnserver}
+  s.version = "0.0.14"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ben Poweski"]
+  s.date = %q{2009-09-17}
+  s.description = %q{A toolkit for proxying and sending Apple Push Notifications}
+  s.email = %q{bpoweski@3factors.com}
+  s.executables = ["apnsend", "apnserverd", "apnserverd.fedora.init"]
+  s.extra_rdoc_files = [
+    "README.textile"
+  ]
+  s.files = [
+    "README.textile",
+     "Rakefile",
+     "VERSION",
+     "apnserver.gemspec",
+     "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"
+  ]
+  s.homepage = %q{http://github.com/bpoweski/apnserver}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Apple Push Notification Server}
+  s.test_files = [
+    "test/test_client.rb",
+     "test/test_helper.rb",
+     "test/test_notification.rb",
+     "test/test_payload.rb",
+     "test/test_protocol.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<eventmachine>, [">= 0"])
+      s.add_runtime_dependency(%q<daemons>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+    else
+      s.add_dependency(%q<eventmachine>, [">= 0"])
+      s.add_dependency(%q<daemons>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<eventmachine>, [">= 0"])
+    s.add_dependency(%q<daemons>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+  end
+end

data/bin/apnsend

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
+require 'logger'
 require 'getoptlong'
 require 'rubygems'
 gem 'bpoweski-apnserver'
@@ -8,6 +9,9 @@ require 'apnserver'
 require 'base64'
 require 'socket'
 
+$logger = Logger.new(STDOUT)
+
+
 def usage
   puts "Usage: apnsend [switches] (--b64-token | --hex-token) <token>"
   puts " --server <localhost>                 the apn server defaults to a locally running apnserverd"

data/bin/apnserverd

@@ -6,6 +6,8 @@ require 'rubygems'
 require 'daemons'
 require 'apnserver'
 
+$logger = Logger.new(STDOUT)
+
 def usage
   puts "Usage: apnserverd [switches] --pem <path>"
   puts " --bind-address [0.0.0.0]             bind address of proxy"
@@ -58,6 +60,7 @@ opts.each do |opt, arg|
     pem = arg
   when '--daemon'
     daemon = true
+    $logger = Logger.new('/var/log/apnserverd.log', 'weekly')
   end
 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/client.rb

@@ -31,7 +31,7 @@ module ApnServer
     end
     
     def write(notification)
-      puts "#{Time.now} [#{host}:#{port}] sending #{notification.alert}"
+      $logger.info "[#{host}:#{port}] Device: #{notification.device_token.unpack('H*')} sending #{notification.json_payload}"
       @ssl.write(notification.to_bytes)
     end
     

data/lib/apnserver/protocol.rb

@@ -3,11 +3,11 @@ module ApnServer
     
     def post_init
       @address = Socket.unpack_sockaddr_in(self.get_peername)
-      puts "#{Time.now} [#{address.last}:#{address.first}] CONNECT"
+      $logger.debug "[#{address.last}:#{address.first}] CONNECT"
     end
     
     def unbind
-      puts "#{Time.now} [#{address.last}:#{address.first}] DISCONNECT"    
+      $logger.debug  "[#{address.last}:#{address.first}] DISCONNECT"    
     end
     
     def receive_data(data)

data/lib/apnserver/server.rb

@@ -11,7 +11,7 @@ module ApnServer
     
     def start!
       EventMachine::run do
-        puts "#{Time.now} Starting APN Server on #{bind_address}:#{port}"
+        $logger.info "Starting APN Server on #{bind_address}:#{port}"
         
         EM.start_server(bind_address, port, ApnServer::ServerConnection) do |s|
           s.queue = @queue

data/lib/apnserver.rb

@@ -1,3 +1,4 @@
+require 'logger'
 require 'eventmachine'
 require 'apnserver/payload'
 require 'apnserver/notification'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bpoweski-apnserver
 version: !ruby/object:Gem::Version 
-  version: 0.0.12
+  version: 0.0.14
 platform: ruby
 authors: 
 - Ben Poweski
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-16 00:00:00 -07:00
+date: 2009-09-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,6 +47,7 @@ email: bpoweski@3factors.com
 executables: 
 - apnsend
 - apnserverd
+- apnserverd.fedora.init
 extensions: []
 
 extra_rdoc_files: 
@@ -55,14 +56,15 @@ files:
 - README.textile
 - Rakefile
 - VERSION
+- apnserver.gemspec
 - 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/sender.rb
 - lib/apnserver/server.rb
 - lib/apnserver/server_connection.rb
 - test/test_client.rb

data/lib/apnserver/sender.rb

@@ -1,6 +0,0 @@
-module ApnServer
-  
-  module Sender
-    
-  end
-end