rpush 5.0.0 → 5.1.0

data/spec/unit/client/redis/adm/app_spec.rb

@@ -0,0 +1,5 @@
+require 'unit_spec_helper'
+
+describe Rpush::Client::Redis::Adm::App do
+  it_behaves_like 'Rpush::Client::Adm::App'
+end if redis?

data/spec/unit/client/redis/adm/notification_spec.rb

@@ -0,0 +1,5 @@
+require 'unit_spec_helper'
+
+describe Rpush::Client::Redis::Adm::Notification do
+  it_behaves_like 'Rpush::Client::Adm::Notification'
+end if redis?

data/spec/unit/client/redis/apns/app_spec.rb

@@ -0,0 +1,5 @@
+require 'unit_spec_helper'
+
+describe Rpush::Client::Redis::Apns::App do
+  it_behaves_like 'Rpush::Client::Apns::App'
+end if redis?

data/spec/unit/client/redis/apns/feedback_spec.rb

@@ -0,0 +1,5 @@
+require 'unit_spec_helper'
+
+describe Rpush::Client::Redis::Apns::Feedback do
+  it_behaves_like 'Rpush::Client::Apns::Feedback'
+end if redis?

data/spec/unit/client/redis/apns/notification_spec.rb

@@ -0,0 +1,50 @@
+# encoding: US-ASCII
+
+require "unit_spec_helper"
+
+describe Rpush::Client::Redis::Apns::Notification do
+  it_behaves_like 'Rpush::Client::Apns::Notification'
+
+  it "should validate the length of the binary conversion of the notification" do
+    notification = described_class.new
+    notification.app = Rpush::Apns2::App.create(name: 'test', environment: 'development')
+    notification.device_token = "a" * 108
+    notification.alert = ""
+
+    notification.alert << "a" until notification.payload.bytesize == 2048
+    expect(notification.valid?).to be_truthy
+    expect(notification.errors[:base]).to be_empty
+
+    notification.alert << "a"
+    expect(notification.valid?).to be_falsey
+    expect(notification.errors[:base].include?("APN notification cannot be larger than 2048 bytes. Try condensing your alert and device attributes.")).to be_truthy
+  end
+
+  it "should default the sound to 'default'" do
+    notification = described_class.new
+    expect(notification.sound).to eq('default')
+  end
+
+  # skipping these tests because data= for redis doesn't merge existing data
+  xit 'does not overwrite the mutable-content flag when setting attributes for the device' do
+    notification.mutable_content = true
+    notification.data = { 'hi' => 'mom' }
+    expect(notification.as_json['aps']['mutable-content']).to eq 1
+    expect(notification.as_json['hi']).to eq 'mom'
+  end
+
+  xit 'does not overwrite the content-available flag when setting attributes for the device' do
+    notification.content_available = true
+    notification.data = { 'hi' => 'mom' }
+    expect(notification.as_json['aps']['content-available']).to eq 1
+    expect(notification.as_json['hi']).to eq 'mom'
+  end
+
+  # redis does not use alert_is_json - unclear if that is a bug or desired behavior
+  xit 'does confuse a JSON looking string as JSON if the alert_is_json attribute is not present' do
+    notification = described_class.new
+    allow(notification).to receive_messages(has_attribute?: false)
+    notification.alert = "{\"one\":2}"
+    expect(notification.alert).to eq('one' => 2)
+  end
+end if redis?

data/spec/unit/client/redis/apns2/app_spec.rb

@@ -0,0 +1,4 @@
+require 'unit_spec_helper'
+
+describe Rpush::Client::Redis::Apns2::App do
+end if redis?

data/spec/unit/client/redis/apns2/notification_spec.rb

