houston 0.2.4 → 2.4.0

data/spec/notification_spec.rb

@@ -0,0 +1,315 @@
+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',
+      category: 'INVITE_CATEGORY',
+      expiry: 1234567890,
+      id: 42,
+      priority: 10,
+      content_available: true,
+      key1: 1,
+      key2: 'abc',
+      url_args: %w[boarding A998],
+      thread_id: 'notify-team-ios'
+    }
+  }
+
+  subject { Houston::Notification.new(notification_options) }
+
+  describe '#token' do
+    subject { super().token }
+    it { should == '<ce8be627 2e43e855 16033e24 b4c28922 0eeda487 9c477160 b2545e95 b68b5969>' }
+  end
+
+  describe '#alert' do
+    subject { super().alert }
+    it { should == 'Houston, we have a problem.' }
+  end
+
+  describe '#badge' do
+    subject { super().badge }
+    it { should == 2701 }
+  end
+
+  describe '#sound' do
+    subject { super().sound }
+    it { should == 'sosumi.aiff' }
+  end
+
+  describe '#category' do
+    subject { super().category }
+    it { should == 'INVITE_CATEGORY' }
+  end
+
+  describe '#expiry' do
+    subject { super().expiry }
+    it { should == 1234567890 }
+  end
+
+  describe '#id' do
+    subject { super().id }
+    it { should == 42 }
+  end
+
+  describe '#priority' do
+    subject { super().priority }
+    it { should == 10 }
+  end
+
+  describe '#content_available' do
+    subject { super().content_available }
+    it { should be_truthy }
+  end
+
+  describe '#custom_data' do
+    subject { super().custom_data }
+    it { should == { key1: 1, key2: 'abc' } }
+  end
+
+  describe '#url_args' do
+    subject { super().url_args }
+    it { should == %w[boarding A998] }
+  end
+
+  describe '#thread_id' do
+    subject { super().thread_id }
+    it { should == 'notify-team-ios' }
+  end
+
+  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
+
+    describe '#device' do
+      subject { super().device }
+      it { should == '<ce8be627 2e43e855 16033e24 b4c28922 0eeda487 9c477160 b2545e95 b68b5969>' }
+    end
+  end
+
+  describe '#payload' do
+    it 'should create a compliant dictionary' do
+      expect(subject.payload).to eq(
+        'aps' => {
+          'alert' => 'Houston, we have a problem.',
+          'badge' => 2701,
+          'sound' => 'sosumi.aiff',
+          'category' => 'INVITE_CATEGORY',
+          'content-available' => 1,
+          'url-args' => %w[boarding A998],
+          'thread-id' => 'notify-team-ios'
+        },
+        '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'
+      )
+    end
+
+    it 'should create a dictionary only with alerts' do
+      expect(Houston::Notification.new(alert: 'Hello, World!').payload).to eq(
+        'aps' => { 'alert' => 'Hello, World!' }
+      )
+    end
+
+    it 'should create a dictionary only with badges' do
+      expect(Houston::Notification.new(badge: '123').payload).to eq(
+        'aps' => { 'badge' => 123 }
+      )
+    end
+
+    it 'should create a dictionary only with sound' do
+      expect(Houston::Notification.new(sound: 'ring.aiff').payload).to eq(
+        'aps' => { 'sound' => 'ring.aiff' }
+      )
+    end
+
+    it 'should create a dictionary only with category' do
+      expect(Houston::Notification.new(category: 'INVITE_CATEGORY').payload).to eq(
+        'aps' => { 'category' => 'INVITE_CATEGORY' }
+      )
+    end
+
+    it 'should create a dictionary only with content-available' do
+      expect(Houston::Notification.new(content_available: true).payload).to eq(
+        'aps' => { 'content-available' => 1 }
+      )
+    end
+
+    it 'should create a dictionary only with mutable-content' do
+        expect(Houston::Notification.new(mutable_content: true).payload).to eq(
+          'aps' => { 'mutable-content' => 1 }
+        )
+    end
+
+    it 'should create a dictionary only with thread-id' do
+      expect(Houston::Notification.new(thread_id: 'notify-ios-team').payload).to eq(
+          'aps' => { 'thread-id' => 'notify-ios-team' }
+       )
+    end
+
+    it 'should allow custom data inside aps key' do
+      notification_options = { :badge => 567, 'aps' => { 'loc-key' => 'my-key' } }
+      expect(Houston::Notification.new(notification_options).payload).to eq(
+        '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_falsey
+    end
+
+    it 'should be true after marking as sent' do
+      subject.mark_as_sent!
+      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_falsey
+    end
+  end
+
+  describe '#message' do
+    it 'should create a message with command 2' do
+      command, _1, _2 = subject.message.unpack('cNa*')
+      expect(command).to eq(2)
+    end
+
+    it 'should create a message with correct frame length' do
+      _1, length, _2 = subject.message.unpack('cNa*')
+      expect(length).to eq(272)
+    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*')
+      expect(parse_items(items_stream).size).to eq(5)
+    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)
+      expect(items).to 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)
+      expect(items).to include([2, 216, '{"key1":1,"key2":"abc","aps":{"alert":"Houston, we have a problem.","badge":2701,"sound":"sosumi.aiff","category":"INVITE_CATEGORY","content-available":1,"url-args":["boarding","A998"],"thread-id":"notify-team-ios"}}'])
+    end
+
+    it 'should include an item #3 with the identifier' do
+      _1, _2, items_stream = subject.message.unpack('cNa*')
+      items = parse_items(items_stream)
+      expect(items).to 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)
+      expect(items).to include([4, 4, [1234567890].pack('N')])
+    end
+
+    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)
+      msg = notification.message
+      _1, _2, items_stream = notification.message.unpack('cNa*')
+      items = parse_items(items_stream)
+      expect(items.size).to eq(4)
+      expect(items.find { |item| item[0] == 3 }).to 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)
+      expect(items.size).to eq(4)
+      expect(items.find { |item| item[0] == 4 }).to 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)
+      expect(items.size).to eq(4)
+      expect(items.find { |item| item[0] == 5 }).to be_nil
+    end
+  end
+
+  describe '#error' do
+    context 'a status code has been set' do
+      it 'returns an error object mapped to that status code' do
+        status_code = 1
+        notification = Houston::Notification.new(notification_options)
+        notification.apns_error_code = status_code
+        expect(notification.error.message).to eq(Houston::Notification::APNSError::CODES[status_code])
+      end
+    end
+
+    context 'a status code has been set to 0' do
+      it 'returns nil' do
+        status_code = 0
+        notification = Houston::Notification.new(notification_options)
+        notification.apns_error_code = status_code
+        expect(notification.error).to be_nil
+      end
+    end
+
+    context 'a status code has not been set' do
+      it 'returns nil' do
+        notification = Houston::Notification.new(notification_options)
+        expect(notification.error).to be_nil
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+unless ENV['CI']
+  require 'simplecov'
+
+  SimpleCov.start do
+    add_filter '/spec/'
+  end
+end
+
+require 'houston'
+require 'rspec'
+
+class MockConnection
+  class << self
+    def open(uri, certificate, passphrase)
+      yield self.new
+    end
+  end
+
+  def initialize
+    @unregistered_devices = [
+      [443779200, 32, 'ce8be6272e43e85516033e24b4c289220eeda4879c477160b2545e95b68b5969'],
+      [1388678223, 32, 'ce8be6272e43e85516033e24b4c289220eeda4879c477160b2545e95b68b5970']
+    ]
+  end
+
+  def read(bytes)
+    return nil if @unregistered_devices.empty?
+
+    @unregistered_devices.shift.pack('N1n1H*')
+  end
+end

metadata

@@ -1,71 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: houston
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 2.4.0
 platform: ruby
 authors:
 - Mattt Thompson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-30 00:00:00.000000000 Z
+date: 2018-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.4'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '3.5'
 - !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
@@ -74,19 +88,89 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ./apple_push_notification_production.pem
-- ./Gemfile
-- ./Gemfile.lock
-- ./houston.gemspec
-- ./lib/houston/client.rb
-- ./lib/houston/connection.rb
-- ./lib/houston/notification.rb
-- ./lib/houston.rb
-- ./LICENSE
-- ./Rakefile
-- ./README.md
+- "./Gemfile"
+- "./Gemfile.lock"
+- "./LICENSE"
+- "./README.md"
+- "./Rakefile"
+- "./coverage/assets/0.7.1/application.css"
+- "./coverage/assets/0.7.1/application.js"
+- "./coverage/assets/0.7.1/fancybox/blank.gif"
+- "./coverage/assets/0.7.1/fancybox/fancy_close.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_loading.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_nav_left.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_nav_right.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_shadow_e.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_shadow_n.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_shadow_ne.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_shadow_nw.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_shadow_s.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_shadow_se.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_shadow_sw.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_shadow_w.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_title_left.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_title_main.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_title_over.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_title_right.png"
+- "./coverage/assets/0.7.1/fancybox/fancybox-x.png"
+- "./coverage/assets/0.7.1/fancybox/fancybox-y.png"
+- "./coverage/assets/0.7.1/fancybox/fancybox.png"
+- "./coverage/assets/0.7.1/favicon_green.png"
+- "./coverage/assets/0.7.1/favicon_red.png"
+- "./coverage/assets/0.7.1/favicon_yellow.png"
+- "./coverage/assets/0.7.1/loading.gif"
+- "./coverage/assets/0.7.1/magnify.png"
+- "./coverage/assets/0.7.1/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png"
+- "./coverage/assets/0.7.1/smoothness/images/ui-bg_flat_75_ffffff_40x100.png"
+- "./coverage/assets/0.7.1/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png"
+- "./coverage/assets/0.7.1/smoothness/images/ui-bg_glass_65_ffffff_1x400.png"
+- "./coverage/assets/0.7.1/smoothness/images/ui-bg_glass_75_dadada_1x400.png"
+- "./coverage/assets/0.7.1/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png"
+- "./coverage/assets/0.7.1/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png"
+- "./coverage/assets/0.7.1/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png"
+- "./coverage/assets/0.7.1/smoothness/images/ui-icons_222222_256x240.png"
+- "./coverage/assets/0.7.1/smoothness/images/ui-icons_2e83ff_256x240.png"
+- "./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"
+- "./houston-2.2.2.gem"
+- "./houston-2.2.3.gem"
+- "./houston.gemspec"
+- "./lib/houston.rb"
+- "./lib/houston/client.rb"
+- "./lib/houston/connection.rb"
+- "./lib/houston/notification.rb"
+- "./lib/houston/version.rb"
 - bin/apn
-homepage: http://github.com/mattt/houston
+- spec/client_spec.rb
+- spec/notification_spec.rb
+- spec/spec_helper.rb
+homepage: http://nomad-cli.com
 licenses:
 - MIT
 metadata: {}
@@ -96,18 +180,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Send Apple Push Notifications
-test_files: []
+test_files:
+- spec/client_spec.rb
+- spec/notification_spec.rb
+- spec/spec_helper.rb