grocer 0.3.1 → 0.3.2

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.3.2
+
+* Validate the size of the payload before sending a notification
+
 ## 0.3.1
 
 * Move repo to the Grocer organization.

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://api.travis-ci.org/grocer/grocer.png?branch=master)](https://travis-ci.org/grocer/grocer)
 [![Dependency Status](https://gemnasium.com/grocer/grocer.png)](https://gemnasium.com/grocer/grocer)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/grocer/grocer)
+[![Code Climate](https://codeclimate.com/github/grocer/grocer.png)](https://codeclimate.com/github/grocer/grocer)
 
 **grocer** interfaces with the [Apple Push Notification
 Service](http://developer.apple.com/library/mac/#documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/ApplePushService/ApplePushService.html)
@@ -118,11 +118,22 @@ send any payload for a Passbook notification. If you do, it will be ignored.
 
 ```ruby
 notification = Grocer::PassbookNotification.new(device_token: "...")
-
 # Generates a JSON payload like:
 # {"aps": {}}
 ```
 
+#### Newsstand Notifications
+
+Grocer also supports the special Newsstand 'content-available' notification. `Grocer::NewsstandNotification` can be
+used for this. Like `Grocer::PassbookNotification`, it is a specialized kind of notification which does not require
+any payload. Likewise, anything you add to it will be ignored.
+
+```ruby
+notification = Grocer::NewsstandNotification.new(device_token: "...")
+# Generates a JSON payload like:
+# {"aps": {"content-available":1}}
+````
+
 ### Feedback
 
 ```ruby
@@ -137,7 +148,7 @@ feedback = Grocer.feedback(
 )
 
 feedback.each do |attempt|
-  puts "Device #{attempt.device_token} failed at #{attempt.timestamp}
+  puts "Device #{attempt.device_token} failed at #{attempt.timestamp}"
 end
 ```
 

data/lib/grocer/connection.rb

@@ -1,7 +1,4 @@
 require 'grocer'
-require 'grocer/no_gateway_error'
-require 'grocer/no_port_error'
-require 'grocer/certificate_expired_error'
 require 'grocer/ssl_connection'
 
 module Grocer

data/lib/grocer/failed_delivery_attempt.rb

@@ -1,5 +1,3 @@
-require 'grocer/invalid_format_error'
-
 module Grocer
   class FailedDeliveryAttempt
     LENGTH = 38

data/lib/grocer/newsstand_notification.rb

@@ -0,0 +1,24 @@
+require 'grocer/notification'
+
+module Grocer
+  # Public: A specialized form of a Grocer::Notification which requires neither
+  # an alert nor badge to be present in the payload. It requires only the
+  # `device_token` to be set.
+  #
+  # Examples
+  #
+  #   Grocer::NewsstandNotification.new(device_token: '...')
+  class NewsstandNotification < Notification
+
+    private
+
+    def validate_payload
+      true
+    end
+    
+    def payload_hash
+      { "content-available" => 1 }
+    end
+
+  end
+end

data/lib/grocer/notification.rb

@@ -1,9 +1,10 @@
 require 'json'
-require 'grocer/no_payload_error'
 
 module Grocer
   # Public: An object used to send notifications to APNS.
   class Notification
+    MAX_PAYLOAD_SIZE = 256
+
     attr_accessor :identifier, :expiry, :device_token, :alert, :badge, :sound,
                   :custom
 
@@ -41,8 +42,13 @@ module Grocer
 
     private
 
+    def payload_too_large?
+      encoded_payload.bytesize > MAX_PAYLOAD_SIZE
+    end
+
     def validate_payload
       fail NoPayloadError unless alert || badge
+      fail PayloadTooLargeError if payload_too_large?
     end
 
     def encoded_payload

data/lib/grocer/version.rb

@@ -1,3 +1,3 @@
 module Grocer
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

data/lib/grocer.rb

@@ -1,6 +1,7 @@
 require 'grocer/feedback'
 require 'grocer/notification'
 require 'grocer/passbook_notification'
+require 'grocer/newsstand_notification'
 require 'grocer/feedback_connection'
 require 'grocer/push_connection'
 require 'grocer/pusher'
@@ -8,6 +9,13 @@ require 'grocer/version'
 require 'grocer/server'
 
 module Grocer
+  Error = Class.new(::StandardError)
+  InvalidFormatError = Class.new(Error)
+  NoGatewayError = Class.new(Error)
+  NoPayloadError = Class.new(Error)
+  NoPortError = Class.new(Error)
+  PayloadTooLargeError = Class.new(Error)
+  CertificateExpiredError = Module.new
 
   def self.env
     ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'

data/spec/grocer/newsstand_notification_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'grocer/newsstand_notification'
+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) }
+
+    include_examples 'a notification'
+
+    it 'does require a payload' do
+      expect(payload_dictionary_from_bytes[:'content-available']).to_not be_nil
+    end
+
+    it 'has a content-available hash' do
+      expect(payload_dictionary_from_bytes[:'content-available']).to eq(1)
+    end
+
+  end
+end

data/spec/grocer/notification_spec.rb

@@ -46,12 +46,20 @@ describe Grocer::Notification do
       expect(bytes[43...45]).to eq([payload_from_bytes.bytesize].pack('n'))
     end
 
-    context 'invalid payload' do
+    context 'missing payload' do
       let(:payload_options) { Hash.new }
 
       it 'raises an error when neither alert nor badge is specified' do
         -> { notification.to_bytes }.should raise_error(Grocer::NoPayloadError)
       end
     end
+
+    context 'oversized payload' do
+      let(:payload_options) { { alert: 'a' * (Grocer::Notification::MAX_PAYLOAD_SIZE + 1) } }
+
+      it 'raises an error when the size of the payload in bytes is too large' do
+        -> { notification.to_bytes }.should raise_error(Grocer::PayloadTooLargeError)
+      end
+    end
   end
 end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: grocer
 version: !ruby/object:Gem::Version
+  version: 0.3.2
   prerelease: 
-  version: 0.3.1
 platform: ruby
 authors:
 - Andy Lindeman
@@ -11,88 +11,88 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-05 00:00:00.000000000 Z
+date: 2013-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.11'
-    none: false
-  name: rspec
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.11'
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.8
-    none: false
-  name: pry
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.8
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  name: mocha
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: bourne
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  name: bourne
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  name: rake
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
 description: ! "                          Grocer interfaces with the Apple Push\n
   \                         Notification Service to send push\n                          notifications
   to iOS devices and collect\n                          notification feedback via
@@ -117,16 +117,12 @@ files:
 - Rakefile
 - grocer.gemspec
 - lib/grocer.rb
-- lib/grocer/certificate_expired_error.rb
 - lib/grocer/connection.rb
 - lib/grocer/extensions/deep_symbolize_keys.rb
 - lib/grocer/failed_delivery_attempt.rb
 - lib/grocer/feedback.rb
 - lib/grocer/feedback_connection.rb
-- lib/grocer/invalid_format_error.rb
-- lib/grocer/no_gateway_error.rb
-- lib/grocer/no_payload_error.rb
-- lib/grocer/no_port_error.rb
+- lib/grocer/newsstand_notification.rb
 - lib/grocer/notification.rb
 - lib/grocer/notification_reader.rb
 - lib/grocer/passbook_notification.rb
@@ -147,6 +143,7 @@ files:
 - spec/grocer/failed_delivery_attempt_spec.rb
 - spec/grocer/feedback_connection_spec.rb
 - spec/grocer/feedback_spec.rb
+- spec/grocer/newsstand_notification_spec.rb
 - spec/grocer/notification_reader_spec.rb
 - spec/grocer/notification_spec.rb
 - spec/grocer/passbook_notification_spec.rb
@@ -166,17 +163,23 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
+      segments:
+      - 0
+      hash: -399715243168588084
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
+      segments:
+      - 0
+      hash: -399715243168588084
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -192,6 +195,7 @@ test_files:
 - spec/grocer/failed_delivery_attempt_spec.rb
 - spec/grocer/feedback_connection_spec.rb
 - spec/grocer/feedback_spec.rb
+- spec/grocer/newsstand_notification_spec.rb
 - spec/grocer/notification_reader_spec.rb
 - spec/grocer/notification_spec.rb
 - spec/grocer/passbook_notification_spec.rb
@@ -203,4 +207,3 @@ test_files:
 - spec/grocer/ssl_server_spec.rb
 - spec/grocer_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/lib/grocer/certificate_expired_error.rb

@@ -1,3 +0,0 @@
-module Grocer
-  CertificateExpiredError = Module.new
-end

data/lib/grocer/invalid_format_error.rb

@@ -1,4 +0,0 @@
-module Grocer
-  class InvalidFormatError < StandardError
-  end
-end

data/lib/grocer/no_gateway_error.rb

@@ -1,4 +0,0 @@
-module Grocer
-  class NoGatewayError < StandardError
-  end
-end

data/lib/grocer/no_payload_error.rb

@@ -1,4 +0,0 @@
-module Grocer
-  class NoPayloadError < StandardError
-  end
-end

data/lib/grocer/no_port_error.rb

@@ -1,4 +0,0 @@
-module Grocer
-  class NoPortError < StandardError
-  end
-end