pushpad 0.8.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 523d9efb23303960dd6479a1488ddbf0c6a4acfa
-  data.tar.gz: 1170dd487dcaee2ebe4cc45177e32ff75174241d
+SHA256:
+  metadata.gz: 5ad9a17dc685ff8fe33a528b0814aec2596af0c1a6979e0750238326a3a601e5
+  data.tar.gz: 4eee2d3b34066a974a7d9648d834298c905a223ca4cad8e5e9092158c0a345fb
 SHA512:
-  metadata.gz: 93f7b3c1c25d3a37d4dcf277055329f1e4e8874817a8f8291b1d4a9d8033dcb547b93c7093de3048b3e8fbe727b24ca9c0bd4a196c716726046b65ff849eb766
-  data.tar.gz: 5ce9742333e169945e3084b8b377e48fe8a186af589f26841b7f4f9844f5e984b1fe30363d0ee39c85d1aaec038a41809b0af3204558229159660eaaad024e2e
+  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

@@ -3,7 +3,7 @@
 [![Build Status](https://travis-ci.org/pushpad/pushpad-ruby.svg?branch=master)](https://travis-ci.org/pushpad/pushpad-ruby)
 [![Gem Version](https://badge.fury.io/rb/pushpad.svg)](https://badge.fury.io/rb/pushpad)
 
-[Pushpad](https://pushpad.xyz) is a service for sending push notifications from your web app. It supports the **Push API** (Chrome, Firefox, Opera) and **APNs** (Safari).
+[Pushpad](https://pushpad.xyz) is a service for sending push notifications from your web app. It supports the **Push API** (Chrome, Firefox, Opera, Edge) and **APNs** (Safari).
 
 Features:
 
@@ -11,13 +11,6 @@ Features:
 - users don't need to install any app or plugin
 - you can target specific users or send bulk notifications
 
-Currently push notifications work on the following browsers:
-
-- Chrome (Desktop and Android)
-- Firefox (44+)
-- Opera (42+)
-- Safari
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -50,11 +43,7 @@ Pushpad.project_id = 123 # set it here or pass it as a param to methods later
 
 ## Collecting user subscriptions to push notifications
 
-Pushpad offers two different products. [Learn more](https://pushpad.xyz/docs)
-
-### Pushpad Pro
-
-Choose Pushpad Pro if you want to use Javascript for a seamless integration. [Read the docs](https://pushpad.xyz/docs/pushpad_pro_getting_started)
+You can subscribe the users to your notifications using the Javascript SDK, as described in the [getting started guide](https://pushpad.xyz/docs/pushpad_pro_getting_started).
 
 If you need to generate the HMAC signature for the `uid` you can use this helper:
 
@@ -62,45 +51,37 @@ If you need to generate the HMAC signature for the `uid` you can use this helper
 Pushpad.signature_for current_user.id
 ```
 
-### Pushpad Express
-
-If you want to use Pushpad Express, add a link to your website to let users subscribe to push notifications: 
-
-```erb
-<a href="<%= Pushpad.path %>">Push notifications</a>
-
-<!-- If the user is logged in on your website you should track its user id to target him in the future  -->
-<a href="<%= Pushpad.path_for current_user # or current_user_id %>">Push notifications</a>
-```
-
-When a user clicks the link is sent to Pushpad, asked to receive push notifications and redirected back to your website.
-
 ## Sending push notifications
 
 ```ruby
 notification = Pushpad::Notification.new({
-  body: "Hello world!", # max 120 characters
-  title: "Website Name", # optional, defaults to your project name, max 30 characters
-  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
+  body: "Hello world!",
+  title: "Website Name", # optional, defaults to your project name
+  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
   # see https://pushpad.xyz/docs/action_buttons
   actions: [
     {
-      title: "My Button 1", # max length is 20 characters
-      target_url: "http://example.com/button-link", # optional
-      icon: "http://example.com/assets/button-icon.png", # optional
+      title: "My Button 1",
+      target_url: "https://example.com/button-link", # optional
+      icon: "https://example.com/assets/button-icon.png", # optional
       action: "myActionName" # optional
     }
   ],
   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)
+  send_at: Time.utc(2016, 7, 25, 10, 9),
+  # optional, add the notification to custom categories for stats aggregation
+  # see https://pushpad.xyz/docs/monitoring
+  custom_metrics: ['examples', 'another_metric'] # up to 3 metrics per notification
 })
 
 # deliver to a user
@@ -134,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:
@@ -158,10 +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.icon_url # => "http://example.com/assets/icon.png",
+notification.silent # => false,
+notification.urgent # => false,
+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.rb

@@ -29,15 +29,4 @@ module Pushpad
     OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), self.auth_token, data.to_s)
   end
 
-  def self.path(options = {})
-    project_id = options[:project_id] || self.project_id
-    raise "You must set project_id" unless project_id
-    "https://pushpad.xyz/projects/#{self.project_id}/subscription/edit"
-  end
-
-  def self.path_for(user, options = {})
-    uid = user.respond_to?(:id) ? user.id : user
-    uid_signature = self.signature_for(uid.to_s)
-    "#{self.path(options)}?uid=#{uid}&uid_signature=#{uid_signature}"
-  end
 end

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, :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,14 +29,17 @@ 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]
       @actions = options[:actions]
       @starred = options[:starred]
       @send_at = options[:send_at]
     end
 
     def self.find(id)
-      response = Request.get("https://pushpad.xyz/notifications/#{id}")
+      response = Request.get("https://pushpad.xyz/api/v1/notifications/#{id}")
 
       unless response.code == "200"
         raise FindError, "Response #{response.code} #{response.message}: #{response.body}"
@@ -52,7 +55,7 @@ module Pushpad
       query_parameters = {}
       query_parameters[:page] = options[:page] if options.key?(:page)
 
-      response = Request.get("https://pushpad.xyz/projects/#{project_id}/notifications",
+      response = Request.get("https://pushpad.xyz/api/v1/projects/#{project_id}/notifications",
                              query_parameters: query_parameters)
 
       unless response.code == "200"
@@ -95,7 +98,7 @@ module Pushpad
       project_id = options[:project_id] || Pushpad.project_id
       raise "You must set project_id" unless project_id
 
-      endpoint = "https://pushpad.xyz/projects/#{project_id}/notifications"
+      endpoint = "https://pushpad.xyz/api/v1/projects/#{project_id}/notifications"
       response = Request.post(endpoint, req_body)
 
       unless response.code == "201"
@@ -116,7 +119,10 @@ 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
       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

data/lib/pushpad/subscription.rb

@@ -18,7 +18,7 @@ module Pushpad
         project_id = options[:project_id] || Pushpad.project_id
         raise "You must set project_id" unless project_id
 
-        endpoint = "https://pushpad.xyz/projects/#{project_id}/subscriptions"
+        endpoint = "https://pushpad.xyz/api/v1/projects/#{project_id}/subscriptions"
         response = Request.head(endpoint, query_parameters: query_parameters)
 
         unless response.code == "200"

data/pushpad.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |spec|
   spec.name          = "pushpad"
-  spec.version       = '0.8.0'
+  spec.version       = '0.12.0'
   spec.authors       = ["Pushpad"]
   spec.email         = ["support@pushpad.xyz"]
-  spec.summary       = "Web push notifications for Chrome, Firefox and Safari using Pushpad."
+  spec.summary       = "Web push notifications for Chrome, Firefox, Opera, Edge and Safari using Pushpad."
   spec.homepage      = "https://pushpad.xyz"
   spec.license       = "MIT"
   spec.files         = `git ls-files`.split("\n")

data/spec/pushpad/notification_spec.rb

@@ -7,35 +7,35 @@ module Pushpad
     let(:notification) { Pushpad::Notification.new body: "Example message" }
 
     def stub_notification_get(attributes)
-      stub_request(:get, "https://pushpad.xyz/notifications/#{attributes[:id]}").
+      stub_request(:get, "https://pushpad.xyz/api/v1/notifications/#{attributes[:id]}").
         to_return(status: 200, body: attributes.to_json)
     end
 
     def stub_failing_notification_get(notification_id)
-      stub_request(:get, "https://pushpad.xyz/notifications/#{notification_id}").
+      stub_request(:get, "https://pushpad.xyz/api/v1/notifications/#{notification_id}").
         to_return(status: 404)
     end
 
     def stub_notifications_get(options)
-      stub_request(:get, "https://pushpad.xyz/projects/#{options[:project_id]}/notifications").
+      stub_request(:get, "https://pushpad.xyz/api/v1/projects/#{options[:project_id]}/notifications").
         with(query: hash_including(options.fetch(:query, {}))).
         to_return(status: 200, body: options[:list].to_json)
     end
 
     def stub_failing_notifications_get(options)
-      stub_request(:get, "https://pushpad.xyz/projects/#{options[:project_id]}/notifications").
+      stub_request(:get, "https://pushpad.xyz/api/v1/projects/#{options[:project_id]}/notifications").
         to_return(status: 403)
     end
 
     def stub_notification_post(project_id, params = {}, response_body = "{}")
 
-      stub_request(:post, "https://pushpad.xyz/projects/#{project_id}/notifications").
+      stub_request(:post, "https://pushpad.xyz/api/v1/projects/#{project_id}/notifications").
         with(body: hash_including(params)).
         to_return(status: 201, body: response_body)
     end
 
     def stub_failing_notification_post(project_id)
-      stub_request(:post, "https://pushpad.xyz/projects/#{project_id}/notifications").
+      stub_request(:post, "https://pushpad.xyz/api/v1/projects/#{project_id}/notifications").
         to_return(status: 403)
     end
 
@@ -55,10 +55,12 @@ 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,
           successfully_sent_count: 4,
@@ -108,10 +110,12 @@ 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,
           successfully_sent_count: 4,
@@ -272,17 +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"
               }
             ],
@@ -352,17 +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"
               }
             ],

data/spec/pushpad/subscription_spec.rb

@@ -3,14 +3,14 @@ require "spec_helper"
 module Pushpad
   describe Subscription do
     def stub_subscriptions_head(options)
-      stub_request(:head, "https://pushpad.xyz/projects/#{options[:project_id]}/subscriptions").
+      stub_request(:head, "https://pushpad.xyz/api/v1/projects/#{options[:project_id]}/subscriptions").
         with(query: hash_including(options.fetch(:query, {}))).
         to_return(status: 200,
                   headers: { "X-Total-Count" => options.fetch(:total_count, 10) })
     end
 
     def stub_failing_subscriptions_head(options)
-      stub_request(:head, "https://pushpad.xyz/projects/#{options[:project_id]}/subscriptions").
+      stub_request(:head, "https://pushpad.xyz/api/v1/projects/#{options[:project_id]}/subscriptions").
         to_return(status: 503)
     end
 

metadata

@@ -1,53 +1,53 @@
 --- !ruby/object:Gem::Specification
 name: pushpad
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Pushpad
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-10-26 00:00:00.000000000 Z
+date: 2021-02-24 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: 
+description:
 email:
 - support@pushpad.xyz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -66,26 +66,26 @@ homepage: https://pushpad.xyz
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 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.0.14.1
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
-summary: Web push notifications for Chrome, Firefox and Safari using Pushpad.
+summary: Web push notifications for Chrome, Firefox, Opera, Edge and Safari using
+  Pushpad.
 test_files:
 - spec/pushpad/notification_spec.rb
 - spec/pushpad/request_spec.rb