pubnub 4.4.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f8b275c721b9de530bc31977a8ce13bc80f09ddbdab4b86aa95290e356efb69
-  data.tar.gz: e1a95809c417d251ca1cf4845d1b0afe4a8542aed89e7770955eb6c7f4ded259
+  metadata.gz: f99bc04274ad4c925ccaeb22554add0934aa9579f35ad114c68f5a361927aa7b
+  data.tar.gz: 326e53a9a9d7d6fc3cc3cdf4563dad813c91f98bbfb5268e148fa9d842c60cb7
 SHA512:
-  metadata.gz: 520398c604c98552438102a972bda7a32bb597550bf91fcf2980990dd99d9e655b0b150a098191ad6a39ee0c9fcb893f2967ad551dd317138db78d8bc9586acf
-  data.tar.gz: d39f1d0d61e7c090eb59ad061d9b194e2e94b73e7abf60c72772f4542208c2be081a1a096cc030ecfa75b88e3ee2d2a541416a12d8c21afaf4581ef25c823c4a
+  metadata.gz: '09eb1c5f639e76233894bf7ddac49b6729cc6cb27a457535c7a0c3315da85ade49edd753394ce2ba1539ee6e20500b5530f6f2c7dd3503dad79471c45d613eac'
+  data.tar.gz: e0374ca5a489dc8d89ec8a5cff6f48c5684f6642cf1823df88ce3ca4793c2c8226e807841d7908ee859205eba813e019b9c3f517645145dfc2152d486428604c

data/.pubnub.yml

@@ -1,6 +1,13 @@
 ---
-version: "4.4.0"
+version: "4.5.0"
 changelog:
+  -
+    changes:
+      -
+        text: "Add support for APNS2 device/channel management."
+        type: feature
+    date: 03-12-2020
+    version: v4.5.0
   -
     changes:
       -
@@ -64,7 +71,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.4.0"
+    version: "4.5.0"
   -
     changes:
       -
@@ -372,6 +379,15 @@ features:
     - PUBLISH-SYNC
     - PUBLISH-ASYNC
     - PUBLISH-MESSAGE-TTL
+  push:
+    - PUSH-ADD-DEVICE-TO-CHANNELS
+    - PUSH-REMOVE-DEVICE-FROM-CHANNELS
+    - PUSH-LIST-CHANNELS-FROM-DEVICE
+    - PUSH-REMOVE-DEVICE
+    - PUSH-TYPE-APNS
+    - PUSH-TYPE-APNS2
+    - PUSH-TYPE-FCM
+    - PUSH-TYPE-MPNS
   storage:
     - STORAGE-REVERSE
     - STORAGE-INCLUDE-TIMETOKEN

data/.travis.yml

@@ -31,6 +31,8 @@ jobs:
       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,3 +1,7 @@
+##### v4.5.0
+
+- Add support for APNS2 device/channel management. 
+
 ##### v4.4.0
 
 - Add simplified Objects API support with UUID and Channel metadata / membership management. 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pubnub (4.4.0)
+    pubnub (4.5.0)
       addressable (>= 2.0.0)
       concurrent-ruby (~> 1.1.5)
       concurrent-ruby-edge (~> 0.5.0)
@@ -68,10 +68,12 @@ GEM
       dry-equalizer (~> 0.2)
       dry-initializer (~> 3.0)
       dry-schema (~> 1.5)
+    ffi (1.13.1-java)
     hashdiff (1.0.1)
     httpclient (2.8.3)
     interception (0.5)
     json (2.3.1)
+    json (2.3.1-java)
     method_source (1.0.0)
     parallel (1.19.2)
     parser (2.7.1.4)
@@ -79,6 +81,10 @@ GEM
     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.2)
       interception (>= 0.5)
       pry (>= 0.12.0)
@@ -122,6 +128,8 @@ GEM
       docile (~> 1.1)
       simplecov-html (~> 0.11)
     simplecov-html (0.12.2)
