pubnub 4.4.0 → 4.5.0

data/lib/pubnub/event.rb

@@ -163,7 +163,9 @@ module Pubnub
                      group action read write delete manage ttl presence start
                      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 join update get]
+                     replicate with_presence cipher_key_selector include_meta join update get
+                     add remove push_token push_gateway environment topic
+                   ]
 
       options = options.each_with_object({}) { |option, obj| obj[option.first.to_sym] = option.last }
 

data/lib/pubnub/events/add_channels_to_push.rb

@@ -3,13 +3,14 @@ module Pubnub
   # Push related event
   class AddChannelsToPush < SingleEvent
     include Concurrent::Async
-    include Pubnub::Validator::Push
+    include Pubnub::Validator::AddChannelsToPush
 
     def initialize(options, app)
-      super
       @event = current_operation
-      @auth_key = options[:auth_key]
-      @params = @given_options
+      @telemetry_name = :l_push
+      super
+      # `environment` should
+      @environment ||= 'development' if @push_gateway.eql? 'apns2'
     end
 
     private
@@ -25,19 +26,33 @@ module Pubnub
     end
 
     def path
-      '/' + [
-        'v1',
-        'push',
-        'sub-key',
-        @subscribe_key,
-        'devices',
-        @params.fetch(:push_token)
-      ].join('/')
+      if @push_gateway.eql? 'apns2'
+        '/' + [
+          'v2',
+          'push',
+          'sub-key',
+          @subscribe_key,
+          'devices-apns2',
+          @push_token
+        ].join('/')
+      else
+        '/' + [
+          'v1',
+          'push',
+          'sub-key',
+          @subscribe_key,
+          'devices',
+          @push_token
+        ].join('/')
+      end
     end
 
     def parameters(*_args)
       params = super
-      params.merge!(@params.select { |p, _| required_params.include?(p) })
+      params[:add] = Formatter.channels_for_url(@channel, false)
+      params[:type] = @push_gateway unless @push_gateway.eql? 'apns2'
+      params[:environment] = @environment if @push_gateway.eql? 'apns2'
+      params[:topic] = @topic if @push_gateway.eql? 'apns2'
       params
     end
 
@@ -48,6 +63,7 @@ module Pubnub
         timetoken: nil,
         status: {
           code: req_res_objects[:response].code,
+          operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],
 

data/lib/pubnub/events/get_all_channels_metadata.rb

@@ -56,6 +56,13 @@ module Pubnub
     end
 
     def valid_envelope(parsed_response, req_res_objects)
+      channels_metadata = parsed_response['data'].map { |uuid_metadata|
+        metadata = Hash.new
+        uuid_metadata.each{ |k,v| metadata[k.to_sym] = v }
+        metadata[:updated] = Date._parse(metadata[:updated]) unless metadata[:updated].nil?
+        metadata
+      }
+
       Pubnub::Envelope.new(
         event: @event,
         event_options: @given_options,
@@ -66,7 +73,12 @@ module Pubnub
           operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],
