imobile 0.0.6 → 0.0.7

data/CHANGELOG

@@ -1,3 +1,5 @@
+v0.0.7. New API for push notifications, better suited for daemons.
+
 v0.0.6. New push certificates read method for Ruby 1.8.6 on Heroku.
 
 v0.0.5. Renamed device_token to push_token throughout the API.

data/Manifest

@@ -7,7 +7,7 @@ lib/imobile.rb
 LICENSE
 Manifest
 Rakefile
-README
+README.textile
 test/crypto_app_fprint_test.rb
 test/push_notification_test.rb
 test/validate_receipt_test.rb

data/README.textile

@@ -0,0 +1,37 @@
+h1. Imobile
+
+This gem/Rails plugin contains common code for powering iPhone applications. It
+is particularly suitable as a server-side partner to the ZergSupport toolkit,
+also available on Github under the MIT license at
+http://github.com/costan/zergsupport
+
+h2. Features
+
+* <b>In-App Purchase</b> receipts verification - imobile can verify a StoreKit
+receipt with Apple's servers. Apple's response is parsed into a Ruby-friendly
+hash. See Imobile.validate_receipt in validate_receipt.rb
+
+* <b>Push Notifications</b> - imobile supports both pushing notifications and
+receiving feedback from Apple's servers. imobile can use the .p12 certificates
+exported by Keychain directly, and it knows to talk to both sandbox and
+production servers. imobile can send notifications in batch mode, ideal for
+daemons and Cron jobs. See Imobile.push_notifications and Imobile.push_feedback
+in push_notification.rb
+
+* ZergSupport's CryptoSupport - imobile can validate the application fingerprint
+generated by ZergSupport's CryptoSupport. Useful to know who's pirating your
+applications. See Imobile.crypto_app_fprint in crypto_app_fprint.rb
+
+* Production-friendly - imobile has great automated test coverage and all
+methods are reasonably well document. The code is placed under the MIT license.
+
+h2. ZergSupport
+
+Some of imobile's functionality was designed specifically for use with the
+ZergSupport iPhone application toolkit. The toolkit is available under the MIT
+license at http://github.com/costan/zergsupport
+
+h2. Contributions
+
+Please don't hesitate to fork the project and send pull requests.
+ 

data/imobile.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{imobile}
-  s.version = "0.0.6"
+  s.version = "0.0.7"
 
   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-27}
+  s.date = %q{2009-07-28}
   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", "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.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.textile"]
+  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.textile", "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.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Imobile", "--main", "README.textile"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{zerglings}
   s.rubygems_version = %q{1.3.5}

data/lib/imobile/push_notification.rb

@@ -51,7 +51,7 @@ end
 # Reads the available feedback from Apple's Push Notification service.
 #
 # Args:
-#   certificate_or_path:: see Imobile.push_notification
+#   path_or_certificate:: see Imobile.push_notification
 #
 # The currently provided feedback is the tokens for the devices which rejected
 # notifications. Each piece of feedback is a hash with the following keys:
@@ -81,6 +81,53 @@ def self.pack_hex_push_token(push_token)
   [push_token.gsub(/\s/, '')].pack('H*')
 end
 
+# Carries state for delivering batched notifications.
+class PushNotificationsContext
+  # Sends a notification via this context's APNs connection.
+  #
+  # Args:
+  #   notification:: see Imobile.push_notification
+  #
+  # Raises a RuntimeError if the context's APNs connection was closed.
+  def push(notification)
+    raise "The context's APNs connection was closed" if @closed
+    @socket.write PushNotifications.encode_notification(notification)
+  end
+  
+  # Creates a push context for a fixed Apple Push Notifications server.
+  #
+  # Args:
+  #   path_or_certificate:: see Imobile.push_notification
+  def initialize(path_or_certificate)
+    @certificate = PushNotifications.read_certificate path_or_certificate    
+    @socket = PushNotifications.apns_socket @certificate, :push
+    @closed = false
+  end
+  
+  # Closes the APNs connection. The context is unusable afterwards.
+  def close
+    @socket.close unless @closed
+    @closed = true
+  end
+  
+  # The raw SSL connection to the APNs. 
+  attr_reader :socket
+  # The APNs client certificate.
+  attr_reader :certificate
+
+  # True if the context's APNs connection is closed.
+  def closed?
+    @closed
+  end
+  
+  # Called when the context is garbage-collected.
+  #
+  # Closes the APNs connection, if it wasn't already closed.
+  def finalize
+    close unless @closed
+  end
+end
+
 # Implementation details for push_notification.
 module PushNotifications
   # Reads an APNs certificate from a string or a file.
@@ -203,7 +250,6 @@ module PushNotifications
       super
       raw_socket.close
     end
-    socket.sync = true
     socket.connect
   end
   
@@ -239,17 +285,17 @@ module PushNotifications
   
   # Real implementation of Imobile.push_notifications
   def self.push_notifications(certificate_or_path, notifications)
-    socket = apns_socket read_certificate(certificate_or_path), :push
+    context = PushNotificationsContext.new certificate_or_path
     notifications = [notifications] if notifications.kind_of? Hash
-    notifications.each { |n| socket.write encode_notification(n) }
+    notifications.each { |notification| context.push notification }
     if Kernel.block_given?
       loop do
         notifications = yield
         notifications = [notifications] if notifications.kind_of? Hash
-        notifications.each { |n| socket.write encode_notification(n) }
+        notifications.each { |notification| context.push notification }
       end
     end
-    socket.close
+    context.close
   end
   
   # Real implementation of Imobile.push_notification

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: imobile
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors: 
 - Victor Costan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-27 00:00:00 -04:00
+date: 2009-07-28 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -55,7 +55,7 @@ extra_rdoc_files:
 - lib/imobile/validate_receipt.rb
 - lib/imobile.rb
 - LICENSE
-- README
+- README.textile
 files: 
 - CHANGELOG
 - imobile.gemspec
@@ -66,7 +66,7 @@ files:
 - LICENSE
 - Manifest
 - Rakefile
-- README
+- README.textile
 - test/crypto_app_fprint_test.rb
 - test/push_notification_test.rb
 - test/validate_receipt_test.rb
@@ -89,7 +89,7 @@ rdoc_options:
 - --title
 - Imobile
 - --main
-- README
+- README.textile
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/README

@@ -1,6 +0,0 @@
-This gem/Rails plugin contains common code for powering iPhone applications. It
-is particularly suitable as a server-side partner to the ZergSupport toolkit,
-also available on Github under the MIT license at
-http://github.com/costan/zergsupport
-
-