pubnub 4.2.5 → 4.5.0

data/lib/pubnub/events/set_memberships.rb

@@ -0,0 +1,140 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Holds SetMemberships functionality
+  class SetMemberships < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::SetMemberships
+
+    def initialize(options, app)
+      @event = current_operation
+      @telemetry_name = :l_obj
+      @uuid = options[:uuid].nil? ? app.env[: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
+
+      @channels = options[:channels] if options[:channels] && !options[:channels].empty?
+
+      # Collections by default return number of available entries.
+      @include_count = "1" if @include_count.nil?
+
+      super
+    end
+
+    def fire
+      Pubnub.logger.debug('Pubnub::SetMemberships') { "Fired event #{self.class}" }
+
+      memberships = @channels.map do |membership|
+        membership_object = { channel: { id: membership[:channel] } }
+        membership_object[:custom] = membership[:custom] if membership[:custom] && !membership[:custom].empty?
+
+        membership_object
+      end
+
+      body = Formatter.format_message({ set: memberships }, @cipher_key, false)
+      response = send_request(body)
+
+      envelopes = fire_callbacks(handle(response, uri))
+      finalize_event(envelopes)
+      envelopes
+    end
+
+    private
+
+    def current_operation
+      Pubnub::Constants::OPERATION_SET_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)
+      memberships = parsed_response['data'].map { |uuid_membership|
+        membership = Hash.new
+        uuid_membership.each{ |k,v| membership[k.to_sym] = v }
+
+        unless membership[:channel].nil?
+          channel_metadata = Hash.new
+          membership[:channel].each{ |k,v| channel_metadata[k.to_sym] = v }
+          channel_metadata[:updated] = Date._parse(channel_metadata[:updated]) unless channel_metadata[:updated].nil?
+          membership[:channel] = channel_metadata
+        end
+        membership[:updated] = Date._parse(membership[:updated]) unless membership[:updated].nil?
+
+        membership
+      }
+
+      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: {
+            memberships: memberships,
+            totalCount: parsed_response['totalCount'],
+            next: parsed_response['next'],
+            prev: parsed_response['prev']
+          }
+        },
+
+        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/{create_user.rb → set_uuid_metadata.rb}

@@ -2,23 +2,33 @@
 # frozen_string_literal: true
 
 module Pubnub
-  # Holds CreateUser functionality
-  class CreateUser < SingleEvent
+  # Holds SetUuidMetadata functionality
+  class SetUuidMetadata < SingleEvent
     include Concurrent::Async
-    include Pubnub::Validator::CreateUser
+    include Pubnub::Validator::SetUuidMetadata
 
     def initialize(options, app)
-      @event = :create_user
+      @event = current_operation
       @telemetry_name = :l_obj
-      @data = options[:data]
-      @include = options[:include]
+      @uuid = options[:uuid].nil? ? app.env[:uuid] : options[:uuid]
+
+      # Clean up user-provided metadata object from nils.
+      @metadata = options[:metadata].delete_if { |_k, v| v.blank? } unless options[:metadata].nil?
+
+      if options[:include]
+        @include = [0, '0', false].include?(options[:include][:custom]) ? "0" : "1" unless options[:include][:custom].nil?
+      end
+
+      # Single entity creation should return it's 'custom' field by default.
+      @include = "custom" if @include.nil?
+
       super
     end
 
     def fire
-      Pubnub.logger.debug('Pubnub::CreateUser') { "Fired event #{self.class}" }
+      Pubnub.logger.debug('Pubnub::SetUuidMetadata') { "Fired event #{self.class}" }
 
-      body = Formatter.format_message(@data, @cipher_key, false)
+      body = Formatter.format_message(@metadata, @cipher_key, false)
       response = send_request(body)
 
       envelopes = fire_callbacks(handle(response, uri))
@@ -29,25 +39,31 @@ module Pubnub
     private
 
     def current_operation
-      Pubnub::Constants::OPERATION_CREATE_USER
+      Pubnub::Constants::OPERATION_SET_UUID_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'
+        'uuids',
+        Formatter.encode(@uuid)
       ].join('/')
     end
 
     def valid_envelope(parsed_response, req_res_objects)
+      data = parsed_response['data']
+      metadata = Hash.new
+      data.each{ |k,v| metadata[k.to_sym] = v }
+      metadata[:updated] = Date._parse(metadata[:updated]) unless metadata[:updated].nil?
+
       Pubnub::Envelope.new(
         event: @event,
         event_options: @given_options,
@@ -55,15 +71,15 @@ module Pubnub
 
         result: {
           code: req_res_objects[:response].code,
-          operation: Pubnub::Constants::OPERATION_CREATE_USER,
+          operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],
-          data: parsed_response
+          data: metadata
         },
 
         status: {
           code: req_res_objects[:response].code,
-          operation: Pubnub::Constants::OPERATION_CREATE_USER,
+          operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],
           data: nil,

data/lib/pubnub/formatter.rb

@@ -1,4 +1,5 @@
 require 'cgi'
+require "addressable/uri"
 
 # Toplevel Pubnub module.
 module Pubnub
@@ -30,13 +31,22 @@ module Pubnub
         )
       end
 
+      def format_uuid(uuids, should_encode = true)
+        make_uuid_array(uuids).map do |uuid|
+          if should_encode
+            encode(uuid)
+          else
+            uuid.to_s
+          end
+        end
+      end
+
       # Transforms message to json and encode it
       def format_message(message, cipher_key, uri_escape = true)
         if cipher_key
           pc = Pubnub::Crypto.new(cipher_key)
           message = pc.encrypt(message).to_json
-          # rubocop:disable Lint/UriEscapeUnescape
-          message = URI.escape(message) if uri_escape
+          message = Addressable::URI.escape(message) if uri_escape
         else
           message = message.to_json
           message = Formatter.encode(message) if uri_escape
@@ -70,6 +80,23 @@ module Pubnub
         end
       end
 
+      def make_uuid_array(uuid)
+        case uuid.class.to_s
+        when 'String'
+          uuid.to_s.split(',')
+        when 'Symbol'
+          uuid.to_s.split(',')
+        when 'Array'
+          uuid.map(&:to_s)
+        when 'NilClass'
+          []
+        else
+          raise Pubnub::ArgumentError.new(
+            message: 'UUID has to be String, Symbol or Array'
+          ), 'UUID has to be String, Symbol or Array'
+        end
+      end
+
       # Parses string to JSON
       def parse_json(string)
         [JSON.parse(string), nil]
@@ -84,7 +111,7 @@ module Pubnub
           if %w[meta ortt].include?(key.to_s)
             encoded_value = URI.encode_www_form_component(value.to_json).gsub('+', '%20')
             params << "#{key}=#{encoded_value}&"
-          elsif %w[t state filter-expr].include?(key.to_s)
+          elsif %w[t state filter filter-expr].include?(key.to_s)
             params << "#{key}=#{value}&"
           else
             params << "#{key}=#{URI.encode_www_form_component(value).gsub('+', '%20')}&"

data/lib/pubnub/pam.rb

@@ -14,17 +14,7 @@ module Pubnub
     end
 
     def signature
-      message = [
-        @subscribe_key,
-        @publish_key,
-        path,
-        variables_for_signature.gsub(/[!~'()*]/) { |char| '%' + char.ord.to_s(16).upcase }, # Replace ! ~ * ' ( )
-      ].join("\n")
-
-      Base64.urlsafe_encode64(
-        OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'),
-                             @secret_key.to_s, message)
-      ).strip
+      super_admin_signature("GET", nil)
     end
 
     def parameters(set_signature = false)
@@ -32,6 +22,7 @@ module Pubnub
       params['channel-group'] = @group.join(',') unless @group.blank?
       params[:timestamp] = @timestamp
       params[:channel] = @channel.join(',') unless @channel.first.blank?
+      params['target-uuid'] = @uuids.join(',') if !@uuids.nil? && !@uuids.first.blank?
       params[:signature] = signature unless set_signature
       params
     end

data/lib/pubnub/subscribe_callback.rb

@@ -10,9 +10,7 @@ module Pubnub
         status: options[:status],
         presence: options[:presence],
         signal: options[:signal],
-        user: options[:user],
-        space: options[:space],
-        membership: options[:membership]
+        object: options[:object]
       }
       validate!
     end

data/lib/pubnub/subscribe_event/formatter.rb

@@ -148,6 +148,11 @@ module Pubnub
       end
 
       def format_envelopes(response, request)
+        if response.is_a?(StandardError)
+          # unexpected error response
+          raise response
+        end
+
         parsed_response, error = Pubnub::Formatter.parse_json(response.body)
 
         error = response if parsed_response && response.code.to_i != 200
@@ -168,32 +173,36 @@ module Pubnub
           Pubnub::Constants::OPERATION_SIGNAL
         elsif message[:type] == 2
           case message[:payload]['type']
-          when 'user'
+          when 'uuid'
             case message[:payload]['event']
-            when 'create'
-              Pubnub::Constants::OPERATION_CREATE_USER
-            when 'update'
-              Pubnub::Constants::OPERATION_UPDATE_USER
+            when 'set'
+              Pubnub::Constants::OPERATION_SET_UUID_METADATA
             when 'delete'
-              Pubnub::Constants::OPERATION_DELETE_USER
+              Pubnub::Constants::OPERATION_REMOVE_UUID_METADATA
             else
-              Pubnub.logger.error('Pubnub::SubscribeEvent::Formatter') { "Invalid event #{message[:payload]['event']}." }
-              raise Exception, "Invalid event #{message[:payload]['event']}."
+              Pubnub.logger.error('Pubnub::SubscribeEvent::Formatter') { "Invalid event #{message[:payload]['event']} for uuid." }
+              raise Exception, "Invalid event #{message[:payload]['event']} for uuid."
             end
-          when 'space'
+          when 'channel'
             case message[:payload]['event']