@@ -0,0 +1,50 @@
+# encoding: US-ASCII
+
+require "unit_spec_helper"
+
+describe Rpush::Client::Redis::Apns2::Notification do
+  it_behaves_like 'Rpush::Client::Apns::Notification'
+
+  it "should validate the length of the binary conversion of the notification" do
+    notification = described_class.new
+    notification.app = Rpush::Apns2::App.create(name: 'test', environment: 'development')
+    notification.device_token = "a" * 108
+    notification.alert = ""
+
+    notification.alert << "a" until notification.payload.bytesize == 4096
+    expect(notification.valid?).to be_truthy
+    expect(notification.errors[:base]).to be_empty
+
+    notification.alert << "a"
+    expect(notification.valid?).to be_falsey
+    expect(notification.errors[:base].include?("APN notification cannot be larger than 4096 bytes. Try condensing your alert and device attributes.")).to be_truthy
+  end
+
+  it "should default the sound to 'default'" do
+    notification = described_class.new
+    expect(notification.sound).to eq('default')
+  end
+
+  # skipping these tests because data= for redis doesn't merge existing data
+  xit 'does not overwrite the mutable-content flag when setting attributes for the device' do
+    notification.mutable_content = true
+    notification.data = { 'hi' => 'mom' }
+    expect(notification.as_json['aps']['mutable-content']).to eq 1
+    expect(notification.as_json['hi']).to eq 'mom'
+  end
+
+  xit 'does not overwrite the content-available flag when setting attributes for the device' do
+    notification.content_available = true
+    notification.data = { 'hi' => 'mom' }
+    expect(notification.as_json['aps']['content-available']).to eq 1
+    expect(notification.as_json['hi']).to eq 'mom'
+  end
+
+  # redis does not use alert_is_json - unclear if that is a bug or desired behavior
+  xit 'does confuse a JSON looking string as JSON if the alert_is_json attribute is not present' do
+    notification = described_class.new
+    allow(notification).to receive_messages(has_attribute?: false)
+    notification.alert = "{\"one\":2}"
+    expect(notification.alert).to eq('one' => 2)
+  end
+end if redis?

data/spec/unit/client/redis/app_spec.rb

@@ -0,0 +1,5 @@
+require 'unit_spec_helper'
+
+describe Rpush::Client::Redis::App do
+  it_behaves_like 'Rpush::Client::App'
+end if redis?

data/spec/unit/client/redis/gcm/app_spec.rb

@@ -0,0 +1,5 @@
+require 'unit_spec_helper'
+
+describe Rpush::Client::Redis::Gcm::App do
+  it_behaves_like 'Rpush::Client::Gcm::App'
+end if redis?

data/spec/unit/client/redis/gcm/notification_spec.rb

@@ -0,0 +1,5 @@
+require 'unit_spec_helper'
+
+describe Rpush::Client::Redis::Gcm::Notification do
+  it_behaves_like 'Rpush::Client::Gcm::Notification'
+end if redis?

data/spec/unit/client/redis/notification_spec.rb

@@ -0,0 +1,5 @@
+require 'unit_spec_helper'
+
+describe Rpush::Client::Redis::Notification do
+  it_behaves_like 'Rpush::Client::Notification'
+end if redis?

data/spec/unit/client/redis/pushy/app_spec.rb

@@ -0,0 +1,5 @@
+require 'unit_spec_helper'
+
+describe Rpush::Client::Redis::Pushy::App do
+  it_behaves_like 'Rpush::Client::Pushy::App'
+end if redis?

data/spec/unit/client/redis/pushy/notification_spec.rb

@@ -0,0 +1,5 @@
+require 'unit_spec_helper'
+
+describe Rpush::Client::Redis::Pushy::Notification do
+  it_behaves_like 'Rpush::Client::Pushy::Notification'
+end if redis?

data/spec/unit/client/redis/wns/badge_notification_spec.rb

@@ -0,0 +1,5 @@
+require 'unit_spec_helper'
+
+describe Rpush::Client::Redis::Wns::BadgeNotification do
+  it_behaves_like 'Rpush::Client::Wns::BadgeNotification'
+end if redis?

data/spec/unit/client/redis/wns/raw_notification_spec.rb

