grocer 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6555a705340dbf836a1e108191917cb6e070cd4
-  data.tar.gz: ff071fb2ba59d97b416843adfd3242482628cb0a
+  metadata.gz: 22fd48d5c9119fdaf4ebe30482265fd29b42dcda
+  data.tar.gz: e4d34ea7dd2625b96e17a1e373b6d7172b8752c6
 SHA512:
-  metadata.gz: 18b17445045304ce0dca3673e8f56188fea6c94df2870a6c56dce035dc79af6c8c6dab48900d3aac37b6a5e687dd5e7486dc6285f4c90b3274ba6292ba90f4c7
-  data.tar.gz: 99874e8769c23afd6a8f5401fae5f276cc6f17b1b65e920d2ed3cfbbbe60bc5ce3a7aeb451de1d08a5cdf97cec368217cd861ed6c309e325fbdc572509cf6619
+  metadata.gz: 378b66ae89f8a80446f4b5c36a10894a0f4674e69f8ca041608a162e0030d9d44ec8daecd636119774150391e2c63c17f2dc08c91167899095e2aca5fcecf363
+  data.tar.gz: f2498ef365ec5e89fad9d57f79e1dd173fea1742bd6e3b106177383f03d221a3d43d0c915ada43cc11d1f42c67b3112628f60b584627e0c0becade524a57c606

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+## 0.5.0
+
+* Add `Grocer::SafariNotification` for sending Safari notifications in OS X
+  Mavericks. ([Ben Ubois](https://github.com/benubois) and [Adam
+  Duke](adamvduke))
+
 ## 0.4.1
 
 * Fix `Grocer::NotificationReader`, ensuring it sanitizes incoming `aps`

data/README.md

@@ -125,9 +125,10 @@ notification = Grocer::PassbookNotification.new(device_token: "...")
 
 #### 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.
+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: "...")
@@ -135,6 +136,38 @@ notification = Grocer::NewsstandNotification.new(device_token: "...")
 # {"aps": {"content-available":1}}
 ````
 
+#### Safari Notifications
+
+Grocer can be used for [Safari Push
+Notifications](https://developer.apple.com/notifications/safari-push-notifications/)
+introduced in Mavericks.
+
+```ruby
+notification = Grocer::SafariNotification.new(
+  device_token: '...',        # required
+  title: 'Hello from Grocer', # required
+  body: 'Hi',                 # required
+  action: 'Read',             # optional; the label of the action button
+  url_args: ['arg1']          # required (array); values that are paired with the placeholders inside the urlFormatString.
+                              # Apple's documention lists url-args as optional, but in testing it was found to be required
+)
+```
+
+Generates a JSON payload like:
+
+```json
+{
+  "aps": {
+    "alert": {
+      "title": "Hello from Grocer",
+      "body": "Hi",
+      "action": "Read"
+    },
+    "url-args": [ "arg1" ]
+  }
+}
+```
+
 ### Feedback
 
 ```ruby

data/lib/grocer.rb

@@ -5,6 +5,7 @@ require 'grocer/mobile_device_management_notification'
 require 'grocer/newsstand_notification'
 require 'grocer/notification'
 require 'grocer/passbook_notification'
+require 'grocer/safari_notification'
 require 'grocer/push_connection'
 require 'grocer/pusher'
 require 'grocer/server'

data/lib/grocer/notification.rb

@@ -69,8 +69,12 @@ module Grocer
     def validate_payload
       fail NoPayloadError unless alert || badge || custom
       fail PayloadTooLargeError if payload_too_large?
+      true
+    end
+
+    def valid?
+      validate_payload rescue false
     end
-    alias_method :valid?, :validate_payload
 
     private
 

data/lib/grocer/notification_reader.rb

@@ -39,14 +39,10 @@ module Grocer
     end
 
     def sanitize_keys(hash)
-      hash ||= {}
-
-      clean_hash = hash.map { |k, v|
-        new_key = k.to_s.gsub(/-/i, '_').to_sym
-        [new_key, v]
-      }
-
-      Hash[clean_hash]
+      hash.each_with_object({}) do |(k,v), h|
+        new_key = k.to_s.gsub(/-/,'_').to_sym
+        h[new_key] = v
+      end
     end
   end
 end

data/lib/grocer/safari_notification.rb

@@ -0,0 +1,85 @@
+require 'grocer/notification'
+
+module Grocer
+  # Public: A specialized form of a Grocer::Notification for sending
+  # Safari push notifications
+  #
+  # Examples
+  #
+  #   Grocer::SafariNotification.new(
+  #     device_token: '...',
+  #     title: '...',
+  #     body: '...',
+  #     action: '...',
+  #     url_args: ['...']
+  #   )
+  #
+  #   #=>
+  #   {
+  #     "aps": {
+  #       "alert": {
+  #         "title": "...",
+  #         "body": "...",
+  #         "action": "..."
+  #       },
+  #       "url-args": ["..."]
+  #     }
+  #   }
+  class SafariNotification < Notification
+
+    def initialize(payload = {})
+      self.alert = {}
+      super(payload)
+    end
+
+    def title
+      alert[:title]
+    end
+
+    def title=(title)
+      alert[:title] = title
+      @encoded_payload = nil
+    end
+
+    def body
+      alert[:body]
+    end
+
+    def body=(body)
+      alert[:body] = body
+      @encoded_payload = nil
+    end
+
+    def action
+      alert[:action]
+    end
+
+    def action=(action)
+      alert[:action] = action
+      @encoded_payload = nil
+    end
+
+    def url_args
+      Array(@url_args)
+    end
+
+    def url_args=(args)
+      @url_args = args.dup
+      @encoded_payload = nil
+    end
+
+    private
+
+    def validate_payload
+      fail ArgumentError.new('missing title') unless title
+      fail ArgumentError.new('missing body') unless body
+      super
+    end
+
+    def payload_hash
+      aps_hash = { alert: alert }
+      aps_hash[:'url-args'] = url_args
+      { aps: aps_hash }
+    end
+  end
+end

data/lib/grocer/version.rb

@@ -1,3 +1,3 @@
 module Grocer
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

data/spec/grocer/notification_spec.rb

@@ -55,6 +55,10 @@ describe Grocer::Notification do
       expect(payload[:aps]).to_not have_key(:'content-available')
     end
 
+    it "is valid" do
+      expect(notification.valid?).to be_true
+    end
+
     context 'missing payload' do
       let(:payload_options) { Hash.new }
 
@@ -62,6 +66,10 @@ describe Grocer::Notification do
         -> { notification.to_bytes }.should raise_error(Grocer::NoPayloadError)
       end
 
+      it 'is not valid' do
+        expect(notification.valid?).to be_false
+      end
+
       [{alert: 'hi'}, {badge: 1}, {custom: {a: 'b'}}].each do |payload|
         context "when #{payload.keys.first} exists, but not any other payload keys" do
           let(:payload_options) { payload }
@@ -79,6 +87,10 @@ describe Grocer::Notification do
       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
+
+      it 'is not valid' do
+        expect(notification.valid?).to be_false
+      end
     end
   end
 end

data/spec/grocer/safari_notification_spec.rb

@@ -0,0 +1,111 @@
+# encoding: UTF-8
+require 'spec_helper'
+require 'grocer/safari_notification'
+require 'grocer/shared_examples_for_notifications'
+
+describe Grocer::SafariNotification do
+  describe 'binary format' do
+    let(:payload_options) {
+      {
+        title: 'Grocer Update!',
+        body: 'Grocer now supports Safari Notifications',
+        action: 'View',
+        url_args: ['message_id', '124234']
+      }
+    }
+    let(:payload) { payload_hash(notification) }
+
+    include_examples 'a notification'
+
+    it 'encodes title as part of the payload' do
+      notification.title = 'Hello World!'
+      expect(payload[:aps][:alert][:title]).to eq('Hello World!')
+    end
+
+    it 'encodes body as part of the payload' do
+      notification.body = 'In the body'
+      expect(payload[:aps][:alert][:body]).to eq('In the body')
+    end
+
+    it 'encodes action as part of the payload' do
+      notification.action = 'Launch'
+      expect(payload[:aps][:alert][:action]).to eq('Launch')
+    end
+
+    it 'encodes url-args payload attributes' do
+      notification.url_args = ['hello', 'world']
+      expect(payload[:aps][:'url-args']).to eq(['hello','world'])
+    end
+
+    it 'is valid' do
+      expect(notification.valid?).to be_true
+    end
+
+    context 'missing parameters' do
+      context 'title' do
+        let(:payload_options) { { alert: { body: 'This is a body' } } }
+
+        it 'raises an error when title is missing' do
+          -> { notification.to_bytes }.should raise_error(ArgumentError)
+        end
+
+        it 'is not valid' do
+          expect(notification.valid?).to be_false
+        end
+      end
+
+      context 'body' do
+        let(:payload_options) { { alert: { title: 'This is a title' } } }
+
+        it 'raises an error when body is missing' do
+          -> { notification.to_bytes }.should raise_error(ArgumentError)
+        end
+
+        it 'is not valid' do
+          expect(notification.valid?).to be_false
+        end
+      end
+    end
+
+    context 'oversized payload' do
+      let(:payload_options) { { alert: { title: 'Test', body: '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
+
+      it 'is not valid' do
+        expect(notification.valid?).to be_false
+      end
+    end
+
+    context 'with a complete alert hash passed to the initializer' do
+      let(:payload_options) {
+        {
+          alert: {
+            title: 'Title',
+            body: 'Body',
+            action: 'View'
+          },
+          url_args: ['hello', 'world']
+        }
+      }
+
+      it 'has the correct title' do
+        expect(notification.title).to eq('Title')
+      end
+
+      it 'has the correct body' do
+        expect(notification.body).to eq('Body')
+      end
+
+      it 'has the correct action' do
+        expect(notification.action).to eq('View')
+      end
+
+      it 'has the correct url-args' do
+        expect(notification.url_args).to eq(['hello','world'])
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grocer
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Andy Lindeman
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-20 00:00:00.000000000 Z
+date: 2013-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -123,6 +123,7 @@ files:
 - lib/grocer/passbook_notification.rb
 - lib/grocer/push_connection.rb
 - lib/grocer/pusher.rb
+- lib/grocer/safari_notification.rb
 - lib/grocer/server.rb
 - lib/grocer/ssl_connection.rb
 - lib/grocer/ssl_server.rb
@@ -146,6 +147,7 @@ files:
 - spec/grocer/passbook_notification_spec.rb
 - spec/grocer/push_connection_spec.rb
 - spec/grocer/pusher_spec.rb
+- spec/grocer/safari_notification_spec.rb
 - spec/grocer/server_spec.rb
 - spec/grocer/shared_examples_for_notifications.rb
 - spec/grocer/ssl_connection_spec.rb
@@ -173,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
 summary: Pushing Apple notifications since 2012.
@@ -194,6 +196,7 @@ test_files:
 - spec/grocer/passbook_notification_spec.rb
 - spec/grocer/push_connection_spec.rb
 - spec/grocer/pusher_spec.rb
+- spec/grocer/safari_notification_spec.rb
 - spec/grocer/server_spec.rb
 - spec/grocer/shared_examples_for_notifications.rb
 - spec/grocer/ssl_connection_spec.rb
@@ -201,3 +204,4 @@ test_files:
 - spec/grocer_spec.rb
 - spec/spec_helper.rb
 - spec/support/notification_helpers.rb
+has_rdoc: