apns-pressplane 0.9.10

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+pkg

data/MIT-LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2009 James Pozdena
+Copyright (c) 2010-2011 Thierry Passeron
+ 
+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/README.textile

@@ -0,0 +1,199 @@
+h1. APNS
+
+A plugin/Gem for the Apple Push Notification Service.
+
+The connections to Apple are done on demand (per process) and last until they are either closed by the system or are timed out.
+This is the prefered way for communicating with Apple's push servers.
+
+Works in Ruby on Rails 3.
+
+h2. Install
+
+<pre>
+  <code>
+sudo gem install apns
+  or
+rails plugin install git://...
+  </code>
+</pre>
+
+h2. Setup:
+
+Convert your certificates
+
+In Keychain access export your push certificate(s) as a .p12. Then run the following command to convert each .p12 to a .pem
+
+<pre>
+  <code>
+openssl pkcs12 -in cert.p12 -out cert.pem -nodes -clcerts
+  </code>
+</pre>
+
+After you have your .pem files, copy them to a place where APNS can access them. 
+You will need to register them with APNS before being able to send Notifications
+
+In a Rails project, you can add an initializer to configure the pem(s), with for example:
+
+<pre>
+  <code>
+In file ./config/initializers/APNS.rb:
+
+# Initialize the APNS environment
+APNS.pem = Rails.root.join("config", Rails.env + ".pem") # => ./config/{development,production}.pem
+
+  </code>
+</pre>
+
+h2. Creating a Payload:
+
+Sending a push notification is sending a Payload to Apple's servers.
+
+You may create payloads with APNS::Payload.new(<device-token> [,<message>])
+A payload is composed of a device-token and a message all mixed and encoded together.
+Payload message can either just be a alert string or a hash that lets you specify the alert, badge, sound and any custom field.
+
+<pre>
+  <code>
+device_token = '123abc456def'
+p1 = APNS::Payload.new(device_token, 'Hello iPhone!')
+p2 = APNS::Payload.new(device_token, :alert => 'Hello iPhone!', :badge => 1, :sound => 'default')
+p3 = APNS::Payload.new(device_token).badge(4).alert("Hello iPhone!").sound('bird.aiff')
+
+# with custom data:
+p4 = APNS::Payload.new(device_token, :badge => 2, :my_custom_field => 'blah')
+p5 = APNS::Payload.new(device_token, :badge => 2).custom(:my_custom_field => 'blah')
+  </code>
+</pre>
+
+
+h2. Truncating payload informations
+
+Only valid Payloads will be sent to Apple. From APNS point of view, a valid payload has a size lesser or equal to 256 bytes.
+REM: Apple may find a APNS valid payload invalid because it doesn't contain mandatory fields in the message part. 
+For instance, a message must at least contain a non empty badge or sound or alert.
+
+You can check whether a payload is valid with the Payload#valid? method.
+In case you know a payload message field is too large and wish to have it truncated you can either use Payload#payload_with_truncated_alert or a more generic Payload#payload_with_truncated_string_at_keypath. These two method will try to truncate the value of the alert field or any custom field at a keypath.
+
+Truncate the alert field:
+
+<pre>
+  <code>
+p = APNS::Payload.new("a-device-token", "A very long message "*15)
+p.valid?
+=> false
+p.size
+=> 331
+p.payload_with_truncated_alert.size
+=> 256
+p.payload_with_truncated_alert.valid?
+=> true    
+  </code>
+</pre>
+
+Truncate a custom field:
+
+<pre>
+	<code>
+p = APNS::Payload.new("a-device-token", :alert => "Hello from APNS", :custom => {:foo => "Bar "*80})
+p.valid?
+=> false
+p.size
+=> 387
+p.payload_with_truncated_string_at_keypath("custom.foo").size
+=> 256
+p.payload_with_truncated_string_at_keypath("custom.foo").valid?
+=> true
+	</code>
+</pre>
+
+
+h2. Sending Notifications to a single application:
+
+Before sending notifications, you _must_ have setup the pem file(s) so that Apple knows which application you are sending a notification to.
+
+<pre>
+  <code>
+APNS.pem = "/path/to/my/development.pem"
+  </code>
+</pre>
+
+Now we can send some payloads either with:
+
+  * APNS.send_payloads(<payloads>)
+  * APNS.send(<payloads>) # same as APNS.send_payloads
+
+<pre>
+  <code>
+APNS.send(p1, p2, p3)
+  </code>
+</pre>
+
+h2. Sending Notifications to multiple applications:
+
+You may want to handle push notifications for many applications at once. In this case you have to setup multiple pem streams:
+
+<pre>
+  <code>
+@streams = [:voodoo, :child]
+
+@streams.each do |stream|
+	APNS.pem(stream, "/path/to/#{stream}/development.pem"
+end
+  </code>
+</pre>
+
+Now you can send the notifications to any stream with:
+	
+	* APNS.send_stream(<stream>, <payloads>)
+		
+<pre>
+  <code>
+APNS.send_stream(@streams.first, p1, p2, p3)
+APNS.send_stream(@streams.last, p4, p5)
+  </code>
+</pre>
+    
+
+h2. Feedback queue:
+
+You should check the feedback queue of your application on Apple's servers to avoid sending notifications to obsolete devices
+
+For single pem:
+
+<pre>
+	<code>
+APNS.feedback.each do |time, token|
+	# remove the device registered with this token ?
+end
+	</code>
+</pre>
+
+For multiple pems:
+
+<pre>
+	<code>
+APNS.feedback(@streams.first).each do |time, token|
+	# remove the device registered with this token ?
+end
+	</code>
+</pre>
+
+
+h2. Getting your iPhone's device token
+
+After you setup push notification for your application with Apple. You need to ask Apple for you application specific device token.
+
+In the UIApplicationDelegate
+<pre>
+  <code>
+- (void)applicationDidFinishLaunching:(UIApplication *)application {    
+	[[UIApplication sharedApplication] registerForRemoteNotificationTypes:
+		(UIRemoteNotificationTypeAlert | UIRemoteNotificationTypeSound | UIRemoteNotificationTypeBadge)];	
+}
+
+- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
+	// Do something with the device token
+}
+  </code>
+</pre>

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'date'
+require 'rspec/core/rake_task'
+ 
+GEM = 'apns'
+GEM_NAME = 'apns'
+GEM_VERSION = '0.9.9'
+AUTHORS = ['James Pozdena', 'Thierry Passeron']
+EMAIL = "thierry.passeron@gmail.com"
+HOMEPAGE = "http://github.com/Orion98MC/APNS"
+SUMMARY = "Simple Apple push notification service gem"
+ 
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["MIT-LICENSE"]
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.authors = AUTHORS
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.require_path = 'lib'
+  s.autorequire = GEM
+  s.files = %w(MIT-LICENSE README.textile Rakefile) + Dir.glob("{lib}/**/*")
+end
+ 
+task :default => :spec
+ 
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = %w(-fs --color)
+end
+ 
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+ 
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+ 
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/apns.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{apns-pressplane}
+  s.version = "0.9.10"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["James Pozdena", "Thierry Passeron", "Pressplane Inc."]
+  s.autorequire = %q{apns}
+  s.date = %q{2010-03-22}
+  s.description = %q{Simple Apple push notification service gem}
+  s.email = %q{thierry.passeron@gmail.com}
+  s.extra_rdoc_files = ["MIT-LICENSE"]
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.homepage = %q{http://github.com/Orion98MC/APNS}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Simple Apple push notification service gem}
+
+  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
+    else
+    end
+  else
+  end
+end

data/lib/apns.rb

@@ -0,0 +1,3 @@
+require 'apns/core'
+require 'apns/device'
+require 'apns/payload'

data/lib/apns/core.rb

@@ -0,0 +1,162 @@
+module APNS
+  require 'socket'
+  require 'openssl'
+  require 'json'
+  
+  class PemPathError < RuntimeError;end
+  class PemFileError < RuntimeError;end
+
+  ## Host for push notification service
+  #
+  # production: gateway.push.apple.com
+  # development: gateway.sandbox.apple.com
+  #
+  # You may set the correct host with:
+  # APNS.host = <host> or use the default one
+  @host = 'gateway.sandbox.push.apple.com'
+  @port = 2195
+
+  ## Host for feedback service
+  #
+  # production: feedback.push.apple.com
+  # development: feedback.sandbox.apple.com
+  #  
+  # You may set the correct feedback host with:
+  # APNS.feedback_host = <host> or use the default one
+  @feedback_host = @host.gsub('gateway','feedback')
+  @feedback_port = 2196
+  
+  # openssl pkcs12 -in mycert.p12 -out client-cert.pem -nodes -clcerts
+  @pem = {} # this should be the path of the pem file not the contents
+  @pass = {}
+  
+  # Persistent connection
+  @@ssl = {}
+  @@sock = {}
+    
+  class << self
+    attr_accessor :host, :port, :feedback_host, :feedback_port
+    def pem(stream = :_global, new_pem = nil)
+      @pem[stream] = new_pem if new_pem
+      @pem[stream]
+    end
+    def pem=(new_pem); @pem[:_global] = new_pem; end
+    
+    def pass(stream = :_global, new_pass = nil)
+      @pass[stream] = new_pass if new_pass
+      @pass[stream]
+    end
+    def pass=(new_pass); @pass[:_global] = new_pass; end
+  end 
+  
+  # send one or many payloads
+  #
+  # Connection
+  #   The connection is made only if needed and is persisted until it times out or is closed by the system
+  #
+  # Errors
+  #   If an error occures during the write operation, after 3 retries, the socket and ssl connections are closed and an exception is raised
+  #
+  # Example:
+  #
+  #  single payload
+  # payload = APNS::Payload.new(device_token, 'Hello iPhone!')
+  # APNS.send_payloads(payload)
+  #
+  #  or with multiple payloads
+  # APNS.send_payloads([payload1, payload2])
+  
+  
+  # Send to a pem stream
+  def self.send_stream(stream, *payloads)    
+    payloads.flatten!
+    
+    # retain valid payloads only
+    payloads.reject!{ |p| !(p.is_a?(APNS::Payload) && p.valid?) }
+    
+    return if (payloads.nil? || payloads.count < 1)
+                    
+    # loop through each payloads
+    payloads.each do |payload|
+      retry_delay = 2
+      
+      # !ToDo! do a better job by using a select to poll the socket for a possible response from apple to inform us about an error in the sent payload
+      #
+      begin
+        @@sock[stream], @@ssl[stream] = self.push_connection(stream) if @@ssl[stream].nil?
+        @@ssl[stream].write(payload.to_ssl); @@ssl[stream].flush
+      rescue PemPathError, PemFileError => e
+        raise e
+      rescue
+        @@ssl[stream].close; @@sock[stream].close
+        @@ssl[stream] = nil; @@sock[stream] = nil # cleanup
+        
+        retry_delay *= 2
+        if retry_delay <= 8
+          sleep retry_delay
+          retry
+        else
+          raise
+        end
+      end # begin block 
+
+    end # each payloads
+  end
+  
+  def self.send_payloads(*payloads)
+    self.send(payloads)
+  end
+  
+  def self.send(*payloads)
+    self.send_stream(:_global, payloads)
+  end
+  
+
+  def self.feedback(stream = :_global)
+    sock, ssl = self.feedback_connection(stream)
+    
+    apns_feedback = []
+    
+    while line = sock.gets   # Read lines from the socket
+      line.strip!
+      f = line.unpack('N1n1H140')
+      apns_feedback << [Time.at(f[0]), f[2]]
+    end
+    
+    ssl.close
+    sock.close
+    
+    return apns_feedback
+  end
+    
+  
+  protected
+  
+  def self.ssl_context(stream = :_global)
+    raise PemPathError, "The path to your pem file is not set. (APNS.pem = /path/to/cert.pem)" unless self.pem(stream)
+    raise PemFileError, "The path to your pem file does not exist!" unless File.exist?(self.pem(stream))
+    
+    context      = OpenSSL::SSL::SSLContext.new
+    context.cert = OpenSSL::X509::Certificate.new(File.read(self.pem(stream)))
+    context.key  = OpenSSL::PKey::RSA.new(File.read(self.pem(stream)), self.pass(stream))
+    context
+  end
+  
+  def self.connect_to(aps_host, aps_port, stream = :_global)
+    context      = self.ssl_context(stream)
+    sock         = TCPSocket.new(aps_host, aps_port)
+    ssl          = OpenSSL::SSL::SSLSocket.new(sock, context)
+    ssl.connect
+
+    return sock, ssl
+  end
+    
+  def self.push_connection(stream = :_global)
+    self.connect_to(self.host, self.port, stream)
+  end
+  
+  def self.feedback_connection(stream = :_global)
+    self.connect_to(self.feedback_host, self.feedback_port, stream)
+  end
+  
+end

data/lib/apns/device.rb

@@ -0,0 +1,16 @@
+module APNS
+  
+  class Device
+    attr_accessor :token
+    
+    def initialize(device_token)
+      # cleanup token
+      self.token = device_token.gsub(/[\s|<|>]/,'')
+    end
+    
+    def to_payload
+      [token].pack('H*')
+    end 
+  end
+
+end

data/lib/apns/payload.rb

@@ -0,0 +1,149 @@
+module APNS
+    
+  class Payload
+    attr_accessor :device, :message
+    
+    APS_ROOT = :aps
+    APS_KEYS = [:alert, :badge, :sound]
+    
+    PAYLOAD_MAX_SIZE = 256
+        
+    def initialize(device_token, message_string_or_hash = {})
+      self.device = APNS::Device.new(device_token)
+      if message_string_or_hash.is_a?(String)
+        self.message = {:alert => message_string_or_hash.strip}
+      elsif message_string_or_hash.is_a?(Hash)
+        self.message = message_string_or_hash.each_value { |val| val.strip! if val.respond_to? :strip! }
+      else
+        raise "Payload message argument needs to be either a hash or a string"
+      end
+      self
+    end
+    
+    
+    # Batch payloads
+    # Ex: APNS::Payload.batch(Device.all.collect{|d|d.token}, :alert => "Hello")
+    #   or with a block
+    #     APNS::Payload.batch(Device.all.collect{|d|d.token}, :alert => custom_big_alert) do |payload|
+    #       payload.payload_with_truncated_alert
+    #     end
+    def self.batch(device_tokens, message_string_or_hash = {})
+      raise unless device_tokens.is_a?(Array)
+      payloads = []
+      device_tokens.each do |device|
+        payload = self.new(device, message_string_or_hash)        
+        payload = yield(payload) if block_given?
+        payloads << payload
+      end
+      payloads
+    end
+    
+    #
+    # Handy chainable setters
+    # 
+    # Ex: APNS::Payload.new(token).badge(3).sound("bipbip").alert("Roadrunner!").custom(:foo => :bar)
+    #
+    def badge(number)
+      message[:badge] = number
+      self
+    end
+    
+    def sound(filename)
+      message[:sound] = filename
+      self
+    end
+    
+    def alert(string)
+      message[:alert] = string
+      self
+    end
+     
+    def custom(hash)
+      return nil unless hash.is_a? Hash
+      return nil if hash.any?{|k,v| APS_KEYS.include?(k.to_sym) || (k.to_sym == APS_ROOT)}
+      message.merge!(hash)
+      self
+    end
+    
+    
+    # 
+    def to_ssl
+      pm = self.apn_message.to_json
+      [0, 0, 32, self.device.to_payload, 0, pm.size, pm].pack("ccca*cca*")
+    end
+    
+    def size
+      self.to_ssl.size
+    end
+    
+    # Validity checking only checks that the payload size is valid. We do not check the message content.
+    def valid?
+      self.size <= PAYLOAD_MAX_SIZE
+    end
+    
+    def apn_message
+      message_hash = message.dup
+      apnm = { APS_ROOT => {} }
+      APS_KEYS.each do |k|
+        apnm[APS_ROOT][k] = message_hash.delete(k) if message_hash.has_key?(k)
+      end
+      apnm.merge!(message_hash)
+      apnm
+    end
+    
+    # Returns a new payload with the alert truncated to fit in the payload size requirement (PAYLOAD_MAX_SIZE)
+    # Rem: It's a best effort since the alert may not be the one string responsible for the oversized payload
+    #      also, if your alert is a Hash containing loc-* keys it won't work, in this case you should use the #payload_with_truncated_string_at_keypath
+    def payload_with_truncated_alert
+      payload_with_truncated_string_at_keypath([:alert])
+    end
+    
+    
+    # payload_with_truncated_string_at_keypath("alert") or payload_with_truncated_string_at_keypath([:alert])
+    #   or
+    # payload_with_truncated_string_at_keypath("custom1.custom2") or payload_with_truncated_string_at_keypath([:custom1, :custom2])
+    # Rem: Truncation only works on String values...
+    def payload_with_truncated_string_at_keypath(array_or_dotted_string)
+      return self if valid? # You can safely call it on a valid payload 
+      return unless message.at_key_path(array_or_dotted_string).is_a?(String)
+      
+      # Rem: I'm using Marshall to make a deep copy of the message hash. Of course this would only work with "standard" values like Hash/String/Array
+      payload_with_empty_string = APNS::Payload.new(device.token, Marshal.load(Marshal.dump(message)).at_key_path(array_or_dotted_string){|obj, key| obj[key] = ""})
+      wanted_length = PAYLOAD_MAX_SIZE - payload_with_empty_string.size
+
+      # Return a new payload with truncated value
+      APNS::Payload.new(device.token, Marshal.load(Marshal.dump(message)).at_key_path(array_or_dotted_string) {|obj, key| obj[key] = obj[key].truncate(wanted_length) })
+    end
+            
+  end #Payload
+    
+end #module
+
+class Hash
+  def at_key_path(array_or_dotted_string, &block)
+    keypath = array_or_dotted_string.is_a?(Array) ? array_or_dotted_string.dup : array_or_dotted_string.split('.')
+    obj = self
+    while (keypath.count > 0) do
+      key = keypath.shift.to_s
+      key = key.to_sym if !obj.has_key?(key) && obj.has_key?(key.to_sym)
+      next unless keypath.count > 0 # exit the while loop
+      obj = obj.has_key?(key) ? obj[key] : raise("No key #{key} in Object (#{obj.inspect})")
+    end
+
+    raise("No key #{key} in Object (#{obj.inspect})") unless obj.has_key?(key)
+    if block_given? 
+      block.call(obj, key)
+      return self
+    else
+      return obj[key]
+    end
+  end    
+end
+
+class String
+  if !String.new.respond_to? :truncate
+    def truncate(len)
+       (len > 4 && length > 5) ? self[0..(len - 1) - 3] + '...' : self
+    end
+  end
+end

data/spec/apns/core_spec.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe APNS do
+  
+  def valid_payload
+    APNS::Payload.new("a-device-token", "my message")
+  end
+  
+  describe "send_payload" do
+    it "should complain about no pem file path" do
+      lambda{APNS.send_payloads(valid_payload)}.should raise_error(APNS::PemPathError)
+    end
+    
+    it "should complain about pem file inexistence" do
+      APNS.pem = "test.pem"
+      lambda{APNS.send_payloads(valid_payload)}.should raise_error(APNS::PemFileError)
+      APNS.pem = nil # cleanup for next tests
+    end
+        
+  end
+  
+  describe "feedback" do
+    it "should complain about no pem file path" do
+      lambda{APNS.feedback()}.should raise_error(APNS::PemPathError)
+    end
+    
+    it "should complain about pem file inexistence" do
+      APNS.pem = "test.pem"
+      lambda{APNS.feedback()}.should raise_error(APNS::PemFileError)
+      APNS.pem = nil # cleanup for next tests
+    end
+        
+  end
+
+end

data/spec/apns/device_spec.rb

@@ -0,0 +1,16 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe APNS::Device do
+  before do
+    @device = APNS::Device.new('<5b51030d d5bad758 fbad5004 bad35c31 e4e0f550 f77f20d4 f737bf8d 3d5524c6>')
+  end
+  
+  it "should cleanup the token string" do
+    @device.token.should == "5b51030dd5bad758fbad5004bad35c31e4e0f550f77f20d4f737bf8d3d5524c6"
+  end
+  
+  it "should package the token for the payload" do
+    @device.to_payload.should == "[Q\003\r\325\272\327X\373\255P\004\272\323\\1\344\340\365P\367\177 \324\3677\277\215=U$\306"
+  end
+  
+end

data/spec/apns/payload_spec.rb

@@ -0,0 +1,137 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe APNS::Payload do
+  
+  def payload(message, token = "a-device-token")
+    APNS::Payload.new(token, message)
+  end
+  it "should take a string as the message" do
+    p = payload('Hello')
+    p.should be_valid
+  end
+  
+  it "should take a hash as the message" do
+    p = payload({:alert => 'Hello iPhone', :badge => 3})
+    p.should be_valid
+  end
+
+  it "should not validate a message longer than 256 bytes" do
+    p = payload({:alert => 'A' * 250})
+    p.size.should > 256
+    p.should_not be_valid
+  end
+  
+  it "should validate a message of 256 bytes or less" do
+    p = payload({:alert => 'A' * 224})
+    p.size.should == 256
+    p.should be_valid
+  end
+  
+  it "should strip whitespace from payload string" do
+    p = payload("Hello iPhone  \n")
+    p.should be_valid
+    p.apn_message.should == { :aps => { :alert => 'Hello iPhone' } }
+  end
+
+  it "should allow chaining of setters for badge alert and sound" do
+    p = APNS::Payload.new("a-device-token").badge(2).sound("bipbip.aiff").alert("hello")
+    p.message[:badge].should == 2
+    p.message[:sound].should == "bipbip.aiff"
+    p.message[:alert].should == "hello"
+    p.should be_valid
+  end
+  
+  it "should allow truncation of alert and return a valid payload when alert is too big" do
+    p = payload("A"*300)
+    p.size.should > 256
+    p.should_not be_valid
+    
+    tp = p.payload_with_truncated_alert
+    tp.should be_valid
+    tp.size.should == 256
+  end
+    
+  it "should not change other fields but the alert message when truncating alert" do
+    p = payload({
+      :alert => "A" * 300,
+      :badge => 2,
+      :sound => "sound.aiff",
+      :custom => "my custom data"
+    })
+    p.should_not be_valid
+    p.size.should > 256
+    p.message[:badge].should == 2
+    p.message[:sound].should == "sound.aiff"
+    p.message[:custom].should == "my custom data"
+    
+    pn = p.payload_with_truncated_alert
+    pn.should be_valid
+    pn.size.should == 256
+    pn.message[:badge].should == p.message[:badge]
+    pn.message[:sound].should == p.message[:sound]
+    pn.message[:custom].should == p.message[:custom]
+  end
+  
+  it "should not change the alert when truncating alert and alert is not a String" do
+    p = payload({
+      :alert => {'foo' => 'bar'*80, 'baz' => 'blah'},
+      :badge => 2,
+      :sound => "sound.aiff",
+      :custom => "my custom data"
+    })
+    p.should_not be_valid
+    
+    pn = p.payload_with_truncated_alert
+    pn.should be_nil
+  end
+  
+  
+  it "should allow truncating a custom field" do
+    p = payload({
+      :alert => "my alert",
+      :badge => 2,
+      :sound => "sound.aiff",
+      :custom => {:message => "A"*300}
+    })
+    p.should_not be_valid
+    p.size.should > 256
+    p.message[:alert].should == "my alert"
+    p.message[:badge].should == 2
+    p.message[:sound].should == "sound.aiff"
+    
+    pn = p.payload_with_truncated_string_at_keypath("custom.message")
+    pn.should be_valid
+    pn.size.should == 256
+    pn.message[:badge].should == p.message[:badge]
+    pn.message[:sound].should == p.message[:sound]
+    pn.message[:alert].should == p.message[:alert]
+  end
+  
+  
+  describe '#packaged_message' do
+    
+    it "should return JSON with payload informations" do
+      p = payload({:alert => 'Hello iPhone', :badge => 2, :custom => "custom-string"})
+      p.apn_message.should == { :aps => { :badge => 2, :alert => 'Hello iPhone' }, :custom => "custom-string" }
+    end
+    
+    it "should return JSON with payload informations with whitespace stripped" do
+      p = payload({:alert => " Hello iPhone  \n", :badge => 2, :custom => "  custom-string  \n"})
+      p.apn_message.should == { :aps => { :badge => 2, :alert => 'Hello iPhone' }, :custom => "custom-string" }
+    end
+    
+    it "should not include keys that are empty in the JSON" do
+      p = payload({:badge => 3})
+      p.apn_message.should == { :aps => { :badge => 3 } }
+    end
+    
+  end
+  
+  describe '#to_ssl' do
+    it "should package the token and message" do
+      p = APNS::Payload.new('<5b51030d d5bad758 fbad5004 bad35c31 e4e0f550 f77f20d4 f737bf8d 3d5524c6>', {:alert => 'Hello iPhone'})
+      Base64.encode64(p.to_ssl).should == "AAAgW1EDDdW611j7rVAEutNcMeTg9VD3fyDU9ze/jT1VJMYAIHsiYXBzIjp7\nImFsZXJ0IjoiSGVsbG8gaVBob25lIn19\n"
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+gem 'rspec', '>= 2.0.0'
+require 'rspec'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'apns')
+require 'base64'

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: apns-pressplane
+version: !ruby/object:Gem::Version
+  version: 0.9.10
+  prerelease: 
+platform: ruby
+authors:
+- James Pozdena
+- Thierry Passeron
+- Pressplane Inc.
+autorequire: apns
+bindir: bin
+cert_chain: []
+date: 2010-03-22 00:00:00.000000000Z
+dependencies: []
+description: Simple Apple push notification service gem
+email: thierry.passeron@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- MIT-LICENSE
+files:
+- .gitignore
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- apns.gemspec
+- lib/apns.rb
+- lib/apns/core.rb
+- lib/apns/device.rb
+- lib/apns/payload.rb
+- spec/apns/core_spec.rb
+- spec/apns/device_spec.rb
+- spec/apns/payload_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/Orion98MC/APNS
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Simple Apple push notification service gem
+test_files:
+- spec/apns/core_spec.rb
+- spec/apns/device_spec.rb
+- spec/apns/payload_spec.rb
+- spec/spec_helper.rb