eq-apns 0.2.0

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009 James Pozdena, 2010 Justin.tv
+ 
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,153 @@
+h1. JTV-APNS
+
+Jtv-apns is a gem for accessing the Apple Push Notification Service that allows
+both sending notifications and reading from apple's feedback service. This gem
+is based heavily on the work of James Pozdena (http://github.com/jpoz/APNS).
+
+h2. Install
+
+<pre>
+sudo gem install jtv-apns
+</pre>
+
+h2. Setup:
+
+First, you will need to export your development/production iphone push service
+certificate and key from your keychain. To do this select the private key and
+certificate, and select File -> Export from your keychain. By default a .p12
+file will be generated containing certificate and key.
+
+Next, run the following command to convert this .p12 file into a .pem file.
+<pre>
+openssl pkcs12 -in cert.p12 -out cert.pem -nodes -clcerts
+</pre>
+
+This pem file should be stored somewhere secure that your application can access. Next, set the jtv-apns configuration parameters:
+
+<pre>
+###################
+# Hosts Config
+###################
+
+# Push Notification Service:
+#
+# (default: gateway.sandbox.push.apple.com is)
+# Set as below for a production install
+APNS.host = 'gateway.push.apple.com' 
+
+# (default: 2195)
+# APNS.port = 2195
+
+# Feedback Service:
+#
+# (default: feedback.sandbox.push.apple.com)
+APNS.feedback_host = 'feedback.push.apple.com'
+
+# (default: 2196)
+# APNS.feedback_port = 2196
+
+####################
+# Certificate Setup
+####################
+
+# Path to the .pem file created earlier
+APNS.pem  = '/path/to/pem/file'
+
+# Password for decrypting the .pem file, if one was used
+APNS.pass = 'xxxx'
+
+####################
+# Connection Mgmt
+####################
+
+# Cache open connections when sending push notifications
+# this will force the gem to keep 1 connection open per
+# host/port pair, and reuse it when sending notifications
+
+# (default: false)
+# APNS.cache_connections = true
+</pre>
+
+h2. Example (Single notification):
+
+Then to send a push notification you can either just send a string as the alert or give it a hash for the alert, badge and sound.
+
+<pre>
+device_token = '123abc456def'
+
+APNS.send_notification(device_token, 'Hello iPhone!')
+APNS.send_notification(device_token, :aps => {:alert => 'Hello iPhone!', :badge => 1, :sound => 'default'})
+</pre>
+
+h2. Example (Multiple notifications):
+
+You can also send multiple notifications using the same connection to Apple:
+
+<pre>
+device_token = '123abc456def'
+
+n1 = [device_token, :aps => { :alert => 'Hello...', :badge => 1, :sound => 'default' }
+n2 = [device_token, :aps => { :alert => '... iPhone!', :badge => 1, :sound => 'default' }]
+
+APNS.send_notifications([n1, n2])
+</pre>
+
+
+h2. Send other info along with aps
+
+Application-specific information can be included along with the alert by
+passing it along with the "aps" key in the message hash.
+
+<pre>
+APNS.send_notification(device_token, :aps => { :alert => 'Hello iPhone!', :badge => 1, :sound => 'default'},
+                                     :sent_by => 'Justin.tv')
+</pre>
+
+h2. Pre-establishing connections
+
+If connection caching is enabled, you can tell the gem to establish connections before sending any notifications.
+
+<pre>
+APNS.establish_notification_connection
+# ...
+if APNS.has_notification_connection?
+  APNS.send_notification(device_token, "It works!")
+end
+</pre>
+
+h2. Accessing the feedback service
+
+jtv-apns provides a simple api to access Apple's feedback service. Below is an example for setting the feedback time on an ActiveRecord object corresponding to a device token.
+
+<pre>
+# APNS.feedback_each returns an array of Hash objects with the following keys
+# :feedback_on => (Time) Time Apple considers app unregistered from device
+# :length => (Fixnum) Length of :device_token, currently always 32 (bytes)
+# :device_token => (String) hex-encoded device token
+APNS.feedback.each do |feedback|
+  d = RegisteredDevices.find(:first, :conditions => { :device_token = feedback.device_token })
+  unless d.nil?
+    d.feedback_on = feedback.feedback_on
+  end
+end
+</pre>
+
+h2. Getting your iPhone's device token
+
+After you setup push notification for your application with Apple. You need to ask Apple for you application specific device token.
+
+ApplicationAppDelegate.m
+<pre>
+- (void)applicationDidFinishLaunching:(UIApplication *)application {    
+    // Register with apple that this app will use push notification
+    [[UIApplication sharedApplication] registerForRemoteNotificationTypes:(UIRemoteNotificationTypeAlert | 
+      UIRemoteNotificationTypeSound | UIRemoteNotificationTypeBadge)];	
+}
+
+- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
+    // Show the device token obtained from apple to the log
+    NSLog(@"deviceToken: %@", deviceToken);
+}
+</pre>
+    
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'date'
+require 'spec/rake/spectask'
+ 
+GEM = 'apns'
+GEM_NAME = 'apns'
+GEM_VERSION = '0.9.0'
+AUTHORS = ['James Pozdena']
+EMAIL = "jpoz@jpoz.net"
+HOMEPAGE = "http://github.com/jpoz/apns"
+SUMMARY = "Simple Apple push notification service gem"
+ 
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["MIT-LICENSE"]
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.authors = AUTHORS
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.require_path = 'lib'
+  s.autorequire = GEM
+  s.files = %w(MIT-LICENSE README.textile Rakefile) + Dir.glob("{lib}/**/*")
+end
+ 
+task :default => :spec
+ 
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = %w(-fs --color)
+end
+ 
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+ 
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+ 
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/lib/apns.rb

@@ -0,0 +1,24 @@
+# Copyright (c) 2009 James Pozdena, 2010 Justin.tv
+#  
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+#  
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#  
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+ 
+require 'apns/core'

data/lib/apns/core.rb

@@ -0,0 +1,242 @@
+# Copyright (c) 2009 James Pozdena, 2010 Justin.tv
+#  
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+#  
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#  
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+ 
+module APNS
+  require 'socket'
+  require 'openssl'
+  require 'json'
+
+  # Host for push notification service
+  # production: gateway.push.apple.com
+  # development: gateway.sandbox.apple.com
+  @host = 'gateway.sandbox.push.apple.com'
+  @port = 2195
+
+  # Host for feedback service
+  # production: feedback.push.apple.com
+  # development: feedback.sandbox.apple.com
+  @feedback_host = 'feedback.sandbox.push.apple.com'
+  @feedback_port = 2196
+
+  # openssl pkcs12 -in mycert.p12 -out client-cert.pem -nodes -clcerts
+  @pem = nil # this should be the contents of the pem file not the path
+  @pass = nil
+
+  @max_connection_age = 60 * 60 # 1 hour
+  @cache_connections = false
+  @connections = {}
+
+
+
+  class << self
+    attr_accessor :host, :port, :feedback_host, :feedback_port, :pem, :pass, :cache_connections, :max_connection_age
+  end
+
+  def self.establish_notification_connection
+    if @cache_connections
+      begin
+        self.get_connection(self.host, self.port, self.pem)
+        return true
+      rescue
+      end
+    end
+    return false
+  end
+
+  def self.has_notification_connection?
+    return self.has_connection?(self.host, self.port, self.pem)
+  end
+
+  def self.send_notification(device_token, message)
+    self.with_notification_connection do |conn|
+      conn.write(self.packaged_notification(device_token, message))
+      conn.flush
+    end
+  end
+  
+  def self.send_notifications(notifications)
+    self.with_notification_connection do |conn|
+      notifications.each do |n|
+        conn.write(self.packaged_notification(n[0], n[1]))
+      end
+      conn.flush
+    end
+  end
+  
+  def self.feedback
+    apns_feedback = []
+    self.with_feedback_connection do |conn|
+      # Read buffers data from the OS, so it's probably not
+      # too inefficient to do the small reads
+      while data = conn.read(38)
+        apns_feedback << self.parse_feedback_tuple(data)
+      end
+    end
+    
+    return apns_feedback
+  end
+
+  protected
+
+  # Each tuple is in the following format:
+  #
+  #              timestamp | token_length (32) | token
+  # bytes:  4 (big-endian)      2 (big-endian) | 32
+  #
+  # timestamp - seconds since the epoch, in UTC
+  # token_length - Always 32 for now
+  # token - 32 bytes of binary data specifying the device token
+  #
+  def self.parse_feedback_tuple(data)
+    feedback = data.unpack('N1n1H64')
+    {:feedback_at => Time.at(feedback[0]), :length => feedback[1], :device_token => feedback[2] }
+  end
+
+  def self.packaged_notification(device_token, message)
+    pt = self.packaged_token(device_token)
+    pm = self.packaged_message(message)
+    [0, 0, 32, pt, 0, pm.size, pm].pack("ccca*cca*")
+  end
+  
+  def self.packaged_token(device_token)
+    [device_token.gsub(/[\s|<|>]/,'')].pack('H*')
+  end
+  
+  def self.packaged_message(message)
+    if message.is_a?(Hash)
+      message.to_json
+    elsif message.is_a?(String)
+      '{"aps":{"alert":"'+ message + '"}}'
+    else
+      raise "Message needs to be either a hash or string"
+    end
+  end
+  
+  def self.with_notification_connection(&block)
+    self.with_connection(self.host, self.port, self.pem, &block)
+  end
+
+  def self.with_feedback_connection(&block)
+    # Explicitly disable the connection cache for feedback
+    cache_temp = @cache_connections
+    @cache_connections = false
+
+    self.with_connection(self.feedback_host, self.feedback_port, self.pem, &block)
+
+  ensure
+    @cache_connections = cache_temp
+  end
+ 
+  private
+
+  def self.open_connection(host, port, pem)
+    raise "The PEM data is not set" unless self.pem
+    
+    context      = OpenSSL::SSL::SSLContext.new
+    context.cert = OpenSSL::X509::Certificate.new(pem)
+    context.key  = OpenSSL::PKey::RSA.new(pem, self.pass)
+
+    retries = 0
+    begin
+      sock         = TCPSocket.new(host, port)
+      ssl          = OpenSSL::SSL::SSLSocket.new(sock, context)
+      ssl.connect
+      return ssl, sock
+    rescue SystemCallError
+      if (retries += 1) < 5
+        sleep 1
+        retry
+      else
+        # Too many retries, re-raise this exception
+        raise
+      end
+    end
+  end
+
+  def self.has_connection?(host, port, pem)
+    @connections.has_key?([host,port, pem])
+  end
+
+  def self.create_connection(host, port, pem)
+    ssl, sock = self.open_connection(host, port, pem)
+    @connections[[host, port, pem]] = [ssl, sock, Time.now]
+  end
+
+  def self.find_connection(host, port, pem)
+    @connections[[host, port, pem]]
+  end
+
+  def self.remove_connection(host, port, pem)
+    if self.has_connection?(host, port, pem)
+      ssl, sock = @connections.delete([host, port, pem])
+      ssl.close
+      sock.close
+    end
+  end
+
+  def self.reconnect_connection(host, port, pem)
+    self.remove_connection(host, port, pem)
+    self.create_connection(host, port, pem)
+  end
+
+  def self.get_connection(host, port, pem)
+    if @cache_connections
+      # Create a new connection if we don't have one
+      unless self.has_connection?(host, port, pem)
+        self.create_connection(host, port, pem)
+      end
+
+      ssl, sock, connection_opened_at = self.find_connection(host, port, pem)
+      # If we're closed, reconnect
+      if ssl.closed? || Time.now - connection_opened_at > @max_connection_age
+        self.reconnect_connection(host, port, pem)
+        self.find_connection(host, port, pem)
+      else
+        return [ssl, sock]
+      end
+    else
+      self.open_connection(host, port, pem)
+    end
+  end
+
+  def self.with_connection(host, port, pem, &block)
+    retries = 0
+    begin
+      ssl, sock = self.get_connection(host, port, pem)
+      yield ssl if block_given?
+
+      unless @cache_connections
+        ssl.close
+        sock.close
+      end
+    rescue Errno::ECONNABORTED, Errno::EPIPE, Errno::ECONNRESET
+      if (retries += 1) < 5
+        self.remove_connection(host, port, pem)
+        retry
+      else
+        # too-many retries, re-raise
+        raise
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: eq-apns
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Eric Mason
+- Paul Gebheim
+- James Pozdena
+autorequire: apns
+bindir: bin
+cert_chain: []
+
+date: 2013-02-21 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Simple Apple push notification service gem
+email: eric@equisolve.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MIT-LICENSE
+files: 
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- lib/apns/core.rb
+- lib/apns.rb
+has_rdoc: true
+homepage: http://github.com/ericmason/APNS
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Simple Apple push notification service gem
+test_files: []
+