apn_on_rails 0.3.1 → 0.4.0

data/spec/apn_on_rails/app/models/apn/device_spec.rb

@@ -0,0 +1,60 @@
+require File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'spec_helper.rb')
+
+describe APN::Device do
+  
+  describe 'token' do
+    
+    it 'should be unique' do
+      device = DeviceFactory.new(:token => APN::Device.first.token)
+      device.should_not be_valid
+      device.errors['token'].should include('has already been taken')
+      
+      device = DeviceFactory.new(:token => device.token.succ)
+      device.should be_valid
+    end
+    
+    it 'should get cleansed if it contains brackets' do
+      token = DeviceFactory.random_token
+      device = DeviceFactory.new(:token => "<#{token}>")
+      device.token.should == token
+      device.token.should_not == "<#{token}>"
+    end
+    
+    it 'should be in the correct pattern' do
+      device = DeviceFactory.new(:token => '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz')
+      device.should be_valid
+      device.token = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6'
+      device.should_not be_valid
+      device.token = '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7!!'
+      device.should_not be_valid
+    end
+    
+  end
+  
+  describe 'to_hexa' do
+    
+    it 'should convert the text string to hexadecimal' do
+      device = DeviceFactory.new(:token => '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz')
+      device.to_hexa.should == fixture_value('hexa.bin')
+    end
+    
+  end
+  
+  describe 'before_save' do
+    
+    it 'should set the last_registered_at date to Time.now if nil' do
+      time = Time.now
+      Time.stub(:now).and_return(time)
+      device = DeviceFactory.create
+      device.last_registered_at.should_not be_nil
+      device.last_registered_at.to_s.should == time.to_s
+      
+      ago = 1.week.ago
+      device = DeviceFactory.create(:last_registered_at => ago)
+      device.last_registered_at.should_not be_nil
+      device.last_registered_at.to_s.should == ago.to_s
+    end
+    
+  end
+  
+end

data/spec/apn_on_rails/app/models/apn/group_notification_spec.rb

@@ -0,0 +1,66 @@
+require File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'spec_helper.rb')
+
+describe APN::GroupNotification do
+  
+  describe 'alert' do
+    
+    it 'should trim the message to 150 characters' do
+      noty = APN::GroupNotification.new
+      noty.alert = 'a' * 200
+      noty.alert.should == ('a' * 147) + '...'
+    end
+    
+  end
+  
+  describe 'apple_hash' do
+    
+    it 'should return a hash of the appropriate params for Apple' do
+      noty = APN::GroupNotification.first
+      noty.apple_hash.should == {"aps" => {"badge" => 5, "sound" => "my_sound.aiff", "alert" => "Hello!"},"typ" => "1"}
+      noty.custom_properties = nil
+      noty.apple_hash.should == {"aps" => {"badge" => 5, "sound" => "my_sound.aiff", "alert" => "Hello!"}}
+      noty.badge = nil
+      noty.apple_hash.should == {"aps" => {"sound" => "my_sound.aiff", "alert" => "Hello!"}}
+      noty.alert = nil
+      noty.apple_hash.should == {"aps" => {"sound" => "my_sound.aiff"}}
+      noty.sound = nil
+      noty.apple_hash.should == {"aps" => {}}
+      noty.sound = true
+      noty.apple_hash.should == {"aps" => {"sound" => "1.aiff"}}
+    end
+    
+  end
+  
+  describe 'to_apple_json' do
+    
+    it 'should return the necessary JSON for Apple' do
+      noty = APN::GroupNotification.first
+      noty.to_apple_json.should == %{{"typ":"1","aps":{"badge":5,"sound":"my_sound.aiff","alert":"Hello!"}}}
+    end
+    
+  end
+  
+  describe 'message_for_sending' do
+    
+    it 'should create a binary message to be sent to Apple' do
+      noty = APN::GroupNotification.first
+      noty.custom_properties = nil
+      device = DeviceFactory.new(:token => '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz')
+      noty.message_for_sending(device).should == fixture_value('message_for_sending.bin')
+    end
+    
+    it 'should raise an APN::Errors::ExceededMessageSizeError if the message is too big' do
+      app = AppFactory.create
+      device = DeviceFactory.create({:app_id => app.id})
+      group =   GroupFactory.create({:app_id => app.id})
+      device_grouping = DeviceGroupingFactory.create({:group_id => group.id,:device_id => device.id})
+      noty = GroupNotificationFactory.new(:group_id => group.id, :sound => true, :badge => nil)
+      noty.send(:write_attribute, 'alert', 'a' * 183)
+      lambda {
+        noty.message_for_sending(device)
+      }.should raise_error(APN::Errors::ExceededMessageSizeError)
+    end
+    
+  end
+  
+end

data/spec/apn_on_rails/app/models/apn/notification_spec.rb

