kw_apn 0.2

data/README.rdoc

@@ -0,0 +1,51 @@
+====================================
+Getting Started
+====================================
+For Rails start the generator: kw_apn
+This will copy the configuration example into your project.
+
+If you not working with Rails you need to specify either Rails.root and Rails.env or RACK_ROOT and RACK_ENV for the gem to work.
+
+Manual:
+create the File
+<project_root>/config/kw_apn.yml
+
+structure of the config file should look like this:
+
+
+    environment: 
+      cert_file: path to ssl certificate file
+      push_host: 'gateway.sandbox.push.apple.com' or 'gateway.push.apple.com' for live
+      push_port: 2195
+      feedback_host: 'feedback.sandbox.push.apple.com' or 'feedback.push.apple.com' for live
+      feedback_port: 2196 
+  
+
+====================================
+Example
+====================================
+
+  users = MyAPNUsers.all
+  n = []
+  payload = {:aps => {:alert => "Something very important for everyone to read", :sound => 'annoying_beep'}}
+  
+  users.each do |u|
+    n << KwAPN::Notification.create(u.token, payload, 0)
+  end
+  
+  status, ret = KwAPN::Sender.push(n, 'TestSession')
+  
+  if status == :ok
+    ret.each do |token|
+      MyAPNUsers.delete_all('token'=>token)
+    end
+  end
+  
+
+====================================
+Copyright
+====================================
+
+Distributed under the MIT License.
+Based in part on Apns4r by Leonid Ponomarev (http://rdoc.info/projects/thegeekbird/Apns4r)
+  

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'rake'
+
+task :gem do
+  `gem build *.gemspec`
+end
+
+task :install do
+  Rake::Task[:gem].invoke
+  `sudo gem install *.gem`
+  Rake::Task[:cleanup].invoke
+end
+
+task :cleanup do
+  `rm *.gem`
+end

data/VERSION

@@ -0,0 +1 @@
+0.2

data/kw_apn.gemspec

@@ -0,0 +1,19 @@
+version =  File.read('VERSION')
+
+File.open(File.join(File.dirname(__FILE__), 'VERSION'), 'w') do |f|
+  f.write(version)
+end
+
+Gem::Specification.new do |s|
+  s.name = 'kw_apn'
+  s.version = version
+  s.authors = ['Jonathan Cichon']
+  s.email = 'cichon@kupferwerk.com'
+  s.homepage = 'http://kupferwerk.com'
+  s.summary = 'APN Lib by Kupferwerk'
+  s.description = 'Apple Push Notification Library by Kupferwerk'
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README.rdoc']
+  s.require_path = 'lib'
+  s.files = Dir['lib/**/*'] + Dir['*.gemspec'] + ['Rakefile', 'README.rdoc', 'VERSION']
+end

data/lib/config.rb

@@ -0,0 +1,40 @@
+module KwAPN
+  require 'erb'
+  class Config
+    class << self
+      def options
+        @@options ||= nil
+        unless @@options
+          p_root = if defined? Rails
+            Rails.root
+          elsif defined? RACK_ROOT
+            RACK_ROOT
+          else
+            puts "Warning (KwAPN): You need to specifiy either Rails.root or RACK_ROOT for apns to work!"
+            nil
+          end
+          
+          p_env = if defined? Rails
+            Rails.env
+          elsif defined? RACK_ENV
+            RACK_ENV
+          else
+            puts "Warning (KwAPN): You need to specifiy either Rails.env or RACK_ENV for apns to work!"
+            nil
+          end
+          
+          @@options = begin
+              raw_config = File.read(p_root.join("config", "kw_apn.yml"))
+              parsed_config = ERB.new(raw_config).result
+              YAML.load(parsed_config)[p_env].symbolize_keys
+          rescue => e
+              puts "Warning (KwAPN): Could not parse config file: #{e.message}"
+              {}
+          end
+          @@options[:root] = p_root
+        end
+        return @@options
+      end
+    end
+  end
+end

data/lib/connection.rb

@@ -0,0 +1,30 @@
+module KwAPN
+  
+  require 'socket'
+  require 'openssl'
+  
+  class Connection
+    
+    def connect(host, port, opts)
+      ctx = OpenSSL::SSL::SSLContext.new()
+      ctx.cert = OpenSSL::X509::Certificate.new(File::read(opts[:cert_file]))
+      ctx.key  = OpenSSL::PKey::RSA.new(File::read(opts[:cert_file]))
+
+      s = TCPSocket.new(host, port)
+      ssl = OpenSSL::SSL::SSLSocket.new(s, ctx)
+      ssl.connect # start SSL session
+      ssl.sync_close = true # close underlying socket on SSLSocket#close
+      ssl      
+    end
+    
+    class << self
+      def log(s)
+        File.open(KwAPN::Config.options[:root].join("log", "kw_apn.log"), File::WRONLY|File::APPEND|File::CREAT, 0666) do |f|
+          f.write("#{s}\n")
+        end
+      end
+    end
+    
+  end
+  
+end

data/lib/core.rb

@@ -0,0 +1,66 @@
+begin
+  require 'json'
+rescue
+  puts "Warning: you need the json gem for apns to work!"
+end
+
+class Hash
+  MAX_PAYLOAD_LEN = 256
+
+  # Converts hash into JSON String.
+  # When payload is too long but can be chopped, tries to cut self.[:aps][:alert].
+  # If payload still don't fit Apple's restrictions, returns nil
+  #
+  # @return [String, nil] the object converted into JSON or nil.
+  def to_apn_payload
+    # Payload too long
+    if (to_json.length > MAX_PAYLOAD_LEN)
+      alert = self[:aps][:alert]
+      self[:aps][:alert] = ''
+      # can be chopped?
+      if (to_json.length > MAX_PAYLOAD_LEN)
+        return nil
+      else # inefficient way, but payload may be full of unicode-escaped chars, so...
+        self[:aps][:alert] = alert
+        while (self.to_json.length > MAX_PAYLOAD_LEN)
+          self[:aps][:alert].chop!
+        end
+      end
+    end
+    to_json
+  end
+
+  # Invokes {Hash#to_payload} and returns it's length
+  # @return [Fixnum, nil] length of object converted into JSON or nil.
+  def apn_payload_length
+    p = to_apn_payload
+    p ? p.length : nil
+  end
+
+end
+
+module KwAPN
+
+  class Notification
+
+    attr_accessor :identifier, :token
+    def initialize(token, payload, timestamp=0)
+      @token, @payload, @timestamp = token, payload, timestamp
+    end
+
+    # Creates new notification with given token and payload
+    # @param [String, Fixnum] token APNs token of device to notify
+    # @param [Hash, String] payload attached payload
+    def Notification.create(token, payload, timestamp=0)
+      Notification.new(token.kind_of?(String) ? token.delete(' ') : token.to_s(16) , payload.kind_of?(Hash) ? payload.to_apn_payload : payload, timestamp)
+    end
+
+    # Converts to binary string wich can be writen directly into socket
+    # @return [String] binary string representation  
+    def to_s
+      [1, @identifier, @timestamp, 32, @token, @payload.length, @payload].pack("CNNnH*na*")
+    end
+
+  end
+
+end

data/lib/feedback_reader.rb

@@ -0,0 +1,26 @@
+module KwAPN
+  class FeedbackReader < Connection
+    
+    attr_accessor :host, :port
+    def initialize(host=nil, port=nil)
+      @host = host || KwAPN::Config.options[:feedback_host]
+      @port = port || KwAPN::Config.options[:feedback_port]
+    end
+    
+    def read
+      records ||= []
+      begin
+        @ssl = connect(@host, @port, KwAPN::Config.options)
+        while record = @ssl.read(38)
+          feedback = record.strip.unpack('NnH*')
+          records << feedback[2].scan(/.{0,8}/).join(' ').strip
+        end
+      rescue => e
+        puts "Error reading feedback channel: #{e.message}"
+      ensure
+        @ssl.close
+      end
+      return records
+    end
+  end
+end

data/lib/generators/kw_apn/kw_apn_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators'
+
+class KwApnGenerator < Rails::Generators::Base
+
+  def install_kw_apn
+    source_paths << File.join(File.dirname(__FILE__), 'templates')
+    
+    copy_file "config/kw_apn.yml"
+    directory "config/cert"
+    directory "log"
+    copy_file "log/kw_apn.log"
+    
+    gem 'kw_apn'
+  end
+
+    
+
+end

data/lib/generators/kw_apn/templates/config/kw_apn.yml

@@ -0,0 +1,18 @@
+defaults: &defaults
+  cert_file: <%= Rails.root.join("config/cert", "apn_#{Rails.env}_cert.pem") %>
+  push_host: 'gateway.sandbox.push.apple.com'
+  push_port: 2195
+  feedback_host: 'feedback.sandbox.push.apple.com'
+  feedback_port: 2196
+
+development:
+  <<: *defaults
+  profile: true
+
+test:
+  <<: *defaults
+
+production:
+  <<: *defaults
+  push_host: 'gateway.push.apple.com'
+  feedback_host: 'feedback.push.apple.com'

data/lib/generators/kw_apn/usage

@@ -0,0 +1 @@
+Installs config templates to get you started with your project

data/lib/kw_apn.rb

@@ -0,0 +1,5 @@
+require 'config'
+require 'connection'
+require 'sender'
+require 'feedback_reader'
+require 'core'

data/lib/sender.rb

@@ -0,0 +1,145 @@
+module KwAPN
+
+  # maybe somebody knows why but Apple seems to have dificulties handling identifiers between 9 and ~ 20
+  # if there is a bug on our side feel free to fix it, but for now it seems to work with the offset workaround
+  ID_OFFSET = 333
+  class Sender < Connection
+    attr_accessor :host, :port, :count, :fail_count, :work_thread, :watch_thread, :failed_index_array, :session_id
+
+    # Creates new {Sender} object with given host and port
+    def initialize(session_id, host=nil, port=nil)
+      @session_id = session_id
+      @host = host || KwAPN::Config.options[:push_host] || 'gateway.sandbox.push.apple.com'
+      @port = port || KwAPN::Config.options[:push_port] || 2195
+      @count = 0
+      @fail_count = 0
+      @failed_index_array = []
+      self
+    end
+    
+    def push_batch(notifications=[])
+      begin
+        if @ssl != nil
+          return [:nok, 'Start a new Connection for every batch you want to perform'] 
+        end
+        @count = notifications.length
+        start_threads(notifications)
+        return [:ok, @failed_index_array.collect{|a| notifications[a].token}]
+      rescue => e
+        failed
+        self.class.log("(#{session_id}) Exception: #{e.message}")
+        return [:nok, "Exception: #{e.message}"]
+      end
+    end
+    
+    def close_connection
+      @ssl.close if @ssl
+      @ssl = nil
+    end
+    
+private
+    
+    def start_threads(notifications, index=0)
+      @ssl = connect(@host, @port, KwAPN::Config.options)
+      if @ssl
+        @watch_thread = Thread.new do 
+          perform_watch()
+        end
+        
+        @work_thread = Thread.new do 
+          perform_batch(notifications, index)
+        end
+        
+        @work_thread.join
+        
+        if @failed_index_array.last and index <= @failed_index_array.last and @failed_index_array.last < @count - 1 and @ssl.nil?
+          # wait for apple to respond errors
+#          sleep(1)
+          start_threads(notifications, @failed_index_array.last + 1)
+        end
+      else
+        failed
+      end      
+    end
+
+    def perform_batch(notifications, index=0)
+      notifications[index..-1].each_with_index do |n, i|
+        begin
+          n.identifier = i + index + ID_OFFSET
+          bytes = @ssl.write(n.to_s)
+          if bytes <= 0
+            self.class.log("(#{session_id}) Warning at index #{i+index}: could not write to Socket")
+            # TODO?
+            # we do not realy want to respond to network errors, as we do not know how many apns might have been lost. 
+            # At the moment we hope the watchthread does everything right and our connection holds. 
+          end
+        rescue => e
+          # probably interrupted by watchthread, do nothing wait for restart
+          self.class.log("(#{session_id}) Exception at index #{i+index}: #{e.message}")
+
+          #if e.message == 'Broken pipe'
+          #end
+        end
+      end
+      # wait for apple to respond errors
+      sleep(5)
+    end
+    
+    def perform_watch
+      ret = @ssl.read
+      err = ret.strip.unpack('CCN')
+      if err[1] != 0 and err[2]
+        @failed_index_array << (err[2] - ID_OFFSET)
+        failed
+        @work_thread.exit
+      else
+        perform_watch
+      end
+    end
+
+    def failed
+      @fail_count += 1
+      close_connection
+    end
+    
+    def error_msg(status)
+      case status
+      when 1
+        "Processing error"
+      when 2
+        "Missing device token"
+      when 3
+        "Missing topic"
+      when 4
+        "Missing payload"
+      when 5
+        "Invalid token size"
+      when 6
+        "Invalid topic size"
+      when 7
+        "Invalid payload size"
+      when 8
+        "Invalid token"
+      when 255
+        "unknown"
+      end
+    end
+    
+    class << self
+      # convenient way of connecting with apple and pushing the notifications
+      # @param [Array] notifications - An Array of Objects of Type KwAPN::Notification
+      # @param [String] session_id - A Identifier for Login purpose
+      #
+      # @returns [Symbol, Array/String] if no Problems occured :ok and an Array of Tokens failed to push is returned. The Caller should take care of those invalid Tokens.
+      def push(notifications, session_id=nil)
+        s = self.new(session_id)
+        startdate = Time.now
+        status, ret = s.push_batch(notifications)
+        log("(#{session_id}) #{startdate.to_s} SENT APN #{s.count - s.fail_count}/#{s.count} in #{Time.now.to_i - startdate.to_i} seconds")
+        s.close_connection
+        return [status, ret]
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: kw_apn
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  version: "0.2"
+platform: ruby
+authors: 
+- Jonathan Cichon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-05 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Apple Push Notification Library by Kupferwerk
+email: cichon@kupferwerk.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/config.rb
+- lib/connection.rb
+- lib/core.rb
+- lib/feedback_reader.rb
+- lib/generators/kw_apn/kw_apn_generator.rb
+- lib/generators/kw_apn/templates/config/cert/dummy.pem
+- lib/generators/kw_apn/templates/config/kw_apn.yml
+- lib/generators/kw_apn/templates/log/kw_apn.log
+- lib/generators/kw_apn/usage
+- lib/kw_apn.rb
+- lib/sender.rb
+- kw_apn.gemspec
+- Rakefile
+- README.rdoc
+- VERSION
+has_rdoc: true
+homepage: http://kupferwerk.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: APN Lib by Kupferwerk
+test_files: []
+