rapns 3.0.0.beta.1 → 3.0.0.rc.1

data/lib/rapns/daemon.rb

@@ -31,15 +31,15 @@ module Rapns
     extend DatabaseReconnectable
 
     class << self
-      attr_accessor :logger, :config
+      attr_accessor :logger
     end
 
-    def self.start(config)
-      self.config = config
-      self.logger = Logger.new(:foreground => config.foreground, :airbrake_notify => config.airbrake_notify)
+    def self.start
+      self.logger = Logger.new(:foreground => Rapns.config.foreground,
+                               :airbrake_notify => Rapns.config.airbrake_notify)
       setup_signal_hooks
 
-      unless config.foreground
+      unless Rapns.config.foreground
         daemonize
         reconnect_database
       end
@@ -47,7 +47,7 @@ module Rapns
       write_pid_file
       ensure_upgraded
       AppRunner.sync
-      Feeder.start(config.push_poll)
+      Feeder.start(Rapns.config.push_poll)
     end
 
     protected
@@ -61,18 +61,22 @@ module Rapns
         puts "!!!! RAPNS NOT STARTED !!!!"
         puts
         puts "As of version v2.0.0 apps are configured in the database instead of rapns.yml."
-        puts "Please run 'rails g rapns' to generate the new migrations and create your apps with Rapns::App."
+        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
       end
 
       if count == 0
-        logger.warn("You have not created an Rapns::App yet. See https://github.com/ileitch/rapns for instructions.")
+        logger.warn("You have not created an app yet. See https://github.com/ileitch/rapns for instructions.")
       end
 
       if File.exists?(File.join(Rails.root, 'config', 'rapns', 'rapns.yml'))
-        logger.warn("Since 2.0.0 rapns uses command-line options instead of a configuration file. Please remove config/rapns/rapns.yml.")
+        logger.warn(<<-EOS)
+Since 2.0.0 rapns uses command-line options and a Ruby based configuration file.
+Please run 'rails g rapns' to generate a new configuration file into config/initializers.
+Remove config/rapns/rapns.yml to avoid this warning.
+        EOS
       end
     end
 
@@ -80,7 +84,7 @@ module Rapns
       @shutting_down = false
 
       Signal.trap('SIGHUP') { AppRunner.sync }
-      Signal.trap('SIGUSR1') { AppRunner.debug }
+      Signal.trap('SIGUSR2') { AppRunner.debug }
 
       ['SIGINT', 'SIGTERM'].each do |signal|
         Signal.trap(signal) { handle_shutdown_signal }
@@ -101,17 +105,17 @@ module Rapns
     end
 
     def self.write_pid_file
-      if !config.pid_file.blank?
+      if !Rapns.config.pid_file.blank?
         begin
-          File.open(config.pid_file, 'w') { |f| f.puts Process.pid }
+          File.open(Rapns.config.pid_file, 'w') { |f| f.puts Process.pid }
         rescue SystemCallError => e
-          logger.error("Failed to write PID to '#{config.pid_file}': #{e.inspect}")
+          logger.error("Failed to write PID to '#{Rapns.config.pid_file}': #{e.inspect}")
         end
       end
     end
 
     def self.delete_pid_file
-      pid_file = config.pid_file
+      pid_file = Rapns.config.pid_file
       File.delete(pid_file) if !pid_file.blank? && File.exists?(pid_file)
     end
 

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

@@ -16,7 +16,7 @@ module Rapns
         protected
 
         def started
-          poll = Rapns::Daemon.config[:feedback_poll]
+          poll = Rapns.config[:feedback_poll]
           host, port = ENVIRONMENTS[app.environment.to_sym][:feedback]
           @feedback_receiver = FeedbackReceiver.new(app, host, port, poll)
           @feedback_receiver.start

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

@@ -25,7 +25,7 @@ module Rapns
         def perform
           begin
             @connection.write(@notification.to_binary)
-            check_for_error if Rapns::Daemon.config.check_for_errors
+            check_for_error if Rapns.config.check_for_errors
             mark_delivered
             Rapns::Daemon.logger.info("[#{@app.name}] #{@notification.id} sent to #{@notification.device_token}")
           rescue Rapns::DeliveryError, Rapns::Apns::DisconnectionError => error

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

@@ -62,7 +62,7 @@ module Rapns
             Rapns::Daemon.logger.info("[FeedbackReceiver:#{@app.name}] Delivery failed at #{formatted_failed_at} for #{device_token}")
             feedback = Rapns::Apns::Feedback.create!(:failed_at => failed_at, :device_token => device_token, :app => @app)
             begin
