houston 0.2.4 → 2.4.0

data/houston.gemspec

@@ -1,26 +1,27 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "houston"
+$:.push File.expand_path('../lib', __FILE__)
+require 'houston/version'
 
 Gem::Specification.new do |s|
-  s.name        = "houston"
-  s.authors     = ["Mattt Thompson"]
-  s.email       = "m@mattt.me"
-  s.license     = "MIT"
-  s.homepage    = "http://github.com/mattt/houston"
+  s.name        = 'houston'
+  s.authors     = ['Mattt Thompson']
+  s.email       = 'm@mattt.me'
+  s.license     = 'MIT'
+  s.homepage    = 'http://nomad-cli.com'
   s.version     = Houston::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.summary     = "Send Apple Push Notifications"
-  s.description = "Houston is a simple gem for sending Apple Push Notifications. Pass your credentials, construct your message, and send it."
+  s.summary     = 'Send Apple Push Notifications'
+  s.description = 'Houston is a simple gem for sending Apple Push Notifications. Pass your credentials, construct your message, and send it.'
 
-  s.add_dependency "commander", "~> 4.1"
-  s.add_dependency "json"
+  s.add_dependency 'commander', '~> 4.4'
+  s.add_dependency 'json'
 
-  s.add_development_dependency "rspec", "~> 0.6"
-  s.add_development_dependency "rake",  "~> 0.9"
+  s.add_development_dependency 'rspec', '~> 3.5'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'simplecov'
 
-  s.files         = Dir["./**/*"].reject { |file| file =~ /\.\/(bin|log|pkg|script|spec|test|vendor)/ }
+  s.files         = Dir['./**/*'].reject { |file| file =~ /\.\/(bin|log|pkg|script|spec|test|vendor)/ }
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
 end

data/lib/houston/client.rb

@@ -1,12 +1,12 @@
 module Houston
-  APPLE_PRODUCTION_GATEWAY_URI = "apn://gateway.push.apple.com:2195"
-  APPLE_PRODUCTION_FEEDBACK_URI = "apn://feedback.push.apple.com:2196"
+  APPLE_PRODUCTION_GATEWAY_URI = 'apn://gateway.push.apple.com:2195'
+  APPLE_PRODUCTION_FEEDBACK_URI = 'apn://feedback.push.apple.com:2196'
 
-  APPLE_DEVELOPMENT_GATEWAY_URI = "apn://gateway.sandbox.push.apple.com:2195"
-  APPLE_DEVELOPMENT_FEEDBACK_URI = "apn://feedback.sandbox.push.apple.com:2196"
+  APPLE_DEVELOPMENT_GATEWAY_URI = 'apn://gateway.sandbox.push.apple.com:2195'
+  APPLE_DEVELOPMENT_FEEDBACK_URI = 'apn://feedback.sandbox.push.apple.com:2196'
 
   class Client
-    attr_accessor :gateway_uri, :feedback_uri, :certificate, :passphrase
+    attr_accessor :gateway_uri, :feedback_uri, :certificate, :passphrase, :timeout
 
     class << self
       def development
@@ -27,36 +27,66 @@ module Houston
     def initialize
       @gateway_uri = ENV['APN_GATEWAY_URI']
       @feedback_uri = ENV['APN_FEEDBACK_URI']
-      @certificate = ENV['APN_CERTIFICATE']
+      @certificate = certificate_data
       @passphrase = ENV['APN_CERTIFICATE_PASSPHRASE']
+      @timeout = Float(ENV['APN_TIMEOUT'] || 0.5)
     end
 
     def push(*notifications)
       return if notifications.empty?
 
+      notifications.flatten!
+
       Connection.open(@gateway_uri, @certificate, @passphrase) do |connection|
-        notifications.flatten.each do |notification|
+        ssl = connection.ssl
+
+        notifications.each_with_index do |notification, index|
           next unless notification.kind_of?(Notification)
           next if notification.sent?
+          next unless notification.valid?
+
+          notification.id = index
 
           connection.write(notification.message)
           notification.mark_as_sent!
+
+          read_socket, _write_socket = IO.select([ssl], [ssl], [ssl], nil)
+          if (read_socket && read_socket[0])
+            if error = connection.read(6)
+              _command, status, index = error.unpack('ccN')
+              notification.apns_error_code = status
+              notification.mark_as_unsent!
+            end
+          end
         end
       end
     end
 
