rpush 4.2.0 → 7.0.1

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

@@ -0,0 +1,277 @@
+# 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 'content_available?' do
+    context 'if not set' do
+      it 'should be false' do
+        expect(notification.content_available?).to be_falsey
+      end
+    end
+
+    context 'if set' do
+      it 'should be true' do
+        notification.content_available = true
+        expect(notification.content_available?).to be_truthy
+      end
+    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

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

@@ -0,0 +1,17 @@
+require 'unit_spec_helper'
+
+shared_examples 'Rpush::Client::App' do
+  context 'validating certificates' do
+    it 'rescues from certificate error' do
+      app = Rpush::Apns::App.new(name: 'test', environment: 'development', certificate: 'bad')
+      expect { app.valid? }.not_to raise_error
+      expect(app.valid?).to eq(false)
+    end
+
+    it 'raises other errors' do
+      app = Rpush::Apns::App.new(name: 'test', environment: 'development', certificate: 'bad')
+      allow(OpenSSL::X509::Certificate).to receive(:new).and_raise(NameError, 'simulating no openssl')
+      expect { app.valid? }.to raise_error(NameError)
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+require 'unit_spec_helper'
+
+shared_examples 'Rpush::Client::Gcm::App' do
+end

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

@@ -0,0 +1,77 @@
+require 'unit_spec_helper'
+
+shared_examples 'Rpush::Client::Gcm::Notification' do
+  let(:app) { Rpush::Gcm::App.create!(name: 'test', auth_key: 'abc') }
+  let(:notification) { described_class.new }
+
+  it "has a 'data' payload limit of 4096 bytes" do
+    notification.data = { key: "a" * 4096 }
+    expect(notification.valid?).to be_falsey
+    expect(notification.errors[:base]).to eq ["Notification payload data cannot be larger than 4096 bytes."]
+  end
+
+  it 'limits the number of registration ids to 1000' do
+    notification.registration_ids = ['a'] * (1000 + 1)
+    expect(notification.valid?).to be_falsey
+    expect(notification.errors[:base]).to eq ["Number of registration_ids cannot be larger than 1000."]
+  end
+
+  it 'validates expiry is present if collapse_key is set' do
+    notification.collapse_key = 'test'
+    notification.expiry = nil
+    expect(notification.valid?).to be_falsey
+    expect(notification.errors[:expiry]).to eq ['must be set when using a collapse_key']
+  end
+
+  it 'includes time_to_live in the payload' do
+    notification.expiry = 100
+    expect(notification.as_json['time_to_live']).to eq 100
+  end
+
+  it 'includes content_available in the payload' do
+    notification.content_available = true
+    expect(notification.as_json['content_available']).to eq true
+  end
+
+  it 'includes mutable_content in the payload' do
+    notification.mutable_content = true
+    expect(notification.as_json['mutable_content']).to eq true
+  end
+
+  it 'sets the priority to high when set to high' do
+    notification.priority = 'high'
+    expect(notification.as_json['priority']).to eq 'high'
+  end
+
+  it 'sets the priority to normal when set to normal' do
+    notification.priority = 'normal'
+    expect(notification.as_json['priority']).to eq 'normal'
+  end
+
+  it 'validates the priority is either "normal" or "high"' do
+    notification.priority = 'invalid'
+    expect(notification.errors[:priority]).to eq ['must be one of either "normal" or "high"']
+  end
+
+  it 'excludes the priority if it is not defined' do
+    expect(notification.as_json).not_to have_key 'priority'
+  end
+
+  it 'includes the notification payload if defined' do
+    notification.notification = { key: 'any key is allowed' }
+    expect(notification.as_json).to have_key 'notification'
+  end
+
+  it 'excludes the notification payload if undefined' do
+    expect(notification.as_json).not_to have_key 'notification'
+  end
+
+  it 'includes the dry_run payload if defined' do
+    notification.dry_run = true
+    expect(notification.as_json['dry_run']).to eq true
+  end
+
+  it 'excludes the dry_run payload if undefined' do
+    expect(notification.as_json).not_to have_key 'dry_run'
+  end
+end

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

@@ -0,0 +1,10 @@
+require 'unit_spec_helper'
+
+shared_examples 'Rpush::Client::Notification' do
+  let(:notification) { described_class.new }
+
+  it 'allows assignment of many registration IDs' do
+    notification.registration_ids = %w[a b]
+    expect(notification.registration_ids).to eq %w[a b]
+  end
+end

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

