rapns 3.0.1-java → 3.1.0-java

data/CHANGELOG.md

@@ -1,7 +1,15 @@
-## 3.0.1 (Sun 16, 2012)
+## 3.1.0 (Jan 26, 2013)
+  * Rapns.reflect API for fine-grained introspection.
+  * Rapns.embed API for embedding Rapns into an existing process.
+  * Rapns.push API for using Rapns in scheduled jobs.
+  * Fix issue with integration with ActiveScaffold (#98) (@jeffarena).
+  * Fix content-available setter for APNs (#95) (@dup2).
+  * GCM validation fixes (#96) (@DianthuDia).
+
+## 3.0.1 (Dec 16, 2012)
   * Fix compatibility with Rails 3.0.x. Fixes #89.
 
-## 3.0.0 (Sat 15, 2012)
+## 3.0.0 (Dec 15, 2012)
   * Add support for Google Cloud Messaging.
   * Fix Heroku logging issue.
 

data/README.md

@@ -1,14 +1,18 @@
 [![Build Status](https://secure.travis-ci.org/ileitch/rapns.png?branch=master)](http://travis-ci.org/ileitch/rapns)
 
-### Rapns - Professional grade APNs and GCM daemon
+### 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.
 * 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.
+* Use in a scheduler for low-workload deployments ([Push API](rapns/wiki/Push-API)).
+* Reflection API for fine-grained instrumentation ([Reflection API](rapns/wiki/Relfection-API)).
 * Works with MRI, JRuby, Rubinius 1.8 and 1.9.
 * [Airbrake](http://airbrakeapp.com/) integration.
+* Built with a love for Open Source :)
 
 #### 2.x users please read [upgrading from 2.x to 3.0](rapns/wiki/Upgrading-from-version-2.x-to-3.0)
 
@@ -36,11 +40,16 @@ Generate the migrations, rapns.yml and migrate:
 3. Select both the certificate and private key.
 4. Right click and select `Export 2 items...`.
 5. Save the file as `cert.p12`, make sure the File Format is `Personal Information Exchange (p12)`.
-6. If you decide to set a password for your exported certificate, please read the 'Adding Apps' section below.
-7. Convert the certificate to a .pem, where `<environment>` should be `development` or `production`, depending on the certificate you exported.
+6. Convert the certificate to a .pem, where `<environment>` should be `development` or `production`, depending on the certificate you exported.
+
+Without a password:
 
     `openssl pkcs12 -nodes -clcerts -in cert.p12 -out <environment>.pem`
 
+With a password:
+
+    `openssl pkcs12 -clcerts -in cert.p12 -out <environment>.pem`
+
 ## Create an App
 
 #### APNs
@@ -86,9 +95,17 @@ n.save!
 
 ## Starting Rapns
 
+As a daemon:
+
     cd /path/to/rails/app
     rapns <Rails environment> [options]
 
+Inside an existing process:
+
+    Rapns.embed
+
+*Please note that only ever a single instance of Rapns should be running.*
+
 See [Configuration](rapns/wiki/Configuration) for a list of options, or run `rapns --help`.
 
 ## Updating Rapns
@@ -102,6 +119,9 @@ After updating you should run `rails g rapns` to check for any new migrations.
 * [Upgrading from 2.x to 3.0](rapns/wiki/Upgrading-from-version-2.x-to-3.0)
 * [Deploying to Heroku](rapns/wiki/Heroku)
 * [Hot App Updates](rapns/wiki/Hot-App-Updates)
+* [Reflection API](rapns/wiki/Reflection-API)
+* [Push API](rapns/wiki/Push-API)
+* [Embedding API](rapns/wiki/Embedding-API)
 
 ### APNs
 * [Advanced APNs Features](rapns/wiki/Advanced-APNs-Features)
@@ -138,3 +158,6 @@ Thank you to the following wonderful people for contributing:
 * [@adorr](https://github.com/adorr)
 * [@mattconnolly](https://github.com/mattconnolly)
 * [@emeitch](https://github.com/emeitch)
+* [@jeffarena](https://github.com/jeffarena)
+* [@DianthuDia](https://github.com/DianthuDia)
+* [@dup2](https://github.com/dup2)

data/bin/rapns

@@ -11,9 +11,7 @@ if environment.nil? || environment =~ /^-/
   exit 1
 end
 
-# A mock configuration to be used before the Rails environment is loaded.
-class CommandlineConfig < Struct.new(*Rapns::CONFIG_ATTRS); end
-config = CommandlineConfig.new
+config = Rapns::ConfigurationWithoutDefaults.new
 
 ARGV.options do |opts|
   opts.banner = banner
@@ -34,8 +32,5 @@ load 'config/environment.rb'
 load 'config/initializers/rapns.rb' if File.exist?('config/initializers/rapns.rb')
 
 Rapns.config.update(config)
-
-require 'rapns/daemon'
-require 'rapns/patches'
-
+Rapns.require_for_daemon
 Rapns::Daemon.start

data/lib/generators/templates/add_gcm.rb

@@ -34,7 +34,9 @@ class AddGcm < ActiveRecord::Migration
 
     add_column :rapns_notifications, :collapse_key, :string, :null => true
     add_column :rapns_notifications, :delay_while_idle, :boolean, :null => false, :default => false
-    add_column :rapns_notifications, :registration_ids, :text, :null => true
+
+    reg_ids_type = ActiveRecord::Base.connection.adapter_name.include?('Mysql') ? :mediumtext : :text
+    add_column :rapns_notifications, :registration_ids, reg_ids_type, :null => true
     add_column :rapns_notifications, :app_id, :integer, :null => true
     add_column :rapns_notifications, :retries, :integer, :null => true, :default => 0
 

data/lib/generators/templates/rapns.rb

@@ -23,17 +23,48 @@
   # Path to write PID file. Relative to Rails root unless absolute.
   # config.pid_file = '/path/to/rapns.pid'
 
-  # Define a block that will be called with a Rapns::Apns::Feedback instance
-  # when feedback is received from the APNs that a notification has
-  # failed to be delivered. Further notifications should not be sent to the device.
+ end
+
+Rapns.reflect do |on|
+
+  # Called with a Rapns::Apns::Feedback instance when feedback is received
+  # from the APNs that a notification has failed to be delivered.
+  # Further notifications should not be sent to the device.
+  # on.apns_feedback do |feedback|
+  # end
+
+  # Called when a notification is queued internally for delivery.
+  # The internal queue for each app runner can be inspected:
   #
-  # Example:
-  # config.on_apns_feedback do |feedback|
-  #   device = Device.find_by_device_token(feedback.device_token)
-  #   if device
-  #     device.active = false
-  #     device.save!
-  #   end
+  # Rapns::Daemon::AppRunner.runners.each do |app_id, runner|
+  #   runner.app
+  #   runner.queue_size
+  # end
+  #
+  # on.notification_enqueued do |notification|
   # end
 
- end
+  # Called when a notification is successfully delivered.
+  # on.notification_delivered do |notification|
+  # end
+
+  # Called when notification delivery failed.
+  # Call 'error_code' and 'error_description' on the notification for the cause.
+  # on.notification_failed do |notification|
+  # end
+
+  # Called when a notification will be retried at a later date.
+  # Call 'deliver_after' on the notification for the next delivery date
+  # and 'retries' for the number of times this notification has been retried.
+  # on.notification_will_retry do |notification|
+  # end
+
+  # Called when an APNs connection is lost and will be reconnected.
+  # on.apns_connection_lost do |app, error|
+  # end
+
+  # Called when an exception is raised.
+  # on.error do |error|
+  # end
+
+end

data/lib/rapns.rb

@@ -8,6 +8,9 @@ require 'rapns/multi_json_helper'
 require 'rapns/notification'
 require 'rapns/app'
 require 'rapns/configuration'
+require 'rapns/reflection'
+require 'rapns/embed'
+require 'rapns/push'
 
 require 'rapns/apns/binary_notification_validator'
 require 'rapns/apns/device_token_format_validator'
@@ -17,7 +20,14 @@ require 'rapns/apns/feedback'
 require 'rapns/apns/app'
 
 require 'rapns/gcm/expiry_collapse_key_mutual_inclusion_validator'
-require 'rapns/gcm/payload_size_validator'
+require 'rapns/gcm/payload_data_size_validator'
+require 'rapns/gcm/registration_ids_count_validator'
 require 'rapns/gcm/notification'
 require 'rapns/gcm/app'
 
+module Rapns
+  def self.require_for_daemon
+    require 'rapns/daemon'
+    require 'rapns/patches'
+  end
+end

data/lib/rapns/apns/notification.rb

@@ -43,13 +43,13 @@ module Rapns
 
       MDM_KEY = '__rapns_mdm__'
       def mdm=(magic)
-        self.attributes_for_device = { MDM_KEY => magic }
+        self.attributes_for_device = (attributes_for_device || {}).merge({ MDM_KEY => magic })
       end
 
       CONTENT_AVAILABLE_KEY = '__rapns_content_available__'
       def content_available=(bool)
         return unless bool
-        self.attributes_for_device = { CONTENT_AVAILABLE_KEY => true }
+        self.attributes_for_device = (attributes_for_device || {}).merge({ CONTENT_AVAILABLE_KEY => true })
       end
 
       def as_json
@@ -81,6 +81,12 @@ module Rapns
         [1, id_for_pack, expiry, 0, 32, device_token, payload_size, payload].pack("cNNccH*na*")
       end
 
+      def data=(attrs)
+        return unless attrs
+        raise ArgumentError, "must be a Hash" if !attrs.is_a?(Hash)
+        super attrs.merge(data || {})
+      end
+
     end
   end
 end

data/lib/rapns/app.rb

@@ -4,7 +4,7 @@ module Rapns
 
     attr_accessible :name, :environment, :certificate, :password, :connections, :auth_key
 
-    has_many :notifications
+    has_many :notifications, :class_name => 'Rapns::Notification'
 
     validates :name, :presence => true, :uniqueness => { :scope => [:type, :environment] }
     validates_numericality_of :connections, :greater_than => 0, :only_integer => true
@@ -16,8 +16,8 @@ module Rapns
     def certificate_has_matching_private_key
       result = false
       if certificate.present?
-        x509 = OpenSSL::X509::Certificate.new certificate rescue nil
-        pkey = OpenSSL::PKey::RSA.new certificate rescue nil
+        x509 = OpenSSL::X509::Certificate.new(certificate) rescue nil
+        pkey = OpenSSL::PKey::RSA.new(certificate, password) rescue nil
         result = !x509.nil? && !pkey.nil?
         unless result
           errors.add :certificate, 'Certificate value must contain a certificate and a private key.'

data/lib/rapns/configuration.rb

@@ -7,21 +7,21 @@ module Rapns
     yield config if block_given?
   end
 
-  CONFIG_ATTRS = [:foreground, :push_poll, :feedback_poll,
-    :airbrake_notify, :check_for_errors, :pid_file, :batch_size]
+  CONFIG_ATTRS = [:foreground, :push_poll, :feedback_poll, :embedded,
+    :airbrake_notify, :check_for_errors, :pid_file, :batch_size,
+    :push]
+
+  class ConfigurationWithoutDefaults < Struct.new(*CONFIG_ATTRS)
+  end
 
   class Configuration < Struct.new(*CONFIG_ATTRS)
+    include Deprecatable
+
     attr_accessor :apns_feedback_callback
 
     def initialize
       super
-
-      self.foreground = false
-      self.push_poll = 2
-      self.feedback_poll = 60
-      self.airbrake_notify = true
-      self.check_for_errors = true
-      self.batch_size = 5000
+      set_defaults
     end
 
     def update(other)
@@ -31,10 +31,6 @@ module Rapns
       end
     end
 
-    def on_apns_feedback(&block)
-      self.apns_feedback_callback = block
-    end
-
     def pid_file=(path)
       if path && !Pathname.new(path).absolute?
         super(File.join(Rails.root, path))
@@ -42,5 +38,42 @@ module Rapns
         super
       end
     end
+
+    def foreground=(bool)
+      if defined? JRUBY_VERSION
+        # The JVM does not support fork().
+        super(true)
+      else
+        super
+      end
+    end
+
+    def on_apns_feedback(&block)
+      self.apns_feedback_callback = block
+    end
+    deprecated(:on_apns_feedback, 3.2, "Please use the Rapns.reflect API instead.")
+
+    private
+
+    def set_defaults
+      if defined? JRUBY_VERSION
+        # The JVM does not support fork().
+        self.foreground = true
+      else
+        self.foreground = false
+      end
+
+      self.push_poll = 2
+      self.feedback_poll = 60
+      self.airbrake_notify = true
+      self.check_for_errors = true
+      self.batch_size = 5000
+      self.pid_file = nil
+      self.apns_feedback_callback = nil
+
+      # Internal options.
+      self.embedded = false
+      self.push = false
+    end
   end
 end

data/lib/rapns/daemon.rb

@@ -5,6 +5,7 @@ require 'openssl'
 
 require 'net/http/persistent'
 
+require 'rapns/daemon/reflectable'
 require 'rapns/daemon/interruptible_sleep'
 require 'rapns/daemon/delivery_error'
 require 'rapns/daemon/database_reconnectable'
@@ -37,9 +38,10 @@ module Rapns
     def self.start
       self.logger = Logger.new(:foreground => Rapns.config.foreground,
                                :airbrake_notify => Rapns.config.airbrake_notify)
-      setup_signal_hooks
 
-      unless Rapns.config.foreground
+      setup_signal_traps if trap_signals?
+
+      if daemonize?
         daemonize
         reconnect_database
       end
@@ -47,11 +49,22 @@ module Rapns
       write_pid_file
       ensure_upgraded
       AppRunner.sync
-      Feeder.start(Rapns.config.push_poll)
+      Feeder.start
+    end
+
+    def self.shutdown(quiet = false)
+      puts "\nShutting down..." unless quiet
+      Feeder.stop
+      AppRunner.stop
+      delete_pid_file
     end
 
     protected
 
+    def self.daemonize?
+      !(Rapns.config.foreground || Rapns.config.embedded || Rapns.config.push || defined?(JRUBY_VERSION))
+    end
+
     def self.ensure_upgraded
       count = 0
 
@@ -64,7 +77,7 @@ module Rapns
         puts "Please run 'rails g rapns' to generate the new migrations and create your app."
         puts "See https://github.com/ileitch/rapns for further instructions."
         puts
-        exit 1
+        exit 1 unless Rapns.config.embedded || Rapns.config.push
       end
 
       if count == 0
@@ -80,7 +93,11 @@ Remove config/rapns/rapns.yml to avoid this warning.
       end
     end
 
-    def self.setup_signal_hooks
+    def self.trap_signals?
+      !(Rapns.config.embedded || Rapns.config.push)
+    end
+
+    def self.setup_signal_traps
       @shutting_down = false
 
       Signal.trap('SIGHUP') { AppRunner.sync }
@@ -97,13 +114,6 @@ Remove config/rapns/rapns.yml to avoid this warning.
       shutdown
     end
 
-    def self.shutdown
-      puts "\nShutting down..."
-      Feeder.stop
-      AppRunner.stop
-      delete_pid_file
-    end
-
     def self.write_pid_file
       if !Rapns.config.pid_file.blank?
         begin
@@ -121,16 +131,17 @@ Remove config/rapns/rapns.yml to avoid this warning.
 
     # :nocov:
     def self.daemonize
-      exit if pid = fork
-      Process.setsid
-      exit if pid = fork
-
-      Dir.chdir '/'
-      File.umask 0000
-
-      STDIN.reopen '/dev/null'
-      STDOUT.reopen '/dev/null', 'a'
-      STDERR.reopen STDOUT
+      if RUBY_VERSION < "1.9"
+        exit if fork
+        Process.setsid
+        exit if fork
+        Dir.chdir "/"
+        STDIN.reopen "/dev/null"
+        STDOUT.reopen "/dev/null", "a"
+        STDERR.reopen "/dev/null", "a"
+      else
+        Process.daemon
+      end
     end
   end
 end