houston 2.1.0 → 2.2.0

data/houston.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.add_dependency "commander", "~> 4.1"
   s.add_dependency "json"
 
-  s.add_development_dependency "rspec", "~> 2.0"
+  s.add_development_dependency "rspec", "~> 3.0"
   s.add_development_dependency "rake"
   s.add_development_dependency "simplecov"
 

data/lib/houston/client.rb

@@ -72,6 +72,7 @@ module Houston
 
       if error
         command, status, index = error.unpack("ccN")
+        notifications[index].apns_error_code = status
         notifications.slice!(0..index)
         notifications.each(&:mark_as_unsent!)
         push(*notifications)

data/lib/houston/notification.rb

@@ -2,10 +2,28 @@ require 'json'
 
 module Houston
   class Notification
-    MAXIMUM_PAYLOAD_SIZE = 256
+    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"
+      }
+    end
+
+    MAXIMUM_PAYLOAD_SIZE = 2048
 
-    attr_accessor :token, :alert, :badge, :sound, :content_available, :custom_data, :id, :expiry, :priority
+    attr_accessor :token, :alert, :badge, :sound, :category, :content_available, :custom_data, :id, :expiry, :priority
     attr_reader :sent_at
+    attr_writer :apns_error_code
 
     alias :device :token
     alias :device= :token=
@@ -15,6 +33,7 @@ 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)
@@ -24,11 +43,13 @@ module Houston
     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
@@ -59,10 +80,14 @@ module Houston
       payload.to_json.bytesize <= MAXIMUM_PAYLOAD_SIZE
     end
 
+    def error
+      APNSError.new(APNSError::CODES[@apns_error_code]) if @apns_error_code.nonzero?
+    end
+
     private
-    
+
     def device_token_item
-      [1, 32, @token.gsub(/[<\s>]/, '')].pack('cnH*')
+      [1, 32, @token.gsub(/[<\s>]/, '')].pack('cnH64')
     end
 
     def payload_item

data/lib/houston/version.rb

@@ -1,3 +1,3 @@
 module Houston
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 end

data/spec/client_spec.rb

@@ -83,7 +83,7 @@ describe Houston::Client do
 
   describe '#unregistered_devices' do
     it 'should correctly parse the feedback response and create a dictionary of unregistered devices with timestamps' do
-      subject.unregistered_devices.should == [
+      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}
       ]
@@ -92,7 +92,7 @@ describe Houston::Client do
 
   describe '#devices' do
     it 'should correctly parse the feedback response and create an array of unregistered devices' do
-      subject.devices.should == [
+      expect(subject.devices).to eq [
         "ce8be627 2e43e855 16033e24 b4c28922 0eeda487 9c477160 b2545e95 b68b5969",
         "ce8be627 2e43e855 16033e24 b4c28922 0eeda487 9c477160 b2545e95 b68b5970"
       ]

data/spec/notification_spec.rb

@@ -11,7 +11,6 @@ describe Houston::Notification do
       id: 42,
       priority: 10,
       content_available: true,
-      # custom data
       key1: 1,
       key2: 'abc'
     }
@@ -56,7 +55,7 @@ describe Houston::Notification do
 
   describe '#content_available' do
     subject { super().content_available }
-    it { should be_true }
+    it { should be_truthy }
   end
 
   describe '#custom_data' do
@@ -86,16 +85,16 @@ describe Houston::Notification do
           'sound' => 'sosumi.aiff',
           'content-available' => 1
         },
-        :key1 => 1,
-        :key2 => 'abc'
+        'key1' => 1,
+        'key2' => 'abc'
       })
     end
 
     it 'should create a dictionary of only custom data and empty aps' do
       expect(Houston::Notification.new(key1: 123, key2: 'xyz').payload).to eq({
         'aps' => {},
-        :key1 => 123,
-        :key2 => 'xyz'
+        'key1' => 123,
+        'key2' => 'xyz'
       })
     end
 
@@ -129,22 +128,29 @@ describe Houston::Notification do
         'aps' => { 'loc-key' => 'my-key', 'badge' => 567 }
       })
     end