@@ -0,0 +1,22 @@
+require 'unit_spec_helper'
+
+describe Rpush::Client::Redis::Wns::RawNotification do
+  it_behaves_like 'Rpush::Client::Wns::RawNotification'
+
+  subject(:notification) do
+    notif = described_class.new
+    notif.app = Rpush::Wns::App.create!(name: "MyApp", client_id: "someclient", client_secret: "somesecret")
+    notif.uri = 'https://db5.notify.windows.com/?token=TOKEN'
+    notif.data = { foo: 'foo', bar: 'bar' }
+    notif
+  end
+
+  # This fails because the length validation is only on active record
+  # Attempting to move to active model in rails 6 fails
+  # because wns_notification#as_json is not defined
+  # and the active_model#as_json version results in a stack level too deep error
+  xit 'does not allow the size of payload over 5 KB' do
+    allow(notification).to receive(:payload_data_size) { 5121 }
+    expect(notification.valid?).to be(false)
+  end
+end if redis?

data/spec/unit/client/redis/wpns/app_spec.rb

@@ -0,0 +1,5 @@
+require 'unit_spec_helper'
+
+describe Rpush::Client::Redis::Wpns::App do
+  it_behaves_like 'Rpush::Client::Wpns::App'
+end if redis?

data/spec/unit/client/redis/wpns/notification_spec.rb

@@ -0,0 +1,5 @@
+require 'unit_spec_helper'
+
+describe Rpush::Client::Redis::Wpns::Notification do
+  it_behaves_like 'Rpush::Client::Wpns::Notification'
+end if redis?

data/spec/unit/client/shared/adm/app.rb

@@ -0,0 +1,51 @@
+require 'unit_spec_helper'
+
+shared_examples 'Rpush::Client::Adm::App' do
+  subject { described_class.new(name: 'test', environment: 'development', client_id: 'CLIENT_ID', client_secret: 'CLIENT_SECRET') }
+
+  it 'should be valid if properly instantiated' do
+    expect(subject).to be_valid
+  end
+
+  it 'should be invalid if name' do
+    subject.name = nil
+    expect(subject).not_to be_valid
+    expect(subject.errors[:name]).to eq ["can't be blank"]
+  end
+
+  it 'should be invalid if missing client_id' do
+    subject.client_id = nil
+    expect(subject).not_to be_valid
+    expect(subject.errors[:client_id]).to eq ["can't be blank"]
+  end
+
+  it 'should be invalid if missing client_secret' do
+    subject.client_secret = nil
+    expect(subject).not_to be_valid
+    expect(subject.errors[:client_secret]).to eq ["can't be blank"]
+  end
+
+  describe '#access_token_expired?' do
+    before(:each) do
+      Timecop.freeze(Time.now)
+    end
+
+    after do
+      Timecop.return
+    end
+
+    it 'should return true if access_token_expiration is nil' do
+      expect(subject.access_token_expired?).to eq(true)
+    end
+
+    it 'should return true if expired' do
+      subject.access_token_expiration = Time.now - 5.minutes
+      expect(subject.access_token_expired?).to eq(true)
+    end
+
+    it 'should return false if not expired' do
+      subject.access_token_expiration = Time.now + 5.minutes
+      expect(subject.access_token_expired?).to eq(false)
+    end
+  end
+end

data/spec/unit/client/shared/adm/notification.rb

@@ -0,0 +1,39 @@
+require 'unit_spec_helper'
+
+shared_examples 'Rpush::Client::Adm::Notification' do
+  let(:app) { Rpush::Adm::App.create!(name: 'test', client_id: 'CLIENT_ID', client_secret: 'CLIENT_SECRET') }
+  let(:notification) { described_class.new }
+
+  it "has a 'data' payload limit of 6144 bytes" do
+    notification.data = { key: "a" * 6144 }
+    expect(notification.valid?).to eq(false)
+    expect(notification.errors[:base]).to eq ["Notification payload data cannot be larger than 6144 bytes."]
+  end
+
+  it 'limits the number of registration ids to 100' do
+    notification.registration_ids = ['a'] * (100 + 1)
+    expect(notification.valid?).to eq(false)
+    expect(notification.errors[:base]).to eq ["Number of registration_ids cannot be larger than 100."]
+  end
+
+  it 'validates data can be blank if collapse_key is set' do
+    notification.app = app
+    notification.registration_ids = ['a']
+    notification.collapse_key = 'test'
+    notification.data = nil
+    expect(notification.valid?).to eq(true)
+    expect(notification.errors[:data]).to be_empty
+  end
+
+  it 'validates data is present if collapse_key is not set' do
+    notification.collapse_key = nil
+    notification.data = nil
+    expect(notification.valid?).to eq(false)
+    expect(notification.errors[:data]).to eq ['must be set unless collapse_key is specified']
+  end
+
+  it 'includes expiresAfter in the payload' do
+    notification.expiry = 100
+    expect(notification.as_json['expiresAfter']).to eq 100
+  end
+end

data/spec/unit/client/shared/apns/app.rb

@@ -0,0 +1,29 @@
+require 'unit_spec_helper'
+
+shared_examples 'Rpush::Client::Apns::App' do
+  it 'does not validate an app with an invalid certificate' do
+    app = described_class.new(name: 'test', environment: 'development', certificate: 'foo')
+    app.valid?
+    expect(app.errors[:certificate]).to eq ['value must contain a certificate and a private key.']
+  end
+
+  it 'validates a certificate without a password' do
+    app = described_class.new name: 'test', environment: 'development', certificate: TEST_CERT
+    app.valid?
+    expect(app.errors[:certificate]).to eq []
+  end
+
+  it 'validates a certificate with a password' do
+    app = described_class.new name: 'test', environment: 'development',
+                              certificate: TEST_CERT_WITH_PASSWORD, password: 'fubar'
+    app.valid?
+    expect(app.errors[:certificate]).to eq []
+  end
+
+  it 'validates a certificate with an incorrect password' do
+    app = described_class.new name: 'test', environment: 'development',
+                              certificate: TEST_CERT_WITH_PASSWORD, password: 'incorrect'
+    app.valid?
+    expect(app.errors[:certificate]).to eq ['value must contain a certificate and a private key.']
+  end
+end

data/spec/unit/client/shared/apns/feedback.rb

@@ -0,0 +1,9 @@
+require 'unit_spec_helper'
+
+shared_examples 'Rpush::Client::Apns::Feedback' do
+  it 'validates the format of the device_token' do
+    notification = described_class.new(device_token: "{$%^&*()}")
+    expect(notification.valid?).to be_falsey
+    expect(notification.errors[:device_token]).to include('is invalid')
+  end
+end

data/spec/unit/client/shared/apns/notification.rb

