rpush 2.0.1 → 2.1.0

data/lib/rpush/client/active_model/apns/binary_notification_validator.rb

@@ -3,10 +3,10 @@ module Rpush
     module ActiveModel
       module Apns
         class BinaryNotificationValidator < ::ActiveModel::Validator
-          MAX_BYTES = 256
+          MAX_BYTES = 2048
 
           def validate(record)
-            return unless record.payload_size > MAX_BYTES
+            return unless record.payload.bytesize > MAX_BYTES
             record.errors[:base] << "APN notification cannot be larger than #{MAX_BYTES} bytes. Try condensing your alert and device attributes."
           end
         end

data/lib/rpush/client/active_model/apns/notification.rb

@@ -48,6 +48,8 @@ module Rpush
               json['aps']['alert'] = alert if alert
               json['aps']['badge'] = badge if badge
               json['aps']['sound'] = sound if sound
+              json['aps']['category'] = category if category
+              json['aps']['url-args'] = url_args if url_args
 
               if data && data[CONTENT_AVAILABLE_KEY]
                 json['aps']['content-available'] = 1
@@ -63,10 +65,11 @@ module Rpush
           end
 
           def to_binary(options = {})
+            frame_payload = payload
             frame_id = options[:for_validation] ? 0 : id
             frame = ""
             frame << [1, 32, device_token].pack("cnH*")
-            frame << [2, payload.bytesize, payload].pack("cna*")
+            frame << [2, frame_payload.bytesize, frame_payload].pack("cna*")
             frame << [3, 4, frame_id].pack("cnN")
             frame << [4, 4, expiry || APNS_DEFAULT_EXPIRY].pack("cnN")
             frame << [5, 1, priority_for_frame].pack("cnc")

data/lib/rpush/client/active_model/notification.rb

@@ -13,10 +13,6 @@ module Rpush
           multi_json_dump(as_json)
         end
 
-        def payload_size
-          payload.bytesize
-        end
-
         def payload_data_size
           multi_json_dump(as_json['data']).bytesize
         end

data/lib/rpush/client/active_record/apns/notification.rb

@@ -6,12 +6,6 @@ module Rpush
           include Deprecatable
           include Rpush::Client::ActiveModel::Apns::Notification
 
-          alias_method :attributes_for_device=, :data=
-          alias_method :attributes_for_device, :data
-
-          deprecated(:attributes_for_device, '2.1.0', 'Use :data instead.')
-          deprecated(:attributes_for_device=, '2.1.0', 'Use :data instead.')
-
           def alert=(alert)
             if alert.is_a?(Hash)
               write_attribute(:alert, multi_json_dump(alert))

data/lib/rpush/client/active_record/notification.rb

@@ -7,15 +7,16 @@ module Rpush
 
         self.table_name = 'rpush_notifications'
 
-        # TODO: Dump using multi json.
         serialize :registration_ids
+        serialize :url_args
 
         belongs_to :app, class_name: 'Rpush::Client::ActiveRecord::App'
 
         if Rpush.attr_accessible_available?
           attr_accessible :badge, :device_token, :sound, :alert, :data, :expiry, :delivered,
                           :delivered_at, :failed, :failed_at, :error_code, :error_description, :deliver_after,
-                          :alert_is_json, :app, :app_id, :collapse_key, :delay_while_idle, :registration_ids, :uri
+                          :alert_is_json, :app, :app_id, :collapse_key, :delay_while_idle, :registration_ids,
+                          :uri, :url_args, :category
         end
 
         def data=(attrs)

data/lib/rpush/client/redis/notification.rb

@@ -40,6 +40,8 @@ module Rpush
         attribute :registration_ids, :array
         attribute :uri, :string
         attribute :priority, :integer
+        attribute :url_args, :array
+        attribute :category, :string
 
         def app
           return nil unless app_id

data/lib/rpush/configuration.rb

@@ -23,9 +23,10 @@ module Rpush
     @client_initialized = true
   end
 
-  CONFIG_ATTRS = [:foreground, :push_poll, :feedback_poll, :embedded,
-                  :check_for_errors, :pid_file, :batch_size, :push, :client, :logger,
-                  :batch_storage_updates, :log_dir, :environment]
+  CONFIG_ATTRS = [:push_poll, :feedback_poll, :embedded, :pid_file, :batch_size,
+                  :push, :client, :logger, :log_file, :foreground, :log_level,
+                  # Deprecated
+                  :log_dir]
 
   class ConfigurationWithoutDefaults < Struct.new(*CONFIG_ATTRS)
   end
