pushpad 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dccdac2f6334014fc3b1a7fa42b5cc0644135df02b3e58f9c44f17e7fe00a27e
-  data.tar.gz: 69c4ea4985bdd6c120445e36c58e8adf0f572874dd7fd3ef929ad90176c84b18
+  metadata.gz: 328e31a9039907c359c8a9eeb0e560a71027163f2fbc05d4f899ef94dd21fad2
+  data.tar.gz: 334cc8c408c1b8c0c7a2bb9dcd982919c4f223cd36076869691d251ce932fdfb
 SHA512:
-  metadata.gz: b9ab88edcae1bcb44f8e6e1b388d25ee47459c81b6f2c72c9b450a1bf64b08dd874b019d518733a1cb4cf53c7f4f3c8feec7ffc418a144c81cc6b0864c1b67d2
-  data.tar.gz: 6540c56bb6cbaa46e496098669d081c7c66f35c20e1cc82bb4602510a696179c9fa71ba381dd1693c181fe32adf8a05ef5224ca9a2ea22f16648e35b2eca138b
+  metadata.gz: 1126ed9f343b6e9b57dfae141dd8a7c46c2234c459f10d906b3051e8932699851d986f53d8721ae32b3fa8bdb654011e594334d3c699dfaf74f80ee2bf072f6c
+  data.tar.gz: 9e0cdb926a5b27b306c74dfd24c556447001087eb6d62fb00d24d462bcbcf160920e39abf932c7bfac3bcb51f281367a074bd7121ce70e2bb628a4d24b7041fd

data/README.md

@@ -237,6 +237,83 @@ 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)
+```
+
+You can also retrieve the data of a specific subscription if you already know its id:
+
+```ruby
+Pushpad::Subscription.find 123
+Pushpad::Subscription.find 123, project_id: 456
+```
+
+## Updating push subscription data
+
+Usually you add data, like user IDs and tags, to the push subscriptions using the [JavaScript SDK](https://pushpad.xyz/docs/javascript_sdk_reference) in the frontend.
+
+However you can also update the subscription data from your server:
+
+```ruby
+Pushpad::Subscription.find_all(uids: ['user1']).each do |subscription|
+  # update the user ID associated to the push subscription
+  subscription.update uid: 'myuser1'
+  
+  # update the tags associated to the push subscription
+  tags = subscription.tags
+  tags << 'another_tag'
+  subscription.update tags: tags
+end
+```
+
+## Importing push subscriptions
+
+If you need to [import](https://pushpad.xyz/docs/import) some existing push subscriptions (from another service to Pushpad, or from your backups) or if you simply need to create some test data, you can use this method:
+
+```ruby
+attributes = {
+  endpoint: "https://example.com/push/f7Q1Eyf7EyfAb1", 
+  p256dh: "BCQVDTlYWdl05lal3lG5SKr3VxTrEWpZErbkxWrzknHrIKFwihDoZpc_2sH6Sh08h-CacUYI-H8gW4jH-uMYZQ4=",
+  auth: "cdKMlhgVeSPzCXZ3V7FtgQ==",
+  uid: "exampleUid", 
+  tags: ["exampleTag1", "exampleTag2"]
+}
+
+subscription = Pushpad::Subscription.create(attributes, project_id: 5)
+```
+
+Please note that this is not the standard way to collect subscriptions on Pushpad: usually you subscribe the users to the notifications using the [JavaScript SDK](https://pushpad.xyz/docs/javascript_sdk_reference) in the frontend.
+
+## Deleting push subscriptions
+
+Usually you unsubscribe a user from push notifications using the [JavaScript SDK](https://pushpad.xyz/docs/javascript_sdk_reference) in the frontend (recommended).
+
+However you can also delete the subscriptions using this library. Be careful, the subscriptions are permanently deleted!
+
+```ruby
+subscription = Pushpad::Subscription.find 123
+subscription.delete
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/pushpad/request.rb

@@ -19,6 +19,12 @@ module Pushpad
       end
     end
     
+    def patch(endpoint, body, options = {})
+      perform(Net::HTTP::Patch, endpoint, options) do |request|
+        request.body = body
+      end
+    end
+    
     def delete(endpoint, options = {})
       perform(Net::HTTP::Delete, endpoint, options)
     end

data/lib/pushpad/subscription.rb

@@ -1,52 +1,137 @@
 module Pushpad
   class Subscription
+    class CreateError < RuntimeError
+    end
+    
+    class UpdateError < RuntimeError
+    end
+    
     class CountError < RuntimeError
     end
-
-    def self.count(options = {})
-      CountQuery.new(options).perform
+    
+    class FindError < RuntimeError
+    end
+    
+    class DeleteError < 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 self.create(attributes, options = {})
+      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.post(endpoint, attributes.to_json)
 
-      def initialize(options)
-        @options = options
+      unless response.code == "201"
+        raise CreateError, "Response #{response.code} #{response.message}: #{response.body}"
       end
+      
+      new(JSON.parse(response.body, symbolize_names: true))
+    end
 
-      def perform
-        project_id = options[:project_id] || Pushpad.project_id
-        raise "You must set project_id" unless project_id
+    def self.count(options = {})
+      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)
+      endpoint = "https://pushpad.xyz/api/v1/projects/#{project_id}/subscriptions"
+      response = Request.head(endpoint, query_parameters: query_parameters(options))
 
-        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(id, options = {})
+      project_id = options[:project_id] || Pushpad.project_id
+      raise "You must set project_id" unless project_id
+      
+      response = Request.get("https://pushpad.xyz/api/v1/projects/#{project_id}/subscriptions/#{id}")
 
-        response["X-Total-Count"].to_i
+      unless response.code == "200"
+        raise FindError, "Response #{response.code} #{response.message}: #{response.body}"
       end
 
-      private
+      new(JSON.parse(response.body, symbolize_names: true))
+    end
+    
+    def self.find_all(options = {})
+      project_id = options[:project_id] || Pushpad.project_id
+      raise "You must set project_id" unless project_id
+
+      query_parameters_with_pagination = query_parameters(options)
+      query_parameters_with_pagination << ["page", options[:page]] if options.key?(:page)
+
+      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 update(attributes, options = {})
+      project_id = options[:project_id] || Pushpad.project_id
+      raise "You must set project_id" unless project_id
+      
+      raise "You must set id" unless id
+      
+      endpoint = "https://pushpad.xyz/api/v1/projects/#{project_id}/subscriptions/#{id}"
+      response = Request.patch(endpoint, attributes.to_json)
 
-      def tag_query_parameters
-        tags = options.fetch(:tags, [])
+      unless response.code == "200"
+        raise UpdateError, "Response #{response.code} #{response.message}: #{response.body}"
+      end
+      
+      attributes = JSON.parse(response.body, symbolize_names: true)
+      @uid = attributes[:uid]
+      @tags = attributes[:tags]
+      
+      self
+    end
+    
+    def delete(options = {})
+      project_id = options[:project_id] || Pushpad.project_id
+      raise "You must set project_id" unless project_id
+      
+      raise "You must set id" unless id
+      
+      response = Request.delete("https://pushpad.xyz/api/v1/projects/#{project_id}/subscriptions/#{id}")
 
-        if tags.is_a?(String)
-          [["tags", tags]]
-        else
-          tags.map { |tag| ["tags[]", tag] }
-        end
+      unless response.code == "204"
+        raise DeleteError, "Response #{response.code} #{response.message}: #{response.body}"
       end
     end
+
+    private
+
+    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.1.0'
+  spec.version       = '1.3.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/subscription_spec.rb

@@ -2,6 +2,16 @@ require "spec_helper"
 
 module Pushpad
   describe Subscription do
+    def stub_subscription_get(options)
+      stub_request(:get, "https://pushpad.xyz/api/v1/projects/#{options[:project_id]}/subscriptions/#{options[:id]}").
+        to_return(status: 200, body: options[:attributes].to_json)
+    end
+
+    def stub_failing_subscription_get(options)
+      stub_request(:get, "https://pushpad.xyz/api/v1/projects/#{options[:project_id]}/subscriptions/#{options[:id]}").
+        to_return(status: 404)
+    end
+    
     def stub_subscriptions_head(options)
       stub_request(:head, "https://pushpad.xyz/api/v1/projects/#{options[:project_id]}/subscriptions").
         with(query: hash_including(options.fetch(:query, {}))).
@@ -13,6 +23,74 @@ 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
+    
+    def stub_subscriptions_post(project_id, attributes = {})
+      stub_request(:post, "https://pushpad.xyz/api/v1/projects/#{project_id}/subscriptions").
+        with(body: hash_including(attributes)).
+        to_return(status: 201, body: attributes.to_json)
+    end
+
+    def stub_failing_subscriptions_post(project_id)
+      stub_request(:post, "https://pushpad.xyz/api/v1/projects/#{project_id}/subscriptions").
+        to_return(status: 403)
+    end
+    
+    def stub_subscription_patch(project_id, id, attributes = {})
+      stub_request(:patch, "https://pushpad.xyz/api/v1/projects/#{project_id}/subscriptions/#{id}").
+        with(body: hash_including(attributes)).
+        to_return(status: 200, body: attributes.to_json)
+    end
+
+    def stub_failing_subscription_patch(project_id, id)
+      stub_request(:patch, "https://pushpad.xyz/api/v1/projects/#{project_id}/subscriptions/#{id}").
+        to_return(status: 422)
+    end
+    
+    def stub_subscription_delete(project_id, id)
+      stub_request(:delete, "https://pushpad.xyz/api/v1/projects/#{project_id}/subscriptions/#{id}").
+        to_return(status: 204)
+    end
+    
+    def stub_failing_subscription_delete(project_id, id)
+      stub_request(:delete, "https://pushpad.xyz/api/v1/projects/#{project_id}/subscriptions/#{id}").
+        to_return(status: 403)
+    end
+    
+    describe ".create" do
+      it "creates a new subscription with the given attributes and returns it" do
+        attributes = {
+          endpoint: "https://example.com/push/f7Q1Eyf7EyfAb1", 
+          p256dh: "BCQVDTlYWdl05lal3lG5SKr3VxTrEWpZErbkxWrzknHrIKFwihDoZpc_2sH6Sh08h-CacUYI-H8gW4jH-uMYZQ4=",
+          auth: "cdKMlhgVeSPzCXZ3V7FtgQ==",
+          uid: "exampleUid", 
+          tags: ["exampleTag1", "exampleTag2"]
+        }
+        stub_subscriptions_post(5, attributes)
+
+        subscription = Subscription.create(attributes, project_id: 5)
+        expect(subscription).to have_attributes(attributes)
+      end
+      
+      it "fails with CreateError if response status code is not 201" do
+        attributes = { endpoint: "https://example.com/push/123" }
+        stub_failing_subscriptions_post(5)
+
+        expect {
+          Subscription.create(attributes, project_id: 5)
+        }.to raise_error(Subscription::CreateError)
+      end
+    end
 
     describe ".count" do
       it "returns value from X-Total-Count header" do
@@ -81,5 +159,214 @@ module Pushpad
         }.to raise_error(Subscription::CountError)
       end
     end
+    
+    describe ".find" do
+      it "returns subscription with attributes from json response" do
+        attributes = {
+          id: 5,
+          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_subscription_get(id: 5, project_id: 10, attributes: attributes)
+
+        subscription = Subscription.find(5, project_id: 10)
+
+        attributes.delete(:last_click_at)
+        attributes.delete(:created_at)
+        expect(subscription).to have_attributes(attributes)
+        expect(subscription.last_click_at.utc.to_s).to eq(Time.utc(2023, 11, 3, 10, 30, 0.0).to_s)
+        expect(subscription.created_at.utc.to_s).to eq(Time.utc(2016, 9, 6, 10, 47, 5.494).to_s)
+      end
+
+      it "fails with FindError if response status code is not 200" do
+        stub_failing_subscription_get(id: 5, project_id: 10)
+
+        expect {
+          Subscription.find(5, project_id: 10)
+        }.to raise_error(Subscription::FindError)
+      end
+      
+      it "fails with helpful error message when project_id is missing" do
+        Pushpad.project_id = nil
+
+        expect {
+          Subscription.find 5
+        }.to raise_error(/must set project_id/)
+      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
+    
+    describe "#update" do
+      it "updates a subscription with the given attributes and returns it" do
+        attributes = {
+          uid: "exampleUid", 
+          tags: ["exampleTag1", "exampleTag2"]
+        }
+        stub_subscription_patch(5, 123, attributes)
+
+        subscription = Subscription.new(id: 123)
+        subscription.update attributes, project_id: 5
+        expect(subscription).to have_attributes(attributes)
+      end
+      
+      it "fails with UpdateError if response status code is not 200" do
+        attributes = { uid: "exampleUid" }
+        stub_failing_subscription_patch(5, 123)
+
+        subscription = Subscription.new(id: 123)
+        
+        expect {
+          subscription.update attributes, project_id: 5
+        }.to raise_error(Subscription::UpdateError)
+      end
+      
+      it "fails with helpful error message when project_id is missing" do
+        Pushpad.project_id = nil
+
+        expect {
+          Subscription.new(id: 123).update({})
+        }.to raise_error(/must set project_id/)
+      end
+      
+      it "fails with helpful error message when id is missing" do
+        Pushpad.project_id = 5
+        
+        expect {
+          Subscription.new(id: nil).update({})
+        }.to raise_error(/must set id/)
+      end
+    end
+    
+    describe "#delete" do
+      it "deletes a subscription" do
+        Pushpad.project_id = 5
+        stub_subscription_delete(5, 123)
+        
+        subscription = Subscription.new(id: 123)
+        
+        res = subscription.delete
+        expect(res).to be_nil
+      end
+      
+      it "fails with DeleteError if response status code is not 204" do
+        Pushpad.project_id = 5
+        stub_failing_subscription_delete(5, 123)
+        
+        subscription = Subscription.new(id: 123)
+        
+        expect {
+          subscription.delete
+        }.to raise_error(Subscription::DeleteError)
+      end
+    end
+    
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pushpad
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Pushpad
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-18 00:00:00.000000000 Z
+date: 2024-09-19 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.5.16
-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.