-              Rapns.configuration.feedback_callback.call(feedback) if Rapns.configuration.feedback_callback
+              Rapns.config.apns_feedback_callback.call(feedback) if Rapns.config.apns_feedback_callback
             rescue StandardError => e
               Rapns::Daemon.logger.error(e)
             end

data/lib/rapns/daemon/app_runner.rb

@@ -8,7 +8,7 @@ module Rapns
       @runners = {}
 
       def self.enqueue(notification)
-        if app = @runners[notification.app_id]
+        if app = runners[notification.app_id]
           app.enqueue(notification)
         else
           Rapns::Daemon.logger.error("No such app '#{notification.app_id}' for notification #{notification.id}.")
@@ -43,11 +43,11 @@ module Rapns
       end
 
       def self.stop
-        @runners.values.map(&:stop)
+        runners.values.map(&:stop)
       end
 
       def self.debug
-        @runners.values.map(&:debug)
+        runners.values.map(&:debug)
       end
 
       def self.idle
@@ -60,10 +60,6 @@ module Rapns
         @app = app
       end
 
-      def new_delivery_handler
-        raise NotImplementedError
-      end
-
       def started
       end
 
@@ -73,6 +69,7 @@ module Rapns
       def start
         app.connections.times { handlers << start_handler }
         started
+        Rapns::Daemon.logger.info("[#{app.name}] Started, #{handlers_str}.")
       end
 
       def stop
@@ -87,10 +84,13 @@ module Rapns
       def sync(app)
         @app = app
         diff = handlers.size - app.connections
+        return if diff == 0
         if diff > 0
           diff.times { handlers.pop.stop }
+          Rapns::Daemon.logger.info("[#{app.name}] Terminated #{handlers_str(diff)}. #{handlers_str} remaining.")
         else
           diff.abs.times { handlers << start_handler }
+          Rapns::Daemon.logger.info("[#{app.name}] Added #{handlers_str(diff)}. #{handlers_str} remaining.")
         end
       end
 
@@ -124,6 +124,12 @@ module Rapns
       def handlers
         @handler ||= []
       end
+
+      def handlers_str(count = app.connections)
+        count = count.abs
+        str = count == 1 ? 'handler' : 'handlers'
+        "#{count} #{str}"
+      end
     end
   end
 end

data/lib/rapns/daemon/delivery_handler.rb

@@ -3,10 +3,6 @@ module Rapns
     class DeliveryHandler
       attr_accessor :queue
 
-      def deliver(notification)
-        raise NotImplementedError
-      end
-
       def start
         @thread = Thread.new do
           loop do

data/lib/rapns/daemon/feeder.rb

@@ -4,10 +4,6 @@ module Rapns
       extend InterruptibleSleep
       extend DatabaseReconnectable
 
-      def self.name
-        'Feeder'
-      end
-
       def self.start(poll)
         loop do
           enqueue_notifications
@@ -26,7 +22,7 @@ module Rapns
       def self.enqueue_notifications
         begin
           with_database_reconnect_and_retry do
-            batch_size = Rapns::Daemon.config.batch_size
+            batch_size = Rapns.config.batch_size
             idle = Rapns::Daemon::AppRunner.idle.map(&:app)
             Rapns::Notification.ready_for_delivery.for_apps(idle).limit(batch_size).each do |notification|
               Rapns::Daemon::AppRunner.enqueue(notification)

data/lib/rapns/daemon/logger.rb

@@ -3,10 +3,17 @@ module Rapns
     class Logger
       def initialize(options)
         @options = options
-        log = File.open(File.join(Rails.root, 'log', 'rapns.log'), 'a')
-        log.sync = true
-        @logger = ActiveSupport::BufferedLogger.new(log, Rails.logger.level)
-        @logger.auto_flushing = Rails.logger.respond_to?(:auto_flushing) ? Rails.logger.auto_flushing : true
+
+        begin
+          log = File.open(File.join(Rails.root, 'log', 'rapns.log'), 'a')
+          log.sync = true
+          @logger = ActiveSupport::BufferedLogger.new(log, Rails.logger.level)
+          @logger.auto_flushing = Rails.logger.respond_to?(:auto_flushing) ? Rails.logger.auto_flushing : true
+        rescue Errno::ENOENT, Errno::EPERM => e
+          @logger = nil
+          error(e)
+          error('Logging disabled.')
+        end
       end
 
       def info(msg)
@@ -15,16 +22,16 @@ module Rapns
 
       def error(msg, options = {})
         airbrake_notify(msg) if notify_via_airbrake?(msg, options)
