rapns 0.1.3 → 0.1.4

data/README.md

@@ -50,6 +50,7 @@ If you want to use rapns in environments other than development or production, y
 * `airbrake_notify` (default: true) Enables/disables error notifications via Airbrake.
 * `poll` (default: 2) Frequency in seconds to check for new notifications to deliver.
 * `connections` (default: 3) the number of connections to keep open to the APNs. Consider increasing this if you are sending a very large number of notifications.
+* `pid_file` (default: blank) the file that rapns will write its process ID to. Paths are relative to your project's RAILS_ROOT unless an absolute path is given.
 
 ## Starting the rapns Daemon
 

data/lib/generators/templates/rapns.yml

@@ -14,4 +14,5 @@ production:
   certificate_password:
   airbrake_notify: true
   poll: 2
-  connections: 3
+  connections: 3
+  pid_file: tmp/pids/rapns.pid

data/lib/rapns/daemon/configuration.rb

@@ -5,7 +5,7 @@ module Rapns
 
   module Daemon
     class Configuration
-      attr_accessor :host, :port, :certificate, :certificate_password, :poll, :airbrake_notify, :connections
+      attr_accessor :host, :port, :certificate, :certificate_password, :poll, :airbrake_notify, :connections, :pid_file
       alias_method  :airbrake_notify?, :airbrake_notify
 
       def initialize(environment, config_path)
@@ -24,6 +24,7 @@ module Rapns
         set_variable(:certificate_password, config, :optional => true, :default => "")
         set_variable(:poll, config, :optional => true, :default => 2)
         set_variable(:connections, config, :optional => true, :default => 3)
+        set_variable(:pid_file, config, :optional => true, :default => "")
       end
 
       def certificate
@@ -34,6 +35,16 @@ module Rapns
         end
       end
 
+      def pid_file
+        return if @pid_file.blank?
+
+        if Pathname.new(@pid_file).absolute?
+          @pid_file
+        else
+          File.join(Rails.root, @pid_file)
+        end
+      end
+
       protected
 
       def read_config

data/lib/rapns/daemon/connection.rb

@@ -40,7 +40,7 @@ module Rapns
 
           check_for_error
         rescue Errno::EPIPE => e
-          Rapns::Daemon.logger.warn("[#{@name}] Lost connection to #{Rapns::Daemon.configuration.host}:#{Rapns::Daemon.configuration.port}, reconnecting...")
+          Rapns::Daemon.logger.error("[#{@name}] Lost connection to #{Rapns::Daemon.configuration.host}:#{Rapns::Daemon.configuration.port}, reconnecting...")
           @tcp_socket, @ssl_socket = connect_socket
 
           retry_count += 1
@@ -70,7 +70,7 @@ module Rapns
           end
 
           begin
-            Rapns::Daemon.logger.warn("[#{@name}] Error received, reconnecting...")
+            Rapns::Daemon.logger.error("[#{@name}] Error received, reconnecting...")
             close
             @tcp_socket, @ssl_socket = connect_socket
           ensure

data/lib/rapns/daemon/delivery_handler.rb

@@ -47,7 +47,7 @@ module Rapns
         rescue StandardError => e
           Rapns::Daemon.logger.error(e)
         ensure
-          Rapns::Daemon.delivery_queue.signal
+          Rapns::Daemon.delivery_queue.signal_waiters_if_empty
         end
       end
     end

data/lib/rapns/daemon/delivery_queue.rb

@@ -5,11 +5,9 @@ module Rapns
         @queue = Queue.new
         @waiting_threads = []
         @mutex = Mutex.new
-        @counter = 0
       end
 
       def push(obj)
-        @mutex.synchronize { @counter += 1 }
         @queue.push(obj)
       end
 
@@ -17,11 +15,10 @@ module Rapns
         @queue.pop
       end
 
-      def signal
+      def signal_waiters_if_empty
         @mutex.synchronize do
           begin
-            @counter -= 1
-            if @counter <= 0
+            if @queue.size == 0
               t = @waiting_threads.shift
               t.wakeup if t
             end
@@ -31,9 +28,9 @@ module Rapns
         end
       end
 
-      def wait
+      def wait_until_empty
         Thread.exclusive do
-          if @counter > 0
+          if @queue.size > 0
             @waiting_threads << Thread.current
             Thread.stop
           end

