pushpad 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a4c81351920b86c10b9926e94eb2aca07a9da9b87ddb3f9d4725459a0993e9c
-  data.tar.gz: 657f63d05bcabe69c8a197199ab516452d893450ad221b33a07b28162eb7d9be
+  metadata.gz: 79880c6abcf0f8ecda48ad0df65bb07ee440660f58fb5fd60d898ceb162d5263
+  data.tar.gz: aa148bdaf14910ea7041867163d3f524682be1e54533d6153c790326961c7edc
 SHA512:
-  metadata.gz: 6a1e76b5ebfc31b43af6ff17d394c3f4bc88b41f359ab42359e018e5a213bda46c93ca830b3ec663b6b04d915244eda457463305ded412eb56fc448b50cac332
-  data.tar.gz: cebbc1b3610953a2064549998acc12348e9bd33c69ef97d20bbfb5f6bdcc4d7c94357cc0296dd4584ec68cb4ac8b3cb883cfa0cd774bff842dc326c1c760abd6
+  metadata.gz: 8e0b08f9dc1b48b61fc4fc12f8a0a6a22872de66d4e61736792a5548b2f4795b36e5f9275589cfd8d717baf86278908b0833305bbb6fd1ab8fac75150a47d177
+  data.tar.gz: '08d16dc17ec9b9a5e2454f254fde072880c2eb50f84b298b882362d36c9b40dc8957b75fcb8935b5e045279c76a1da7de4fbaea685d8e9dedfed365d2993f093'

data/.github/workflows/ci.yml

@@ -10,9 +10,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: ['3.0', '3.1', '3.2', '3.3']
+        ruby-version: ['3.0', '3.1', '3.2', '3.3', '3.4']
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v5
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/LICENSE.txt

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

@@ -350,6 +350,38 @@ project.update(name: 'The New Project Name')
 project.delete
 ```
 
+## Managing senders
+
+Senders are usually created manually from the Pushpad dashboard. However you can also create senders from code.
+
+```ruby
+attributes = {
+  # required attributes
+  name: "My sender",
+  
+  # optional configurations
+  # do not include these fields if you want to generate them automatically
+  vapid_private_key: "-----BEGIN EC PRIVATE KEY----- ...",
+  vapid_public_key: "-----BEGIN PUBLIC KEY----- ..."
+}
+
+sender = Pushpad::Sender.create(attributes)
+```
+
+You can also find, update and delete senders:
+
+```ruby
+Pushpad::Sender.find_all.each do |s|
+  puts "Sender #{s.id}: #{s.name}"
+end
+
+sender = Pushpad::Sender.find 987
+
+sender.update(name: 'The New Sender Name')
+
+sender.delete
+```
+
 ## 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

@@ -16,10 +16,11 @@ module Pushpad
     end
 
     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
+    attr_reader :id, :project_id, :created_at, :scheduled_count, :successfully_sent_count, :opened_count
 
     def initialize(options)
       @id = options[:id]
+      @project_id = options[:project_id]
       @created_at = options[:created_at] && Time.parse(options[:created_at])
       @scheduled_count = options[:scheduled_count]
       @successfully_sent_count = options[:successfully_sent_count]

data/lib/pushpad/sender.rb

@@ -0,0 +1,90 @@
+module Pushpad
+  class Sender
+    class CreateError < RuntimeError
+    end
+    
+    class FindError < RuntimeError
+    end
+    
+    class UpdateError < RuntimeError
+    end
+    
+    class DeleteError < RuntimeError
+    end
+    
+    ATTRIBUTES = :id, :name, :vapid_private_key, :vapid_public_key, :created_at
+    
+    attr_reader *ATTRIBUTES
+    
+    def initialize(options)
+      @id = options[:id]
+      @name = options[:name]
+      @vapid_private_key = options[:vapid_private_key]
+      @vapid_public_key = options[:vapid_public_key]
+      @created_at = options[:created_at] && Time.parse(options[:created_at])
+    end
+    
+    def self.create(attributes)      
+      endpoint = "https://pushpad.xyz/api/v1/senders"
+      response = Request.post(endpoint, attributes.to_json)
+      
+      unless response.code == "201"
+        raise CreateError, "Response #{response.code} #{response.message}: #{response.body}"
+      end
+      
+      new(JSON.parse(response.body, symbolize_names: true))
+    end
+    
+    def self.find(id)  
+      response = Request.get("https://pushpad.xyz/api/v1/senders/#{id}")
+      
+      unless response.code == "200"
+        raise FindError, "Response #{response.code} #{response.message}: #{response.body}"
+      end
+      
+      new(JSON.parse(response.body, symbolize_names: true))
+    end
+    
+    def self.find_all
+      response = Request.get("https://pushpad.xyz/api/v1/senders")
+      
+      unless response.code == "200"
+        raise FindError, "Response #{response.code} #{response.message}: #{response.body}"
+      end
+      
+      JSON.parse(response.body, symbolize_names: true).map do |attributes|
+        new(attributes)
+      end
+    end
+    
+    def update(attributes)      
+      raise "You must set id" unless id
+      
+      endpoint = "https://pushpad.xyz/api/v1/senders/#{id}"
+      response = Request.patch(endpoint, attributes.to_json)
+      
+      unless response.code == "200"
+        raise UpdateError, "Response #{response.code} #{response.message}: #{response.body}"
+      end
+      
+      updated = self.class.new(JSON.parse(response.body, symbolize_names: true))
+      
+      ATTRIBUTES.each do |attr|
+        self.instance_variable_set("@#{attr}", updated.instance_variable_get("@#{attr}"))
+      end
+      
+      self
+    end
+    
+    def delete      
+      raise "You must set id" unless id
+      
+      response = Request.delete("https://pushpad.xyz/api/v1/senders/#{id}")
+      
+      unless response.code == "204"
+        raise DeleteError, "Response #{response.code} #{response.message}: #{response.body}"
+      end
+    end
+    
+  end
+end

data/lib/pushpad/subscription.rb

@@ -15,10 +15,11 @@ module Pushpad
     class DeleteError < RuntimeError
     end
     
-    attr_reader :id, :endpoint, :p256dh, :auth, :uid, :tags, :last_click_at, :created_at
+    attr_reader :id, :project_id, :endpoint, :p256dh, :auth, :uid, :tags, :last_click_at, :created_at
 
     def initialize(options)
       @id = options[:id]
+      @project_id = options[:project_id]
       @endpoint = options[:endpoint]
       @p256dh = options[:p256dh]
       @auth = options[:auth]
@@ -89,7 +90,7 @@ module Pushpad
     end
     
     def update(attributes, options = {})
-      project_id = options[:project_id] || Pushpad.project_id
+      project_id = project_id || options[:project_id] || Pushpad.project_id
       raise "You must set project_id" unless project_id
       
       raise "You must set id" unless id
@@ -109,7 +110,7 @@ module Pushpad
     end
     
     def delete(options = {})
-      project_id = options[:project_id] || Pushpad.project_id
+      project_id = project_id || options[:project_id] || Pushpad.project_id
       raise "You must set project_id" unless project_id
       
       raise "You must set id" unless id

data/lib/pushpad.rb

@@ -4,6 +4,7 @@ require "pushpad/request"
 require "pushpad/notification"
 require "pushpad/subscription"
 require "pushpad/project"
+require "pushpad/sender"
 
 module Pushpad
   @@auth_token = nil

data/pushpad.gemspec

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

@@ -62,6 +62,7 @@ module Pushpad
       it "returns notification with attributes from json response" do
         attributes = {
           id: 5,
+          project_id: 123,
           title: "Foo Bar",
           body: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
           target_url: "https://example.com",
@@ -118,6 +119,7 @@ module Pushpad
       it "returns notifications of project with attributes from json response" do
         attributes = {
           id: 5,
+          project_id: 123,
           title: "Foo Bar",
           body: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
           target_url: "https://example.com",

data/spec/pushpad/sender_spec.rb

@@ -0,0 +1,199 @@
+require "spec_helper"
+
+module Pushpad
+  describe Sender do
+    
+    def stub_senders_post(attributes = {})
+      stub_request(:post, "https://pushpad.xyz/api/v1/senders").
+        with(body: hash_including(attributes)).
+        to_return(status: 201, body: attributes.to_json)
+    end
+    
+    def stub_failing_senders_post
+      stub_request(:post, "https://pushpad.xyz/api/v1/senders").
+        to_return(status: 422)
+    end
+    
+    def stub_sender_get(attributes)
+      stub_request(:get, "https://pushpad.xyz/api/v1/senders/#{attributes[:id]}").
+        to_return(status: 200, body: attributes.to_json)
+    end
+    
+    def stub_failing_sender_get(attributes)
+      stub_request(:get, "https://pushpad.xyz/api/v1/senders/#{attributes[:id]}").
+        to_return(status: 404)
+    end
+    
+    def stub_senders_get(list)
+      stub_request(:get, "https://pushpad.xyz/api/v1/senders").
+        to_return(status: 200, body: list.to_json)
+    end
+    
+    def stub_failing_senders_get
+      stub_request(:get, "https://pushpad.xyz/api/v1/senders").
+        to_return(status: 401)
+    end
+    
+    def stub_sender_patch(id, attributes)
+      stub_request(:patch, "https://pushpad.xyz/api/v1/senders/#{id}").
+        with(body: hash_including(attributes)).
+        to_return(status: 200, body: attributes.to_json)
+    end
+    
+    def stub_failing_sender_patch(id)
+      stub_request(:patch, "https://pushpad.xyz/api/v1/senders/#{id}").
+        to_return(status: 422)
+    end
+    
+    def stub_sender_delete(id)
+      stub_request(:delete, "https://pushpad.xyz/api/v1/senders/#{id}").
+        to_return(status: 204)
+    end
+    
+    def stub_failing_sender_delete(id)
+      stub_request(:delete, "https://pushpad.xyz/api/v1/senders/#{id}").
+        to_return(status: 403)
+    end
+    
+    describe ".create" do
+      it "creates a new sender with the given attributes and returns it" do
+        attributes = {
+          name: "My sender"
+        }
+        stub = stub_senders_post(attributes)
+        
+        sender = Sender.create(attributes)
+        expect(sender).to have_attributes(attributes)
+        
+        expect(stub).to have_been_requested
+      end
+      
+      it "fails with CreateError if response status code is not 201" do
+        attributes = { name: "" }
+        stub_failing_senders_post
+        
+        expect {
+          Sender.create(attributes)
+        }.to raise_error(Sender::CreateError)
+      end
+    end
+    
+    describe ".find" do
+      it "returns sender with attributes from json response" do
+        attributes = {
+          id: 182,
+          name: "My sender",
+          vapid_private_key: "-----BEGIN EC PRIVATE KEY----- ...",
+          vapid_public_key: "-----BEGIN PUBLIC KEY----- ...",
+          created_at: "2016-07-06T11:28:21.266Z"
+        }
+        stub_sender_get(attributes)
+        
+        sender = Sender.find(182)
+        
+        attributes.delete(:created_at)
+        expect(sender).to have_attributes(attributes)
+        expect(sender.created_at.utc.to_s).to eq(Time.utc(2016, 7, 6, 11, 28, 21.266).to_s)
+      end
+
+      it "fails with FindError if response status code is not 200" do
+        attributes = { id: 362 }
+        stub_failing_sender_get(attributes)
+        
+        expect {
+          Sender.find(362)
+        }.to raise_error(Sender::FindError)
+      end
+    end
+    
+    describe ".find_all" do
+      it "returns senders with attributes from json response" do
+        attributes = {
+          id: 182,
+          name: "My sender",
+          vapid_private_key: "-----BEGIN EC PRIVATE KEY----- ...",
+          vapid_public_key: "-----BEGIN PUBLIC KEY----- ...",
+          created_at: "2016-07-06T11:28:21.266Z"
+        }
+        stub_senders_get([attributes])
+        
+        senders = Sender.find_all
+        
+        attributes.delete(:created_at)
+        expect(senders[0]).to have_attributes(attributes)
+        expect(senders[0].created_at.utc.to_s).to eq(Time.utc(2016, 7, 6, 11, 28, 21.266).to_s)
+      end
+
+      it "fails with FindError if response status code is not 200" do
+        stub_failing_senders_get
+        
+        expect {
+          Sender.find_all
+        }.to raise_error(Sender::FindError)
+      end
+
+      it "works properly when there are no results" do
+        stub_senders_get([])
+        
+        senders = Sender.find_all
+        
+        expect(senders).to eq([])
+      end
+    end
+    
+    describe "#update" do
+      it "updates a sender with the given attributes and returns it" do
+        attributes = {
+          name: "The New Sender Name"
+        }
+        stub = stub_sender_patch(5, attributes)
+        
+        sender = Sender.new(id: 5)
+        sender.update attributes
+        expect(sender).to have_attributes(attributes)
+        
+        expect(stub).to have_been_requested
+      end
+      
+      it "fails with UpdateError if response status code is not 200" do
+        attributes = { name: "" }
+        stub_failing_sender_patch(5)
+        
+        sender = Sender.new(id: 5)
+        
+        expect {
+          sender.update attributes
+        }.to raise_error(Sender::UpdateError)
+      end
+      
+      it "fails with helpful error message when id is missing" do
+        expect {
+          Sender.new(id: nil).update({})
+        }.to raise_error(/must set id/)
+      end
+    end
+    
+    describe "#delete" do
+      it "deletes a sender" do
+        stub = stub_sender_delete(5)
+        
+        sender = Sender.new(id: 5)
+        res = sender.delete
+        expect(res).to be_nil
+        
+        expect(stub).to have_been_requested
+      end
+      
+      it "fails with DeleteError if response status code is not 204" do
+        stub_failing_sender_delete(5)
+        
+        sender = Sender.new(id: 5)
+        
+        expect {
+          sender.delete
+        }.to raise_error(Sender::DeleteError)
+      end
+    end
+    
+  end
+end

data/spec/pushpad/subscription_spec.rb

@@ -164,6 +164,7 @@ module Pushpad
       it "returns subscription with attributes from json response" do
         attributes = {
           id: 5,
+          project_id: 123,
           endpoint: "https://example.com/push/f7Q1Eyf7EyfAb1", 
           p256dh: "BCQVDTlYWdl05lal3lG5SKr3VxTrEWpZErbkxWrzknHrIKFwihDoZpc_2sH6Sh08h-CacUYI-H8gW4jH-uMYZQ4=",
           auth: "cdKMlhgVeSPzCXZ3V7FtgQ==",
@@ -204,6 +205,7 @@ module Pushpad
       it "returns subscriptions of project with attributes from json response" do
         attributes = {
           id: 1169,
+          project_id: 123,
           endpoint: "https://example.com/push/f7Q1Eyf7EyfAb1", 
           p256dh: "BCQVDTlYWdl05lal3lG5SKr3VxTrEWpZErbkxWrzknHrIKFwihDoZpc_2sH6Sh08h-CacUYI-H8gW4jH-uMYZQ4=",
           auth: "cdKMlhgVeSPzCXZ3V7FtgQ==",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pushpad
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Pushpad
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-21 00:00:00.000000000 Z
+date: 2025-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -56,11 +56,13 @@ files:
 - lib/pushpad/notification.rb
 - lib/pushpad/project.rb
 - lib/pushpad/request.rb
+- lib/pushpad/sender.rb
 - lib/pushpad/subscription.rb
 - pushpad.gemspec
 - spec/pushpad/notification_spec.rb
 - spec/pushpad/project_spec.rb
 - spec/pushpad/request_spec.rb
+- spec/pushpad/sender_spec.rb
 - spec/pushpad/subscription_spec.rb
 - spec/pushpad_spec.rb
 - spec/spec_helper.rb
@@ -83,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Web push notifications for Chrome, Firefox, Opera, Edge and Safari using
@@ -92,6 +94,7 @@ test_files:
 - spec/pushpad/notification_spec.rb
 - spec/pushpad/project_spec.rb
 - spec/pushpad/request_spec.rb
+- spec/pushpad/sender_spec.rb
 - spec/pushpad/subscription_spec.rb
 - spec/pushpad_spec.rb
 - spec/spec_helper.rb