pubnub 4.2.4 → 4.4.0

data/lib/pubnub/event/formatter.rb

@@ -10,7 +10,11 @@ module Pubnub
                                 response,
                                 request: request,
                                 response: response)
+        elsif response.is_a?(StandardError)
+          # unexpected error response
+          raise response
         end
+
         parsed_response, error = Formatter.parse_json(response.body)
 
         error = response if parsed_response && response.code.to_i != 200

data/lib/pubnub/event/signature.rb

@@ -6,20 +6,35 @@ module Pubnub
     module Signature
       private
 
-      def super_admin_signature
+      def super_admin_signature(http_method, body)
         return unless @app.env[:secret_key]
 
+        # Handle special case with publish operation signing when message sent as POST body.
+        http_method = if http_method.upcase == "POST" && current_operation == Pubnub::Constants::OPERATION_PUBLISH
+                        "GET"
+                      else
+                        http_method.upcase
+                      end
+
         message = [
-          @app.env[:subscribe_key],
+          http_method.upcase,
           @app.env[:publish_key],
           path,
           variables_for_signature.gsub(/[!~'()*]/) { |char| '%' + char.ord.to_s(16).upcase }, # Replace ! ~ * ' ( )
-        ].join("\n")
+        ]
+
+        if %w[POST PATCH].include?(http_method)
+          message.push(body)
+        else
+          message.push('')
+        end
 
-        URI.encode_www_form_component(Base64.encode64(
+        signature = URI.encode_www_form_component(Base64.encode64(
           OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'),
-                               @app.env[:secret_key].to_s, message)
-        ).strip).gsub('+', '%20')
+                               @app.env[:secret_key].to_s, message.join("\n"))
+        ).strip.gsub(/\+/, '-').gsub(/\//, '_').gsub(/=+$/, ''))
+
+        "v2.#{signature}"
       end
 
       def variables_for_signature
@@ -29,7 +44,7 @@ module Pubnub
           if %w[meta ortt].include?(k.to_s)
             encoded_value = URI.encode_www_form_component(v.to_json).gsub('+', '%20')
             "#{k}=#{encoded_value}"
-          elsif %w[t state filter-expr].include?(k.to_s)
+          elsif %w[t state filter-expr sort filter].include?(k.to_s)
             "#{k}=#{v}"
           else
             "#{k}=#{URI.encode_www_form_component(v.to_s).gsub('+', '%20')}"

data/lib/pubnub/events/get_all_channels_metadata.rb

@@ -0,0 +1,92 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Holds GetAllChannelsMetadata functionality
+  class GetAllChannelsMetadata < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::GetAllChannelsMetadata
+
+    def initialize(options, app)
+      @event = current_operation
+      @telemetry_name = :l_obj
+      @limit = [options[:limit], 100].min unless options[:limit].nil?
+      @sort = options[:sort].join(",") if options[:sort] && !options[:sort].empty?
+      @filter = options[:filter] if options[:filter] && !options[:filter].empty?
+      @start = options[:start] if options[:start] && !options[:start].empty?
+      @end = options[:end] if options[:start] && !options[:end].empty?
+
+      if options[:include]
+        @include_count = [0, '0', false].include?(options[:include][:count]) ? "0" : "1" unless options[:include][:count].nil?
+        @include = "custom" unless [0, '0', false].include?(options[:include][:custom])
+      end
+
+      # Collections by default return number of available entries.
+      @include_count = "1" if @include_count.nil?
+
+      super
+    end
+
+    private
+
+    def current_operation
+      Pubnub::Constants::OPERATION_GET_ALL_CHANNELS_METADATA
+    end
+
+    def parameters(signature = false)
+      parameters = super(signature)
+      parameters[:limit] = @limit unless @limit.nil?
+      parameters[:sort] = @sort unless @sort.nil?
+      parameters[:filter] = @filter unless @filter.nil?
+      parameters[:start] = @start unless @start.nil?
+      parameters[:end] = @end if @end && !@start
+      parameters[:count] = @include_count unless @include_count.nil?
+      parameters[:include] = @include unless @include.to_s.empty?
+
+      parameters
+    end
+
+    def path
+      '/' + [
+        'v2',
+        'objects',
+        @subscribe_key,
+        'channels'
+      ].join('/')
+    end
+
+    def valid_envelope(parsed_response, req_res_objects)
+      Pubnub::Envelope.new(
+        event: @event,
+        event_options: @given_options,
+        timetoken: nil,
+
+        result: {
+          code: req_res_objects[:response].code,
+          operation: current_operation,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: parsed_response
+        },
+
+        status: {
+          code: req_res_objects[:response].code,
+          operation: current_operation,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: nil,
+          category: Pubnub::Constants::STATUS_ACK,
+          error: false,
+          auto_retried: false,
+
+          current_timetoken: nil,
+          last_timetoken: nil,
+          subscribed_channels: nil,
+          subscribed_channel_groups: nil,
+
+          config: get_config
+        }
+      )
+    end
+  end
+end

data/lib/pubnub/events/get_all_uuid_metadata.rb

@@ -0,0 +1,92 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Holds GetAllUuidMetadata functionality
+  class GetAllUuidMetadata < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::GetAllUuidMetadata
+
+    def initialize(options, app)
+      @event = current_operation
+      @telemetry_name = :l_obj
+      @limit = [options[:limit], 100].min unless options[:limit].nil?
+      @sort = options[:sort].join(",") if options[:sort] && !options[:sort].empty?
+      @filter = options[:filter] if options[:filter] && !options[:filter].empty?
+      @start = options[:start] if options[:start] && !options[:start].empty?
+      @end = options[:end] if options[:start] && !options[:end].empty?
+
+      if options[:include]
+        @include_count = [0, '0', false].include?(options[:include][:count]) ? "0" : "1" unless options[:include][:count].nil?
+        @include = "custom" unless [0, '0', false].include?(options[:include][:custom])
+      end
+
+      # Collections by default return number of available entries.
+      @include_count = "1" if @include_count.nil?
+
+      super
+    end
+
+    private
+
+    def current_operation
+      Pubnub::Constants::OPERATION_GET_ALL_UUID_METADATA
+    end
+
+    def parameters(signature = false)
+      parameters = super(signature)
+      parameters[:limit] = @limit unless @limit.nil?
+      parameters[:sort] = @sort unless @sort.nil?
+      parameters[:filter] = @filter unless @filter.nil?
+      parameters[:start] = @start unless @start.nil?
+      parameters[:end] = @end if @end && !@start
+      parameters[:count] = @include_count unless @include_count.nil?
+      parameters[:include] = @include unless @include.to_s.empty?
+
+      parameters
+    end
+
+    def path
+      '/' + [
+        'v2',
+        'objects',
+        @subscribe_key,
+        'uuids'
+      ].join('/')
+    end
+
+    def valid_envelope(parsed_response, req_res_objects)
+      Pubnub::Envelope.new(
+        event: @event,
+        event_options: @given_options,
+        timetoken: nil,
+
+        result: {
+          code: req_res_objects[:response].code,
+          operation: current_operation,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: parsed_response
+        },
+
+        status: {
+          code: req_res_objects[:response].code,
+          operation: current_operation,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: nil,
+          category: Pubnub::Constants::STATUS_ACK,
+          error: false,
+          auto_retried: false,
+
+          current_timetoken: nil,
+          last_timetoken: nil,
+          subscribed_channels: nil,
+          subscribed_channel_groups: nil,
+
+          config: get_config
+        }
+      )
+    end
+  end
+end

data/lib/pubnub/events/get_channel_members.rb

@@ -0,0 +1,100 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Holds GetChannelMembers functionality
+  class GetChannelMembers < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::GetChannelMembers
+
+    def initialize(options, app)
+      @event = current_operation
+      @telemetry_name = :l_obj
+      @channel = options[:channel]
+      @limit = [options[:limit], 100].min unless options[:limit].nil?
+      @sort = options[:sort].join(",") if options[:sort] && !options[:sort].empty?
+      @filter = options[:filter] if options[:filter] && !options[:filter].empty?
+      @start = options[:start] if options[:start] && !options[:start].empty?
+      @end = options[:end] if options[:start] && !options[:end].empty?
+
+      if options[:include]
+        include = options[:include]
+        @include_count = [0, '0', false].include?(include[:count]) ? "0" : "1" unless include[:count].nil?
+        @include_custom = "custom" if !include[:custom].nil? && ![0, '0', false].include?(include[:custom])
+        @include_uuid_metadata = "uuid" if !include[:uuid_metadata].nil? && ![0, '0', false].include?(include[:uuid_metadata])
+        @include_uuid_custom = "uuid.custom" if !include[:uuid_custom].nil? && ![0, '0', false].include?(include[:uuid_custom])
+
+        @include = [@include_custom, @include_uuid_metadata, @include_uuid_custom].reject { |flag| flag.to_s.empty? }
+      end
+
+      # Collections by default return number of available entries.
+      @include_count = "1" if @include_count.nil?
+
+      super
+    end
+
+    private
+
+    def current_operation
+      Pubnub::Constants::OPERATION_GET_CHANNEL_MEMBERS
+    end
+
+    def parameters(signature = false)
+      parameters = super(signature)
+      parameters[:limit] = @limit unless @limit.nil?
+      parameters[:sort] = @sort unless @sort.nil?
+      parameters[:filter] = @filter unless @filter.nil?
+      parameters[:start] = @start unless @start.nil?
+      parameters[:end] = @end if @end && !@start
+      parameters[:count] = @include_count unless @include_count.nil?
+      parameters[:include] = @include.sort.join(",") if @include && !@include.empty?
+
+      parameters
+    end
+
+    def path
+      '/' + [
+        'v2',
+        'objects',
+        @subscribe_key,
+        'channels',
+        Formatter.channels_for_url(@channel),
+        'uuids'
+      ].join('/')
+    end
+
+    def valid_envelope(parsed_response, req_res_objects)
+      Pubnub::Envelope.new(
+        event: @event,
+        event_options: @given_options,
+        timetoken: nil,
+
+        result: {
+          code: req_res_objects[:response].code,
+          operation: current_operation,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: parsed_response
+        },
+
+        status: {
+          code: req_res_objects[:response].code,
+          operation: current_operation,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: nil,
+          category: Pubnub::Constants::STATUS_ACK,
+          error: false,
+          auto_retried: false,
+
+          current_timetoken: nil,
+          last_timetoken: nil,
+          subscribed_channels: nil,
+          subscribed_channel_groups: nil,
+
+          config: get_config
+        }
+      )
+    end
+  end
+end

data/lib/pubnub/events/{get_user.rb → get_channel_metadata.rb}

@@ -2,38 +2,45 @@
 # frozen_string_literal: true
 
 module Pubnub
-  # Holds GetUser functionality
-  class GetUser < SingleEvent
+  # Holds GetChannelMetadata functionality
+  class GetChannelMetadata < SingleEvent
     include Concurrent::Async
-    include Pubnub::Validator::GetUser
+    include Pubnub::Validator::GetChannelMetadata
 
     def initialize(options, app)
-      @event = :get_user
+      @event = current_operation
       @telemetry_name = :l_obj
-      @user_id = options[:user_id]
-      @include = options[:include]
+      @channel = options[:channel]
+
+      if options[:include]
+        @include = "custom" unless [0, '0', false].include?(options[:include][:custom])
+      end
+
+      # Single entity creation should return it's 'custom' field by default.
+      @include = "custom" if @include.nil?
       super
     end
 
     private
 
     def current_operation
-      Pubnub::Constants::OPERATION_GET_USER
+      Pubnub::Constants::OPERATION_GET_CHANNEL_METADATA
     end
 
-    def parameters(*_args)
-      parameters = super
-      parameters[:include] = @include if @include
+    def parameters(signature = false)
+      parameters = super(signature)
+      parameters[:include] = @include
+
       parameters
     end
 
     def path
       '/' + [
-        'v1',
+        'v2',
         'objects',
         @subscribe_key,
-        'users',
-        @user_id
+        'channels',
+        Formatter.channels_for_url(@channel)
       ].join('/')
     end
 
@@ -45,7 +52,7 @@ module Pubnub
 
         result: {
           code: req_res_objects[:response].code,
-          operation: Pubnub::Constants::OPERATION_GET_USER,
+          operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],
           data: parsed_response
@@ -53,7 +60,7 @@ module Pubnub
 
         status: {
           code: req_res_objects[:response].code,
-          operation: Pubnub::Constants::OPERATION_GET_USER,
+          operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],
           data: nil,

data/lib/pubnub/events/get_memberships.rb

@@ -0,0 +1,100 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Holds GetMemberships functionality
+  class GetMemberships < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::GetMemberships
+
+    def initialize(options, app)
+      @event = current_operation
+      @telemetry_name = :l_obj
+      @uuid = options[:uuid]
+      @limit = [options[:limit], 100].min unless options[:limit].nil?
+      @sort = options[:sort].join(",") if options[:sort] && !options[:sort].empty?
+      @filter = options[:filter] if options[:filter] && !options[:filter].empty?
+      @start = options[:start] if options[:start] && !options[:start].empty?
+      @end = options[:end] if options[:start] && !options[:end].empty?
+
+      if options[:include]
+        include = options[:include]
+        @include_count = [0, '0', false].include?(include[:count]) ? "0" : "1" unless include[:count].nil?
+        @include_custom = "custom" if !include[:custom].nil? && ![0, '0', false].include?(include[:custom])
+        @include_channel_metadata = "channel" if !include[:channel_metadata].nil? && ![0, '0', false].include?(include[:channel_metadata])
+        @include_channel_custom = "channel.custom" if !include[:channel_custom].nil? && ![0, '0', false].include?(include[:channel_custom])
+
+        @include = [@include_custom, @include_channel_metadata, @include_channel_custom].reject { |flag| flag.to_s.empty? }
+      end
+
+      # Collections by default return number of available entries.
+      @include_count = "1" if @include_count.nil?
+
+      super
+    end
+
+    private
+
+    def current_operation
+      Pubnub::Constants::OPERATION_GET_MEMBERSHIPS
+    end
+
+    def parameters(signature = false)
+      parameters = super(signature)
+      parameters[:limit] = @limit unless @limit.nil?
+      parameters[:sort] = @sort unless @sort.nil?
+      parameters[:filter] = @filter unless @filter.nil?
+      parameters[:start] = @start unless @start.nil?
+      parameters[:end] = @end if @end && !@start
+      parameters[:count] = @include_count unless @include_count.nil?
+      parameters[:include] = @include.sort.join(",") if @include && !@include.empty?
+
+      parameters
+    end
+
+    def path
+      '/' + [
+        'v2',
+        'objects',
+        @subscribe_key,
+        'uuids',
+        Formatter.encode(@uuid),
+        'channels'
+      ].join('/')
+    end
+
+    def valid_envelope(parsed_response, req_res_objects)
+      Pubnub::Envelope.new(
+        event: @event,
+        event_options: @given_options,
+        timetoken: nil,
+
+        result: {
+          code: req_res_objects[:response].code,
+          operation: current_operation,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: parsed_response
+        },
+
+        status: {
+          code: req_res_objects[:response].code,
+          operation: current_operation,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: nil,
+          category: Pubnub::Constants::STATUS_ACK,
+          error: false,
+          auto_retried: false,
+
+          current_timetoken: nil,
+          last_timetoken: nil,
+          subscribed_channels: nil,
+          subscribed_channel_groups: nil,
+
+          config: get_config
+        }
+      )
+    end
+  end
+end