@@ -33,8 +34,7 @@ module Rpush
   class Configuration < Struct.new(*CONFIG_ATTRS)
     include Deprecatable
 
-    deprecated(:batch_storage_updates=, '2.1.0', 'Updates are now always batched by the storage backends.')
-    deprecated(:check_for_errors=, '2.1.0', 'APNs error detection is now performed asynchronously and does not require pauses.')
+    deprecated(:log_dir=, '2.3.0', 'Please use log_file instead.')
 
     delegate :redis_options, :redis_options=, to: :Modis
 
@@ -52,45 +52,37 @@ module Rpush
 
     def pid_file=(path)
       if path && !Pathname.new(path).absolute?
-        super(File.join(Rails.root, path))
+        super(File.join(Rpush.root, path))
       else
         super
       end
     end
 
-    def logger=(logger)
-      super(logger)
-    end
-
-    def foreground=(bool)
-      if Rpush.jruby?
-        # The JVM does not support fork().
-        super(true)
+    def log_file=(path)
+      if path && !Pathname.new(path).absolute?
+        super(File.join(Rpush.root, path))
       else
         super
       end
     end
 
-    def set_defaults
-      if Rpush.jruby?
-        # The JVM does not support fork().
-        self.foreground = true
-      else
-        self.foreground = false
-      end
+    def logger=(logger)
+      super(logger)
+    end
 
+    def set_defaults
       self.push_poll = 2
       self.feedback_poll = 60
       self.batch_size = 100
-      self.pid_file = nil
       self.client = :active_record
       self.logger = nil
-      self.log_dir = Rails.root
+      self.log_file = 'log/rpush.log'
+      self.pid_file = 'tmp/rpush.pid'
+      self.log_level = (defined?(Rails) && Rails.logger) ? Rails.logger.level : ::Logger::Severity::INFO
 
       # Internal options.
       self.embedded = false
       self.push = false
-      self.environment = Rails.env
     end
   end
 end

data/lib/rpush/daemon.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 require 'thread'
 require 'socket'
 require 'pathname'
@@ -46,6 +48,8 @@ require 'rpush/daemon/adm'
 
 module Rpush
   module Daemon
+    extend Term::ANSIColor
+
     class << self
       attr_accessor :store
     end
@@ -60,6 +64,9 @@ module Rpush
       # No further store connections will be made from this thread.
       store.release_connection
 
+      Rpush.logger.info('Rpush operational.')
+      show_welcome_if_needed
+
       # Blocking call, returns after Feeder.stop is called from another thread.
       Feeder.start
 
@@ -68,12 +75,19 @@ module Rpush
     end
 
     def self.shutdown
-      puts "\nShutting down..."
+      if Rpush.config.foreground
+        # Eat the '^C'
+        STDOUT.write("\b\b")
+        STDOUT.flush
+      end
+
+      Rpush.logger.info('Shutting down... ', true)
 
       shutdown_lock.synchronize do
         Feeder.stop
         AppRunner.stop
         delete_pid_file
+        puts green('✔') if Rpush.config.foreground
       end
     end
 
@@ -105,6 +119,7 @@ module Rpush
     def self.write_pid_file
       unless Rpush.config.pid_file.blank?
         begin
+          FileUtils.mkdir_p(File.dirname(Rpush.config.pid_file))
           File.open(Rpush.config.pid_file, 'w') { |f| f.puts Process.pid }
         rescue SystemCallError => e
           Rpush.logger.error("Failed to write PID to '#{Rpush.config.pid_file}': #{e.inspect}")
@@ -116,5 +131,17 @@ module Rpush
       pid_file = Rpush.config.pid_file
       File.delete(pid_file) if !pid_file.blank? && File.exist?(pid_file)
     end
+
+    def self.show_welcome_if_needed
+      if Rpush::Daemon::AppRunner.app_ids.count == 0
+        puts <<-EOS
+
+* #{green('Is this your first time using Rpush?')}
+  You need to create an App before you can start using Rpush.
+  Please refer to the documentation at https://github.com/rpush/rpush
+
+        EOS
+      end
+    end
   end
 end

data/lib/rpush/daemon/app_runner.rb

@@ -1,6 +1,10 @@
+# encoding: UTF-8
+
 module Rpush
   module Daemon
     class AppRunner
+      extend Term::ANSIColor
+
       extend Reflectable
       include Reflectable
       include Loggable
@@ -24,9 +28,10 @@ module Rpush
       end
 
       def self.start_app(app)
+        Rpush.logger.info("[#{app.name}] Starting #{pluralize(app.connections, 'dispatcher')}... ", true)
         @runners[app.id] = new(app)
         @runners[app.id].start
-        log_info("[#{app.name}] Started, #{pluralize(app.connections, 'dispatcher')}.")
+        puts green('✔') if Rpush.config.foreground
       rescue StandardError => e
         @runners.delete(app.id)
         Rpush.logger.error("[#{app.name}] Exception raised during startup. Notifications will not be delivered for this app.")

data/lib/rpush/daemon/proc_title.rb

@@ -9,7 +9,7 @@ module Rpush
         total_dispatchers = AppRunner.total_dispatchers
         dispatchers_str = total_dispatchers == 1 ? 'dispatcher' : 'dispatchers'
         total_queued = AppRunner.total_queued
-        format("rpush | %s | %d queued | %d %s", Rpush.config.environment, total_queued, total_dispatchers, dispatchers_str)
+        format("rpush | %d queued | %d %s", total_queued, total_dispatchers, dispatchers_str)
       end
     end
   end

data/lib/rpush/daemon/signal_handler.rb

@@ -28,10 +28,9 @@ module Rpush
             begin
               case signal
               when 'HUP'
-                Synchronizer.sync
-                Feeder.wakeup
+                handle_hup
               when 'USR2'
-                AppRunner.debug
+                handle_usr2
               when 'INT', 'TERM'
                 Thread.new { Rpush::Daemon.shutdown }
                 break
@@ -48,6 +47,17 @@ module Rpush
         end
       end
 
+      def self.handle_hup
+        Rpush.logger.info("Received HUP signal.")
+        Synchronizer.sync
+        Feeder.wakeup
+      end
+
+      def self.handle_usr2
+        Rpush.logger.info("Received USR2 signal.")
+        AppRunner.debug
+      end
+
       def self.trap_signals?
         !Rpush.config.embedded
       end

data/lib/rpush/daemon/store/active_record.rb

@@ -166,7 +166,7 @@ module Rpush
         end
 
         def ready_for_delivery
-          Rpush::Client::ActiveRecord::Notification.where('processing = ? AND delivered = ? AND failed = ? AND (deliver_after IS NULL OR deliver_after < ?)', false, false, false, Time.now)
+          Rpush::Client::ActiveRecord::Notification.where('processing = ? AND delivered = ? AND failed = ? AND (deliver_after IS NULL OR deliver_after < ?)', false, false, false, Time.now).order('created_at ASC')
         end
 
         def mark_processing(notifications)

data/lib/rpush/deprecatable.rb

@@ -14,7 +14,8 @@ module Rpush
         warning << " #{msg}" if msg
         class_eval(<<-RUBY, __FILE__, __LINE__)
           def #{method_name}(*args, &blk)
