rapns_rails_2 3.4.3 → 3.5.0

data/CHANGELOG.md

@@ -1,5 +1,6 @@
-## 3.4.2 (unreleased)
+## 3.5.0 (unreleased)
   * Fix sqlite3 support (#160).
+  * Drop support for Ruby 1.8.
 
 ## 3.4.1 (Aug 30, 2013)
   * Silence unintended airbrake_notify deprecation warning (#158).

data/README.md

@@ -11,7 +11,7 @@
 * Run as a daemon or inside an [existing processs](https://github.com/ileitch/rapns/wiki/Embedding-API).
 * Use in a scheduler for low-workload deployments ([Push API](https://github.com/ileitch/rapns/wiki/Push-API)).
 * Reflection API for fine-grained instrumentation and error handling ([Reflection API](https://github.com/ileitch/rapns/wiki/Reflection-API)).
-* Works with MRI, JRuby, Rubinius 1.8 and 1.9.
+* Works with MRI, JRuby, Rubinius 1.9, 2.0.
 * Built with love.
 
 ### Who uses Rapns?

data/config/database.yml

@@ -15,7 +15,7 @@ jdbcpostgresql:
   password: ""
 
 mysql2:
-  adapter: mysql
+  adapter: mysql2
   database: rapns_test
   host: localhost
   username: rapns_test

data/lib/generators/templates/rapns.rb

@@ -71,7 +71,7 @@ Rapns.reflect do |on|
   # on.gcm_canonical_id do |old_id, canonical_id|
   # end
 
-  # Called when the GCM returns a failure that indicates an invalid tegistration id.
+  # Called when the GCM returns a failure that indicates an invalid registration id.
   # You will need to delete the registration_id from your records.
   # on.gcm_invalid_registration_id do |app, error, registration_id|
   # end

data/lib/rapns/apns/device_token_format_validator.rb

@@ -3,7 +3,7 @@ module Rapns
     class DeviceTokenFormatValidator < ActiveModel::Validator
 
       def validate(record)
-        if record.device_token !~ /^[a-z0-9]{64}$/
+        if record.device_token !~ /^[a-z0-9]{64}$/i
           record.errors.add(:device_token, "is invalid")
         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, :logger, :batch_storage_updates, :udp_wake_host, :udp_wake_port]
+    :push, :store, :logger, :batch_storage_updates, :wakeup]
 
   class ConfigurationWithoutDefaults < Struct.new(*CONFIG_ATTRS)
   end

data/lib/rapns/daemon/feeder.rb

@@ -51,15 +51,15 @@ module Rapns
       end
 
       def self.interruptible_sleeper
-        unless @interruptible_sleeper
-          @interruptible_sleeper = InterruptibleSleep.new
-          if Rapns.config.udp_wake_host && Rapns.config.udp_wake_port
-            @interruptible_sleeper.enable_wake_on_udp Rapns.config.udp_wake_host, Rapns.config.udp_wake_port
-          end
+        return @interruptible_sleeper if @interruptible_sleeper
+
+        @interruptible_sleeper = InterruptibleSleep.new
+        if Rapns.config.wakeup
+          @interruptible_sleeper.enable_wake_on_udp Rapns.config.wakeup[:bind], Rapns.config.wakeup[:port]
         end
+
         @interruptible_sleeper
       end
-
     end
   end
 end

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

@@ -46,6 +46,9 @@ module Rapns
 
         def ok(response)
           body = multi_json_load(response.body)
+
+          handle_canonical_ids(response, body)
+
           if body['failure'].to_i == 0
             mark_delivered
             Rapns.logger.info("[#{@app.name}] #{@notification.id} sent to #{@notification.registration_ids.join(', ')}")
@@ -54,7 +57,6 @@ module Rapns
             handle_errors(response, body)
           end
 
-          handle_canonical_ids(response, body)
         end
 
         def handle_errors(response, body)
@@ -63,9 +65,10 @@ module Rapns
           body['results'].each_with_index do |result, i|
             errors[i] = result['error'] if result['error'] && ! INVALID_REGISTRATION_ID_STATES.include?(result['error'])
           end
-          return if errors.empty?
 
-          if body['success'].to_i == 0 && errors.values.all? { |error| UNAVAILABLE_STATES.include?(error) }
+          if errors.empty?
+            all_errors_were_invalid_registration_ids(response)
+          elsif body['success'].to_i == 0 && errors.values.all? { |error| UNAVAILABLE_STATES.include?(error) }
             all_devices_unavailable(response)
           elsif errors.values.any? { |error| UNAVAILABLE_STATES.include?(error) }
             some_devices_unavailable(response, errors)
@@ -117,6 +120,10 @@ module Rapns
           Rapns.logger.warn("All recipients unavailable. " + retry_message)
         end
 
+        def all_errors_were_invalid_registration_ids(response)
+          mark_failed(nil, "All registration IDs were invalid.")
+        end
+
         def some_devices_unavailable(response, errors)
           unavailable_idxs = errors.find_all { |i, error| UNAVAILABLE_STATES.include?(error) }.map(&:first)
           new_notification = create_new_notification(response, unavailable_idxs)

data/lib/rapns/notifier.rb

@@ -32,4 +32,21 @@ module Rapns
     end
 
   end
+
+  # Call this from a client application after saving a Notification to the database to wakeup the Rapns
+  # Daemon to deliver the notification immediately.
+  def self.wakeup
+    notifier.notify
+  end
+
+  # Default notifier instance. This uses the :connect, :port values in Rapns.config.wakeup to connect to the
+  # wakeup socket in the Rapns Daemon. It will fall back to :host, :port if :connect is not specified.
+  def self.notifier
+    unless @notifier
+      if Rapns.config.wakeup
+        @notifier = Notifier.new(Rapns.config.wakeup[:connect] || Rapns.config.wakeup[:host], Rapns.config.wakeup[:port])
+      end
+    end
+    @notifier
+  end
 end

data/lib/rapns/version.rb

@@ -1,3 +1,3 @@
 module Rapns
-  VERSION = '3.4.3'
+  VERSION = '3.5.0'
 end

data/lib/rapns_rails_2.rb

@@ -34,6 +34,7 @@ require 'rapns/embed'
 require 'rapns/push'
 require 'rapns/apns_feedback'
 require 'rapns/upgraded'
+require 'rapns/notifier'
 
 require 'rapns/apns/binary_notification_validator'
 require 'rapns/apns/device_token_format_validator'

data/spec/unit/apns/feedback_spec.rb

@@ -4,6 +4,6 @@ describe Rapns::Apns::Feedback do
   it "should validate the format of the device_token" do
     notification = Rapns::Apns::Feedback.new(:device_token => "{$%^&*()}")
     notification.valid?.should be_false
-    notification.errors[:device_token].include?("is invalid").should be_true
+    notification.errors[:device_token].should include("is invalid")
   end
 end

data/spec/unit/daemon/feeder_spec.rb

@@ -5,77 +5,85 @@ describe Rapns::Daemon::Feeder do
                         :push_poll => 0,
                         :embedded => false,
                         :push => false,
-                        :udp_wake_host => nil,
-                        :udp_wake_port => nil) }
+                        :wakeup => nil) }
   let!(:app) { Rapns::Apns::App.create!(:name => 'my_app', :environment => 'development', :certificate => TEST_CERT) }
   let(:notification) { Rapns::Apns::Notification.create!(:device_token => "a" * 64, :app => app) }
   let(:logger) { double }
+  let(:interruptible_sleep) { double(:sleep => nil, :interrupt_sleep => nil) }
 
   before do
     Rapns.stub(:config => config,:logger => logger)
     Rapns::Daemon.stub(:store => double(:deliverable_notifications => [notification]))
     Rapns::Daemon::Feeder.stub(:stop? => true)
     Rapns::Daemon::AppRunner.stub(:enqueue => nil, :idle => [double(:app => app)])
+    Rapns::Daemon::InterruptibleSleep.stub(:new => interruptible_sleep)
+    Rapns::Daemon::Feeder.instance_variable_set('@interruptible_sleeper', nil)
   end
 
-  def start
+  def start_and_stop
     Rapns::Daemon::Feeder.start
+    Rapns::Daemon::Feeder.stop
   end
 
   it "starts the loop in a new thread if embedded" do
     config.stub(:embedded => true)
     Thread.should_receive(:new).and_yield
     Rapns::Daemon::Feeder.should_receive(:feed_forever)
-    start
+    start_and_stop
   end
 
   it 'loads deliverable notifications' do
     Rapns::Daemon.store.should_receive(:deliverable_notifications).with([app])
-    start
+    start_and_stop
   end
 
   it 'does not attempt to load deliverable notifications if there are no idle runners' do
     Rapns::Daemon::AppRunner.stub(:idle => [])
     Rapns::Daemon.store.should_not_receive(:deliverable_notifications)
-    start
+    start_and_stop
   end
 
   it 'enqueues notifications without looping if in push mode' do
     config.stub(:push => true)
     Rapns::Daemon::Feeder.should_not_receive(:feed_forever)
     Rapns::Daemon::Feeder.should_receive(:enqueue_notifications)
-    start
+    start_and_stop
   end
 
   it "enqueues the notifications" do
     Rapns::Daemon::AppRunner.should_receive(:enqueue).with([notification])
-    start
+    start_and_stop
   end
 
   it "logs errors" do
     e = StandardError.new("bork")
     Rapns::Daemon.store.stub(:deliverable_notifications).and_raise(e)
     Rapns.logger.should_receive(:error).with(e)
-    start
+    start_and_stop
   end
 
   it "interrupts sleep when stopped" do
     Rapns::Daemon::Feeder.should_receive(:interrupt_sleep)
-    Rapns::Daemon::Feeder.stop
+    start_and_stop
   end
 
   it "enqueues notifications when started" do
     Rapns::Daemon::Feeder.should_receive(:enqueue_notifications).at_least(:once)
     Rapns::Daemon::Feeder.stub(:loop).and_yield
-    start
+    start_and_stop
   end
 
   it "sleeps for the given period" do
     config.stub(:push_poll => 2)
-    sleeper = double(:sleep => true)
-    sleeper.should_receive(:sleep).with(2)
-    Rapns::Daemon::Feeder.stub(:interruptible_sleeper => sleeper)
-    Rapns::Daemon::Feeder.stub(:loop).and_yield
-    Rapns::Daemon::Feeder.start
+    interruptible_sleep.should_receive(:sleep).with(2)
+    start_and_stop
+  end
+
+  it "creates the wakeup socket" do
+    bind = '127.0.0.1'
+    port = 12345
+    config.stub(:wakeup => { :bind => bind, :port => port})
+    interruptible_sleep.should_receive(:enable_wake_on_udp).with(bind, port)
+    start_and_stop
   end
 end

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

@@ -110,7 +110,7 @@ describe Rapns::Daemon::Gcm::Delivery do
       perform
     end
 
-    it 'does not retry, raise or marks a notification as failed for invalid ids.' do
+    it 'does marks a notification as failed if any ids are invalid.' do
       body = {
           'failure' => 1,
           'success' => 2,
@@ -122,7 +122,7 @@ describe Rapns::Daemon::Gcm::Delivery do
           ]}
 
       response.stub(:body => MultiJson.dump(body))
-      batch.should_not_receive(:mark_failed)
+      batch.should_receive(:mark_failed)
       batch.should_not_receive(:mark_retryable)
       store.should_not_receive(:create_gcm_notification)
       perform

data/spec/unit/notifier_spec.rb

@@ -29,4 +29,24 @@ describe Rapns::Notifier do
       end
     end
   end
+
+  describe "default notifier" do
+    it "creates using :connect first" do
+      Rapns.config.stub :wakeup => { :connect => '127.0.0.1', :port => 1234 }
+      Rapns::Notifier.should_receive(:new).with('127.0.0.1', 1234)
+      Rapns.notifier
+    end
+
+    it "creates using :host next" do
+      Rapns.config.stub :wakeup => { :host => '127.0.0.1', :port => 1234 }
+      Rapns::Notifier.should_receive(:new).with('127.0.0.1', 1234)
+      Rapns.notifier
+    end
+
+    it "returns nil when wakeup is not specified" do
+      Rapns.config.stub :wakeup => nil
+      Rapns::Notifier.should_not_receive(:new)
+      Rapns.notifier.should be_nil
+    end
+  end
 end

data/spec/unit_spec_helper.rb

@@ -4,7 +4,6 @@ require 'bundler'
 Bundler.require(:default)
 
 require 'active_record'
-require 'database_cleaner'
 
 unless ENV['TRAVIS'] && ENV['QUALITY'] == 'false'
   begin
@@ -53,6 +52,7 @@ require 'generators/templates/add_gcm'
   migration.up
 end
 
+require 'database_cleaner'
 DatabaseCleaner.strategy = :truncation
 
 require 'rapns_rails_2'

metadata

@@ -1,52 +1,62 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: rapns_rails_2
-version: !ruby/object:Gem::Version
-  version: 3.4.3
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: 
+  segments: 
+  - 3
+  - 5
+  - 0
+  version: 3.5.0
 platform: ruby
-authors:
+authors: 
 - Ian Leitch
 - Marc Rohloff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-02 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2013-11-20 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: net-http-persistent
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
   type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: net-http-persistent
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
 description: Professional grade APNs and GCM for Ruby with Rails 2 compatibility
-email:
+email: 
 - port001@gmail.com
-executables:
+executables: 
 - rapns
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - CHANGELOG.md
 - LICENSE
 - README.md
@@ -160,28 +170,38 @@ files:
 - bin/rapns
 homepage: https://github.com/marcrohloff/rapns_rails_2
 licenses: []
-metadata: {}
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 1.8.4
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Professional grade APNs and GCM for Ruby
-test_files:
+test_files: 
 - config/database.yml
 - spec/support/cert_with_password.pem
 - spec/support/cert_without_password.pem

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ODdlNDhlOTIzODkyMDZiODdiNzIwYjAyNDJlNjkzZDYyMmYyZDhjNQ==
-  data.tar.gz: !binary |-
-    NDlhMWY3NGRmOTUwMmQ1NGRjMjg2MjE2ZDY5NmYwNWE5NjgyZWM1MA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    MTkzNDAxZTZmNWM4YTg3OTEzYWJhM2Q1YmE3MzBhZjg0YjUxYWJmMjAwYWMz
-    NGZmMGM0Mzk4MDM1MGU3OTFjZWVlNThhZTg1MDhiMmRmNDFhZjk3ZjcxYTA4
-    OTllMzFjM2NkZWRmYmVhZTlmOTkwYzlhMGI3NmVkZjQ1NjRiMTE=
-  data.tar.gz: !binary |-
-    YzQ3ZmMzMzU1MzFmYzczZGI4M2FlYWRjMTY3Y2NmNmJlOTY5Y2UxMWNhODUz
-    NTlmY2QwNTEyMmM0MWVkNGExNGJiNjdlYmViNjY3MzkyOWFhM2M3ZWUwY2Jm
-    M2Q0ODNlNmJiMmU1MDI2Mjc3ZGIzYjE1ZWQ1YjgxZmZiNGY3MzU=