grocer 0.3.3 → 0.3.4

data/CHANGELOG.md

@@ -1,8 +1,16 @@
 # CHANGELOG
 
+## 0.3.4
+
+* Add `Grocer::MobileDeviceManagementNotification` to send PushMagic tokens.
+  ([Osis](https://github.com/Osis))
+* Fix `Grocer::NewsstandNotification` payload
+  ([khelll](https://github.com/khelll))
+
 ## 0.3.3
 
-* Notifications that only include a custom payload are now valid. ([overlycommonname](https://github.com/overlycommonname))
+* Notifications that only include a custom payload are now valid.
+  ([overlycommonname](https://github.com/overlycommonname))
 
 ## 0.3.2
 

data/lib/grocer/mobile_device_management_notification.rb

@@ -0,0 +1,25 @@
+require 'grocer/notification'
+
+module Grocer
+  # Public: A specialized form of a Grocer::Notification which only requires a
+  # `push_magic` and `device_token` to be present in the payload.
+  #
+  # Examples
+  #
+  #   Grocer::MobileDeviceManagementNotification.new(device_token: '...', push_magic: '...')
+  class MobileDeviceManagementNotification < Notification
+    attr_accessor :push_magic
+
+    private
+
+    def payload_hash
+      { mdm: push_magic }
+    end
+
+    def validate_payload
+      fail NoPayloadError unless push_magic
+      fail InvalidFormatError if alert || badge || custom
+      fail PayloadTooLargeError if payload_too_large?
+    end
+  end
+end

data/lib/grocer/newsstand_notification.rb

@@ -8,6 +8,7 @@ module Grocer
   # Examples
   #
   #   Grocer::NewsstandNotification.new(device_token: '...')
+  #     #=> { aps: { 'content-available' => 1 } }
   class NewsstandNotification < Notification
 
     private
@@ -15,9 +16,9 @@ module Grocer
     def validate_payload
       true
     end
-    
+
     def payload_hash
-      { "content-available" => 1 }
+      { aps: {'content-available' => 1} }
     end
 
   end

data/lib/grocer/version.rb

@@ -1,3 +1,3 @@
 module Grocer
-  VERSION = '0.3.3'
+  VERSION = '0.3.4'
 end

data/spec/grocer/mobile_device_management_notification_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'grocer/mobile_device_management_notification'
+require 'grocer/shared_examples_for_notifications'
+
+describe Grocer::MobileDeviceManagementNotification do
+  let(:payload_from_bytes) { notification.to_bytes[45..-1] }
+  let(:payload_dictionary_from_bytes) { JSON.parse(payload_from_bytes, symbolize_names: true) }
+
+  describe 'binary format' do
+    let(:payload_options) { Hash[:push_magic, "00000000-1111-3333-4444-555555555555"] }
+
+    include_examples 'a notification'
+
+    it 'should have a single key in the payload' do
+      expect(payload_dictionary_from_bytes.length).to eq(1)
+    end
+
+    it 'does require a mdm payload' do
+      expect(payload_dictionary_from_bytes[:'mdm']).to_not be_nil
+    end
+  end
+
+  describe 'no push magic specified' do
+    let(:notification) { Grocer::MobileDeviceManagementNotification.new(device_token: "token", alert: "Moo") }
+
+    it 'should raise a payload error' do
+      -> { notification.to_bytes }.should raise_error(Grocer::NoPayloadError)
+    end
+  end
+
+  describe 'aps object is included in the payload' do
+    let(:notification) { Grocer::MobileDeviceManagementNotification.new(device_token: "token", push_magic: "00000000-1111-3333-4444-555555555555", alert: "test") }
+
+    it 'should raise a format error' do
+      -> { payload_dictionary_from_bytes }.should raise_error(Grocer::InvalidFormatError)
+    end
+  end
+end

data/spec/grocer/newsstand_notification_spec.rb

@@ -5,18 +5,16 @@ require 'grocer/shared_examples_for_notifications'
 describe Grocer::NewsstandNotification do
   describe 'binary format' do
     let(:payload_options) { Hash.new }
-    let(:payload_from_bytes) { notification.to_bytes[45..-1] }
-    let(:payload_dictionary_from_bytes) { JSON.parse(payload_from_bytes, symbolize_names: true) }
+    let(:payload) { payload_hash(notification) }
 
     include_examples 'a notification'
 
-    it 'does require a payload' do
-      expect(payload_dictionary_from_bytes[:'content-available']).to_not be_nil
+    it 'requires a payload' do
+      expect(payload[:aps]).to_not be_empty
     end
 
-    it 'has a content-available hash' do
-      expect(payload_dictionary_from_bytes[:'content-available']).to eq(1)
+    it 'encodes content-available as part of the payload' do
+      expect(payload[:aps][:'content-available']).to eq(1)
     end
-
   end
 end

data/spec/grocer/notification_spec.rb

@@ -6,44 +6,43 @@ require 'grocer/shared_examples_for_notifications'
 describe Grocer::Notification do
   describe 'binary format' do
     let(:payload_options) { { alert: 'hi', badge: 2, sound: 'siren.aiff' } }
-    let(:payload_dictionary_from_bytes) { JSON.parse(payload_from_bytes, symbolize_names: true) }
-    let(:payload_from_bytes) { notification.to_bytes[45..-1] }
+    let(:payload) { payload_hash(notification) }
 
     include_examples 'a notification'
 
     it 'encodes alert as part of the payload' do
       notification.alert = 'Hello World!'
-      expect(payload_dictionary_from_bytes[:aps][:alert]).to eq('Hello World!')
+      expect(payload[:aps][:alert]).to eq('Hello World!')
     end
 
     it 'encodes badge as part of the payload' do
       notification.badge = 42
-      expect(payload_dictionary_from_bytes[:aps][:badge]).to eq(42)
+      expect(payload[:aps][:badge]).to eq(42)
     end
 
     it 'encodes sound as part of the payload' do
       notification.sound = 'siren.aiff'
-      expect(payload_dictionary_from_bytes[:aps][:sound]).to eq('siren.aiff')
+      expect(payload[:aps][:sound]).to eq('siren.aiff')
     end
 
     it 'encodes custom payload attributes' do
       notification.custom = { :foo => 'bar' }
-      expect(payload_dictionary_from_bytes[:foo]).to eq('bar')
+      expect(payload[:foo]).to eq('bar')
     end
 
     it 'encodes UTF-8 characters' do
       notification.alert = '私'
-      expect(payload_dictionary_from_bytes[:aps][:alert].force_encoding("UTF-8")).to eq('私')
+      expect(payload[:aps][:alert].force_encoding("UTF-8")).to eq('私')
     end
 
     it 'encodes the payload length' do
       notification.alert = 'Hello World!'
-      expect(bytes[43...45]).to eq([payload_from_bytes.bytesize].pack('n'))
+      expect(bytes[43...45]).to eq([payload_bytes(notification).bytesize].pack('n'))
     end
 
     it 'encodes the payload length correctly for multibyte UTF-8 strings' do
       notification.alert = '私'
-      expect(bytes[43...45]).to eq([payload_from_bytes.bytesize].pack('n'))
+      expect(bytes[43...45]).to eq([payload_bytes(notification).bytesize].pack('n'))
     end
 
     context 'missing payload' do

data/spec/grocer/passbook_notification_spec.rb

@@ -5,13 +5,11 @@ require 'grocer/shared_examples_for_notifications'
 describe Grocer::PassbookNotification do
   describe 'binary format' do
     let(:payload_options) { Hash.new }
-    let(:payload_dictionary_from_bytes) { JSON.parse(payload_from_bytes, symbolize_names: true) }
-    let(:payload_from_bytes) { notification.to_bytes[45..-1] }
 
     include_examples 'a notification'
 
     it 'does not require a payload' do
-      expect(payload_dictionary_from_bytes[:aps]).to be_empty
+      expect(payload_hash(notification)[:aps]).to be_empty
     end
 
     it 'encodes the payload length' do

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 ENV['RACK_ENV'] = 'test'
 require 'mocha/api'
 require 'bourne'
+require 'support/notification_helpers'
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
@@ -8,4 +9,6 @@ RSpec.configure do |config|
   config.filter_run :focus
 
   config.mock_with :mocha
+
+  config.include NotificationHelpers
 end

data/spec/support/notification_helpers.rb

@@ -0,0 +1,9 @@
+module NotificationHelpers
+  def payload_hash(notification)
+    JSON.parse(payload_bytes(notification), symbolize_names: true)
+  end
+
+  def payload_bytes(notification)
+    notification.to_bytes[45..-1]
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grocer
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-12 00:00:00.000000000 Z
+date: 2013-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -122,6 +122,7 @@ files:
 - lib/grocer/failed_delivery_attempt.rb
 - lib/grocer/feedback.rb
 - lib/grocer/feedback_connection.rb
+- lib/grocer/mobile_device_management_notification.rb
 - lib/grocer/newsstand_notification.rb
 - lib/grocer/notification.rb
 - lib/grocer/notification_reader.rb
@@ -143,6 +144,7 @@ files:
 - spec/grocer/failed_delivery_attempt_spec.rb
 - spec/grocer/feedback_connection_spec.rb
 - spec/grocer/feedback_spec.rb
+- spec/grocer/mobile_device_management_notification_spec.rb
 - spec/grocer/newsstand_notification_spec.rb
 - spec/grocer/notification_reader_spec.rb
 - spec/grocer/notification_spec.rb
@@ -155,6 +157,7 @@ files:
 - spec/grocer/ssl_server_spec.rb
 - spec/grocer_spec.rb
 - spec/spec_helper.rb
+- spec/support/notification_helpers.rb
 homepage: https://github.com/grocer/grocer
 licenses:
 - MIT
@@ -170,7 +173,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 215139925189749573
+      hash: -4490716643818473019
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -179,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 215139925189749573
+      hash: -4490716643818473019
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -195,6 +198,7 @@ test_files:
 - spec/grocer/failed_delivery_attempt_spec.rb
 - spec/grocer/feedback_connection_spec.rb
 - spec/grocer/feedback_spec.rb
+- spec/grocer/mobile_device_management_notification_spec.rb
 - spec/grocer/newsstand_notification_spec.rb
 - spec/grocer/notification_reader_spec.rb
 - spec/grocer/notification_spec.rb
@@ -207,3 +211,4 @@ test_files:
 - spec/grocer/ssl_server_spec.rb
 - spec/grocer_spec.rb
 - spec/spec_helper.rb
+- spec/support/notification_helpers.rb