bpoweski-apnserver 0.0.2

data/README.rdoc

@@ -0,0 +1,48 @@
+= apnserver
+
+* http://github.com/bpoweski/apnserver
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== 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/bin/apns

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require 'socket'
+require 'base64'
+require 'rubygems'
+
+socket = TCPSocket.new('localhost', 22195)
+token = Base64.decode64(ARGV.last)
+socket.write("\0\0 #{token}\0#{22.chr}{\"aps\":{\"alert\":\"Hi\"}}")
+socket.close

data/bin/apnsend

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+require 'getoptlong'
+require 'rubygems'
+require 'apnserver'
+require 'base64'
+
+client = ApnServer::Client.new(ARGV.first)
+client.connect!
+
+token = Base64.decode64(ARGV.last)
+client.write("\0\0 #{token}\0#{22.chr}{\"aps\":{\"alert\":\"Hi\"}}")

data/bin/apnserverd

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+require 'getoptlong'
+require 'rubygems'
+require 'apnserver'
+require 'daemons'
+
+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
+
+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]
+)
+
+bind_address = '0.0.0.0'
+proxy_port = 22195
+server = 'gateway.push.apple.com'
+port = 2295
+pem = nil
+
+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'
+  	server = arg
+  when '--port'
+  	port = arg
+  when '--pem'
+    pem = arg
+  end
+end
+
+if pem.nil?
+  usage
+else
+  # Become a daemon
+  Daemons.daemonize
+
+  server = ApnServer::Server.new(pem, bind_address, proxy_port)
+  server.start!
+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,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/apnserver'

data/test/test_notification.rb

@@ -0,0 +1,78 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+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 = '12345678123456781234567812345678'
+    payload = '{"aps":{"alert":"You have not mail!"}}'
+    request = [0, 0, 20, device_token, 0, payload.size, payload].pack("ccca*cca*")
+    assert !Notification.valid?(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,79 @@
+--- !ruby/object:Gem::Specification 
+name: bpoweski-apnserver
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Ben Poweski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-14 00:00:00 -07: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: 
+description: A toolkit for proxying and sending Apple Push Notifications
+email: bpoweski@3factors.com
+executables: 
+- apns
+- apnsend
+- apnserverd
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/bpoweski/apnserver
+licenses: 
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+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