imobile 0.0.4 → 0.0.5

data/CHANGELOG

@@ -1,3 +1,5 @@
+v0.0.5. Renamed device_token to push_token throughout the API.
+
 v0.0.4. Updated CryptoSupport with the push token device attribute.  
 
 v0.0.3. Push Notification support.

data/Manifest

@@ -1,4 +1,5 @@
 CHANGELOG
+imobile.gemspec
 lib/imobile/crypto_app_fprint.rb
 lib/imobile/push_notification.rb
 lib/imobile/validate_receipt.rb
@@ -15,6 +16,6 @@ testdata/apns_production.p12
 testdata/device_attributes.yml
 testdata/encoded_notification
 testdata/forged_sandbox_receipt
-testdata/sandbox_device_token
-testdata/sandbox_device_token.bin
+testdata/sandbox_push_token
+testdata/sandbox_push_token.bin
 testdata/valid_sandbox_receipt

data/imobile.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{imobile}
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Victor Costan"]
-  s.date = %q{2009-07-26}
+  s.date = %q{2009-07-27}
   s.description = %q{Library for servers backing iPhone applications.}
   s.email = %q{victor@zergling.net}
   s.extra_rdoc_files = ["CHANGELOG", "lib/imobile/crypto_app_fprint.rb", "lib/imobile/push_notification.rb", "lib/imobile/validate_receipt.rb", "lib/imobile.rb", "LICENSE", "README"]
