pubnub 4.6.1 → 4.8.0

data/lib/pubnub/event.rb

@@ -24,8 +24,8 @@ module Pubnub
       env.delete(:state)
       create_variables_from_options(env.merge(options))
       @origin = @app.current_origin
-      format_channels
-      format_group
+      format_channels if enable_format_channels?
+      format_group if enable_format_group?
       set_timestamp
       validate!
       telemetry = @app.telemetry_for(@telemetry_name)
@@ -44,7 +44,7 @@ module Pubnub
       envelopes
     end
 
-    def send_request(compressed_body = '')
+    def send_request(compressed_body = '', header = {})
       Pubnub.logger.debug('Pubnub::Event') { '#send_request called' }
 
       @compressed_body = compressed_body
@@ -54,13 +54,13 @@ module Pubnub
       telemetry_time_start = ::Time.now.to_f
       response = case operation_http_method
                  when "get"
-                   sender.get(uri.to_s)
+                   sender.get(uri.to_s, header: header)
                  when "post"
-                   sender.post(uri.to_s, body: compressed_body)
+                   sender.post(uri.to_s, body: compressed_body, header: header)
                  when "patch"
-                   sender.patch(uri.to_s, body: compressed_body)
+                   sender.patch(uri.to_s, body: compressed_body, header: header)
                  else
-                   sender.delete(uri.to_s)
+                   sender.delete(uri.to_s, header: header)
                  end
 
       begin
@@ -102,9 +102,18 @@ module Pubnub
 
     private
 
+    def enable_format_channels?
+      true
+    end
+
+    def enable_format_group?
+      true
+    end
+
     def operation_http_method
       case @event
-      when Pubnub::Constants::OPERATION_DELETE, Pubnub::Constants::OPERATION_REMOVE_CHANNEL_METADATA, Pubnub::Constants::OPERATION_REMOVE_UUID_METADATA
+      when Pubnub::Constants::OPERATION_DELETE, Pubnub::Constants::OPERATION_REMOVE_CHANNEL_METADATA,
+           Pubnub::Constants::OPERATION_REMOVE_UUID_METADATA, Pubnub::Constants::OPERATION_REVOKE_TOKEN
         "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,
@@ -136,8 +145,9 @@ module Pubnub
         pnsdk: @app.sdk_version
       }
 
+      token = @app.env[:token]
       empty_if_blank = {
-        auth: @auth_key,
+        auth: token ? token : @auth_key,
         uuid: @app.env[:uuid],
         @telemetry_name => @current_telemetry
       }
@@ -164,7 +174,8 @@ module Pubnub
                      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
-                     add remove push_token push_gateway environment topic
+                     add remove push_token push_gateway environment topic authorized_uuid
+                     token
                    ]
 
       options = options.each_with_object({}) { |option, obj| obj[option.first.to_sym] = option.last }

data/lib/pubnub/events/grant_token.rb

@@ -0,0 +1,172 @@
+module Pubnub
+  # Holds grant token functionality
+  class GrantToken < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::GrantToken
+
+    def initialize(options, app)
+      @event = current_operation
+      @telemetry_name = :l_pamv3
+      @uuids = options[:uuids] || {}
+      options[:channels] = options[:channels] || {}
+      options[:channel_groups] = options[:channel_groups] || {}
+      super
+    end
+
+    def fire
+      Pubnub.logger.debug('Pubnub::GrantToken') { "Fired event #{self.class}" }
+
+      raw_body = {
+        ttl: @ttl,
+        permissions: {
+          meta: @meta,
+          uuid: @authorized_uuid,
+          resources: prepare_permissions(:resource, @channels, @channel_groups, @uuids),
+          patterns: prepare_permissions(:pattern, @channels, @channel_groups, @uuids)
+        }.select { |_, v| v }
+      }
+      body = Formatter.format_message(raw_body, "", false, false)
+      response = send_request(body, { "Content-Type": "application/json" })
+
+      envelopes = fire_callbacks(handle(response, uri))
+      finalize_event(envelopes)
+      envelopes
+    end
+
+    private
+
+    def enable_format_channels?
+      false
+    end
+
+    def enable_format_group?
+      false
+    end
+
+    def current_operation
+      Pubnub::Constants::OPERATION_GRANT_TOKEN
+    end
+
+    def prepare_permissions(type, channels, groups, uuids)
+      {
+        channels: prepare_single_permissions(type, channels),
+        groups: prepare_single_permissions(type, groups),
+        uuids: prepare_single_permissions(type, uuids)
+      }
+    end
+
+    def prepare_single_permissions(type, resources)
+      resources
+        .select { |_, v| v.type == type }
+        .to_h { |k, v| [k, v.calculate_bitmask] }
+    end
+
+    def valid_envelope(parsed_response, req_res_objects)
+      Pubnub::Envelope.new(
+        event: @event,
+        event_options: @given_options,
+        timetoken: nil,
+        status: {
+          code: req_res_objects[:response].code,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          category: Pubnub::Constants::STATUS_ACK,
+          error: false,
+          auto_retried: false,
+
+          current_timetoken: nil,
+          last_timetoken: nil,
+          subscribed_channels: nil,
+          subscribed_channel_groups: nil,
+
+          data: nil,
+
+          config: get_config
+
+        },
+        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['data']
+        }
+      )
+    end
+
+    def path
+      '/' + [
+        'v3',
+        'pam',
+        @subscribe_key,
+        'grant'
+      ].join('/')
+    end
+  end
+
+  class Permissions
+    attr_reader :type
+
+    class << Permissions
+      def pat(read: false, write: false, manage: false, delete: false,
+              create: false, get: false, update: false, join: false)
+        Permissions.new(
+          type: :pattern,
+          read: read,
+          write: write,
+          manage: manage,
+          delete: delete,
+          create: create,
+          get: get,
+          update: update,
+          join: join
+        )
+      end
+
+      def res(read: false, write: false, manage: false, delete: false, create: false, get: false, update: false, join: false)
+        Permissions.new(
+          type: :resource,
+          read: read,
+          write: write,
+          manage: manage,
+          delete: delete,
+          create: create,
+          get: get,
+          update: update,
+          join: join
+        )
+      end
+    end
+
+    def initialize(options)
+      @type = options[:type]
+      @read = options[:read] || false
+      @write = options[:write] || false
+      @manage = options[:manage] || false
+      @delete = options[:delete] || false
+      @create = options[:create] || false
+      @get = options[:get] || false
+      @update = options[:update] || false
+      @join = options[:join] || false
+    end
+
+    def to_s
+      "Permissions: {:read => #{@read}, :write => #{@write}, :manage => #{@manage} , :delete => #{@delete}, :create => #{@create}, :get => #{@get}, :update => #{@update}, :join => #{@join}}"
+    end
+
+    def calculate_bitmask
+      sum = 0
+
+      sum |= 1 if @read
+      sum |= 2 if @write
+      sum |= 4 if @manage
+      sum |= 8 if @delete
+      sum |= 16 if @create
+      sum |= 32 if @get
+      sum |= 64 if @update
+      sum |= 128 if @join
+      sum
+    end
+  end
+end

data/lib/pubnub/events/revoke_token.rb

@@ -0,0 +1,66 @@
+module Pubnub
+  # Holds revoke token functionality
+  class RevokeToken < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::RevokeToken
+
+    def initialize(options, app)
+      @event = :revoke_token
+      super
+      @token = @token.split(' ')
+            .map{ |part| CGI.escape(part) }
+            .join("%20")
+    end
+
+    private
+
+    def current_operation
+      Pubnub::Constants::OPERATION_GRANT_TOKEN
+    end
+
+    def valid_envelope(parsed_response, req_res_objects)
+      Pubnub::Envelope.new(
+        event: @event,
+        event_options: @given_options,
+        timetoken: nil,
+        status: {
+          code: req_res_objects[:response].code,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          category: Pubnub::Constants::STATUS_ACK,
+          error: false,
+          auto_retried: false,
+
+          current_timetoken: nil,
+          last_timetoken: nil,
+          subscribed_channels: nil,
+          subscribed_channel_groups: nil,
+
+          data: nil,
+
+          config: get_config
+
+        },
+        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['data']
+        }
+      )
+    end
+
+
+    def path
+      '/' + [
+        'v3',
+        'pam',
+        @subscribe_key,
+        'grant',
+        @token
+      ].join('/')
+    end
+  end
+end

data/lib/pubnub/validators/grant_token.rb

@@ -0,0 +1,51 @@
+# Toplevel Pubnub module.
+module Pubnub
+  # Validator module that holds all validators modules
+  module Validator
+    # Validator for Grant event
+    module GrantToken
+      include CommonValidator
+
+      def validate!
+        validate_keys!
+        validate_ttl!
+        validate_permissions!(@uuids, ":uuids")
+        validate_permissions!(@channels, ":channels")
+        validate_permissions!(@channel_groups, ":uuids")
+      end
+
+      private
+
+      def validate_keys!
+        raise(
+          ArgumentError.new(object: self, message: ':subscribe_key is required for grant token event.'),
+          ':subscribe_key is required for grant token event.'
+        ) if @subscribe_key.nil? || @subscribe_key.empty?
+
+        raise(
+          ArgumentError.new(object: self, message: ':secret_key is required for grant token event.'),
+          ':publish_key is required for grant token event.'
+        ) if @secret_key.nil? || @secret_key.empty?
+      end
+
+      def validate_ttl!
+        return unless !@ttl.nil? && !@ttl.is_a?(Integer)
+
+        raise(
+          ArgumentError.new(object: self, message: ':ttl has to be kind of Integer for grant token event.'),
+          ':ttl has to be kind of Integer for grant token event.'
+        )
+      end
+
+      def validate_permissions!(arg, name)
+        return if arg.nil?
+
+        raise(
+          ArgumentError.new(object: self, message: ":#{name} has to be kind of Hash for grant token event."),
+          ":#{name} has to be kind of Hash for grant token event."
+        ) unless arg.is_a?(Hash)
+      end
+    end
+  end
+end
+

data/lib/pubnub/validators/revoke_token.rb

@@ -0,0 +1,31 @@
+# Toplevel Pubnub module.
+module Pubnub
+  # Validator module that holds all validators modules
+  module Validator
+    # Validator for Grant event
+    module RevokeToken
+      include CommonValidator
+
+      def validate!
+        validate_keys!
+        validate_token!
+      end
+
+      private
+
+      def validate_keys!
+        raise(
+          ArgumentError.new(object: self, message: ':subscribe_key is required for revoke token event.'),
+          ':subscribe_key is required for grant token event.'
+        ) if @subscribe_key.nil? || @subscribe_key.empty?
+      end
+
+      def validate_token!
+        raise(
+          ArgumentError.new(object: self, message: ':token is required for revoke token event.'),
+          ':token is required for revoke token event.'
+        ) if @token.nil? || @token.empty?
+      end
+    end
+  end
+end

data/lib/pubnub/version.rb

@@ -1,4 +1,4 @@
 # Toplevel Pubnub module.
 module Pubnub
-  VERSION = '4.6.1'.freeze
+  VERSION = '4.8.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pubnub
 version: !ruby/object:Gem::Version
-  version: 4.6.1
+  version: 4.8.0
 platform: ruby
 authors:
 - PubNub
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-18 00:00:00.000000000 Z
+date: 2021-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -130,6 +130,10 @@ files:
 - ".bundle/config"
 - ".codeclimate.yml"
 - ".github/CODEOWNERS"
+- ".github/workflows/commands-handler.yml"
+- ".github/workflows/release.yml"
+- ".github/workflows/release/versions.json"
+- ".github/workflows/run_acceptance_tests.yml"
 - ".github/workflows/validate-pubnub-yml.yml"
 - ".github/workflows/validate-yml.js"
 - ".gitignore"
@@ -145,7 +149,12 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- config/cucumber.yml
 - docs.md
+- features/step_definitions/access_steps.rb
+- features/support/env.rb
+- features/support/helper.rb
+- features/support/hooks.rb
 - gemfiles/celluloid_017.gemfile
 - gemfiles/celluloid_017.gemfile.lock
 - gemfiles/celluloid_018.gemfile
@@ -155,6 +164,7 @@ files:
 - gemfiles/concurrent-ruby-1.0.5.gem
 - gemfiles/concurrent-ruby-edge-0.3.1.gem
 - lib/pubnub.rb
+- lib/pubnub/cbor.rb
 - lib/pubnub/client.rb
 - lib/pubnub/client/events.rb
 - lib/pubnub/client/getters_setters.rb
@@ -180,6 +190,7 @@ files:
 - lib/pubnub/events/get_memberships.rb
 - lib/pubnub/events/get_uuid_metadata.rb
 - lib/pubnub/events/grant.rb
+- lib/pubnub/events/grant_token.rb
 - lib/pubnub/events/heartbeat.rb
 - lib/pubnub/events/here_now.rb
 - lib/pubnub/events/history.rb
@@ -195,6 +206,7 @@ files:
 - lib/pubnub/events/remove_memberships.rb
 - lib/pubnub/events/remove_uuid_metadata.rb
 - lib/pubnub/events/revoke.rb
+- lib/pubnub/events/revoke_token.rb
 - lib/pubnub/events/set_channel_members.rb
 - lib/pubnub/events/set_channel_metadata.rb
 - lib/pubnub/events/set_memberships.rb
@@ -235,6 +247,7 @@ files:
 - lib/pubnub/validators/get_memberships.rb
 - lib/pubnub/validators/get_uuid_metadata.rb
 - lib/pubnub/validators/grant.rb
+- lib/pubnub/validators/grant_token.rb
 - lib/pubnub/validators/heartbeat.rb
 - lib/pubnub/validators/here_now.rb
 - lib/pubnub/validators/history.rb
@@ -250,6 +263,7 @@ files:
 - lib/pubnub/validators/remove_memberships.rb
 - lib/pubnub/validators/remove_uuid_metadata.rb
 - lib/pubnub/validators/revoke.rb
+- lib/pubnub/validators/revoke_token.rb
 - lib/pubnub/validators/set_channel_members.rb
 - lib/pubnub/validators/set_channel_metadata.rb
 - lib/pubnub/validators/set_memberships.rb
@@ -281,8 +295,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: PubNub Official Ruby gem.
-test_files: []
+test_files:
+- features/step_definitions/access_steps.rb
+- features/support/env.rb
+- features/support/helper.rb
+- features/support/hooks.rb