pushpad 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0f05f2f24a86d00d4d1e13e436eae9f610d8dc57daa43b870f87b651a485b8c
-  data.tar.gz: 6b29277e18ee9d4b0fac014b80883faf9895f76847cb889cd81efaae9b723ce4
+  metadata.gz: 5ad9a17dc685ff8fe33a528b0814aec2596af0c1a6979e0750238326a3a601e5
+  data.tar.gz: 4eee2d3b34066a974a7d9648d834298c905a223ca4cad8e5e9092158c0a345fb
 SHA512:
-  metadata.gz: 3dae98b1e646c1d50324d2a11d619a3ab89c3fda58bdaa99e3d999c0d1a370eee8920369281395601cd07b29a027a12d5bf5e1b062ce139e7b6499a5fc8cb156
-  data.tar.gz: 154f7121f0da043d7677dedc9fec25bd892ea247fe36f92743db9dc5e7a8e85175f312db6ed7f1fe13bbbc4051a4b3a56f0363b48aaacaabbb4456062a5153f4
+  metadata.gz: 3e6cc505ef35a958b69d4f4763b120d3c8fda7185b447f65fe86730f92fcbf593a25ee234dc345df82d5c542eb963ada0f64e094678b9326eb34c3e4b7039b64
+  data.tar.gz: 9cc1392a374f64acfc747b9ed78423946773a8d6be5720a88e7ba16bb419391df2c5a8fb54bb557f57fd42050257dd7b11291bf3c017b80d6dfcb76aab7391dd

data/.travis.yml

@@ -1,3 +1,5 @@
 language: ruby
 rvm:
-  - 2.2.2
+  - 2.6
+  - 2.7
+  - 3.0

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Pushpad (https://pushpad.xyz)
+Copyright (c) 2016-2021 Pushpad (https://pushpad.xyz)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -57,11 +57,12 @@ Pushpad.signature_for current_user.id
 notification = Pushpad::Notification.new({
   body: "Hello world!",
   title: "Website Name", # optional, defaults to your project name
-  target_url: "http://example.com", # optional, defaults to your project website
-  icon_url: "http://example.com/assets/icon.png", # optional, defaults to the project icon
-  image_url: "http://example.com/assets/image.png", # optional, an image to display in the notification content
+  target_url: "https://example.com", # optional, defaults to your project website
+  icon_url: "https://example.com/assets/icon.png", # optional, defaults to the project icon
+  image_url: "https://example.com/assets/image.png", # optional, an image to display in the notification content
   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
+  silent: false, # optional, enable this option if you want a mute notification without any sound
   urgent: false, # optional, enable this option only for time-sensitive alerts (e.g. incoming phone call)
   custom_data: "123", # optional, a string that is passed as an argument to action button callbacks
   # optional, add some action buttons to the notification
@@ -69,8 +70,8 @@ notification = Pushpad::Notification.new({
   actions: [
     {
       title: "My Button 1",
-      target_url: "http://example.com/button-link", # optional
-      icon: "http://example.com/assets/button-icon.png", # optional
+      target_url: "https://example.com/button-link", # optional
+      icon: "https://example.com/assets/button-icon.png", # optional
       action: "myActionName" # optional
     }
   ],
@@ -114,7 +115,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).
+- `"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](https://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:
@@ -138,11 +139,12 @@ notification = Pushpad::Notification.find(42)
 notification.id # => 42
 notification.title # => "Foo Bar",
 notification.body # => "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
-notification.target_url # => "http://example.com",
+notification.target_url # => "https://example.com",
 notification.ttl # => 604800,
 notification.require_interaction # => false,
+notification.silent # => false,
 notification.urgent # => false,
-notification.icon_url # => "http://example.com/assets/icon.png",
+notification.icon_url # => "https://example.com/assets/icon.png",
 
 # `created_at` is a `Time` instance
 notification.created_at.utc.to_s # => "2016-07-06 10:09:14 UTC",

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, :urgent, :custom_data, :custom_metrics, :actions, :starred, :send_at
+    attr_accessor :body, :title, :target_url, :icon_url, :image_url, :ttl, :require_interaction, :silent, :urgent, :custom_data, :custom_metrics, :actions, :starred, :send_at
     attr_reader :id, :created_at, :scheduled_count, :successfully_sent_count, :opened_count
 
     def initialize(options)
@@ -29,6 +29,7 @@ module Pushpad
       @image_url = options[:image_url]
       @ttl = options[:ttl]
       @require_interaction = options[:require_interaction]
+      @silent = options[:silent]
       @urgent = options[:urgent]
       @custom_data = options[:custom_data]
       @custom_metrics = options[:custom_metrics]
@@ -118,6 +119,7 @@ module Pushpad
       notification_params["image_url"] = self.image_url if self.image_url
       notification_params["ttl"] = self.ttl if self.ttl
       notification_params["require_interaction"] = self.require_interaction unless self.require_interaction.nil?
+      notification_params["silent"] = self.silent unless self.silent.nil?
       notification_params["urgent"] = self.urgent unless self.urgent.nil?
       notification_params["custom_data"] = self.custom_data if self.custom_data
       notification_params["custom_metrics"] = self.custom_metrics if self.custom_metrics

data/pushpad.gemspec

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

data/spec/pushpad/notification_spec.rb

@@ -55,10 +55,11 @@ module Pushpad
           id: 5,
           title: "Foo Bar",
           body: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
-          target_url: "http://example.com",
+          target_url: "https://example.com",
           created_at: "2016-07-06T10:09:14.835Z",
           ttl: 604800,
           require_interaction: false,
+          silent: false,
           urgent: false,
           icon_url: "https://example.com/assets/icon.png",
           scheduled_count: 2,
@@ -109,10 +110,11 @@ module Pushpad
           id: 5,
           title: "Foo Bar",
           body: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
-          target_url: "http://example.com",
+          target_url: "https://example.com",
           created_at: "2016-07-06T10:09:14.835Z",
           ttl: 604800,
           require_interaction: false,
+          silent: false,
           urgent: false,
           icon_url: "https://example.com/assets/icon.png",
           scheduled_count: 2,
@@ -274,19 +276,20 @@ module Pushpad
           {
             body: "Example message",
             title: "Website Name",
-            target_url: "http://example.com",
-            icon_url: "http://example.com/assets/icon.png",
-            image_url: "http://example.com/assets/image.png",
+            target_url: "https://example.com",
+            icon_url: "https://example.com/assets/icon.png",
+            image_url: "https://example.com/assets/image.png",
             ttl: 604800,
             require_interaction: true,
+            silent: true,
             urgent: true,
             custom_data: "123",
             custom_metrics: ["examples", "another_metric"],
             actions: [
               {
                 title: "My Button 1",
-                target_url: "http://example.com/button-link",
-                icon: "http://example.com/assets/button-icon.png",
+                target_url: "https://example.com/button-link",
+                icon: "https://example.com/assets/button-icon.png",
                 action: "myActionName"
               }
             ],
@@ -356,19 +359,20 @@ module Pushpad
           {
             body: "Example message",
             title: "Website Name",
-            target_url: "http://example.com",
-            icon_url: "http://example.com/assets/icon.png",
-            image_url: "http://example.com/assets/image.png",
+            target_url: "https://example.com",
+            icon_url: "https://example.com/assets/icon.png",
+            image_url: "https://example.com/assets/image.png",
             ttl: 604800,
             require_interaction: true,
+            silent: true,
             urgent: true,
             custom_data: "123",
             custom_metrics: ["examples", "another_metric"],
             actions: [
               {
                 title: "My Button 1",
-                target_url: "http://example.com/button-link",
-                icon: "http://example.com/assets/button-icon.png",
+                target_url: "https://example.com/button-link",
+                icon: "https://example.com/assets/button-icon.png",
                 action: "myActionName"
               }
             ],

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pushpad
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Pushpad
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-02-09 00:00:00.000000000 Z
+date: 2021-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - support@pushpad.xyz
 executables: []
@@ -66,7 +66,7 @@ homepage: https://pushpad.xyz
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -81,9 +81,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Web push notifications for Chrome, Firefox, Opera, Edge and Safari using
   Pushpad.