rapns 3.0.0 → 3.0.1

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 3.0.1 (Sun 16, 2012)
+  * Fix compatibility with Rails 3.0.x. Fixes #89.
+
+## 3.0.0 (Sat 15, 2012)
+  * Add support for Google Cloud Messaging.
+  * Fix Heroku logging issue.
+
 ##  2.0.5 (Nov 4, 2012) ##
   * Support content-available (#68).
   * Append to log files.

data/README.md

@@ -10,6 +10,8 @@
 * Works with MRI, JRuby, Rubinius 1.8 and 1.9.
 * [Airbrake](http://airbrakeapp.com/) integration.
 
+#### 2.x users please read [upgrading from 2.x to 3.0](rapns/wiki/Upgrading-from-version-2.x-to-3.0)
+
 ### Who uses Rapns?
 
 [GateGuru](http://gateguruapp.com) and [Desk.com](http://desk.com), among others!
@@ -22,12 +24,12 @@ Add Rapns to your Gemfile:
 
     gem 'rapns'
 
-Generate the migration, rapns.yml and migrate:
+Generate the migrations, rapns.yml and migrate:
 
     rails g rapns
     rake db:migrate
 
-## Generating Certificates
+## Generating Certificates (APNs only)
 
 1. Open up Keychain Access and select the `Certificates` category in the sidebar.
 2. Expand the disclosure arrow next to the iOS Push Services certificate you want to export.
@@ -87,7 +89,7 @@ n.save!
     cd /path/to/rails/app
     rapns <Rails environment> [options]
 
-See [Configuration](wiki/Configuration) for a list of options, or run `rapns --help`.
+See [Configuration](rapns/wiki/Configuration) for a list of options, or run `rapns --help`.
 
 ## Updating Rapns
 
@@ -96,16 +98,16 @@ After updating you should run `rails g rapns` to check for any new migrations.
 ## Wiki
 
 ### General
-* [Configuration](wiki/Configuration)
-* [Upgrading from 2.x to 3.0](wiki/Upgrading-from-version-2.x-to-3.0)
-* [Deploying to Heroku](wiki/Heroku)
-* [Hot App Updates](wiki/Hot-App-Updates)
+* [Configuration](rapns/wiki/Configuration)
+* [Upgrading from 2.x to 3.0](rapns/wiki/Upgrading-from-version-2.x-to-3.0)
+* [Deploying to Heroku](rapns/wiki/Heroku)
+* [Hot App Updates](rapns/wiki/Hot-App-Updates)
 
 ### APNs
-* [Advanced APNs Features](wiki/Advanced-APNs-Features)
-* [APNs Delivery Failure Handling](wiki/APNs-Delivery-Failure-Handling)
-* [Why open multiple connections to the APNs?](wiki/Why-open-multiple-connections-to-the-APNs%3F)
-* [Silent failures might be dropped connections](wiki/Dropped-connections)
+* [Advanced APNs Features](rapns/wiki/Advanced-APNs-Features)
+* [APNs Delivery Failure Handling](rapns/wiki/APNs-Delivery-Failure-Handling)
+* [Why open multiple connections to the APNs?](rapns/wiki/Why-open-multiple-connections-to-the-APNs%3F)
+* [Silent failures might be dropped connections](rapns/wiki/Dropped-connections)
 
 ### GCM
 

data/lib/rapns/deprecatable.rb

@@ -0,0 +1,23 @@
+module Rapns
+  module Deprecatable
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def deprecated(method_name, version, msg=nil)
+        instance_eval do
+          alias_method "#{method_name}_without_warning", method_name
+        end
+        warning = "#{method_name} is deprecated and will be removed from Rapns #{version}."
+        warning << " #{msg}" if msg
+        class_eval(<<-RUBY, __FILE__, __LINE__)
+          def #{method_name}(*args, &blk)
+            Rapns::Deprecation.warn(#{warning.inspect})
+            #{method_name}_without_warning(*args, &blk)
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/rapns/deprecation.rb

@@ -0,0 +1,22 @@
+module Rapns
+  class Deprecation
+    def self.silenced
+      begin
+        Thread.current[:rapns_silence_deprecations] = true
+        yield
+      ensure
+        Thread.current[:rapns_silence_deprecations] = false
+      end
+    end
+
+    def self.silenced?
+      Thread.current[:rapns_silence_deprecations]
+    end
+
+    def self.warn(msg)
+      unless Rapns::Deprecation.silenced?
+        STDERR.puts "DEPRECATION WARNING: #{msg}"
+      end
+    end
+  end
+end

data/lib/rapns/notification.rb

@@ -25,10 +25,11 @@ module Rapns
       where(:app_id => apps.map(&:id))
     }
 
-    def initialize(attributes = nil, options = {})
+    def initialize(*args)
+      attributes = args.first
       if attributes.is_a?(Hash) && attributes.keys.include?(:attributes_for_device)
         msg = ":attributes_for_device via mass-assignment is deprecated. Use :data or the attributes_for_device= instance method."
-        ActiveSupport::Deprecation.warn(msg, caller(1))
+        Rapns::Deprecation.warn(msg)
       end
       super
     end

data/lib/rapns/version.rb

@@ -1,3 +1,3 @@
 module Rapns
-  VERSION = '3.0.0'
+  VERSION = '3.0.1'
 end

data/lib/rapns.rb

@@ -2,6 +2,8 @@ require 'active_record'
 require 'multi_json'
 
 require 'rapns/version'
+require 'rapns/deprecation'
+require 'rapns/deprecatable'
 require 'rapns/multi_json_helper'
 require 'rapns/notification'
 require 'rapns/app'

data/spec/unit/deprecatable_spec.rb

@@ -0,0 +1,32 @@
+require 'unit_spec_helper'
+
+describe Rapns::Deprecatable do
+  class HasDeprecatedMethod
+    include Rapns::Deprecatable
+
+    def original_called?
+      @called == true
+    end
+
+    def deprecated_method
+      @called = true
+    end
+    deprecated(:deprecated_method, '4.0')
+  end
+
+  let(:klass) { HasDeprecatedMethod.new }
+
+  before do
+    Rapns::Deprecation.stub(:warn)
+  end
+
+  it 'warns the method is deprecated when called' do
+    Rapns::Deprecation.should_receive(:warn).with("deprecated_method is deprecated and will be removed from Rapns 4.0.")
+    klass.deprecated_method
+  end
+
+  it 'calls the original method' do
+    klass.deprecated_method
+    klass.original_called?.should be_true
+  end
+end

data/spec/unit/deprecation_spec.rb

@@ -0,0 +1,15 @@
+require 'unit_spec_helper'
+
+describe Rapns::Deprecation do
+  it 'prints a warning' do
+    STDERR.should_receive(:puts).with("DEPRECATION WARNING: msg")
+    Rapns::Deprecation.warn("msg")
+  end
+
+  it 'does not print a warning when silenced' do
+    STDERR.should_not_receive(:puts)
+    Rapns::Deprecation.silenced do
+      Rapns::Deprecation.warn("msg")
+    end
+  end
+end

data/spec/unit/notification_shared.rb

@@ -31,7 +31,7 @@ shared_examples_for "an Notification subclass" do
     end
 
     it 'warns if attributes_for_device is assigned via mass-assignment' do
-      ActiveSupport::Deprecation.should_receive(:warn)
+      Rapns::Deprecation.should_receive(:warn)
       notification_class.new(:attributes_for_device => {:hi => 'mom'})
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rapns
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-15 00:00:00.000000000 Z
+date: 2012-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -92,6 +92,8 @@ files:
 - lib/rapns/daemon/gcm/delivery_handler.rb
 - lib/rapns/daemon/interruptible_sleep.rb
 - lib/rapns/daemon/logger.rb
+- lib/rapns/deprecatable.rb
+- lib/rapns/deprecation.rb
 - lib/rapns/gcm/app.rb
 - lib/rapns/gcm/expiry_collapse_key_mutual_inclusion_validator.rb
 - lib/rapns/gcm/notification.rb
@@ -133,6 +135,8 @@ files:
 - spec/unit/daemon/interruptible_sleep_spec.rb
 - spec/unit/daemon/logger_spec.rb
 - spec/unit/daemon_spec.rb
+- spec/unit/deprecatable_spec.rb
+- spec/unit/deprecation_spec.rb
 - spec/unit/gcm/app_spec.rb
 - spec/unit/gcm/notification_spec.rb
 - spec/unit/notification_shared.rb
@@ -193,6 +197,8 @@ test_files:
 - spec/unit/daemon/interruptible_sleep_spec.rb
 - spec/unit/daemon/logger_spec.rb
 - spec/unit/daemon_spec.rb
+- spec/unit/deprecatable_spec.rb
+- spec/unit/deprecation_spec.rb
 - spec/unit/gcm/app_spec.rb
 - spec/unit/gcm/notification_spec.rb
 - spec/unit/notification_shared.rb