@@ -0,0 +1,71 @@
+require File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'spec_helper.rb')
+
+describe APN::Notification do
+  
+  describe 'alert' do
+    
+    it 'should trim the message to 150 characters' do
+      noty = APN::Notification.new
+      noty.alert = 'a' * 200
+      noty.alert.should == ('a' * 147) + '...'
+    end
+    
+  end
+  
+  describe 'apple_hash' do
+    
+    it 'should return a hash of the appropriate params for Apple' do
+      noty = APN::Notification.first
+      noty.apple_hash.should == {"aps" => {"badge" => 5, "sound" => "my_sound.aiff", "alert" => "Hello!"},"typ" => "1"}
+      noty.custom_properties = nil
+      noty.apple_hash.should == {"aps" => {"badge" => 5, "sound" => "my_sound.aiff", "alert" => "Hello!"}}
+      noty.badge = nil
+      noty.apple_hash.should == {"aps" => {"sound" => "my_sound.aiff", "alert" => "Hello!"}}
+      noty.alert = nil
+      noty.apple_hash.should == {"aps" => {"sound" => "my_sound.aiff"}}
+      noty.sound = nil
+      noty.apple_hash.should == {"aps" => {}}
+      noty.sound = true
+      noty.apple_hash.should == {"aps" => {"sound" => "1.aiff"}}
+    end
+    
+  end
+  
+  describe 'to_apple_json' do
+    
+    it 'should return the necessary JSON for Apple' do
+      noty = APN::Notification.first
+      noty.to_apple_json.should == %{{"typ":"1","aps":{"badge":5,"sound":"my_sound.aiff","alert":"Hello!"}}}
+    end
+    
+  end
+  
+  describe 'message_for_sending' do
+    
+    it 'should create a binary message to be sent to Apple' do
+      noty = APN::Notification.first
+      noty.custom_properties = nil
+      noty.device = DeviceFactory.new(:token => '5gxadhy6 6zmtxfl6 5zpbcxmw ez3w7ksf qscpr55t trknkzap 7yyt45sc g6jrw7qz')
+      noty.message_for_sending.should == fixture_value('message_for_sending.bin')
+    end
+    
+    it 'should raise an APN::Errors::ExceededMessageSizeError if the message is too big' do
+      noty = NotificationFactory.new(:device_id => DeviceFactory.create, :sound => true, :badge => nil)
+      noty.send(:write_attribute, 'alert', 'a' * 183)
+      lambda {
+        noty.message_for_sending
+      }.should raise_error(APN::Errors::ExceededMessageSizeError)
+    end
+    
+  end
+  
+  describe 'send_notifications' do 
+    
+    it 'should warn the user the method is deprecated and call the corresponding method on APN::App' do
+      ActiveSupport::Deprecation.should_receive(:warn)
+      APN::App.should_receive(:send_notifications)
+      APN::Notification.send_notifications
+    end
+  end
+  
+end

data/spec/apn_on_rails/app/models/apn/pull_notification_spec.rb

@@ -0,0 +1,37 @@
+require File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'spec_helper.rb')
+
+describe APN::PullNotification do
+  
+  describe 'latest_since_when_already_seen_latest' do
+    
+    it 'should return nothing because since date is after the latest pull notification' do
+      app = APN::App.first
+      noty1 = PullNotificationFactory.create({:app_id => app.id})
+      noty1.created_at = Time.now - 1.week
+      noty1.save
+      APN::PullNotification.latest_since(app.id,Time.now).should == nil      
+    end
+    
+  end
+  
+  describe 'latest_since_when_have_not_seen_latest' do 
+    
+    it 'should return the most recent pull notification because it has not yet been seen' do 
+      app = APN::App.first
+      noty1 = PullNotificationFactory.create({:app_id => app.id})
+      noty1.created_at = Time.now + 1.week
+      noty1.save
+      APN::PullNotification.latest_since(app.id,Time.now - 1.week).should == noty1 
+    end
+
+  end
+  
+  describe 'latest_since_with_no_date' do 
+    it 'should return the most recent pull notification because no date is given' do 
+      app = APN::App.first
+      noty1 = APN::PullNotification.find(:first, :order => "created_at DESC")
+      APN::PullNotification.latest_since(app.id).should == noty1
+    end
+  end
+  
+end

data/spec/apn_on_rails/libs/connection_spec.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe APN::Connection do
+
+  describe 'open_for_delivery' do
+    
+    it 'should create a connection to Apple, yield it, and then close' do
+      rsa_mock = mock('rsa_mock')
+      OpenSSL::PKey::RSA.should_receive(:new).and_return(rsa_mock)
+
+      cert_mock = mock('cert_mock')
+      OpenSSL::X509::Certificate.should_receive(:new).and_return(cert_mock)
+
+      ctx_mock = mock('ctx_mock')
+      ctx_mock.should_receive(:key=).with(rsa_mock)
+      ctx_mock.should_receive(:cert=).with(cert_mock)
+      OpenSSL::SSL::SSLContext.should_receive(:new).and_return(ctx_mock)
+      
+      tcp_mock = mock('tcp_mock')
+      tcp_mock.should_receive(:close)
+      TCPSocket.should_receive(:new).with('gateway.sandbox.push.apple.com', 2195).and_return(tcp_mock)
+      
+      ssl_mock = mock('ssl_mock')
+      ssl_mock.should_receive(:sync=).with(true)
+      ssl_mock.should_receive(:connect)
+      ssl_mock.should_receive(:write).with('message-0')
+      ssl_mock.should_receive(:write).with('message-1')
+      ssl_mock.should_receive(:close)
+      OpenSSL::SSL::SSLSocket.should_receive(:new).with(tcp_mock, ctx_mock).and_return(ssl_mock)
+      
+      APN::Connection.open_for_delivery do |conn, sock|
+        conn.write('message-0')
+        conn.write('message-1')
+      end
+      
+    end
+    
+  end
+  
+end

