pushpad 0.11.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 67f4863ab766c1ca89b1682f5844e3ff14052485
-  data.tar.gz: 848e06f99b504eac246cc94d970de15dde652ca3
+SHA256:
+  metadata.gz: 859e8674ef09ee84c2bb6ab00a837aef0d48b2039774625974aae32f2ca3a2ee
+  data.tar.gz: 71086f6109284229c8c02d01d48ca0980a4621065d43875a4131bc867b7c002a
 SHA512:
-  metadata.gz: 9bde5c69aebcbbf6f8a7ede29ce2b7c75c0a46f835f32eb806bb88a827b91b0b801cdde87cdb3fd12efb34679f18bdb4eb93be709b3de01b8fed04b84465e767
-  data.tar.gz: 5c7666ab8ca1c40e183ce6bc15d16834e00a0df84da63969120ba894ea72b455d5888b09c647d0d2520d73d217c05de6a6d8d4b4059e8a49a0be03508aa10b78
+  metadata.gz: 2cd5ae106f55214c5c16a7fc2eae7d33ecb4e6fb0c9b2917d44c643a754b5a6b124630b356969d9a230a25ed89fe0726b900d001452c777dba677f629c52ce6d
+  data.tar.gz: f06eb68e6b96bbf6b6f59ab687c838fdc72a6a5f9df61a86e48772bd7f74d6990416d69ddbe8ea71855b8a42ba453e363c2fb4a1ae4b97268d437a545b9a0166

data/.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: CI
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1']
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rspec

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Pushpad (https://pushpad.xyz)
+Copyright (c) 2016-2022 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

@@ -1,7 +1,7 @@
 # Pushpad - Web Push Notifications
 
-[![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)
+![Build Status](https://github.com/pushpad/pushpad-ruby/workflows/CI/badge.svg)
 
 [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).
 
@@ -55,22 +55,24 @@ Pushpad.signature_for current_user.id
 
 ```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
+  badge_url: "https://example.com/assets/badge.png" # optional, defaults to the project badge
+  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
     }
   ],
@@ -114,7 +116,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 +140,13 @@ 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",
+notification.badge_url # => "https://example.com/assets/badge.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, :badge_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)
@@ -26,9 +26,11 @@ module Pushpad
       @title = options[:title]
       @target_url = options[:target_url]
       @icon_url = options[:icon_url]
+      @badge_url = options[:badge_url]
       @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]
@@ -38,7 +40,7 @@ module Pushpad
     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}"
@@ -54,7 +56,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"
@@ -97,7 +99,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"
@@ -115,9 +117,11 @@ module Pushpad
       notification_params["title"] = self.title if self.title
       notification_params["target_url"] = self.target_url if self.target_url
       notification_params["icon_url"] = self.icon_url if self.icon_url
+      notification_params["badge_url"] = self.badge_url if self.badge_url
       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/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,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "pushpad"
-  spec.version       = '0.11.0'
+  spec.version       = '0.13.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

@@ -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,12 +55,14 @@ 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",
+          badge_url: "https://example.com/assets/badge.png",
           scheduled_count: 2,
           successfully_sent_count: 4,
           opened_count: 1
@@ -109,12 +111,14 @@ 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",
+          badge_url: "https://example.com/assets/badge.png",
           scheduled_count: 2,
           successfully_sent_count: 4,
           opened_count: 1
@@ -274,19 +278,21 @@ 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",
+            badge_url: "https://example.com/assets/badge.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 +362,21 @@ 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",
+            badge_url: "https://example.com/assets/badge.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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pushpad
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Pushpad
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-11-26 00:00:00.000000000 Z
+date: 2022-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -38,16 +38,16 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - support@pushpad.xyz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -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.4.5
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Web push notifications for Chrome, Firefox, Opera, Edge and Safari using
   Pushpad.

data/.travis.yml

@@ -1,3 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.2