pubnub 4.2.5 → 4.5.0

data/.travis.yml

@@ -17,18 +17,22 @@ 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"
+      env: JRUBY_TEST=true NO_COVERAGE=true JRUBY_OPTS="--server -J-Xms2048m -J-Xmx2048m -J-XX:-UseGCOverheadLimit -J-XX:+CMSClassUnloadingEnabled"
       jdk: oraclejdk11
-      script: bundle exec rspec
-
+      script:
+        - jruby -S rspec ./spec/examples/
+        - jruby -S rspec ./spec/lib/

data/CHANGELOG.md

@@ -1,15 +1,38 @@
-##### v4.2.5
+##### v4.5.0
 
-- Updated Subscribe endpoint tests to use an unsorted channels list. 
-- Fixed Message Counts channel timetokens by disabling alphabetic sorting of the channels list. 
+- Add support for APNS2 device/channel management. 
 
-##### v4.2.4
+##### v4.4.0
 
-- 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. 
+- Add simplified Objects API support with UUID and Channel metadata / membership management. 
+- Add uuid and parameter to Grant API along with new Objects permissions: `get`, `update` and `join`. 
 
+##### v4.3.0
+
+- Add `delete` permission for `channel` to Grant. 
+
+##### v4.2.7
+
+- Don't suppress runtime errors. 
+
+##### v4.2.6
+
+- History can now respond with message meta information. 
+- Added official support for Ruby 2.7.X
+- History 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.
+
+##### v4.2.4
+
+- 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.
+
 ##### 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.5.0)
+      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,96 +41,99 @@ 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)
+    ffi (1.13.1-java)
+    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)
+    json (2.3.1)
+    json (2.3.1-java)
+    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 (0.13.1-java)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
       spoon (~> 0.0)
-    pry-rescue (1.5.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)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
     spoon (0.0.6)
       ffi
     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)
@@ -136,11 +141,9 @@ GEM
 PLATFORMS
   java
   ruby
-  x64-mingw32
 
 DEPENDENCIES
   awesome_print
-  bundler (~> 1.7)
   codacy-coverage
   pry
   pry-rescue
@@ -155,4 +158,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/README.md

@@ -1,34 +1,73 @@
+# PubNub Ruby SDK
+
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/b744287bb0324e2883f95525b12cf19f)](https://www.codacy.com/app/blazeroot/ruby?utm_source=github.com&utm_medium=referral&utm_content=pubnub/ruby&utm_campaign=badger)
 [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/b744287bb0324e2883f95525b12cf19f)](https://www.codacy.com/app/blazeroot/ruby?utm_source=github.com&utm_medium=referral&utm_content=pubnub/ruby&utm_campaign=Badge_Coverage)
 [![Build Status](https://travis-ci.org/pubnub/ruby.svg?branch=master)](https://travis-ci.org/pubnub/ruby)
 
-# Please direct all Support Questions and Concerns to Support@PubNub.com
+This is the official PubNub Ruby SDK repository.
+
+PubNub takes care of the infrastructure and APIs needed for the realtime communication layer of your application. Work on your app's logic and let PubNub handle sending and receiving data across the world in less than 100ms.
+
+## Get keys
+
+You will need the publish and subscribe keys to authenticate your app. Get your keys from the [Admin Portal](https://dashboard.pubnub.com/).
+
+## Configure PubNub
+
+1. Integrate PubNub into your project using RubyGems:
+
+    ```bash
+    gem install pubnub
+    ```
 
-# Complete Documentation
-Available at https://www.pubnub.com/docs/ruby/pubnub-ruby-sdk-v4 **v4.x**
+1. Create a new `App.rb` file and add the following code.
 
-## PubNub Gem version 4.2.5
+    ```ruby
+    require 'pubnub'
 
-##### YOU MUST HAVE A PUBNUB ACCOUNT TO USE THE API.
-##### http://www.pubnub.com/account
+    pubnub = Pubnub.new(
+        subscribe_key: :mySubscribeKey,
+        publish_key: :myPublishKey,
+        uuid: :myUniqueUUID
+    )
+    ```
 
-www.pubnub.com - PubNub Real-time Push Service in the Cloud.
+    This is the minimum configuration you need to send and receive messages with PubNub.
 
+## Add event listeners
 
-The PubNub Network is a blazingly fast Global Messaging Service for building real-time web and mobile apps. Thousands of apps and developers rely on PubNub for delivering human-perceptive real-time experiences that scale to millions of users worldwide. PubNub delivers the infrastructure needed to build amazing Mobile, MMO games, social apps, business collaborative solutions, and more.
+```ruby
+callback = Pubnub::SubscribeCallback.new(
+    message: ->(envelope) {
+        puts "MESSAGE: # {puts envelope.result[:data][:message]['msg']}"
+    },
+    presence: ->(envelope) {
+        puts "PRESENCE: #{envelope.result[:data]}"
+    }
+)
+pubnub.add_listener(callback: callback)
+```
 
-### Upgrading from PubNub 3.6.x / 3.7.x
+## Publish and subscribe
 
-Main change is that we're no longer using EventMachine. Right now Celluloid is used. Public API remain unchanged.
-If you encounter any issues while upgrading from EventMachine version, please contact us at support@pubnub.com you can also find eventmachine version in "eventmachine" branch of this repo.
+```ruby
+pubnub.subscribe(
+    channels: ['my_channel'],
+    with_presence: true
+)
 
-### Upgrading from PubNub 3.5.x
+pubnub.publish(
+    channel: 'my_channel',
+    message: { text: 'Hello world' }
+) do |envelope|
+    puts envelope.status
+end
+```
 
-We've made the response format compatible across all operations. This may break existing parsing of where_now, leave, state, and PAM responses. So if you are monitoring these operation responses, please be sure to modify your code accordingly.
+## Documentation
 
-Examples of affected operations can be found [here](3.5_to_3.6_upgrade_notes.md).
+[API reference for Ruby](https://www.pubnub.com/docs/ruby/pubnub-ruby-sdk)
 
-### Upgrading from PubNub 3.3.x and Earlier
-PubNub 3.7.3 is NOT compatible with earlier than 3.4 versions of Pubnub Ruby Client.
+## Support
 
-# Please direct all Support Questions and Concerns to Support@PubNub.com
+If you **need help** or have a **general question**, contact <support@pubnub.com>.

data/VERSION

@@ -1 +1 @@
-4.2.5
+4.5.0

data/fixtures/vcr_cassettes/examples/add_channels_to_push/001.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://ps.pndsn.com/v1/push/sub-key/sub-a-mock-key/devices/815ee724ccb0a6a84dc303be8ccbaa00d1c84dde6bcae6721b08f92100951113?add=demo1,demo2&auth=ruby-test-auth-client-one&pnsdk=PubNub-Ruby/4.4.0&type=apns&uuid=ruby-test-uuid-client-one
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.6.6 (2020-03-31))
+      Accept:
+      - "*/*"
+      Date:
+      - Tue, 17 Nov 2020 14:50:57 GMT
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 17 Nov 2020 14:50:57 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '24'
+      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: '[1, "Modified Channels"]'
+  recorded_at: Tue, 17 Nov 2020 17:46:16 GMT
+recorded_with: VCR 6.0.0

data/fixtures/vcr_cassettes/examples/add_channels_to_push/002.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://ps.pndsn.com/v2/push/sub-key/sub-a-mock-key/devices-apns2/815ee724ccb0a6a84dc303be8ccbaa00d1c84dde6bcae6721b08f92100951113?add=demo1,demo2&auth=ruby-test-auth-client-one&environment=development&pnsdk=PubNub-Ruby/4.4.0&topic=ruby_test&uuid=ruby-test-uuid-client-one
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.6.6 (2020-03-31))
+      Accept:
+      - "*/*"
+      Date:
+      - Tue, 17 Nov 2020 19:01:25 GMT
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 17 Nov 2020 19:01:25 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '24'
+      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: '[1, "Modified Channels"]'
+  recorded_at: Tue, 17 Nov 2020 19:01:25 GMT
+recorded_with: VCR 6.0.0