-          data: parsed_response
+          data: {
+            metadata: channels_metadata,
+            totalCount: parsed_response['totalCount'],
+            next: parsed_response['next'],
+            prev: parsed_response['prev']
+          }
         },
 
         status: {

data/lib/pubnub/events/get_all_uuid_metadata.rb

@@ -56,6 +56,13 @@ module Pubnub
     end
 
     def valid_envelope(parsed_response, req_res_objects)
+      uuids_metadata = parsed_response['data'].map { |uuid_metadata|
+        metadata = Hash.new
+        uuid_metadata.each{ |k,v| metadata[k.to_sym] = v }
+        metadata[:updated] = Date._parse(metadata[:updated]) unless metadata[:updated].nil?
+        metadata
+      }
+
       Pubnub::Envelope.new(
         event: @event,
         event_options: @given_options,
@@ -66,7 +73,12 @@ module Pubnub
           operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],
-          data: parsed_response
+          data: {
+            metadata: uuids_metadata,
+            totalCount: parsed_response['totalCount'],
+            next: parsed_response['next'],
+            prev: parsed_response['prev']
+          }
         },
 
         status: {

data/lib/pubnub/events/get_channel_members.rb

@@ -64,6 +64,21 @@ module Pubnub
     end
 
     def valid_envelope(parsed_response, req_res_objects)
+      members = parsed_response['data'].map { |channel_member|
+        member = Hash.new
+        channel_member.each{ |k,v| member[k.to_sym] = v }
+
+        unless member[:uuid].nil?
+          uuid_metadata = Hash.new
+          member[:uuid].each{ |k,v| uuid_metadata[k.to_sym] = v }
+          uuid_metadata[:updated] = Date._parse(uuid_metadata[:updated]) unless uuid_metadata[:updated].nil?
+          member[:uuid] = uuid_metadata
+        end
+        member[:updated] = Date._parse(member[:updated]) unless member[:updated].nil?
+
+        member
+      }
+
       Pubnub::Envelope.new(
         event: @event,
         event_options: @given_options,
@@ -74,7 +89,12 @@ module Pubnub
           operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],
-          data: parsed_response
+          data: {
+            members: members,
+            totalCount: parsed_response['totalCount'],
+            next: parsed_response['next'],
+            prev: parsed_response['prev']
+          }
         },
 
         status: {

data/lib/pubnub/events/get_channel_metadata.rb

@@ -45,6 +45,11 @@ module Pubnub
     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,7 +60,7 @@ module Pubnub
           operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],
-          data: parsed_response
+          data: metadata
         },
 
         status: {

data/lib/pubnub/events/get_memberships.rb

@@ -10,7 +10,7 @@ module Pubnub
     def initialize(options, app)
       @event = current_operation
       @telemetry_name = :l_obj
-      @uuid = options[:uuid]
+      @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?
@@ -64,6 +64,21 @@ module Pubnub
     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,
@@ -74,7 +89,12 @@ module Pubnub
           operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],
-          data: parsed_response
+          data: {
+            memberships: memberships,
+            totalCount: parsed_response['totalCount'],
+            next: parsed_response['next'],
+            prev: parsed_response['prev']
+          }
         },
 
         status: {

data/lib/pubnub/events/get_uuid_metadata.rb

@@ -10,7 +10,7 @@ module Pubnub
     def initialize(options, app)
       @event = current_operation
       @telemetry_name = :l_obj
-      @uuid = options[:uuid]
+      @uuid = options[:uuid].nil? ? app.env[:uuid] : options[:uuid]
 
       if options[:include]
         @include = "custom" unless [0, '0', false].include?(options[:include][:custom])
@@ -45,6 +45,11 @@ module Pubnub
     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,7 +60,7 @@ module Pubnub
           operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],
