pubnub 4.0.19 → 4.0.20

data/fixtures/vcr_cassettes/lib/multiple_ciphers.yml

@@ -0,0 +1,188 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://ps.pndsn.com/v2/subscribe/demo/multiple_cipher_test/0?pnsdk=PubNub-Ruby/4.0.19&t=%7B%22r%22:0,%22t%22:0%7D&uuid=f14f63f0-fbbc-48eb-931e-cd8af0e0278c
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.4.1 (2017-03-22))
+      Accept:
+      - "*/*"
+      Date:
+      - Mon, 27 Mar 2017 14:27:13 GMT
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 27 Mar 2017 14:27:13 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '45'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET
+    body:
+      encoding: UTF-8
+      string: '{"t":{"t":"14906248338299636","r":12},"m":[]}'
+    http_version: 
+  recorded_at: Mon, 27 Mar 2017 14:27:13 GMT
+- request:
+    method: get
+    uri: http://ps.pndsn.com/publish/demo/demo/0/multiple_cipher_test/0/%22SiyiTt6E/g36egfcDEavKiHNqBjq0sV4n1AIukd+QPg=%22?ortt=%7B%22t%22:14906248339973000%7D&pnsdk=PubNub-Ruby/4.0.19&seqn=1&uuid=f14f63f0-fbbc-48eb-931e-cd8af0e0278c
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.4.1 (2017-03-22))
+      Accept:
+      - "*/*"
+      Date:
+      - Mon, 27 Mar 2017 14:27:14 GMT
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 27 Mar 2017 14:27:14 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '30'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET
+    body:
+      encoding: UTF-8
+      string: '[1,"Sent","14906248340470284"]'
+    http_version: 
+  recorded_at: Mon, 27 Mar 2017 14:27:14 GMT
+- request:
+    method: get
+    uri: http://ps.pndsn.com/v2/subscribe/demo/multiple_cipher_test/0?pnsdk=PubNub-Ruby/4.0.19&t=%7B%22r%22:12,%22t%22:%2214906248338299636%22%7D&uuid=f14f63f0-fbbc-48eb-931e-cd8af0e0278c
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.4.1 (2017-03-22))
+      Accept:
+      - "*/*"
+      Date:
+      - Mon, 27 Mar 2017 14:27:14 GMT
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 27 Mar 2017 14:27:14 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '267'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET
+    body:
+      encoding: UTF-8
+      string: '{"t":{"t":"14906248340566552","r":12},"m":[{"a":"1","f":514,"i":"f14f63f0-fbbc-48eb-931e-cd8af0e0278c","s":1,"o":{"t":"14906248339973000"},"p":{"t":"14906248340470284","r":12},"k":"demo","c":"multiple_cipher_test","d":"SiyiTt6E/g36egfcDEavKiHNqBjq0sV4n1AIukd+QPg="}]}'
+    http_version: 
+  recorded_at: Mon, 27 Mar 2017 14:27:14 GMT
+- request:
+    method: get
+    uri: http://ps.pndsn.com/publish/demo/demo/0/multiple_cipher_test/0/%22MkZas2KYXTSswsWBK2v+TFREAnNoI72Fi+2yiANzxbI=%22?ortt=%7B%22t%22:14906248341698080%7D&pnsdk=PubNub-Ruby/4.0.19&seqn=2&uuid=f14f63f0-fbbc-48eb-931e-cd8af0e0278c
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.4.1 (2017-03-22))
+      Accept:
+      - "*/*"
+      Date:
+      - Mon, 27 Mar 2017 14:27:14 GMT
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 27 Mar 2017 14:27:14 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '30'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET
+    body:
+      encoding: UTF-8
+      string: '[1,"Sent","14906248341647937"]'
+    http_version: 
+  recorded_at: Mon, 27 Mar 2017 14:27:14 GMT
+- request:
+    method: get
+    uri: http://ps.pndsn.com/v2/subscribe/demo/multiple_cipher_test/0?pnsdk=PubNub-Ruby/4.0.19&t=%7B%22r%22:12,%22t%22:%2214906248340566552%22%7D&uuid=f14f63f0-fbbc-48eb-931e-cd8af0e0278c
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.4.1 (2017-03-22))
+      Accept:
+      - "*/*"
+      Date:
+      - Mon, 27 Mar 2017 14:27:14 GMT
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 27 Mar 2017 14:27:14 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '267'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET
+    body:
+      encoding: UTF-8
+      string: '{"t":{"t":"14906248341665599","r":12},"m":[{"a":"1","f":514,"i":"f14f63f0-fbbc-48eb-931e-cd8af0e0278c","s":2,"o":{"t":"14906248341698080"},"p":{"t":"14906248341647937","r":12},"k":"demo","c":"multiple_cipher_test","d":"MkZas2KYXTSswsWBK2v+TFREAnNoI72Fi+2yiANzxbI="}]}'
+    http_version: 
+  recorded_at: Mon, 27 Mar 2017 14:27:14 GMT
+recorded_with: VCR 3.0.1

data/fixtures/vcr_cassettes/lib/multiple_ciphers_history.yml

@@ -0,0 +1,163 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://ps.pndsn.com/publish/demo/demo/0/multiple_cipher_test/0/%22SiyiTt6E/g36egfcDEavKiHNqBjq0sV4n1AIukd+QPg=%22?ortt=%7B%22t%22:14906293412452538%7D&pnsdk=PubNub-Ruby/4.0.19&seqn=1&uuid=3c65b963-1f7f-4a7b-97d1-e71b684ece5d
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.4.1 (2017-03-22))
+      Accept:
+      - "*/*"
+      Date:
+      - Mon, 27 Mar 2017 15:42:21 GMT
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 27 Mar 2017 15:42:21 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '30'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET
+    body:
+      encoding: UTF-8
+      string: '[1,"Sent","14906293411842868"]'
+    http_version: 
+  recorded_at: Mon, 27 Mar 2017 15:42:21 GMT
+- request:
+    method: get
+    uri: http://ps.pndsn.com/v2/history/sub-key/demo/channel/multiple_cipher_test?count=1&pnsdk=PubNub-Ruby/4.0.19&uuid=3c65b963-1f7f-4a7b-97d1-e71b684ece5d
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.4.1 (2017-03-22))
+      Accept:
+      - "*/*"
+      Date:
+      - Mon, 27 Mar 2017 15:42:22 GMT
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 27 Mar 2017 15:42:22 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '86'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET
+      Accept-Ranges:
+      - bytes
+      Age:
+      - '0'
+      Server:
+      - Pubnub
+    body:
+      encoding: UTF-8
+      string: '[["SiyiTt6E/g36egfcDEavKiHNqBjq0sV4n1AIukd+QPg="],14906293411842868,14906293411842868]'
+    http_version: 
+  recorded_at: Mon, 27 Mar 2017 15:42:22 GMT
+- request:
+    method: get
+    uri: http://ps.pndsn.com/publish/demo/demo/0/multiple_cipher_test/0/%22MkZas2KYXTSswsWBK2v+TFREAnNoI72Fi+2yiANzxbI=%22?ortt=%7B%22t%22:14906293424201470%7D&pnsdk=PubNub-Ruby/4.0.19&seqn=2&uuid=3c65b963-1f7f-4a7b-97d1-e71b684ece5d
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.4.1 (2017-03-22))
+      Accept:
+      - "*/*"
+      Date:
+      - Mon, 27 Mar 2017 15:42:22 GMT
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 27 Mar 2017 15:42:22 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '30'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET
+    body:
+      encoding: UTF-8
+      string: '[1,"Sent","14906293423103762"]'
+    http_version: 
+  recorded_at: Mon, 27 Mar 2017 15:42:22 GMT
+- request:
+    method: get
+    uri: http://ps.pndsn.com/v2/history/sub-key/demo/channel/multiple_cipher_test?count=1&pnsdk=PubNub-Ruby/4.0.19&uuid=3c65b963-1f7f-4a7b-97d1-e71b684ece5d
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.4.1 (2017-03-22))
+      Accept:
+      - "*/*"
+      Date:
+      - Mon, 27 Mar 2017 15:42:23 GMT
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 27 Mar 2017 15:42:23 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '86'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET
+      Accept-Ranges:
+      - bytes
+      Age:
+      - '0'
+      Server:
+      - Pubnub
+    body:
+      encoding: UTF-8
+      string: '[["MkZas2KYXTSswsWBK2v+TFREAnNoI72Fi+2yiANzxbI="],14906293423103762,14906293423103762]'
+    http_version: 
+  recorded_at: Mon, 27 Mar 2017 15:42:23 GMT
+recorded_with: VCR 3.0.1

data/lib/pubnub/client/getters_setters.rb

@@ -0,0 +1,127 @@
+# Toplevel Pubnub module.
+module Pubnub
+  # Pubnub client Class
+  class Client
+    # Module that holds some getters and setters
+    module GettersSetters
+      def sdk_version
+        "PubNub-Ruby/#{Pubnub::VERSION}"
+      end
+
+      # Parameters:
+      # ===========
+      # <dl>
+      #   <dt>uuid</dt>
+      #   <dd>New uuid to be set.</dd>
+      # </dl>
+      #
+      # Returns:
+      # ========
+      # New uuid.
+      #
+      # Functionality:
+      # ==============
+      # Can't change uuid while subscribed. You have to leave every subscribed channel.
+      def change_uuid(uuid)
+        Pubnub.logger.debug('Pubnub::Client') { 'Changing uuid' }
+        if subscribed?
+          fail('Cannot change UUID while subscribed.')
+        else
+          @env[:uuid] = uuid
+        end
+      end
+      alias_method :session_uuid=, :change_uuid
+      alias_method :uuid=, :change_uuid
+      alias_method :set_uuid=, :change_uuid
+
+      # Returns:
+      # ========
+      # Current origin.
+      def current_origin
+        @env[:origin]
+      end
+      alias_method :origin, :current_origin
+
+      # Returns:
+      # ========
+      # Origin that was set.
+      def origin=(origin)
+        @env[:origin] = origin
+      end
+
+      # Returns:
+      # ========
+      # Current client timetoken
+      def timetoken
+        @env[:timetoken]
+      end
+
+      # Retruns:
+      # ========
+      # Current region or default '0'
+      def region_code
+        @env[:region_code] || 0
+      end
+
+      # Parameters:
+      # ===========
+      # <dl>
+      #   <dt>region</dt>
+      #   <dd>New region.</dd>
+      # </dl>
+      # Returns:
+      # ========
+      # New region.
+      def region_code=(region)
+        @env[:region_code] = region
+      end
+
+      # Parameters:
+      # ===========
+      # <dl>
+      #   <dt>timetoken</dt>
+      #   <dd>New timetoken.</dd>
+      # </dl>
+      # Returns:
+      # ========
+      # New timetoken.
+      def timetoken=(timetoken)
+        @env[:timetoken] = timetoken
+      end
+
+      # Returns:
+      # ========
+      # Current uuid.
+      def uuid
+        @env[:uuid]
+      end
+
+      # Returns:
+      # ========
+      # Array of all current events.
+      # :nocov:
+      def events
+        @env[:events]
+      end
+      # :nocov:
+
+      def current_heartbeat
+        @env[:heartbeat].to_i
+      end
+
+      def heartbeat=(value)
+        @env[:heartbeat] = value
+      end
+
+      def subscribe_filter=(filter_expr)
+        @env[:subscribe_filter] = filter_expr
+        @subscriber.reset if subscribed?
+        filter_expr
+      end
+
+      def subscribe_filter
+        @env[:subscribe_filter]
+      end
+    end
+  end
+end

data/lib/pubnub/client.rb

@@ -27,6 +27,7 @@ require 'pubnub/error_envelope'
 require 'pubnub/client/events'
 require 'pubnub/client/paged_history'
 require 'pubnub/client/helpers'
+require 'pubnub/client/getters_setters'
 
 require 'pubnub/validators/common_validator'
 require 'pubnub/validators/client'
@@ -70,6 +71,7 @@ module Pubnub
     include Events
     include PagedHistory
     include Helpers
+    include GettersSetters
 
     attr_reader :env, :subscriber, :heart
 
@@ -267,109 +269,11 @@ module Pubnub
       Pubnub.logger.debug('Pubnub::Client') { 'There\'s no requester' }
     end
 
-    # Parameters:
-    # ===========
-    # <dl>
-    #   <dt>uuid</dt>
-    #   <dd>New uuid to be set.</dd>
-    # </dl>
-    #
-    # Returns:
-    # ========
-    # New uuid.
-    #
-    # Functionality:
-    # ==============
-    # Can't change uuid while subscribed. You have to leave every subscribed channel.
-    def change_uuid(uuid)
-      Pubnub.logger.debug('Pubnub::Client') { 'Changing uuid' }
-      if subscribed?
-        fail('Cannot change UUID while subscribed.')
-      else
-        @env[:uuid] = uuid
-      end
-    end
-    alias_method :session_uuid=, :change_uuid
-    alias_method :uuid=, :change_uuid
-    alias_method :set_uuid=, :change_uuid
-
-    # Returns:
-    # ========
-    # Current origin.
-    def current_origin
-      @env[:origins_pool].first
-    end
-    alias_method :origin, :current_origin
-
-    # Returns:
-    # ========
-    # Current client timetoken
-    def timetoken
-      @env[:timetoken]
-    end
-
-    # Retruns:
-    # ========
-    # Current region or default '0'
-    def region_code
-      @env[:region_code] || 0
-    end
-
-    # Parameters:
-    # ===========
-    # <dl>
-    #   <dt>region</dt>
-    #   <dd>New region.</dd>
-    # </dl>
-    # Returns:
-    # ========
-    # New region.
-    def region_code=(region)
-      @env[:region_code] = region
-    end
-
-    # Parameters:
-    # ===========
-    # <dl>
-    #   <dt>timetoken</dt>
-    #   <dd>New timetoken.</dd>
-    # </dl>
-    # Returns:
-    # ========
-    # New timetoken.
-    def timetoken=(timetoken)
-      @env[:timetoken] = timetoken
-    end
-
-    # Returns:
-    # ========
-    # Current uuid.
-    def uuid
-      @env[:uuid]
-    end
-
-    # Returns:
-    # ========
-    # Array of all current events.
-    # :nocov:
-    def events
-      @env[:events]
-    end
-    # :nocov:
-
     def sequence_number_for_publish!
       @env[:sequence_number_for_publish] += 1
       @env[:sequence_number_for_publish] % 2**32
     end
 
-    def current_heartbeat
-      @env[:heartbeat].to_i
-    end
-
-    def heartbeat=(value)
-      @env[:heartbeat] = value
-    end
-
     def apply_state(event)
       Pubnub.logger.debug('Pubnub::Client') { 'Apply state' }
       create_state_pools(event)
@@ -394,20 +298,6 @@ module Pubnub
       (::Time.now.to_f * 10_000_000).to_i
     end
 
-    def subscribe_filter=(filter_expr)
-      @env[:subscribe_filter] = filter_expr
-      @subscriber.reset if subscribed?
-      filter_expr
-    end
-
-    def subscribe_filter
-      @env[:subscribe_filter]
-    end
-
-    def sdk_version
-      "PubNub-Ruby/#{Pubnub::VERSION}"
-    end
-
     private
 
     def create_state_pools(event)
@@ -456,6 +346,7 @@ module Pubnub
     end
 
     def assign_defaults
+      @env[:origin] = @env[:origins_pool].first if @env[:origins_pool]
       default_values.each do |k, v|
         @env[k] = v unless @env[k]
       end

data/lib/pubnub/configuration.rb

@@ -5,7 +5,7 @@ module Pubnub
     private
 
     def default_values
-      { origins_pool: Pubnub::Constants::DEFAULT_ORIGINS_POOL,
+      { origin: Pubnub::Constants::DEFAULT_ORIGIN,
         open_timeout: Pubnub::Constants::DEFAULT_OPEN_TIMEOUT,
         read_timeout: Pubnub::Constants::DEFAULT_READ_TIMEOUT,
         idle_timeout: Pubnub::Constants::DEFAULT_IDLE_TIMEOUT,

data/lib/pubnub/constants.rb

@@ -1,4 +1,6 @@
+# Toplevel Pubnub module.
 module Pubnub
+  # Constants module holds all constants and default values.
   module Constants
     # Config constants
     DEFAULT_READ_TIMEOUT               = 10
@@ -12,7 +14,7 @@ module Pubnub
     DEFAULT_H_IDLE_TIMEOUT             = 10
     DEFAULT_RECONNECT_ATTEMPTS         = 10
     DEFAULT_RECONNECT_INTERVAL         = 10
-    DEFAULT_ORIGINS_POOL               = ['ps.pndsn.com']
+    DEFAULT_ORIGIN                     = 'ps.pndsn.com'
     DEFAULT_PORT                       = 80
     PERIODIC_TIMER_INTERVAL            = 0.25
     DEFAULT_TTL                        = 1440
@@ -33,7 +35,8 @@ module Pubnub
     # Successes
     STATUS_ACK = :ack
 
-    STATUS_CATEGORY_ERRORS    = [STATUS_ACCESS_DENIED, STATUS_TIMEOUT, STATUS_NON_JSON_RESPONSE, STATUS_API_KEY_ERROR, SSL_ERROR]
+    STATUS_CATEGORY_ERRORS    = [STATUS_ACCESS_DENIED, STATUS_TIMEOUT, STATUS_NON_JSON_RESPONSE, STATUS_API_KEY_ERROR,
+                                 SSL_ERROR]
     STATUS_CATEGORY_SUCCESSES = [STATUS_ACK]
 
     # Operations

data/lib/pubnub/crypto.rb

@@ -11,7 +11,7 @@ module Pubnub
     end
 
     def encrypt(message)
-      aes = OpenSSL::Cipher::Cipher.new(@alg)
+      aes = OpenSSL::Cipher.new(@alg)
       aes.encrypt
       aes.key = @key
       aes.iv = @iv
@@ -24,7 +24,7 @@ module Pubnub
     end
 
     def decrypt(cipher_text)
-      decode_cipher = OpenSSL::Cipher::Cipher.new(@alg).decrypt
+      decode_cipher = OpenSSL::Cipher.new(@alg).decrypt
       decode_cipher.key = @key
       decode_cipher.iv  = @iv
 
@@ -47,10 +47,10 @@ module Pubnub
       '"DECRYPTION ERROR"'
     end
 
-    def load_json(text)
-      JSON.load(text)
+    def load_json(plain_text)
+      JSON.load(plain_text)
     rescue JSON::ParserError
-      JSON.load("[#{text}]")[0]
+      JSON.load("[#{plain_text}]")[0]
     end
   end
 end