apns-p 1.0.0.pre

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+pkg
+temp
+Gemfile.lock
+.rvmrc

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in apns.gemspec
+gemspec
+

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009 James Pozdena
+ 
+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,132 @@
+h1. APNS-P
+
+A gem for the Apple Push Notification Service. Now with Passbook notification support.
+
+h2. Install
+
+h3. Terminal
+
+sudo gem install apns
+
+h3. Bundler
+
+gem "apns-p"
+
+h2. Use
+
+require "apns"
+
+h2. Setup:
+
+Convert your certificate
+
+In Keychain access export your certificate as a p12. Then run the following command to convert it to a .pem
+
+<pre>
+  <code>
+    openssl pkcs12 -in cert.p12 -out cert.pem -nodes -clcerts
+  </code>
+</pre>
+
+After you have your .pem file. Set what host, port, certificate file location on the APNS class:
+
+<pre>
+  <code>
+    APNS.host = 'gateway.push.apple.com'
+    # gateway.sandbox.push.apple.com is default
+
+    APNS.pem  = '/path/to/pem/file'
+    # this is the file you just created
+
+    APNS.port = 2195
+    # this is also the default. Shouldn't ever have to set this, but just in case Apple goes crazy, you can.
+  </code>
+</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>
+  <code>
+    device_token = '123abc456def'
+
+    APNS.send_notification(device_token, 'Hello iPhone!' )
+
+    APNS.send_notification(device_token, :alert => 'Hello iPhone!', :badge => 1, :sound => 'default')
+  </code>
+</pre>
+
+h2. Example (Multiple notifications):
+
+You can also send multiple notifications using the same connection to Apple:
+
+<pre>
+  <code>
+    device_token = '123abc456def'
+
+    n1 = APNS::Notification.new(device_token, 'Hello iPhone!' )
+
+    n2 = APNS::Notification.new(device_token, :alert => 'Hello iPhone!', :badge => 1, :sound => 'default')
+
+    APNS.send_notifications([n1, n2])
+  </code>
+</pre>
+
+h2. Example (Passbook notifications):
+
+These notifications are signed with the Passbook cert, thus passing along the PassTypeId
+
+<pre>
+  <code>
+    device_token = '123abc456def'
+
+    device_token2 = 'abc123def456'
+
+    n1 = APNS::Notification.new(device_token)
+
+    n2 = APNS::Notification.new(device_token2)
+
+    APNS.send_notifications([n1, n2])
+  </code>
+</pre>
+
+h2. Send other info along with aps
+
+You can send other application specific information as well.
+
+<pre>
+  <code>
+    APNS.send_notification(device_token, :alert => 'Hello iPhone!', :badge => 1, :sound => 'default',
+                                         :other => {:sent => 'with apns gem'})
+  </code>
+</pre>
+
+This will add the other hash to the same level as the aps hash:
+
+<pre>
+  <code>
+    {"aps":{"alert":"Hello iPhone!","badge":1,"sound":"default"},"sent":"with apns gem"}
+  </code>
+</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>
+  <code>
+    - (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);
+    }
+  </code>
+</pre>

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/apns.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'apns/version'
+
+SUMMARY = "Simple Apple push notification service gem with Passbook support"
+DESCRIPTION =<<DESC
+A simple Apple push notification service gem with Passbook support. Send
+an empty payload on an Apple Push Notification using the Passbook cert
+to trigger a pull from the Passbook.
+DESC
+
+Gem::Specification.new do |gem|
+  gem.name             = "apns-p"
+  gem.version          = APNS::VERSION
+  gem.authors          = ["Keith Swallow"]
+  gem.email            = ["keithcelt@gmail.com"]
+  gem.date             = "2012-12-03"
+  gem.platform         = Gem::Platform::RUBY
+  gem.summary          = SUMMARY
+  gem.description      = DESCRIPTION
+  gem.homepage         = "http://github.com/keithcelt/apns-p"
+
+  gem.files            = `git ls-files`.split($/)
+  gem.test_files       = gem.files.grep(%r{^spec/})
+  gem.extra_rdoc_files = ["MIT-LICENSE"]
+  gem.require_paths    = ["lib"]
+
+  gem.add_runtime_dependency 'json'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
+end

data/lib/apns.rb

@@ -0,0 +1,3 @@
+require "apns/core"
+require "apns/notification"
+require "apns/version"

data/lib/apns/core.rb

@@ -0,0 +1,84 @@
+module APNS
+  require 'socket'
+  require 'openssl'
+  require 'json'
+
+  @host = 'gateway.sandbox.push.apple.com'
+  @port = 2195
+  # openssl pkcs12 -in mycert.p12 -out client-cert.pem -nodes -clcerts
+  @pem = nil # this should be the path of the pem file not the contentes
+  @pass = nil
+
+  class << self
+    attr_accessor :host, :pem, :port, :pass
+  end
+
+  def self.send_notification(device_token, message)
+    n = APNS::Notification.new(device_token, message)
+    self.send_notifications([n])
+  end
+
+  def self.send_notifications(notifications)
+    return unless notifications
+    sock, ssl = self.open_connection
+
+    notifications.each do |n|
+      ssl.write(n.packed)
+    end
+
+    ssl.close
+    sock.close
+  end
+
+  def self.feedback
+    sock, ssl = self.feedback_connection
+
+    apns_feedback = []
+
+    while message = ssl.read(38)
+      timestamp, token_size, token = message.unpack('N1n1H*')
+      apns_feedback << [Time.at(timestamp), token]
+    end
+
+    ssl.close
+    sock.close
+
+    return apns_feedback
+  end
+
+  protected
+
+  def self.open_connection
+    raise "The path to your pem file is not set. (APNS.pem = /path/to/cert.pem)" unless self.pem
+    raise "The path to your pem file does not exist!" unless File.exist?(self.pem)
+
+    context      = OpenSSL::SSL::SSLContext.new
+    context.cert = OpenSSL::X509::Certificate.new(File.read(self.pem))
+    context.key  = OpenSSL::PKey::RSA.new(File.read(self.pem), self.pass)
+
+    sock         = TCPSocket.new(self.host, self.port)
+    ssl          = OpenSSL::SSL::SSLSocket.new(sock,context)
+    ssl.connect
+
+    return sock, ssl
+  end
+
+  def self.feedback_connection
+    raise "The path to your pem file is not set. (APNS.pem = /path/to/cert.pem)" unless self.pem
+    raise "The path to your pem file does not exist!" unless File.exist?(self.pem)
+
+    context      = OpenSSL::SSL::SSLContext.new
+    context.cert = OpenSSL::X509::Certificate.new(File.read(self.pem))
+    context.key  = OpenSSL::PKey::RSA.new(File.read(self.pem), self.pass)
+
+    fhost = self.host.gsub('gateway','feedback')
+    puts fhost
+
+    sock         = TCPSocket.new(fhost, 2196)
+    ssl          = OpenSSL::SSL::SSLSocket.new(sock,context)
+    ssl.connect
+
+    return sock, ssl
+  end
+
+end

data/lib/apns/notification.rb

@@ -0,0 +1,37 @@
+module APNS
+  class Notification
+
+    attr_accessor :device_token, :alert, :badge, :sound, :other
+
+    def initialize(device_token, message=nil)
+      @device_token = device_token
+      if message.is_a?(Hash)
+        @alert = message[:alert]
+        @badge = message[:badge]
+        @sound = message[:sound]
+        @other = message[:other]
+      elsif message.is_a?(String)
+        @alert = message
+      end
+    end
+
+    def packed
+      [0, 0, 32, packed_token, 0, json_message.bytesize,
+       json_message].pack("ccca*cca*")
+    end
+
+    def packed_token
+      [device_token.gsub(/[\s|<|>]/,'')].pack('H*')
+    end
+
+    def json_message
+      return "{}" unless (alert || badge || sound)
+      aps = {'aps'=> {} }
+      aps['aps']['alert'] = alert if alert
+      aps['aps']['badge'] = badge if badge
+      aps['aps']['sound'] = sound if sound
+      aps.merge!(other) if other
+      aps.to_json
+    end
+  end
+end

data/lib/apns/version.rb

@@ -0,0 +1,3 @@
+module APNS
+  VERSION = "1.0.0.pre"
+end

data/spec/apns/notification_spec.rb

@@ -0,0 +1,49 @@
+require"spec_helper"
+
+describe APNS::Notification do
+
+  it "allows a nil message" do
+    lambda {
+      APNS::Notification.new("device_token")
+    }.should_not raise_error
+  end
+
+  it "takes a string as the message" do
+    n = APNS::Notification.new("device_token", "Hello")
+    n.alert.should == "Hello"
+  end
+
+  it "takes a hash as the message" do
+    n = APNS::Notification.new("device_token", {:alert => "Hello iPhone", :badge => 3})
+    n.alert.should == "Hello iPhone"
+    n.badge.should == 3
+  end
+
+  describe "#json_message" do
+
+    it "allows an empty payload" do
+      n = APNS::Notification.new("device_token")
+      n.json_message.should == "{}"
+    end
+
+    it "returns JSON with notification information" do
+      n = APNS::Notification.new("device_token", {:alert => "Hello iPhone", :badge => 3, :sound => "awesome.caf"})
+      n.json_message.should include "alert\":\"Hello iPhone"
+      n.json_message.should include "badge\":3"
+      n.json_message.should include "sound\":\"awesome.caf"
+    end
+
+    it "omits keys that are empty in the JSON" do
+      n = APNS::Notification.new("device_token", {:badge => 3})
+      n.json_message.should == "{\"aps\":{\"badge\":3}}"
+    end
+
+  end
+
+  describe "#package_token" do
+    it "packages the token" do
+      n = APNS::Notification.new("<5b51030d d5bad758 fbad5004 bad35c31 e4e0f550 f77f20d4 f737bf8d 3d5524c6>", "a")
+      Base64.encode64(n.packed_token).should == "W1EDDdW611j7rVAEutNcMeTg9VD3fyDU9ze/jT1VJMY=\n"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "rubygems"
+gem "rspec"
+require "rspec"
+require File.join(File.dirname(__FILE__), "..", "lib", "apns")
+require "base64"
+require "apns"

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: apns-p
+version: !ruby/object:Gem::Version 
+  hash: 1692402070
+  prerelease: 6
+  segments: 
+  - 1
+  - 0
+  - 0
+  - pre
+  version: 1.0.0.pre
+platform: ruby
+authors: 
+- Keith Swallow
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-12-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  requirement: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  requirement: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  name: rake
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  requirement: *id003
+  prerelease: false
+description: |
+  A simple Apple push notification service gem with Passbook support. Send
+  an empty payload on an Apple Push Notification using the Passbook cert
+  to trigger a pull from the Passbook.
+
+email: 
+- keithcelt@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MIT-LICENSE
+files: 
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- apns.gemspec
+- lib/apns.rb
+- lib/apns/core.rb
+- lib/apns/notification.rb
+- lib/apns/version.rb
+- spec/apns/notification_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/keithcelt/apns-p
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      hash: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple Apple push notification service gem with Passbook support
+test_files: 
+- spec/apns/notification_spec.rb
+- spec/spec_helper.rb