ns-apple-push 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c645fa8a83f91369d9126fcc085be0486c4858b2
+  data.tar.gz: 8e9049bb60787b76067cbec4bb2d5262d84ab957
+SHA512:
+  metadata.gz: b50b7d4d453584e95d2970d9d6c1f7654b935f67578e09a60f3c5c7870b4e63b76c75e035588f2d5ef3572dd623b07addf92b0d3d111f783247bc51bc11903e7
+  data.tar.gz: e57c0023d7bd6be877a5b227eefdac2bfce99a932b2373792c85407ae13d26993a29f3cc465de9be6029710ca904921103a9d10be473f39d6abe3fd7f6744c7b

data/CHANGELOG

@@ -0,0 +1,8 @@
+
+*0.1*
+
+* First public release
+
+*1.0*
+
+* Added silent notification support

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010, 2011 Niklas Holmgren, Sutajio
+
+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.md

@@ -0,0 +1,45 @@
+ApplePush
+=========
+
+ApplePush is a very simple implementation of the APNS (Apple Push Notification
+Service) protocol. It differs from the
+[APNS gem](https://github.com/jpoz/APNS) by being able to push to different
+iOS apps from the same Ruby application.
+
+Setup
+-----
+
+    $ gem install apple-push
+
+    require 'apple-push'
+    ApplePush.host = 'gateway.push.apple.com' 
+    ApplePush.port = 2195
+
+Creating a PEM certificate
+--------------------------
+
+In Keychain access export your certificate as a p12. Then run the following command to convert it to a .pem
+
+    openssl pkcs12 -in cert.p12 -out cert.pem -nodes -clcerts
+
+Then store the PEM data in your database or in a file.
+
+Example usage
+-------------
+
+    ApplePush.send_notification(pem, device_token, 'Hello, world!')
+    ApplePush.send_notification(pem, device_token, :alert => 'Hello, world!', :badge => 1, :sound => 'default')
+    ApplePush.send_notification(pem, device_token, :alert => 'Hello, world!', :badge => 1, :sound => 'default', :other => { :foo => 'bar' })
+
+The `pem` parameter can either be the path to a .pem file or the PEM data it
+self, retrieved from a database for example. If the PEM certificate is
+encrypted with a password you should pass an array with the pem and the
+password instead of just the pem.
+
+The `device_token` can either be binary data, or Base64 encoded.
+
+Author
+------
+
+Created by Niklas Holmgren (niklas@sutajio.se) and released under
+the MIT license.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake/testtask'
+
+$LOAD_PATH.unshift 'lib'
+
+task :default => [:test]
+
+task :test do
+  Dir.glob('test/**/*_test.rb').each do |file|
+    require File.expand_path(file)
+  end
+end

data/certs/entrust_ssl_ca.cer

@@ -0,0 +1,28 @@
+-----BEGIN CERTIFICATE-----
+MIIE2DCCBEGgAwIBAgIEN0rSQzANBgkqhkiG9w0BAQUFADCBwzELMAkGA1UEBhMC
+VVMxFDASBgNVBAoTC0VudHJ1c3QubmV0MTswOQYDVQQLEzJ3d3cuZW50cnVzdC5u
+ZXQvQ1BTIGluY29ycC4gYnkgcmVmLiAobGltaXRzIGxpYWIuKTElMCMGA1UECxMc
+KGMpIDE5OTkgRW50cnVzdC5uZXQgTGltaXRlZDE6MDgGA1UEAxMxRW50cnVzdC5u
+ZXQgU2VjdXJlIFNlcnZlciBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTAeFw05OTA1
+MjUxNjA5NDBaFw0xOTA1MjUxNjM5NDBaMIHDMQswCQYDVQQGEwJVUzEUMBIGA1UE
+ChMLRW50cnVzdC5uZXQxOzA5BgNVBAsTMnd3dy5lbnRydXN0Lm5ldC9DUFMgaW5j
+b3JwLiBieSByZWYuIChsaW1pdHMgbGlhYi4pMSUwIwYDVQQLExwoYykgMTk5OSBF
+bnRydXN0Lm5ldCBMaW1pdGVkMTowOAYDVQQDEzFFbnRydXN0Lm5ldCBTZWN1cmUg
+U2VydmVyIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MIGdMA0GCSqGSIb3DQEBAQUA
+A4GLADCBhwKBgQDNKIM0VBuJ8w+vN5Ex/68xYMmo6LIQaO2f55M28Qpku0f1BBc/
+I0dNxScZgSYMVHINiC3ZH5oSn7yzcdOAGT9HZnuMNSjSuQrfJNqc1lB5gXpa0zf3
+wkrYKZImZNHkmGw6AIr1NJtl+O3jEP/9uElY3KDegjlrgbEWGWG5VLbmQwIBA6OC
+AdcwggHTMBEGCWCGSAGG+EIBAQQEAwIABzCCARkGA1UdHwSCARAwggEMMIHeoIHb
+oIHYpIHVMIHSMQswCQYDVQQGEwJVUzEUMBIGA1UEChMLRW50cnVzdC5uZXQxOzA5
+BgNVBAsTMnd3dy5lbnRydXN0Lm5ldC9DUFMgaW5jb3JwLiBieSByZWYuIChsaW1p
+dHMgbGlhYi4pMSUwIwYDVQQLExwoYykgMTk5OSBFbnRydXN0Lm5ldCBMaW1pdGVk
+MTowOAYDVQQDEzFFbnRydXN0Lm5ldCBTZWN1cmUgU2VydmVyIENlcnRpZmljYXRp
+b24gQXV0aG9yaXR5MQ0wCwYDVQQDEwRDUkwxMCmgJ6AlhiNodHRwOi8vd3d3LmVu
+dHJ1c3QubmV0L0NSTC9uZXQxLmNybDArBgNVHRAEJDAigA8xOTk5MDUyNTE2MDk0
+MFqBDzIwMTkwNTI1MTYwOTQwWjALBgNVHQ8EBAMCAQYwHwYDVR0jBBgwFoAU8Bdi
+E1U9s/8KAGv7UISX8+1i0BowHQYDVR0OBBYEFPAXYhNVPbP/CgBr+1CEl/PtYtAa
+MAwGA1UdEwQFMAMBAf8wGQYJKoZIhvZ9B0EABAwwChsEVjQuMAMCBJAwDQYJKoZI
+hvcNAQEFBQADgYEAkNwwAvpkdMKnCqV8IY00F6j7Rw7/JXyNEwr75Ji174z4xRAN
+95K+8cPV1ZVqBLssziY2ZcgxxufuP+NXdYR6Ee9GTxj005i7qIcyunL2POI9n9cd
+2cNgQ4xYDiKWL2KjLB+6rQXvqzJ4h6BUcxm1XAX5Uj5tLUUL9wqT6u0G+bI=
+-----END CERTIFICATE-----

data/lib/apple-push.rb

@@ -0,0 +1,63 @@
+require 'base64'
+require 'openssl'
+require 'socket'
+require 'json'
+
+require 'apple-push/version'
+require 'apple-push/notification'
+
+module ApplePush
+
+  @host = 'gateway.sandbox.push.apple.com'
+  @port = 2195
+
+  class<<self
+    attr_accessor :host
+    attr_accessor :port
+  end
+
+  def self.send_notification(apns_pem, apns_token, message = {})
+    connection(apns_pem) do |ssl|
+      notification = ApplePush::Notification.new(apns_token, message)
+      puts "#{Time.now} [#{host}:#{port}] Device: #{notification.device_token.unpack('H*')} sending #{message.inspect}"
+      ssl.write(notification.to_s)
+    end
+  end
+
+protected
+
+  def self.connection(apns_pem, &block)
+    sock         = TCPSocket.new(host.to_s, port.to_i)
+    ssl          = OpenSSL::SSL::SSLSocket.new(sock, security_context(apns_pem))
+    ssl.connect
+
+    yield(ssl)
+
+    ssl.close
+    sock.close
+
+    return true
+  end
+
+  def self.security_context(apns_pem)
+    pem, password = self.pem_and_password(apns_pem)
+    context      = OpenSSL::SSL::SSLContext.new
+    context.cert = OpenSSL::X509::Certificate.new(pem)
+    context.key  = OpenSSL::PKey::RSA.new(pem, password)
+    context.ca_file = File.expand_path(File.join(File.dirname(__FILE__),'../certs/entrust_ssl_ca.cer'))
+    context
+  end
+
+  def self.pem_and_password(apns_pem)
+    if apns_pem.is_a?(Array)
+      return self.read_pem(apns_pem.first), apns_pem.last
+    else
+      return self.read_pem(apns_pem), nil
+    end
+  end
+
+  def self.read_pem(file_or_string)
+    File.exist?(file_or_string) ? File.read(file_or_string) : file_or_string
+  end
+
+end

data/lib/apple-push/notification.rb

@@ -0,0 +1,51 @@
+module ApplePush
+  class Notification
+    attr_accessor :device_token, :alert, :badge, :sound, :other, :content_available
+
+    def initialize(device_token, message)
+      if device_token
+        self.device_token = device_token
+      else
+        raise "Invalid device token"
+      end
+      if message.is_a?(Hash)
+        self.alert = message[:alert]
+        self.badge = message[:badge]
+        self.sound = message[:sound]
+        self.other = message[:other]
+        self.content_available = message[:content_available]
+      elsif message.is_a?(String)
+        self.alert = message
+      else
+        raise "Notification message needs to be either a hash or a string"
+      end
+    end
+
+    def device_token
+      if @device_token =~ /=$/
+        Base64.decode64(@device_token)
+      else
+        @device_token
+      end
+    end
+
+    def to_s
+      dt = self.device_token
+      pl = self.payload
+      [0, 0, dt.size, dt, 0, pl.size, pl].pack("ccca*cca*")
+    end
+
+  protected
+
+    def payload
+      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'] = self.content_available if self.content_available
+      aps.merge!(self.other) if self.other
+      aps.to_json
+    end
+    
+  end
+end

data/lib/apple-push/version.rb

@@ -0,0 +1,3 @@
+module ApplePush
+  Version = VERSION = '1.0.0'
+end

data/test/apple_push_test.rb

@@ -0,0 +1,28 @@
+require File.expand_path('test/test_helper')
+
+class ApplePushTest < Test::Unit::TestCase
+
+  def test_can_push_notification
+    pem = File.read('test/cert.pem')
+    device_token = 'gM/RJodgEmAI////WGWMs/QjbFq05pyQ8hCVsTTDeiI='
+    assert ApplePush.send_notification(pem, device_token, 'Hello, world!')
+    assert ApplePush.send_notification(pem, device_token, :alert => 'Hello, world!', :badge => 1)
+  end
+
+  def test_can_create_security_context_from_file
+    assert ApplePush.security_context('test/cert.pem')
+  end
+
+  def test_can_create_security_context_from_string
+    assert ApplePush.security_context(File.read('test/cert.pem'))
+  end
+
+  def test_can_create_security_context_from_file_with_password
+    assert ApplePush.security_context(['test/cert_secure.pem', '123456'])
+  end
+
+  def test_can_create_security_context_from_string_with_password
+    assert ApplePush.security_context([File.read('test/cert_secure.pem'), '123456'])
+  end
+
+end

data/test/notification_test.rb

@@ -0,0 +1,45 @@
+require File.expand_path('test/test_helper')
+
+class NotificationTest < Test::Unit::TestCase
+
+  def setup
+    @notification = ApplePush::Notification.new('FkjWc8HztEiEblJ7g1n8AKw8kvyCtkQKc10tmoo2Tak=',
+      :alert => 'Hello, world!', :badge => 1, :sound => 'default', :other => { :foo => 'bar' })
+  end
+
+  def test_raises_errors
+    assert_raises RuntimeError do
+      ApplePush::Notification.new(nil, 'Hello, world!')
+    end
+    assert_raises RuntimeError do
+      ApplePush::Notification.new('...', nil)
+    end
+  end
+
+  def test_can_create_notification_with_only_an_alert_string
+    assert_equal 'Hello, world!', ApplePush::Notification.new('...', 'Hello, world!').alert
+  end
+
+  def test_can_handle_base64_encoded_device_token
+    @notification.device_token = 'FkjWc8HztEiEblJ7g1n8AKw8kvyCtkQKc10tmoo2Tak='
+    assert_equal Base64.decode64('FkjWc8HztEiEblJ7g1n8AKw8kvyCtkQKc10tmoo2Tak='), @notification.device_token
+  end
+
+  def test_can_handle_binary_device_token
+    @notification.device_token = Base64.decode64('FkjWc8HztEiEblJ7g1n8AKw8kvyCtkQKc10tmoo2Tak=')
+    assert_equal Base64.decode64('FkjWc8HztEiEblJ7g1n8AKw8kvyCtkQKc10tmoo2Tak='), @notification.device_token
+  end
+
+  def test_payload
+    payload = JSON.parse(@notification.send(:payload))
+    assert_equal 'Hello, world!', payload['aps']['alert']
+    assert_equal 1, payload['aps']['badge']
+    assert_equal 'default', payload['aps']['sound']
+    assert_equal 'bar', payload['foo']
+  end
+
+  def test_packaged_notification
+    assert_equal "\x00\x00 \x16H\xD6s\xC1\xF3\xB4H\x84nR{\x83Y\xFC\x00\xAC<\x92\xFC\x82\xB6D\ns]-\x9A\x8A6M\xA9\x00I{\"aps\":{\"alert\":\"Hello, world!\",\"badge\":1,\"sound\":\"default\"},\"foo\":\"bar\"}", @notification.to_s
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+
+dir = File.dirname(File.expand_path(__FILE__))
+$LOAD_PATH.unshift dir + '/../lib'
+
+require 'test/unit'
+require 'apple-push'

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: ns-apple-push
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Niklas Holmgren
+- Matt Price
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: ApplePush is a very simple implementation of the APNS (Apple Push Notification
+  Service) protocol. It differs from the APNS gem by being able to push to different
+  iOS apps from the same Ruby application.
+email:
+- niklas@sutajio.se
+- matt@netsanity.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- CHANGELOG
+- LICENSE
+- README.md
+- Rakefile
+- certs/entrust_ssl_ca.cer
+- lib/apple-push.rb
+- lib/apple-push/notification.rb
+- lib/apple-push/version.rb
+- test/apple_push_test.rb
+- test/notification_test.rb
+- test/test_helper.rb
+homepage: http://github.com/sutajio/apple-push/
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+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.6.14
+signing_key: 
+specification_version: 4
+summary: ApplePush is a very simple implementation of the APNS (Apple Push Notification
+  Service) protocol
+test_files: []