lead_zeppelin 0.1.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+test.rb

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Geoloqi
+
+MIT License
+
+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,71 @@
+# LeadZeppelin
+
+Fast, threaded client for the Apple Push Notification Service.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'lead_zeppelin'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lead_zeppelin
+
+## Usage
+
+Require the gem, set threads to throw exceptions (optional, but recommended for now):
+
+    require 'lead_zeppelin'
+    Thread.abort_on_exception = true
+    
+Instantiate a new client and configure it by adding the block of code to handle error responses, and . Provide client.on\_error _before adding applications_.
+
+    client = LeadZeppelin::APNS::Client.new do |c|
+      c.on_error do |error_response|
+        puts "Apple sent back an error response: #{error_response.inspect}"
+      end
+      
+      # You can provide .p12 files too! p12: File.read('./yourapp.p12')
+      c.add_application :your_app_identifier, pem: File.read('./yourapp.pem')
+    end
+
+# Add a poller to read messages via a method of your choosing:
+
+    # Poll every second, join parent (main) thread so it doesn't close
+    
+    client.poll(1, join_parent_thread: true) do |c|
+      c.message :demoapp, 'f80d44bc73b4a856d9bcd63c2285e5190f8a7dcd8af34cfdf1f4a23cfd66423d', "testing!"
+    end
+
+# Logging
+
+LeadZeppelin#logger takes a Logger class:
+
+    require 'logger'
+    LeadZeppelin.logger = Logger.new(STDERR)
+
+To watch the thread flow, pass an IO to LeadZeppelin#thread_logger (but not a Logger):
+
+    LeadZeppelin.thread_logger = STDERR
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## TODO
+
+* *TESTING*
+* Way to handle errors asynchronously using a pool
+* Performance and concurrency speedups
+* Edge cases
+* Documentation (code level and regular)
+* Length checking for payload, possibly an auto truncating feature

data/Rakefile

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

data/lead_zeppelin.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/lead_zeppelin/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Kyle Drake"]
+  gem.email         = ["kyledrake@gmail.com"]
+  gem.description   = %q{Thread-safe, multi-application APNS client}
+  gem.summary       = %q{Thread-safe, multi-application APNS client that makes it easier to develop notification software for the APNS service.}
+  gem.homepage      = "https://github.com/geoloqi/lead_zeppelin"
+
+  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          = "lead_zeppelin"
+  gem.require_paths = ["lib"]
+  gem.version       = LeadZeppelin::VERSION
+  gem.add_dependency 'multi_json'
+  gem.add_dependency 'json'
+  gem.add_dependency 'connection_pool'
+end

data/lib/lead_zeppelin.rb

@@ -0,0 +1,9 @@
+require_relative './lead_zeppelin/apns'
+require_relative './lead_zeppelin/version'
+
+module LeadZeppelin
+  class << self
+    attr_accessor :logger
+    attr_accessor :thread_logger
+  end
+end

data/lib/lead_zeppelin/apns.rb

@@ -0,0 +1,13 @@
+require 'thread'
+require 'socket'
+require 'openssl'
+require 'multi_json'
+require 'connection_pool'
+require 'timeout'
+require 'securerandom'
+require_relative './apns/application'
+require_relative './apns/client'
+require_relative './apns/gateway'
+require_relative './apns/logger'
+require_relative './apns/notification'
+require_relative './apns/error'

data/lib/lead_zeppelin/apns/application.rb

@@ -0,0 +1,45 @@
+module LeadZeppelin
+  module APNS
+    class Application
+      CONNECTION_POOL_SIZE = 5
+      CONNECTION_POOL_TIMEOUT = 5
+
+      def initialize(name, opts={})
+        @name = name
+        @opts = opts
+
+        @ssl_context = OpenSSL::SSL::SSLContext.new
+
+        if opts[:p12]
+          pem = OpenSSL::PKCS12.new opts[:p12], opts[:p12_pass]
+          @ssl_context.cert = pem.certificate
+          @ssl_context.key  = pem.key
+        elsif opts[:pem]
+          @ssl_context.cert = OpenSSL::X509::Certificate.new opts[:pem]
+          @ssl_context.key  = OpenSSL::PKey::RSA.new opts[:pem], opts[:pem_pass]
+        else
+          raise ArgumentError, 'opts[:p12] or opts[:pem] required'
+        end
+      end
+
+      def connect
+        cp_args = {size:    (@opts[:connection_pool_size] || CONNECTION_POOL_SIZE),
+                   timeout: (@opts[:connection_pool_timeout] || CONNECTION_POOL_TIMEOUT)}
+
+        @gateway_connection_pool = ConnectionPool.new(cp_args) do
+          Gateway.new @ssl_context, (@opts[:gateway_opts] || {}).merge(error_block: @opts[:error_block])
+        end
+      end
+
+      def message(device_id, message, opts={})
+        connect if @gateway_connection_pool.nil?
+
+        @gateway_connection_pool.with_connection do |gateway|
+          gateway.write Notification.new(device_id, message, opts)
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/lead_zeppelin/apns/client.rb