data/lib/rapns/daemon/feeder.rb

@@ -14,7 +14,7 @@ module Rapns
             Rapns::Daemon.delivery_queue.push(notification)
           end
 
-          Rapns::Daemon.delivery_queue.wait
+          Rapns::Daemon.delivery_queue.wait_until_empty
         rescue StandardError => e
           Rapns::Daemon.logger.error(e)
         end

data/lib/rapns/daemon.rb

@@ -1,3 +1,7 @@
+require 'thread'
+require 'socket'
+require 'pathname'
+
 require "rapns/daemon/configuration"
 require "rapns/daemon/certificate"
 require "rapns/daemon/delivery_error"
@@ -37,6 +41,8 @@ module Rapns
         ActiveRecord::Base.establish_connection
       end
 
+      write_pid_file
+
       self.delivery_handler_pool = DeliveryHandlerPool.new(configuration.connections)
       delivery_handler_pool.populate
 
@@ -49,19 +55,27 @@ module Rapns
     protected
 
     def self.setup_signal_hooks
-      @sigint_received = false
-      Signal.trap("SIGINT") do
-        exit 1 if @sigint_received
-        @sigint_received = true
-        shutdown
+      @shutting_down = false
+
+      ["SIGINT", "SIGTERM"].each do |signal|
+        Signal.trap(signal) do
+          handle_shutdown_signal
+        end
       end
     end
 
+    def self.handle_shutdown_signal
+      exit 1 if @shutting_down
+      @shutting_down = true
+      shutdown
+    end
+
     def self.shutdown
       puts "\nShutting down..."
       Rapns::Daemon::Feeder.stop
       Rapns::Daemon.delivery_handler_pool.drain if Rapns::Daemon.delivery_handler_pool
       Rapns::Daemon.connection_pool.drain if Rapns::Daemon.connection_pool
+      delete_pid_file
     end
 
     def self.daemonize
@@ -76,5 +90,18 @@ module Rapns
       STDOUT.reopen '/dev/null', 'a'
       STDERR.reopen STDOUT
     end
+
+    def self.write_pid_file
+      if !configuration.pid_file.blank?
+        File.open(configuration.pid_file, "w") do |f|
+          f.puts $$
+        end
+      end
+    end
+
+    def self.delete_pid_file
+      pid_file = configuration.pid_file
+      File.delete(pid_file) if !pid_file.blank? && File.exists?(pid_file)
+    end
   end
 end

data/lib/rapns/version.rb

@@ -1,3 +1,3 @@
 module Rapns
-  VERSION = "0.1.3"
+  VERSION = '0.1.4'
 end

data/lib/rapns.rb

@@ -1,5 +1,5 @@
-require "active_record"
+require 'active_record'
 
-require "rapns/version"
-require "rapns/binary_notification_validator"
-require "rapns/notification"
+require 'rapns/version'
+require 'rapns/binary_notification_validator'
+require 'rapns/notification'

data/spec/rapns/daemon/configuration_spec.rb

@@ -5,7 +5,8 @@ describe Rapns::Daemon::Configuration do
   end
 
   before do
-    @config = {"port" => 123, "host" => "localhost", "certificate" => "production.pem", "certificate_password" => "abc123", "airbrake_notify" => false, "poll" => 4, "connections" => 6}
+    Rails.stub(:root).and_return("/rails_root")
+    @config = {"port" => 123, "host" => "localhost", "certificate" => "production.pem", "certificate_password" => "abc123", "airbrake_notify" => false, "poll" => 4, "connections" => 6, "pid_file" => "rapns.pid"}
   end
 
   it "should raise an error if the configuration file does not exist" do
@@ -107,7 +108,6 @@ describe Rapns::Daemon::Configuration do
   end
 
   it "should set the certificate, with absolute path" do
-    Rails.stub(:root).and_return("/rails_root")
     configuration = Rapns::Daemon::Configuration.new("production", "/some/config.yml")
     configuration.stub(:read_config).and_return({"production" => @config})
     configuration.load
@@ -115,11 +115,33 @@ describe Rapns::Daemon::Configuration do
   end
 
   it "should keep the absolute path of the certificate if it has one" do
