webpush 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '0499dcd1f7c46766c0c0f310f4bb2e786fdc875c'
-  data.tar.gz: 5aeeedf8d5ead80dad72c9804547f24c8aa7450a
+  metadata.gz: e6d555b555c5277dc1abbe12a9808292b62b241a
+  data.tar.gz: 3f12232353b917a3135ce12f33a38f1a2a7f5388
 SHA512:
-  metadata.gz: 48ec18d9fe4529ab4e16fed5e63b347497c5b1b2e964d4c5771c9d130871c65be066e95e41a004c0631e33ccd4ee474c10297b5152d984c41b59523d44280261
-  data.tar.gz: ad6df7b328130176806a8111f28c86469eee04f268731534f8f888750b4ec061d0fac7d48be870e7e58ad928945fd77bd8fcaba16126405c00022676de09b98e
+  metadata.gz: b7429002edc35b7d8e92cb15ff6d329f52257d0f36ab46f316440c31f3141869d5617973e4c3250d79abd05efa4d60f0918194ab3160b42866cb400ba6220a20
+  data.tar.gz: 1a22cb446da2ff49013a3a5474bb970bbfa5789b3d24c693be4aadca2eca64e94db242cbe4fc36185a77dee25b45c3259ef8edb834de273f136db4efbfa98746

data/.travis.yml

@@ -1,8 +1,10 @@
 language: ruby
 rvm:
-  - 2.2.5
-  - 2.3.0
-before_install: gem install bundler -v 1.11.2
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+before_install: gem install bundler
 script: "bundle exec rake spec"
 addons:
   code_climate:

data/CHANGELOG.md

