gs-apns 0.2.0 → 1.0.0

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    gs-apns (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gs-apns!
+  rspec (~> 2.6)

data/README.textile

@@ -1,20 +1,36 @@
 h1. gs-apns
 
-gs-apns is a gem for accessing the Apple Push Notification Service that allows
-both sending notifications and reading from apple's feedback service. This gem
-is based heavily on the work of James Pozdena (http://github.com/jpoz/APNS) and
-"Paul Gebheim" (http://github.com/jpoz/APNS).
+gs-apns is a gem for accessing the Apple Push Notification Service that allows both sending notifications and reading from apple's feedback service. This gem extends on the prior work of "James Pozdena":http://github.com/jpoz/APNS and "Paul Gebheim":http://github.com/jpoz/APNS.
 
-Updates by William Denniss of Geospike: Apple's APNS service does not support JSON that isn't ascii encoded. Prior to rails 3.2.13
-it was encoded, but now it isn't.
+Improvements in *gs-apns*, by William Denniss of "Geospike":http://geospike.com/ :
+
+# Automatic truncation of messages to fit within the 256 byte limit, and an exception thrown if the server payload is too big (better than dying silently)
+# Truncation can truncate on word or character boundaries, and UTF-8 is fully supported (specifically, Chinese/Japanese character messages are supported)
+# JSON generation uses the JSON gem directly rather than to_json which is overridden by Rails with the potential for "bugs to be introduced":http://omegadelta.net/2013/04/28/changes-to-how-rails-3-2-13-and-4-0-encodes-unicode-in-json/ .
+# Uses Apple's new 'enhanced' notification protocol allowing for an expiration date to be sent on notifications
+# All 256 of available notification payload can be used (jtv-apns & apns are currently limited to 255)
 
 
 h2. Install
 
 <pre>
-sudo gem install jtv-apns
+sudo gem install gs-apns
+</pre>
+
+h3. Gemfile
+
+<pre>
+gem "gs-apns", "~> 1.0.0"
+</pre>
+
+Bleeding edge:
+
+<pre>
+gem 'gs-apns', :git => 'git://github.com/WilliamDenniss/APNS.git'
 </pre>
 
+
+
 h2. Setup:
 
 First, you will need to export your development/production iphone push service
@@ -23,11 +39,12 @@ certificate, and select File -> Export from your keychain. By default a .p12
 file will be generated containing certificate and key.
 
 Next, run the following command to convert this .p12 file into a .pem file.
+
 <pre>
 openssl pkcs12 -in cert.p12 -out cert.pem -nodes -clcerts
 </pre>
 
-This pem file should be stored somewhere secure that your application can access. Next, set the jtv-apns configuration parameters:
+This pem file should be stored somewhere secure that your application can access. Next, set the configuration parameters:
 
 <pre>
 ###################
@@ -71,6 +88,31 @@ APNS.pass = 'xxxx'
 
 # (default: false)
 # APNS.cache_connections = true
+
+#######################
+# Message trunctation
+#######################
+
+# soft (word break), or hard truncation (default: Truncate::TRUNCATE_METHOD_SOFT).
+APNS.truncate_mode = APNS::Truncate::TRUNCATE_METHOD_SOFT
+
+# for soft truncation, the maximum number of characters that will be chopped (default: 15)
+APNS.truncate_soft_max_chopped = 15
+
+# if true (default: false), replaces all whitespace characters in the message with single spaces. 
+# e.g. "\n" becomes " ", and "\n\t\n \n" becomes " ".
+APNS.message_clean_whitespace = false
+
+# when a message is truncated, this string is written to the end. Defaults to … (the unicode ellipsis)
+APNS.truncate_ellipsis_str = "\u2026"
+
+#######################
+# Logging
+#######################
+
+# if true (default: true), will output 1 log message for every notification in a batch, and 1 message for the batch
+APNS.logging = true
+
 </pre>
 
 h2. Example (Single notification):
@@ -122,7 +164,7 @@ end
 
 h2. Accessing the feedback service
 
-jtv-apns provides a simple api to access Apple's feedback service. Below is an example for setting the feedback time on an ActiveRecord object corresponding to a device token.
+gs-apns provides a simple api to access Apple's feedback service. Below is an example for setting the feedback time on an ActiveRecord object corresponding to a device token.
 
 <pre>
 # APNS.feedback_each returns an array of Hash objects with the following keys
@@ -146,7 +188,7 @@ ApplicationAppDelegate.m
 - (void)applicationDidFinishLaunching:(UIApplication *)application {    
     // Register with apple that this app will use push notification
     [[UIApplication sharedApplication] registerForRemoteNotificationTypes:(UIRemoteNotificationTypeAlert | 
-      UIRemoteNotificationTypeSound | UIRemoteNotificationTypeBadge)];	
+      UIRemoteNotificationTypeSound | UIRemoteNotificationTypeBadge)];                                     
 }
 
 - (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
@@ -155,4 +197,12 @@ ApplicationAppDelegate.m
 }
 </pre>
     
+h2. Test Cases
+
+Execute:
+
+<pre>
+bundle exec rspec spec
+</pre>
 
+To run all the rspec test-cases.

data/lib/apns/core.rb

@@ -45,13 +45,15 @@ module APNS
   @connections = {}
 
   @truncate_mode = Truncate::TRUNCATE_METHOD_SOFT
-  @truncate_max_chopped = 10
-  @clean_whitespace = true
+  @truncate_soft_max_chopped = 15
+  @truncate_ellipsis_str = "\u2026"
+
+  @message_clean_whitespace = false
   
   @logging = true
 
   class << self
-    attr_accessor :host, :port, :feedback_host, :feedback_port, :pem, :pass, :cache_connections, :clean_whitespace, :truncate_mode, :truncate_max_chopped, :logging
+    attr_accessor :host, :port, :feedback_host, :feedback_port, :pem, :pass, :cache_connections, :message_clean_whitespace, :truncate_mode, :truncate_soft_max_chopped, :truncate_ellipsis_str, :logging
   end
 
   def self.establish_notification_connection
@@ -73,6 +75,7 @@ module APNS
     self.with_notification_connection do |conn|
       conn.write(self.packaged_notification(device_token, message, notification_id, expiry))
       conn.flush
+      puts "[APNS] send 1 notification package to #{@host}" if @logging
     end
   end
   
@@ -82,6 +85,7 @@ module APNS
         conn.write(self.packaged_notification(n[0], n[1], (n[2] or rand(9999)), (n[3] or (Time.now + 1.year))))
       end
       conn.flush
+      puts "[APNS] sent #{notifications.count} notification package(s) to #{@host}" if @logging
     end
   end
   
@@ -139,7 +143,7 @@ module APNS
     else
       raise "Message needs to be either a hash or string"
     end
-    hash = Truncate.truncate_notification(hash, @clean_whitespace, @truncate_mode, @truncate_max_chopped)
+    hash = Truncate.truncate_notification(hash, @message_clean_whitespace, @truncate_mode, @truncate_soft_max_chopped, @truncate_ellipsis_str)
     ApnsJSON.apns_json(hash)
   end
   

data/lib/apns/truncate.rb

@@ -31,7 +31,7 @@ module APNS
     NOTIFICATION_MAX_BYTE_SIZE = 256
   
     # forces a notification to fit within Apple's payload limits by truncating the message as required
-    def self.truncate_notification(notification, clean_whitespace = true, truncate_mode = TRUNCATE_METHOD_SOFT, truncate_soft_max_chopped = 10)
+    def self.truncate_notification(notification, clean_whitespace = true, truncate_mode = TRUNCATE_METHOD_SOFT, truncate_soft_max_chopped = 10, ellipsis = "\u2026")
       
       raise ArgumentError, "notification is not a hash" unless notification.is_a?(Hash)
       raise ArgumentError, "notification hash should contain :aps key" unless notification[:aps]
@@ -54,7 +54,7 @@ module APNS
           raise TrucateException, "notification would only fit within 256 byte limit by completely truncating the message which changes the presentation in iOS"
         end
 
-        notification[:aps][:alert] = truncate_string(notification[:aps][:alert], message_target_byte_size, truncate_mode, truncate_soft_max_chopped)
+        notification[:aps][:alert] = truncate_string(notification[:aps][:alert], message_target_byte_size, truncate_mode, truncate_soft_max_chopped, ellipsis)
       end
       
       return notification

data/lib/apns/version.rb

@@ -1,3 +1,3 @@
 module APNS
-  VERSION = "0.2.0"
+  VERSION = "1.0.0"
 end

data/spec/apns/core_spec.rb

@@ -25,6 +25,8 @@ require 'spec_helper'
 
 describe APNS do
 
+  APNS.logging = false
+
   it "should encode unicode to ascii-only json" do
     string = "\u2601"
     json = ApnsJSON.apns_json([string])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gs-apns
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-28 00:00:00.000000000 Z
+date: 2013-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -39,6 +39,7 @@ extra_rdoc_files:
 files:
 - .gitignore
 - Gemfile
+- Gemfile.lock
 - MIT-LICENSE
 - README.textile
 - Rakefile