data/spec/apn_on_rails/libs/feedback_spec.rb

@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe APN::Feedback do
+  
+  describe 'devices' do
+    
+    before(:each) do
+      @time = Time.now
+      @device = DeviceFactory.create
+      @cert = mock('cert_mock')
+      
+      @data_mock = mock('data_mock')
+      @data_mock.should_receive(:strip!)
+      @data_mock.should_receive(:unpack).with('N1n1H140').and_return([@time.to_i, 12388, @device.token.delete(' ')])
+      
+      @ssl_mock = mock('ssl_mock')
+      @sock_mock = mock('sock_mock')
+      @sock_mock.should_receive(:gets).twice.and_return(@data_mock, nil)
+      
+    end
+    
+    it 'should an Array of devices that need to be processed' do
+      APN::Connection.should_receive(:open_for_feedback).and_yield(@ssl_mock, @sock_mock)
+      
+      devices = APN::Feedback.devices(@cert)
+      devices.size.should == 1
+      r_device = devices.first
+      r_device.token.should == @device.token
+      r_device.feedback_at.to_s.should == @time.to_s
+    end
+    
+    it 'should yield up each device' do
+      APN::Connection.should_receive(:open_for_feedback).and_yield(@ssl_mock, @sock_mock)
+      lambda {
+        APN::Feedback.devices(@cert) do |r_device|
+          r_device.token.should == @device.token
+          r_device.feedback_at.to_s.should == @time.to_s
+          raise BlockRan.new
+        end
+      }.should raise_error(BlockRan)
+    end
+    
+  end
+  
+end

data/spec/extensions/string.rb

@@ -0,0 +1,10 @@
+class String
+  
+  def self.randomize(length = 10)
+    chars = ("A".."H").to_a + ("J".."N").to_a + ("P".."T").to_a + ("W".."Z").to_a + ("3".."9").to_a
+    newpass = ""
+    1.upto(length) { |i| newpass << chars[rand(chars.size-1)] }
+    return newpass.upcase
+  end
+  
+end

data/spec/factories/app_factory.rb

@@ -0,0 +1,27 @@
+module AppFactory
+  
+  class << self
+    
+    def new(options = {})
+      options = {:apn_dev_cert => AppFactory.random_cert, 
+                 :apn_prod_cert => AppFactory.random_cert}.merge(options)
+      return APN::App.new(options)
+    end
+    
+    def create(options = {})
+      device = AppFactory.new(options)
+      device.save
+      return device
+    end
+    
+    def random_cert
+      tok = []
+      tok << String.randomize(50)
+      tok.join('').downcase
+    end
+    
+  end
+  
+end
+
+AppFactory.create

data/spec/factories/device_factory.rb

@@ -0,0 +1,29 @@
+module DeviceFactory
+  
+  class << self
+    
+    def new(options = {})
+      app = APN::App.first
+      options = {:token => DeviceFactory.random_token, :app_id => app.id}.merge(options)
+      return APN::Device.new(options)
+    end
+    
+    def create(options = {})
+      device = DeviceFactory.new(options)
+      device.save
+      return device
+    end
+    
+    def random_token
+      tok = []
+      8.times do
+        tok << String.randomize(8)
+      end
+      tok.join(' ').downcase
+    end
+    
+  end
+  
+end
+
+DeviceFactory.create

data/spec/factories/device_grouping_factory.rb

@@ -0,0 +1,22 @@
+module DeviceGroupingFactory
+  
+  class << self
+    
+    def new(options = {})
+      device = APN::Device.first
+      group  = APN::Group.first
+      options = {:device_id => device.id, :group_id => group.id}.merge(options)
+      return APN::DeviceGrouping.new(options)
+    end
+    
+    def create(options = {})
+      device_grouping = DeviceGroupingFactory.new(options)
+      device_grouping.save
+      return device_grouping
+    end
+    
+  end
+  
+end
+
+DeviceGroupingFactory.create

data/spec/factories/group_factory.rb

@@ -0,0 +1,27 @@
+module GroupFactory
+  
+  class << self
+    
+    def new(options = {})
+      app = APN::App.first
+      options = {:app_id => app.id, :name => GroupFactory.random_name}.merge(options)
+      return APN::Group.new(options)
+    end
+    
+    def create(options = {})
+      group = GroupFactory.new(options)
+      group.save
+      return group
+    end
+    
+    def random_name
+      tok = []
+      tok << String.randomize(8)
+      tok.join(' ').downcase
+    end
+    
+  end
+  
+end
+
+GroupFactory.create