@@ -0,0 +1,75 @@
+module LeadZeppelin
+  module APNS
+    class Client
+      CLIENT_THREADS = 10
+      DEFAULT_POLL_FREQUENCY = 1
+
+      def initialize(opts={}, &configure)
+        Logger.info "instantiating client with options: #{opts.inspect}"
+        Logger.thread 'c'
+        @semaphore = Mutex.new
+        @opts = opts
+
+        self.instance_eval &configure
+
+        # FIXME
+        @thread_count = Queue.new
+        (opts[:client_threads] || CLIENT_THREADS).times {|t| @thread_count << t}
+      end
+
+      attr_accessor :applications
+
+      def on_error(&block)
+        @error_block = block
+      end
+
+      def poll(frequency=DEFAULT_POLL_FREQUENCY, opts={}, &block)
+        Logger.info 'creating polling thread'
+        Logger.thread 'p'
+        @polling_thread = Thread.new {
+          loop do
+            self.instance_eval &block
+            sleep frequency
+          end
+
+          Logger.thread 'polling thread running'
+        }
+
+        @polling_thread.join if opts[:join_parent_thread] == true
+      end
+
+      def hold_open_poll
+        Logger.info 'attaching current thread to polling thread'
+        @polling_thread.join
+      end
+
+      def add_application(name, opts={})
+        Logger.info "adding application \"#{name}\""
+        Logger.thread 'a'
+        @semaphore.synchronize do
+          @applications ||= {}
+          @applications[name] = Application.new name, opts.merge(error_block: @error_block)
+        end
+      end
+
+      def remove_application(name)
+        Logger.info "removing application \"#{name}\""
+        Logger.thread 'r'
+        @semaphore.synchronize do
+          deleted = @applications.delete name
+          Logger.warn "removing application \"#{name}\" failed! Name may be invalid." if deleted.nil?
+        end
+      end
+
+      def message(app_name, device_id, message, opts={})
+        Logger.debug "message: \"#{app_name}\", \"#{device_id}\", \"#{message}\""
+        Logger.thread 'm'
+
+        # FIXME
+        t = @thread_count
+        @applications[app_name].message device_id, message, opts
+        @thread_count << t
+      end
+    end
+  end
+end

data/lib/lead_zeppelin/apns/error.rb

@@ -0,0 +1,26 @@
+module LeadZeppelin
+  module APNS
+    class ErrorResponse
+      CODES = {
+        0   => 'No errors encountered',
+        1   => 'Processing error',
+        2   => 'Missing device token',
+        3   => 'Missing topic',
+        4   => 'Missing payload',
+        5   => 'Invalid token size',
+        6   => 'Invalid topic size',
+        7   => 'Invalid payload size',
+        8   => 'Invalid token',
+        255 => 'None (unknown)'
+      }
+
+      attr_reader :code, :identifier, :message, :notification
+
+      def initialize(packet, notification=nil)
+        command, @code, @identifier = packet.unpack 'ccA4'
+        @message = CODES[@code]
+        @notification = notification
+      end
+    end
+  end
+end

data/lib/lead_zeppelin/apns/gateway.rb

