apns-lookout 1.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MWViOGY3NTUzZDRkNDJhZTllNTYyOGY5Nzc3YmY1MjQ0MjkxOWExNw==
+  data.tar.gz: !binary |-
+    M2JjZmM5NTVlMDYyYWI5MjllMGViZGI1ZTQwYzFhODEyNTJmMjE1Mw==
+SHA512:
+  metadata.gz: !binary |-
+    MjhiNTEyOThhZGZhZjUxNTc0ZGU1Yzc4MjZiMTkwMTQxMWMzNDMzMWQ2NGUz
+    MmQ2YWM3ZjM1ODFmMWQ4NDZjN2VjYzRiMWQxZTZhMjlhNmY2ZWViMDMyMDQz
+    NmRiMTYyZTYyN2M0ZGMwMTY0ZWYzMjRmYzc4MzMwYTViYzEyOGE=
+  data.tar.gz: !binary |-
+    YjgxMzA4MTVmYTc0MDlmNDA1NzlmNGVmZmZhNmJiOWJlNzEyMGZhYzljOTc0
+    MWQxNjNmZDJlOTY3YzZiZDk3M2RmZDI1YTQyNmIyZmYzYmI3N2M5NGNmNDVl
+    YTgzMWFlOWFmYjI4MDk0YzVlZmNjM2MwNmZkY2Q4NzYyZTE0NTE=

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,135 @@
+h1. APNS
+
+a gem for the Apple Push Notification Service.
+
+h2. Install
+
+sudo gem install 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. 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.
+
+h3. ApplicationAppDelegate.m
+
+<pre>
+  <code>
+    - (void)applicationDidFinishLaunching:(UIApplication *)application 
+    {    
+        // Register with apple that this app will use push notification
+        [[UIApplication sharedApplication] registerForRemoteNotificationTypes:(UIRemoteNotificationTypeAlert | 
+          UIRemoteNotificationTypeSound | UIRemoteNotificationTypeBadge)];
+
+        // Your app startup logic...
+        return YES;
+    }
+
+    - (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken 
+    {
+        // Convert the binary data token into an NSString (see below for the implementation of this function)
+        NSString *deviceTokenAsString = stringFromDeviceTokenData(deviceToken);
+
+        // Show the device token obtained from apple to the log
+        NSLog(@"deviceToken: %@", deviceTokenAsString);
+    }
+  </code>
+</pre>
+
+h3. stringFromDeviceTokenData function
+
+This snippet comes from "this stackoverflow post's anwser":http://stackoverflow.com/a/1990880/855846.
+<pre>
+  <code>
+    NSString* stringFromDeviceTokenData(NSData *deviceToken)
+    {
+      const char *data = [deviceToken bytes];
+      NSMutableString* token = [NSMutableString string];
+      
+      for (int i = 0; i < [deviceToken length]; i++) {
+        [token appendFormat:@"%02.2hhX", data[i]];
+      }
+      
+      return [[token copy] autorelease];
+    }
+  </code>
+</pre>
+
+For more information on Apple Push Notifications you can see Apple Developer Documentation "here":http://developer.apple.com/library/mac/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/IPhoneOSClientImp/IPhoneOSClientImp.html#//apple_ref/doc/uid/TP40008194-CH103-SW2.

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,2 @@
+require 'apns/core'
+require 'apns/notification'

data/lib/apns/core.rb

@@ -0,0 +1,98 @@
+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)
+    sock, ssl = self.open_connection
+
+    packed_nofications = self.packed_nofications(notifications)
+
+    notifications.each do |n|
+      ssl.write(packed_nofications)
+    end
+
+    ssl.close
+    sock.close
+  end
+
+  def self.packed_nofications(notifications)
+    bytes = ''
+
+    notifications.each do |notification|
+      # Each notification frame consists of
+      # 1. (e.g. protocol version) 2 (unsigned char [1 byte]) 
+      # 2. size of the full frame (unsigend int [4 byte], big endian)
+      pn = notification.packaged_notification
+      bytes << ([2, pn.bytesize].pack('CN') + pn)
+    end
+
+    bytes
+  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,69 @@
+module APNS
+  require 'openssl'
+
+  class Notification
+    attr_accessor :device_token, :alert, :badge, :sound, :other, :priority
+    attr_accessor :message_identifier, :expiration_date
+    attr_accessor :content_available
+    
+    def initialize(device_token, message)
+      self.device_token = device_token
+      if message.is_a?(Hash)
+        self.alert = message[:alert]
+        self.badge = message[:badge]
+        self.sound = message[:sound]
+        self.other = message[:other]
+        self.message_identifier = message[:message_identifier]
+        self.content_available = !message[:content_available].nil?
+        self.expiration_date = message[:expiration_date]
+        self.priority = if self.content_available
+          message[:priority] || 5
+        else
+          message[:priority] || 10
+        end
+      elsif message.is_a?(String)
+        self.alert = message
+      else
+        raise "Notification needs to have either a hash or string"
+      end
+
+      self.message_identifier ||= OpenSSL::Random.random_bytes(4)
+    end
+        
+    def packaged_notification
+      pt = self.packaged_token
+      pm = self.packaged_message
+      pi = self.message_identifier
+      pe = (self.expiration_date || 0).to_i
+      pr = (self.priority || 10).to_i
+
+      # Each item consist of
+      # 1. unsigned char [1 byte] is the item (type) number according to Apple's docs
+      # 2. short [big endian, 2 byte] is the size of this item
+      # 3. item data, depending on the type fixed or variable length
+      data = ''
+      data << [1, pt.bytesize, pt].pack("CnA*")
+      data << [2, pm.bytesize, pm].pack("CnA*")
+      data << [3, pi.bytesize, pi].pack("CnA*")
+      data << [4, 4, pe].pack("CnN")
+      data << [5, 1, pr].pack("CnC")
+      
+      data
+    end
+  
+    def packaged_token
+      [device_token.gsub(/[\s|<|>]/,'')].pack('H*')
+    end
+  
+    def packaged_message
+      aps = {'aps'=> {} }
+      aps['aps']['alert'] = self.alert if self.alert
+      aps['aps']['badge'] = self.badge if self.badge
+      aps['aps']['sound'] = self.sound if self.sound
+      aps['aps']['content-available'] = 1 if self.content_available
+
+      aps.merge!(self.other) if self.other
+      aps.to_json
+    end    
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: apns-lookout
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- James Pozdena
+- Thomas Kollbach
+- Susheel Daswani
+autorequire: apns
+bindir: bin
+cert_chain: []
+date: 2013-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'Simple Apple push notification service gem.
+
+  It supports the 3rd wire format (command 2) with support for content-availible (Newsstand),
+  expiration dates and delivery priority (background pushes)}
+
+'
+email:
+- jpoz@jpoz.net
+- thomas@kollba.ch
+executables: []
+extensions: []
+extra_rdoc_files:
+- MIT-LICENSE
+files:
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- lib/apns.rb
+- lib/apns/core.rb
+- lib/apns/notification.rb
+homepage: http://github.com/jpoz/apns
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Simple Apple push notification service gem for Lookout use
+test_files: []