+    spoon (0.0.6)
+      ffi
     timers (4.3.0)
     unicode-display_width (1.7.0)
     vcr (6.0.0)
@@ -131,6 +139,7 @@ GEM
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
+  java
   ruby
 
 DEPENDENCIES

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.4.0
+    ```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.4.0
+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

data/fixtures/vcr_cassettes/examples/add_channels_to_push/003.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=production&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:30:00 GMT
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 17 Nov 2020 19:30:01 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:30:01 GMT
+recorded_with: VCR 6.0.0

data/fixtures/vcr_cassettes/examples/add_channels_to_push/004.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/invalid_token?add=demo1,demo2&auth=ruby-test-auth-client-one&environment=production&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:31:10 GMT
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Date:
+      - Tue, 17 Nov 2020 19:31:10 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '33'
+      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: '{"error": "Invalid device token"}'
+  recorded_at: Tue, 17 Nov 2020 19:31:10 GMT
+recorded_with: VCR 6.0.0

data/fixtures/vcr_cassettes/examples/grant/1946.yml

@@ -2,28 +2,28 @@
 http_interactions:
 - request:
     method: get
-    uri: http://ps.pndsn.com/v2/auth/grant/sub-key/sub-a-mock-key?auth=ruby-authkey&channel-group=demo&m=0&pnsdk=PubNub-Ruby/4.1.0&r=0&signature=ul_R5sIqyldD47tpyxU5sATIZd0H8JL4UulNIyuXJoA=&timestamp=1464188863&ttl=0&uuid=ruby-test-uuid-client-one&w=0
+    uri: http://ps.pndsn.com/v2/auth/grant/sub-key/sub-a-mock-key?auth=demo&d=0&g=1&m=1&pnsdk=PubNub-Ruby/4.4.0&r=1&signature=v2.v9I738j7Zuks-MiomTBSKAYKviUDyUK8FtNPkPp8txQ&target-uuid=bob&timestamp=1605101896&ttl=1440&u=1&uuid=ruby-test-uuid-client-one&w=1
     body:
       encoding: UTF-8
       string: ''
     headers:
       User-Agent:
-      - HTTPClient/1.0 (2.8.0, ruby 2.3.0 (2015-12-25))
+      - HTTPClient/1.0 (2.8.3, ruby 2.6.3 (2019-04-16))
       Accept:
       - "*/*"
       Date:
-      - Wed, 25 May 2016 15:07:43 GMT
+      - Wed, 11 Nov 2020 13:38:16 GMT
   response:
     status:
       code: 200
       message: OK
     headers:
       Date:
-      - Wed, 25 May 2016 15:07:44 GMT
+      - Wed, 11 Nov 2020 13:38:16 GMT
       Content-Type:
       - text/javascript; charset=UTF-8
       Content-Length:
-      - '240'
+      - '239'
       Connection:
       - keep-alive
       Access-Control-Allow-Origin:
@@ -36,8 +36,7 @@ http_interactions:
       - no-cache, no-store, must-revalidate
     body:
       encoding: UTF-8
-      string: '{"message":"Success","payload":{"level":"channel-group+auth","subscribe_key":"sub-a-mock-key","ttl":1,"channel-groups":"demo","auths":{"ruby-authkey":{"r":0,"w":0,"m":0}}},"service":"Access
+      string: '{"message":"Success","payload":{"level":"uuid","subscribe_key":"sub-a-mock-key","ttl":1440,"uuids":{"bob":{"auths":{"demo":{"r":1,"w":1,"m":1,"d":0,"g":1,"u":1,"j":0}}}}},"service":"Access
         Manager","status":200}'
-    http_version: 
-  recorded_at: Wed, 25 May 2016 15:07:44 GMT
-recorded_with: VCR 3.0.1
+  recorded_at: Wed, 11 Nov 2020 13:38:16 GMT
+recorded_with: VCR 6.0.0