pubnub 4.1.6 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04517d5210c2213931c074c40ecbeeb804179cf8ce28c4f21350321e560b5560
-  data.tar.gz: 8a8b59f386f3d62e747707762856d517e936f0983a3ee393a39e7b97d515bd5b
+  metadata.gz: 9c25c64114536e1291cee9e54eda326abe3a57df11045d1a3b8ca366f3a58ae1
+  data.tar.gz: 83eed4a95f664d986b80710f8ad3d48131648f479ffa7d62a1f3a8dc8beca963
 SHA512:
-  metadata.gz: f294ccd614f20cc7d2ec694ecc9cf493d65c2460833638ec316d793b628e225d7d36c2827491ce4ca77eaf24d1f2daab6e2ede0bcd082123f9bc0aadbf8a266f
-  data.tar.gz: ffb4e0e6977f9efc895abf1fb20e4235fca9fe78a0ed8d8a3d52e2eac9f4bfe8d4d79f5161994df95592996a8925bb2a9c2d48ec0806f5467eee44eac3c1c0a0
+  metadata.gz: 2945b9f4c19a4ed2427bd1cab5a983b9968670efa9becba45dd3be6cf8945a55feea753be973dbd141ab253687cd734cab4b522f7993a7f4032d6a8ec7dc1d4a
+  data.tar.gz: c6d198937f88306474e57ff39c2db525db12619d7ea2072d7b1262be4b9922014f66d3dcd8f29a60c5a28c593cfc15906cf0317c27343064f44797a27794910f

data/.pubnub.yml

@@ -1,11 +1,20 @@
 ---
-version: "4.1.6"
+version: "4.2.0"
 changelog:
-  - changes:
-        - text: "Added signal feature"
-          type: feature
-      date: 21-8-2019
-      version: "4.1.6"
+  -
+    changes:
+      -
+        text: "Added objects feature"
+        type: feature
+    date: 11-10-2019
+    version: "4.2.0"
+  -
+    changes:
+      -
+        text: "Added signal feature"
+        type: feature
+    date: 21-8-2019
+    version: "4.1.6"
   -
     changes:
       -
@@ -300,8 +309,33 @@ features:
     - SUBSCRIBE-WITH-TIMETOKEN
     - SUBSCRIBE-WILDCARD
     - SUBSCRIBE-FILTER-EXPRESSION
+    - SUBSCRIBE-SIGNAL-LISTENER
+    - SUBSCRIBE-MEMBERSHIP-LISTENER
+    - SUBSCRIBE-SPACE-LISTENER
+    - SUBSCRIBE-USER-LISTENER
   signal:
     - SIGNAL-SEND
+  objects:
+    - OBJECTS-GET-USERS
+    - OBJECTS-GET-USER
+    - OBJECTS-CREATE-USER
+    - OBJECTS-UPDATE-USER
+    - OBJECTS-DELETE-USER
+    - OBJECTS-GET-SPACES
+    - OBJECTS-CREATE-SPACE
+    - OBJECTS-GET-SPACE
+    - OBJECTS-UPDATE-SPACE
+    - OBJECTS-DELETE-SPACE
+    - OBJECTS-GET-MEMBERSHIPS
+    - OBJECTS-MANAGE-MEMBERSHIPS
+    - OBJECTS-GET-MEMBERS
+    - OBJECTS-MANAGE-MEMBERS
+    - OBJECTS-JOIN-SPACES
+    - OBJECTS-UPDATE-MEMBERSHIPS
+    - OBJECTS-LEAVE-SPACES
+    - OBJECTS-ADD-MEMBERS
+    - OBJECTS-REMOVE-MEMBERS
+    - OBJECTS-UPDATE-MEMBERS
   time: 
     - TIME-TIME
 name: ruby

data/.travis.yml

@@ -23,5 +23,5 @@ matrix:
   include:
     - rvm: jruby-head
       env: JRUBY_OPTS="--server -J-Xms1500m -J-Xmx1500m -J-XX:+UseConcMarkSweepGC -J-XX:-UseGCOverheadLimit -J-XX:+CMSClassUnloadingEnabled"
-      jdk: oraclejdk9
+      jdk: oraclejdk11
 

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+##### 4.2.0
+* Added objects feature
+
 ##### 4.1.6
 * Added signal feature
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pubnub (4.1.6)
+    pubnub (4.2.0)
       concurrent-ruby (~> 1.1.5)
       concurrent-ruby-edge (~> 0.5.0)
       dry-validation (~> 1.0)

data/README.md

@@ -7,7 +7,7 @@
 # Complete Documentation
 Available at https://www.pubnub.com/docs/ruby/pubnub-ruby-sdk-v4 **v4.x**
 
-## PubNub Gem version 4.1.6
+## PubNub Gem version 4.2.0
 
 ##### YOU MUST HAVE A PUBNUB ACCOUNT TO USE THE API.
 ##### http://www.pubnub.com/account

data/VERSION

@@ -1 +1 @@
-4.1.6
+4.2.0

data/fixtures/vcr_cassettes/lib/events/get_users.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://ps.pndsn.com/v1/objects/demo/users?auth=ruby-test-auth&include=custom&limit=5&pnsdk=PubNub-Ruby/4.2.0&uuid=ruby-test-uuid
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.6.3 (2019-04-16))
+      Accept:
+      - "*/*"
+      Date:
+      - Mon, 14 Oct 2019 13:26:38 GMT
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 14 Oct 2019 13:26:39 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '1140'
+      Connection:
+      - keep-alive
+      Vary:
+      - Accept-Encoding
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Credentials:
+      - 'true'
+    body:
+      encoding: UTF-8
+      string: '{"status":200,"data":[{"id":"UJNPRWCKNI","name":"VBSHVLMPEO","externalId":null,"profileUrl":null,"email":null,"custom":null,"created":"2019-08-16T08:12:02.242563Z","updated":"2019-08-16T08:12:02.242563Z","eTag":"AaeFrJLq79bxMg"},{"id":"YAJNBVKTTY","name":"SZRNRVXLGS","externalId":null,"profileUrl":null,"email":null,"custom":null,"created":"2019-08-16T08:13:26.571666Z","updated":"2019-08-16T08:13:26.571666Z","eTag":"AZG6vojJlPjuvwE"},{"id":"QTIVDQJAOJ","name":"XMRZLEINKB","externalId":null,"profileUrl":null,"email":null,"custom":null,"created":"2019-08-16T08:51:20.763757Z","updated":"2019-08-16T08:51:20.763757Z","eTag":"AcHMvZj9rpTj/wE"},{"id":"SAHHGSCVBO","name":"LRXSBWCRND","externalId":null,"profileUrl":null,"email":null,"custom":{"text":"CGJYKWBJWS","uncd":"=--+=!=="},"created":"2019-08-16T08:55:18.96962Z","updated":"2019-08-16T08:55:18.96962Z","eTag":"AeWkrM7ducOORA"},{"id":"SRMNJAHHNT","name":"XNQAYAJVQE","externalId":null,"profileUrl":null,"email":null,"custom":{"text":"TQONNXSYTR","uncd":"!!++!!-+"},"created":"2019-08-16T08:55:54.795609Z","updated":"2019-08-16T08:55:54.795609Z","eTag":"Af+0/7Gt6oKBNw"}],"next":"NQ"}'
+    http_version: 
+  recorded_at: Mon, 14 Oct 2019 13:26:38 GMT
+recorded_with: VCR 5.0.0

data/lib/pubnub/client.rb

@@ -50,6 +50,20 @@ require 'pubnub/validators/delete'
 require 'pubnub/validators/message_counts'
 require 'pubnub/validators/push'
 require 'pubnub/validators/signal'
+require 'pubnub/validators/create_user'
+require 'pubnub/validators/create_space'
+require 'pubnub/validators/delete_user'
+require 'pubnub/validators/delete_space'
+require 'pubnub/validators/get_user'
+require 'pubnub/validators/get_users'
+require 'pubnub/validators/get_space'
+require 'pubnub/validators/get_spaces'
+require 'pubnub/validators/update_user'
+require 'pubnub/validators/update_space'
+require 'pubnub/validators/get_members'
+require 'pubnub/validators/get_space_memberships'
+require 'pubnub/validators/manage_members'
+require 'pubnub/validators/manage_memberships'
 
 Dir[File.join(File.dirname(__dir__), 'pubnub', 'events', '*.rb')].each do |file|
   require file

data/lib/pubnub/client/events.rb

@@ -6,7 +6,9 @@ module Pubnub
     module Events
       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].freeze
+                  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
 
       EVENTS.each do |event_name|
         define_method event_name do |options = {}, &block|

data/lib/pubnub/constants.rb

@@ -66,6 +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
 
     OPERATIONS = [
       OPERATION_SUBSCRIBE, OPERATION_HEARTBEAT, OPERATION_PRESENCE, OPERATION_TIME, OPERATION_HISTORY,
@@ -73,7 +87,10 @@ 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_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
     ].freeze
 
     # Announcements

data/lib/pubnub/event.rb

@@ -50,12 +50,20 @@ module Pubnub
       Pubnub.logger.debug('Pubnub::Event') { '#send_request got sender' }
 
       telemetry_time_start = ::Time.now.to_f
-      response = if @event == Pubnub::Constants::OPERATION_DELETE
+      response = case @event
+                 when Pubnub::Constants::OPERATION_DELETE, Pubnub::Constants::OPERATION_DELETE_SPACE, Pubnub::Constants::OPERATION_DELETE_USER
                    sender.delete(uri.to_s)
-                 elsif compressed_body.empty?
-                   sender.get(uri.to_s)
-                 else
+                 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
                    sender.post(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
                  end
 
       begin

data/lib/pubnub/events/create_space.rb

@@ -0,0 +1,84 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Holds CreateSpace functionality
+  class CreateSpace < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::CreateSpace
+
+    def initialize(options, app)
+      @event = :create_space
+      @telemetry_name = :l_obj
+      @data = options[:data]
+      @include = options[:include]
+      super
+    end
+
+    def fire
+      Pubnub.logger.debug('Pubnub::CreateSpace') { "Fired event #{self.class}" }
+
+      body = Formatter.format_message(@data, @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_CREATE_SPACE
+    end
+
+    def parameters(*_args)
+      parameters = super
+      parameters[:include] = @include if @include
+      parameters
+    end
+
+    def path
+      '/' + [
+        'v1',
+        'objects',
+        @subscribe_key,
+        'spaces'
+      ].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: Pubnub::Constants::OPERATION_CREATE_SPACE,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: parsed_response
+        },
+
+        status: {
+          code: req_res_objects[:response].code,
+          operation: Pubnub::Constants::OPERATION_CREATE_SPACE,
+          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

@@ -0,0 +1,84 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Holds CreateUser functionality
+  class CreateUser < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::CreateUser
+
+    def initialize(options, app)
+      @event = :create_user
+      @telemetry_name = :l_obj
+      @data = options[:data]
+      @include = options[:include]
+      super
+    end
+
+    def fire
+      Pubnub.logger.debug('Pubnub::CreateUser') { "Fired event #{self.class}" }
+
+      body = Formatter.format_message(@data, @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_CREATE_USER
+    end
+
+    def parameters(*_args)
+      parameters = super
+      parameters[:include] = @include if @include
+      parameters
+    end
+
+    def path
+      '/' + [
+        'v1',
+        'objects',
+        @subscribe_key,
+        'users'
+      ].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: Pubnub::Constants::OPERATION_CREATE_USER,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: parsed_response
+        },
+
+        status: {
+          code: req_res_objects[:response].code,
+          operation: Pubnub::Constants::OPERATION_CREATE_USER,
+          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/delete_space.rb

@@ -0,0 +1,78 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Holds DeleteSpace functionality
+  class DeleteSpace < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::DeleteSpace
+
+    def initialize(options, app)
+      @event = :delete_space
+      @telemetry_name = :l_obj
+      @space_id = options[:space_id]
+      super
+    end
+
+    def fire
+      Pubnub.logger.debug('Pubnub::DeleteSpace') { "Fired event #{self.class}" }
+
+      body = Formatter.format_message(@data, @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_DELETE_SPACE
+    end
+
+    def path
+      '/' + [
+        'v1',
+        'objects',
+        @subscribe_key,
+        'spaces',
+        @space_id
+      ].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: Pubnub::Constants::OPERATION_DELETE_SPACE,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: parsed_response
+        },
+
+        status: {
+          code: req_res_objects[:response].code,
+          operation: Pubnub::Constants::OPERATION_DELETE_SPACE,
+          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