adck 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+pkg

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    adck (0.1.0)
+      multi_json
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    multi_json (1.3.6)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  adck!
+  rspec (~> 2.8.0)

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Tal Atlas
+
+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,149 @@
+# ADCK
+
+a gem for the Apple Push Notification Service (APNS).
+
+Based on the [APNS](https://github.com/jpoz/apns) gem by [James Pozdena](https://github.com/jpoz) \<<jpoz@jpoz.net>>
+
+## Install
+
+    gem install adck
+
+or in your Gemfile:
+
+    gem 'adck'
+
+## Setup
+
+You need to have your certificate in the form aof a .pem. If you have yours as a p12 you can run this to convert it:
+
+	openssl pkcs12 -in cert.p12 -out cert.pem -nodes -clcerts
+
+### Defaults
+
+You can set the defaults for all connections created by setting them on the `ADCK` object.
+
+	ADCK.host = 'gateway.push.apple.com'
+	ADCK.pem  = '/path/to/pem/file'
+	ADCK.port = 2195 # default, doesn't need to be set
+
+## Examples
+
+### Quick send one notification
+
+	device_token = '123abc456def'
+	
+	ADCK(device_token, 'POPUP!')
+
+is equivalent to
+
+	ADCK.send_notification(device_token, 'POPUP!')
+
+also the same
+
+	ADCK.send_notification(device_token, body: 'POPUP!')
+	
+All of these quick sendings use the default server values and open and close the connection for each notification.
+
+### Multiple notifications
+
+Behind the scenes on the single notifications it creates a notification object
+
+	n1 = ADCK::Notification.new(device_token, 'POPUP!)
+
+`Notification` is a combination of a `Message` and a device token.
+
+The `Message` creates the payload which is sent to the iPhone.
+
+To send many messages quickly
+
+	n2 = ADCK::Notification.new(device_token, 'POPUP2!)
+	
+	ADCK.send_notifications([n1,n2])
+
+or you can
+
+	ADCK([n1,n2])
+
+#### Message
+
+A message is just the payload seperated withouat an identifier to send it to the phone. It can take all the options that Apple supports:
+
+* `alert` - The actual message being sent
+* `badge` - The number to set the badge count to
+* `sound` - Sound to play for notification
+
+The alert property is special and allows for other fields, in place of alert you can pass:
+
+* `body` - the text to display
+* `action_loc_key` - Localized key for what to set the action button on the notification to
+* `loc_key` - localized message key, in place of the body you can pass the key from one of your localized plists
+* `loc_args` - if you pass a loc_key you must pass an array to loc_args for what values to fill into the localized arry
+* `launch_image` - the image to display while launching instead of the default one
+
+For more details on how these values work plase refer to [Apple's Documentation](http://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/ApplePushService/ApplePushService.html)
+
+#### Creating a message
+
+Messages are passed all the way though so in the previous example where we ran `ADCK(token, 'POPUP!')` it at some point ran `Message.new(body: 'POPUP!')`.
+
+Here are some examples of messages:
+
+	ADCK::Message.new(body: 'This is what the user sees')
+	
+Now lets add a sound and a badge count:
+	
+	ADCK::Message.new(body: 'This is what the user sees', sound: 'default', badge: 5)
+	
+What if we don't want to show an action button, just want to pop up a notification with an "OK" button.
+
+	ADCK::Message.new(body: 'Something you cant do anything about', action_loc_key: nil)
+
+#### Sending one message to many people
+
+The most performant way to send the same message to a lot of people is to make a message and then pass it an array of tokens to send to.
+
+	m = ADCK::Message.new(body: 'Cute Kitty!', action_loc_key: "PET_IT")
+	m.send_to([token1,token2,…,tokenN])
+
+This will open and close a new connection to the server. If you want to use an existing connection you can set it on the message
+
+	conn = ADCK::Connection.new
+	m.connection = conn
+	
+	conn.open
+	m.send_to([token1,token2,…,tokenN])
+	m.send_to([token1,token2,…,tokenN])
+	conn.close
+
+
+There's one caviat, the message is compiled and frozen upon sending to improve performance. This is primarily an issue when sending badge numbers. I'm working on creating a performant way to send out large numbers of badge updates.
+
+	m = ADCK::Message.new(body: 'Cute Kitty!', action_loc_key: "PET_IT")
+	m.send_to([token1,token2,…,tokenN])
+	m.body = 'Cute Kitty2' #=> RuntimeError: can't modify frozen ADCK::Message
+
+You can however dupe
+	
+	m = m.dup
+	m.body = 'Cute Kitty2'
+	m.send_to([token1,token2,…,tokenN])
+	
+or you can tell the message to not freeze it
+
+	m = ADCK::Message.new(body: 'Cute Kitty!', action_loc_key: "PET_IT", freeze: false)
+	m.send_to([token1,token2,…,tokenN])
+	m.body = 'Cute Kitty2'
+	m.send_to([token1,token2,…,tokenN])
+
+### Connection
+
+A good example of when you'd want to use multiple connections is if you have different `.pem` files (for different apps maybe) that you want to use.
+
+	conn_iphone = ADCK::Connection.new(pem: Rails.root+'config/pem/iphone.pem')
+	conn_ipad = ADCK::Connection.new(pem: Rails.root+'config/pem/ipad.pem')
+	
+	n = ADCK::Notification.new(token, "Sent to both iPhone and iPad apps")
+	n2 = ADCK::Notification.new(token2, "Sent to iPad app")
+	
+	conn_iphone.send_notification(n)
+	conn_ipad.send_notifications([n,n2])

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/adck.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/adck/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Tal Atlas"]
+  gem.email         = ["me@tal.by"]
+  gem.description   = <<-EOF
+    Simple Apple push notification service gem
+
+    Based on the APNS gem by James Pozdena <jpoz@jpoz.net> http://github.com/jpoz/apns
+  EOF
+  gem.summary       = %q{Simple Apple push notification service gem}
+  gem.homepage      = "https://github.com/delight-labs/ADCK"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "adck"
+  gem.require_paths = ["lib"]
+  gem.version       = ADCK::VERSION
+
+  gem.add_dependency('multi_json')
+
+  gem.add_development_dependency("rspec", ["~> 2.8.0"])
+end

data/lib/adck/connection.rb

@@ -0,0 +1,78 @@
+module ADCK
+  class Connection
+    def initialize(opts={})
+      @host = opts[:host]||ADCK.host
+      @port = opts[:port]||ADCK.port
+      @pem  = opts[:pem] ||ADCK.pem
+      @pass = opts[:pass]||ADCK.pass
+
+      raise "The path to your pem file is not set. (ADCK.pem = /path/to/cert.pem)" unless @pem
+      raise "The path to your pem file does not exist!" unless File.exist?(@pem)
+
+      @context      = OpenSSL::SSL::SSLContext.new
+      @context.cert = OpenSSL::X509::Certificate.new(File.read(@pem))
+      @context.key  = OpenSSL::PKey::RSA.new(File.read(@pem), @pass)
+    end
+
+    def sock
+      @sock ||= TCPSocket.new(@host, @port)
+    end
+
+    def ssl
+      @ssl ||= begin
+        ssl = OpenSSL::SSL::SSLSocket.new(sock,@context)
+        ssl.connect
+      end
+    end
+
+    def close
+      sock.close if @sock
+      ssl.close if @ssl
+      @sock = nil
+      @ssl = nil
+    end
+
+    def open
+      is_open = open?
+
+      _sock, _ssl = sock, ssl
+
+      yield(sock,ssl) if block_given?
+
+      if !is_open && block_given?
+        close
+      end
+
+      return _sock, _ssl
+    end
+
+    def open?
+      !!(@sock || @ssl)
+    end
+
+    def send_notification token, message=nil
+      if token.is_a?(Notification)
+        n = token
+      else
+        n = Notification.new(token,message)
+      end
+
+      send_notifications([n])
+    end
+
+    def send_notifications msgs
+      open do |sock,ssl|
+        msgs.each do |n|
+          ssl.write(n.packaged_notification)
+        end
+      end
+    end
+
+    class << self
+      def feedback(opts={})
+        opts[:host] ||= ADCK.host.sub('gateway','feedback')
+        new(opts)
+      end
+    end
+  end
+end

data/lib/adck/message.rb

@@ -0,0 +1,152 @@
+module ADCK
+  class Message
+    ALERT_FIELDS = [
+      :body, :action_loc_key, :loc_key, :loc_args, :launch_image
+    ]
+    FIELDS = ALERT_FIELDS+[
+      :alert, :badge, :sound, :other
+    ]
+    attr_accessor *FIELDS
+    attr_accessor :connection
+
+    def initialize(message)
+      if message.is_a? Hash
+        @validate = message[:validate]
+        @freeze = message[:freeze]
+      end
+
+      set_values_from_arg(message)
+
+      self.other ||= {}
+    end
+
+    def alert
+      a = {}
+
+      a[:body] = body if body
+
+      if action_loc_key # is not false or nil
+        a[:'action-loc-key'] = action_loc_key
+      elsif action_loc_key == false
+        a[:'action-loc-key'] = nil
+      end
+
+      a[:'loc-key'] = loc_key unless loc_key.nil?
+      a[:'loc-args'] = loc_args unless loc_args.nil?
+      a[:'launch-image'] = launch_image unless launch_image.nil?
+
+      a
+    end
+
+    def alert=val
+      set_values_from_arg val, ALERT_FIELDS
+    end
+
+    def action_loc_key=val
+      # A nil action-loc-key is significant so set to false for later
+      # detection
+      @action_loc_key = val.nil? ? false : val
+    end
+
+    def aps
+      a = {}
+      _alert = alert
+      a[:alert] = _alert unless _alert.empty?
+      a[:badge] = badge if badge
+      a[:sound] = sound if sound
+      a
+    end
+
+    def payload(options={})
+      other.merge(aps: aps)
+    end
+    alias as_json payload
+
+    def validate!
+      return to_json if @validate == false
+
+      if loc_args && !loc_args.is_a?(Array)
+        raise InvalidAttribute, 'loc-args should be an array'
+      end
+
+      if body && !body.is_a?(String)
+        raise InvalidAttribute, 'body needs to be a string'
+      end
+
+      if action_loc_key && (action_loc_key != false || !action_loc_key.is_a?(String))
+        raise InvalidAttribute, 'action-loc-key needs to be set to false/nil/string'
+      end
+
+      if badge && !badge.is_a?(Integer)
+        raise InvalidAttribute, 'badge needs to be a number or nil'
+      end
+
+      json = to_json
+
+      if json.bytesize > 255
+        raise PayloadTooLarge, "Payload must be less than 256 bytes, is #{json.bytesize}bytes"
+      end
+
+      json
+    end
+
+    def bytesize
+      @package ? @package.bytesize : to_json.bytesize
+    end
+
+    def to_json(options={})
+      MultiJson.dump(payload(options))
+    end
+
+    def package
+      if @freeze == false
+        validate!
+      else
+        unless @package
+          @package = validate!
+          freeze
+        end
+        @package
+      end
+    end
+
+    def self.build(opts)
+      opts.is_a?(self) ? opts : new(opts)
+    end
+
+    def send_to(device_tokens)
+      conn = connection || Connection.new
+
+      notifications = Array(device_tokens).collect do |token|
+        Notification.new(token,self)
+      end
+
+      conn.send_notifications(notifications)
+    end
+
+    def dup
+      m = super()
+      m.instance_variable_set :@package, nil
+      m
+    end
+
+  private
+
+    def set_values_from_arg val, fields=nil
+      if val.is_a?(String)
+        self.body = val
+      elsif val.is_a?(Hash)
+        (fields || FIELDS).each do |key|
+          if val.has_key?(key)
+            send("#{key}=",val[key])
+          end
+        end
+      else
+        raise "Message needs to have either a hash or string"
+      end
+    end
+
+    class PayloadTooLarge < RuntimeError; end
+    class InvalidAttribute < RuntimeError; end
+  end
+end

data/lib/adck/notification.rb

@@ -0,0 +1,27 @@
+module ADCK
+  class Notification
+    extend Forwardable
+    attr_accessor :device_token, :message
+    def_delegators :message, :alert, :badge, :sound, :other, :as_json
+
+    def initialize(device_token, message)
+      self.device_token = device_token
+      self.message = Message.build(message)
+    end
+
+    def packaged_notification
+      pt = packaged_token
+      pm = message.package
+      [0, 0, 32, pt, 0, pm.bytesize, pm].pack("ccca*cca*")
+    end
+
+    def packaged_token
+      [device_token.gsub(/[\s|<|>]/,'')].pack('H*')
+    end
+
+    def packaged_message
+      message.package
+    end
+
+  end
+end

data/lib/adck/version.rb

@@ -0,0 +1,3 @@
+module ADCK
+  VERSION = '0.1.0'
+end

data/lib/adck.rb

@@ -0,0 +1,66 @@
+require 'forwardable'
+require 'socket'
+require 'openssl'
+require 'json'
+require 'adck/version'
+require 'multi_json'
+
+module ADCK
+
+  @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
+
+    def send_notification token, message=nil
+      if token.is_a?(Notification)
+        n = token
+      else
+        n = Notification.new(token,message)
+      end
+
+      send_notifications([n])
+    end
+
+    def send_notifications(notifications)
+      Connection.new.open do |sock,ssl|
+        notifications.each do |n|
+          ssl.write(n.packaged_notification)
+        end
+      end
+    end
+
+    def feedback
+      apns_feedback = []
+
+      Connection.feedback.open do |sock, ssl|
+        while line = sock.gets   # Read lines from the socket
+          line.strip!
+          f = line.unpack('N1n1H140')
+          apns_feedback << [Time.at(f[0]), f[2]]
+        end
+      end
+
+      apns_feedback
+    end
+  end
+
+end
+
+def ADCK val, msg=nil
+  if val.is_a?(Array)
+    ADCK.send_notifications(val)
+  elsif val.is_a?(ADCK::Notification)
+    ADCK.send_notifications([val])
+  else
+    ADCK.send_notification(val,msg)
+  end
+end
+
+require 'adck/notification'
+require 'adck/message'
+require 'adck/connection'

data/spec/apns/notification_spec.rb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe ADCK::Notification do
+
+  it "should take a string as the message" do
+    n = ADCK::Notification.new('device_token', 'Hello')
+    n.alert.should == 'Hello'
+  end
+
+  it "should take a hash as the message" do
+    n = ADCK::Notification.new('device_token', {:alert => 'Hello iPhone', :badge => 3})
+    n.alert.should == "Hello iPhone"
+    n.badge.should == 3
+  end
+
+  describe '#packaged_message' do
+
+    it "should return JSON with notification information" do
+      n = ADCK::Notification.new('device_token', {:alert => 'Hello iPhone', :badge => 3, :sound => 'awesome.caf'})
+      n.packaged_message.should  == "{\"aps\":{\"alert\":\"Hello iPhone\",\"badge\":3,\"sound\":\"awesome.caf\"}}"
+    end
+
+    it "should not include keys that are empty in the JSON" do
+      n = ADCK::Notification.new('device_token', {:badge => 3})
+      n.packaged_message.should == "{\"aps\":{\"badge\":3}}"
+    end
+
+  end
+
+  describe '#package_token' do
+    it "should package the token" do
+      n = ADCK::Notification.new('<5b51030d d5bad758 fbad5004 bad35c31 e4e0f550 f77f20d4 f737bf8d 3d5524c6>', 'a')
+      Base64.encode64(n.packaged_token).should == "W1EDDdW611j7rVAEutNcMeTg9VD3fyDU9ze/jT1VJMY=\n"
+    end
+  end
+
+  describe '#packaged_notification' do
+    it "should package the token" do
+      n = ADCK::Notification.new('device_token', {:alert => 'Hello iPhone', :badge => 3, :sound => 'awesome.caf'})
+      Base64.encode64(n.packaged_notification).should == "AAAg3vLO/YTnAEB7ImFwcyI6eyJhbGVydCI6IkhlbGxvIGlQaG9uZSIsImJh\nZGdlIjozLCJzb3VuZCI6ImF3ZXNvbWUuY2FmIn19\n"
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+gem 'rspec', '>= 1.2.8'
+require 'rspec'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'apns')
+require 'base64'

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: adck
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Tal Atlas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+description: ! "    Simple Apple push notification service gem\n\n    Based on the
+  APNS gem by James Pozdena <jpoz@jpoz.net> http://github.com/jpoz/apns\n"
+email:
+- me@tal.by
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- adck.gemspec
+- lib/adck.rb
+- lib/adck/connection.rb
+- lib/adck/message.rb
+- lib/adck/notification.rb
+- lib/adck/version.rb
+- spec/apns/notification_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/delight-labs/ADCK
+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.24
+signing_key: 
+specification_version: 3
+summary: Simple Apple push notification service gem
+test_files:
+- spec/apns/notification_spec.rb
+- spec/spec_helper.rb