apns-ruby 0.0.0 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb1f035a12ec76366159c112eccd23dc2f319b8d
-  data.tar.gz: 2d6a9188eba06cb48683f10ba748a71069a46157
+  metadata.gz: a82816830da1287822fead19cd690a9e6f9a8042
+  data.tar.gz: cf75ab95b88a81f4b3415182744c3ddf5888e760
 SHA512:
-  metadata.gz: 07fe76e8c32cd0a91d0bc76eb283896aa53a65b4ffc4b5caf960fbb018c1212c29880e13b9acb7a65d948ab8618497b70fe6da9f946d8595e528f87ed03c1987
-  data.tar.gz: 47499c4c0f549710d22a27e4d379d8642ebc0e2cd34fb18b9c3d9b2b8e7a65b6cfd4a76f599eec9c23853d00b078df8de61a43b3f6dbe9ecb3cebaa6385652fc
+  metadata.gz: 8426a8e9f97f4ee0ba56d8b619d3c6588ab7e801db21aacad8e4f1a5ba13a2c8fb208a67061189c2a2214d3f24e46641e3c7c19d8727eac80f8af7991878620b
+  data.tar.gz: 2e4ef8e08692bf8228aa6a280c9f72d28efbda116d84b6e44be8e80db2c1d2bc5d7394afdd638b137aac6867bd57ee80ffacc8452c62c9a79cefba3fae34236b

data/README.md

@@ -4,8 +4,6 @@ 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.
 
-Beware though, that this gem has it's own nonsense in that by default, it sets the notification buffer size to 1 million, which could potentially take up 256MB of memory (Apple caps the size of a single notification's payload at 256 bytes). If you cannot afford to spare that amount of memory, configure it to a lesser number `conn = APNS::Connection.new(notification_buffer_size: 1024) # 1024 bytes`.
-
 Example usage:
 ```
 pem = path_to_your_pem_file
@@ -15,7 +13,12 @@ conn = APNS::Connection.new(pem: pem, host: host)
 conn.error_handler = ->(code, notification) {
   case code
   when 8
+    if notification.nil?
+      puts "Insufficient buffer size to collect failed notifications, please set a larger buffer size when creating an APNS connection."
+      return
+    end
     puts "Invalid token: #{notification.device_token}"
+    # Handle the invalid token per Apple's docs
   else
     # Consult Apple's docs
   end
@@ -23,17 +26,20 @@ conn.error_handler = ->(code, notification) {
 n1 = APNS::Notification.new(token, alert: 'hello')
 ne = APNS::Notification.new('bogustoken', alert: 'error')
 n2 = APNS::Notification.new(token, alert: 'world')
-conn.write([n1, ne, n2])
+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
+# 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.write([APNS::Notification.new(token, alert: 'hello world 0')])
+conn.push([APNS::Notification.new(token, alert: 'hello world 0')])
 sleep(7)
-conn.write([APNS::Notification.new(token, alert: 'hello world 1')])
+conn.push([APNS::Notification.new(token, alert: 'hello world 1')])
 
 # 'Invalid token: bogustoken' is printed out
-# We should be receiving the 'world', 'hello world 0', and 'hello world 1' notifications
+# We should be receiving each and every successful notification with texts:
+# 'world', 'hello world 0', and 'hello world 1'.
 ```
 
 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.rb

@@ -1,2 +1,3 @@
+require 'apns/infinite_array'
 require 'apns/connection'
 require 'apns/notification'

data/lib/apns/connection.rb

@@ -3,6 +3,9 @@ require 'socket'
 require 'timeout'
 
 module APNS
+
+MAX_32_BIT =  2_147_483_647
+
 class Connection
   attr_accessor :error_handler
 
@@ -10,13 +13,12 @@ class Connection
                  pass: nil,
                  host: 'gateway.sandbox.push.apple.com',
                  port: 2195,
-                 notification_buffer_size: 1_000_000)
-    @notifications = []
+                 buffer_size: 4 * 1024)
+    @notifications = InfiniteArray.new(buffer_size: buffer_size)
     @pem =  pem
     @pass = pass
     @host = host
     @port = port
-    @notification_buffer_size = notification_buffer_size
 
     @sock, @ssl = open_connection
     ObjectSpace.define_finalizer(self, self.class.finalize(@sock, @ssl))
@@ -28,22 +30,42 @@ class Connection
     }
   end
 
-  def write ns
-    if @notifications.size > @notification_buffer_size
-      ns = detect_failed_notifications(timeout: 0.5) + ns
-      @notifications = []
+  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.
+    if @notifications.size + ns.size > MAX_32_BIT - 10
+      code, failed_id = read_failure_info(timeout: 3)
+      if failed_id
+        ns = @notifications.items_from(failed_id+1) + ns
+        reopen_connection
+        @error_handler.call(code, @notifications.item_at(failed_id))
+      end
+
+      @notifications.clear
     end
 