@@ -0,0 +1,262 @@
+# encoding: US-ASCII
+
+require "unit_spec_helper"
+
+shared_examples 'Rpush::Client::Apns::Notification' do
+  let(:notification) { described_class.new }
+  let(:app) { Rpush::Apns::App.create!(name: 'my_app', environment: 'development', certificate: TEST_CERT) }
+
+  it "should validate the format of the device_token" do
+    notification = described_class.new(device_token: "{$%^&*()}")
+    expect(notification.valid?).to be_falsey
+    expect(notification.errors[:device_token].include?("is invalid")).to be_truthy
+  end
+
+  it "should store long alerts" do
+    notification.app = app
+    notification.device_token = "a" * 108
+    notification.alert = "*" * 300
+    expect(notification.valid?).to be_truthy
+
+    notification.save!
+    notification.reload
+    expect(notification.alert).to eq("*" * 300)
+  end
+
+  it "should default the expiry to 1 day" do
+    expect(notification.expiry).to eq 1.day.to_i
+  end
+
+  describe "when assigning the device token" do
+    it "should strip spaces from the given string" do
+      notification = described_class.new(device_token: "o m g")
+      expect(notification.device_token).to eq "omg"
+    end
+
+    it "should strip chevrons from the given string" do
+      notification = described_class.new(device_token: "<omg>")
+      expect(notification.device_token).to eq "omg"
+    end
+  end
+
+  describe "as_json" do
+    it "should include the alert if present" do
+      notification = described_class.new(alert: "hi mom")
+      expect(notification.as_json["aps"]["alert"]).to eq "hi mom"
+    end
+
+    it "should not include the alert key if the alert is not present" do
+      notification = described_class.new(alert: nil)
+      expect(notification.as_json["aps"].key?("alert")).to be_falsey
+    end
+
+    it "should encode the alert as JSON if it is a Hash" do
+      notification = described_class.new(alert: { 'body' => "hi mom", 'alert-loc-key' => "View" })
+      expect(notification.as_json["aps"]["alert"]).to eq('body' => "hi mom", 'alert-loc-key' => "View")
+    end
+
+    it "should include the badge if present" do
+      notification = described_class.new(badge: 6)
+      expect(notification.as_json["aps"]["badge"]).to eq 6
+    end
+
+    it "should not include the badge key if the badge is not present" do
+      notification = described_class.new(badge: nil)
+      expect(notification.as_json["aps"].key?("badge")).to be_falsey
+    end
+
+    it "should include the sound if present" do
+      notification = described_class.new(sound: "my_sound.aiff")
+      expect(notification.as_json["aps"]["sound"]).to eq "my_sound.aiff"
+    end
+
+    it "should not include the sound key if the sound is not present" do
+      notification = described_class.new(sound: nil)
+      expect(notification.as_json["aps"].key?("sound")).to be_falsey
+    end
+
+    it "should encode the sound as JSON if it is a Hash" do
+      notification = described_class.new(sound: { 'name' => "my_sound.aiff", 'critical' => 1, 'volume' => 0.5 })
+      expect(notification.as_json["aps"]["sound"]).to eq('name' => "my_sound.aiff", 'critical' => 1, 'volume' => 0.5)
+    end
+
+    it "should include attributes for the device" do
+      notification = described_class.new
+      notification.data = { 'omg' => 'lol', 'wtf' => 'dunno' }
+      expect(notification.as_json["omg"]).to eq "lol"
+      expect(notification.as_json["wtf"]).to eq "dunno"
+    end
+
+    it "should allow attributes to include a hash" do
+      notification = described_class.new
+      notification.data = { 'omg' => { 'ilike' => 'hashes' } }
+      expect(notification.as_json["omg"]["ilike"]).to eq "hashes"
+    end
+  end
+
+  describe 'MDM' do
+    let(:magic) { 'abc123' }
+
+    before do
+      notification.device_token = "a" * 108
+      notification.id = 1234
+    end
+
+    it 'includes the mdm magic in the payload' do
+      notification.mdm = magic
+      expect(notification.as_json).to eq('mdm' => magic)
+    end
+
+    it 'does not include aps attribute' do
+      notification.alert = "i'm doomed"
+      notification.mdm = magic
+      expect(notification.as_json.key?('aps')).to be_falsey
+    end
+
+    it 'can be converted to binary' do
+      notification.mdm = magic
+      expect(notification.to_binary).to be_present
+    end
+  end
+
+  describe 'mutable-content' do
+    it 'includes mutable-content in the payload' do
+      notification.mutable_content = true
+      expect(notification.as_json['aps']['mutable-content']).to eq 1
+    end
+
+    it 'does not include content-available in the payload if not set' do
+      expect(notification.as_json['aps'].key?('mutable-content')).to be_falsey
+    end
+
+    it 'does not include mutable-content as a non-aps attribute' do
+      notification.mutable_content = true
+      expect(notification.as_json.key?('mutable-content')).to be_falsey
+    end
+
+    it 'does not overwrite existing attributes for the device' do
+      notification.data = { 'hi' => 'mom' }
+      notification.mutable_content = true
+      expect(notification.as_json['aps']['mutable-content']).to eq 1
+      expect(notification.as_json['hi']).to eq 'mom'
+    end
+  end
+
+  describe 'content-available' do
+    it 'includes content-available in the payload' do
+      notification.content_available = true
+      expect(notification.as_json['aps']['content-available']).to eq 1
+    end
+
+    it 'does not include content-available in the payload if not set' do
+      expect(notification.as_json['aps'].key?('content-available')).to be_falsey
+    end
+
+    it 'does not include content-available as a non-aps attribute' do
+      notification.content_available = true
+      expect(notification.as_json.key?('content-available')).to be_falsey
+    end
+
+    it 'does not overwrite existing attributes for the device' do
+      notification.data = { 'hi' => 'mom' }
+      notification.content_available = true
+      expect(notification.as_json['aps']['content-available']).to eq 1
+      expect(notification.as_json['hi']).to eq 'mom'
+    end
+  end
+
+  describe 'url-args' do
+    it 'includes url-args in the payload' do
+      notification.url_args = ['url-arg-1']
+      expect(notification.as_json['aps']['url-args']).to eq ['url-arg-1']
+    end
+
+    it 'does not include url-args in the payload if not set' do
+      expect(notification.as_json['aps'].key?('url-args')).to be_falsey
+    end
+  end
+
+  describe 'category' do
+    it 'includes category in the payload' do
+      notification.category = 'INVITE_CATEGORY'
+      expect(notification.as_json['aps']['category']).to eq 'INVITE_CATEGORY'
+    end
+
+    it 'does not include category in the payload if not set' do
+      expect(notification.as_json['aps'].key?('category')).to be_falsey
+    end
+  end
+
+  describe 'to_binary' do
+    before do
+      notification.device_token = "a" * 108
+      notification.id = 1234
+    end
+
+    it 'uses APNS_PRIORITY_CONSERVE_POWER if content-available is the only key' do
+      notification.alert = nil
+      notification.badge = nil
+      notification.sound = nil
+      notification.content_available = true
+      bytes = notification.to_binary.bytes.to_a[-4..-1]
+      expect(bytes.first).to eq 5 # priority item ID
+      expect(bytes.last).to eq described_class::APNS_PRIORITY_CONSERVE_POWER
+    end
+
+    it 'uses APNS_PRIORITY_IMMEDIATE if content-available is not the only key' do
+      notification.alert = "New stuff!"
+      notification.badge = nil
+      notification.sound = nil
+      notification.content_available = true
+      bytes = notification.to_binary.bytes.to_a[-4..-1]
+      expect(bytes.first).to eq 5 # priority item ID
+      expect(bytes.last).to eq described_class::APNS_PRIORITY_IMMEDIATE
+    end
+
+    it "should correctly convert the notification to binary" do
+      notification.sound = "1.aiff"
+      notification.badge = 3
+      notification.alert = "Don't panic Mr Mainwaring, don't panic!"
+      notification.data = { hi: :mom }
+      notification.expiry = 86_400 # 1 day
+      notification.priority = described_class::APNS_PRIORITY_IMMEDIATE
+      notification.app = app
+      now = Time.now
+      allow(Time).to receive_messages(now: now)
+      expect(notification.to_binary).to eq "\x02\x00\x00\x00\xAF\x01\x00 \xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\x02\x00a{\"aps\":{\"alert\":\"Don't panic Mr Mainwaring, don't panic!\",\"badge\":3,\"sound\":\"1.aiff\"},\"hi\":\"mom\"}\x03\x00\x04\x00\x00\x04\xD2\x04\x00\x04#{[now.to_i + 86_400].pack('N')}\x05\x00\x01\n"
+    end
+  end
+
+  describe "bug #31" do
+    it 'does not confuse a JSON looking string as JSON' do
+      notification = described_class.new
+      notification.alert = "{\"one\":2}"
+      expect(notification.alert).to eq "{\"one\":2}"
+    end
+  end
+
+  describe "bug #35" do
+    it "should limit payload size to 256 bytes but not the entire packet" do
+      notification = described_class.new.tap do |n|
+        n.device_token = "a" * 108
+        n.alert = "a" * 210
+        n.app = app
+      end
+
+      expect(notification.to_binary(for_validation: true).bytesize).to be > 256
+      expect(notification.payload.bytesize).to be < 256
+      expect(notification).to be_valid
+    end
+  end
+
+  describe 'thread-id' do
+    it 'includes thread-id in the payload' do
+      notification.thread_id = 'THREAD-ID'
+      expect(notification.as_json['aps']['thread-id']).to eq 'THREAD-ID'
+    end
+
+    it 'does not include thread-id in the payload if not set' do
+      expect(notification.as_json['aps']).to_not have_key('thread-id')
+    end
+  end
+end