@@ -0,0 +1,17 @@
+require 'unit_spec_helper'
+
+shared_examples 'Rpush::Client::Pushy::App' do
+  describe 'validates' do
+    subject { described_class.new }
+
+    it 'validates presence of name' do
+      is_expected.not_to be_valid
+      expect(subject.errors[:name]).to eq ["can't be blank"]
+    end
+
+    it 'validates presence of api_key' do
+      is_expected.not_to be_valid
+      expect(subject.errors[:api_key]).to eq ["can't be blank"]
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+require 'unit_spec_helper'
+
+shared_examples 'Rpush::Client::Pushy::Notification' do
+  subject(:notification) { described_class.new }
+
+  describe 'validates' do
+    let(:app) { Rpush::Pushy::App.create!(name: 'MyApp', api_key: 'my_api_key') }
+
+    describe 'data' do
+      subject { described_class.new(app: app, registration_ids: ['id']) }
+      it 'validates presence' do
+        is_expected.not_to be_valid
+        expect(subject.errors[:data]).to eq ["can't be blank"]
+      end
+
+      it "has a 'data' payload limit of 4096 bytes" do
+        subject.data = { message: 'a' * 4096 }
+        is_expected.not_to be_valid
+        expected_errors = ["Notification payload data cannot be larger than 4096 bytes."]
+        expect(subject.errors[:base]).to eq expected_errors
+      end
+    end
+
+    describe 'registration_ids' do
+      subject { described_class.new(app: app, data: { message: 'test' }) }
+      it 'validates presence' do
+        is_expected.not_to be_valid
+        expect(subject.errors[:registration_ids]).to eq ["can't be blank"]
+      end
+
+      it 'limits the number of registration ids to 1000' do
+        subject.registration_ids = ['a'] * (1000 + 1)
+        is_expected.not_to be_valid
+        expected_errors = ["Number of registration_ids cannot be larger than 1000."]
+        expect(subject.errors[:base]).to eq expected_errors
+      end
+    end
+
+    describe 'time_to_live' do
+      subject { described_class.new(app: app, data: { message: 'test' }, registration_ids: ['id']) }
+
+      it 'should be > 0' do
+        subject.time_to_live = -1
+        is_expected.not_to be_valid
+        expect(subject.errors[:time_to_live]).to eq ['must be greater than 0']
+      end
+
+      it 'should be <= 1.year.seconds' do
+        subject.time_to_live = 2.years.seconds.to_i
+        is_expected.not_to be_valid
+        expect(subject.errors[:time_to_live]).to eq ['The maximum value is 1 year']
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+require 'unit_spec_helper'
+
+shared_examples 'Rpush::Client::Webpush::App' do
+  describe 'validates' do
+    subject { described_class.new }
+
+    it 'validates presence of name' do
+      is_expected.not_to be_valid
+      expect(subject.errors[:name]).to eq ["can't be blank"]
+    end
+
+    it 'validates presence of vapid_keypair' do
+      is_expected.not_to be_valid
+      expect(subject.errors[:vapid_keypair]).to eq ["can't be blank"]
+    end
+
+    it 'should require the vapid keypair to have subject, public and private key' do
+      subject.vapid_keypair = {}.to_json
+      is_expected.not_to be_valid
+      expect(subject.errors[:vapid_keypair].sort).to eq [
+        'must have a private_key entry',
+        'must have a public_key entry',
+        'must have a subject entry',
+      ]
+    end
+
+    it 'should require valid json for the keypair' do
+      subject.vapid_keypair = 'invalid'
+      is_expected.not_to be_valid
+      expect(subject.errors[:vapid_keypair].sort).to eq [ 'must be valid JSON' ]
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+require 'unit_spec_helper'
+
+shared_examples 'Rpush::Client::Webpush::Notification' do
+  subject(:notification) { described_class.new }
+
+  describe 'notification attributes' do
+    describe 'data' do
+      subject { described_class.new(data: { message: 'test', urgency: 'normal' } ) }
+      it 'has a message' do
+        expect(subject.message).to eq "test"
+      end
+      it 'has an urgency' do
+        expect(subject.urgency).to eq "normal"
+      end
+    end
+
+    describe 'subscription' do
+      let(:subscription){ { endpoint: 'https://push.example.org/foo', keys: {'foo' => 'bar'}} }
+      subject { described_class.new(registration_ids: [subscription]) }
+
+      it "has a subscription" do
+        expect(subject.subscription).to eq({ endpoint: 'https://push.example.org/foo', keys: {foo: 'bar'} })
+      end
+    end
+  end
+
+
+  describe 'validates' do
+    let(:app) { Rpush::Webpush::App.create!(name: 'MyApp', vapid_keypair: VAPID_KEYPAIR) }
+
+    describe 'data' do
+      subject { described_class.new(app: app, registration_ids: [{endpoint: 'https://push.example.org/foo', keys: {'foo' => 'bar'}}]) }
+      it 'validates presence' do
+        is_expected.not_to be_valid
+        expect(subject.errors[:data]).to eq ["can't be blank"]
+      end
+
+      it "has a 'data' payload limit of 4096 bytes" do
+        subject.data = { message: 'a' * 4096 }
+        is_expected.not_to be_valid
+        expected_errors = ["Notification payload data cannot be larger than 4096 bytes."]
+        expect(subject.errors[:base]).to eq expected_errors
+      end
+    end
+
+    describe 'registration_ids' do
+      subject { described_class.new(app: app, data: { message: 'test' }) }
+      it 'validates presence' do
+        is_expected.not_to be_valid
+        expect(subject.errors[:registration_ids]).to eq ["can't be blank"]
+      end
+
+      it 'limits the number of registration ids to exactly 1' do
+        subject.registration_ids = [{endpoint: 'string', keys: { 'a' => 'hash' }}] * 2
+        is_expected.not_to be_valid
+        expected_errors = ["Number of registration_ids cannot be larger than 1."]
+        expect(subject.errors[:base]).to eq expected_errors
+      end
+
+      it 'validates the structure of the registration' do
+        subject.registration_ids = ['a']
+        is_expected.not_to be_valid
+        expect(subject.errors[:base]).to eq [
+          "Registration must have :endpoint (String) and :keys (Hash) keys"
+        ]
+
+        subject.registration_ids = [{endpoint: 'string', keys: { 'a' => 'hash' }}]
+        is_expected.to be_valid
+      end
+    end
+
+    describe 'time_to_live' do
+      subject { described_class.new(app: app, data: { message: 'test' }, registration_ids: [{endpoint: 'https://push.example.org/foo', keys: {'foo' => 'bar'}}]) }
+
+      it 'should be > 0' do
+        subject.time_to_live = -1
+        is_expected.not_to be_valid
+        expect(subject.errors[:time_to_live]).to eq ['must be greater than 0']
+      end
+    end
+
+  end
+end

