web-push 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a688b354339ddf4f82d8febb54a2042bb432357dffd77a571c3c9212c107aa2f
-  data.tar.gz: 01060b2687a57217cafb2cf96b3925c6e2e39102daf6f796277d06d767ae6a0e
+  metadata.gz: e3bdb2158142d9ffd8c7f50671b7613afd5f19021a16b9416aae42b8c05e8403
+  data.tar.gz: 81d443e347403d3a22a8d8c91998bec7280b2015930a9303bbc9143014304748
 SHA512:
-  metadata.gz: 2386c18e4fef78c027b2a5dee6a1778dc82d43cf26dcf0468e83feb8ff972eca1b743c87d68612fffee8ea9feb05329bc4a06127599643de72d922b465aca776
-  data.tar.gz: b023139054b433c36d32d5a91465e8d0082231a6c7c2e8f0ff79825599457c28b57e51ffcabdf21e7fb03ab5e63a28750c00fddfea74204c3f8da640fd9ffe38
+  metadata.gz: 3b2d34d5da7ecb7705abc060be5f4578eb2cfe5cd9d4fd62f7b13ecb4d2473c0009e174d3553850cc7abe68d4900741d1d9eee6f92846222a5adaef9bb9ba1f4
+  data.tar.gz: d14f4adfe100b421638daa9e3b47d4221d39f8f35cade077f28e7d82f105ee84532facb813aa7165c9c86085c9a3c7c58dbafa917ec3ba4da9d5ee5b78d90875

data/.github/workflows/ci.yml

@@ -9,11 +9,11 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-20.04, ubuntu-22.04]
-        ruby-version: ['3.0', '3.1', '3.2']
+        os: [ubuntu-22.04, ubuntu-24.04]
+        ruby-version: ['3.0', '3.1', '3.2', '3.3', '3.4']
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v6
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/LICENSE

@@ -1,5 +1,5 @@
 Copyright (c) 2016 Hiroyuki Sakuraba
-Copyright (c) 2022 Marco Colli, Pushpad (https://pushpad.xyz)
+Copyright (c) 2022-2025 Marco Colli, 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

data/README.md

@@ -5,7 +5,8 @@
 
 This gem makes it possible to send push messages to web browsers from Ruby backends using the [Web Push Protocol](https://datatracker.ietf.org/doc/html/rfc8030). It supports [Message Encryption for Web Push](https://datatracker.ietf.org/doc/html/rfc8291) and [VAPID](https://datatracker.ietf.org/doc/html/rfc8292).
 
-**Note**: This is an open source gem for Web Push. If you want to send web push notifications from Ruby using Pushpad, you need to use another gem ([pushpad gem](https://github.com/pushpad/pushpad-ruby)).
+> [!NOTE]
+> This is an open source gem for Web Push maintained by Pushpad. If you want to send web push notifications from Ruby using Pushpad (the cloud service), use the [pushpad gem](https://github.com/pushpad/pushpad-ruby).
 
 ## Installation
 
@@ -55,10 +56,16 @@ navigator.serviceWorker.register('/service-worker.js')
 
 ### Subscribing to push notifications
 
-The VAPID public key you generated earlier is made available to the client as a `UInt8Array`. To do this, one way would be to expose the urlsafe-decoded bytes from Ruby to JavaScript when rendering the HTML template.
+The VAPID public key that you generated earlier needs to be made available to JavaScript, which can be done in many ways, for example with a fetch request or when rendering the HTML template in Ruby:
 
-```javascript
-window.vapidPublicKey = new Uint8Array(<%= Base64.urlsafe_decode64(ENV['VAPID_PUBLIC_KEY']).bytes %>);
+```erb
+<script>
+// Make the VAPID public key available to the client as a Uint8Array
+window.vapidPublicKey = new Uint8Array(<%= Base64.urlsafe_decode64(ENV['VAPID_PUBLIC_KEY']).bytes %>)
+
+// Or you can pass it as a string if you prefer
+window.vapidPublicKey = "<%= ENV['VAPID_PUBLIC_KEY'].delete('=') %>"
+</script>
 ```
 
 Your JavaScript code uses the `pushManager` interface to subscribe to push notifications, passing the VAPID public key to the subscription settings.

data/lib/web_push/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WebPush
-  VERSION = '3.0.1'.freeze
+  VERSION = '3.1.0'.freeze
 end

data/lib/web_push.rb

@@ -56,10 +56,6 @@ module WebPush
     end
 
     def decode64(str)
-      # For Ruby < 2.3, Base64.urlsafe_decode64 strict decodes and will raise errors if encoded value is not properly padded
-      # Implementation: http://ruby-doc.org/stdlib-2.3.0/libdoc/base64/rdoc/Base64.html#method-i-urlsafe_decode64
-      str = str.ljust((str.length + 3) & ~3, '=') if !str.end_with?('=') && str.length % 4 != 0
-
       Base64.urlsafe_decode64(str)
     end
 

data/spec/spec_helper.rb

@@ -1,9 +1,12 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
 require 'web_push'
 require 'webmock/rspec'
-require 'simplecov'
 
 WebMock.disable_net_connect!(allow_localhost: true)
-SimpleCov.start
 
 def vapid_options
   {

data/spec/web_push_spec.rb

@@ -5,6 +5,18 @@ describe WebPush do
     expect(WebPush::VERSION).not_to be nil
   end
 
+  describe '.decode64' do
+    let(:a_padded_key) { "YWJjZGU=" }
+
+    it 'urlsafe decodes padded base64 string' do
+      expect(WebPush.decode64(a_padded_key)).to eq("abcde")
+    end
+
+    it 'urlsafe decodes unpadded base64 string' do
+      expect(WebPush.decode64(a_padded_key.delete("="))).to eq("abcde")
+    end
+  end
+
   shared_examples 'web push protocol standard error handling' do
     it 'raises InvalidSubscription if the API returns a 404 Error' do
       stub_request(:post, expected_endpoint)

data/web-push.gemspec

@@ -14,8 +14,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 3.0'
 
-  spec.add_dependency 'jwt', '~> 2.0'
-  spec.add_dependency 'openssl', '~> 3.0'
+  spec.add_dependency 'jwt', '~> 3.0'
+  spec.add_dependency 'openssl', '>= 3.0'
 
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov', '~> 0.0'

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: web-push
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - zaru
 - collimarco
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -17,26 +16,26 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: openssl
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
@@ -81,7 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
 email:
 - support@pushpad.xyz
 executables: []
@@ -110,7 +108,6 @@ homepage: https://github.com/pushpad/web-push
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -125,8 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Web Push library for Ruby (RFC8030)
 test_files: []