-        log(:error, msg, 'ERROR')
+        log(:error, msg, 'ERROR', STDERR)
       end
 
       def warn(msg)
-        log(:warn, msg, 'WARNING')
+        log(:warn, msg, 'WARNING', STDERR)
       end
 
       private
 
-      def log(where, msg, prefix = nil)
+      def log(where, msg, prefix = nil, io = STDOUT)
         if msg.is_a?(Exception)
           formatted_backtrace = msg.backtrace.join("\n")
           msg = "#{msg.class.name}, #{msg.message}\n#{formatted_backtrace}"
@@ -33,8 +40,14 @@ module Rapns
         formatted_msg = "[#{Time.now.to_s(:db)}] "
         formatted_msg << "[#{prefix}] " if prefix
         formatted_msg << msg
-        puts formatted_msg if @options[:foreground]
-        @logger.send(where, formatted_msg)
+
+        if io == STDERR
+          io.puts formatted_msg
+        elsif @options[:foreground]
+          io.puts formatted_msg
+        end
+
+        @logger.send(where, formatted_msg) if @logger
       end
 
       def airbrake_notify(e)

data/lib/rapns/version.rb

@@ -1,3 +1,3 @@
 module Rapns
-  VERSION = '3.0.0.beta.1'
+  VERSION = '3.0.0.rc.1'
 end

data/lib/tasks/cane.rake

@@ -3,12 +3,11 @@ begin
 
   desc "Run cane to check quality metrics"
   Cane::RakeTask.new(:quality) do |cane|
-    cane.add_threshold 'coverage/covered_percent', :>=, 97
+    cane.add_threshold 'coverage/covered_percent', :>=, 99
     cane.no_style = false
     cane.style_measure = 1000
     cane.no_doc = true