data/spec/unit/client/shared/wns/badge_notification.rb

@@ -0,0 +1,15 @@
+require 'unit_spec_helper'
+
+shared_examples 'Rpush::Client::Wns::BadgeNotification' do
+  let(: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.badge = 42
+    notif
+  end
+
+  it 'should allow a notification without data' do
+    expect(notification.valid?).to be(true)
+  end
+end

data/spec/unit/client/shared/wns/raw_notification.rb

@@ -0,0 +1,21 @@
+require 'unit_spec_helper'
+
+shared_examples 'Rpush::Client::Wns::RawNotification' do
+  let(: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
+
+  it 'allows exact payload of 5 KB' do
+    allow(notification).to receive(:payload_data_size) { 5120 }
+    expect(notification.valid?).to be(true)
+  end
+
+  it 'allows the size of payload under 5 KB' do
+    allow(notification).to receive(:payload_data_size) { 5119 }
+    expect(notification.valid?).to be(true)
+  end
+end

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

@@ -0,0 +1,4 @@
+require 'unit_spec_helper'
+
+shared_examples 'Rpush::Client::Wpns::App' do
+end

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

@@ -0,0 +1,18 @@
+require 'unit_spec_helper'
+
+shared_examples 'Rpush::Client::Wpns::Notification' do
+  let(:app) { Rpush::Wpns::App.create!(name: 'test', auth_key: 'abc') }
+  let(:notification) { described_class.new }
+
+  it "should have an url in the uri parameter" do
+    notification = described_class.new(uri: "somthing")
+    notification.valid?
+    expect(notification.errors[:uri]).to include('is invalid')
+  end
+
+  it "should be invalid if there's no data" do
+    notification = described_class.new(data: {})
+    notification.valid?
+    expect(notification.errors[:data]).to include("can't be blank")
+  end
+end