pusher 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71dc5eb4f9d389dce37f6ec8c1f78390402b31bd94edcb6f22094c70edeb2d72
-  data.tar.gz: 3b2d0db0ffe052cbd8c71b252ced1d5910ece64a08100a92c0f17b5ac9b6fa8a
+  metadata.gz: 5666fd615b33c55a6d4edfb362d9efd756c08a86c8b71c5e5364998d9392c3ec
+  data.tar.gz: c868837eb799850564c54de4e419d90471e57c738c58fff813a1af89776a7fd5
 SHA512:
-  metadata.gz: 2f644cc58f1b8accd8785eeffc3fc74bad4c20677032455d96e655944ee0818f99802ed339a3f5f9049acd57ea1166817f6c01feba926c9b61256260239c6354
-  data.tar.gz: c0d4edd095918225bea29707df4e8e0364b16218c367b40f72c5541fe98232e4698e83e58ea8260b7caeeea54d314ec343ea25050f1f7847747d01a003c68221
+  metadata.gz: c8abe07a9ba76d5dbfa47881903c1e553b39163eef3df19357039ee368ae18ebe24bef42bb4be20d7a41e14527c2453893d3b92c84144c686673de045626abe4
+  data.tar.gz: 873f4bc20a57905565b80a037c59d560ad8fbb2b97bca6325bc2ff6a1fd092437e68855918a7931f2cc9ccdf6031c38a9190b8f561b7fd6561c6b9c935cbd0a0

data/CHANGELOG.md

@@ -1,24 +1,28 @@
 # Changelog
 
+## 2.0.4
+
+* [ADDED] Add `authenticate_user` method for user authentication flow
+
 ## 2.0.3
 
 * [FIXED] Corrected the channels limit when publishing events. Upped from 10 to 100. 
 
 ## 2.0.2
 
-* [CHANGED] made encryption_master_key_base64 globally configurable 
+* [CHANGED] made encryption_master_key_base64 globally configurable 
 
 ## 2.0.1
 
-* [CHANGED] Only include lib and essential docs in gem.
+* [CHANGED] Only include lib and essential docs in gem.
 
 ## 2.0.0
 
-* [CHANGED] Use TLS by default.
-* [REMOVED] Support for Ruby 2.4 and 2.5.
-* [FIXED] Handle empty or nil  configuration.
-* [REMOVED] Legacy Push Notification integration.
-* [ADDED] Stalebot and Github actions. 
+* [CHANGED] Use TLS by default.
+* [REMOVED] Support for Ruby 2.4 and 2.5.
+* [FIXED] Handle empty or nil  configuration.
+* [REMOVED] Legacy Push Notification integration.
+* [ADDED] Stalebot and Github actions. 
 
 ## 1.4.3
 

data/lib/pusher/channel.rb

@@ -126,20 +126,9 @@ module Pusher
     # @raise [Pusher::Error] if socket_id or custom_string invalid
     #
     def authentication_string(socket_id, custom_string = nil)
-      validate_socket_id(socket_id)
+      string_to_sign = [socket_id, name, custom_string].compact.map(&:to_s).join(':')
 
-      unless custom_string.nil? || custom_string.kind_of?(String)
-        raise Error, 'Custom argument must be a string'
-      end
-
-      string_to_sign = [socket_id, name, custom_string].
-        compact.map(&:to_s).join(':')
-      Pusher.logger.debug "Signing #{string_to_sign}"
-      token = @client.authentication_token
-      digest = OpenSSL::Digest::SHA256.new
-      signature = OpenSSL::HMAC.hexdigest(digest, token.secret, string_to_sign)
-
-      return "#{token.key}:#{signature}"
+      _authentication_string(socket_id, string_to_sign, @client.authentication_token, custom_string)
     end
 
     # Generate the expected response for an authentication endpoint.
@@ -185,10 +174,6 @@ module Pusher
 
     private
 
-    def validate_socket_id(socket_id)
-      unless socket_id && /\A\d+\.\d+\z/.match(socket_id)
-        raise Pusher::Error, "Invalid socket ID #{socket_id.inspect}"
-      end
-    end
+    include Pusher::Utils
   end
 end

data/lib/pusher/client.rb

@@ -321,7 +321,7 @@ module Pusher
 
 
     # Generate the expected response for an authentication endpoint.
-    # See http://pusher.com/docs/authenticating_users for details.
+    # See https://pusher.com/docs/channels/server_api/authorizing-users for details.
     #
     # @example Private channels
     #   render :json => Pusher.authenticate('private-my_channel', params[:socket_id])
@@ -355,6 +355,31 @@ module Pusher
       r
     end
 