+    ns.each{ |n|
+      n.message_identifier = [@notifications.size].pack('N')
+      @notifications.push(n)
+    }
+    write ns
+  end
+
+
+  private
+
+  def write ns
     packed = pack_notifications(ns)
     @ssl.write(packed)
   rescue Errno::EPIPE, Errno::ECONNRESET, OpenSSL::SSL::SSLError
-    failed_notifications = detect_failed_notifications timeout: 3
-    @notifications = []
-    @ssl.close
-    @sock.close
-    @sock, @ssl = open_connection
+    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))
 
-    ns = failed_notifications
+    @notifications.delete_where_index_less_than(failed_id+1)
+    ns = @notifications.items_from(failed_id+1)
     retry
   end
 
@@ -51,9 +73,6 @@ class Connection
     bytes = ''
 
     notifications.each do |n|
-      n.message_identifier = [@notifications.size].pack('N')
-      @notifications << n
-
       # Each notification frame consists of
       # 1. (e.g. protocol version) 2 (unsigned char [1 byte]) 
       # 2. size of the full frame (unsigend int [4 byte], big endian)
@@ -64,21 +83,17 @@ class Connection
     bytes
   end
 
-  def detect_failed_notifications(timeout:)
-    begin
-      tuple = Timeout::timeout(timeout){ @ssl.read(6) }
-      _, code, failed_id = tuple.unpack("ccN")
-    rescue Timeout::Error
-    end
-    failed_id ||= @notifications.size
-
-    # Report error to user
-    failed_notification = @notifications[failed_id]
-    if @error_handler && failed_notification
-      @error_handler.call(code, failed_notification)
-    end
+  def read_failure_info(timeout:)
+    tuple = Timeout::timeout(timeout){ @ssl.read(6) }
+    _, code, failed_id = tuple.unpack("ccN")
+    [code, failed_id]
+  rescue Timeout::Error
+  end
 
-    @notifications[failed_id+1..-1] || []
+  def reopen_connection
+    @ssl.close
+    @sock.close
+    @sock, @ssl = open_connection
   end
 
   def open_connection
@@ -94,9 +109,9 @@ class Connection
   end
 
   # Override inspect since we do not want to print out the entire @notifications,
-  # whose size might be over a hundred thousand
+  # whose size might be over tens of thousands
   def inspect
-    puts "#<#{self.class}:#{'0x%014x' % object_id} @pem=#{@pem} @pass=#{@pass} @host=#{@host} @port=#{@port} @notifications.size=#{@notifications.size} @error_handler=#{@error_handler}>"
+    puts "#<#{self.class}:#{'0x%014x' % object_id} @pem=#{@pem} @pass=#{@pass} @host=#{@host} @port=#{@port} @error_handler=#{@error_handler}>"
   end
 
 end

data/lib/apns/infinite_array.rb

@@ -0,0 +1,64 @@
+module APNS
+
+  class Element
+    attr_accessor :index, :item
+    def initialize(index:, item:)
+      self.index = index
+      self.item = item
+    end
+  end
+
+  class InfiniteArray
+
+    def initialize(buffer_size:)
+      @buffer_size = buffer_size
+      @buf = []
+    end
+
+    def push item
+      @buf << Element.new(index: size, item: item)
+      pop_front if @buf.size > @buffer_size
+    end
+
+    def size
+      return 0 if @buf[0].nil?
+      @buf.last.index + 1
+    end
+
+    def item_at index
+      buf_index = buffer_index_from(index: index)
+      return unless buf_index
+      @buf[buf_index].item
+    end
+
+    def items_from index
+      buf_index = buffer_index_from(index: index)
+      return [] unless buf_index
+      @buf[buf_index..-1].map(&:item)
+    end
+
+    def pop_front
+      @buf = @buf[1..-1]
+    end
+
+    def delete_where_index_less_than index
+      while @buf[0].index < index
+        pop_front
+      end
+    end
+
+    def clear
+      @buf = []
+      @hash = {}
+    end
+
+    def buffer_index_from(index:)
+      return if index > @buf.last.index
+      buf_index = index - @buf[0].index
+      return if buf_index < 0
+      buf_index
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apns-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.2
 platform: ruby
 authors:
 - awaw
@@ -20,6 +20,7 @@ files:
 - README.md
 - lib/apns.rb
 - lib/apns/connection.rb
+- lib/apns/infinite_array.rb
 - lib/apns/notification.rb
 homepage: https://github.com/fumin/apns-ruby
 licenses: