pushpad 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48d7160263b210c7897b4171bb69b21916e155e3e3c5c252a23ab99f0d64252d
-  data.tar.gz: e06bc7a3e1d946403e45cc4ed57672d1fd97e4076d9d0538bf42ba7b13a5aaf1
+  metadata.gz: 6ca523c6dd48111c5a369889092c80690401158c3f0a14142eb3aee236848062
+  data.tar.gz: 637c8461863686d6c3c1f9f666a7df74b2053aed5017318f360054f908b83fbe
 SHA512:
-  metadata.gz: 33bc016ccd42f4ea8cced6e3b0a98e91c22c196ff1481b504f64ae231ec0ff0d67c4e47bd5fb5fd0ab42c544d3d97e559893ed85d71cce7057e355a5d138863e
-  data.tar.gz: 927b49b786b2ed3114d6a1c8b88dddcea72a21c6688a4bc9adc51e6206a5a0d6229134fdaace40c7687e957f0eba3a7045edb1e512ccfac4436568704bcdf803
+  metadata.gz: 7aaed7d9218f698803bf1adda9ba1459365b49eaba897903b1cab109aeb9bb825ab40b25119a52cc620d515dd7cce36ad8509d34baacb7b74d58028c26327207
+  data.tar.gz: 0e89ea2619f3c6f39c4a073c95d56faa451e672b86ad3d898e681b53c7ecef59af7e2b7b5fd22b3be957ab02cb7fcc98b6c7e4a84b5a328e853f6c5abc8905ac

data/.github/workflows/ci.yml

@@ -10,7 +10,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: ['2.7', '3.0', '3.1']
+        ruby-version: ['3.0', '3.1', '3.2', '3.3']
     steps:
     - uses: actions/checkout@v3
     - name: Set up Ruby

data/README.md

@@ -3,13 +3,9 @@
 [![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 desktop). iOS support is coming in 2023.
+[Pushpad](https://pushpad.xyz) is a service for sending push notifications from websites and web apps. It uses the **Push API**, which is a standard supported by all major browsers (Chrome, Firefox, Opera, Edge, Safari).
 
-Features:
-
-- notifications are delivered even when the user is not on your website
-- users don't need to install any app or plugin
-- you can target specific users or send bulk notifications
+The notifications are delivered in real time even when the users are not on your website and you can target specific users or send bulk notifications.
 
 ## Installation
 
@@ -55,17 +51,40 @@ Pushpad.signature_for current_user.id
 
 ```ruby
 notification = Pushpad::Notification.new({
+  # required, the main content of the notification
   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, the title of the notification (defaults to your project name)
+  title: "Website Name",
+
+  # optional, open this link on notification click (defaults to your project website)
+  target_url: "https://example.com",
+
+  # optional, the icon of the notification (defaults to the project icon)
+  icon_url: "https://example.com/assets/icon.png",
+
+  # optional, the small icon displayed in the status bar (defaults to the project badge)
+  badge_url: "https://example.com/assets/badge.png",
+
+  # optional, an image to display in the notification content
+  # see https://pushpad.xyz/docs/sending_images
+  image_url: "https://example.com/assets/image.png",
+
+  # optional, drop the notification after this number of seconds if a device is offline
+  ttl: 604800,
+
+  # optional, prevent Chrome on desktop from automatically closing the notification after a few seconds
+  require_interaction: true,
+
+  # optional, enable this option if you want a mute notification without any sound
+  silent: false,
+
+  # optional, enable this option only for time-sensitive alerts (e.g. incoming phone call)
+  urgent: false,
+
+  # optional, a string that is passed as an argument to action button callbacks
+  custom_data: "123",
+
   # optional, add some action buttons to the notification
   # see https://pushpad.xyz/docs/action_buttons
   actions: [
@@ -76,10 +95,14 @@ notification = Pushpad::Notification.new({
       action: "myActionName" # optional
     }
   ],
-  starred: true, # optional, bookmark the notification in the Pushpad dashboard (e.g. to highlight manual notifications)
+
+  # optional, bookmark the notification in the Pushpad dashboard (e.g. to highlight manual notifications)
+  starred: true,
+
   # 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),
+
   # 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
@@ -100,7 +123,8 @@ notification.deliver_to users, tags: ['events']
 notification.broadcast tags: ['segment1', 'segment2']
 
 # you can use boolean expressions 
-# they must be in the disjunctive normal form (without parenthesis)
+# they can include parentheses and the operators !, &&, || (from highest to lowest precedence)
+# https://pushpad.xyz/docs/tags
 notification.broadcast tags: ['zip_code:28865 && !optout:local_events || friend_of:Organizer123']
 notification.deliver_to users, tags: ['tag1 && tag2', 'tag3'] # equal to 'tag1 && tag2 || tag3'
 
@@ -177,6 +201,26 @@ to get the full list in multiple requests.
 notifications = Pushpad::Notification.find_all(project_id: 5, page: 2)
 ```
 
+## Scheduled notifications
+
+You can create scheduled notifications that will be sent in the future:
+
+```ruby
+notification = Pushpad::Notification.new({
+  body: "This notification will be sent after 60 seconds",
+  send_at: Time.now.utc + 60
+})
+
+notification.broadcast
+```
+
+You can also cancel a scheduled notification:
+
+```ruby
+notification = Pushpad::Notification.find(5)
+notification.cancel
+```
+
 ## Getting subscription count
 
 You can retrieve the number of subscriptions for a given project,
@@ -193,6 +237,29 @@ Pushpad::Subscription.count(project_id: 5, uids: ['user1'], tags: 'sports && tra
 If `Pushpad.project_id` is defined, the `project_id` option can be
 omitted.
 
+## Getting push subscription data
+
+You can retrieve the subscriptions for a given project,
+optionally filtered by `tags` or `uids`:
+
+```ruby
+Pushpad::Subscription.find_all(project_id: 5)
+Pushpad::Subscription.find_all(project_id: 5, uids: ['user1'])
+Pushpad::Subscription.find_all(project_id: 5, tags: ['sports'])
+Pushpad::Subscription.find_all(project_id: 5, tags: 'sports && travel')
+Pushpad::Subscription.find_all(project_id: 5, uids: ['user1'], tags: 'sports && travel')
+```
+
+If `Pushpad.project_id` is defined, the `project_id` option can be
+omitted.
+
+The REST API paginates the result set. You can pass a `page` parameter
+to get the full list in multiple requests.
+
+```ruby
+subscriptions = Pushpad::Subscription.find_all(project_id: 5, page: 2)
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/pushpad/notification.rb

@@ -8,6 +8,9 @@ module Pushpad
 
     class FindError < RuntimeError
     end
+    
+    class CancelError < RuntimeError
+    end
 
     class ReadonlyError < RuntimeError
     end
@@ -87,6 +90,14 @@ module Pushpad
       end
       deliver req_body(uids, options[:tags]), options
     end
+    
+    def cancel
+      response = Request.delete("https://pushpad.xyz/api/v1/notifications/#{id}/cancel")
+
+      unless response.code == "204"
+        raise CancelError, "Response #{response.code} #{response.message}: #{response.body}"
+      end
+    end
 
     private
 

data/lib/pushpad/request.rb

@@ -18,6 +18,10 @@ module Pushpad
         request.body = body
       end
     end
+    
+    def delete(endpoint, options = {})
+      perform(Net::HTTP::Delete, endpoint, options)
+    end
 
     private
 

data/lib/pushpad/subscription.rb

@@ -2,51 +2,67 @@ module Pushpad
   class Subscription
     class CountError < RuntimeError
     end
-
-    def self.count(options = {})
-      CountQuery.new(options).perform
+    
+    class FindError < RuntimeError
     end
+    
+    attr_reader :id, :endpoint, :p256dh, :auth, :uid, :tags, :last_click_at, :created_at
 
-    class CountQuery
-      attr_reader :options
+    def initialize(options)
+      @id = options[:id]
+      @endpoint = options[:endpoint]
+      @p256dh = options[:p256dh]
+      @auth = options[:auth]
+      @uid = options[:uid]
+      @tags = options[:tags]
+      @last_click_at = options[:last_click_at] && Time.parse(options[:last_click_at])
+      @created_at = options[:created_at] && Time.parse(options[:created_at])
+    end
 
-      def initialize(options)
-        @options = options
-      end
+    def self.count(options = {})
+      project_id = options[:project_id] || Pushpad.project_id
+      raise "You must set project_id" unless project_id
 
-      def perform
-        project_id = options[:project_id] || Pushpad.project_id
-        raise "You must set project_id" unless project_id
+      endpoint = "https://pushpad.xyz/api/v1/projects/#{project_id}/subscriptions"
+      response = Request.head(endpoint, query_parameters: query_parameters(options))
 
-        endpoint = "https://pushpad.xyz/api/v1/projects/#{project_id}/subscriptions"
-        response = Request.head(endpoint, query_parameters: query_parameters)
+      unless response.code == "200"
+        raise CountError, "Response #{response.code} #{response.message}: #{response.body}"
+      end
 
-        unless response.code == "200"
-          raise CountError, "Response #{response.code} #{response.message}: #{response.body}"
-        end
+      response["X-Total-Count"].to_i
+    end
+    
+    def self.find_all(options = {})
+      project_id = options[:project_id] || Pushpad.project_id
+      raise "You must set project_id" unless project_id
 
-        response["X-Total-Count"].to_i
-      end
+      query_parameters_with_pagination = query_parameters(options)
+      query_parameters_with_pagination << ["page", options[:page]] if options.key?(:page)
 
-      private
+      response = Request.get("https://pushpad.xyz/api/v1/projects/#{project_id}/subscriptions",
+                             query_parameters: query_parameters_with_pagination)
 
-      def query_parameters
-        [uid_query_parameters, tag_query_parameters].flatten(1)
+      unless response.code == "200"
+        raise FindError, "Response #{response.code} #{response.message}: #{response.body}"
       end
 
-      def uid_query_parameters
-        options.fetch(:uids, []).map { |uid| ["uids[]", uid] }
+      JSON.parse(response.body, symbolize_names: true).map do |attributes|
+        new(attributes)
       end
+    end
 
-      def tag_query_parameters
-        tags = options.fetch(:tags, [])
+    private
 
-        if tags.is_a?(String)
-          [["tags", tags]]
-        else
-          tags.map { |tag| ["tags[]", tag] }
-        end
-      end
+    def self.query_parameters(options)
+      uids = options.fetch(:uids, [])
+      uids_query = uids.map { |uid| ["uids[]", uid] }
+      
+      tags = options.fetch(:tags, [])
+      tags_query = tags.is_a?(String) ? [["tags", tags]] : tags.map { |tag| ["tags[]", tag] }
+      
+      [uids_query, tags_query].flatten(1)
     end
+
   end
 end

data/pushpad.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "pushpad"
-  spec.version       = '1.0.0'
+  spec.version       = '1.2.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

@@ -28,7 +28,6 @@ module Pushpad
     end
 
     def stub_notification_post(project_id, params = {}, response_body = "{}")
-
       stub_request(:post, "https://pushpad.xyz/api/v1/projects/#{project_id}/notifications").
         with(body: hash_including(params)).
         to_return(status: 201, body: response_body)
@@ -38,6 +37,16 @@ module Pushpad
       stub_request(:post, "https://pushpad.xyz/api/v1/projects/#{project_id}/notifications").
         to_return(status: 403)
     end
+    
+    def stub_notification_delete(notification_id)
+      stub_request(:delete, "https://pushpad.xyz/api/v1/notifications/#{notification_id}/cancel").
+        to_return(status: 204)
+    end
+    
+    def stub_failing_notification_delete(notification_id)
+      stub_request(:delete, "https://pushpad.xyz/api/v1/notifications/#{notification_id}/cancel").
+        to_return(status: 404)
+    end
 
     describe ".new" do
       it "allows delivering notifications even if an id attribute is supplied" do
@@ -409,5 +418,27 @@ module Pushpad
         end
       end
     end
+    
+    describe "#cancel" do
+      it "cancels a scheduled notification" do
+        stub_notification_delete(5)
+        
+        notification = Notification.new(id: 5)
+        
+        res = notification.cancel
+        expect(res).to be_nil
+      end
+      
+      it "fails with CancelError if response status code is not 204" do
+        stub_failing_notification_delete(5)
+        
+        notification = Notification.new(id: 5)
+        
+        expect {
+          notification.cancel
+        }.to raise_error(Notification::CancelError)
+      end
+    end
+    
   end
 end

data/spec/pushpad/subscription_spec.rb

@@ -13,6 +13,17 @@ module Pushpad
       stub_request(:head, "https://pushpad.xyz/api/v1/projects/#{options[:project_id]}/subscriptions").
         to_return(status: 503)
     end
+    
+    def stub_subscriptions_get(options)
+      stub_request(:get, "https://pushpad.xyz/api/v1/projects/#{options[:project_id]}/subscriptions").
+        with(query: hash_including(options.fetch(:query, {}))).
+        to_return(status: 200, body: options[:list].to_json)
+    end
+    
+    def stub_failing_subscriptions_get(options)
+      stub_request(:get, "https://pushpad.xyz/api/v1/projects/#{options[:project_id]}/subscriptions").
+        to_return(status: 403)
+    end
 
     describe ".count" do
       it "returns value from X-Total-Count header" do
@@ -81,5 +92,110 @@ module Pushpad
         }.to raise_error(Subscription::CountError)
       end
     end
+    
+    describe ".find_all" do
+      it "returns subscriptions of project with attributes from json response" do
+        attributes = {
+          id: 1169,
+          endpoint: "https://example.com/push/f7Q1Eyf7EyfAb1", 
+          p256dh: "BCQVDTlYWdl05lal3lG5SKr3VxTrEWpZErbkxWrzknHrIKFwihDoZpc_2sH6Sh08h-CacUYI-H8gW4jH-uMYZQ4=",
+          auth: "cdKMlhgVeSPzCXZ3V7FtgQ==",
+          uid: "exampleUid", 
+          tags: ["exampleTag1", "exampleTag2"],
+          last_click_at: "2023-11-03T10:30:00.000Z",
+          created_at: "2016-09-06T10:47:05.494Z"
+        }
+        stub_subscriptions_get(project_id: 10, list: [attributes])
+
+        subscriptions = Subscription.find_all(project_id: 10)
+
+        attributes.delete(:last_click_at)
+        attributes.delete(:created_at)
+        expect(subscriptions[0]).to have_attributes(attributes)
+        expect(subscriptions[0].last_click_at.utc.to_s).to eq(Time.utc(2023, 11, 3, 10, 30, 0.0).to_s)
+        expect(subscriptions[0].created_at.utc.to_s).to eq(Time.utc(2016, 9, 6, 10, 47, 5.494).to_s)
+      end
+
+      it "falls back to global project id" do
+        attributes = { id: 5 }
+        stub_subscriptions_get(project_id: 10, list: [attributes])
+
+        Pushpad.project_id = 10
+        subscriptions = Subscription.find_all
+
+        expect(subscriptions[0]).to have_attributes(attributes)
+      end
+
+      it "fails with helpful error message when project_id is missing" do
+        Pushpad.project_id = nil
+
+        expect {
+          Subscription.find_all
+        }.to raise_error(/must set project_id/)
+      end
+
+      it "allows passing page parameter for pagination" do
+        attributes = { id: 5 }
+        stub_subscriptions_get(project_id: 10, list: [attributes], query: { page: "3" })
+
+        subscriptions = Subscription.find_all(project_id: 10, page: 3)
+
+        expect(subscriptions[0]).to have_attributes(attributes)
+      end
+
+      it "fails with FindError if response status code is not 200" do
+        stub_failing_subscriptions_get(project_id: 10)
+
+        expect {
+          Subscription.find_all(project_id: 10)
+        }.to raise_error(Subscription::FindError)
+      end
+      
+      it "allows passing uids" do
+        attributes = { id: 5 }
+        request = stub_subscriptions_get(project_id: 5, list: [attributes], query: { uids:  ["uid0", "uid1"] })
+
+        Subscription.find_all(project_id: 5, uids: ["uid0", "uid1"])
+
+        expect(request).to have_been_made.once
+      end
+
+      it "allows passing tags" do
+        attributes = { id: 5 }
+        request = stub_subscriptions_get(project_id: 5, list: [attributes], query: { tags:  ["sports", "travel"] })
+
+        Subscription.find_all(project_id: 5, tags: ["sports", "travel"])
+
+        expect(request).to have_been_made.once
+      end
+
+      it "allows passing tags as boolean expression" do
+        attributes = { id: 5 }
+        request = stub_subscriptions_get(project_id: 5, list: [attributes], query: { tags: "sports || travel" })
+
+        Subscription.find_all(project_id: 5, tags: "sports || travel")
+
+        expect(request).to have_been_made.once
+      end
+
+      it "allows passing tags and uids" do
+        attributes = { id: 5 }
+        request = stub_subscriptions_get(project_id: 5, list: [attributes],
+                                          query: { tags:  ["sports", "travel"], uids: ["uid0"] })
+
+        Subscription.find_all(project_id: 5, tags: ["sports", "travel"], uids: ["uid0"])
+
+        expect(request).to have_been_made.once
+      end
+      
+      it "works properly when there are no results" do
+        stub_subscriptions_get(project_id: 5, list: [])
+
+        subscriptions = Subscription.find_all(project_id: 5)
+
+        expect(subscriptions).to eq([])
+      end
+    end
+    
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pushpad
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Pushpad
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-30 00:00:00.000000000 Z
+date: 2024-09-18 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,8 +81,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Web push notifications for Chrome, Firefox, Opera, Edge and Safari using
   Pushpad.