-    def devices
+    def unregistered_devices
       devices = []
 
       Connection.open(@feedback_uri, @certificate, @passphrase) do |connection|
         while line = connection.read(38)
           feedback = line.unpack('N1n1H140')
+          timestamp = feedback[0]
           token = feedback[2].scan(/.{0,8}/).join(' ').strip
-          devices << token if token
+          devices << { token: token, timestamp: timestamp } if token && timestamp
         end
       end
 
       devices
     end
+
+    def devices
+      unregistered_devices.collect { |device| device[:token] }
+    end
+
+    def certificate_data
+      if ENV['APN_CERTIFICATE']
+        File.read(ENV['APN_CERTIFICATE'])
+      elsif ENV['APN_CERTIFICATE_DATA']
+        ENV['APN_CERTIFICATE_DATA']
+      end
+    end
   end
 end

data/lib/houston/connection.rb

@@ -26,8 +26,8 @@ module Houston
 
     def initialize(uri, certificate, passphrase)
       @uri = URI(uri)
-      @certificate = certificate
-      @passphrase = passphrase
+      @certificate = certificate.to_s
+      @passphrase = passphrase.to_s unless passphrase.nil?              
     end
 
     def open
@@ -45,7 +45,7 @@ module Houston
     end
 
     def open?
-      not (@ssl and @socket).nil?
+      not (@ssl && @socket).nil?
     end
 
     def close

data/lib/houston/notification.rb

@@ -2,8 +2,37 @@ require 'json'
 
 module Houston
   class Notification
-    attr_accessor :token, :alert, :badge, :sound, :content_available, :custom_data
+    class APNSError < RuntimeError
+      # See: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/CommunicatingWIthAPS.html#//apple_ref/doc/uid/TP40008194-CH101-SW12
+      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',
+        10 => 'Shutdown',
+        255 => 'Unknown error'
+      }
+
+      attr_reader :code
+
+      def initialize(code)
+        raise ArgumentError unless CODES.include?(code)
+        super(CODES[code])
+        @code = code
+      end
+    end
+
+    MAXIMUM_PAYLOAD_SIZE = 2048
+
+    attr_accessor :token, :alert, :badge, :sound, :category, :content_available, :mutable_content,
+                  :custom_data, :id, :expiry, :priority, :url_args, :thread_id
     attr_reader :sent_at
+    attr_writer :apns_error_code
 
     alias :device :token
     alias :device= :token=
@@ -13,35 +42,87 @@ module Houston
       @alert = options.delete(:alert)
       @badge = options.delete(:badge)
       @sound = options.delete(:sound)
+      @category = options.delete(:category)
+      @expiry = options.delete(:expiry)
+      @id = options.delete(:id)
+      @priority = options.delete(:priority)
       @content_available = options.delete(:content_available)
+      @mutable_content = options.delete(:mutable_content)
+      @url_args = options.delete(:url_args)
+      @thread_id = options.delete(:thread_id)
 
       @custom_data = options
+
+      @sent_at = nil
+      @apns_error_code = nil
     end
 
     def payload
-      json = {}.merge(@custom_data || {})
+      json = {}.merge(@custom_data || {}).inject({}) { |h, (k, v)| h[k.to_s] = v; h }
+
       json['aps'] ||= {}
       json['aps']['alert'] = @alert if @alert
       json['aps']['badge'] = @badge.to_i rescue 0 if @badge
       json['aps']['sound'] = @sound if @sound
+      json['aps']['category'] = @category if @category
       json['aps']['content-available'] = 1 if @content_available
+      json['aps']['mutable-content'] = 1 if @mutable_content
+      json['aps']['url-args'] = @url_args if @url_args
+      json['aps']['thread-id'] = @thread_id if @thread_id
 
       json
     end
 
     def message
-      json = payload.to_json
-      hex_token = [@token.gsub(/[<\s>]/, '')].pack('H*')
-
-      [0, 0, 32, hex_token, 0, json.bytes.count, json].pack('ccca*cca*')
+      data = [device_token_item,
+              payload_item,
+              identifier_item,
+              expiration_item,
+              priority_item].compact.join
+      [2, data.bytes.count, data].pack('cNa*')
     end
 
     def mark_as_sent!
       @sent_at = Time.now
     end
 
+    def mark_as_unsent!
+      @sent_at = nil
+    end
+
     def sent?
       !!@sent_at
     end
