pubnub 4.3.0 → 4.4.0

data/lib/pubnub/client/events.rb

@@ -7,8 +7,10 @@ module Pubnub
       EVENTS = %w[publish subscribe presence leave history here_now audit grant delete_messages
                   revoke time heartbeat where_now set_state state channel_registration message_counts signal
                   add_channels_to_push list_push_provisions remove_channels_from_push remove_device_from_push
-                  create_user create_space delete_user delete_space get_user get_users get_space get_spaces
-                  update_user update_space get_members get_space_memberships manage_members manage_memberships].freeze
+                  set_uuid_metadata set_channel_metadata remove_uuid_metadata remove_channel_metadata
+                  get_uuid_metadata get_all_uuid_metadata get_channel_metadata get_all_channels_metadata
+                  get_channel_members get_memberships set_channel_members set_memberships
+                  remove_memberships remove_channel_members].freeze
 
       EVENTS.each do |event_name|
         define_method event_name do |options = {}, &block|

data/lib/pubnub/constants.rb

@@ -66,20 +66,20 @@ module Pubnub
     OPERATION_REMOVE_CHANNELS_FROM_PUSH = :remove_channels_from_push
     OPERATION_REMOVE_DEVICE_FROM_PUSH = :remove_device_from_push
     OPERATION_SIGNAL = :signal
-    OPERATION_CREATE_USER = :create_user
-    OPERATION_GET_USER = :get_user
-    OPERATION_GET_USERS = :get_users
-    OPERATION_UPDATE_USER = :update_user
-    OPERATION_DELETE_USER = :delete_user
-    OPERATION_CREATE_SPACE = :create_space
-    OPERATION_GET_SPACE = :get_space
-    OPERATION_GET_SPACES = :get_spaces
-    OPERATION_UPDATE_SPACE = :update_space
-    OPERATION_DELETE_SPACE = :delete_space
-    OPERATION_GET_MEMBERS = :get_members
-    OPERATION_MANAGE_MEMBERS = :manage_members
-    OPERATION_GET_SPACE_MEMBERSHIPS = :get_space_memberships
-    OPERATION_MANAGE_MEMBERSHIPS = :manage_memberships
+    OPERATION_SET_UUID_METADATA = :set_uuid_metadata
+    OPERATION_GET_UUID_METADATA = :get_uuid_metadata
+    OPERATION_GET_ALL_UUID_METADATA = :get_all_uuid_metadata
+    OPERATION_REMOVE_UUID_METADATA = :remove_uuid_metadata
+    OPERATION_SET_CHANNEL_METADATA = :set_channel_metadata
+    OPERATION_GET_CHANNEL_METADATA = :get_channel_metadata
+    OPERATION_GET_ALL_CHANNELS_METADATA = :get_all_channels_metadata
+    OPERATION_REMOVE_CHANNEL_METADATA = :remove_channel_metadata
+    OPERATION_GET_CHANNEL_MEMBERS = :get_channel_members
+    OPERATION_SET_CHANNEL_MEMBERS = :set_channel_members
+    OPERATION_REMOVE_CHANNEL_MEMBERS = :remove_channel_members
+    OPERATION_GET_MEMBERSHIPS = :get_memberships
+    OPERATION_SET_MEMBERSHIPS = :set_memberships
+    OPERATION_REMOVE_MEMBERSHIPS = :remove_memberships
 
     OPERATIONS = [
       OPERATION_SUBSCRIBE, OPERATION_HEARTBEAT, OPERATION_PRESENCE, OPERATION_TIME, OPERATION_HISTORY,
@@ -87,10 +87,11 @@ module Pubnub
       OPERATION_LIST_ALL_CHANNELS_IN_CHANNEL_GROUP, OPERATION_CHANNEL_GROUP_ADD, OPERATION_CHANNEL_GROUP_REMOVE,
       OPERATION_AUDIT, OPERATION_GRANT, OPERATION_REVOKE, OPERATION_WHERE_NOW, OPERATION_MESSAGE_COUNTS,
       OPERATION_ADD_CHANNELS_TO_PUSH, OPERATION_LIST_PUSH_PROVISIONS, OPERATION_REMOVE_CHANNELS_FROM_PUSH,
-      OPERATION_REMOVE_DEVICE_FROM_PUSH, OPERATION_SIGNAL, OPERATION_CREATE_USER, OPERATION_GET_USER,
-      OPERATION_GET_USERS, OPERATION_UPDATE_USER, OPERATION_DELETE_USER, OPERATION_CREATE_SPACE,
-      OPERATION_GET_SPACE, OPERATION_GET_SPACES, OPERATION_UPDATE_SPACE, OPERATION_DELETE_SPACE,
-      OPERATION_GET_MEMBERS, OPERATION_MANAGE_MEMBERS, OPERATION_GET_SPACE_MEMBERSHIPS, OPERATION_MANAGE_MEMBERSHIPS
+      OPERATION_REMOVE_DEVICE_FROM_PUSH, OPERATION_SIGNAL, OPERATION_SET_UUID_METADATA, OPERATION_GET_UUID_METADATA,
+      OPERATION_GET_ALL_UUID_METADATA, OPERATION_REMOVE_UUID_METADATA, OPERATION_SET_CHANNEL_METADATA,
+      OPERATION_GET_CHANNEL_METADATA, OPERATION_GET_ALL_CHANNELS_METADATA, OPERATION_REMOVE_CHANNEL_METADATA,
+      OPERATION_GET_CHANNEL_MEMBERS, OPERATION_SET_CHANNEL_MEMBERS, OPERATION_REMOVE_CHANNEL_MEMBERS,
+      OPERATION_GET_MEMBERSHIPS, OPERATION_SET_MEMBERSHIPS, OPERATION_REMOVE_MEMBERSHIPS
     ].freeze
 
     # Announcements

