bpoweski-apnserver 0.0.9 → 0.0.10

data/README.textile

@@ -1,38 +1,38 @@
-h1. apnserver
+h1. Apple Push Notification Server Toolkit
 
 * http://github.com/bpoweski/apnserver
 
-h2. DESCRIPTION:
+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. FEATURES/PROBLEMS:
+h2. APN Server Daemon
 
-* FIX (list of features or problems)
-
-h2. SYNOPSIS:
-
-Usagge: apnserverd [options] --pem /path/to/pem
    
 <pre>
   <code>
-  --bind-address bind address (defaults to 0.0.0.0)</i>::
-	bind address of the server daemon
-	
+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)
+    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
+    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  
@@ -43,19 +43,42 @@ Usagge: apnserverd [options] --pem /path/to/pem
   </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>
+
 
-h2. INSTALL:
+h2. Installation
 
 To install apnserver execute the following gem command:
 
+<pre>
 <code>
-</pre>
   $ gem install bpoweski-apnserver --source http://gems.github.com
-</pre>
 </code>
+</pre>
   
 
-h2. LICENSE:
+h2. License
 
 (The MIT License)
 
@@ -78,4 +101,4 @@ 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.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/VERSION

@@ -1 +1 @@
-0.0.9
+0.0.10

data/apnserver.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{apnserver}
-  s.version = "0.0.9"
+  s.version = "0.0.10"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Poweski"]
-  s.date = %q{2009-09-15}
+  s.date = %q{2009-09-16}
   s.description = %q{A toolkit for proxying and sending Apple Push Notifications}
   s.email = %q{bpoweski@3factors.com}
   s.executables = ["apnsend", "apnserverd"]
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
      "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/bin/apnsend

@@ -34,10 +34,7 @@ opts = GetoptLong.new(
   ["--help", "-h", GetoptLong::NO_ARGUMENT]
 )
 
-port = nil
-server = nil
 notification = ApnServer::Notification.new
-pem = nil
 
 opts.each do |opt, arg|
   case opt
@@ -45,11 +42,11 @@ opts.each do |opt, arg|
     usage
     exit
   when '--server'
-    server = arg
+    ApnServer::Config.host = arg
   when '--port'
-    port = arg
+    ApnServer::Config.port = arg.to_i
   when '--pem'
-    pem = arg
+    ApnServer::Config.pem = arg
   when '--alert'
     notification.alert = arg
   when '--sound'
@@ -65,20 +62,9 @@ opts.each do |opt, arg|
   end
 end
 
-
 if notification.device_token.nil?
   usage  
   exit
-end
-  
-if pem.nil?
-  @client = TCPSocket.new(server || 'localhost', port || 22195)
-  @client.write(notification.to_bytes)  
 else
-  @client = ApnServer::Client.new(pem, server || 'gateway.push.apple.com', port || 2195)
-  @client.connect!
-  @client.write(notification)
+  notification.push
 end
-  
-
-

data/lib/apnserver/notification.rb

@@ -3,11 +3,19 @@ require 'json'
 
 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|
@@ -22,6 +30,17 @@ module ApnServer
       p
     end
     
+    def push
+      if Config.pem.nil?
+        socket = TCPSocket.new(Config.host || 'localhost', Config.port.to_i || 22195)
+        socket.write(notification.to_bytes)  
+      else
+        client = ApnServer::Client.new(Config.pem, Config.host || 'gateway.push.apple.com', Config.port.to_i || 2195)
+        client.connect!
+        client.write(notification)
+      end      
+    end
+    
     def to_bytes
       json = json_payload
       [0, 0, device_token.size, device_token, 0, json.size, json].pack("ccca*cca*")

data/lib/apnserver/sender.rb

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

data/test/test_helper.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bpoweski-apnserver
 version: !ruby/object:Gem::Version 
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors: 
 - Ben Poweski
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-15 00:00:00 -07:00
+date: 2009-09-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -63,6 +63,7 @@ files:
 - 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