-  s.files = ["CHANGELOG", "lib/imobile/crypto_app_fprint.rb", "lib/imobile/push_notification.rb", "lib/imobile/validate_receipt.rb", "lib/imobile.rb", "LICENSE", "Manifest", "Rakefile", "README", "test/crypto_app_fprint_test.rb", "test/push_notification_test.rb", "test/validate_receipt_test.rb", "testdata/apns_developer.p12", "testdata/apns_production.p12", "testdata/device_attributes.yml", "testdata/encoded_notification", "testdata/forged_sandbox_receipt", "testdata/sandbox_device_token", "testdata/sandbox_device_token.bin", "testdata/valid_sandbox_receipt", "imobile.gemspec"]
+  s.files = ["CHANGELOG", "imobile.gemspec", "lib/imobile/crypto_app_fprint.rb", "lib/imobile/push_notification.rb", "lib/imobile/validate_receipt.rb", "lib/imobile.rb", "LICENSE", "Manifest", "Rakefile", "README", "test/crypto_app_fprint_test.rb", "test/push_notification_test.rb", "test/validate_receipt_test.rb", "testdata/apns_developer.p12", "testdata/apns_production.p12", "testdata/device_attributes.yml", "testdata/encoded_notification", "testdata/forged_sandbox_receipt", "testdata/sandbox_push_token", "testdata/sandbox_push_token.bin", "testdata/valid_sandbox_receipt"]
   s.homepage = %q{http://github.com/costan/imobile}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Imobile", "--main", "README"]
   s.require_paths = ["lib"]

data/lib/imobile/push_notification.rb

@@ -21,7 +21,7 @@ module Imobile
 #
 # Args:
 #   notification:: ruby Hash indicating the desired notification; the hash
-#                  should have an extra key named :device_token, containing
+#                  should have an extra key named :push_token, containing
 #                  the binary-encoded (not hexadecimally-encoded) iMobile device
 #                  token, as provided by the UIApplicationDelegate method
 #                  application:didRegisterForRemoteNotificationsWithDeviceToken: 
@@ -55,7 +55,7 @@ end
 #
 # The currently provided feedback is the tokens for the devices which rejected
 # notifications. Each piece of feedback is a hash with the following keys:
-#   :device_token:: the device's token, in binary (not hexadecimal) format
+#   :push_token:: the device's token, in binary (not hexadecimal) format
 #   :time:: the last time when the device rejected notifications; according to
 #           Apple, the rejection can be discarded if the device sent a
 #           token after this time
@@ -76,9 +76,9 @@ def self.valid_notification?(notification)
   PushNotifications.encode_notification(notification) ? true : false
 end
 
-# Packs a hexadecimal iMobile device token into binary form.
-def self.pack_hex_device_token(device_token)
-  [device_token.gsub(/\s/, '')].pack('H*')
+# Packs a hexadecimal iMobile token for push notifications into binary form.
+def self.pack_hex_push_token(push_token)
+  [push_token.gsub(/\s/, '')].pack('H*')
 end
 
 # Implementation details for push_notification.
@@ -118,13 +118,13 @@ module PushNotifications
   # Returns a string suitable for transmission over an APNs, or nil if the
   # notification is invalid (i.e. the json encoding exceeds 256 bytes).
   def self.encode_notification(notification)
-    device_token = notification[:device_token] || ''
+    push_token = notification[:push_token] || ''
     notification = notification.dup
-    notification.delete :device_token
+    notification.delete :push_token
     json_notification = notification.to_json
     return nil if json_notification.length > 256
     
-    ["\0", [device_token.length].pack('n'), device_token,
+    ["\0", [push_token.length].pack('n'), push_token,
      [json_notification.length].pack('n'), json_notification].join
   end
     
@@ -226,7 +226,8 @@ module PushNotifications
   #
   # The currently provided feedback is the tokens for the devices which rejected
   # notifications. Each piece of feedback is a hash with the following keys:
-  #   :device_token:: the device's token, in binary (not hexadecimal) format
+  #   :push_token:: the device's token for push notifications, in binary
+  #                 (not hexadecimal) format
   #   :time:: the last time when the device rejected notifications; according to
   #           Apple, the rejection can be discarded if the device sent a
   #           token after this time
@@ -238,9 +239,9 @@ module PushNotifications
     loop do      
       break unless header = fixed_socket_read(socket, 6)
       time = Time.at header[0, 4].unpack('N').first
-      device_token = fixed_socket_read(socket, header[4, 2].unpack('n').first)
-      break unless device_token
-      feedback_item = { :device_token => device_token, :time => time }
+      push_token = fixed_socket_read(socket, header[4, 2].unpack('n').first)
+      break unless push_token
+      feedback_item = { :push_token => push_token, :time => time }
       yield feedback_item
     end
     socket.close

data/test/push_notification_test.rb

@@ -17,8 +17,8 @@ class PushNotificationTest < Test::Unit::TestCase
     @dev_cert_path = File.join(testdata_path, 'apns_developer.p12') 
     @prod_cert_path = File.join(testdata_path, 'apns_production.p12')
     
-    @hex_dev_token = File.read File.join(testdata_path, 'sandbox_device_token')
-    @dev_token = File.read File.join(testdata_path, 'sandbox_device_token.bin')
+    @hex_dev_token = File.read File.join(testdata_path, 'sandbox_push_token')
+    @dev_token = File.read File.join(testdata_path, 'sandbox_push_token.bin')
     
     @notification = {:aps => {:alert => 'imobile test notification'}}
     @encoded_notification = File.read File.join(testdata_path,
@@ -46,12 +46,12 @@ class PushNotificationTest < Test::Unit::TestCase
            "Wrong data in prod certificate #{cert_data[:certificate].inspect}")
   end
   
-  def test_pack_device_token
-    assert_equal @dev_token, Imobile.pack_hex_device_token(@hex_dev_token)
+  def test_pack_push_token
+    assert_equal @dev_token, Imobile.pack_hex_push_token(@hex_dev_token)
   end
    
   def test_encode_notification
-    notification = @notification.merge :device_token => @dev_token
+    notification = @notification.merge :push_token => @dev_token
     encoded = Imobile::PushNotifications.encode_notification notification
     
     assert_equal @encoded_notification, encoded
@@ -60,7 +60,7 @@ class PushNotificationTest < Test::Unit::TestCase
   def test_valid_notification
     assert Imobile.valid_notification?(@notification),
            'Failed on easy valid notification'
-    notification = @notification.merge :device_token => '1' * 512
+    notification = @notification.merge :push_token => '1' * 512
     assert Imobile.valid_notification?(notification),
            'Failed on notification with large device token'
     notification[:aps][:alert] = '1' * 512
@@ -85,7 +85,7 @@ class PushNotificationTest < Test::Unit::TestCase
   end
     
   def test_smoke_push
-    notification = @notification.merge :device_token => @dev_token
+    notification = @notification.merge :push_token => @dev_token
     Imobile.push_notification notification, @dev_cert_path
   end
   
@@ -95,8 +95,8 @@ class PushNotificationTest < Test::Unit::TestCase
     token1 = @dev_token
     token2 = @dev_token.reverse
     golden_feedback = [
-      {:device_token => token1, :time => time1},
-      {:device_token => token2, :time => time2}
+      {:push_token => token1, :time => time1},
+      {:push_token => token2, :time => time2}
     ]
     
     reads = [
@@ -143,8 +143,8 @@ class PushNotificationTest < Test::Unit::TestCase
   
   # Verifies that a piece of feedback looks valid.
   def check_feedback_item(feedback)
-    assert feedback[:device_token],
-           "A feedback item does not contain a device token"
+    assert feedback[:push_token],
+           "A feedback item does not contain a push token"
     assert feedback[:time],
            "A feedback item does not contain a timestamp"
   end  

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: imobile
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Victor Costan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-26 00:00:00 -04:00
+date: 2009-07-27 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,6 +58,7 @@ extra_rdoc_files:
 - README
 files: 
 - CHANGELOG
+- imobile.gemspec
 - lib/imobile/crypto_app_fprint.rb
 - lib/imobile/push_notification.rb
 - lib/imobile/validate_receipt.rb
@@ -74,10 +75,9 @@ files:
 - testdata/device_attributes.yml
 - testdata/encoded_notification
 - testdata/forged_sandbox_receipt
-- testdata/sandbox_device_token
-- testdata/sandbox_device_token.bin
+- testdata/sandbox_push_token
+- testdata/sandbox_push_token.bin
 - testdata/valid_sandbox_receipt
-- imobile.gemspec
 has_rdoc: true
 homepage: http://github.com/costan/imobile
 licenses: []