data/lib/pubnub/event.rb

@@ -29,6 +29,7 @@ module Pubnub
       set_timestamp
       validate!
       telemetry = @app.telemetry_for(@telemetry_name)
+      @compressed_body = nil
       @current_telemetry = telemetry ? telemetry.round(3) : nil
       Pubnub.logger.debug('Pubnub::Event') { "Initialized #{self.class}" }
     end
@@ -46,24 +47,20 @@ module Pubnub
     def send_request(compressed_body = '')
       Pubnub.logger.debug('Pubnub::Event') { '#send_request called' }
 
+      @compressed_body = compressed_body
       sender = request_dispatcher
       Pubnub.logger.debug('Pubnub::Event') { '#send_request got sender' }
 
       telemetry_time_start = ::Time.now.to_f
-      response = case @event
-                 when Pubnub::Constants::OPERATION_DELETE, Pubnub::Constants::OPERATION_DELETE_SPACE, Pubnub::Constants::OPERATION_DELETE_USER
-                   sender.delete(uri.to_s)
-                 when Pubnub::Constants::OPERATION_MANAGE_MEMBERS, Pubnub::Constants::OPERATION_MANAGE_MEMBERSHIPS,
-                      Pubnub::Constants::OPERATION_UPDATE_SPACE, Pubnub::Constants::OPERATION_UPDATE_USER
-                   sender.patch(uri.to_s, body: compressed_body)
-                 when Pubnub::Constants::OPERATION_CREATE_USER, Pubnub::Constants::OPERATION_CREATE_SPACE
+      response = case operation_http_method
+                 when "get"
+                   sender.get(uri.to_s)
+                 when "post"
                    sender.post(uri.to_s, body: compressed_body)
+                 when "patch"
+                   sender.patch(uri.to_s, body: compressed_body)
                  else
-                   if compressed_body.empty?
-                     sender.get(uri.to_s)
-                   else
-                     sender.post(uri.to_s, body: compressed_body)
-                   end
+                   sender.delete(uri.to_s)
                  end
 
       begin
@@ -84,7 +81,7 @@ module Pubnub
         return @uri if @uri
       end
 
-      sa_signature = super_admin_signature unless parameters.include?(:signature)
+      sa_signature = super_admin_signature(operation_http_method, @compressed_body) unless parameters.include?(:signature)
 
       uri = @ssl ? 'https://' : 'http://'
       uri += @origin
@@ -105,6 +102,23 @@ module Pubnub
 
     private
 
+    def operation_http_method
+      case @event
+      when Pubnub::Constants::OPERATION_DELETE, Pubnub::Constants::OPERATION_REMOVE_CHANNEL_METADATA, Pubnub::Constants::OPERATION_REMOVE_UUID_METADATA
+        "delete"
+      when Pubnub::Constants::OPERATION_SET_UUID_METADATA, Pubnub::Constants::OPERATION_SET_CHANNEL_METADATA,
+           Pubnub::Constants::OPERATION_SET_CHANNEL_MEMBERS, Pubnub::Constants::OPERATION_SET_MEMBERSHIPS,
+           Pubnub::Constants::OPERATION_REMOVE_CHANNEL_MEMBERS, Pubnub::Constants::OPERATION_REMOVE_MEMBERSHIPS
+        "patch"
+      else
+        if @compressed_body.nil? || @compressed_body.empty?
+          "get"
+        else
+          "post"
+        end
+      end
+    end
+
     def secure_call(cb, arg)
       cb.call arg
     rescue StandardError => error
@@ -147,9 +161,9 @@ module Pubnub
                      publish_key subscribe_key timetoken
                      open_timeout read_timeout idle_timeout heartbeat
                      group action read write delete manage ttl presence start
-                     end count reverse presence_callback store skip_validate
+                     end count limit reverse presence_callback store skip_validate
                      state channel_group channel_groups compressed meta customs include_token
-                     replicate with_presence cipher_key_selector include_meta]
+                     replicate with_presence cipher_key_selector include_meta join update get]
 
       options = options.each_with_object({}) { |option, obj| obj[option.first.to_sym] = option.last }
 

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