grocer 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 6e424c4a3e8c5ff0fdce9bb8f16fca576382e254
-  data.tar.gz: 8e99095c9208eb9e11378c32d68413d73cbf3869
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Y2E3NDU5NjNkYjQyYTAyMjUyM2RkOWVhNTljNjNiYWVlMDU5OTkxNw==
+  data.tar.gz: !binary |-
+    ZDRlNTFjOTRhOGI4NzAyNzU3YjEwZjhmNzZhNTcyMmM0Y2QxZTQ3MA==
 SHA512:
-  metadata.gz: 7451c8895a50c7366f095f3484852f5144db26e0f8efb1aa881bd5b86247639278db9767d9ac182b55975db321255ee409a2fc05da2628b17c597e82e6b109cd
-  data.tar.gz: c156b71a10de32edd60e5cf224c240cf1d97637c441cd67f15ae316918bc23b59bdf049e42da914ea9fddbe2f6ac7c0b070215fd16ef10d51067b802c80d8f03
+  metadata.gz: !binary |-
+    MGQ0ZDc5ZWFiOGI1NGE2MjQ4NzQ5ZWE3YzJmYjYxNTcyMDFhNTQyMWQ1Y2Y5
+    YzI4NTEwNGYyN2ViMDFjMWNiYWQ0NGRiOGYzM2Y1YTA4MTVlYzY1MTI2YTU5
+    MjM2M2U4MzQ2Yzc2MDEyOWQ2MDQ4ZDNkOWJkZjZmNzcxYzkyOTE=
+  data.tar.gz: !binary |-
+    MTE4YzBiODQ2M2NlNmE0MTJmMzY1NGE2OTBmODc4ZTY5NDY3OGE2MjkxMzMz
+    YWQyMjcwOTM2NDBlYjRkMmFlOWRmZjk4MDRmMjllZmRlYzU0YjQ3ZGJlY2I5
+    MGYwN2QyY2VmZmIwYThhNGI0ZjEyZWM2YTVkMDA4Y2U3OTExMTE=

data/.travis.yml

@@ -1,13 +1,13 @@
 language: ruby
 rvm:
-  - 2.1.4
+  - 2.3.1
+  - 2.2.5
+  - 2.1.10
   - 2.0.0
-  - 1.9.3
-  - 1.9.2
-  - jruby-19mode
+  - jruby
   - rbx
   - rbx-2
-  - rbx-2.3
+sudo: false
 addons:
   code_climate:
     repo_token: d414084f17a07a6b2d7da72eaa35d92281554a4266ab8d6246fee1f6c0c161b6

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+## 0.7.0
+
+* Support for `mutable-content` flag (for iOS 10). ([Matthias
+  Lüdtke](https://github.com/mat))
+
 ## 0.6.1
 
 * Support SafariNotifications in the test server. ([Will

data/README.md

@@ -1,7 +1,7 @@
 # Grocer
 
-[![Gem Version](http://img.shields.io/gem/v/grocer.svg)](https://rubygems.org/gems/grocer)
-[![Code Climate](http://img.shields.io/codeclimate/github/grocer/grocer.svg)](https://codeclimate.com/github/grocer/grocer)
+[![Gem Version](https://img.shields.io/gem/v/grocer.svg)](https://rubygems.org/gems/grocer)
+[![Code Climate](https://img.shields.io/codeclimate/github/grocer/grocer.svg)](https://codeclimate.com/github/grocer/grocer)
 [![Build Status](https://img.shields.io/travis/grocer/grocer.svg)](https://travis-ci.org/grocer/grocer)
 [![Dependency Status](https://img.shields.io/gemnasium/grocer/grocer.svg)](https://gemnasium.com/grocer/grocer)
 
@@ -9,12 +9,26 @@
 Service](http://developer.apple.com/library/mac/#documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/ApplePushService/ApplePushService.html)
 to send push notifications to iOS devices.
 
-There are other gems out there to do this, but **grocer** plans to be the
-cleanest, most extensible, and friendliest.
+There are other gems out there to do this, but **grocer** plans to be the cleanest, most extensible, and friendliest.
+
+## Important Note
+
+iOS 9.0 (and subsequent versions) introduced a subtle change to the way push tokens are provided.
+
+If you delete and then re-install an application the push token is invalidated and a new push token is generated.
+This is important because the [Feedback service](#feedback) does not deliver the list of invalidated tokens quickly enough to prevent you from using the now invalidated token.
+
+There is currently a [bug in grocer (#14)](https://github.com/grocer/grocer/issues/14) that will cause the APNS socket connect to hang up and fail to send subsequent notifications when one of these invalid tokens is used.
+
+This bug combined with the change to push tokens in iOS results in varied reliability of push notification delivery.
+This may or may not affect you, but if you are seeing a large amount of undelivered notifications - specifically when sending multiple messages in quick succession - it is likely that you are coming up against this.
+
+We are looking for help [moving over to Apple's HTTP/2 notification API](https://github.com/grocer/grocer/issues/104) which should address this situation.
+The current maintainer doesn't have time to do this work, but please leave us a note if you would like to drive the effort.
 
 ## Requirements
 
-* Ruby/MRI 2.1, 2.0, 1.9.x, JRuby 1.7.x in 1.9 mode, Rubinius in 1.9 mode
+* Ruby/MRI 2.x, JRuby 9000, Rubinius 2 & 3
 
 ## Installation
 
@@ -77,7 +91,8 @@ notification = Grocer::Notification.new(
   sound:             "siren.aiff",         # optional
   expiry:            Time.now + 60*60,     # optional; 0 is default, meaning the message is not stored
   identifier:        1234,                 # optional; must be an integer
-  content_available: true                  # optional; any truthy value will set 'content-available' to 1
+  content_available: true,                 # optional; any truthy value will set 'content-available' to 1
+  mutable_content:   true                  # optional; any truthy value will set 'mutable-content' to 1
 )
 
 pusher.push(notification) # return value is the number of bytes sent successfully
@@ -269,16 +284,19 @@ Login to the [iOS Provisioning Portal (App IDs)](https://developer.apple.com/ios
 Configure the appropriate certificate for push notifications and download the
 certificate:
 
-![Downloading the Push Notification Certificate](https://img.skitch.com/20120402-gtj3bkqi1kq92kgw2pbr5puk5d.png)
+![Downloading the Push Notification
+Certificate](images/Downloading_the_Push_Notification_Certificate.png)
 
 Open the file in Keychain Access, then expand the certificate to show both the
 certificate *and* the private key. Command select so both are highlighted:
 
-![Selecting both the certificate and private key](https://img.skitch.com/20120402-e8deartr2uhimaiatgccttkggi.png)
+![Selecting both the certificate and private
+key](images/Selecting_both_the_certificate_and_private_key.png)
 
 Control click and select to export the 2 items:
 
-![Exporting the certificate and private key](https://img.skitch.com/20120402-mbmgjrybyym846cy58a9kpyxp5.png)
+![Exporting the certificate and private
+key](images/Exporting_the_certificate_and_private_key.png)
 
 Save the items as a `.p12` file. Open a terminal window and run the following
 command:
@@ -295,6 +313,31 @@ the private key. This will be the passphrase used when configuring
 
 The `certificate.pem` file that is generated can be used with **grocer**.
 
+### Alternative way to generate certificate file (no Mac OS X required)
+
+Generate private key and unsigned certificate:
+
+```bash
+ openssl req -nodes -newkey rsa:2048 -keyout push_private_key.pem -out push.csr
+```
+
+* Go to Apple Developer site and select [Add iOS Certificate](https://developer.apple.com/account/ios/certificate/certificateCreate.action).
+* Choose *Apple Push Notification service SSL (Sandbox & Production)*.
+* Upload the `push.csr` file during the *Generate your certificate* step.
+* Download `aps.cer` on the next step.
+
+Create `push.pem` file from `aps.cer` with following command:
+
+```bash
+openssl x509 -in aps.cer -inform der -out push.pem
+```
+
+Merge `push.pem` file and your private key into `certificate.pem`:
+
+```bash
+cat push.pem push_private_key.pem > certificate.pem
+```
+
 ## Support Channels
 
 [GitHub Issues](https://github.com/grocer/grocer/issues) and [Pull

data/grocer.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Grocer::VERSION
 
-  gem.add_development_dependency 'rspec', '~> 3.1'
+  gem.add_development_dependency 'rspec', '~> 3.4'
   gem.add_development_dependency 'pry', '~> 0.10.1'
   gem.add_development_dependency 'mocha'
   gem.add_development_dependency 'bourne'

data/lib/grocer/notification.rb

@@ -5,9 +5,10 @@ module Grocer
   class Notification
     MAX_PAYLOAD_SIZE = 2048
     CONTENT_AVAILABLE_INDICATOR = 1
+    MUTABLE_CONTENT_INDICATOR = 1
 
     attr_accessor :identifier, :expiry, :device_token
-    attr_reader :alert, :badge, :custom, :sound, :content_available, :category
+    attr_reader :alert, :badge, :custom, :sound, :content_available, :mutable_content, :category
 
     # Public: Initialize a new Grocer::Notification. You must specify at least an `alert` or `badge`.
     #
@@ -19,6 +20,7 @@ module Grocer
     #           :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)
+    #           :mutable_content   - The truthy or falsy value indicating whether to have this notification be processed by a Notification Service Extension (since iOS 10) (optional)
     #           :category          - The String to be sent as the category portion of the payload. (optional)
     def initialize(payload = {})
       @identifier = 0
@@ -76,6 +78,15 @@ module Grocer
       !!content_available
     end
 
+    def mutable_content=(mutable_content)
+      @mutable_content = MUTABLE_CONTENT_INDICATOR if mutable_content
+      @encoded_payload = nil
+    end
+
+    def mutable_content?
+      !!mutable_content
+    end
+
     def validate_payload
       fail NoPayloadError unless alert || badge || custom
       fail PayloadTooLargeError if payload_too_large?
@@ -98,6 +109,7 @@ module Grocer
       aps_hash[:badge] = badge if badge
       aps_hash[:sound] = sound if sound
       aps_hash[:'content-available'] = content_available if content_available?
+      aps_hash[:'mutable-content'] = mutable_content if mutable_content?
       aps_hash[:category] = category if category
 
       { aps: aps_hash }.merge(custom || { })

data/lib/grocer/version.rb

@@ -1,3 +1,3 @@
 module Grocer
-  VERSION = '0.6.1'
+  VERSION = '0.7.0'
 end

data/spec/grocer/notification_spec.rb

@@ -60,6 +60,16 @@ describe Grocer::Notification do
       expect(payload[:aps]).to_not have_key(:'content-available')
     end
 
+    it 'encodes mutable-content as part of the payload if a truthy value is passed' do
+      notification.mutable_content = :foo
+      expect(payload[:aps][:'mutable-content']).to eq(1)
+    end
+
+    it 'does not encode mutable-content as part of the payload if a falsy value is passed' do
+      notification.mutable_content = false
+      expect(payload[:aps]).to_not have_key(:'mutable-content')
+    end
+
     it "is valid" do
       expect(notification.valid?).to be true
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grocer
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Andy Lindeman
@@ -10,88 +10,84 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-19 00:00:00.000000000 Z
+date: 2016-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.10.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.10.1
 - !ruby/object:Gem::Dependency
   name: mocha
   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'
 - !ruby/object:Gem::Dependency
   name: bourne
   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'
 - !ruby/object:Gem::Dependency
   name: rake
   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: |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.
+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"
 email:
 - alindeman@gmail.com
 - steveharman@gmail.com
@@ -100,15 +96,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - grocer.gemspec
+- images/Downloading_the_Push_Notification_Certificate.png
+- images/Exporting_the_certificate_and_private_key.png
+- images/Selecting_both_the_certificate_and_private_key.png
 - lib/grocer.rb
 - lib/grocer/connection.rb
 - lib/grocer/error_response.rb
@@ -165,17 +164,17 @@ 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.4.2
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Pushing Apple notifications since 2012.
@@ -204,4 +203,3 @@ test_files:
 - spec/grocer_spec.rb
 - spec/spec_helper.rb
 - spec/support/notification_helpers.rb
-has_rdoc: