pushpad 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62b82eeebcf3b9611c204c4752dd44a0beb6b45c
-  data.tar.gz: cf789a7d62f9a8aae45cdb7d5fd758594ad3dd7f
+  metadata.gz: 523d9efb23303960dd6479a1488ddbf0c6a4acfa
+  data.tar.gz: 1170dd487dcaee2ebe4cc45177e32ff75174241d
 SHA512:
-  metadata.gz: cfa24ded993111cf8d193336f29e1be39372cf3e9b95a25166b67c9bc142699311fa5c7c35ff75df12a988d526a8345d1825e110f317bd1f40ebc2fd6337285e
-  data.tar.gz: 2a690c2bce05779cf56c5a475853292e0c637ab4dfbeb753513a67d69544fa1ea35ac829b52a63d5b0fb3290ad164bbcdfaccc91288b0d5e15df562945f86729
+  metadata.gz: 93f7b3c1c25d3a37d4dcf277055329f1e4e8874817a8f8291b1d4a9d8033dcb547b93c7093de3048b3e8fbe727b24ca9c0bd4a196c716726046b65ff849eb766
+  data.tar.gz: 5ce9742333e169945e3084b8b377e48fe8a186af589f26841b7f4f9844f5e984b1fe30363d0ee39c85d1aaec038a41809b0af3204558229159660eaaad024e2e

data/README.md

@@ -87,8 +87,8 @@ notification = Pushpad::Notification.new({
   ttl: 604800, # optional, drop the notification after this number of seconds if a device is offline
   require_interaction: true, # optional, prevent Chrome on desktop from automatically closing the notification after a few seconds
   custom_data: "123", # optional, a string that is passed as an argument to action button callbacks
-  // optional, add some action buttons to the notification
-  // see https://pushpad.xyz/docs/action_buttons
+  # optional, add some action buttons to the notification
+  # see https://pushpad.xyz/docs/action_buttons
   actions: [
     {
       title: "My Button 1", # max length is 20 characters
@@ -97,7 +97,10 @@ notification = Pushpad::Notification.new({
       action: "myActionName" # optional
     }
   ],
-  starred: true # optional, bookmark the notification in the Pushpad dashboard (e.g. to highlight manual notifications)
+  starred: true, # optional, bookmark the notification in the Pushpad dashboard (e.g. to highlight manual notifications)
+  # optional, use this option only if you need to create scheduled notifications (max 5 days)
+  # see https://pushpad.xyz/docs/schedule_notifications
+  send_at: Time.utc(2016, 7, 25, 10, 9)
 })
 
 # deliver to a user
@@ -132,6 +135,7 @@ The methods above return an hash:
 - `"id"` is the id of the notification on Pushpad
 - `"scheduled"` is the estimated reach of the notification (i.e. the number of devices to which the notification will be sent, which can be different from the number of users, since a user may receive notifications on multiple devices)
 - `"uids"` (`deliver_to` only) are the user IDs that will be actually reached by the notification because they are subscribed to your notifications. For example if you send a notification to `['uid1', 'uid2', 'uid3']`, but only `'uid1'` is subscribed, you will get `['uid1']` in response. Note that if a user has unsubscribed after the last notification sent to him, he may still be reported for one time as subscribed (this is due to [the way](http://blog.pushpad.xyz/2016/05/the-push-api-and-its-wild-unsubscription-mechanism/) the W3C Push API works).
+- `"send_at"` is present only for scheduled notifications. The fields `"scheduled"` and `"uids"` are not available in this case.
 
 The `id` and `scheduled_count` attribute are also stored on the notification object:
 

data/lib/pushpad/notification.rb

@@ -12,7 +12,7 @@ module Pushpad
     class ReadonlyError < RuntimeError
     end
 
-    attr_accessor :body, :title, :target_url, :icon_url, :image_url, :ttl, :require_interaction, :custom_data, :actions, :starred
+    attr_accessor :body, :title, :target_url, :icon_url, :image_url, :ttl, :require_interaction, :custom_data, :actions, :starred, :send_at
     attr_reader :id, :created_at, :scheduled_count, :successfully_sent_count, :opened_count
 
     def initialize(options)
@@ -32,6 +32,7 @@ module Pushpad
       @custom_data = options[:custom_data]
       @actions = options[:actions]
       @starred = options[:starred]
+      @send_at = options[:send_at]
     end
 
     def self.find(id)
@@ -118,6 +119,7 @@ module Pushpad
       notification_params["custom_data"] = self.custom_data if self.custom_data
       notification_params["actions"] = self.actions if self.actions
       notification_params["starred"] = self.starred unless self.starred.nil?
+      notification_params["send_at"] = self.send_at.utc.strftime("%Y-%m-%dT%R") if self.send_at
 
       body = { "notification" => notification_params }
       body["uids"] = uids if uids

data/pushpad.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "pushpad"
-  spec.version       = '0.7.0'
+  spec.version       = '0.8.0'
   spec.authors       = ["Pushpad"]
   spec.email         = ["support@pushpad.xyz"]
   spec.summary       = "Web push notifications for Chrome, Firefox and Safari using Pushpad."

data/spec/pushpad/notification_spec.rb

@@ -28,6 +28,7 @@ module Pushpad
     end
 
     def stub_notification_post(project_id, params = {}, response_body = "{}")
+
       stub_request(:post, "https://pushpad.xyz/projects/#{project_id}/notifications").
         with(body: hash_including(params)).
         to_return(status: 201, body: response_body)
@@ -248,9 +249,11 @@ module Pushpad
         notification.deliver_to(100)
       }
 
+      let(:notification_params_to_json) { {} }
+
       shared_examples "notification params" do
         it "includes the params in the request" do
-          req = stub_notification_post project_id, notification: notification_params
+          req = stub_notification_post project_id, notification: notification_params.merge(notification_params_to_json)
           notification.deliver_to [123, 456]
           expect(req).to have_been_made.once
         end
@@ -283,7 +286,13 @@ module Pushpad
                 action: "myActionName"
               }
             ],
-            starred: true
+            starred: true,
+            send_at: Time.utc(2016, 7, 25, 10, 9)
+          }
+        end
+        let(:notification_params_to_json) do
+          {
+            send_at: "2016-07-25T10:09"
           }
         end
         let(:notification) { Pushpad::Notification.new notification_params }
@@ -320,9 +329,11 @@ module Pushpad
         notification.broadcast
       }
 
+      let(:notification_params_to_json) { {} }
+
       shared_examples "notification params" do
         it "includes the params in the request" do
-          req = stub_notification_post project_id, notification: notification_params
+          req = stub_notification_post project_id, notification: notification_params.merge(notification_params_to_json)
           notification.broadcast
           expect(req).to have_been_made.once
         end
@@ -355,7 +366,13 @@ module Pushpad
                 action: "myActionName"
               }
             ],
-            starred: true
+            starred: true,
+            send_at: Time.utc(2016, 7, 25, 10, 9)
+          }
+        end
+        let(:notification_params_to_json) do
+          {
+            send_at: "2016-07-25T10:09"
           }
         end
         let(:notification) { Pushpad::Notification.new notification_params }

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: pushpad
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Pushpad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-30 00:00:00.000000000 Z
+date: 2017-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   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: webmock
   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: 
@@ -45,9 +45,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -72,17 +72,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.5
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: Web push notifications for Chrome, Firefox and Safari using Pushpad.