grocer 0.3.4 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d758bbd299d221fe50d6a3b9d736dce0ae5016fb
+  data.tar.gz: f29ab31ea4fd92da51b624c84172578354e96246
+SHA512:
+  metadata.gz: 8fea57524b210a9c547f6efcb17f775210cc591e1d04a904828fa9ac4d388aa0d4b31bc2a74f8b025b9d48f29618ec59f6b0deb5ee3ee2a789d1b4e47c68dece
+  data.tar.gz: 642f3a3612148d4a721f4bcc554aa9168e89eb0adb5ffbd4a6b9fc35e14187c1143306577a49b223e642caa6be9d1833bbc1bfd355463d97dbc06cbf22ca06ee

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
   - 1.9.2
   - 1.9.3
+  - 2.0.0
   - jruby-19mode # JRuby 1.7.0
   - rbx-19mode
   # - ruby-head  # seems unstable on travis at this time

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## Unreleased
+
+## 0.4.0
+
+* Add support for `content-available` for background fetches (iOS 7) for all
+  types of Notifications ([Zack Parker](https://github.com/somezack))
+
 ## 0.3.4
 
 * Add `Grocer::MobileDeviceManagementNotification` to send PushMagic tokens.

data/README.md

@@ -69,12 +69,13 @@ pusher = Grocer.pusher(
 #
 # Information on obtaining `device_token` is shown later.
 notification = Grocer::Notification.new(
-  device_token: "fe15a27d5df3c34778defb1f4f3880265cc52c0c047682223be59fb68500a9a2",
-  alert:        "Hello from Grocer!",
-  badge:        42,
-  sound:        "siren.aiff",         # optional
-  expiry:       Time.now + 60*60,     # optional; 0 is default, meaning the message is not stored
-  identifier:   1234                  # optional
+  device_token:      "fe15a27d5df3c34778defb1f4f3880265cc52c0c047682223be59fb68500a9a2",
+  alert:             "Hello from Grocer!",
+  badge:             42,
+  sound:             "siren.aiff",         # optional
+  expiry:            Time.now + 60*60,     # optional; 0 is default, meaning the message is not stored
+  identifier:        1234,                 # optional
+  content_available: true                  # optional; any truthy value will set 'content-available' to 1
 )
 
 pusher.push(notification)
@@ -143,7 +144,7 @@ feedback = Grocer.feedback(
   certificate: "/path/to/cert.pem",       # required
   passphrase:  "",                        # optional
   gateway:     "feedback.push.apple.com", # optional; See note below.
-  port:        2196                       # optional
+  port:        2196,                      # optional
   retries:     3                          # optional
 )
 
@@ -252,3 +253,11 @@ openssl pkcs12 -in exported_certificate.p12 -out certificate.pem -nodes -clcerts
 ```
 
 The `certificate.pem` file that is generated can be used with **grocer**.
+
+## Support Channels
+
+[GitHub Issues](https://github.com/grocer/grocer/issues) and [Pull
+Requests](https://github.com/grocer/grocer/pulls) are the primary venues for
+communicating issues and discussing possible features. Several of us also
+regularly hang out in the `#grocer` channel on Freenode; feel free to pop in
+and ask questions there as well. Thanks! :heart:

data/lib/grocer/error_response.rb

@@ -0,0 +1,33 @@
+module Grocer
+  class ErrorResponse
+    STATUS_CODE_DESCRIPTIONS = {
+      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',
+      256 => 'None (unknown)',
+    }
+
+    COMMAND = 8
+
+    attr_accessor :status_code, :identifier
+
+    def initialize(binary_tuple)
+      # C => 1 byte command
+      # C => 1 byte status
+      # N => 4 byte identifier
+      command, @status_code, @identifier = binary_tuple.unpack('CCN')
+      raise InvalidFormatError unless @status_code && @identifier
+      raise InvalidCommandError unless command == COMMAND
+    end
+
+    def status
+      STATUS_CODE_DESCRIPTIONS[status_code]
+    end
+  end
+end

data/lib/grocer/newsstand_notification.rb

@@ -11,15 +11,15 @@ module Grocer
   #     #=> { aps: { 'content-available' => 1 } }
   class NewsstandNotification < Notification
 
+    def initialize(payload = {})
+      super(payload.merge(content_available: true))
+    end
+
     private
 
     def validate_payload
       true
     end
 
-    def payload_hash
-      { aps: {'content-available' => 1} }
-    end
-
   end
 end

data/lib/grocer/notification.rb

@@ -4,19 +4,21 @@ module Grocer
   # Public: An object used to send notifications to APNS.
   class Notification
     MAX_PAYLOAD_SIZE = 256
+    CONTENT_AVAILABLE_INDICATOR = 1
 
-    attr_accessor :identifier, :expiry, :device_token, :alert, :badge, :sound,
-                  :custom
+    attr_accessor :identifier, :expiry, :device_token
+    attr_reader :alert, :badge, :custom, :sound, :content_available
 
     # Public: Initialize a new Grocer::Notification. You must specify at least an `alert` or `badge`.
     #
     # payload - The Hash of notification parameters and payload to be sent to APNS.:
-    #           :device_token - The String representing to device token sent to APNS.
-    #           :alert        - The String or Hash to be sent as the alert portion of the payload. (optional)
-    #           :badge        - The Integer to be sent as the badge portion of the payload. (optional)
-    #           :sound        - The String representing the sound portion of the payload. (optional)
-    #           :expiry       - The Integer representing UNIX epoch date sent to APNS as the notification expiry. (default: 0)
-    #           :identifier   - The arbitrary value sent to APNS to uniquely this notification. (default: 0)
+    #           :device_token      - The String representing to device token sent to APNS.
+    #           :alert             - The String or Hash to be sent as the alert portion of the payload. (optional)
+    #           :badge             - The Integer to be sent as the badge portion of the payload. (optional)
+    #           :sound             - The String representing the sound portion of the payload. (optional)
+    #           :expiry            - The Integer representing UNIX epoch date sent to APNS as the notification expiry. (default: 0)
+    #           :identifier        - The arbitrary Integer sent to APNS to uniquely this notification. (default: 0)
+    #           :content_available - The truthy or falsy value indicating the availability of new content for background fetch. (optional)
     def initialize(payload = {})
       @identifier = 0
 
@@ -27,7 +29,6 @@ module Grocer
 
     def to_bytes
       validate_payload
-      payload = encoded_payload
 
       [
         1,
@@ -35,24 +36,46 @@ module Grocer
         expiry_epoch_time,
         device_token_length,
         sanitized_device_token,
-        payload.bytesize,
-        payload
+        encoded_payload.bytesize,
+        encoded_payload
       ].pack('CNNnH64nA*')
     end
 
-    private
+    def alert=(alert)
+      @alert = alert
+      @encoded_payload = nil
+    end
 
-    def payload_too_large?
-      encoded_payload.bytesize > MAX_PAYLOAD_SIZE
+    def badge=(badge)
+      @badge = badge
+      @encoded_payload = nil
+    end
+
+    def custom=(custom)
+      @custom = custom
+      @encoded_payload = nil
+    end
+
+    def sound=(sound)
+      @sound = sound
+      @encoded_payload = nil
+    end
+
+    def content_available=(content_available)
+      @content_available = CONTENT_AVAILABLE_INDICATOR if content_available
+      @encoded_payload = nil
     end
 
     def validate_payload
       fail NoPayloadError unless alert || badge || custom
       fail PayloadTooLargeError if payload_too_large?
     end
+    alias_method :valid?, :validate_payload
+
+    private
 
     def encoded_payload
-      JSON.dump(payload_hash)
+      @encoded_payload ||= JSON.dump(payload_hash)
     end
 
     def payload_hash
@@ -60,10 +83,15 @@ module Grocer
       aps_hash[:alert] = alert if alert
       aps_hash[:badge] = badge if badge
       aps_hash[:sound] = sound if sound
+      aps_hash[:'content-available'] = content_available if content_available
 
       { aps: aps_hash }.merge(custom || { })
     end
 
+    def payload_too_large?
+      encoded_payload.bytesize > MAX_PAYLOAD_SIZE
+    end
+
     def expiry_epoch_time
       expiry.to_i
     end

data/lib/grocer/version.rb

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

data/lib/grocer.rb

@@ -1,12 +1,14 @@
+require 'grocer/error_response'
 require 'grocer/feedback'
+require 'grocer/feedback_connection'
+require 'grocer/mobile_device_management_notification'
+require 'grocer/newsstand_notification'
 require 'grocer/notification'
 require 'grocer/passbook_notification'
-require 'grocer/newsstand_notification'
-require 'grocer/feedback_connection'
 require 'grocer/push_connection'
 require 'grocer/pusher'
-require 'grocer/version'
 require 'grocer/server'
+require 'grocer/version'
 
 module Grocer
   Error = Class.new(::StandardError)
@@ -16,6 +18,7 @@ module Grocer
   NoPortError = Class.new(Error)
   PayloadTooLargeError = Class.new(Error)
   CertificateExpiredError = Module.new
+  InvalidCommandError = Class.new(Error)
 
   def self.env
     ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
@@ -35,5 +38,4 @@ module Grocer
     ssl_server = SSLServer.new(options)
     Server.new(ssl_server)
   end
-
 end

data/spec/grocer/error_response_spec.rb

@@ -0,0 +1,26 @@
+require_relative '../../lib/grocer/error_response'
+
+describe Grocer::ErrorResponse do
+  let(:status_code) { 1 }
+  let(:identifier) { 8342 }
+  let(:binary_tuple) { [described_class::COMMAND, status_code, identifier].pack('CCN') }
+  let(:invalid_binary_tuple) { 'totally not the right format' }
+
+  subject(:error_response) { described_class.new(binary_tuple) }
+
+  describe 'decoding' do
+    it 'accepts a binary tuple and sets each attribute' do
+      expect(error_response.status_code).to eq(status_code)
+      expect(error_response.identifier).to eq(identifier)
+    end
+
+    it 'raises an exception when there are problems decoding' do
+      -> { described_class.new(invalid_binary_tuple) }.should
+        raise_error(Grocer::InvalidFormatError)
+    end
+  end
+
+  it 'finds the status from the status code' do
+    expect(error_response.status).to eq('Processing error')
+  end
+end

data/spec/grocer/notification_spec.rb

@@ -45,6 +45,16 @@ describe Grocer::Notification do
       expect(bytes[43...45]).to eq([payload_bytes(notification).bytesize].pack('n'))
     end
 
+    it 'encodes content-available as part of the payload if a truthy value is passed' do
+      notification.content_available = :foo
+      expect(payload[:aps][:'content-available']).to eq(1)
+    end
+
+    it 'does not encode content-available as part of the payload if a falsy value is passed' do
+      notification.content_available = false
+      expect(payload[:aps]).to_not have_key(:'content-available')
+    end
+
     context 'missing payload' do
       let(:payload_options) { Hash.new }
 

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grocer
 version: !ruby/object:Gem::Version
-  version: 0.3.4
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Andy Lindeman
@@ -11,12 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-15 00:00:00.000000000 Z
+date: 2013-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -24,7 +22,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -32,7 +29,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -40,7 +36,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -48,57 +43,55 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bourne
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! "                          Grocer interfaces with the Apple Push\n
-  \                         Notification Service to send push\n                          notifications
-  to iOS devices and collect\n                          notification feedback via
-  the Feedback\n                          Service.\n\n                          There
-  are other gems out there to do this,\n                          but Grocer plans
-  to be the cleanest, most\n                          extensible, and friendliest.\n"
+description: |2
+                            Grocer interfaces with the Apple Push
+                            Notification Service to send push
+                            notifications to iOS devices and collect
+                            notification feedback via the Feedback
+                            Service.
+
+                            There are other gems out there to do this,
+                            but Grocer plans to be the cleanest, most
+                            extensible, and friendliest.
 email:
 - alindeman@gmail.com
 - steveharman@gmail.com
@@ -118,6 +111,7 @@ files:
 - grocer.gemspec
 - lib/grocer.rb
 - lib/grocer/connection.rb
+- lib/grocer/error_response.rb
 - lib/grocer/extensions/deep_symbolize_keys.rb
 - lib/grocer/failed_delivery_attempt.rb
 - lib/grocer/feedback.rb
@@ -140,6 +134,7 @@ files:
 - spec/fixtures/example.key
 - spec/fixtures/example.pem
 - spec/grocer/connection_spec.rb
+- spec/grocer/error_response_spec.rb
 - spec/grocer/extensions/deep_symbolize_keys_spec.rb
 - spec/grocer/failed_delivery_attempt_spec.rb
 - spec/grocer/feedback_connection_spec.rb
@@ -161,39 +156,33 @@ files:
 homepage: https://github.com/grocer/grocer
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4490716643818473019
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4490716643818473019
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Pushing Apple notifications since 2012.
 test_files:
 - spec/fixtures/example.cer
 - spec/fixtures/example.key
 - spec/fixtures/example.pem
 - spec/grocer/connection_spec.rb
+- spec/grocer/error_response_spec.rb
 - spec/grocer/extensions/deep_symbolize_keys_spec.rb
 - spec/grocer/failed_delivery_attempt_spec.rb
 - spec/grocer/feedback_connection_spec.rb