@@ -0,0 +1,133 @@
+# Change Log
+
+## [Unreleased](https://github.com/zaru/webpush/tree/HEAD)
+
+[Full Changelog](https://github.com/zaru/webpush/compare/v0.3.4...HEAD)
+
+**Merged pull requests:**
+
+- Fix \#55 and \#51: raise the proper error based on the HTTP status code [\#58](https://github.com/zaru/webpush/pull/58) ([collimarco](https://github.com/collimarco))
+- Add urgency option [\#57](https://github.com/zaru/webpush/pull/57) ([collimarco](https://github.com/collimarco))
+- Add Rake task to generate VAPID keys [\#54](https://github.com/zaru/webpush/pull/54) ([stevenharman](https://github.com/stevenharman))
+
+## [v0.3.4](https://github.com/zaru/webpush/tree/v0.3.4) (2018-05-25)
+[Full Changelog](https://github.com/zaru/webpush/compare/v0.3.3...v0.3.4)
+
+**Merged pull requests:**
+
+- add http timeout options [\#50](https://github.com/zaru/webpush/pull/50) ([aishek](https://github.com/aishek))
+
+## [v0.3.3](https://github.com/zaru/webpush/tree/v0.3.3) (2017-11-06)
+[Full Changelog](https://github.com/zaru/webpush/compare/v0.3.2...v0.3.3)
+
+**Merged pull requests:**
+
+- Add typ to JWT header fields [\#46](https://github.com/zaru/webpush/pull/46) ([ykzts](https://github.com/ykzts))
+- Specify the version of JWT strictly [\#45](https://github.com/zaru/webpush/pull/45) ([ykzts](https://github.com/ykzts))
+
+## [v0.3.2](https://github.com/zaru/webpush/tree/v0.3.2) (2017-07-01)
+[Full Changelog](https://github.com/zaru/webpush/compare/v0.3.1...v0.3.2)
+
+**Merged pull requests:**
+
+- feat: improve response error codes [\#39](https://github.com/zaru/webpush/pull/39) ([glennr](https://github.com/glennr))
+- Update README.md [\#38](https://github.com/zaru/webpush/pull/38) ([kitaindia](https://github.com/kitaindia))
+- Fix code example: Add close bracket [\#37](https://github.com/zaru/webpush/pull/37) ([kuranari](https://github.com/kuranari))
+- fix code in README [\#36](https://github.com/zaru/webpush/pull/36) ([kuranari](https://github.com/kuranari))
+- Minor fix in README: Close code blocks [\#32](https://github.com/zaru/webpush/pull/32) ([nicolas-fricke](https://github.com/nicolas-fricke))
+- Copy edits for README clarifying GCM requirements [\#30](https://github.com/zaru/webpush/pull/30) ([rossta](https://github.com/rossta))
+- Adding VAPID documentation [\#28](https://github.com/zaru/webpush/pull/28) ([rossta](https://github.com/rossta))
+
+## [v0.3.1](https://github.com/zaru/webpush/tree/v0.3.1) (2016-10-24)
+[Full Changelog](https://github.com/zaru/webpush/compare/v0.3.0...v0.3.1)
+
+**Merged pull requests:**
+
+- Bug fix invalid base64 [\#29](https://github.com/zaru/webpush/pull/29) ([rossta](https://github.com/rossta))
+- Clarify VAPID usage further in README [\#27](https://github.com/zaru/webpush/pull/27) ([rossta](https://github.com/rossta))
+
+## [v0.3.0](https://github.com/zaru/webpush/tree/v0.3.0) (2016-10-14)
+[Full Changelog](https://github.com/zaru/webpush/compare/v0.2.5...v0.3.0)
+
+**Merged pull requests:**
+
+- Implement VAPID authorization [\#26](https://github.com/zaru/webpush/pull/26) ([rossta](https://github.com/rossta))
+
+## [v0.2.5](https://github.com/zaru/webpush/tree/v0.2.5) (2016-09-14)
+[Full Changelog](https://github.com/zaru/webpush/compare/v0.2.4...v0.2.5)
+
+**Merged pull requests:**
+
+- api key only needed for old google apis [\#24](https://github.com/zaru/webpush/pull/24) ([mohamedhafez](https://github.com/mohamedhafez))
+
+## [v0.2.4](https://github.com/zaru/webpush/tree/v0.2.4) (2016-08-29)
+[Full Changelog](https://github.com/zaru/webpush/compare/v0.2.3...v0.2.4)
+
+**Merged pull requests:**
+
+- VERIFY\_PEER by default - no need for a cert\_store option [\#20](https://github.com/zaru/webpush/pull/20) ([mohamedhafez](https://github.com/mohamedhafez))
+
+## [v0.2.3](https://github.com/zaru/webpush/tree/v0.2.3) (2016-06-19)
+[Full Changelog](https://github.com/zaru/webpush/compare/v0.2.2...v0.2.3)
+
+**Merged pull requests:**
+
+- detect and handle response errors [\#18](https://github.com/zaru/webpush/pull/18) ([mohamedhafez](https://github.com/mohamedhafez))
+
+## [v0.2.2](https://github.com/zaru/webpush/tree/v0.2.2) (2016-06-13)
+[Full Changelog](https://github.com/zaru/webpush/compare/v0.2.1...v0.2.2)
+
+**Merged pull requests:**
+
+- Don't include API key for firefox or other browsers [\#16](https://github.com/zaru/webpush/pull/16) ([mohamedhafez](https://github.com/mohamedhafez))
+- Option to specify a cert store [\#15](https://github.com/zaru/webpush/pull/15) ([mohamedhafez](https://github.com/mohamedhafez))
+- show ttl option in README [\#14](https://github.com/zaru/webpush/pull/14) ([mohamedhafez](https://github.com/mohamedhafez))
+
+## [v0.2.1](https://github.com/zaru/webpush/tree/v0.2.1) (2016-05-23)
+[Full Changelog](https://github.com/zaru/webpush/compare/v0.2.0...v0.2.1)
+
+**Merged pull requests:**
+
+- Make the response more detailed. [\#10](https://github.com/zaru/webpush/pull/10) ([kevinjom](https://github.com/kevinjom))
+
+## [v0.2.0](https://github.com/zaru/webpush/tree/v0.2.0) (2016-05-16)
+[Full Changelog](https://github.com/zaru/webpush/compare/v0.1.6...v0.2.0)
+
+**Merged pull requests:**
+
+- Make message payload optional [\#8](https://github.com/zaru/webpush/pull/8) ([rossta](https://github.com/rossta))
+- Add specs [\#7](https://github.com/zaru/webpush/pull/7) ([rossta](https://github.com/rossta))
+
+## [v0.1.6](https://github.com/zaru/webpush/tree/v0.1.6) (2016-05-12)
+[Full Changelog](https://github.com/zaru/webpush/compare/v0.1.5...v0.1.6)
+
+**Merged pull requests:**
+
+- Add rake binstub [\#6](https://github.com/zaru/webpush/pull/6) ([rossta](https://github.com/rossta))
+- Add syntax highlighting to README snippets [\#5](https://github.com/zaru/webpush/pull/5) ([rossta](https://github.com/rossta))
+- Extract encryption module [\#4](https://github.com/zaru/webpush/pull/4) ([rossta](https://github.com/rossta))
+- Add some happy case specs [\#3](https://github.com/zaru/webpush/pull/3) ([waheedel](https://github.com/waheedel))
+
+## [v0.1.5](https://github.com/zaru/webpush/tree/v0.1.5) (2016-04-29)
+[Full Changelog](https://github.com/zaru/webpush/compare/v0.1.4...v0.1.5)
+
+**Merged pull requests:**
+
+- add Ttl header parameter [\#1](https://github.com/zaru/webpush/pull/1) ([shouta-dev](https://github.com/shouta-dev))
+
+## [v0.1.4](https://github.com/zaru/webpush/tree/v0.1.4) (2016-04-27)
+[Full Changelog](https://github.com/zaru/webpush/compare/v0.1.3...v0.1.4)
+
+## [v0.1.3](https://github.com/zaru/webpush/tree/v0.1.3) (2016-04-13)
+[Full Changelog](https://github.com/zaru/webpush/compare/v0.1.2...v0.1.3)
+
+## [v0.1.2](https://github.com/zaru/webpush/tree/v0.1.2) (2016-04-12)
+[Full Changelog](https://github.com/zaru/webpush/compare/v0.1.1...v0.1.2)
+
+## [v0.1.1](https://github.com/zaru/webpush/tree/v0.1.1) (2016-03-31)
+[Full Changelog](https://github.com/zaru/webpush/compare/v0.1.0...v0.1.1)
+
+## [v0.1.0](https://github.com/zaru/webpush/tree/v0.1.0) (2016-03-31)
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/README.md

@@ -247,7 +247,8 @@ Webpush.payload_send(
   message: JSON.generate(message),
   p256dh: "BO/aG9nYXNkZmFkc2ZmZHNmYWRzZmFl...",
   auth: "aW1hcmthcmFpa3V6ZQ==",
-  ttl: 600 #optional, ttl in seconds, defaults to 2419200 (4 weeks),
+  ttl: 600, # optional, ttl in seconds, defaults to 2419200 (4 weeks)
+  urgency: 'normal' # optional, it can be very-low, low, normal, high, defaults to normal
 )
 ```
 

data/Rakefile

@@ -4,3 +4,5 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+import './lib/tasks/webpush.rake'

data/lib/tasks/webpush.rake

@@ -0,0 +1,14 @@
+namespace :webpush do
+  desc 'Generate VAPID public/private key pair'
+  task :generate_keys do
+    require 'webpush'
+
+    Webpush.generate_key.tap do |keypair|
+      puts <<-KEYS
+Generated VAPID keypair:
+Public  -> #{keypair.public_key}
+Private -> #{keypair.private_key}
+      KEYS
+    end
+  end
+end

data/lib/webpush.rb

@@ -9,6 +9,7 @@ require 'webpush/errors'
 require 'webpush/vapid_key'
 require 'webpush/encryption'
 require 'webpush/request'
+require 'webpush/railtie' if defined?(Rails)
 
 module Webpush
   class << self
@@ -26,6 +27,7 @@ module Webpush
     # @option vapid [String] :private_key the VAPID private key
     # @param options [Hash<Symbol,String>] additional options for the notification
     # @option options [#to_s] :ttl Time-to-live in seconds
+    # @option options [#to_s] :urgency Urgency can be very-low, low, normal, high
     def payload_send(message: "", endpoint:, p256dh: "", auth: "", vapid: {}, **options)
       subscription = {
         endpoint: endpoint,

data/lib/webpush/errors.rb

@@ -17,7 +17,12 @@ module Webpush
 
   class ExpiredSubscription < ResponseError; end
 
+  class Unauthorized < ResponseError; end
+
   class PayloadTooLarge < ResponseError; end
 
   class TooManyRequests < ResponseError; end
+
+  class PushServiceError < ResponseError; end
+
 end

data/lib/webpush/railtie.rb

@@ -0,0 +1,7 @@
+module Webpush
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'tasks/webpush.rake'
+    end
+  end
+end

data/lib/webpush/request.rb

@@ -26,15 +26,19 @@ module Webpush
       req.body = body
       resp = http.request(req)
 
-      if resp.is_a?(Net::HTTPGone) ||   #Firefox unsubscribed response
-          (resp.is_a?(Net::HTTPBadRequest) && resp.message == "UnauthorizedRegistration")  #Chrome unsubscribed response
-        raise InvalidSubscription.new(resp, uri.host)
-      elsif resp.is_a?(Net::HTTPNotFound) # 404
+      if resp.is_a?(Net::HTTPGone) # 410
         raise ExpiredSubscription.new(resp, uri.host)
+      elsif resp.is_a?(Net::HTTPNotFound) # 404
+        raise InvalidSubscription.new(resp, uri.host)
+      elsif resp.is_a?(Net::HTTPUnauthorized) || # 401, Mozilla autopush
+        resp.is_a?(Net::HTTPBadRequest) && resp.message == "UnauthorizedRegistration" # 400, Google FCM
+        raise Unauthorized.new(resp, uri.host)
       elsif resp.is_a?(Net::HTTPRequestEntityTooLarge) # 413
         raise PayloadTooLarge.new(resp, uri.host)
       elsif resp.is_a?(Net::HTTPTooManyRequests) # 429, try again later!
         raise TooManyRequests.new(resp, uri.host)
+      elsif resp.is_a?(Net::HTTPServerError) # 5xx
+        raise PushServiceError.new(resp, uri.host)
       elsif !resp.is_a?(Net::HTTPSuccess)  # unknown/unhandled response error
         raise ResponseError.new(resp, uri.host)
       end
@@ -46,6 +50,7 @@ module Webpush
       headers = {}
       headers["Content-Type"] = "application/octet-stream"
       headers["Ttl"]          = ttl
+      headers["Urgency"]      = urgency
 
       if @payload.has_key?(:server_public_key)
         headers["Content-Encoding"] = "aesgcm"
@@ -89,6 +94,10 @@ module Webpush
       @options.fetch(:ttl).to_s
     end
 
+    def urgency
+      @options.fetch(:urgency).to_s
+    end
+
     def dh_param
       trim_encode64(@payload.fetch(:server_public_key))
     end
@@ -131,7 +140,8 @@ module Webpush
 
     def default_options
       {
-        ttl: 60*60*24*7*4 # 4 weeks
+        ttl: 60*60*24*7*4, # 4 weeks
+        urgency: 'normal'
       }
     end
 

data/lib/webpush/version.rb

@@ -1,3 +1,3 @@
 module Webpush
-  VERSION = "0.3.4"
+  VERSION = "0.3.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webpush
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - zaru@sakuraba
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-25 00:00:00.000000000 Z
+date: 2019-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hkdf
@@ -132,6 +132,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -140,9 +141,11 @@ files:
 - bin/rake
 - bin/rspec
 - bin/setup
+- lib/tasks/webpush.rake
 - lib/webpush.rb
 - lib/webpush/encryption.rb
 - lib/webpush/errors.rb
+- lib/webpush/railtie.rb
 - lib/webpush/request.rb
 - lib/webpush/vapid_key.rb
 - lib/webpush/version.rb
@@ -166,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Encryption Utilities for Web Push payload.