apnserver 0.1.10 → 0.2.1

data/lib/apnserver/notification.rb

@@ -1,91 +1,90 @@
 require 'apnserver/payload'
-require 'json'
-require 'json/add/rails'
 require 'base64'
+require 'active_support/ordered_hash'
+require 'active_support/json'
 
 module ApnServer
-  
   class Config
     class << self
-      attr_accessor :host, :port, :pem, :password
+      attr_accessor :host, :port, :pem, :password, :logger
     end
   end
-  
-  
+
+  Config.logger = Logger.new("/dev/null")
+
   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)        
+        p[k] = send(k) if send(k)
       end
       create_payload(p)
     end
-    
-    def json_payload      
-      j = defined?(Rails) ? payload.to_json : JSON.generate(payload)
+
+    def json_payload
+      j = ActiveSupport::JSON.encode(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.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
     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
+        Config.logger.error "PayloadInvalid: #{p}"
         false
       rescue RuntimeError
         false
+      rescue Exception => e
+        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)
-      
+      result = ActiveSupport::JSON.decode(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

data/lib/apnserver/payload.rb

@@ -1,17 +1,14 @@
 module ApnServer
-  
   module Payload
-    
-    class PayloadInvalid < RuntimeError
-    end
-    
+    PayloadInvalid = Class.new(RuntimeError)
+
     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 }
@@ -19,5 +16,4 @@ module ApnServer
       aps
     end
   end
-  
 end

data/lib/apnserver/protocol.rb

@@ -1,24 +1,22 @@
 module ApnServer
   module Protocol
-    
     def post_init
       @address = Socket.unpack_sockaddr_in(self.get_peername)
-      puts "#{Time.now} [#{address.last}:#{address.first}] CONNECT"
+      Config.logger.debug "#{Time.now} [#{address.last}:#{address.first}] CONNECT"
     end
-    
+
     def unbind
-      puts "#{Time.now} [#{address.last}:#{address.first}] DISCONNECT"    
+      Config.logger.debug "#{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}"
+        Config.logger.debug "#{Time.now} [#{address.last}:#{address.first}] found valid Notification: #{notification}"
         queue.push(notification)
       else
-        puts "#{Time.now} [#{address.last}:#{address.first}] invalid notification: #{@buf}"
+        Config.logger.debug "#{Time.now} [#{address.last}:#{address.first}] invalid notification: #{@buf}"
       end
     end
-    
   end
 end

data/lib/apnserver/server.rb

@@ -1,42 +1,41 @@
 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}"
-        
+        Config.logger.info "#{Time.now} Starting APN Server on #{bind_address}:#{port}"
+
         EM.start_server(bind_address, port, ApnServer::ServerConnection) do |s|
           s.queue = @queue
-        end 
-         
+        end
+
         EventMachine::PeriodicTimer.new(1) do
           unless @queue.empty?
             size = @queue.size
-            size.times do 
+            size.times do
               @queue.pop do |notification|
                 begin
                   @client.connect! unless @client.connected?
                   @client.write(notification)
                 rescue Errno::EPIPE, OpenSSL::SSL::SSLError
-                  puts "Caught Error, closing connecting and adding notification back to queue"
+                  Config.logger.error "Caught Error, closing connecting and adding notification back to queue"
                   @client.disconnect!
                   @queue.push(notification)
                 rescue RuntimeError => e
-                  puts "Unable to handle: #{e}"
+                  Config.logger.error "Unable to handle: #{e}"
                 end
               end
             end
           end
         end
-      end   
+      end
     end
   end
 end

data/spec/models/client_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+module ApnServer
+  describe Client do
+    describe "#new" do
+      let(:client) { ApnServer::Client.new('cert.pem', 'gateway.sandbox.push.apple.com', 2196) }
+
+      it "sets the pem path" do
+        client.pem.should == 'cert.pem'
+      end
+
+      it "sets the host" do
+        client.host.should == 'gateway.sandbox.push.apple.com'
+      end
+
+      it "sets the port" do
+        client.port.should == 2196
+      end
+    end
+  end
+end