+    # Generate the expected response for a user authentication endpoint.
+    # See https://pusher.com/docs/authenticating_users for details.
+    #
+    # @example
+    #   user_data = { id: current_user.id.to_s, company_id: current_user.company_id }
+    #   render :json => Pusher.authenticate_user(params[:socket_id], user_data)
+    #
+    # @param socket_id [String]
+    # @param user_data [Hash] user's properties (id is required and must be a string)
+    #
+    # @return [Hash]
+    #
+    # @raise [Pusher::Error] if socket_id or user_data is invalid
+    #
+    # @private Custom data is sent to server as JSON-encoded string
+    #
+    def authenticate_user(socket_id, user_data)
+      validate_user_data(user_data)
+
+      custom_data = MultiJson.encode(user_data)
+      auth = authentication_string(socket_id, custom_data)
+
+      { auth:, user_data: custom_data }
+    end
+
     # @private Construct a net/http http client
     def sync_http_client
       require 'httpclient'
@@ -399,6 +424,8 @@ module Pusher
 
     private
 
+    include Pusher::Utils
+
     def trigger_params(channels, event_name, data, params)
       channels = Array(channels).map(&:to_s)
       raise Pusher::Error, "Too many channels (#{channels.length}), max 100" if channels.length > 100
@@ -469,5 +496,33 @@ module Pusher
       $stderr.puts "You don't have rbnacl installed in your application. Please add it to your Gemfile and run bundle install"
       raise e
     end
+
+    # Compute authentication string required as part of the user authentication
+    # endpoint response. Generally the authenticate method should be used in
+    # preference to this one.
+    #
+    # @param socket_id [String] Each Pusher socket connection receives a
+    #   unique socket_id. This is sent from pusher.js to your server when
+    #   channel authentication is required.
+    # @param custom_string [String] Allows signing additional data
+    # @return [String]
+    #
+    # @raise [Pusher::Error] if socket_id or custom_string invalid
+    #
+    def authentication_string(socket_id, custom_string = nil)
+      string_to_sign = [socket_id, 'user', custom_string].compact.map(&:to_s).join('::')
+
+      _authentication_string(socket_id, string_to_sign, authentication_token, string_to_sign)
+    end
+
+    def validate_user_data(user_data)
+      return if user_data_valid?(user_data)
+
+      raise Pusher::Error, "Invalid user data #{user_data.inspect}"
+    end
+
+    def user_data_valid?(data)
+      data.is_a?(Hash) && data.key?(:id) && !data[:id].empty? && data[:id].is_a?(String)
+    end
   end
 end

data/lib/pusher/utils.rb

@@ -0,0 +1,34 @@
+module Pusher
+  module Utils
+    def validate_socket_id(socket_id)
+      unless socket_id && /\A\d+\.\d+\z/.match(socket_id)
+        raise Pusher::Error, "Invalid socket ID #{socket_id.inspect}"
+      end
+    end
+
+    # Compute authentication string required as part of the user authentication
+    # and subscription authorization endpoints responses.
+    # Generally the authenticate method should be used in preference to this one.
+    #
+    # @param socket_id [String] Each Pusher socket connection receives a
+    #   unique socket_id. This is sent from pusher.js to your server when
+    #   channel authentication is required.
+    # @param custom_string [String] Allows signing additional data
+    # @return [String]
+    #
+    # @raise [Pusher::Error] if socket_id or custom_string invalid
+    #
+    def _authentication_string(socket_id, string_to_sign, token, custom_string = nil)
+      validate_socket_id(socket_id)
+
+      raise Pusher::Error, 'Custom argument must be a string' unless custom_string.nil? || custom_string.is_a?(String)
+
+      Pusher.logger.debug "Signing #{string_to_sign}"
+
+      digest = OpenSSL::Digest.new('SHA256')
+      signature = OpenSSL::HMAC.hexdigest(digest, token.secret, string_to_sign)
+
+      "#{token.key}:#{signature}"
+    end
+  end
+end

data/lib/pusher/version.rb

@@ -1,3 +1,3 @@
 module Pusher
-  VERSION = '2.0.3'
+  VERSION = '2.0.4'
 end

data/lib/pusher.rb

@@ -2,6 +2,7 @@ autoload 'Logger', 'logger'
 require 'uri'
 require 'forwardable'
 
+require 'pusher/utils'
 require 'pusher/client'
 
 # Used for configuring API credentials and creating Channel objects

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pusher
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Pusher
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-19 00:00:00.000000000 Z
+date: 2026-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -179,13 +179,14 @@ files:
 - lib/pusher/client.rb
 - lib/pusher/request.rb
 - lib/pusher/resource.rb
+- lib/pusher/utils.rb
 - lib/pusher/version.rb
 - lib/pusher/webhook.rb
 homepage: http://github.com/pusher/pusher-http-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -200,8 +201,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.4.20
+signing_key:
 specification_version: 4
 summary: Pusher Channels API client
 test_files: []