-            when 'create'
-              Pubnub::Constants::OPERATION_CREATE_SPACE
-            when 'update'
-              Pubnub::Constants::OPERATION_UPDATE_SPACE
+            when 'set'
+              Pubnub::Constants::OPERATION_SET_CHANNEL_METADATA
             when 'delete'
-              Pubnub::Constants::OPERATION_DELETE_SPACE
+              Pubnub::Constants::OPERATION_REMOVE_CHANNEL_METADATA
             else
-              Pubnub.logger.error('Pubnub::SubscribeEvent::Formatter') { "Invalid event #{message[:payload]['event']}." }
-              raise Exception, "Invalid event #{message[:payload]['event']}."
+              Pubnub.logger.error('Pubnub::SubscribeEvent::Formatter') { "Invalid event #{message[:payload]['event']} for channel." }
+              raise Exception, "Invalid event #{message[:payload]['event']} for channel."
             end
           when 'membership'
-            Pubnub::Constants::OPERATION_MANAGE_MEMBERSHIPS
+            case message[:payload]['event']
+            when 'set'
+              Pubnub::Constants::OPERATION_SET_MEMBERSHIPS
+            when 'delete'
+              Pubnub::Constants::OPERATION_REMOVE_MEMBERSHIPS
+            else
+              Pubnub.logger.error('Pubnub::SubscribeEvent::Formatter') { "Invalid event #{message[:payload]['event']} for membership." }
+              raise Exception, "Invalid event #{message[:payload]['event']} for membership."
+            end
           else
             Pubnub.logger.error('Pubnub::SubscribeEvent::Formatter') { "Invalid operation type #{message[:payload]['type']}." }
             raise Exception, "Invalid operation type #{message[:payload]['type']}."

data/lib/pubnub/subscriber.rb

@@ -75,12 +75,11 @@ module Pubnub
               secure_call callbacks.callbacks[:signal], envelope
             when Pubnub::Constants::OPERATION_PRESENCE
               secure_call callbacks.callbacks[:presence], envelope
-            when Pubnub::Constants::OPERATION_CREATE_USER, Pubnub::Constants::OPERATION_UPDATE_USER, Pubnub::Constants::OPERATION_DELETE_USER
-              secure_call callbacks.callbacks[:user], envelope
-            when Pubnub::Constants::OPERATION_CREATE_SPACE, Pubnub::Constants::OPERATION_UPDATE_SPACE, Pubnub::Constants::OPERATION_DELETE_SPACE
-              secure_call callbacks.callbacks[:space], envelope
-            when Pubnub::Constants::OPERATION_MANAGE_MEMBERS, Pubnub::Constants::OPERATION_MANAGE_MEMBERSHIPS
-              secure_call callbacks.callbacks[:membership], envelope
+            when Pubnub::Constants::OPERATION_SET_UUID_METADATA, Pubnub::Constants::OPERATION_REMOVE_UUID_METADATA,
+                 Pubnub::Constants::OPERATION_SET_CHANNEL_METADATA, Pubnub::Constants::OPERATION_REMOVE_CHANNEL_METADATA,
+                 Pubnub::Constants::OPERATION_SET_CHANNEL_MEMBERS, Pubnub::Constants::OPERATION_REMOVE_CHANNEL_MEMBERS,
+                 Pubnub::Constants::OPERATION_SET_MEMBERSHIPS, Pubnub::Constants::OPERATION_REMOVE_MEMBERSHIPS
+              secure_call callbacks.callbacks[:object], envelope
             else
               secure_call callbacks.callbacks[:status], envelope
             end

data/lib/pubnub/validators/add_channels_to_push.rb

@@ -0,0 +1,52 @@
+# Toplevel Pubnub module.
+module Pubnub
+  # Validator module that holds all validators modules
+  module Validator
+    # Validator for AddChannelsToPush event
+    module AddChannelsToPush
+      include CommonValidator
+
+      def validate!
+        return if @skip_validate
+        validate_push_token!
+        validate_push_gateway!
+        validate_channel!
+        validate_topic! if @push_gateway.eql? 'apns2'
+      end
+
+      private
+
+      def validate_push_token!
+        return unless @push_token.nil? || @push_token.empty?
+        raise(
+          ArgumentError.new,
+          ':push_token is required for AddChannelsToPush event.'
+        )
+      end
+
+      def validate_push_gateway!
+        return unless @push_gateway.nil? || @push_gateway.empty?
+        raise(
+          ArgumentError.new,
+          ':push_gateway is required for AddChannelsToPush event.'
+        )
+      end
+
+      def validate_channel!
+        return unless @channel.nil? || @channel.empty?
+        raise(
+          ArgumentError.new,
+          ':channel is required for AddChannelsToPush event.'
+        )
+      end
+
+      def validate_topic!
+        return unless @topic.nil? || @topic.empty?
+        raise(
+          ArgumentError.new,
+          ':topic is required for AddChannelsToPush event.'
+        )
+      end
+    end
+  end
+end