-    cane.abc_max = 15
-    cane.abc_exclude = %w(Rapns::Daemon::Gcm::Delivery#handle_errors)
+    cane.abc_max = 20
   end
 
   namespace :spec do

data/lib/tasks/test.rake

@@ -16,12 +16,11 @@ namespace :test do
     pwd = Dir.pwd
 
     cmd("bundle exec rails new #{path} --skip-bundle")
-    branch = cmd("git branch | grep '\*'").split(' ').last
 
     begin
       Dir.chdir(path)
       cmd('echo "gem \'rake\'" >> Gemfile')
-      cmd("echo \"gem 'rapns', :git => '#{rapns_root}', :branch => '#{branch}'\" >> Gemfile")
+      cmd("echo \"gem 'rapns', :path => '#{rapns_root}'\" >> Gemfile")
       cmd('bundle install')
       cmd('bundle exec rails g rapns')
       cmd('bundle exec rake db:migrate')

data/spec/unit/apns/notification_spec.rb

@@ -25,13 +25,23 @@ describe Rapns::Apns::Notification do
     notification.errors[:base].include?("APN notification cannot be larger than 256 bytes. Try condensing your alert and device attributes.").should be_true
   end
 
-  it "should default the sound to 1.aiff" do
-    notification.sound.should == "1.aiff"
+  it "should default the sound to 'default'" do
+    notification.sound.should eq('default')
   end
 
   it "should default the expiry to 1 day" do
     notification.expiry.should == 1.day.to_i
   end
+
+  # The notification must contain one of alert, sound or badge.
+  # @see https://developer.apple.com/library/ios/#documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/ApplePushService/ApplePushService.html
+  it "should not be valid if there is none of alert,sound,badge present" do
+    notification.alert = nil
+    notification.sound = nil
+    notification.badge = nil
+    notification.valid?.should be_false
+    notification.errors[:base].should include("APN Notification must contain one of alert, badge, or sound")
+  end
 end
 
 describe Rapns::Apns::Notification, "when assigning the device token" do

data/spec/unit/configuration_spec.rb

@@ -0,0 +1,38 @@
+require 'unit_spec_helper'
+
+describe Rapns do
+  let(:config) { stub }
+
+  before { Rapns.stub(:config => config) }
+
+  it 'can yields a config block' do
+    expect { |b| Rapns.configure(&b) }.to yield_with_args(config)
+  end
+end
+
+describe Rapns::Configuration do
+  let(:config) { Rapns::Configuration.new }
+
+  it 'configures a feedback callback' do
+    b = Proc.new {}
+    config.on_apns_feedback(&b)
+    config.apns_feedback_callback.should == b
+  end
+
+  it 'can be updated' do
+    new_config = Rapns::Configuration.new
+    new_config.batch_size = 100
+    expect { config.update(new_config) }.to change(config, :batch_size).to(100)
+  end
+
+  it 'sets the pid_file relative if not absolute' do
+    Rails.stub(:root => '/rails')
+    config.pid_file = 'tmp/rapns.pid'
+    config.pid_file.should == '/rails/tmp/rapns.pid'
+  end
+
+  it 'does not alter an absolute pid_file path' do
+    config.pid_file = '/tmp/rapns.pid'
+    config.pid_file.should == '/tmp/rapns.pid'
+  end
+end

data/spec/unit/daemon/apns/app_runner_spec.rb

@@ -11,8 +11,10 @@ describe Rapns::Daemon::Apns::AppRunner do
   let(:handler) { stub(:start => nil, :stop => nil, :queue= => nil) }
   let(:receiver) { stub(:start => nil, :stop => nil) }
   let(:config) { {:feedback_poll => 60 } }
+  let(:logger) { stub(:info => nil) }
 
   before do
+    Rapns::Daemon.stub(:logger => logger)
     Rapns::Daemon::Apns::DeliveryHandler.stub(:new => handler)
     Rapns::Daemon::Apns::FeedbackReceiver.stub(:new => receiver)
     Rapns::Daemon.stub(:config => config)

data/spec/unit/daemon/apns/delivery_spec.rb

@@ -16,7 +16,8 @@ describe Rapns::Daemon::Apns::Delivery do
   end
 
   before do
-    Rapns::Daemon.stub(:logger => logger, :config => config)
+    Rapns.stub(:config => config)
+    Rapns::Daemon.stub(:logger => logger)
   end
 
   it "sends the binary version of the notification" do
@@ -95,9 +96,14 @@ describe Rapns::Daemon::Apns::Delivery do
     end
 
     it "logs the delivery error" do
-      error = Rapns::DeliveryError.new(4, 12, "Missing payload")
-      Rapns::DeliveryError.stub(:new => error)
-      expect { delivery.perform }.to raise_error(error)
+      # checking for the stubbed error doesn't work in jruby, but checking
+      # for the exception by class does.
+
+      #error = Rapns::DeliveryError.new(4, 12, "Missing payload")
+      #Rapns::DeliveryError.stub(:new => error)
+      #expect { delivery.perform }.to raise_error(error)
+
+      expect { delivery.perform }.to raise_error(Rapns::DeliveryError)
     end
 
     it "sets the notification error description" do

data/spec/unit/daemon/apns/disconnection_error_spec.rb

@@ -0,0 +1,18 @@
+require 'unit_spec_helper'
+
+describe Rapns::Apns::DisconnectionError do
+  let(:error) { Rapns::Apns::DisconnectionError.new }
+
+  it 'returns a nil error code' do
+    error.code.should be_nil
+  end
+
+  it 'contains an error description' do
+    error.description
+  end
+
+  it 'returns a message' do
+    error.message
+    error.to_s
+  end
+end

data/spec/unit/daemon/apns/feedback_receiver_spec.rb

@@ -90,29 +90,29 @@ describe Rapns::Daemon::Apns::FeedbackReceiver, 'check_for_feedback' do
     receiver.stop
   end
 
-  it 'calls the configuration feedback_callback when feedback is received and the callback is set' do
+  it 'calls the apns_feedback_callback when feedback is received and the callback is set' do
     stub_connection_read_with_tuple
-    Rapns.configuration.feedback_callback = Proc.new {}
+    Rapns.config.apns_feedback_callback = Proc.new {}
     feedback = Object.new
     Rapns::Apns::Feedback.stub(:create! => feedback)
-    Rapns.configuration.feedback_callback.should_receive(:call).with(feedback)
+    Rapns.config.apns_feedback_callback.should_receive(:call).with(feedback)
     receiver.check_for_feedback
   end
 
-  it 'catches exceptions in the feedback_callback' do
+  it 'catches exceptions in the apns_feedback_callback' do
     error = StandardError.new('bork!')
     stub_connection_read_with_tuple
     callback = Proc.new { raise error }
-    Rapns::configuration.feedback_callback = callback
+    Rapns.config.on_apns_feedback &callback
     expect { receiver.check_for_feedback }.not_to raise_error
   end
 
-  it 'logs an exception from the feedback_callback' do
+  it 'logs an exception from the apns_feedback_callback' do
     error = StandardError.new('bork!')
     stub_connection_read_with_tuple
     callback = Proc.new { raise error }
     Rapns::Daemon.logger.should_receive(:error).with(error)
-    Rapns::configuration.feedback_callback = callback
+    Rapns.config.on_apns_feedback &callback
     receiver.check_for_feedback
   end
 end