houston 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc1f9887759e151475336ef952b607870f3b29b3
-  data.tar.gz: 1e09658a9c4177061c0e5137385779dcbee858e1
+  metadata.gz: 19ea781099fb74df316010704e9335580db3418c
+  data.tar.gz: bb5452a82ab13181e6fee98915a37799ae1dbe0d
 SHA512:
-  metadata.gz: 537b0cd3c221e84bc6b156e33eebb07d65edf5c5eb79430b4755f48ad8a7d2fd6532570619d07d12fd17d0d8861b2b64b300b297f498469cacc9cf18e42e75bd
-  data.tar.gz: 35b91cd235c889a02b2e18828f99c8ea5bcd0a3a67c85f30f69fb467466a97334676bf8365bd15df6fa518303251cc802491cc080359d4f63df91648e25bee02
+  metadata.gz: 24c557aa4a8ac29e937cc0f8c4ecccb2bd1218c3f204e3cf273d7c942646e0aa7cd7c01ddc5228ba8d6693ee46a0c65d1a732f2a8c50364ac7d452b8ca274390
+  data.tar.gz: 552d74c3ff780d5168fe3a3fda11b31e3da9292c3a13607cc8741fa088e76b4d1c52677bbbe7e40ebcd6c029ce1b7d0a2eed7341fb1525c089303fe95d467717

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    houston (1.0.0)
+    houston (2.0.0)
       commander (~> 4.1)
       json
 
@@ -12,13 +12,19 @@ GEM
       highline (~> 1.6.11)
     highline (1.6.19)
     json (1.8.1)
+    multi_json (1.8.0)
     rake (0.9.6)
     rspec (0.9.4)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   houston!
-  rake (~> 0.9)
-  rspec (~> 0.6)
+  rake
+  rspec
+  simplecov

data/README.md

