apn_sender 0.0.4 → 0.0.5

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/apn_sender.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{apn_sender}
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kali Donovan"]
-  s.date = %q{2010-05-02}
+  s.date = %q{2010-05-03}
   s.description = %q{Resque-based background worker to send Apple Push Notifications over a persistent TCP socket. Includes Resque tweaks to allow persistent sockets between jobs, helper methods for enqueueing APN notifications, and a background daemon to send them.}
   s.email = %q{kali.donovan@gmail.com}
   s.extra_rdoc_files = [

data/lib/apn/notification.rb

@@ -5,11 +5,11 @@ module APN
   #
   # APN::Notification.new's first argument is the token of the iPhone which should receive the notification.  The second argument
   # is a hash with any of :alert, :badge, and :sound keys. All three accept string arguments, while :sound can also be set to +true+
-  # to play the default sound installed with the application. At least one of these keys must exist. The hash also accepts a
-  # :custom key to send a hash of custom application data:
+  # to play the default sound installed with the application. At least one of these keys must exist.  Any other keys are merged into
+  # the root of the hash payload ultimately sent to the iPhone:
   #
   #   APN::Notification.new(token, {:alert => 'Stuff', :custom => {:code => 23}})
-  #   # Writes this JSON to servers: {"code":23,"aps":{"alert":"Stuff"}}
+  #   # Writes this JSON to servers: {"aps" => {"alert" => "Stuff"}, "custom" => {"code" => 23}}
   # 
   # As a shortcut, APN::Notification.new also accepts a string as the second argument, which it converts into the alert to send.  The 
   # following two lines are equivalent:
@@ -18,6 +18,11 @@ module APN
   #   APN::Notification.new(token, {:alert => 'Some Alert'})
   #
   class Notification
+    # Available to help clients determine before they create the notification if their message will be too large.
+    # Each iPhone Notification payload must be 256 or fewer characters.  Encoding a null message has a 57 
+    # character overhead, so there are 199 characters available for the alert string.
+    MAX_ALERT_LENGTH = 199 
+    
     attr_accessor :options, :token
     def initialize(token, opts)
       @options = hash_as_symbols(opts.is_a?(Hash) ? opts : {:alert => opts})
@@ -50,14 +55,17 @@ module APN
       [@token.gsub(/[\s|<|>]/,'')].pack('H*')
     end
 
-    # Convert the supplied options into the JSON needed for Apple's push notification servers
+    # Converts the supplied options into the JSON needed for Apple's push notification servers.
+    # Extracts :alert, :badge, and :sound keys into the 'aps' hash, merges any other hash data
+    # into the root of the hash to encode and send to apple.
     def packaged_message
       hsh = {'aps' => {}}
-      hsh['aps']['alert'] = @options[:alert].to_s if @options[:alert]
-      hsh['aps']['badge'] = @options[:badge].to_i if @options[:badge]
-      hsh['aps']['sound'] = @options[:sound] if @options[:sound] and @options[:sound].is_a? String
-      hsh['aps']['sound'] = 'default' if @options[:sound] and @options[:sound].is_a? TrueClass
-      hsh.merge!(@options[:custom]) if @options[:custom]
+      hsh['aps']['alert'] = @options.delete(:alert).to_s if @options[:alert]
+      hsh['aps']['badge'] = @options.delete(:badge).to_i if @options[:badge]
+      if sound = @options.delete(:sound)
+        hsh['aps']['sound'] = sound.is_a?(TrueClass) ? 'default' : sound.to_s
+      end
+      hsh.merge!(@options)
       hsh.to_json
     end
     

data/lib/apn/sender.rb

@@ -55,7 +55,7 @@ __END__
 k = 'ceecdc18 ef17b2d0 745475e0 0a6cd5bf 54534184 ac2649eb 40873c81 ae76dbe8'
 c = '0f58e3e2 77237b8f f8213851 c835dee0 376b7a31 9e0484f7 06fe3035 7c5dda2f'
 Resque.enqueue APN::NotificationJob, k, {:alert => 'Resque Test'}
-APN.notify 'ceecdc18 ef17b2d0 745475e0 0a6cd5bf 54534184 ac2649eb 40873c81 ae76dbe8', 'Resque Test'
+APN.notify k, 'Resque Test'
 
 # If you need to really force quit some screwed up workers
 Resque.workers.map{|w| Resque.redis.srem(:workers, w)}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: apn_sender
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Kali Donovan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-02 00:00:00 -07:00
+date: 2010-05-03 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency