pushpad 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 328e31a9039907c359c8a9eeb0e560a71027163f2fbc05d4f899ef94dd21fad2
-  data.tar.gz: 334cc8c408c1b8c0c7a2bb9dcd982919c4f223cd36076869691d251ce932fdfb
+  metadata.gz: 917e13bafb6ed1f686bb914ca94d76142db3e5e0bc170889c225832e245bf901
+  data.tar.gz: 3a5031fda8ea89b8daafb8c39180ca3901102eb19bdfe61f8ac0f9352d120131
 SHA512:
-  metadata.gz: 1126ed9f343b6e9b57dfae141dd8a7c46c2234c459f10d906b3051e8932699851d986f53d8721ae32b3fa8bdb654011e594334d3c699dfaf74f80ee2bf072f6c
-  data.tar.gz: 9e0cdb926a5b27b306c74dfd24c556447001087eb6d62fb00d24d462bcbcf160920e39abf932c7bfac3bcb51f281367a074bd7121ce70e2bb628a4d24b7041fd
+  metadata.gz: 3a6d0fd32f9312c3938af25bfdc94975cdd383d273e3ede4a84f502092f3c4bdbba18f4776b29675a97a282895646c7c7dd5a49295e4ee73bc4bdae70eb2aa55
+  data.tar.gz: 4c984708c630416ade56a76c311471ce4dd7117e12eb75ea577b4af474bf64a839ccca894fa79c81d096f7319b9c3ca8b9d16bb488f9a1038e5262a5e50eed20

data/LICENSE.txt

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

@@ -314,6 +314,74 @@ subscription = Pushpad::Subscription.find 123
 subscription.delete
 ```
 
+## Managing projects
+
+Projects are usually created manually from the Pushpad dashboard. However you can also create projects from code if you need advanced automation or if you manage [many different domains](https://pushpad.xyz/docs/multiple_domains).
+
+```ruby
+attributes = {
+  # required attributes
+  sender_id: 123,
+  name: "My project",
+  website: "https://example.com",
+  
+  # optional configurations
+  icon_url: "https://example.com/icon.png",
+  badge_url: "https://example.com/badge.png",
+  notifications_ttl: 604800,
+  notifications_require_interaction: false,
+  notifications_silent: false
+}
+
+project = Pushpad::Project.create(attributes)
+```
+
+You can also find, update and delete projects:
+
+```ruby
+Pushpad::Project.find_all.each do |p|
+  puts "Project #{p.id}: #{p.name}"
+end
+
+project = Pushpad::Project.find 123
+
+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/project.rb

@@ -0,0 +1,95 @@
+module Pushpad
+  class Project
+    class CreateError < RuntimeError
+    end
+    
+    class FindError < RuntimeError
+    end
+    
+    class UpdateError < RuntimeError
+    end
+    
+    class DeleteError < RuntimeError
+    end
+    
+    ATTRIBUTES = :id, :sender_id, :name, :website, :icon_url, :badge_url, :notifications_ttl, :notifications_require_interaction, :notifications_silent, :created_at
+    
+    attr_reader *ATTRIBUTES
+    
+    def initialize(options)
+      @id = options[:id]
+      @sender_id = options[:sender_id]
+      @name = options[:name]
+      @website = options[:website]
+      @icon_url = options[:icon_url]
+      @badge_url = options[:badge_url]
+      @notifications_ttl = options[:notifications_ttl]
+      @notifications_require_interaction = options[:notifications_require_interaction] 
+      @notifications_silent = options[:notifications_silent]
+      @created_at = options[:created_at] && Time.parse(options[:created_at])
+    end
+    
+    def self.create(attributes)      
+      endpoint = "https://pushpad.xyz/api/v1/projects"
+      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/projects/#{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/projects")
+      
+      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/projects/#{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/projects/#{id}")
+      
+      unless response.code == "202"
+        raise DeleteError, "Response #{response.code} #{response.message}: #{response.body}"
+      end
+    end
+    
+  end
+end

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.rb

@@ -3,6 +3,8 @@ require 'openssl'
 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.3.0'
+  spec.version       = '1.5.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/project_spec.rb

@@ -0,0 +1,211 @@
+require "spec_helper"
+
+module Pushpad
+  describe Project do
+    
+    def stub_projects_post(attributes = {})
+      stub_request(:post, "https://pushpad.xyz/api/v1/projects").
+        with(body: hash_including(attributes)).
+        to_return(status: 201, body: attributes.to_json)
+    end
+    
+    def stub_failing_projects_post
+      stub_request(:post, "https://pushpad.xyz/api/v1/projects").
+        to_return(status: 422)
+    end
+    
+    def stub_project_get(attributes)
+      stub_request(:get, "https://pushpad.xyz/api/v1/projects/#{attributes[:id]}").
+        to_return(status: 200, body: attributes.to_json)
+    end
+    
+    def stub_failing_project_get(attributes)
+      stub_request(:get, "https://pushpad.xyz/api/v1/projects/#{attributes[:id]}").
+        to_return(status: 404)
+    end
+    
+    def stub_projects_get(list)
+      stub_request(:get, "https://pushpad.xyz/api/v1/projects").
+        to_return(status: 200, body: list.to_json)
+    end
+    
+    def stub_failing_projects_get
+      stub_request(:get, "https://pushpad.xyz/api/v1/projects").
+        to_return(status: 401)
+    end
+    
+    def stub_project_patch(id, attributes)
+      stub_request(:patch, "https://pushpad.xyz/api/v1/projects/#{id}").
+        with(body: hash_including(attributes)).
+        to_return(status: 200, body: attributes.to_json)
+    end
+    
+    def stub_failing_project_patch(id)
+      stub_request(:patch, "https://pushpad.xyz/api/v1/projects/#{id}").
+        to_return(status: 422)
+    end
+    
+    def stub_project_delete(id)
+      stub_request(:delete, "https://pushpad.xyz/api/v1/projects/#{id}").
+        to_return(status: 202)
+    end
+    
+    def stub_failing_project_delete(id)
+      stub_request(:delete, "https://pushpad.xyz/api/v1/projects/#{id}").
+        to_return(status: 403)
+    end
+    
+    describe ".create" do
+      it "creates a new project with the given attributes and returns it" do
+        attributes = {
+          sender_id: 123,
+          name: "My project",
+          website: "https://example.com"
+        }
+        stub = stub_projects_post(attributes)
+        
+        project = Project.create(attributes)
+        expect(project).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: "My project" }
+        stub_failing_projects_post
+        
+        expect {
+          Project.create(attributes)
+        }.to raise_error(Project::CreateError)
+      end
+    end
+    
+    describe ".find" do
+      it "returns project with attributes from json response" do
+        attributes = {
+          id: 361,
+          sender_id: 123,
+          name: "Example Project",
+          website: "https://example.com",
+          icon_url: "https://example.com/icon.png",
+          badge_url: "https://example.com/badge.png",
+          notifications_ttl: 604800,
+          notifications_require_interaction: false,
+          notifications_silent: false,
+          created_at: "2016-07-06T10:58:39.143Z"
+        }
+        stub_project_get(attributes)
+        
+        project = Project.find(361)
+        
+        attributes.delete(:created_at)
+        expect(project).to have_attributes(attributes)
+        expect(project.created_at.utc.to_s).to eq(Time.utc(2016, 7, 6, 10, 58, 39.143).to_s)
+      end
+
+      it "fails with FindError if response status code is not 200" do
+        attributes = { id: 362 }
+        stub_failing_project_get(attributes)
+        
+        expect {
+          Project.find(362)
+        }.to raise_error(Project::FindError)
+      end
+    end
+    
+    describe ".find_all" do
+      it "returns projects with attributes from json response" do
+        attributes = {
+          id: 361,
+          sender_id: 123,
+          name: "Example Project",
+          website: "https://example.com",
+          icon_url: "https://example.com/icon.png",
+          badge_url: "https://example.com/badge.png",
+          notifications_ttl: 604800,
+          notifications_require_interaction: false,
+          notifications_silent: false,
+          created_at: "2016-07-06T10:58:39.143Z"
+        }
+        stub_projects_get([attributes])
+        
+        projects = Project.find_all
+        
+        attributes.delete(:created_at)
+        expect(projects[0]).to have_attributes(attributes)
+        expect(projects[0].created_at.utc.to_s).to eq(Time.utc(2016, 7, 6, 10, 58, 39.143).to_s)
+      end
+
+      it "fails with FindError if response status code is not 200" do
+        stub_failing_projects_get
+        
+        expect {
+          Project.find_all
+        }.to raise_error(Project::FindError)
+      end
+
+      it "works properly when there are no results" do
+        stub_projects_get([])
+        
+        projects = Project.find_all
+        
+        expect(projects).to eq([])
+      end
+    end
+    
+    describe "#update" do
+      it "updates a project with the given attributes and returns it" do
+        attributes = {
+          name: "The New Project Name"
+        }
+        stub = stub_project_patch(5, attributes)
+        
+        project = Project.new(id: 5)
+        project.update attributes
+        expect(project).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_project_patch(5)
+        
+        project = Project.new(id: 5)
+        
+        expect {
+          project.update attributes
+        }.to raise_error(Project::UpdateError)
+      end
+      
+      it "fails with helpful error message when id is missing" do
+        expect {
+          Project.new(id: nil).update({})
+        }.to raise_error(/must set id/)
+      end
+    end
+    
+    describe "#delete" do
+      it "deletes a project" do
+        stub = stub_project_delete(5)
+        
+        project = Project.new(id: 5)
+        res = project.delete
+        expect(res).to be_nil
+        
+        expect(stub).to have_been_requested
+      end
+      
+      it "fails with DeleteError if response status code is not 202" do
+        stub_failing_project_delete(5)
+        
+        project = Project.new(id: 5)
+        
+        expect {
+          project.delete
+        }.to raise_error(Project::DeleteError)
+      end
+    end
+    
+  end
+end

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pushpad
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Pushpad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-19 00:00:00.000000000 Z
+date: 2024-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -54,11 +54,15 @@ files:
 - Rakefile
 - lib/pushpad.rb
 - 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
@@ -88,7 +92,9 @@ summary: Web push notifications for Chrome, Firefox, Opera, Edge and Safari usin
   Pushpad.
 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