@@ -0,0 +1,108 @@
+module LeadZeppelin
+  module APNS
+    class Gateway
+      HOST = 'gateway.push.apple.com'
+      PORT = 2195
+      DEFAULT_TIMEOUT = 10
+      DEFAULT_SELECT_WAIT = 0.5
+
+      def initialize(ssl_context, opts={})
+        Logger.thread 'g'
+        @semaphore = Mutex.new
+        @ssl_context = ssl_context
+        @opts        = opts
+
+        connect
+      end
+
+      def connect
+        Logger.thread 's'
+        begin
+          timeout(@opts[:timeout] || DEFAULT_TIMEOUT) do
+            socket = TCPSocket.new((@opts[:apns_host] || HOST), (@opts[:apns_port] || PORT))
+            ssl_socket = OpenSSL::SSL::SSLSocket.new socket, @ssl_context
+            ssl_socket.sync_close = true # when ssl_socket is closed, make sure the regular socket closes too.
+            ssl_socket.connect
+
+            @semaphore.synchronize do
+              @socket = socket
+              @ssl_socket = ssl_socket
+            end
+          end
+
+          Logger.debug "gateway connection established"
+
+        rescue Errno::ETIMEDOUT, Timeout::Error
+          Logger.warn "gateway connection timeout, retrying"
+          retry
+        end
+      end
+
+      def reconnect
+        Logger.info "reconnecting to gateway"
+        Logger.thread 'r'
+        disconnect
+        connect
+      end
+
+      def disconnect
+        Logger.info "disconnecting from gateway"
+        Logger.thread 'd'
+        @ssl_socket.close
+      end
+
+      def process_error(notification=nil)
+        begin
+          error_response = @ssl_socket.read_nonblock 6
+          error = ErrorResponse.new error_response, notification
+
+          Logger.warn "error: #{error.code}, #{error.identifier.to_s}, #{error.message}"
+          Logger.thread 'e'
+
+          reconnect
+
+          if @opts[:error_block].nil? || !@opts[:error_block].respond_to?(:call)
+            Logger.error "You have not implemented an on_error block. This could lead to your account being banned from APNS. See the APNS docs"
+          else
+            @opts[:error_block].call(error)
+          end
+
+        rescue IO::WaitReadable
+          Logger.thread 'g'
+        end
+      end
+
+      def write(notification)
+        Logger.thread 'w'
+
+        begin
+          process_error
+
+          @ssl_socket.write notification.payload
+
+          read, write, error = IO.select [@ssl_socket], [], [@ssl_socket], (@opts[:select_wait] || DEFAULT_SELECT_WAIT)
+
+          if !error.nil? && !error.first.nil?
+            Logger.error "IO.select has reported an unexpected error. Reconnecting, sleeping a bit and retrying"
+            sleep 1
+            reconnect
+          end
+
+          if !read.nil? && !read.first.nil?
+            process_error(notification)
+            return false
+          end
+
+        rescue Errno::EPIPE => e
+          Logger.warn 'gateway connection returned broken pipe, attempting reconnect and retrying'
+          Logger.thread 'f'
+          reconnect
+          retry
+        end
+        
+        true
+      end
+
+    end
+  end
+end

data/lib/lead_zeppelin/apns/logger.rb

@@ -0,0 +1,29 @@
+module LeadZeppelin
+  module APNS
+    module Logger
+
+      module_function
+
+      def thread(string)
+        LeadZeppelin.thread_logger.print string.upcase if LeadZeppelin.thread_logger
+      end
+
+      def debug(string)
+        LeadZeppelin.logger.debug(string) if LeadZeppelin.logger
+      end
+
+      def info(string)
+        LeadZeppelin.logger.info(string) if LeadZeppelin.logger
+      end
+
+      def warn(string)
+        LeadZeppelin.logger.warn(string) if LeadZeppelin.logger
+      end
+
+      def error(string)
+        LeadZeppelin.logger.error(string) if LeadZeppelin.logger
+      end
+
+    end
+  end
+end

data/lib/lead_zeppelin/apns/notification.rb

@@ -0,0 +1,39 @@
+module LeadZeppelin
+  module APNS
+    class Notification
+      attr_reader :device_token, :identifier, :expiry
+
+      def initialize(device_token, message, opts={})
+        @device_token = device_token
+        @opts = opts
+        
+        @identifier = @opts[:identifier] || SecureRandom.random_bytes(4)
+        @identifier = @identifier.to_s
+
+        @expiry = @opts[:expiry].nil? ? 1 : @opts[:expiry].to_i
+
+        if message.is_a?(Hash)
+          other = message.delete(:other)
+          @message = {aps: message}
+          @message.merge!(other) if other
+        elsif message.is_a?(String)
+          @message = {aps: {alert: message}}
+        else
+          raise ArgumentError, "notification message must be hash or string"
+        end
+      end
+
+      def payload
+        [1, @identifier, @expiry, 0, 32, packaged_token, 0, message_json.bytesize, message_json].pack("cA4Ncca*cca*")
+      end
+
+      def packaged_token
+        [device_token.gsub(/[\s|<|>]/,'')].pack('H*')
+      end
+
+      def message_json
+        @message_json ||= MultiJson.encode @message
+      end
+    end
+  end
+end

data/lib/lead_zeppelin/version.rb

@@ -0,0 +1,3 @@
+module LeadZeppelin
+  VERSION = '0.1.1'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: lead_zeppelin
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Kyle Drake
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-06 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: 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: connection_pool
+  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'
+description: Thread-safe, multi-application APNS client
+email:
+- kyledrake@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lead_zeppelin.gemspec
+- lib/lead_zeppelin.rb
+- lib/lead_zeppelin/apns.rb
+- lib/lead_zeppelin/apns/application.rb
+- lib/lead_zeppelin/apns/client.rb
+- lib/lead_zeppelin/apns/error.rb
+- lib/lead_zeppelin/apns/gateway.rb
+- lib/lead_zeppelin/apns/logger.rb
+- lib/lead_zeppelin/apns/notification.rb
+- lib/lead_zeppelin/version.rb
+homepage: https://github.com/geoloqi/lead_zeppelin
+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: Thread-safe, multi-application APNS client that makes it easier to develop
+  notification software for the APNS service.
+test_files: []