-          data: parsed_response
+          data: metadata
         },
 
         status: {

data/lib/pubnub/events/grant.rb

@@ -8,7 +8,7 @@ module Pubnub
     def initialize(options, app)
       @event = current_operation
       super
-      @uuids = options[:uuids] unless options[:uuids].nil?
+      @uuids = Formatter::format_uuid(options[:uuids]) unless options[:uuids].nil?
       @ttl ||= Pubnub::Constants::DEFAULT_TTL
     end
 

data/lib/pubnub/events/list_push_provisions.rb

@@ -3,12 +3,14 @@ module Pubnub
   # Push related event
   class ListPushProvisions < SingleEvent
     include Concurrent::Async
-    include Pubnub::Validator::Push
+    include Pubnub::Validator::ListPushProvisions
 
     def initialize(options, app)
-      super
       @event = current_operation
-      @params = @given_options
+      @telemetry_name = :l_push
+      super
+      # `environment` should
+      @environment ||= 'development' if @push_gateway.eql? 'apns2'
     end
 
     private
@@ -24,19 +26,33 @@ module Pubnub
     end
 
     def path
-      '/' + [
-        'v1',
-        'push',
-        'sub-key',
-        @subscribe_key,
-        'devices',
-        @params.fetch(:push_token)
-      ].join('/')
+      if @push_gateway.eql? 'apns2'
+        '/' + [
+          'v2',
+          'push',
+          'sub-key',
+          @subscribe_key,
+          'devices-apns2',
+          @push_token
+        ].join('/')
+      else
+        '/' + [
+          'v1',
+          'push',
+          'sub-key',
+          @subscribe_key,
+          'devices',
+          @push_token
+        ].join('/')
+      end
     end
 
     def parameters(*_args)
       params = super
-      params.merge!(@params.select { |p, _| required_params.include?(p) })
+      # Only include `type` if gateway is other than apns2
+      params[:type] = @push_gateway unless @push_gateway.eql? 'apns2'
+      params[:environment] = @environment if @push_gateway.eql? 'apns2'
+      params[:topic] = @topic if @push_gateway.eql? 'apns2'
       params
     end
 
@@ -47,6 +63,7 @@ module Pubnub
         timetoken: nil,
         status: {
           code: req_res_objects[:response].code,
+          operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],
 

data/lib/pubnub/events/remove_channel_members.rb

@@ -39,7 +39,7 @@ module Pubnub
       Pubnub.logger.debug('Pubnub::RemoveChannelMembers') { "Fired event #{self.class}" }
 
       members = @uuids.map do |member|
-        { uuid: { id: member[:uuid] } }
+        { uuid: { id: member } }
       end
 
       body = Formatter.format_message({ delete: members }, @cipher_key, false)
@@ -81,6 +81,21 @@ module Pubnub
     end
 
     def valid_envelope(parsed_response, req_res_objects)
+      members = parsed_response['data'].map { |channel_member|
+        member = Hash.new
+        channel_member.each{ |k,v| member[k.to_sym] = v }
+
+        unless member[:uuid].nil?
+          uuid_metadata = Hash.new
+          member[:uuid].each{ |k,v| uuid_metadata[k.to_sym] = v }
+          uuid_metadata[:updated] = Date._parse(uuid_metadata[:updated]) unless uuid_metadata[:updated].nil?
+          member[:uuid] = uuid_metadata
+        end
+        member[:updated] = Date._parse(member[:updated]) unless member[:updated].nil?
+
+        member
+      }
+
       Pubnub::Envelope.new(
         event: @event,
         event_options: @given_options,
@@ -91,7 +106,12 @@ module Pubnub
           operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],
-          data: parsed_response
+          data: {
+            members: members,
+            totalCount: parsed_response['totalCount'],
+            next: parsed_response['next'],
+            prev: parsed_response['prev']
+          }
         },
 
         status: {

data/lib/pubnub/events/remove_channels_from_push.rb

@@ -3,13 +3,14 @@ module Pubnub
   # Push related event
   class RemoveChannelsFromPush < SingleEvent
     include Concurrent::Async
-    include Pubnub::Validator::Push
+    include Pubnub::Validator::RemoveChannelsFromPush
 
     def initialize(options, app)
-      super
       @event = current_operation
-      @params = @given_options
-      @auth_key = options[:auth_key]
+      @telemetry_name = :l_push
+      super
+      # `environment` should
+      @environment ||= 'development' if @push_gateway.eql? 'apns2'
     end
 
     private
@@ -25,19 +26,33 @@ module Pubnub
     end
 
     def path
-      '/' + [
-        'v1',
-        'push',
-        'sub-key',
-        @subscribe_key,
-        'devices',
-        @params.fetch(:push_token)
-      ].join('/')
+      if @push_gateway.eql? 'apns2'
+        '/' + [
+          'v2',
+          'push',
+          'sub-key',
+          @subscribe_key,
+          'devices-apns2',
+          @push_token
+        ].join('/')
+      else
+        '/' + [
+          'v1',
+          'push',
+          'sub-key',
+          @subscribe_key,
+          'devices',
+          @push_token
+        ].join('/')
+      end
     end
 
     def parameters(*_args)
       params = super
-      params.merge!(@params.select { |p, _| required_params.include?(p) })
+      params[:remove] = Formatter.channels_for_url(@channel, false)
+      params[:type] = @push_gateway unless @push_gateway.eql? 'apns2'
+      params[:environment] = @environment if @push_gateway.eql? 'apns2'
+      params[:topic] = @topic if @push_gateway.eql? 'apns2'
       params
     end
 
@@ -48,6 +63,7 @@ module Pubnub
         timetoken: nil,
         status: {
           code: req_res_objects[:response].code,
+          operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],