data/spec/models/notification_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+module ApnServer
+  describe Notification do
+    let(:notification) { Notification.new }
+
+    describe "#to_bytes" do
+      it "generates a byte array" do
+        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]
+        notification.to_bytes.should == expected.pack("ccca*CCa*")
+      end
+    end
+
+    describe "#payload" do
+      it "generates the badge element" do
+        expected = { :aps => { :badge => 1 }}
+        notification.badge = 1
+        notification.payload.should == expected
+      end
+
+      it "generates the alert alement" do
+        expected = { :aps => { :alert => 'Hi' }}
+        notification.alert = 'Hi'
+        notification.payload.should == expected
+      end
+    end
+
+    describe "#json_payload" do
+      it "converts payload to json" do
+        expected = '{"aps":{"alert":"Hi"}}'
+        notification.alert = 'Hi'
+        notification.json_payload.should == expected
+      end
+
+      it "does not allow payloads larger than 256 chars" do
+        lambda {
+          alert = []
+          256.times { alert << 'Hi' }
+          notification.alert = alert.join
+          notification.json_payload
+        }.should raise_error(Payload::PayloadInvalid)
+      end
+    end
+
+    describe "#valid?" do
+      it "recognizes a valid request" do
+        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*")
+        Notification.valid?(request).should be_true
+        notification = Notification.parse(request)
+        notification.device_token.should == device_token
+        notification.alert.should == "You have not mail!"
+      end
+
+      it "recognizes an invalid request" do
+        device_token = '123456781234567812345678'
+        payload = '{"aps":{"alert":"You have not mail!"}}'
+        request = [0, 0, 32, device_token, 0, payload.size, payload].pack("CCCa*CCa*")
+        Notification.valid?(request).should be_false
+      end
+    end
+
+    describe "#parse" do
+      it "reads a byte array and constructs a notification" do
+        device_token = '12345678123456781234567812345678'
+        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)
+          parsed.send(k).should == expected
+        end
+      end
+    end
+  end
+end

data/spec/models/payload_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+module ApnServer
+  describe Payload do
+    describe "#payload.create_payload" do
+      let(:payload) { Class.new.send(:include, Payload).new }
+
+      it "creates a payload_with_simple_string" do
+        payload.create_payload('Hi').should == { :aps => { :alert => 'Hi' }}
+      end
+
+      it "creates a payload_with_alert_key" do
+        payload.create_payload(:alert => 'Hi').should == { :aps => { :alert => 'Hi' }}
+      end
+
+      it "creates payload with badge_and_alert" do
+        payload.create_payload(:alert => 'Hi', :badge => 1).should == { :aps => { :alert => 'Hi', :badge => 1 }}
+      end
+
+      # example 1
+      it "test_should_payload.create_payload_with_custom_payload" do
+        alert = 'Message received from Bob'
+        payload.create_payload(:alert => alert, :custom => { :acme2 => ['bang', 'whiz']}).should == {
+          :aps => { :alert => alert },
+          :acme2 => [ "bang",  "whiz" ]
+        }
+      end
+
+      # example 3
+      it "test_should_payload.create_payload_with_sound_and_multiple_custom" do
+        expected = {
+          :aps => {
+            :alert => "You got your emails.",
+            :badge => 9,
+            :sound => "bingbong.aiff"
+          },
+          :acme1 => "bar",
+          :acme2 => 42
+        }
+        payload.create_payload({
+          :alert => "You got your emails.",
+          :badge => 9,
+          :sound => "bingbong.aiff",
+          :custom => { :acme1 => "bar", :acme2 => 42}
+        }).should == expected
+      end
+
+      # example 5
+      it "test_should_payload.create_payload_with_empty_aps" do
+        payload.create_payload(:custom => { :acme2 => [ 5,  8 ] }).should == {
+          :aps => {},
+          :acme2 => [ 5,  8 ]
+        }
+      end
+    end
+  end
+end

data/spec/models/protocol_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe "TestProtocol" do
+  before(:each) do
+    @server = TestServer.new
+    @server.queue = Array.new # fake out EM::Queue
+  end
+
+  it "adds_notification_to_queue" do
+    token = "12345678123456781234567812345678"
+    @server.receive_data("\0\0 #{token}\0#{22.chr}{\"aps\":{\"alert\":\"Hi\"}}")
+    @server.queue.size.should == 1
+  end
+
+  it "does_not_add_invalid_notification" do
+    @server.receive_data('fakedata')
+    @server.queue.should be_empty
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+
+# Set up gems listed in the Gemfile.
+gemfile = File.expand_path('../Gemfile', File.dirname(__FILE__))
+begin
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+rescue Bundler::GemNotFound => e
+  STDERR.puts e.message
+  STDERR.puts "Try running `bundle install`."
+  exit!
+end
+
+Bundler.require(:spec)
+
+Rspec.configure do |config|
+  config.mock_with :rspec
+end
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+
+require "apnserver"
+require 'base64'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}