@@ -60,6 +60,10 @@ connection.write(notification.message)
 connection.close
 ```
 
+## Versioning
+
+Houston 2.0 supports the new [enhanced notification format](https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/CommunicatingWIthAPS.html#//apple_ref/doc/uid/TP40008194-CH101-SW4). Support for the legacy notification format is available in 1.x releases.
+
 ## Command Line Tool
 
 Houston also comes with the `apn` binary, which provides a convenient way to test notifications from the command line.

data/houston.gemspec

@@ -16,8 +16,9 @@ Gem::Specification.new do |s|
   s.add_dependency "commander", "~> 4.1"
   s.add_dependency "json"
 
-  s.add_development_dependency "rspec", "~> 0.6"
-  s.add_development_dependency "rake",  "~> 0.9"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "simplecov"
 
   s.files         = Dir["./**/*"].reject { |file| file =~ /\.\/(bin|log|pkg|script|spec|test|vendor)/ }
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/houston/client.rb

@@ -71,7 +71,9 @@ module Houston
       end
 
       if error
-        command, status, index = error.unpack("cci")
+        command, status, index = error.unpack("ccN")
+        # status == 10 means shutdown, and the given id is the last one successfully sent
+        index += 1 if status == 10
         notifications.slice!(0..index)
         notifications.each(&:mark_as_unsent!)
         push(*notifications)

data/lib/houston/notification.rb

@@ -4,7 +4,7 @@ module Houston
   class Notification
     MAXIMUM_PAYLOAD_SIZE = 256
 
-    attr_accessor :token, :alert, :badge, :sound, :content_available, :custom_data, :id, :expiry
+    attr_accessor :token, :alert, :badge, :sound, :content_available, :custom_data, :id, :expiry, :priority
     attr_reader :sent_at
 
     alias :device :token
@@ -17,6 +17,7 @@ module Houston
       @sound = options.delete(:sound)
       @expiry = options.delete(:expiry)
       @id = options.delete(:id)
+      @priority = options.delete(:priority)
       @content_available = options.delete(:content_available)
 
       @custom_data = options
@@ -34,12 +35,12 @@ module Houston
     end
 
     def message
-      json = payload.to_json
-      device_token = [@token.gsub(/[<\s>]/, '')].pack('H*')
-      @expiry ||= Time.now + 86400
-      @id ||= 0
-
-      [1, @id, @expiry.to_i, 0, 32, device_token, 0, json.bytes.count, json].pack('ciicca*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!
@@ -57,5 +58,28 @@ module Houston
     def valid?
       payload.to_json.bytesize <= MAXIMUM_PAYLOAD_SIZE
     end
+
+    private
+    
+    def device_token_item
+      [1, 32, @token.gsub(/[<\s>]/, '')].pack('cnH*')
+    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].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

@@ -1,3 +1,3 @@
 module Houston
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
 end

data/spec/notification_spec.rb

@@ -0,0 +1,199 @@
+require 'spec_helper'
+
+describe Houston::Notification do
+  let(:notification_options) {
+    {
+      token: '<ce8be627 2e43e855 16033e24 b4c28922 0eeda487 9c477160 b2545e95 b68b5969>',
+      alert: 'Houston, we have a problem.',
+      badge: 2701,
+      sound: 'sosumi.aiff',
+      expiry: 1234567890,
+      id: 42,
+      priority: 10,
+      content_available: true,
+      # custom data
+      key1: 1,
+      key2: 'abc'
+    }
+  }
+
+  subject { Houston::Notification.new(notification_options) }
+
+  its(:token) { should == '<ce8be627 2e43e855 16033e24 b4c28922 0eeda487 9c477160 b2545e95 b68b5969>' }
+  its(:alert) { should == 'Houston, we have a problem.' }
+  its(:badge) { should == 2701 }
+  its(:sound) { should == 'sosumi.aiff' }
+  its(:expiry) { should == 1234567890 }
+  its(:id) { should == 42 }
+  its(:priority) { should == 10 }
+  its(:content_available) { should be_true }
+  its(:custom_data) { should == { key1: 1, key2: 'abc' } }
+
+  context 'using :device instead of :token' do
+    subject do
+      notification_options[:device] = notification_options[:token]
+      notification_options.delete(:token)
+      Houston::Notification.new(notification_options)
+    end
+
+    its(:device) { '<ce8be627 2e43e855 16033e24 b4c28922 0eeda487 9c477160 b2545e95 b68b5969>' }
+  end
+
+  describe '#payload' do
+    it 'should create a compliant dictionary' do
+      subject.payload.should == {
+        'aps' => {
+          'alert' => 'Houston, we have a problem.',
+          'badge' => 2701,
+          'sound' => 'sosumi.aiff',
+          'content-available' => 1
+        },
+        :key1 => 1,
+        :key2 => 'abc'
+      }
+    end
+
+    it 'should create a dictionary of only custom data and empty aps' do
+      Houston::Notification.new(key1: 123, key2: 'xyz').payload.should == {
+        'aps' => {},
+        :key1 => 123,
+        :key2 => 'xyz'
+      }
+    end
+
+    it 'should create a dictionary only with alerts' do
+      Houston::Notification.new(alert: 'Hello, World!').payload.should == {
+        'aps' => { 'alert' => 'Hello, World!' }
+      }
+    end
+
+    it 'should create a dictionary only with badges' do
+      Houston::Notification.new(badge: '123').payload.should == {
+        'aps' => { 'badge' => 123 }
+      }
+    end
+
+    it 'should create a dictionary only with sound' do
+      Houston::Notification.new(sound: 'ring.aiff').payload.should == {
+        'aps' => { 'sound' => 'ring.aiff' }
+      }
+    end
+
+    it 'should create a dictionary only with content-available' do
+      Houston::Notification.new(content_available: true).payload.should == {
+        'aps' => { 'content-available' => 1 }
+      }
+    end
+
+    it 'should allow custom data inside aps key' do
+      notification_options = { :badge => 567, 'aps' => { 'loc-key' => 'my-key' } }
+      Houston::Notification.new(notification_options).payload.should == {
+        'aps' => { 'loc-key' => 'my-key', 'badge' => 567 }
+      }
+    end
+  end
+
+  describe '#sent?' do
+    it 'should be false initially' do
+      subject.sent?.should be_false
+    end
+
+    it 'should be true after marking as sent' do
+      subject.mark_as_sent!
+      subject.sent?.should be_true
+    end
+
+    it 'should be false after marking as unsent' do
+      subject.mark_as_sent!
+      subject.mark_as_unsent!
+      subject.sent?.should be_false
+    end
+  end
+
+  describe '#message' do
+    it 'should create a message with command 2' do
+      command, _1, _2 = subject.message.unpack('cNa*')
+      command.should == 2
+    end
+
+    it 'should create a message with correct frame length' do
+      _1, length, _2 = subject.message.unpack('cNa*')
+      length.should == 182
+    end
+
+    def parse_items(items_stream)
+      items = []
+      until items_stream.empty?
+        item_id, item_length, items_stream = items_stream.unpack('cna*')
+        item_data, items_stream = items_stream.unpack("a#{item_length}a*")
+        items << [item_id, item_length, item_data]
+      end
+      items
+    end
+
+    it 'should include five items' do
+      _1, _2, items_stream = subject.message.unpack('cNa*')
+      parse_items(items_stream).should have(5).items
+    end
+
+    it 'should include an item #1 with the token as hexadecimal' do
+      _1, _2, items_stream = subject.message.unpack('cNa*')
+      items = parse_items(items_stream)
+      items.should include([1, 32, ['ce8be6272e43e85516033e24b4c289220eeda4879c477160b2545e95b68b5969'].pack('H*')])
+    end
+
+    it 'should include an item #2 with the payload as JSON' do
+      _1, _2, items_stream = subject.message.unpack('cNa*')
+      items = parse_items(items_stream)
+      items.should include([2, 126, '{"key1":1,"key2":"abc","aps":{"alert":"Houston, we have a problem.","badge":2701,"sound":"sosumi.aiff","content-available":1}}'])
+    end
+
+    it 'should include an item #3 with the identifier' do
+      _1, _2, items_stream = subject.message.unpack('cNa*')
+      items = parse_items(items_stream)
+      items.should include([3, 4, [42].pack('N')])
+    end
+
+    it 'should include an item #4 with the expiry' do
+      _1, _2, items_stream = subject.message.unpack('cNa*')
+      items = parse_items(items_stream)
+      items.should include([4, 4, [1234567890].pack('N')])
+    end
+
+    it 'should include an item #4 with the priority' do
+      _1, _2, items_stream = subject.message.unpack('cNa*')
+      items = parse_items(items_stream)
+      items.should include([5, 1, [10].pack('c')])
+    end
+
+    it 'might be missing the identifier item' do
+      notification_options.delete(:id)
+      notification = Houston::Notification.new(notification_options)
+      msg = notification.message
+      _1, _2, items_stream = notification.message.unpack('cNa*')
+      items = parse_items(items_stream)
+      items.should have(4).items
+      items.find { |item| item[0] == 3 }.should be_nil
+    end
+
+    it 'might be missing the expiry item' do
+      notification_options.delete(:expiry)
+      notification = Houston::Notification.new(notification_options)
+      msg = notification.message
+      _1, _2, items_stream = notification.message.unpack('cNa*')
+      items = parse_items(items_stream)
+      items.should have(4).items
+      items.find { |item| item[0] == 4 }.should be_nil
+    end
+
+    it 'might be missing the priority item' do
+      notification_options.delete(:priority)
+      notification = Houston::Notification.new(notification_options)
+      msg = notification.message
+      _1, _2, items_stream = notification.message.unpack('cNa*')
+      items = parse_items(items_stream)
+      items.should have(4).items
+      items.find { |item| item[0] == 5 }.should be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+unless ENV['CI']
+  require 'simplecov'
+
+  SimpleCov.start do
+    add_filter '/spec/'
+  end
+end
+
+require 'houston'
+require 'rspec'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: houston
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Mattt Thompson
@@ -42,30 +42,44 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Houston is a simple gem for sending Apple Push Notifications. Pass your
   credentials, construct your message, and send it.
 email: m@mattt.me
@@ -86,6 +100,8 @@ files:
 - ./LICENSE
 - ./Rakefile
 - ./README.md
+- spec/notification_spec.rb
+- spec/spec_helper.rb
 - bin/apn
 homepage: http://github.com/mattt/houston
 licenses:
@@ -111,4 +127,6 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Send Apple Push Notifications
-test_files: []
+test_files:
+- spec/notification_spec.rb
+- spec/spec_helper.rb