+
+    def valid?
+      payload.to_json.bytesize <= MAXIMUM_PAYLOAD_SIZE
+    end
+
+    def error
+      APNSError.new(@apns_error_code) if @apns_error_code && @apns_error_code.nonzero?
+    end
+
+    private
+
+      def device_token_item
+        [1, 32, @token.gsub(/[<\s>]/, '')].pack('cnH64')
+      end
+
+      def payload_item
+        json = payload.to_json
+        [2, json.bytes.count, json].pack('cna*')
+      end
+
+      def identifier_item
+        [3, 4, @id].pack('cnN') unless @id.nil?
+      end
+
+      def expiration_item
+        [4, 4, @expiry.to_i].pack('cnN') unless @expiry.nil?
+      end
+
+      def priority_item
+        [5, 1, @priority].pack('cnc') unless @priority.nil?
+      end
   end
 end

data/lib/houston/version.rb

@@ -0,0 +1,3 @@
+module Houston
+  VERSION = '2.4.0'
+end

data/lib/houston.rb

@@ -1,7 +1,4 @@
-module Houston
-  VERSION = "0.2.4"
-end
-
+require 'houston/version'
 require 'houston/client'
 require 'houston/notification'
 require 'houston/connection'

data/spec/client_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe Houston::Client do
+  subject { Houston::Client.development }
+
+  before(:each) do
+    stub_const('Houston::Connection', MockConnection)
+  end
+
+  context '#development' do
+    subject { Houston::Client.development }
+
+    describe '#gateway_uri' do
+      subject { super().gateway_uri }
+      it { should == Houston::APPLE_DEVELOPMENT_GATEWAY_URI }
+    end
+
+    describe '#feedback_uri' do
+      subject { super().feedback_uri }
+      it { should == Houston::APPLE_DEVELOPMENT_FEEDBACK_URI }
+    end
+  end
+
+  context '#production' do
+    subject { Houston::Client.production }
+
+    describe '#gateway_uri' do
+      subject { super().gateway_uri }
+      it { should == Houston::APPLE_PRODUCTION_GATEWAY_URI }
+    end
+
+    describe '#feedback_uri' do
+      subject { super().feedback_uri }
+      it { should == Houston::APPLE_PRODUCTION_FEEDBACK_URI }
+    end
+  end
+
+  context '#new' do
+    context 'passing options through ENV' do
+      ENV['APN_GATEWAY_URI'] = 'apn://gateway.example.com'
+      ENV['APN_FEEDBACK_URI'] = 'apn://feedback.example.com'
+      ENV['APN_CERTIFICATE_PASSPHRASE'] = 'passphrase'
+      ENV['APN_TIMEOUT'] = '10.0'
+
+      subject do
+        Houston::Client.new
+      end
+
+      describe '#gateway_uri' do
+        subject { super().gateway_uri }
+        it { should == ENV['APN_GATEWAY_URI'] }
+      end
+
+      describe '#feedback_uri' do
+        subject { super().feedback_uri }
+        it { should == ENV['APN_FEEDBACK_URI'] }
+      end
+
+      describe '#certificate' do
+        subject { super().certificate }
+        it { should be_nil }
+      end
+
+      describe '#passphrase' do
+        subject { super().passphrase }
+        it { should == ENV['APN_CERTIFICATE_PASSPHRASE'] }
+      end
+
+      describe '#timeout' do
+        subject { super().timeout }
+        it { should be_a(Float) }
+        it { should == Float(ENV['APN_TIMEOUT']) }
+      end
+    end
+
+    describe '#push' do
+      it 'should accept zero arguments' do
+        expect(Houston::Client.development.push()).to be_nil()
+      end
+    end
+  end
+
+  describe '#unregistered_devices' do
+    it 'should correctly parse the feedback response and create a dictionary of unregistered devices with timestamps' do
+      expect(subject.unregistered_devices).to eq [
+        { token: 'ce8be627 2e43e855 16033e24 b4c28922 0eeda487 9c477160 b2545e95 b68b5969', timestamp: 443779200 },
+        { token: 'ce8be627 2e43e855 16033e24 b4c28922 0eeda487 9c477160 b2545e95 b68b5970', timestamp: 1388678223 }
+      ]
+    end
+  end
+
+  describe '#devices' do
+    it 'should correctly parse the feedback response and create an array of unregistered devices' do
+      expect(subject.devices).to eq [
+        'ce8be627 2e43e855 16033e24 b4c28922 0eeda487 9c477160 b2545e95 b68b5969',
+        'ce8be627 2e43e855 16033e24 b4c28922 0eeda487 9c477160 b2545e95 b68b5970'
+      ]
+    end
+  end
+end