rapns 3.3.2-java → 3.4.0-java

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### 3.4.0 (Aug 28, 2013)
+  * Rails 4 support.
+  * Add apns_certificate_will_expire reflection.
+  * Perform storage update in batches where possible, to increase throughput.
+  * airbrake_notify is now deprecated, use the Reflection API instead.
+  * Fix calling the notification_delivered reflection twice (#149).
+
 ## 3.3.2 (June 30, 2013)
   * Fix Rails 3.0.x compatibility (#138) (@yoppi).
   * Ensure Rails does not set a default value for text columns (#137).

data/README.md

@@ -4,19 +4,16 @@
 ### Rapns - Professional grade APNs and GCM for Ruby.
 
 * Supports both APNs (iOS) and GCM (Google Cloud Messaging, Android).
-* Seamless Rails integration.
-* Scalable - choose the number of threads each app spawns.
+* Seamless Rails (3, 4) integration.
+* Scalable - choose the number of persistent connections for each app.
 * Designed for uptime - signal -HUP to add, update apps.
 * Stable - reconnects database and network connections when lost.
-* Run as a daemon or inside an existing process.
+* Run as a daemon or inside an [existing processs](https://github.com/ileitch/rapns/wiki/Embedding-API).
 * Use in a scheduler for low-workload deployments ([Push API](https://github.com/ileitch/rapns/wiki/Push-API)).
-* Reflection API for fine-grained instrumentation ([Reflection API](https://github.com/ileitch/rapns/wiki/Relfection-API)).
+* Reflection API for fine-grained instrumentation and error handling ([Reflection API](https://github.com/ileitch/rapns/wiki/Reflection-API)).
 * Works with MRI, JRuby, Rubinius 1.8 and 1.9.
-* [Airbrake](http://airbrakeapp.com/) integration.
 * Built with love.
 
-#### 2.x users please read [upgrading from 2.x to 3.0](https://github.com/ileitch/rapns/wiki/Upgrading-from-version-2.x-to-3.0)
-
 ### Who uses Rapns?
 
 [GateGuru](http://gateguruapp.com) and [Desk.com](http://desk.com), among others!
@@ -34,7 +31,7 @@ Generate the migrations, rapns.yml and migrate:
     rails g rapns
     rake db:migrate
 
-## Create an App
+## Create an App & Notification
 
 #### APNs
 
@@ -44,24 +41,12 @@ If this is your first time using the APNs, you will need to generate SSL certifi
 app = Rapns::Apns::App.new
 app.name = "ios_app"
 app.certificate = File.read("/path/to/sandbox.pem")
-app.environment = "sandbox"
+app.environment = "sandbox" # APNs environment.
 app.password = "certificate password"
 app.connections = 1
 app.save!
 ```
 
-#### GCM
-```ruby
-app = Rapns::Gcm::App.new
-app.name = "android_app"
-app.auth_key = "..."
-app.connections = 1
-app.save!
-```
-
-## Create a Notification
-
-#### APNs
 ```ruby
 n = Rapns::Apns::Notification.new
 n.app = Rapns::Apns::App.find_by_name("ios_app")
@@ -71,7 +56,18 @@ n.attributes_for_device = {:foo => :bar}
 n.save!
 ```
 
+You should also implement the [apns_certificate_will_expire](https://github.com/ileitch/rapns/wiki/Reflection-API) reflection to monitor when your certificate is due to expire.
+
 #### GCM
+
+```ruby
+app = Rapns::Gcm::App.new
+app.name = "android_app"
+app.auth_key = "..."
+app.connections = 1
+app.save!
+```
+
 ```ruby
 n = Rapns::Gcm::Notification.new
 n.app = Rapns::Gcm::App.find_by_name("android_app")
@@ -80,6 +76,8 @@ n.data = {:message => "hi mom!"}
 n.save!
 ```
 
+GCM also requires you to respond to [Canonical IDs](https://github.com/ileitch/rapns/wiki/Canonical-IDs).
+
 ## Starting Rapns
 
 As a daemon:

data/bin/rapns

@@ -5,28 +5,29 @@ require 'rapns'
 
 environment = ARGV[0]
 
-banner = 'Usage: rapns <Rails environment> [options]'
-if environment.nil? || environment =~ /^-/
-  puts banner
-  exit 1
-end
-
 config = Rapns::ConfigurationWithoutDefaults.new
 
-ARGV.options do |opts|
-  opts.banner = banner
+options = ARGV.options do |opts|
+  opts.banner = 'Usage: rapns <Rails environment> [options]'
   opts.on('-f', '--foreground', 'Run in the foreground.') { config.foreground = true }
-  opts.on('-P N', '--db-poll N', Integer, "Frequency in seconds to check for new notifications. Default: #{config.push_poll}.") { |n| config.push_poll = n }
-  opts.on('-F N', '--feedback-poll N', Integer, "Frequency in seconds to check for feedback. Default: #{config.feedback_poll}.") { |n| config.feedback_poll = n }
+  opts.on('-P N', '--db-poll N', Integer, "Frequency in seconds to check for new notifications.") { |n| config.push_poll = n }
+  opts.on('-F N', '--feedback-poll N', Integer, "Frequency in seconds to check for feedback.") { |n| config.feedback_poll = n }
   opts.on('-e', '--no-error-checks', 'Disable APNs error checking after notification delivery.') { config.check_for_errors = false }
   opts.on('-n', '--no-airbrake-notify', 'Disables error notifications via Airbrake.') { config.airbrake_notify = false }
   opts.on('-p PATH', '--pid-file PATH', String, 'Path to write PID file. Relative to Rails root unless absolute.') { |path| config.pid_file = path }
-  opts.on('-b N', '--batch-size N', Integer, 'ActiveRecord notifications batch size.') { |n| config.batch_size = n }
-  opts.on('-v', '--version', 'Print this version of rapns.') { puts "rapns #{Rapns::VERSION}"; exit }
+  opts.on('-b N', '--batch-size N', Integer, 'Storage backend notification batch size.') { |n| config.batch_size = n }
+  opts.on('-B', '--[no-]batch-storage-updates', 'Perform storage updates in batches.') { |v| config.batch_storage_updates = v }
+  opts.on('-v', '--version', 'Print the version.') { puts "rapns #{Rapns::VERSION}"; exit }
   opts.on('-h', '--help', 'You\'re looking at it.') { puts opts; exit }
-  opts.parse!
 end
 
+if environment.nil? || environment =~ /^-/
+  puts options.to_s
+  exit 1
+end
+
+options.parse!
+
 ENV['RAILS_ENV'] = environment
 load 'config/environment.rb'
 load 'config/initializers/rapns.rb' if File.exist?('config/initializers/rapns.rb')

data/lib/generators/templates/rapns.rb

@@ -11,15 +11,15 @@
   # Frequency in seconds to check for feedback
   # config.feedback_poll = 60
 
-  # Enable/Disable error notifications via Airbrake.
-  # config.airbrake_notify = true
-
   # Disable APNs error checking after notification delivery.
   # config.check_for_errors = true
 
   # ActiveRecord notifications batch size.
   # config.batch_size = 5000
 
+  # Perform updates to the storage backend in batches to reduce IO.
+  # config.batch_storage_updates = true
+
   # Path to write PID file. Relative to Rails root unless absolute.
   # config.pid_file = '/path/to/rapns.pid'
 
@@ -71,8 +71,12 @@ Rapns.reflect do |on|
   # on.gcm_canonical_id do |old_id, canonical_id|
   # end
 
+  # Called when an APNs certificate will expire within 1 month.
+  # Implement on.error to catch errors raised when the certificate expires.
+  # on.apns_certificate_will_expire do |app, expiration_time|
+  # end
+
   # Called when an exception is raised.
   # on.error do |error|
   # end
-
 end

data/lib/rapns.rb

@@ -1,6 +1,13 @@
 require 'active_record'
 require 'multi_json'
 
+module Rapns
+  def self.attr_accessible_available?
+    require 'rails'
+    ::Rails::VERSION::STRING < '4'
+  end
+end
+
 require 'rapns/version'
 require 'rapns/deprecation'
 require 'rapns/deprecatable'

data/lib/rapns/TODO

@@ -0,0 +1,3 @@
+* Should internal errors mark a notification as failed?
+* Check cert expiry when connected.
+* Lazy connect on socket write? - would allow to catch initial expiry error and mark on notification.

data/lib/rapns/apns/feedback.rb

@@ -3,7 +3,9 @@ module Rapns
     class Feedback < ActiveRecord::Base
       self.table_name = 'rapns_feedback'
 
-      attr_accessible :device_token, :failed_at, :app
+      if Rapns.attr_accessible_available?
+        attr_accessible :device_token, :failed_at, :app
+      end
 
       validates :device_token, :presence => true
       validates :failed_at, :presence => true
@@ -11,4 +13,4 @@ module Rapns
       validates_with Rapns::Apns::DeviceTokenFormatValidator
     end
   end
-end
+end

data/lib/rapns/app.rb

@@ -2,7 +2,9 @@ module Rapns
   class App < ActiveRecord::Base
     self.table_name = 'rapns_apps'
 
-    attr_accessible :name, :environment, :certificate, :password, :connections, :auth_key
+    if Rapns.attr_accessible_available?
+      attr_accessible :name, :environment, :certificate, :password, :connections, :auth_key
+    end
 
     has_many :notifications, :class_name => 'Rapns::Notification'
 

data/lib/rapns/configuration.rb

@@ -9,7 +9,7 @@ module Rapns
 
   CONFIG_ATTRS = [:foreground, :push_poll, :feedback_poll, :embedded,
     :airbrake_notify, :check_for_errors, :pid_file, :batch_size,
-    :push, :store, :logger]
+    :push, :store, :logger, :batch_storage_updates]
 
   class ConfigurationWithoutDefaults < Struct.new(*CONFIG_ATTRS)
   end
@@ -31,6 +31,11 @@ module Rapns
       end
     end
 
+    def airbrake_notify=(bool)
+      Rapns::Deprecation.warn("airbrake_notify is deprecated. Please use the Rapns.reflect API instead.")
+      super(bool)
+    end
+
     def pid_file=(path)
       if path && !Pathname.new(path).absolute?
         super(File.join(Rails.root, path))
@@ -67,6 +72,7 @@ module Rapns
 
       self.push_poll = 2
       self.feedback_poll = 60
+      Rapns::Deprecation.muted { self.airbrake_notify = true }
       self.airbrake_notify = true
       self.check_for_errors = true
       self.batch_size = 5000
@@ -74,6 +80,7 @@ module Rapns
       self.apns_feedback_callback = nil
       self.store = :active_record
       self.logger = nil
+      self.batch_storage_updates = true
 
       # Internal options.
       self.embedded = false

data/lib/rapns/daemon.rb

@@ -9,13 +9,15 @@ require 'rapns/daemon/reflectable'
 require 'rapns/daemon/interruptible_sleep'
 require 'rapns/daemon/delivery_error'
 require 'rapns/daemon/delivery'
-require 'rapns/daemon/delivery_queue'
 require 'rapns/daemon/feeder'
+require 'rapns/daemon/batch'
 require 'rapns/daemon/app_runner'
 require 'rapns/daemon/delivery_handler'
+require 'rapns/daemon/delivery_handler_collection'
 
 require 'rapns/daemon/apns/delivery'
 require 'rapns/daemon/apns/disconnection_error'
+require 'rapns/daemon/apns/certificate_expired_error'
 require 'rapns/daemon/apns/connection'
 require 'rapns/daemon/apns/app_runner'
 require 'rapns/daemon/apns/delivery_handler'

data/lib/rapns/daemon/apns/app_runner.rb

@@ -2,9 +2,10 @@ module Rapns
   module Daemon
     module Apns
       class AppRunner < Rapns::Daemon::AppRunner
+
         protected
 
-        def started
+        def after_start
           unless Rapns.config.push
             poll = Rapns.config.feedback_poll
             @feedback_receiver = FeedbackReceiver.new(app, poll)
@@ -12,7 +13,7 @@ module Rapns
           end
         end
 
-        def stopped
+        def after_stop
           @feedback_receiver.stop if @feedback_receiver
         end
 

data/lib/rapns/daemon/apns/certificate_expired_error.rb

@@ -0,0 +1,20 @@
+module Rapns
+  module Apns
+    class CertificateExpiredError < StandardError
+      attr_reader :app, :time
+
+      def initialize(app, time)
+        @app = app
+        @time = time
+      end
+
+      def to_s
+        message
+      end
+
+      def message
+        "#{app.name} certificate expired at #{time}."
+      end
+    end
+  end
+end

data/lib/rapns/daemon/apns/connection.rb

@@ -101,6 +101,8 @@ module Rapns
         end
 
         def connect_socket
+          check_certificate_expiration
+
           tcp_socket = TCPSocket.new(@host, @port)
           tcp_socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, 1)
           tcp_socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
@@ -110,6 +112,30 @@ module Rapns
           Rapns.logger.info("[#{@app.name}] Connected to #{@host}:#{@port}")
           [tcp_socket, ssl_socket]
         end
+
+        def check_certificate_expiration
+          cert = @ssl_context.cert
+          if certificate_expired?
+            Rapns.logger.error(certificate_msg('expired'))
+            raise Rapns::Apns::CertificateExpiredError.new(@app, cert.not_after)
+          elsif certificate_expires_soon?
+            Rapns.logger.warn(certificate_msg('will expire'))
+            reflect(:apns_certificate_will_expire, @app, cert.not_after)
+          end
+        end
+
+        def certificate_msg(msg)
+          time = @ssl_context.cert.not_after.utc.strftime("%Y-%m-%d %H:%M:%S %Z")
+          "[#{@app.name}] Certificate #{msg} at #{time}."
+        end
+
+        def certificate_expired?
+          @ssl_context.cert.not_after && @ssl_context.cert.not_after.utc < Time.now.utc
+        end
+
+        def certificate_expires_soon?
+          @ssl_context.cert.not_after && @ssl_context.cert.not_after.utc < (Time.now + 1.month).utc
+        end
       end
     end
   end

data/lib/rapns/daemon/apns/delivery.rb

@@ -16,10 +16,11 @@ module Rapns
           255 => "None (unknown error)"
         }
 
-        def initialize(app, conneciton, notification)
+        def initialize(app, conneciton, notification, batch)
           @app = app
           @connection = conneciton
           @notification = notification
+          @batch = batch
         end
 
         def perform

data/lib/rapns/daemon/apns/delivery_handler.rb

@@ -13,8 +13,8 @@ module Rapns
           @host, @port = HOSTS[@app.environment.to_sym]
         end
 
-        def deliver(notification)
-          Rapns::Daemon::Apns::Delivery.perform(@app, connection, notification)
+        def deliver(notification, batch)
+          Rapns::Daemon::Apns::Delivery.new(@app, connection, notification, batch).perform
         end
 
         def stopped

data/lib/rapns/daemon/app_runner.rb

@@ -1,17 +1,23 @@
 module Rapns
   module Daemon
     class AppRunner
+      extend Reflectable
+      include Reflectable
+
       class << self
         attr_reader :runners
       end
 
       @runners = {}
 
-      def self.enqueue(notification)
-        if app = runners[notification.app_id]
-          app.enqueue(notification)
-        else
-          Rapns.logger.error("No such app '#{notification.app_id}' for notification #{notification.id}.")
+      def self.enqueue(notifications)
+        notifications.group_by(&:app_id).each do |app_id, group|
+          batch = Batch.new(group)
+          if app = runners[app_id]
+            app.enqueue(batch)
+          else
+            Rapns.logger.error("No such app '#{app_id}' for notifications #{batch.describe}.")
+          end
         end
       end
 
@@ -33,6 +39,7 @@ module Rapns
           rescue StandardError => e
             Rapns.logger.error("[#{app.name}] Exception raised during startup. Notifications will not be delivered for this app.")
             Rapns.logger.error(e)
+            reflect(:error, e)
           end
         end
       end
@@ -60,31 +67,36 @@ module Rapns
       end
 
       attr_reader :app
+      attr_accessor :batch
 
       def initialize(app)
         @app = app
       end
 
-      def started
-      end
-
-      def stopped
-      end
+      def before_start; end
+      def after_start; end
+      def before_stop; end
+      def after_stop; end
 
       def start
-        app.connections.times { handlers << start_handler }
-        started
+        before_start
+        app.connections.times { handlers.push(start_handler) }
+        after_start
         Rapns.logger.info("[#{app.name}] Started, #{handlers_str}.")
       end
 
       def stop
-        handlers.map(&:stop)
-        stopped
-        handlers.clear
+        before_stop
+        handlers.stop
+        after_stop
       end
 
-      def enqueue(notification)
-        queue.push(notification)
+      def enqueue(batch)
+        self.batch = batch
+        batch.notifications.each do |notification|
+          queue.push([notification, batch])
+          reflect(:notification_enqueued, notification)
+        end
       end
 
       def sync(app)
@@ -92,20 +104,20 @@ module Rapns
         diff = handlers.size - app.connections
         return if diff == 0
         if diff > 0
-          diff.times { decrement_handlers }
-          Rapns.logger.info("[#{app.name}] Stopped #{handlers_str(diff)}. #{handlers_str} remaining.")
+          decrement_handlers(diff)
+          Rapns.logger.info("[#{app.name}] Stopped #{handlers_str(diff)}. #{handlers_str} running.")
         else
-          diff.abs.times { increment_handlers }
-          Rapns.logger.info("[#{app.name}] Started #{handlers_str(diff)}. #{handlers_str} remaining.")
+          increment_handlers(diff.abs)
+          Rapns.logger.info("[#{app.name}] Started #{handlers_str(diff)}. #{handlers_str} running.")
         end
       end
 
-      def decrement_handlers
-        handlers.pop.stop
+      def decrement_handlers(num)
+        num.times { handlers.pop }
       end
 
-      def increment_handlers
-        handlers << start_handler
+      def increment_handlers(num)
+        num.times { handlers.push(start_handler) }
       end
 
       def debug
@@ -114,18 +126,28 @@ module Rapns
 #{@app.name}:
   handlers: #{num_handlers}
   queued: #{queue_size}
+  batch size: #{batch_size}
+  batch processed: #{batch_processed}
   idle: #{idle?}
         EOS
       end
 
       def idle?
-        queue.notifications_processed?
+        batch ? batch.complete? : true
       end
 
       def queue_size
         queue.size
       end
 
+      def batch_size
+        batch ? batch.num_notifications : 0
+      end
+
+      def batch_processed
+        batch ? batch.num_processed : 0
+      end
+
       def num_handlers
         handlers.size
       end
@@ -140,11 +162,11 @@ module Rapns
       end
 
       def queue
-        @queue ||= Rapns::Daemon::DeliveryQueue.new
+        @queue ||= Queue.new
       end
 
       def handlers
-        @handler ||= []
+        @handlers ||= Rapns::Daemon::DeliveryHandlerCollection.new
       end
 
       def handlers_str(count = app.connections)