+
+    it 'should create notification from hash with string and symbol keys' do
+      notification_options = { :badge => 567, :aps => { 'loc-key' => 'my-key' } }
+      expect(Houston::Notification.new(notification_options).payload['aps']).to eq({
+        'loc-key' => 'my-key', 'badge' => 567
+      })
+    end
   end
 
   describe '#sent?' do
     it 'should be false initially' do
-      expect(subject.sent?).to be_false
+      expect(subject.sent?).to be_falsey
     end
 
     it 'should be true after marking as sent' do
       subject.mark_as_sent!
-      expect(subject.sent?).to be_true
+      expect(subject.sent?).to be_truthy
     end
 
     it 'should be false after marking as unsent' do
       subject.mark_as_sent!
       subject.mark_as_unsent!
-      expect(subject.sent?).to be_false
+      expect(subject.sent?).to be_falsey
     end
   end
 
@@ -198,12 +204,19 @@ describe Houston::Notification do
       expect(items).to include([4, 4, [1234567890].pack('N')])
     end
 
-    it 'should include an item #4 with the priority' do
+    it 'should include an item #5 with the priority' do
       _1, _2, items_stream = subject.message.unpack('cNa*')
       items = parse_items(items_stream)
       expect(items).to include([5, 1, [10].pack('c')])
     end
 
+    it 'should pad or truncate token so it is 32 bytes long' do
+      notification_options[:token] = '<ce8be627 2e43e855 16033e24 b4c28922>'
+      _1, _2, items_stream = subject.message.unpack('cNa*')
+      items = parse_items(items_stream)
+      expect(items).to include([1, 32, ['ce8be6272e43e85516033e24b4c2892200000000000000000000000000000000'].pack('H*')])
+    end
+
     it 'might be missing the identifier item' do
       notification_options.delete(:id)
       notification = Houston::Notification.new(notification_options)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: houston
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Mattt Thompson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-12 00:00:00.000000000 Z
+date: 2014-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +128,30 @@ files:
 - ./coverage/assets/0.7.1/smoothness/images/ui-icons_454545_256x240.png
 - ./coverage/assets/0.7.1/smoothness/images/ui-icons_888888_256x240.png
 - ./coverage/assets/0.7.1/smoothness/images/ui-icons_cd0a0a_256x240.png
+- ./coverage/assets/0.8.0/application.css
+- ./coverage/assets/0.8.0/application.js
+- ./coverage/assets/0.8.0/colorbox/border.png
+- ./coverage/assets/0.8.0/colorbox/controls.png
+- ./coverage/assets/0.8.0/colorbox/loading.gif
+- ./coverage/assets/0.8.0/colorbox/loading_background.png
+- ./coverage/assets/0.8.0/favicon_green.png
+- ./coverage/assets/0.8.0/favicon_red.png
+- ./coverage/assets/0.8.0/favicon_yellow.png
+- ./coverage/assets/0.8.0/loading.gif
+- ./coverage/assets/0.8.0/magnify.png
+- ./coverage/assets/0.8.0/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png
+- ./coverage/assets/0.8.0/smoothness/images/ui-bg_flat_75_ffffff_40x100.png
+- ./coverage/assets/0.8.0/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png
+- ./coverage/assets/0.8.0/smoothness/images/ui-bg_glass_65_ffffff_1x400.png
+- ./coverage/assets/0.8.0/smoothness/images/ui-bg_glass_75_dadada_1x400.png
+- ./coverage/assets/0.8.0/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png
+- ./coverage/assets/0.8.0/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png
+- ./coverage/assets/0.8.0/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png
+- ./coverage/assets/0.8.0/smoothness/images/ui-icons_222222_256x240.png
+- ./coverage/assets/0.8.0/smoothness/images/ui-icons_2e83ff_256x240.png
+- ./coverage/assets/0.8.0/smoothness/images/ui-icons_454545_256x240.png
+- ./coverage/assets/0.8.0/smoothness/images/ui-icons_888888_256x240.png
+- ./coverage/assets/0.8.0/smoothness/images/ui-icons_cd0a0a_256x240.png
 - ./coverage/index.html
 - ./Gemfile
 - ./Gemfile.lock