-    Rails.stub(:root).and_return("/rails_root")
     @config["certificate"] = "/different_path/to/production.pem"
     configuration = Rapns::Daemon::Configuration.new("production", "/some/config.yml")
     configuration.stub(:read_config).and_return({"production" => @config})
     configuration.load
     configuration.certificate.should == "/different_path/to/production.pem"
   end
+
+  it "should set the PID file path" do
+    configuration = Rapns::Daemon::Configuration.new("production", "/some/config.yml")
+    configuration.stub(:read_config).and_return({"production" => @config})
+    configuration.load
+    configuration.pid_file.should == "/rails_root/rapns.pid"
+  end
+
+  it "should keep the absolute path of the PID file if it has one" do
+    @config["pid_file"] = "/some/absolue/path/rapns.pid"
+    configuration = Rapns::Daemon::Configuration.new("production", "/some/config.yml")
+    configuration.stub(:read_config).and_return({"production" => @config})
+    configuration.load
+    configuration.pid_file.should == "/some/absolue/path/rapns.pid"
+  end
+
+  it "should return nil if no PID file was set" do
+    @config["pid_file"] = ""
+    configuration = Rapns::Daemon::Configuration.new("production", "/some/config.yml")
+    configuration.stub(:read_config).and_return({"production" => @config})
+    configuration.load
+    configuration.pid_file.should be_nil
+  end
 end

data/spec/rapns/daemon/connection_spec.rb

@@ -122,15 +122,15 @@ describe Rapns::Daemon::Connection, "when the connection is lost" do
     @connection.instance_variable_set("@ssl_socket", @ssl_socket)
     @connection.stub(:connect_socket).and_return([mock("TCPSocket"), @ssl_socket])
     @ssl_socket.stub(:write).and_raise(Errno::EPIPE)
-    @logger = mock("Logger", :warn => nil)
+    @logger = mock("Logger", :error => nil)
     Rapns::Daemon.stub(:logger).and_return(@logger)
     @connection.stub(:sleep)
     configuration = mock("Configuration", :host => "localhost", :port => 123)
     Rapns::Daemon.stub(:configuration).and_return(configuration)
   end
 
-  it "should log a warning" do
-    Rapns::Daemon.logger.should_receive(:warn).with("[Connection 1] Lost connection to localhost:123, reconnecting...")
+  it "should log a error" do
+    Rapns::Daemon.logger.should_receive(:error).with("[Connection 1] Lost connection to localhost:123, reconnecting...")
     begin
       @connection.write(nil)
     rescue Rapns::Daemon::ConnectionError
@@ -248,7 +248,7 @@ describe Rapns::Daemon::Connection, "when receiving an error packet" do
   end
 
   it "should log that the connection is being reconnected" do
-    Rapns::Daemon.logger.should_receive(:warn).with("[Connection 1] Error received, reconnecting...")
+    Rapns::Daemon.logger.should_receive(:error).with("[Connection 1] Error received, reconnecting...")
     begin
       @connection.write("msg with an error")
     rescue Rapns::DeliveryError

data/spec/rapns/daemon/delivery_handler_spec.rb

@@ -59,6 +59,11 @@ describe Rapns::Daemon::DeliveryHandler do
     @delivery_handler.send(:handle_next_notification)
   end
 
+  it "should signal the feeder if the delivery queue is empty" do
+    Rapns::Daemon.delivery_queue.should_receive(:signal_waiters_if_empty)
+    @delivery_handler.send(:handle_next_notification)
+  end
+
   describe "when delivery fails" do
     before do
       @error = Rapns::DeliveryError.new(4, "Missing payload", 1)

data/spec/rapns/daemon/feeder_spec.rb

@@ -6,7 +6,7 @@ describe Rapns::Daemon::Feeder do
     @notification = Rapns::Notification.create!(:device_token => "a" * 64)
     @logger = mock("Logger", :info => nil, :error => nil)
     Rapns::Daemon.stub(:logger).and_return(@logger)
-    @queue = mock(:push => nil, :wait => nil)
+    @queue = mock(:push => nil, :wait_until_empty => nil)
     Rapns::Daemon.stub(:delivery_queue).and_return(@queue)
     Rapns::Daemon.stub(:configuration => mock("Configuration", :poll => 2))
   end
@@ -53,7 +53,7 @@ describe Rapns::Daemon::Feeder do
   end
 
   it "should wait for the delivery queue to be emptied" do
