apns 0.0.2

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,84 @@
+h1. APNS
+
+a gem for the Apple Push Notification Service.
+
+h2. Install
+
+gem sources -a http://gems.github.com
+    
+sudo gem install jpoz-apns
+
+
+h2. Setup:
+
+Set what host, port, pem file and password 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'
+    APNS.pass = 'secret'
+    # openssl pkcs12 -in cert.p12 -out cert.pem -nodes -clcerts
+    
+    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:
+
+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. 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>
+    - (BOOL)application:(UIApplication *)application 
+    didFinishLaunchingWithOptions:(NSDictionary *)launchOptions 
+    {
+    [[UIApplication sharedApplication] registerForRemoteNotificationTypes:(UIRemoteNotificationTypeAlert | UIRemoteNotificationTypeSound | UIRemoteNotificationTypeBadge)];
+    }
+    
+    - (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
+      NSLog(@"deviceToken: %@", deviceToken);
+    }
+  </code>
+</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.0.2'
+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 @@
+require 'apns/core'

data/lib/apns/core.rb

@@ -0,0 +1,68 @@
+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)
+    sock, ssl = self.open_connection
+    ssl.write(self.packaged_notification(device_token, message))
+
+    ssl.close
+    sock.close
+  end
+  
+  protected
+
+  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)
+      apns_from_hash(message)
+    elsif message.is_a?(String)
+      '{"aps":{"alert":"'+ message + '"}}'
+    else
+      raise "Message needs to be either a hash or string"
+    end
+  end
+  
+  def self.apns_from_hash(hash)
+    other = hash.delete(:other)
+    aps = {'aps'=> hash }
+    aps.merge(other) if other
+    JSON.generate(aps)
+  end
+  
+  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
+  
+end

data/lib/apns/notification.rb

@@ -0,0 +1,9 @@
+module APNS
+  class Notification
+    attr_accessor :device_token, :alert, :badge, :sound, :other
+    
+    def send_notification
+      APNS.send_notification(self.device_token, )
+    end
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: apns
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- James Pozdena
+autorequire: apns
+bindir: bin
+cert_chain: []
+
+date: 2009-07-09 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Simple Apple push notification service gem
+email: jpoz@jpoz.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MIT-LICENSE
+files: 
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- lib/apns/core.rb
+- lib/apns/notification.rb
+- lib/apns.rb
+has_rdoc: true
+homepage: http://github.com/jpoz/apns
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Simple Apple push notification service gem
+test_files: []
+