mobile_notify 0.1

data/Rakefile

@@ -0,0 +1,54 @@
+require "rubygems"
+require "pathname"
+require "rake"
+require "rake/testtask"
+
+# task :default => [:test]
+# Rake::TestTask.new do |t|
+#   t.libs << "test"
+#   t.test_files = FileList['test/**/*_test.rb']
+#   t.verbose = true
+# end
+
+# Gem
+require "rake/gempackagetask"
+require "lib/mobile_notify/version"
+
+NAME = "mobile_notify"
+SUMMARY = "Mobile Notification Services w/ support for the Apple Push Notification Service (APNS)"
+GEM_VERSION = MobileNotify::VERSION
+
+spec = Gem::Specification.new do |s|
+  s.name = NAME
+  s.summary = s.description = SUMMARY
+  s.author = "Scott Bauer"
+  s.homepage = "http://rdoc.info/projects/Bauerpauer/mobile_notify"
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.require_path = 'lib'
+  s.files = %w(Rakefile) + Dir.glob("lib/**/*")
+  s.executables = ['apns_ping']
+  
+  s.add_dependency "json"
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install #{NAME} as a gem"
+task :install => [:repackage] do
+  sh %{gem install pkg/#{NAME}-#{GEM_VERSION}}
+end
+
+task :version do
+  puts GEM_VERSION
+end
+
+spec_file = ".gemspec"
+desc "Create #{spec_file}"
+task :gemspec do
+ File.open(spec_file, "w") do |file|
+   file.puts spec.to_ruby
+ end
+end

data/bin/apns_ping

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+
+gem "mobile_notify"
+require "mobile_notify"
+
+gateway_uri = if ARGV[0].to_s.downcase == '-p'
+  ARGV.shift
+  MobileNotify::Apns::PRODUCTION_GATEWAY_URI
+else
+  MobileNotify::Apns::SANDBOX_GATEWAY_URI
+end
+
+device_token, cert, key, badge, alert, sound = if File.file?(ARGV[2])
+  [ARGV[0], ARGV[1], ARGV[2], ARGV[3].to_i, ARGV[4], ARGV[5]]
+else
+  [ARGV[0], ARGV[1], nil, ARGV[2].to_i, ARGV[3], ARGV[4]]
+end
+
+puts "Gateway: #{gateway_uri}"
+puts "Device Token: #{device_token}"
+puts "Badge: #{badge}"
+puts "Alert: #{alert}"
+puts "Sound: #{sound}"
+
+MobileNotify::Apns::Connection.open(gateway_uri, cert, key) do |connection|
+  connection.send(MobileNotify::Apns::SimpleNotification.new(device_token, badge, alert, sound))
+end

data/lib/mobile_notify.rb

@@ -0,0 +1,8 @@
+require "json"
+require "openssl"
+require "socket"
+require "uri"
+
+require "mobile_notify/version"
+require "mobile_notify/apns/connection"
+require "mobile_notify/apns/notification"

data/lib/mobile_notify/apns/connection.rb

@@ -0,0 +1,124 @@
+module MobileNotify
+  
+  module Apns
+  
+    SANDBOX_GATEWAY_URI = URI.parse("apns://gateway.sandbox.push.apple.com:2195")
+    PRODUCTION_GATEWAY_URI = URI.parse("apns://gateway.push.apple.com:2195")
+
+    class Connection
+      
+      class NotConnectedError < StandardError
+        def initialize(uri)
+          super("A connection to #{uri} has not yet been established.")
+        end
+      end
+
+      class AlreadyConnectedError < StandardError
+        def initialize(uri)
+          super("A connection to #{uri} has already been established.")
+        end
+      end
+
+      class ConnectionTimeoutError < StandardError
+        def initialize(uri, timeout, original_error)
+          super("Unable to establish connection to #{uri.host}:#{uri.port} within #{timeout} seconds.  SSL Reported: #{original_error.inspect}")
+        end
+      end
+
+      class TransmissionTimeoutError < StandardError
+        def initialize(uri, timeout, original_error)
+          super("Unable to send data to #{uri.host}:#{uri.port} within #{timeout} seconds.  SSL Reported: #{original_error.inspect}")
+        end
+      end
+    
+      DEFAULT_CONNECTION_TIMEOUT = 30
+      DEFAULT_CONNECTION_RETRY_DELAY = 2
+      DEFAULT_TRANSMISSION_TIMEOUT = 10 
+      DEFAULT_TRANSMISSION_RETRY_DELAY = 2
+
+      attr_accessor :connection_timeout, :connection_retry_delay
+      attr_accessor :transmission_timeout, :transmission_retry_delay
+      
+      def self.open(uri, certificate_file, key_file = certificate_file)
+        connection = new(uri, certificate_file, key_file = certificate_file)
+        connection.open
+        yield connection
+      ensure
+        connection.close if connection
+      end
+
+      def initialize(uri, certificate_file, key_file = certificate_file)
+        @uri = uri
+        @certificate_file = certificate_file
+        @key_file = key_file.nil? ? certificate_file : key_file
+
+        @connection_timeout = DEFAULT_CONNECTION_TIMEOUT
+        @connection_retry_delay = DEFAULT_CONNECTION_RETRY_DELAY
+        @transmission_timeout = DEFAULT_TRANSMISSION_TIMEOUT
+        @transmission_retry_delay = DEFAULT_TRANSMISSION_RETRY_DELAY
+
+        @ssl_context = OpenSSL::SSL::SSLContext.new()
+        @ssl_context.cert = OpenSSL::X509::Certificate.new(File::read(@certificate_file))
+        @ssl_context.key  = OpenSSL::PKey::RSA.new(File::read(@key_file))
+        @tcp_socket = TCPSocket.new(@uri.host, @uri.port)
+        @ssl_socket = nil
+      end
+      
+      def open
+        raise AlreadyConnectedError.new(@uri) if @ssl_socket
+        
+        @ssl_socket = establish_connection
+        self
+      end
+      
+      def send(notification)
+        raise NotConnectedError.new(@uri) unless @ssl_socket
+
+        unless defined?(retry_timer)
+          retry_timer = 0
+        end
+      
+        @ssl_socket.write(notification.to_data)
+        self
+      rescue OpenSSL::SSL::SSLError, Errno::EPIPE
+        sleep(self.transmission_retry_delay)
+        retry_timer += self.transmission_retry_delay
+        retry if retry_timer < self.transmission_timeout
+      
+        raise TransmissionTimeoutError.new(@uri, self.transmission_timeout, $!) if retry_timer >= self.transmission_timeout
+      end
+    
+      def close
+        @ssl_socket.close if @ssl_socket
+        @ssl_socket = nil
+
+        self
+      end
+
+      protected
+    
+      def establish_connection
+        unless defined?(retry_timer)
+          retry_timer = 0 
+        end
+
+        # Wrap the TCP socket w/ SSL
+        ssl_socket = OpenSSL::SSL::SSLSocket.new(@tcp_socket, @ssl_context)
+        ssl_socket.connect
+        ssl_socket.sync_close = true
+
+        ssl_socket
+      rescue OpenSSL::SSL::SSLError, Errno::EPIPE
+        sleep(self.connection_retry_delay)
+        retry_timer += self.connection_retry_delay
+        retry if retry_timer < self.connection_timeout
+
+        raise ConnectionTimeoutError.new(@uri, self.connection_timeout, $!) if retry_timer >= self.connection_timeout
+      end
+
+    end
+  
+  end
+
+end
+

data/lib/mobile_notify/apns/notification.rb

@@ -0,0 +1,75 @@
+module MobileNotify
+  
+  module Apns
+
+    class Notification
+    
+      MAX_PAYLOAD_LENGTH = 256
+
+      # Counterpart of {Notification#to_s} - parses from binary string
+      # @param [String] bitstring string to parse
+      # @return [Notification] parsed Notification object
+      def self.parse(bitstring)
+        command, tokenlen, device_token, payloadlen, payload = bitstring.unpack("CnH64na*")
+        new(device_token, payload)
+      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
+      # @example
+      # APNs4r::Notification.new 'e754dXXXX...', { :aps => {:alert => "Hey, dude!", :badge => 1}, :custom_data => "asd" }
+      def initialize(device_token, payload)
+        @device_token = device_token.delete(' ')
+        @payload = payload.kind_of?(Hash) ? payload.to_json : payload
+      end
+
+      def valid?
+        @payload.length <= MAX_PAYLOAD_LENGTH
+      end
+
+      # Converts to binary string wich can be writen directly into socket
+      # @return [String] binary string representation
+      def to_data
+        [0, 32, @device_token, @payload.length, @payload ].pack("CnH*na*")
+      end
+
+    end
+  
+    class AlertNotification < Notification
+      def initialize(device_token, alert, sound = nil)
+        payload = { "aps" => {} }
+        payload["aps"]["alert"] = alert
+        payload["aps"]["sound"] = sound if sound
+        super(device_token, payload)
+      end
+    end
+  
+    class BadgeNotification < Notification
+      def initialize(device_token, badge, sound = nil)
+        payload = { "aps" => {} }
+        payload["aps"]["badge"] = badge_value.to_i
+        payload["aps"]["sound"] = sound if sound
+        super(device_token, payload)
+      end
+    end
+  
+    class SimpleNotification < Notification
+    
+      EMPTY_BADGE = 0
+
+      def initialize(device_token, badge_value = EMPTY_BADGE, alert = nil, sound = nil, extra = nil)
+        payload = { "aps" => {} }
+        payload["aps"]["badge"] = badge_value.to_i
+        payload["aps"]["alert"] = alert if alert
+        payload["aps"]["sound"] = sound if sound
+        payload.update(extra) if extra.is_a?(Hash)
+
+        super(device_token, payload)
+      end
+
+    end
+
+  end
+
+end

data/lib/mobile_notify/version.rb

@@ -0,0 +1,3 @@
+module MobileNotify
+  VERSION = "0.1"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: mobile_notify
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Scott Bauer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-27 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Mobile Notification Services w/ support for the Apple Push Notification Service (APNS)
+email: 
+executables: 
+- apns_ping
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- lib/mobile_notify/apns/connection.rb
+- lib/mobile_notify/apns/notification.rb
+- lib/mobile_notify/version.rb
+- lib/mobile_notify.rb
+- bin/apns_ping
+has_rdoc: true
+homepage: http://rdoc.info/projects/Bauerpauer/mobile_notify
+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: Mobile Notification Services w/ support for the Apple Push Notification Service (APNS)
+test_files: []
+