-    Rapns::Daemon.delivery_queue.should_receive(:wait)
+    Rapns::Daemon.delivery_queue.should_receive(:wait_until_empty)
     Rapns::Daemon::Feeder.enqueue_notifications
   end
 

data/spec/rapns/daemon_spec.rb

@@ -8,7 +8,7 @@ describe Rapns::Daemon, "when starting" do
     Rails.stub(:root).and_return("/rails_root")
 
     @configuration = Rapns::Daemon::Configuration.new("development", "/rails_root/config/rapns/rapns.yml")
-    @configuration.stub(:read_config).and_return({"development" => {"port" => 123, "host" => "localhost", "certificate" => "development.pem", "certificate_password" => "abc123"}})
+    @configuration.stub(:read_config).and_return({"development" => {"port" => 123, "host" => "localhost", "certificate" => "development.pem", "certificate_password" => "abc123", "pid_file" => "rapns.pid"}})
     Rapns::Daemon::Configuration.stub(:new).and_return(@configuration)
 
     @certificate = Rapns::Daemon::Certificate.new("/rails_root/config/rapns/development.pem")
@@ -26,6 +26,7 @@ describe Rapns::Daemon, "when starting" do
     Rapns::Daemon::Feeder.stub(:start)
     Rapns::Daemon::Feeder.stub(:wait)
     Rapns::Daemon.stub(:daemonize)
+    Rapns::Daemon.stub(:write_pid_file)
     @logger = mock("Logger")
     Rapns::Daemon::Logger.stub(:new).and_return(@logger)
   end
@@ -92,6 +93,11 @@ describe Rapns::Daemon, "when starting" do
     Rapns::Daemon.start("development", true)
   end
 
+  it "should write the process ID to the PID file" do
+    Rapns::Daemon.should_receive(:write_pid_file)
+    Rapns::Daemon.start("development", {})
+  end
+
   it "should start the feeder" do
     Rapns::Daemon::Feeder.should_receive(:start)
     Rapns::Daemon.start("development", true)
@@ -111,11 +117,14 @@ end
 
 describe Rapns::Daemon, "when being shutdown" do
   before do
+    Rails.stub(:root).and_return("/rails_root")
     Rapns::Daemon::Feeder.stub(:stop)
     @connection_pool = mock("ConnectionPool", :drain => nil)
     Rapns::Daemon.stub(:connection_pool).and_return(@connection_pool)
     @handler_pool = mock("DeliveryHandlerPool", :drain => nil)
     Rapns::Daemon.stub(:delivery_handler_pool).and_return(@handler_pool)
+    @configuration = mock("Configuration", :pid_file => File.join(Rails.root, "rapns.pid"))
+    Rapns::Daemon.stub(:configuration).and_return(@configuration)
     Rapns::Daemon.stub(:puts)
   end
 
@@ -145,4 +154,22 @@ describe Rapns::Daemon, "when being shutdown" do
     @handler_pool.should_not_receive(:drain)
     Rapns::Daemon.send(:shutdown)
   end
+
+  it "should remove the PID file if one was written" do
+    File.stub(:exists?).and_return(true)
+    File.should_receive(:delete).with("/rails_root/rapns.pid")
+    Rapns::Daemon.send(:shutdown)
+  end
+
+  it "should not attempt to remove the PID file if it does not exist" do
+    File.stub(:exists?).and_return(false)
+    File.should_not_receive(:delete)
+    Rapns::Daemon.send(:shutdown)
+  end
+
+  it "should not remove the PID file if one was not written" do
+    @configuration.stub(:pid_file).and_return(nil)
+    File.should_not_receive(:delete)
+    Rapns::Daemon.send(:shutdown)
+  end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,10 @@
 ENV["RAILS_ENV"] = "test"
 
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
 require "active_record"
 
 ActiveRecord::Base.establish_connection("adapter" => "postgresql", "database" => "rapns_test")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rapns
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-01 00:00:00.000000000Z
+date: 2011-10-08 00:00:00.000000000Z
 dependencies: []
 description: Easy to use library for Apple's Push Notification Service with Rails
   3
@@ -53,7 +53,7 @@ files:
 - spec/rapns/notification_spec.rb
 - spec/spec_helper.rb
 - bin/rapns
-homepage: ''
+homepage: https://github.com/ileitch/rapns
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -73,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Easy to use library for Apple's Push Notification Service with Rails 3