banjo-apn_sender 2.1.5 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d397476fb252cbb568dc7a0f1da7c6253f25785d
-  data.tar.gz: fe1e673a80a7c9ec3284f2069424e47f9e8c5538
+  metadata.gz: 067eaa2184fdd9171fcbe18c5bde69809e449a2b
+  data.tar.gz: 99746b0d5bb810c3358737e140d62c40fe2a64c4
 SHA512:
-  metadata.gz: 6746a3005c980b57a5422b2e321f415d6badfbed4b2f33ec694b144026a9fa20b05029b65fdba706bfdaafb5a83c86660dad34d9eedbab7280d76e66bb3476cd
-  data.tar.gz: c1bef3051f997aa869ea0c20e9b5d6d6449ee02b3dcf35a126a272c72d48946ddfd0b2d99943a511a812adb1f01337cfd7698940e915821d38e37adfe17260aa
+  metadata.gz: 95bd7c3aed59c3b8fe66a558a053f27b4b46c1f76f1f871d6c66157664d688edd1dba7c222bd6e7003b174e635ba015f09a6815b0cf1ba3f379dd71a7e450e9b
+  data.tar.gz: 12b2ecaba23309970959fb7d7e376fd4a84fe4fd1042918e261c866db697bc2ce7f36f02c429d3f84ed069d96d177ede50c808d97fb4de62047c9743acfcd3fa

data/apn_sender.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{banjo-apn_sender}
-  s.version = "2.1.5"
+  s.version = "2.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Kali Donovan}, %q{KW Justin Leung}]

data/lib/apn/connection.rb

@@ -12,12 +12,24 @@ class APN::Connection
     @fifos[env].shift if @fifos[env][FIFO_SIZE]
   end
 
-  def send_to_apple(notification, token, env, tag)
+  def error_response
+    if socket.flush && IO.select([socket], nil, nil, 1) && (error = socket.read(6))
+      error = error.unpack("ccA*")
+      log(:error, "Error response: #{error}")
+    end
+
+    error
+  end
+
+  def send_to_apple(notification, token, env, tag, debug = false)
     retries = 0
     push_fifo(env, token)
 
     begin
-      self.socket.write( notification.to_s )
+      socket.write(notification.to_s)
+      return false if debug && error_response
+
+      true
     rescue => e
       log(:error, "Try #{retries}: #{e.class} to #{apn_host}: #{e.message}, recent_tokens: #{@fifos[env]}")
 
@@ -34,14 +46,11 @@ class APN::Connection
     end
   end
 
-  def self.send(token, options, sandbox = false, enterprise = false)
-    msg = APN::Notification.new(token, options)
-    raise "Invalid notification options (did you provide :alert, :badge, :sound, or :'content-available'?): #{options.inspect}" unless msg.valid?
-
+  def self.current(sandbox = false, enterprise = false)
     thread_id = Thread.current.object_id
 
     # Use only 1 single thread for internal enterprise cert
-    sender = if enterprise
+    if enterprise
       if sandbox
         @sandbox_enterprise_sender ||= new(worker_count: 1, sandbox: 1, verbose: 1, enterprise: 1)
       else
@@ -54,18 +63,28 @@ class APN::Connection
         @production_senders[thread_id] ||= new(worker_count: 1, verbose: 1)
       end
     end
-     
+  end
+
+  def self.send_apn(token, message, sandbox = false, enterprise = false, style = { format: :frame })
+    msg = APN::Notification.new(token, message, style.reverse_merge(identifier: token.byteslice(0, 4)))
+    raise "Invalid notification message (did you provide :alert, :badge, :sound, or :'content-available'?): #{message.inspect}" unless msg.valid?
+
+    sender = current(sandbox, enterprise)
     env = sandbox ? 'sandbox' : enterprise ? 'enterprise' : 'production'
     tag = "#{sandbox ? 'sandbox' : 'production'}#{enterprise ? ' enterprise' : ''}"
-    sender.log(:info, "token: #{token} message: #{options}")
+    sender.log(:info, "token: #{token} message: #{message}, style: #{style}")
 
     if enterprise
-      @enterprise_semaphore.synchronize { sender.send_to_apple(msg, token, env, tag) }
+      @enterprise_semaphore.synchronize { sender.send_to_apple(msg, token, env, tag, !!style[:debug]) }
     else
       sender.send_to_apple(msg, token, env, tag)
     end
+
+    sender
   end
 
+  self.singleton_class.send(:alias_method, :send, :send_apn)
+
   protected
   def apn_host
     @apn_host ||= apn_sandbox? ? "gateway.sandbox.push.apple.com" : "gateway.push.apple.com"

data/lib/apn/notification.rb

@@ -23,10 +23,15 @@ module APN
     # 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})
+    attr_accessor :options, :token, :format, :identifier, :expiry_epoch, :priority
+
+    def initialize(token, opts, style = {})
       @token = token
+      @options = hash_as_symbols(opts.is_a?(Hash) ? opts : {:alert => opts})
+      @format = style[:format] || :frame
+      @identifier = style[:identifier] || OpenSSL::Random.random_bytes(4)
+      @expiry_epoch = (style[:expiry_epoch] || Time.now + 1.hour).to_i
+      @priority = (style[:priority] || 10).to_i
       payload_size = packaged_message.bytesize.to_i
 
       raise "Payload bytesize of #{payload_size} is > the maximum allowed size of 255." if payload_size > 255
@@ -71,7 +76,22 @@ module APN
     def packaged_notification
       pt = packaged_token
       pm = packaged_message
-      [0, 0, 32, pt, 0, pm.bytesize, pm].pack("ccca*cca*") 
+
+      case format
+      when :simple
+        [0, 0, pt.bytesize, pt, 0, pm.bytesize, pm].pack("ccca*cca*") 
+      when :frame
+        data = ''
+        data << [1, pt.bytesize, pt].pack("CnA*")
+        data << [2, pm.bytesize, pm].pack("CnA*")
+        data << [3, identifier.bytesize, identifier].pack("CnA*")
+        data << [4, 4, expiry_epoch].pack("CnN")
+        data << [5, 1, priority].pack("CnC")
+
+        [2, data.bytesize].pack('CN') + data
+      else
+        raise "Unsupported apn format #{format} with token: #{pt} message: #{options}"
+      end
     end
 
     # Device token, compressed and hex-ified

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: banjo-apn_sender
 version: !ruby/object:Gem::Version
-  version: 2.1.5
+  version: 2.2.0
 platform: ruby
 authors:
 - Kali Donovan