rapns 1.0.7 → 2.0.0rc1

data/spec/rapns/daemon_spec.rb

@@ -1,182 +1,122 @@
 require "spec_helper"
 
 describe Rapns::Daemon, "when starting" do
-  module Rails
-  end
-
-  let(:config) do
-    {
-      "airbrake_notify" => true,
-      "certificate" => "development.pem",
-      "certificate_password" => "abc123",
-      "pid_file" => "rapns.pid",
-      "push" => {
-        "port" => 123,
-        "host" => "localhost",
-        "poll" => 4,
-        "connections" => 3
-      },
-      "feedback" => {
-        "port" => 123,
-        "host" => "localhost",
-        "poll" => 30,
-      }
-    }
-  end
-
-  before 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" => config})
-    Rapns::Daemon::Configuration.stub(:new).and_return(@configuration)
+  module Rails; end
 
-    @certificate = Rapns::Daemon::Certificate.new("/rails_root/config/rapns/development.pem")
-    @certificate.stub(:read_certificate).and_return("certificate contents")
-    Rapns::Daemon::Certificate.stub(:new).and_return(@certificate)
+  let(:certificate) { stub }
+  let(:password) { stub }
+  let(:config) { stub(:pid_file => nil, :push_poll => 2, :airbrake_notify => false, :foreground => true) }
+  let(:logger) { stub(:info => nil, :error => nil) }
 
-    @handler_pool = Rapns::Daemon::DeliveryHandlerPool.new(3)
-    @handler_pool.stub(:populate)
-    Rapns::Daemon::DeliveryHandlerPool.stub(:new).and_return(@handler_pool)
-
-    Rapns::Daemon::FeedbackReceiver.stub(:start)
+  before do
     Rapns::Daemon::Feeder.stub(:start)
-    Rapns::Daemon.stub(:daemonize)
+    Rapns::Daemon::Logger.stub(:new).and_return(logger)
+    Rapns::Daemon::AppRunner.stub(:sync => nil, :stop => nil)
+    Rapns::Daemon.stub(:daemonize => nil, :reconnect_database => nil, :exit => nil, :puts => nil)
     File.stub(:open)
-    @logger = mock("Logger", :info => nil, :error => nil)
-    Rapns::Daemon::Logger.stub(:new).and_return(@logger)
-  end
-
-  it "should load the configuration" do
-    Rapns::Daemon::Configuration.should_receive(:new).with("development", "/rails_root/config/rapns/rapns.yml").and_return(@configuration)
-    @configuration.load
-    @configuration.should_receive(:load)
-    Rapns::Daemon.start("development", {})
-  end
-
-  it "should make the configuration accessible" do
-    Rapns::Daemon.start("development", {})
-    Rapns::Daemon.configuration.should == @configuration
-  end
-
-  it "should load the certificate" do
-    Rapns::Daemon::Certificate.should_receive(:new).with("/rails_root/config/rapns/development.pem").and_return(@certificate)
-    @certificate.should_receive(:load)
-    Rapns::Daemon.start("development", {})
-  end
-
-  it "should make the certificate accessible" do
-    Rapns::Daemon.start("development", {})
-    Rapns::Daemon.certificate.should == @certificate
+    Rails.stub(:root).and_return("/rails_root")
   end
 
-  it "should initialize the delivery queue" do
-    Rapns::Daemon::DeliveryQueue.should_receive(:new)
-    Rapns::Daemon.start("development", {})
+  it "forks into a daemon if the foreground option is false" do
+    config.stub(:foreground => false)
+    ActiveRecord::Base.stub(:establish_connection)
+    Rapns::Daemon.should_receive(:daemonize)
+    Rapns::Daemon.start("development", config)
   end
 
-  it "should populate the delivery handler pool" do
-    Rapns::Daemon::DeliveryHandlerPool.should_receive(:new).with(3).and_return(@handler_pool)
-    @handler_pool.should_receive(:populate)
-    Rapns::Daemon.start("development", {})
+  it "does not fork into a daemon if the foreground option is true" do
+    config.stub(:foreground => true)
+    Rapns::Daemon.should_not_receive(:daemonize)
+    Rapns::Daemon.start("development", config)
   end
 
-  it "should make the delivery handler pool accessible" do
-    Rapns::Daemon.start("development", {})
-    Rapns::Daemon.delivery_handler_pool.should == @handler_pool
+  it "writes the process ID to the PID file" do
+    Rapns::Daemon.should_receive(:write_pid_file)
+    Rapns::Daemon.start("development", config)
   end
 
-  it "should fork a child process if the foreground option is false" do
-    ActiveRecord::Base.stub(:establish_connection)
-    Rapns::Daemon.should_receive(:daemonize)
-    Rapns::Daemon.start("development", false)
+  it "logs an error if the PID file could not be written" do
+    config.stub(:pid_file => '/rails_root/rapns.pid')
+    File.stub(:open).and_raise(Errno::ENOENT)
+    logger.should_receive(:error).with("Failed to write PID to '/rails_root/rapns.pid': #<Errno::ENOENT: No such file or directory>")
+    Rapns::Daemon.start("development", config)
   end
 
-  it "should not fork a child process if the foreground option is true" do
-    Rapns::Daemon.should_not_receive(:daemonize)
-    Rapns::Daemon.start("development", true)
+  it "starts the feeder" do
+    Rapns::Daemon::Feeder.should_receive(:start).with(2)
+    Rapns::Daemon.start("development", config)
   end
 
-  it "should write the process ID to the PID file" do
-    Rapns::Daemon.should_receive(:write_pid_file)
-    Rapns::Daemon.start("development", {})
+  it "syncs apps" do
+    Rapns::Daemon::AppRunner.should_receive(:sync)
+    Rapns::Daemon.start("development", config)
   end
 
-  it "should log an error if the PID file could not be written" do
-    File.stub(:open).and_raise(Errno::ENOENT)
-    @logger.should_receive(:error).with("Failed to write PID to '/rails_root/rapns.pid': #<Errno::ENOENT: No such file or directory>")
-    Rapns::Daemon.start("development", {})
+  it "sets up the logger" do
+    config.stub(:airbrake_notify => true)
+    Rapns::Daemon::Logger.should_receive(:new).with(:foreground => true, :airbrake_notify => true)
+    Rapns::Daemon.start("development", config)
   end
 
-  it "should start the feedback receiver" do
-    Rapns::Daemon::FeedbackReceiver.should_receive(:start)
-    Rapns::Daemon.start("development", true)
+  it "makes the logger accessible" do
+    Rapns::Daemon.start("development", config)
+    Rapns::Daemon.logger.should == logger
   end
 
-  it "should start the feeder" do
-    Rapns::Daemon::Feeder.should_receive(:start)
-    Rapns::Daemon.start("development", true)
+  it 'prints a warning if there are no apps' do
+    Rapns::App.stub(:count => 0)
+    Rapns::Daemon.should_receive(:puts).any_number_of_times
+    Rapns::Daemon.should_receive(:exit).with(1)
+    Rapns::Daemon.start("development", config)
   end
 
-  it "should setup the logger" do
-    Rapns::Daemon::Logger.should_receive(:new).with(:foreground => true, :airbrake_notify => true).and_return(@logger)
-    Rapns::Daemon.start("development", true)
+  it 'prints a warning exists if rapns has not been upgraded' do
+    Rapns::App.stub(:count).and_raise(ActiveRecord::StatementInvalid)
+    Rapns::Daemon.should_receive(:puts).any_number_of_times
+    Rapns::Daemon.should_receive(:exit).with(1)
+    Rapns::Daemon.start("development", config)
   end
 
-  it "should make the logger accessible" do
-    Rapns::Daemon::Logger.stub(:new).and_return(@logger)
-    Rapns::Daemon.start("development", true)
-    Rapns::Daemon.logger.should == @logger
+  it 'warns if rapns.yml still exists' do
+    File.should_receive(:exists?).with('/rails_root/config/rapns/rapns.yml').and_return(true)
+    logger.should_receive(:warn).with("Since 2.0.0 rapns uses command-line options instead of a configuration file. Please remove config/rapns/rapns.yml.")
+    Rapns::Daemon.start("development", config)
   end
 end
 
 describe Rapns::Daemon, "when being shutdown" do
+  let(:config) { stub(:pid_file => '/rails_root/rapns.pid') }
+
   before do
-    Rails.stub(:root).and_return("/rails_root")
+    Rapns::Daemon.stub(:config => config, :puts => nil)
     Rapns::Daemon::Feeder.stub(:stop)
-    Rapns::Daemon::FeedbackReceiver.stub(:stop)
-    @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
-
-  it "should stop the feedback receiver" do
-    Rapns::Daemon::FeedbackReceiver.should_receive(:stop)
-    Rapns::Daemon.send(:shutdown)
+    Rapns::Daemon::AppRunner.stub(:stop)
   end
 
-  it "should stop the feeder" do
+  it "stops the feeder" do
     Rapns::Daemon::Feeder.should_receive(:stop)
     Rapns::Daemon.send(:shutdown)
   end
 
-  it "should drain the delivery handler pool" do
-    @handler_pool.should_receive(:drain)
-    Rapns::Daemon.send(:shutdown)
-  end
-
-  it "should not attempt to drain the delivery handler pool if it has not been initialized" do
-    Rapns::Daemon.stub(:delivery_handler_pool).and_return(nil)
-    @handler_pool.should_not_receive(:drain)
+  it "stops the app runners" do
+    Rapns::Daemon::AppRunner.should_receive(:stop)
     Rapns::Daemon.send(:shutdown)
   end
 
-  it "should remove the PID file if one was written" do
+  it "removes 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
+  it "does 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)
+  it "does not attempt to remove the PID file if one was not written" do
+    config.stub(:pid_file).and_return(nil)
     File.should_not_receive(:delete)
     Rapns::Daemon.send(:shutdown)
   end

data/spec/rapns/notification_spec.rb

@@ -101,6 +101,22 @@ describe Rapns::Notification, "as_json" do
   end
 end
 
+describe Rapns::Notification, 'MDM' do
+  let(:magic) { 'abc123' }
+  let(:notification) { Rapns::Notification.new }
+
+  it 'includes the mdm magic in the payload' do
+    notification.mdm = magic
+    notification.as_json.should == {'mdm' => magic}
+  end
+
+  it 'does not include aps attribute' do
+    notification.alert = "i'm doomed"
+    notification.mdm = magic
+    notification.as_json.key?('aps').should be_false
+  end
+end
+
 describe Rapns::Notification, "to_binary" do
   it "should correctly convert the notification to binary" do
     notification = Rapns::Notification.new

data/spec/spec_helper.rb

@@ -24,8 +24,11 @@ ActiveRecord::Base.establish_connection('adapter' => $adapter, 'database' => 'ra
 require 'generators/templates/create_rapns_notifications'
 require 'generators/templates/create_rapns_feedback'
 require 'generators/templates/add_alert_is_json_to_rapns_notifications'
+require 'generators/templates/add_app_to_rapns'
+require 'generators/templates/create_rapns_apps'
 
-[CreateRapnsNotifications, CreateRapnsFeedback, AddAlertIsJsonToRapnsNotifications].each do |migration|
+[CreateRapnsNotifications, CreateRapnsFeedback,
+ AddAlertIsJsonToRapnsNotifications, AddAppToRapns, CreateRapnsApps].each do |migration|
   migration.down rescue ActiveRecord::StatementInvalid
   migration.up
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rapns
 version: !ruby/object:Gem::Version
-  version: 1.0.7
-  prerelease: 
+  version: 2.0.0rc1
+  prerelease: 5
 platform: ruby
 authors:
 - Ian Leitch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-22 00:00:00.000000000 Z
+date: 2012-06-18 00:00:00.000000000 Z
 dependencies: []
 description: Easy to use library for Apple's Push Notification Service with Rails
   3
@@ -22,14 +22,15 @@ extra_rdoc_files: []
 files:
 - lib/generators/rapns_generator.rb
 - lib/generators/templates/add_alert_is_json_to_rapns_notifications.rb
+- lib/generators/templates/add_app_to_rapns.rb
+- lib/generators/templates/create_rapns_apps.rb
 - lib/generators/templates/create_rapns_feedback.rb
 - lib/generators/templates/create_rapns_notifications.rb
-- lib/generators/templates/rapns.yml
 - lib/rapns.rb
+- lib/rapns/app.rb
 - lib/rapns/binary_notification_validator.rb
 - lib/rapns/daemon.rb
-- lib/rapns/daemon/certificate.rb
-- lib/rapns/daemon/configuration.rb
+- lib/rapns/daemon/app_runner.rb
 - lib/rapns/daemon/connection.rb
 - lib/rapns/daemon/database_reconnectable.rb
 - lib/rapns/daemon/delivery_error.rb
@@ -41,7 +42,6 @@ files:
 - lib/rapns/daemon/feeder.rb
 - lib/rapns/daemon/interruptible_sleep.rb
 - lib/rapns/daemon/logger.rb
-- lib/rapns/daemon/pool.rb
 - lib/rapns/device_token_format_validator.rb
 - lib/rapns/feedback.rb
 - lib/rapns/notification.rb
@@ -50,9 +50,9 @@ files:
 - lib/rapns/patches/rails/3.1.1/postgresql_adapter.rb
 - lib/rapns/version.rb
 - README.md
-- History.md
-- spec/rapns/daemon/certificate_spec.rb
-- spec/rapns/daemon/configuration_spec.rb
+- CHANGELOG.md
+- LICENSE
+- spec/rapns/daemon/app_runner_spec.rb
 - spec/rapns/daemon/connection_spec.rb
 - spec/rapns/daemon/database_reconnectable_spec.rb
 - spec/rapns/daemon/delivery_error_spec.rb
@@ -83,18 +83,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Easy to use library for Apple's Push Notification Service with Rails 3
 test_files:
-- spec/rapns/daemon/certificate_spec.rb
-- spec/rapns/daemon/configuration_spec.rb
+- spec/rapns/daemon/app_runner_spec.rb
 - spec/rapns/daemon/connection_spec.rb
 - spec/rapns/daemon/database_reconnectable_spec.rb
 - spec/rapns/daemon/delivery_error_spec.rb

data/History.md

@@ -1,5 +0,0 @@
-
-1.0.7 / 2012-04-22 
-==================
-
-  * Reconnect if the connnection has been idle for more than 30 minutes. TCP Keepalive alone is not enough to ensure the connection is still connected.

data/lib/generators/templates/rapns.yml

@@ -1,31 +0,0 @@
-development:
-  certificate: development.pem
-  certificate_password:
-
-  push:
-    host: gateway.sandbox.push.apple.com
-    port: 2195
-    poll: 2
-    connections: 3
-
-  feedback:
-    host: feedback.sandbox.push.apple.com
-    port: 2196
-    poll: 60
-
-production:
-  certificate: production.pem
-  certificate_password:
-  airbrake_notify: true
-  pid_file: tmp/pids/rapns.pid
-
-  push:
-    host: gateway.push.apple.com
-    port: 2195
-    poll: 2
-    connections: 3
-
-  feedback:
-    host: feedback.push.apple.com
-    port: 2196
-    poll: 60

data/lib/rapns/daemon/certificate.rb

@@ -1,27 +0,0 @@
-module Rapns
-  class CertificateError < StandardError; end
-
-  module Daemon
-    class Certificate
-      attr_accessor :certificate
-
-      def initialize(certificate_path)
-        @certificate_path = certificate_path
-      end
-
-      def load
-        @certificate = read_certificate
-      end
-
-      protected
-
-      def read_certificate
-        if !File.exists?(@certificate_path)
-          raise CertificateError, "#{@certificate_path} does not exist. The certificate location can be configured in config/rapns/rapns.yml."
-        else
-          File.read(@certificate_path)
-        end
-      end
-    end
-  end
-end

data/lib/rapns/daemon/configuration.rb

@@ -1,98 +0,0 @@
-require "yaml"
-
-module Rapns
-  class ConfigurationError < StandardError; end
-
-  module Daemon
-    class Configuration
-      attr_accessor :push, :feedback
-      attr_accessor :certificate, :certificate_password, :airbrake_notify, :pid_file
-      alias_method  :airbrake_notify?, :airbrake_notify
-
-      def initialize(environment, config_path)
-        @environment = environment
-        @config_path = config_path
-
-        self.push = Struct.new(:host, :port, :connections, :poll).new
-        self.feedback = Struct.new(:host, :port, :poll).new
-      end
-
-      def load
-        config = read_config
-        ensure_environment_configured(config)
-        config = config[@environment]
-        set_variable(:push, :host, config)
-        set_variable(:push, :port, config)
-        set_variable(:push, :poll, config, :optional => true, :default => 2)
-        set_variable(:push, :connections, config, :optional => true, :default => 3)
-
-        set_variable(:feedback, :host, config)
-        set_variable(:feedback, :port, config)
-        set_variable(:feedback, :poll, config, :optional => true, :default => 60)
-
-        set_variable(nil, :certificate, config)
-        set_variable(nil, :airbrake_notify, config, :optional => true, :default => true)
-        set_variable(nil, :certificate_password, config, :optional => true, :default => "")
-        set_variable(nil, :pid_file, config, :optional => true, :default => "")
-      end
-
-      def certificate
-        if Pathname.new(@certificate).absolute?
-          @certificate
-        else
-          File.join(Rails.root, "config", "rapns", @certificate)
-        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
-        ensure_config_exists
-        File.open(@config_path) { |fd| YAML.load(fd) }
-      end
-
-      def set_variable(base_key, key, config, options = {})
-        if base_key
-          base = send(base_key)
-          value = config.key?(base_key.to_s) ? config[base_key.to_s][key.to_s] : nil
-        else
-          base = self
-          value = config[key.to_s]
-        end
-
-        if value.to_s.strip == ""
-          if options[:optional]
-            base.send("#{key}=", options[:default])
-          else
-            key_path = base_key ? "#{base_key}.#{key}" : key
-            raise Rapns::ConfigurationError, "'#{key_path}' not defined for environment '#{@environment}' in #{@config_path}. You may need to run 'rails g rapns' after updating."
-          end
-        else
-          base.send("#{key}=", value)
-        end
-      end
-
-      def ensure_config_exists
-        if !File.exists?(@config_path)
-          raise Rapns::ConfigurationError, "#{@config_path} does not exist. Have you run 'rails g rapns'?"
-        end
-      end
-
-      def ensure_environment_configured(config)
-        if !config.key?(@environment)
-          raise Rapns::ConfigurationError, "Configuration for environment '#{@environment}' not defined in #{@config_path}"
-        end
-      end
-    end
-  end
-end

data/lib/rapns/daemon/pool.rb

@@ -1,36 +0,0 @@
-module Rapns
-  module Daemon
-    class Pool
-      def initialize(num_objects)
-        @num_objects = num_objects
-        @queue = Queue.new
-      end
-
-      def populate
-        @num_objects.times do |i|
-          object = new_object_for_pool(i)
-          @queue.push(object)
-          object_added_to_pool(object)
-        end
-      end
-
-      def drain
-        while !@queue.empty?
-          object = @queue.pop
-          object_removed_from_pool(object)
-        end
-      end
-
-      protected
-
-      def new_object_for_pool(i)
-      end
-
-      def object_added_to_pool(object)
-      end
-
-      def object_removed_from_pool(object)
-      end
-    end
-  end
-end

data/spec/rapns/daemon/certificate_spec.rb

@@ -1,22 +0,0 @@
-require "spec_helper"
-
-describe Rapns::Daemon::Certificate do
-  it 'reads the certificate from the given path' do
-    File.stub(:exists? => true)
-    File.should_receive(:read).with("/dir/development.pem")
-    cert = Rapns::Daemon::Certificate.new("/dir/development.pem")
-    cert.load
-  end
-
-  it "should raise an error if the .pem file does not exist" do
-    cert = Rapns::Daemon::Certificate.new("/tmp/rapns-missing.pem")
-    expect { cert.load }.to raise_error(Rapns::CertificateError, "/tmp/rapns-missing.pem does not exist. The certificate location can be configured in config/rapns/rapns.yml.")
-  end
-
-  it "should set the certificate accessor" do
-    cert = Rapns::Daemon::Certificate.new("/dir/development.pem")
-    cert.stub(:read_certificate).and_return("certificate contents")
-    cert.load
-    cert.certificate.should == "certificate contents"
-  end
-end