pubnub 4.4.0 → 4.5.0

data/lib/pubnub/events/remove_device_from_push.rb

@@ -3,12 +3,14 @@ module Pubnub
   # Push related event
   class RemoveDeviceFromPush < SingleEvent
     include Concurrent::Async
-    include Pubnub::Validator::Push
+    include Pubnub::Validator::RemoveDeviceFromPush
 
     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,21 +26,34 @@ module Pubnub
     end
 
     def path
-      '/' + [
-        'v1',
-        'push',
-        'sub-key',
-        @subscribe_key,
-        'devices',
-        @params.fetch(:push_token),
-        'remove'
-      ].join('/')
+      if @push_gateway.eql? 'apns2'
+        '/' + [
+          'v2',
+          'push',
+          'sub-key',
+          @subscribe_key,
+          'devices-apns2',
+          @push_token,
+          'remove'
+        ].join('/')
+      else
+        '/' + [
+          'v1',
+          'push',
+          'sub-key',
+          @subscribe_key,
+          'devices',
+          @push_token,
+          'remove'
+        ].join('/')
+      end
     end
 
     def parameters(*_args)
       params = super
-      params.merge!(@params.select { |p, _| required_params.include?(p) })
-      params[:uuid] = @params[:uuid] if @params.key?(:uuid)
+      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
 
@@ -49,6 +64,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_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?
@@ -39,7 +39,7 @@ module Pubnub
       Pubnub.logger.debug('Pubnub::RemoveMemberships') { "Fired event #{self.class}" }
 
       memberships = @channels.map do |membership|
-        { channel: { id: membership[:channel] } }
+        { channel: { id: membership } }
       end
 
       body = Formatter.format_message({ delete: memberships }, @cipher_key, false)
@@ -81,6 +81,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,
@@ -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: {
+            memberships: memberships,
+            totalCount: parsed_response['totalCount'],
+            next: parsed_response['next'],
+            prev: parsed_response['prev']
+          }
         },
 
         status: {

data/lib/pubnub/events/remove_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]
       super
     end
 

data/lib/pubnub/events/set_channel_members.rb

@@ -84,6 +84,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,
@@ -94,7 +109,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/set_channel_metadata.rb

@@ -58,6 +58,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,
@@ -68,7 +73,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/set_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?
@@ -84,6 +84,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,
@@ -94,7 +109,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/set_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]
 
       # Clean up user-provided metadata object from nils.
       @metadata = options[:metadata].delete_if { |_k, v| v.blank? } unless options[:metadata].nil?
@@ -59,6 +59,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,
@@ -69,7 +74,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/formatter.rb

@@ -31,6 +31,16 @@ 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
@@ -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/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

data/lib/pubnub/validators/grant.rb

@@ -38,7 +38,7 @@ module Pubnub
       end
 
       def validate_uuids!
-        return if @uuid.nil?
+        return if @uuids.nil?
 
         raise(
           ArgumentError.new(object: self, message: ':uuid should not be empty for grant event.'),

data/lib/pubnub/validators/list_push_provisions.rb

@@ -0,0 +1,43 @@
+# Toplevel Pubnub module.
+module Pubnub
+  # Validator module that holds all validators modules
+  module Validator
+    # Validator for ListPushProvisions event
+    module ListPushProvisions
+      include CommonValidator
+
+      def validate!
+        return if @skip_validate
+        validate_push_token!
+        validate_push_gateway!
+        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 ListPushProvisions event.'
+        )
+      end
+
+      def validate_push_gateway!
+        return unless @push_gateway.nil? || @push_gateway.empty?
+        raise(
+          ArgumentError.new,
+          ':push_gateway is required for ListPushProvisions event.'
+        )
+      end
+
+      def validate_topic!
+        return unless @topic.nil? || @topic.empty?
+        raise(
+          ArgumentError.new,
+          ':topic is required for ListPushProvisions event.'
+        )
+      end
+    end
+  end
+end

data/lib/pubnub/validators/remove_channels_from_push.rb

@@ -0,0 +1,52 @@
+# Toplevel Pubnub module.
+module Pubnub
+  # Validator module that holds all validators modules
+  module Validator
+    # Validator for RemoveChannelsFromPush event
+    module RemoveChannelsFromPush
+      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 RemoveChannelsFromPush event.'
+        )
+      end
+
+      def validate_push_gateway!
+        return unless @push_gateway.nil? || @push_gateway.empty?
+        raise(
+          ArgumentError.new,
+          ':push_gateway is required for RemoveChannelsFromPush event.'
+        )
+      end
+
+      def validate_channel!
+        return unless @channel.nil? || @channel.empty?
+        raise(
+          ArgumentError.new,
+          ':channel is required for RemoveChannelsFromPush event.'
+        )
+      end
+
+      def validate_topic!
+        return unless @topic.nil? || @topic.empty?
+        raise(
+          ArgumentError.new,
+          ':topic is required for RemoveChannelsFromPush event.'
+        )
+      end
+    end
+  end
+end