rapns 3.3.0 → 3.3.1

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 3.3.1 (June 2, 2013)
+  * Fix compatibility with postgres_ext (#104).
+  * Add ability to switch the logger (@maxsz).
+  * Do not validate presence of alert, badge or sound - not actually required by the APNs (#129) (@wilg).
+  * Catch IOError from an APNs connection. (@maxsz).
+  * Allow nested hashes in APNs notification attributes (@perezda).
+
 ## 3.3.0 (April 21, 2013)
   * GCM: collapse_key is no longer required to set expiry (time_to_live).
   * Add reflection for GCM canonical IDs.

data/README.md

@@ -89,14 +89,18 @@ As a daemon:
 
 Inside an existing process (see [Embedding API](https://github.com/ileitch/rapns/wiki/Embedding-API)):
 
-    Rapns.embed
+```ruby
+Rapns.embed
+```
 
 *Please note that only ever a single instance of Rapns should be running.*
 
 In a scheduler (see [Push API](https://github.com/ileitch/rapns/wiki/Push-API)):
 
-    Rapns.push
-    Rapns.apns_feedback
+```ruby
+Rapns.push
+Rapns.apns_feedback
+```
 
 See [Configuration](https://github.com/ileitch/rapns/wiki/Configuration) for a list of options, or run `rapns --help`.
 
@@ -115,6 +119,7 @@ After updating you should run `rails g rapns` to check for any new migrations.
 * [Reflection API](https://github.com/ileitch/rapns/wiki/Reflection-API)
 * [Push API](https://github.com/ileitch/rapns/wiki/Push-API)
 * [Embedding API](https://github.com/ileitch/rapns/wiki/Embedding-API)
+* [Implementing your own storage backend](https://github.com/ileitch/rapns/wiki/Implementing-your-own-storage-backend)
 
 ### APNs
 * [Generating Certificates](https://github.com/ileitch/rapns/wiki/Generating-Certificates)
@@ -158,3 +163,6 @@ Thank you to the following wonderful people for contributing:
 * [@jeffarena](https://github.com/jeffarena)
 * [@DianthuDia](https://github.com/DianthuDia)
 * [@dup2](https://github.com/dup2)
+* [@maxsz](https://github.com/maxsz)
+* [@wilg](https://github.com/wilg)
+* [@perezda](https://github.com/perezda)

data/lib/generators/templates/rapns.rb

@@ -23,6 +23,9 @@
   # Path to write PID file. Relative to Rails root unless absolute.
   # config.pid_file = '/path/to/rapns.pid'
 
+  # Define a custom logger.
+  # config.logger = MyLogger.new
+
  end
 
 Rapns.reflect do |on|

data/lib/rapns.rb

@@ -17,7 +17,6 @@ require 'rapns/upgraded'
 
 require 'rapns/apns/binary_notification_validator'
 require 'rapns/apns/device_token_format_validator'
-require 'rapns/apns/required_fields_validator'
 require 'rapns/apns/notification'
 require 'rapns/apns/feedback'
 require 'rapns/apns/app'

data/lib/rapns/apns/notification.rb

@@ -8,7 +8,6 @@ module Rapns
 
       validates_with Rapns::Apns::DeviceTokenFormatValidator
       validates_with Rapns::Apns::BinaryNotificationValidator
-      validates_with Rapns::Apns::RequiredFieldsValidator
 
       alias_method :attributes_for_device=, :data=
       alias_method :attributes_for_device, :data
@@ -69,7 +68,7 @@ module Rapns
 
           if attributes_for_device
             non_aps_attributes = attributes_for_device.reject { |k, v| k == CONTENT_AVAILABLE_KEY }
-            non_aps_attributes.each { |k, v| json[k.to_s] = v.to_s }
+            non_aps_attributes.each { |k, v| json[k.to_s] = v }
           end
         end
 

data/lib/rapns/configuration.rb

@@ -9,7 +9,7 @@ module Rapns
 
   CONFIG_ATTRS = [:foreground, :push_poll, :feedback_poll, :embedded,
     :airbrake_notify, :check_for_errors, :pid_file, :batch_size,
-    :push, :store]
+    :push, :store, :logger]
 
   class ConfigurationWithoutDefaults < Struct.new(*CONFIG_ATTRS)
   end
@@ -39,6 +39,10 @@ module Rapns
       end
     end
 
+    def logger=(logger)
+      super(logger)
+    end
+
     def foreground=(bool)
       if Rapns.jruby?
         # The JVM does not support fork().
@@ -53,8 +57,6 @@ module Rapns
     end
     deprecated(:on_apns_feedback, 3.2, "Please use the Rapns.reflect API instead.")
 
-    private
-
     def set_defaults
       if Rapns.jruby?
         # The JVM does not support fork().
@@ -71,6 +73,7 @@ module Rapns
       self.pid_file = nil
       self.apns_feedback_callback = nil
       self.store = :active_record
+      self.logger = nil
 
       # Internal options.
       self.embedded = false

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

@@ -49,7 +49,7 @@ module Rapns
 
           begin
             write_data(data)
-          rescue Errno::EPIPE, Errno::ETIMEDOUT, OpenSSL::SSL::SSLError => e
+          rescue Errno::EPIPE, Errno::ETIMEDOUT, OpenSSL::SSL::SSLError, IOError => e
             retry_count += 1;
 
             if retry_count == 1

data/lib/rapns/logger.rb

@@ -6,12 +6,7 @@ module Rapns
       begin
         log = File.open(File.join(Rails.root, 'log', 'rapns.log'), 'a')
         log.sync = true
-        if defined?(ActiveSupport::BufferedLogger)
-          @logger = ActiveSupport::BufferedLogger.new(log, Rails.logger.level)
-          @logger.auto_flushing = Rails.logger.respond_to?(:auto_flushing) ? Rails.logger.auto_flushing : true
-        else
-          @logger = ActiveSupport::Logger.new(log, Rails.logger.level)
-        end
+        setup_logger(log)
       rescue Errno::ENOENT, Errno::EPERM => e
         @logger = nil
         error(e)
@@ -34,6 +29,17 @@ module Rapns
 
     private
 
+    def setup_logger(log)
+      if Rapns.config.logger
+        @logger = Rapns.config.logger
+      elsif defined?(ActiveSupport::BufferedLogger)
+        @logger = ActiveSupport::BufferedLogger.new(log, Rails.logger.level)
+        @logger.auto_flushing = Rails.logger.respond_to?(:auto_flushing) ? Rails.logger.auto_flushing : true
+      else
+        @logger = ActiveSupport::Logger.new(log, Rails.logger.level)
+      end
+    end
+
     def log(where, msg, prefix = nil, io = STDOUT)
       if msg.is_a?(Exception)
         formatted_backtrace = msg.backtrace.join("\n")

data/lib/rapns/notification.rb

@@ -22,7 +22,7 @@ module Rapns
     }
 
     scope :for_apps, lambda { |apps|
-      where(:app_id => apps.map(&:id))
+      where('app_id IN (?)', apps.map(&:id))
     }
 
     def initialize(*args)

data/lib/rapns/version.rb

@@ -1,3 +1,3 @@
 module Rapns
-  VERSION = '3.3.0'
+  VERSION = '3.3.1'
 end

data/spec/unit/apns/notification_spec.rb

@@ -31,16 +31,6 @@ describe Rapns::Apns::Notification do
   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
@@ -97,6 +87,13 @@ describe Rapns::Apns::Notification, "as_json" do
     notification.as_json["omg"].should == "lol"
     notification.as_json["wtf"].should == "dunno"
   end
+
+  it "should allow attributes to include a hash" do
+    notification = Rapns::Apns::Notification.new
+    notification.attributes_for_device = {:omg => {:ilike => :hashes}}
+    notification.as_json["omg"]["ilike"].should == "hashes"
+  end
+
 end
 
 describe Rapns::Apns::Notification, 'MDM' do

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

@@ -185,6 +185,14 @@ describe Rapns::Daemon::Apns::Connection do
     end
   end
 
+  describe "when write raises an IOError" do
+    it_should_behave_like "when the write fails"
+
+    def error_type
+      IOError
+    end
+  end
+
   describe "when reconnecting" do
     it 'closes the socket' do
       connection.should_receive(:close)

data/spec/unit/daemon_spec.rb

@@ -7,7 +7,8 @@ describe Rapns::Daemon, "when starting" do
   let(:certificate) { stub }
   let(:password) { stub }
   let(:config) { stub(:pid_file => nil, :airbrake_notify => false,
-    :foreground => true, :embedded => false, :push => false, :store => :active_record) }
+    :foreground => true, :embedded => false, :push => false,
+    :store => :active_record, :logger => nil) }
   let(:logger) { stub(:logger, :info => nil, :error => nil, :warn => nil) }
 
   before do
@@ -102,6 +103,7 @@ end
 
 describe Rapns::Daemon, "when being shutdown" do
   let(:config) { stub(:pid_file => '/rails_root/rapns.pid') }
+  let(:logger) { stub(:info => nil, :error => nil, :warn => nil) }
 
   before do
     Rapns.stub(:config => config)

data/spec/unit/logger_spec.rb

@@ -55,6 +55,14 @@ describe Rapns::Logger do
     Rapns::Logger.new(:foreground => true)
   end
 
+  it 'uses the user-defined logger' do
+    my_logger = stub
+    Rapns.config.logger = my_logger
+    logger = Rapns::Logger.new({})
+    my_logger.should_receive(:info)
+    logger.info('test')
+  end
+
   it "should print out the msg if running in the foreground" do
     logger = Rapns::Logger.new(:foreground => true)
     STDOUT.should_receive(:puts).with(/hi mom/)

data/spec/unit_spec_helper.rb

@@ -75,6 +75,7 @@ RSpec.configure do |config|
   config.after(:each) do
     Rapns.logger = nil
     Rapns::Daemon.store = nil
+    Rapns.config.set_defaults if Rapns.config.kind_of?(Rapns::Configuration)
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rapns
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-21 00:00:00.000000000 Z
+date: 2013-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -68,7 +68,6 @@ files:
 - lib/rapns/apns/device_token_format_validator.rb
 - lib/rapns/apns/feedback.rb
 - lib/rapns/apns/notification.rb
-- lib/rapns/apns/required_fields_validator.rb
 - lib/rapns/apns_feedback.rb
 - lib/rapns/app.rb
 - lib/rapns/configuration.rb
@@ -175,7 +174,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3085387548794744992
+      hash: -138032401300594712
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -184,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3085387548794744992
+      hash: -138032401300594712
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25

data/lib/rapns/apns/required_fields_validator.rb

@@ -1,14 +0,0 @@
-module Rapns
-  module Apns
-    class RequiredFieldsValidator < ActiveModel::Validator
-
-      # Notifications must contain one of alert, badge or sound as per:
-      # https://developer.apple.com/library/ios/#documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/ApplePushService/ApplePushService.html
-      def validate(record)
-        if record.alert.nil? && record.badge.nil? && record.sound.nil?
-          record.errors[:base] << "APN Notification must contain one of alert, badge, or sound"
-        end
-      end
-    end
-  end
-end