apns-ruby 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a82816830da1287822fead19cd690a9e6f9a8042
-  data.tar.gz: cf75ab95b88a81f4b3415182744c3ddf5888e760
+  metadata.gz: fb5a30cf2461e888a174d71c290a566c23bd41d7
+  data.tar.gz: 0bd5422d9e7656b5937489728528fcc66f11b745
 SHA512:
-  metadata.gz: 8426a8e9f97f4ee0ba56d8b619d3c6588ab7e801db21aacad8e4f1a5ba13a2c8fb208a67061189c2a2214d3f24e46641e3c7c19d8727eac80f8af7991878620b
-  data.tar.gz: 2e4ef8e08692bf8228aa6a280c9f72d28efbda116d84b6e44be8e80db2c1d2bc5d7394afdd638b137aac6867bd57ee80ffacc8452c62c9a79cefba3fae34236b
+  metadata.gz: 9e5b3605fdfc3bbd279b93f4ec8348e171a0c5b8be8c371b07a104993d199fbaf8a0580e93e797bbe702dc5b2b4585ac761235aa1fa577ee14e3465d48fa3993
+  data.tar.gz: 7285ff7bf0688969409368e5434bc7246e6bd2e9768f8a15d1422ef27b6c4b6d09414a444d7e9c1ac23a5e2c2e7a1cd621b9491e782daea653145cdd5ec02ccf

data/README.md

@@ -4,6 +4,8 @@ This gem sends APNS notifications with proper error handling. Most importantly,
 * Storing notifications in a database, and have a separate process consume them. Worse, only a single consumer is ever allowed.
 * Opening a new SSL connection for every notification, which typically takes several hundred milliseconds. Imagine how long it would take to send a million notifications.
 
+As of 2015-03-04, this gem has been powering [PicCollage](http://pic-collage.com/) for more than a year, sending more than 500 notifications per second at peak time, only to be limited by the devices database's throughput.
+
 Example usage:
 ```
 pem = path_to_your_pem_file
@@ -27,19 +29,8 @@ n1 = APNS::Notification.new(token, alert: 'hello')
 ne = APNS::Notification.new('bogustoken', alert: 'error')
 n2 = APNS::Notification.new(token, alert: 'world')
 conn.push([n1, ne, n2])
-# Should receive only a 'hello' notification on your device
-
-# Wait for Apple to report an error and close the connection on their side, due to
-# the bogus token in the second notification.
-# We'll detect this and automatically retry and invoke your error handler.
-sleep(7)
-conn.push([APNS::Notification.new(token, alert: 'hello world 0')])
-sleep(7)
-conn.push([APNS::Notification.new(token, alert: 'hello world 1')])
-
-# 'Invalid token: bogustoken' is printed out
-# We should be receiving each and every successful notification with texts:
-# 'world', 'hello world 0', and 'hello world 1'.
+# 'Invalid token: bogustoken' is printed out.
+# Moreover, we should be receiving each and every successful notification with texts 'hello' and 'world'.
 ```
 
 A great amount of code in this gem is copied from https://github.com/jpoz/APNS , many thanks to his pioneering work. This work itself is licensed under the MIT license.

data/lib/apns/connection.rb

@@ -20,6 +20,14 @@ class Connection
     @host = host
     @port = port
 
+    # Our current strategy is to read errors emitted by the APNS in a separate
+    # thread spawned when we open a new connection (read_errors method).
+    # If this thread receives an error information from the @ssl, it turns on
+    # the @lock, so that no direct write operation can be performed on the same
+    # Connection instance.
+    #
+    @lock = Mutex.new
+
     @sock, @ssl = open_connection
     ObjectSpace.define_finalizer(self, self.class.finalize(@sock, @ssl))
   end
@@ -31,8 +39,8 @@ class Connection
   end
 
   def push ns
-    # The notification identifier is set to 4 bytes in the APNS protocol. Thus,
-    # upon hitting this limit, read for failures and restart the counting again.
+    # The notification identifier is set to 4 bytes in the APNS protocol.
+    # Thus, upon hitting this limit, read for failures and restart the counting again.
     if @notifications.size + ns.size > MAX_32_BIT - 10
       code, failed_id = read_failure_info(timeout: 3)
       if failed_id
@@ -48,7 +56,7 @@ class Connection
       n.message_identifier = [@notifications.size].pack('N')
       @notifications.push(n)
     }
-    write ns
+    @lock.synchronize{ write ns }
   end
 
 
@@ -57,16 +65,6 @@ class Connection
   def write ns
     packed = pack_notifications(ns)
     @ssl.write(packed)
-  rescue Errno::EPIPE, Errno::ECONNRESET, OpenSSL::SSL::SSLError
-    code, failed_id = read_failure_info(timeout: 30)
-    reopen_connection
-    return unless failed_id # there's nothing we can do
-
-    @error_handler.call(code, @notifications.item_at(failed_id))
-
-    @notifications.delete_where_index_less_than(failed_id+1)
-    ns = @notifications.items_from(failed_id+1)
-    retry
   end
 
   def pack_notifications notifications
@@ -105,9 +103,29 @@ class Connection
     ssl          = OpenSSL::SSL::SSLSocket.new(sock,context)
     ssl.connect
 
+    Thread.new {
+      read_errors ssl
+    }
+
     return sock, ssl
   end
 
+  def read_errors ssl
+    tuple = ssl.read(6)
+
+    @lock.synchronize {
+      _, code, failed_id = tuple.unpack("ccN")
+      reopen_connection
+      return unless failed_id # there's nothing we can do
+
+      @error_handler.call(code, @notifications.item_at(failed_id))
+
+      @notifications.delete_where_index_less_than(failed_id+1)
+      ns = @notifications.items_from(failed_id+1)
+      write ns
+    }
+  end
+
   # Override inspect since we do not want to print out the entire @notifications,
   # whose size might be over tens of thousands
   def inspect

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apns-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - awaw
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-05 00:00:00.000000000 Z
+date: 2015-03-04 00:00:00.000000000 Z
 dependencies: []
 description: APNS notifications sent properly with correct connection management and
   error handling
@@ -47,4 +47,3 @@ signing_key:
 specification_version: 4
 summary: APNS notifications sent properly
 test_files: []
-has_rdoc: