ja-apns 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009 James Pozdena, 2013 Yuriy Kharchenko
+ 
+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,120 @@
+h1. APNS
+
+a gem for the Apple Push Notification Service.
+
+h2. Install
+
+sudo gem install ja-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>
+    sender = APNS::Sender.new({
+      # gateway.sandbox.push.apple.com is default
+      host: 'gateway.push.apple.com',
+      # this is the file you just created
+      pem: '/path/to/pem/file',
+      # this is also the default. Shouldn't ever have to set this, but just in case Apple goes crazy, you can.
+      port: 2195 
+    })
+  </code>
+</pre>
+
+h2. Example:
+
+You will need to create a notification class and provide the following instance methods: 
+<code>device_token</code>, <code>alert</code>, <code>badge</code>, <code>sound</code>, <code>other</code>, <code>valid?</code>
+
+<pre>
+  <code>
+    class MyNotification
+      def device_token
+        'your token'
+      end
+      alert
+        'Hello iPhone'
+      end
+      badge
+        1
+      end
+      sound
+        'default'
+      end
+      def other
+        {foo: 'bar'}
+      end
+      def valid?
+        true
+      end
+    end
+
+    sender = APNS::Sender.new
+
+    notification = MyNotification.new
+    
+    sender.send_notifications([notification])
+  </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,8 @@
+module APNS
+  require 'socket'
+  require 'openssl'
+  require 'json'
+
+  require 'apns/packager'
+  require 'apns/sender'
+end

data/lib/apns/packager.rb

@@ -0,0 +1,42 @@
+module APNS
+  class Packager
+
+    attr_reader :notification
+
+    def initialize(notification)
+      @notification = notification
+    end
+
+    def method_missing(meth, *args, &block)
+      if %w[device_token alert badge sound other].include?(meth.to_s)
+        notification.send(meth, *args, &block)
+      else
+        super
+      end
+    end
+
+    def package
+      [0, 0, 32, token, 0, message.bytesize, message].pack('ccca*cca*')
+    end
+
+    private
+
+    def token
+      @token ||= [device_token.gsub(/[\s|<|>]/,'')].pack('H*')
+    end
+
+    def message
+      @message ||= pack_message
+    end
+
+    def pack_message
+      aps = {'aps'=> {} }
+      aps['aps']['alert'] = alert if alert
+      aps['aps']['badge'] = badge if badge
+      aps['aps']['sound'] = sound if sound
+      aps.merge!(notification.other) if other
+      aps.to_json
+    end
+
+  end
+end

data/lib/apns/sender.rb

@@ -0,0 +1,44 @@
+module APNS
+  class Sender
+
+    attr_reader :host, :port, :pem, :pass
+
+    def initialize(params = {})
+      @host = params[:host] || 'gateway.sandbox.push.apple.com'
+      @port = params[:port] || 2195
+      @pem = params[:pem] || raise("Path to your pem file required!")
+      @pass = params[:pass]
+    end
+
+    def send_notifications(notifications)
+      packages = notifications.select(&:valid?).map { |n| Packager.new(n).package }
+      return if packages.none?
+      connection do |ssl|
+        packages.each { |package| ssl.write(package) }
+      end
+      true
+    end
+
+    private
+
+    def connection
+      raise "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
+
+      yield(ssl)
+
+      ssl.close
+      sock.close
+
+      true
+    end
+
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: ja-apns
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Yuriy Kharchenko
+- James Pozdena
+autorequire: apns
+bindir: bin
+cert_chain: []
+date: 2013-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple Apple push notification service gem
+email: yuri.kharchenko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- MIT-LICENSE
+files:
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- lib/apns/packager.rb
+- lib/apns/sender.rb
+- lib/apns.rb
+homepage: http://github.com/letmein/ja-apns
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Just another simple Apple push notification service gem
+test_files: []