-            Rpush::Deprecation.warn(#{warning.inspect})
+            trace = "\n\nCALLED FROM:\n" + caller.join("\n")
+            Rpush::Deprecation.warn(#{warning.inspect} + trace)
             #{method_name_as_var}_without_warning(*args, &blk)
           end
         RUBY

data/lib/rpush/embed.rb

@@ -1,6 +1,6 @@
 module Rpush
   def self.embed(options = {})
-    Rpush.require_for_daemon
+    require 'rpush/daemon'
 
     if @embed_thread
       STDERR.puts 'Rpush.embed can only be run once inside this process.'

data/lib/rpush/logger.rb

@@ -1,9 +1,8 @@
 module Rpush
   class Logger
     def initialize
-      log_dir = File.join(Rpush.config.log_dir, 'log')
-      FileUtils.mkdir_p(log_dir)
-      log = File.open(File.join(log_dir, 'rpush.log'), 'a')
+      FileUtils.mkdir_p(File.dirname(Rpush.config.log_file))
+      log = File.open(Rpush.config.log_file, 'a')
       log.sync = true
       setup_logger(log)
     rescue Errno::ENOENT, Errno::EPERM => e
@@ -12,16 +11,16 @@ module Rpush
       error('Logging disabled.')
     end
 
-    def info(msg)
-      log(:info, msg)
+    def info(msg, inline = false)
+      log(:info, msg, inline)
     end
 
-    def error(msg)
-      log(:error, msg, 'ERROR', STDERR)
+    def error(msg, inline = false)
+      log(:error, msg, inline, 'ERROR', STDERR)
     end
 
-    def warn(msg)
-      log(:warn, msg, 'WARNING', STDERR)
+    def warn(msg, inline = false)
+      log(:warn, msg, inline, 'WARNING', STDERR)
     end
 
     private
@@ -30,14 +29,22 @@ module Rpush
       if Rpush.config.logger
         @logger = Rpush.config.logger
       elsif ActiveSupport.const_defined?('BufferedLogger')
-        @logger = ActiveSupport::BufferedLogger.new(log, Rails.logger.level)
-        @logger.auto_flushing = Rails.logger.respond_to?(:auto_flushing) ? Rails.logger.auto_flushing : true
+        @logger = ActiveSupport::BufferedLogger.new(log, Rpush.config.log_level)
+        @logger.auto_flushing = auto_flushing
       else
-        @logger = ActiveSupport::Logger.new(log, Rails.logger.level)
+        @logger = ActiveSupport::Logger.new(log, Rpush.config.log_level)
       end
     end
 
-    def log(where, msg, prefix = nil, io = STDOUT)
+    def auto_flushing
+      if defined?(Rails) && Rails.logger.respond_to?(:auto_flushing)
+        Rails.logger.auto_flushing
+      else
+        true
+      end
+    end
+
+    def log(where, msg, inline = false, prefix = nil, io = STDOUT)
       if msg.is_a?(Exception)
         formatted_backtrace = msg.backtrace.join("\n")
         msg = "#{msg.class.name}, #{msg.message}\n#{formatted_backtrace}"
@@ -47,13 +54,19 @@ module Rpush
       formatted_msg << "[#{prefix}] " if prefix
       formatted_msg << msg
 
-      if io == STDERR
-        io.puts formatted_msg
-      elsif Rpush.config.foreground
-        io.puts formatted_msg
-      end
-
+      log_foreground(io, formatted_msg, inline)
       @logger.send(where, formatted_msg) if @logger
     end
+
+    def log_foreground(io, formatted_msg, inline)
+      return unless io == STDERR || Rpush.config.foreground
+
+      if inline
+        io.write(formatted_msg)
+        io.flush
+      else
+        io.puts(formatted_msg)
+      end
+    end
   end
 end

data/lib/rpush/push.rb

@@ -1,6 +1,6 @@
 module Rpush
   def self.push(options = {})
-    Rpush.require_for_daemon
+    require 'rpush/daemon'
 
     config = Rpush::ConfigurationWithoutDefaults.new
     options.each { |k, v| config.send("#{k}=", v) }

data/lib/rpush/version.rb

@@ -1,3 +1,3 @@
 module Rpush
-  VERSION = '2.0.1'
+  VERSION = '2.1.0'
 end

data/lib/tasks/quality.rake

@@ -7,7 +7,7 @@ begin
     cane.no_style = false
     cane.style_measure = 1000
     cane.no_doc = true
-    cane.abc_max = 20
+    cane.abc_max = 22
   end
 
   namespace :spec do

data/lib/tasks/test.rake

@@ -21,8 +21,20 @@ namespace :test do
     begin
       Dir.chdir(path)
       cmd('echo "gem \'rake\'" >> Gemfile')
+      cmd('echo "gem \'pg\'" >> Gemfile')
       cmd("echo \"gem 'rpush', :path => '#{rpush_root}'\" >> Gemfile")
       cmd('bundle install')
+
+      File.open('config/database.yml', 'w') do |fd|
+        fd.write(<<-YML)
+development:
+  adapter: postgresql
+  database: rpush_rails_test
+  pool: 5
+  timeout: 5000
+        YML
+      end
+
       cmd('bundle exec rails g rpush')
       cmd('bundle exec rake db:migrate')
     ensure