pubnub 4.2.5 → 4.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86e45590c51fc5c68bc1338d7e328647e388825f3d880a3e80ffc1e2c5c64240
-  data.tar.gz: 0f5e0dc7e964e9deb5a52ef9a78281ec5819a8ac6059e52ae10ca8ec872ea800
+  metadata.gz: 3f7a81a88398281f6a7aabc7b3a6cfdc12c3f2c69d3f38648f35de7143e325d4
+  data.tar.gz: cc0ceed081a5b115b283fe9ccc0e344e9865b815e3fef4b02ef24c01ea4d9507
 SHA512:
-  metadata.gz: 19b6fc85836903d3baea82171224b3fad0178b89ebb6efa4a18d831e412d1b7ca74cb37a035d3051cb33c13ac4211483f6940ad831ee729a86506cd5e8fc6071
-  data.tar.gz: 2daad3e26f3398ad1d77811557930c230b87016e09269b595458b486e941063296d78addb422d70c786f653a19ba5a3305bd29cf2a190492f65899107b1c40d3
+  metadata.gz: 1a715e51fcc684a51fb1ef192f95780ebf3c815c6fe0cf2c67df58a38a697be9a80e9a52541abe6a4202ebd2dc0f2b330b7c82ea261230bb95e6c3e73cb4509a
+  data.tar.gz: b4d7f702196a4aa9c32b4ca94c12ec9281ab37ad083175a021ef798f5b3148d3820abde80454b999b9609001e3bc76d61b27d62430c03e2f71166186cc0f91fb

data/.pubnub.yml

@@ -1,6 +1,16 @@
 ---
-version: "4.2.5"
+version: "4.2.6"
 changelog:
+  -
+    changes:
+      -
+        text: "History can now respond with message meta information."
+        type: feature
+      -
+        text: "Added official support for Ruby 2.7X\u2028\u2028fix: Decrypt History messages\u2028\u2028History properly decrypts messages when using the \"include_token\" parameter."
+        type: feature
+    date: 25-08-2020
+    version: v4.2.6
   -
     changes:
       -
@@ -27,7 +37,7 @@ changelog:
         text: "Resolved issue with subscribe loop where the connection was reinitiated after receiving a 4xx error code from the server"
         type: bugfix
     date: 14-02-2020
-    version: "4.2.5"
+    version: "4.2.6"
   -
     changes:
       -
@@ -123,210 +133,210 @@ changelog:
     date: 26-07-2017
     version: "4.0.23"
   -
-    changes: 
-      - 
+    changes:
+      -
         text: "Fixed signature generation and channel name escaping"
         type: bug
     date: 31-05-2017
     version: "4.0.22"
-  - 
-    changes: 
-      - 
+  -
+    changes:
+      -
         text: "Fixed signature generation"
         type: bug
     date: 18-04-2017
     version: "4.0.21"
-  - 
-    changes: 
-      - 
+  -
+    changes:
+      -
         text: "origin can now be set in initialized client"
         type: improvement
-      - 
+      -
         text: "presence interval support"
         type: improvement
-      - 
+      -
         text: "allows using multiple cipher keys"
         type: improvement
     date: 11-04-2017
     version: "4.0.20"
-  - 
-    changes: 
-      - 
+  -
+    changes:
+      -
         text: "Fixed sync subscribe not terminating actors"
         type: bug
     date: 02-03-2017
     version: v4.0.18
-  - 
-    changes: 
-      - 
+  -
+    changes:
+      -
         text: "Added a bit more debug logging"
         type: improvement
-      - 
+      -
         text: "Updated default origin"
         type: improvement
     date: 21-12-2016
     version: v4.0.17
-  - 
-    changes: 
-      - 
+  -
+    changes:
+      -
         text: "Fixed missing channel group parameter in leave event"
         type: bug
     date: ~
     version: v4.0.16
-  - 
-    changes: 
-      - 
+  -
+    changes:
+      -
         text: "Fixed PAM signature when some special characters are present"
         type: bug
     date: ~
     version: v4.0.15
-  - 
-    changes: 
-      - 
+  -
+    changes:
+      -
         text: "Added ttl parameter for publish"
         type: improvement
     date: ~
     version: v4.0.14
-  - 
-    changes: 
-      - 
+  -
+    changes:
+      -
         text: "Changed init message log level to debug"
         type: improvement
     date: ~
     version: v4.0.13
-  - 
-    changes: 
-      - 
+  -
+    changes:
+      -
         text: "Added alert on catchup failure (REQUEST_MESSAGE_COUNT_EXCEEDED)"
         type: improvement
     date: ~
     version: v4.0.12
-  - 
-    changes: 
-      - 
+  -
+    changes:
+      -
         text: "Added super admin mode (Enabled when secret key is set on Pubnub::Client init)"
         type: improvement
     date: ~
     version: v4.0.11
-  - 
-    changes: 
-      - 
+  -
+    changes:
+      -
         text: "Better single events timeout handling"
         type: improvement
-      - 
+      -
         text: "DRYed envelope formatting a bit"
         type: improvement
     date: ~
     version: v4.0.10
-  - 
-    changes: 
-      - 
+  -
+    changes:
+      -
         text: "Removed json dependency"
         type: improvement
-      - 
+      -
         text: "Updated dependecies"
         type: improvement
     date: ~
     version: v4.0.9
-  - 
-    changes: 
-      - 
+  -
+    changes:
+      -
         text: "Updated dry-validation."
         type: improvement
-      - 
+      -
         text: "Dropped support for ruby 2.0."
         type: improvement
     date: ~
     version: v4.0.8
-  - 
-    changes: 
-      - 
+  -
+    changes:
+      -
         text: "Added message decrypting in history."
         type: improvement
     date: ~
     version: v4.0.7
-  - 
-    changes: 
-      - 
+  -
+    changes:
+      -
         text: "channel and channels are the same argument."
         type: improvement
-      - 
+      -
         text: "channel_group and channel_groups are the same argument."
         type: improvement
-      - 
+      -
         text: "added `with_presence` flag for subscribe, default false."
         type: improvement
     date: ~
     version: v4.0.6
-  - 
-    changes: 
-      - 
+  -
+    changes:
+      -
         text: "Required CGI."
         type: improvement
     version: v4.0.5
-  - 
-    changes: 
-      - 
+  -
+    changes:
+      -
         text: Added
         type: feature
     version: v4.0.2
-  - 
-    changes: 
-      - 
+  -
+    changes:
+      -
         text: "Updated dry-validation and EnvelopeSchema."
         type: improvement
     version: v4.0.1
-  - 
-    changes: 
-      - 
+  -
+    changes:
+      -
         text: "Removed auth_key and uuid setters (#set_auth_key,"
         type: feature
-      - 
+      -
         text: Added
         type: improvement
     version: v4.0.0
-  - 
-    changes: 
-      - 
+  -
+    changes:
+      -
         text: "Restored auth_key and uuid setters. Important notice: they will be removed"
         type: improvement
     version: v3.8.3
-  - 
-    changes: 
-      - 
+  -
+    changes:
+      -
         text: "Added :include_token parameter to history call."
         type: feature
     version: v3.8.2
-  - 
-    changes: 
-      - 
+  -
+    changes:
+      -
         text: "Updated celluloid dependency."
         type: improvement
     version: v3.8.1
-  - 
-    changes: 
-      - 
+  -
+    changes:
+      -
         text: "Release of celluloid version of pubnub gem. It's complete rewrite but public API doesn't change."
         type: improvement
     version: v3.8.0
-features: 
-  access: 
+features:
+  access:
     - ACCESS-GRANT
     - ACCESS-SECRET-KEY-ALL-ACCESS
-  channel-groups: 
+  channel-groups:
     - CHANNEL-GROUPS-ADD-CHANNELS
     - CHANNEL-GROUPS-REMOVE-CHANNELS
     - CHANNEL-GROUPS-REMOVE-GROUPS
     - CHANNEL-GROUPS-LIST-CHANNELS-IN-GROUP
-  notify: 
+  notify:
     - REQUEST-MESSAGE-COUNT-EXCEEDED
-  presence: 
+  presence:
     - PRESENCE-HERE-NOW
     - PRESENCE-WHERE-NOW
     - PRESENCE-SET-STATE
     - PRESENCE-GET-STATE
     - PRESENCE-HEARTBEAT
-  publish: 
+  publish:
     - PUBLISH-STORE-FLAG
     - PUBLISH-RAW-JSON
     - PUBLISH-WITH-METADATA
@@ -335,14 +345,14 @@ features:
     - PUBLISH-SYNC
     - PUBLISH-ASYNC
     - PUBLISH-MESSAGE-TTL
-  storage: 
+  storage:
     - STORAGE-REVERSE
     - STORAGE-INCLUDE-TIMETOKEN
     - STORAGE-START-END
     - STORAGE-COUNT
     - STORAGE-DELETE-MESSAGES
     - STORAGE-MESSAGE-COUNT
-  subscribe: 
+  subscribe:
     - SUBSCRIBE-CHANNELS
     - SUBSCRIBE-CHANNEL-GROUPS
     - SUBSCRIBE-PRESENCE-CHANNELS
@@ -377,18 +387,18 @@ features:
     - OBJECTS-ADD-MEMBERS
     - OBJECTS-REMOVE-MEMBERS
     - OBJECTS-UPDATE-MEMBERS
-  time: 
+  time:
     - TIME-TIME
 name: ruby
 schema: 1
 scm: github.com/pubnub/ruby
-supported-platforms: 
-  - 
-    editors: 
+supported-platforms:
+  -
+    editors:
       - "ruby 2.6"
       - "ruby 2.5"
       - "ruby 2.4"
-    platforms: 
+    platforms:
       - "FreeBSD 8-STABLE or later, amd64, 386"
       - "Linux 2.6 or later, amd64, 386"
       - "macOS 10.8 or later, amd64"

data/.travis.yml

@@ -17,18 +17,20 @@ stages:
 jobs:
   include:
     - stage: "test"
-      name: 'Ruby 2.4.4'
-      rvm: '2.4.4'
+      name: 'Ruby 2.4.10'
+      rvm: '2.4.10'
       script: bundle exec rspec
-    - name: 'Ruby 2.5.1'
-      rvm: '2.5.1'
+    - name: 'Ruby 2.5.8'
+      rvm: '2.5.8'
       script: bundle exec rspec
-    - name: 'Ruby 2.6.3'
-      rvm: '2.6.3'
+    - name: 'Ruby 2.6.6'
+      rvm: '2.6.6'
+      script: bundle exec rspec
+    - name: 'Ruby 2.7.1'
+      rvm: '2.7.1'
       script: bundle exec rspec
     - name: 'Ruby JRuby'
       rvm: 'jruby-head'
       env: JRUBY_OPTS="--server -J-Xms1500m -J-Xmx1500m -J-XX:+UseConcMarkSweepGC -J-XX:-UseGCOverheadLimit -J-XX:+CMSClassUnloadingEnabled"
       jdk: oraclejdk11
       script: bundle exec rspec
-

data/CHANGELOG.md

@@ -1,14 +1,19 @@
+##### v4.2.6
+
+- History can now respond with message meta information. 
+- Added official support for Ruby 2.7X20282028fix: Decrypt History messages20282028History properly decrypts messages when using the "include_token" parameter. 
+
 ##### v4.2.5
 
-- Updated Subscribe endpoint tests to use an unsorted channels list. 
-- Fixed Message Counts channel timetokens by disabling alphabetic sorting of the channels list. 
+- Updated Subscribe endpoint tests to use an unsorted channels list.
+- Fixed Message Counts channel timetokens by disabling alphabetic sorting of the channels list.
 
 ##### v4.2.4
 
-- Update Grant, Revoke and Audit PAM tests to use v2 paths instead of v1. 
+- Update Grant, Revoke and Audit PAM tests to use v2 paths instead of v1.
 - Replace event name with full endpoint path in PAM signatures, for compatibility with PAM v2 signatures. Addresses the following PRs from [@stefan-qsd](https://github.com/stefan-qsd): [#112](https://github.com/pubnub/ruby/pull/112).
-- Change paths for PAM endpoints from v1 to v2. 
-- Update PAM signature generator to correctly sort the query string parameters based on key instead of combined key and value. 
+- Change paths for PAM endpoints from v1 to v2.
+- Update PAM signature generator to correctly sort the query string parameters based on key instead of combined key and value.
 
 ##### 4.2.3
 * Resolved issue with subscribe loop where the connection was reinitiated after receiving a 4xx error code from the server

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    pubnub (4.2.5)
+    pubnub (4.2.6)
+      addressable (>= 2.0.0)
       concurrent-ruby (~> 1.1.5)
       concurrent-ruby-edge (~> 0.5.0)
       dry-validation (~> 1.0)
@@ -12,26 +13,27 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
-    ast (2.4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
     awesome_print (1.8.0)
     binding_of_caller (0.8.0)
       debug_inspector (>= 0.0.1)
-    codacy-coverage (2.1.0)
+    codacy-coverage (2.2.1)
       simplecov
-    coderay (1.1.2)
-    concurrent-ruby (1.1.5)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.6)
     concurrent-ruby-edge (0.5.0)
       concurrent-ruby (~> 1.1.5)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     debug_inspector (0.0.3)
-    diff-lcs (1.3)
+    diff-lcs (1.4.4)
     docile (1.3.2)
-    dry-configurable (0.9.0)
+    dry-configurable (0.11.6)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.4, >= 0.4.7)
+      dry-equalizer (~> 0.2)
     dry-container (0.7.2)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
@@ -39,108 +41,100 @@ GEM
       concurrent-ruby (~> 1.0)
     dry-equalizer (0.3.0)
     dry-inflector (0.2.0)
-    dry-initializer (3.0.2)
-    dry-logic (1.0.5)
+    dry-initializer (3.0.3)
+    dry-logic (1.0.6)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.2)
       dry-equalizer (~> 0.2)
-    dry-schema (1.4.1)
+    dry-schema (1.5.2)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.8, >= 0.8.3)
       dry-core (~> 0.4)
       dry-equalizer (~> 0.2)
       dry-initializer (~> 3.0)
       dry-logic (~> 1.0)
-      dry-types (~> 1.2)
-    dry-types (1.2.1)
+      dry-types (~> 1.4)
+    dry-types (1.4.0)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.3)
       dry-core (~> 0.4, >= 0.4.4)
-      dry-equalizer (~> 0.2, >= 0.2.2)
+      dry-equalizer (~> 0.3)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
-    dry-validation (1.3.1)
+    dry-validation (1.5.3)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.7, >= 0.7.1)
       dry-core (~> 0.4)
       dry-equalizer (~> 0.2)
       dry-initializer (~> 3.0)
-      dry-schema (~> 1.0, >= 1.3.1)
-    ffi (1.11.1-java)
-    hashdiff (1.0.0)
+      dry-schema (~> 1.5)
+    hashdiff (1.0.1)
     httpclient (2.8.3)
     interception (0.5)
-    jaro_winkler (1.5.3)
-    jaro_winkler (1.5.3-java)
-    json (2.2.0)
-    json (2.2.0-java)
-    method_source (0.9.2)
-    parallel (1.17.0)
-    parser (2.6.3.0)
-      ast (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry (0.12.2-java)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-      spoon (~> 0.0)
-    pry-rescue (1.5.0)
+    json (2.3.1)
+    method_source (1.0.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-rescue (1.5.2)
       interception (>= 0.5)
       pry (>= 0.12.0)
-    pry-stack_explorer (0.4.9.3)
-      binding_of_caller (>= 0.7)
-      pry (>= 0.9.11)
-    public_suffix (3.1.1)
+    pry-stack_explorer (0.4.11)
+      binding_of_caller (~> 0.7)
+      pry (~> 0.13)
+    public_suffix (4.0.5)
     rainbow (3.0.0)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
     rr (1.2.1)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-retry (0.6.1)
+      rspec-support (~> 3.9.0)
+    rspec-retry (0.6.2)
       rspec-core (> 3.3)
-    rspec-support (3.8.2)
-    rubocop (0.73.0)
-      jaro_winkler (~> 1.5.1)
+    rspec-support (3.9.3)
+    rubocop (0.89.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
-    simplecov (0.17.0)
+    simplecov (0.18.5)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    spoon (0.0.6)
-      ffi
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
     timers (4.3.0)
-    unicode-display_width (1.6.0)
-    vcr (5.0.0)
-    webmock (3.6.0)
+    unicode-display_width (1.7.0)
+    vcr (6.0.0)
+    webmock (3.8.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
-  java
   ruby
-  x64-mingw32
 
 DEPENDENCIES
   awesome_print
-  bundler (~> 1.7)
   codacy-coverage
   pry
   pry-rescue
@@ -155,4 +149,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

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.2.5
+## PubNub Gem version 4.2.6
 
 ##### YOU MUST HAVE A PUBNUB ACCOUNT TO USE THE API.
 ##### http://www.pubnub.com/account

data/VERSION

@@ -1 +1 @@
-4.2.5
+4.2.6

data/fixtures/vcr_cassettes/examples/history/100.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://ps.pndsn.com/v2/history/sub-key/sub-a-mock-key/channel/rubytest?auth=ruby-test-auth-client-one&include_meta=true&pnsdk=PubNub-Ruby/4.2.5&uuid=ruby-test-uuid-client-one
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.5.3 (2018-10-18))
+      Accept:
+      - "*/*"
+      Date:
+      - Tue, 04 Aug 2020 20:53:59 GMT
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 04 Aug 2020 20:53:59 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '130'
+      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: '[[{"message": {"message": "text"}, "timetoken": 15965666789169854,
+        "meta": {"metaKey": "metaValue"}}],15965666789169854,15965666789169854]'
+  recorded_at: Tue, 04 Aug 2020 20:53:59 GMT
+recorded_with: VCR 6.0.0

data/fixtures/vcr_cassettes/examples/history/include_meta__encrypted.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://ps.pndsn.com/v2/history/sub-key/sub-a-mock-key/channel/rubytest?auth=ruby-test-auth-client-one&count=10&include_meta=true&pnsdk=PubNub-Ruby/4.2.5&uuid=ruby-test-uuid-client-one
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.4.10 (2020-03-31))
+      Accept:
+      - "*/*"
+      Date:
+      - Tue, 18 Aug 2020 22:11:06 GMT
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 18 Aug 2020 22:11:06 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '123'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET, POST, DELETE, OPTIONS
+      Accept-Ranges:
+      - bytes
+      Age:
+      - '0'
+      Server:
+      - Pubnub
+    body:
+      encoding: UTF-8
+      string: '[[{"message": "wdjzGfMFLREacKDtVrgDgA==", "timetoken": 15965666789169854,
+        "meta": ""}],15965666789169854,15965666789169854]'
+  recorded_at: Tue, 18 Aug 2020 22:11:06 GMT
+recorded_with: VCR 6.0.0

data/fixtures/vcr_cassettes/examples/history/include_token__encrypted.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://ps.pndsn.com/v2/history/sub-key/sub-a-mock-key/channel/rubytest?auth=ruby-test-auth-client-one&count=10&include_token=true&pnsdk=PubNub-Ruby/4.2.5&uuid=ruby-test-uuid-client-one
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.4.10 (2020-03-31))
+      Accept:
+      - "*/*"
+      Date:
+      - Tue, 18 Aug 2020 22:13:02 GMT
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 18 Aug 2020 22:13:02 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '111'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET, POST, DELETE, OPTIONS
+      Accept-Ranges:
+      - bytes
+      Age:
+      - '0'
+      Server:
+      - Pubnub
+    body:
+      encoding: UTF-8
+      string: '[[{"message": "wdjzGfMFLREacKDtVrgDgA==", "timetoken": 15965666789169854}],15965666789169854,15965666789169854]'
+  recorded_at: Tue, 18 Aug 2020 22:13:02 GMT
+recorded_with: VCR 6.0.0

data/fixtures/vcr_cassettes/examples/history/no_includes__encrypted.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://ps.pndsn.com/v2/history/sub-key/sub-a-mock-key/channel/rubytest?auth=ruby-test-auth-client-one&count=10&pnsdk=PubNub-Ruby/4.2.5&uuid=ruby-test-uuid-client-one
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.4.10 (2020-03-31))
+      Accept:
+      - "*/*"
+      Date:
+      - Tue, 18 Aug 2020 21:55:21 GMT
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 18 Aug 2020 21:55:21 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '66'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET, POST, DELETE, OPTIONS
+      Accept-Ranges:
+      - bytes
+      Age:
+      - '0'
+      Server:
+      - Pubnub
+    body:
+      encoding: UTF-8
+      string: '[["wdjzGfMFLREacKDtVrgDgA=="],15965666789169854,15965666789169854]'
+  recorded_at: Tue, 18 Aug 2020 21:55:21 GMT
+recorded_with: VCR 6.0.0

data/lib/pubnub/client/paged_history.rb

@@ -12,7 +12,7 @@ module Pubnub
         sync = options[:http_sync]
         start_tt = options.fetch(:start)
         end_tt = options.fetch(:end)
-        if sync
+      if sync
           sync_paged_history(channel, page, limit, callback, start: start_tt, end: end_tt)
         else
           async_paged_history(options)

data/lib/pubnub/event.rb

@@ -149,7 +149,7 @@ module Pubnub
                      group action read write manage ttl presence start
                      end count reverse presence_callback store skip_validate
                      state channel_group channel_groups compressed meta customs include_token
-                     replicate with_presence cipher_key_selector]
+                     replicate with_presence cipher_key_selector include_meta]
 
       options = options.each_with_object({}) { |option, obj| obj[option.first.to_sym] = option.last }
 

data/lib/pubnub/events/history.rb

@@ -21,8 +21,12 @@ module Pubnub
       message['timetoken'] if @include_token
     end
 
+    def meta(message)
+      message['meta'] if @include_meta
+    end
+
     def message(message)
-      if @include_token
+      if @include_token || @include_meta
         message['message']
       else
         message
@@ -53,16 +57,27 @@ module Pubnub
       params[:count] = @count if @count
       params[:reverse] = 'true' if @reverse
       params[:include_token] = 'true' if @include_token
+      params[:include_meta] = 'true' if @include_meta
       params
     end
 
+    def decrypt_history(message, crypto)
+      if @include_token || @include_meta
+        message['message'] = JSON.parse(crypto.decrypt(message['message']), quirks_mode: true)
+
+        message
+      else
+        JSON.parse(crypto.decrypt(message), quirks_mode: true)
+      end
+    end
+
     def valid_envelope(parsed_response, req_res_objects)
       messages = parsed_response[0]
 
       if (@cipher_key || @app.env[:cipher_key] || @cipher_key_selector || @app.env[:cipher_key_selector]) && messages
         cipher_key = compute_cipher_key(parsed_response)
         crypto = Crypto.new(cipher_key)
-        messages = messages.map { |message| JSON.parse(crypto.decrypt(message), quirks_mode: true) }
+        messages = messages.map { |message| decrypt_history(message, crypto) }
       end
 
       start = parsed_response[1]

data/lib/pubnub/formatter.rb

@@ -1,4 +1,5 @@
 require 'cgi'
+require "addressable/uri"
 
 # Toplevel Pubnub module.
 module Pubnub
@@ -35,8 +36,7 @@ module Pubnub
         if cipher_key
           pc = Pubnub::Crypto.new(cipher_key)
           message = pc.encrypt(message).to_json
-          # rubocop:disable Lint/UriEscapeUnescape
-          message = URI.escape(message) if uri_escape
+          message = Addressable::URI.escape(message) if uri_escape
         else
           message = message.to_json
           message = Formatter.encode(message) if uri_escape

data/lib/pubnub/version.rb

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

data/pubnub.gemspec

@@ -18,11 +18,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.4'
 
+  spec.add_dependency 'addressable', '>= 2.0.0'
   spec.add_dependency 'concurrent-ruby', '~> 1.1.5'
   spec.add_dependency 'concurrent-ruby-edge', '~> 0.5.0'
   spec.add_dependency 'dry-validation', '~> 1.0'
   spec.add_dependency 'httpclient', '~> 2.8', '>= 2.8.3'
   spec.add_dependency 'json', '>= 2.2.0', '< 3'
   spec.add_dependency 'timers', '>= 4.3.0'
-  spec.add_development_dependency 'bundler', '~> 1.7'
 end

data/spec/examples/history_examples_spec.rb

@@ -18,6 +18,91 @@ describe Pubnub::History do
     example.run_with_retry retry: 10
   end
 
+  it "__channel___demo___count__10___start__nil___end__nil___reverse__false___http_sync__true___callback__nil___include_meta__true_" do
+    VCR.use_cassette("examples/history/100", :record => :none) do
+      envelope = @pubnub.history(channel: :rubytest, include_meta: true, http_sync: true)
+      expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+      expect(envelope.error?).to eq false
+
+      expect(envelope.status[:code]).to eq(200)
+      expect(envelope.status[:category]).to eq(:ack)
+      expect(envelope.status[:config]).to eq({:tls => false, :uuid => "ruby-test-uuid-client-one", :auth_key => "ruby-test-auth-client-one", :origin => "ps.pndsn.com"})
+
+      expect(envelope.result[:code]).to eq(200)
+      expect(envelope.result[:operation]).to eq(:history)
+      expect(envelope.result[:data]).to eq({:messages => [{"message" => {"message"=>"text"}, "meta" => {"metaKey"=>"metaValue"}, "timetoken" => 15965666789169854}], :end => 15965666789169854, :start => 15965666789169854})
+    end
+  end
+
+  it "__channel___demo___count__10___start__nil___end__nil___reverse__false___http_sync__true___callback__nil___encrypted__true_" do
+    @pubnub = Pubnub.new(
+      publish_key: "pub-a-mock-key",
+      subscribe_key: "sub-a-mock-key",
+      uuid: "ruby-test-uuid-client-one",
+      auth_key: "ruby-test-auth-client-one",
+      cipher_key: "super-secret-cipher-key",
+    )
+    VCR.use_cassette("examples/history/no_includes__encrypted", :record => :none) do
+      envelope = @pubnub.history(channel: :rubytest, count: 10, http_sync: true)
+      expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+      expect(envelope.error?).to eq false
+
+      expect(envelope.status[:code]).to eq(200)
+      expect(envelope.status[:category]).to eq(:ack)
+      expect(envelope.status[:config]).to eq({:tls => false, :uuid => "ruby-test-uuid-client-one", :auth_key => "ruby-test-auth-client-one", :origin => "ps.pndsn.com"})
+
+      expect(envelope.result[:code]).to eq(200)
+      expect(envelope.result[:operation]).to eq(:history)
+      expect(envelope.result[:data]).to eq({:messages => [100], :end => 15965666789169854, :start => 15965666789169854})
+    end
+  end
+
+  it "__channel___demo___count__10___start__nil___end__nil___reverse__false___http_sync__true___callback__nil___include_meta__true___encrypted__true_" do
+    @pubnub = Pubnub.new(
+      publish_key: "pub-a-mock-key",
+      subscribe_key: "sub-a-mock-key",
+      uuid: "ruby-test-uuid-client-one",
+      auth_key: "ruby-test-auth-client-one",
+      cipher_key: "super-secret-cipher-key",
+    )
+    VCR.use_cassette("examples/history/include_meta__encrypted", :record => :none) do
+      envelope = @pubnub.history(channel: :rubytest, count: 10, include_meta: true, http_sync: true)
+      expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+      expect(envelope.error?).to eq false
+
+      expect(envelope.status[:code]).to eq(200)
+      expect(envelope.status[:category]).to eq(:ack)
+      expect(envelope.status[:config]).to eq({:tls => false, :uuid => "ruby-test-uuid-client-one", :auth_key => "ruby-test-auth-client-one", :origin => "ps.pndsn.com"})
+
+      expect(envelope.result[:code]).to eq(200)
+      expect(envelope.result[:operation]).to eq(:history)
+      expect(envelope.result[:data]).to eq({:messages => [{"message" => 100, "meta" => "", "timetoken" => 15965666789169854}], :end => 15965666789169854, :start => 15965666789169854})
+    end
+  end
+
+  it "__channel___demo___count__10___start__nil___end__nil___reverse__false___http_sync__true___callback__nil___include_token__true___encrypted__true_" do
+    @pubnub = Pubnub.new(
+      publish_key: "pub-a-mock-key",
+      subscribe_key: "sub-a-mock-key",
+      uuid: "ruby-test-uuid-client-one",
+      auth_key: "ruby-test-auth-client-one",
+      cipher_key: "super-secret-cipher-key",
+    )
+    VCR.use_cassette("examples/history/include_token__encrypted", :record => :none) do
+      envelope = @pubnub.history(channel: :rubytest, count: 10, include_token: true, http_sync: true)
+      expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+      expect(envelope.error?).to eq false
+
+      expect(envelope.status[:code]).to eq(200)
+      expect(envelope.status[:category]).to eq(:ack)
+      expect(envelope.status[:config]).to eq({:tls => false, :uuid => "ruby-test-uuid-client-one", :auth_key => "ruby-test-auth-client-one", :origin => "ps.pndsn.com"})
+
+      expect(envelope.result[:code]).to eq(200)
+      expect(envelope.result[:operation]).to eq(:history)
+      expect(envelope.result[:data]).to eq({:messages => [{"message" => 100, "timetoken" => 15965666789169854}], :end => 15965666789169854, :start => 15965666789169854})
+    end
+  end
+
   it "__channel___demo___count__10___start__nil___end__nil___reverse__true___http_sync__true___callback__nil_" do
     VCR.use_cassette("examples/history/53", record: :none) do
       envelope = @pubnub.history(channel: :demo, count: 10, reverse: true, http_sync: true)

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: pubnub
 version: !ruby/object:Gem::Version
-  version: 4.2.5
+  version: 4.2.6
 platform: ruby
 authors:
 - PubNub
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-02 00:00:00.000000000 Z
+date: 2020-08-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -106,20 +120,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.3.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
 description: Ruby anywhere in the world in 250ms with PubNub!
 email:
 - support@pubnub.com
@@ -3759,6 +3759,7 @@ files:
 - fixtures/vcr_cassettes/examples/history/0.yml
 - fixtures/vcr_cassettes/examples/history/1.yml
 - fixtures/vcr_cassettes/examples/history/10.yml
+- fixtures/vcr_cassettes/examples/history/100.yml
 - fixtures/vcr_cassettes/examples/history/11.yml
 - fixtures/vcr_cassettes/examples/history/12.yml
 - fixtures/vcr_cassettes/examples/history/13.yml
@@ -3828,6 +3829,9 @@ files:
 - fixtures/vcr_cassettes/examples/history/71.yml
 - fixtures/vcr_cassettes/examples/history/8.yml
 - fixtures/vcr_cassettes/examples/history/9.yml
+- fixtures/vcr_cassettes/examples/history/include_meta__encrypted.yml
+- fixtures/vcr_cassettes/examples/history/include_token__encrypted.yml
+- fixtures/vcr_cassettes/examples/history/no_includes__encrypted.yml
 - fixtures/vcr_cassettes/examples/leave/0.yml
 - fixtures/vcr_cassettes/examples/leave/1.yml
 - fixtures/vcr_cassettes/examples/leave/10.yml
@@ -10762,7 +10766,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: PubNub Official Ruby gem.