pubnub 4.6.0 → 4.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb52f9920096246f6eaf19f16979ccfaad00f4358c022120042c9e4e2b511970
-  data.tar.gz: f6fb7348f5e7e1633b972ab705884c089de62907c4b247d16e1a3a2397e7f09d
+  metadata.gz: 63f05feb970510f07c5cbf539c613259829ac85837fdcb242c778deface2f42f
+  data.tar.gz: 4b3eadd3412e0572470db93fa1ab6cd6cd790133762f1cc5bf7cd38505958e75
 SHA512:
-  metadata.gz: 72308ca7b2b82e3d8b2dd13e4afc75b0282b576c2c1e94bcb66add47ce8d4193ec4881a3a7fc0fb36934ff07369f772db5d6bfdbe8e0f57db1ef37253b1fa571
-  data.tar.gz: a954307b0ddcc59c814f982e40f6e3ba311c0c7611fc5f5e7d2a5addd1e65b7a91db37f9ca13c20e30e6333acbc2fbf4d2130840b1343b84cb641df429ef9936
+  metadata.gz: 1d967129cab1778fb5913be924aafa016af945d51e1845af86a7cde0e417f431dd9971997bdf672e803af3b6fae108f12565209100ac6cd4bf8710c71d636a03
+  data.tar.gz: e7a7044d4dba40f12cf49ddfc1fdb784ba18899c9dbe6afc649c5cb5c63a9491747eb7f3eef62982c7d2e4a5bd128d32d9ccc4003f76e685449c0c03329fc77e

data/.github/workflows/validate-pubnub-yml.yml

@@ -0,0 +1,24 @@
+name: validate-pubnub-yml
+
+# Controls when the action will run. Workflow runs when manually triggered using the UI
+# or API.
+on: [push]
+
+jobs:
+  build:
+    name: Validate PubNub yml
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: '12.x'
+      - name: Install dependencies
+        run: |
+          npm install ajv@6.12.6
+          npm install yaml@1.10.0
+          npm install node-fetch@2.6.1
+          npm install chalk@2.4.2
+      - name: Validate
+        run: GITHUB_TOKEN=${{ secrets.GH_TOKEN }} node ./.github/workflows/validate-yml.js

data/.github/workflows/validate-yml.js

@@ -0,0 +1,95 @@
+const YAML = require('yaml')
+const Ajv = require('ajv');
+const fetch = require('node-fetch');
+const fs = require('fs');
+const chalk = require('chalk');
+
+const ghToken = process.env.GITHUB_TOKEN;
+const ghHeaders = {'User-Agent': 'sdk-bot', 'Authorization': 'token ' + ghToken,'Accept': 'application/vnd.github.v3.raw'};
+
+const sdkReposJSONBranch = "develop";
+let sdkReposJSONPath = "http://api.github.com/repos/pubnub/documentation-resources/contents/website-common/tools/build/sdk-repos.json?ref=" + sdkReposJSONBranch;
+startExecution(sdkReposJSONPath);
+
+async function startExecution(sdkReposJSONPath){
+    console.log('JSON:', sdkReposJSONPath);
+    var sdkRepos = await requestGetFromGithub(sdkReposJSONPath);
+    var sdkReposAndFeatureMappingArray = parseReposAndFeatureMapping(sdkRepos);
+    var schemaText = await requestGetFromGithub(sdkReposAndFeatureMappingArray[2]);
+
+    schema = JSON.parse(schemaText);
+    var yaml = fs.readFileSync(".pubnub.yml", 'utf8');
+
+    if(yaml != null){
+        yml = YAML.parse(yaml);
+        var ajv = new Ajv({schemaId: 'id', "verbose":true, "allErrors": true});
+        const validate = ajv.compile(schema);
+        const valid = validate(yml);
+        if (validate.errors!= null) {
+            console.log(chalk.cyan("==================================="));
+            console.log(chalk.red(yml["version"] + " validation errors..."));
+            console.log(chalk.cyan("==================================="));
+            console.log(validate.errors);
+            console.log(chalk.cyan("==================================="));
+            var result = {code:1, repo: yml["version"], msg: "validation errors"};
+            printResult(result);
+            process.exit(1);
+        }
+        else {
+            var result = {code: 0, repo: yml["version"], msg: "validation pass"};
+            printResult(result);
+        }
+    } else {
+        var result = {code:1, repo: "yml null", msg: "validation errors"};
+        printResult(result);
+        process.exit(1);
+    }
+}
+
+function printResult(result){
+    var str = result.repo + ", " + result.msg;
+    if(result.code === 0){
+        console.log(chalk.green(str) + ", Code: " + result.code);
+    } else {
+        console.log(chalk.red(str) + ", Code: " + result.code);
+    }
+}
+
+async function requestGetFromGithub(url){
+    try {
+        const response = await fetch(url, {
+            headers: ghHeaders,
+            method: 'get',
+        });
+        if(response.status == 200){
+            const json = await response.text();
+            return json;
+        } else {
+            console.error(chalk.red("res.status: " + response.status + "\n URL: " + url));
+            return null;
+        }
+
+    } catch (error) {
+        console.error(chalk.red("requestGetFromGithub: " + error + "\n URL: " + url));
+        return null;
+    }
+}
+
+function parseReposAndFeatureMapping(body){
+    if(body != null){
+        var sdkRepos = JSON.parse(body);
+        var locations = sdkRepos["locations"];
+        if(locations!=null){
+            var sdkURLs = locations["sdks"];
+            var featureMappingURL = locations["featureMapping"];
+            var pubnubYAMLSchemaURL = locations["pubnubYAMLSchema"];
+            return [sdkURLs, featureMappingURL, pubnubYAMLSchemaURL];
+        } else {
+            console.log(chalk.red("response locations null"));
+            return null;
+        }
+    } else {
+        console.log(chalk.red("response body null"));
+        return null;
+    }
+}

data/.pubnub.yml

@@ -1,16 +1,19 @@
 ---
-version: "4.6.0"
+version: "4.6.1"
 changelog:
   -
     changes:
       -
-        text: "BREAKING CHANGE: Add randomized initialization vector usage by default for data encryption / decryption in publish / subscribe / history API calls."
-        type: feature
+        text: "Exclude `spec` and `fixtures` from built gem file."
+        type: improvement
       -
-        text: "Fix issue which caused Object request body encryption when `cipher_key` is set."
-        type: bug
-    date: Mar 8, 21
-    version: v4.6.0
+        text: "Fix Ruby SDK repository location under `sdks` section in `.pubnub.yml`."
+        type: improvement
+      -
+        text: "Add new section to `.pubnub.yml` file with information about SDK and destribution types."
+        type: improvement
+    date: 2021-05-19
+    version: v4.6.1
   -
     changes:
       -
@@ -19,7 +22,7 @@ changelog:
       -
         text: "Fix issue which caused Object request body encryption when `cipher_key` is set."
         type: bug
-    date: Mar 8, 21
+    date: 2021-03-08
     version: v4.6.0
   -
     changes:
@@ -28,7 +31,7 @@ changelog:
         type: feature
       -
         text: "Resolved issue with multiple timetokens in message counts endpoint"
-        type: bug        
+        type: bug
     date: 2020-12-03
     version: v4.5.0
   -
@@ -231,42 +234,42 @@ changelog:
       -
         text: "Fixed missing channel group parameter in leave event"
         type: bug
-    date: ~
+    date: 2016-11-23
     version: v4.0.16
   -
     changes:
       -
         text: "Fixed PAM signature when some special characters are present"
         type: bug
-    date: ~
+    date: 2016-11-21
     version: v4.0.15
   -
     changes:
       -
         text: "Added ttl parameter for publish"
         type: improvement
-    date: ~
+    date: 2016-11-04
     version: v4.0.14
   -
     changes:
       -
         text: "Changed init message log level to debug"
         type: improvement
-    date: ~
+    date: 2016-11-04
     version: v4.0.13
   -
     changes:
       -
         text: "Added alert on catchup failure (REQUEST_MESSAGE_COUNT_EXCEEDED)"
         type: improvement
-    date: ~
+    date: 2016-10-31
     version: v4.0.12
   -
     changes:
       -
         text: "Added super admin mode (Enabled when secret key is set on Pubnub::Client init)"
         type: improvement
-    date: ~
+    date: 2016-10-31
     version: v4.0.11
   -
     changes:
@@ -276,7 +279,7 @@ changelog:
       -
         text: "DRYed envelope formatting a bit"
         type: improvement
-    date: ~
+    date: 2016-10-31
     version: v4.0.10
   -
     changes:
@@ -286,7 +289,7 @@ changelog:
       -
         text: "Updated dependecies"
         type: improvement
-    date: ~
+    date: 2016-10-31
     version: v4.0.9
   -
     changes:
@@ -296,14 +299,14 @@ changelog:
       -
         text: "Dropped support for ruby 2.0."
         type: improvement
-    date: ~
+    date: 2016-10-31
     version: v4.0.8
   -
     changes:
       -
         text: "Added message decrypting in history."
         type: improvement
-    date: ~
+    date: 2016-08-23
     version: v4.0.7
   -
     changes:
@@ -316,25 +319,28 @@ changelog:
       -
         text: "added `with_presence` flag for subscribe, default false."
         type: improvement
-    date: ~
+    date: 2016-08-17
     version: v4.0.6
   -
     changes:
       -
         text: "Required CGI."
         type: improvement
+    date: 2016-08-17
     version: v4.0.5
   -
     changes:
       -
-        text: Added
+        text: "Added #subscribe_filter for client"
         type: feature
+    date: 2016-08-17
     version: v4.0.2
   -
     changes:
       -
         text: "Updated dry-validation and EnvelopeSchema."
         type: improvement
+    date: 2016-08-17
     version: v4.0.1
   -
     changes:
@@ -344,30 +350,35 @@ changelog:
       -
         text: Added
         type: improvement
+    date: 2016-08-17
     version: v4.0.0
   -
     changes:
       -
         text: "Restored auth_key and uuid setters. Important notice: they will be removed"
         type: improvement
+    date: 2016-08-17
     version: v3.8.3
   -
     changes:
       -
         text: "Added :include_token parameter to history call."
         type: feature
+    date: 2016-08-17
     version: v3.8.2
   -
     changes:
       -
         text: "Updated celluloid dependency."
         type: improvement
+    date: 2016-08-17
     version: v3.8.1
   -
     changes:
       -
         text: "Release of celluloid version of pubnub gem. It's complete rewrite but public API doesn't change."
         type: improvement
+    date: 2017-08-17
     version: v3.8.0
 features:
   access:
@@ -462,3 +473,324 @@ supported-platforms:
       - "Windows 7 or later, amd64, 386, use rubyinstaller and dev pack"
       - "Apart from the above, the PubNub Ruby SDK works on almost every platform where the supported Ruby versions work. To use an SSL connection, Ruby should be compiled with OpenSSL support."
     version: "PubNub Ruby SDK"
+
+sdks:
+  - full-name: Ruby SDK
+    short-name: Ruby
+    artifacts:
+      - artifact-type: api-client
+        language: Ruby
+        tier: 1
+        tags:
+          - Server
+        source-repository: https://github.com/pubnub/ruby
+        documentation: https://www.pubnub.com/docs/sdks/ruby
+        distributions:
+          - distribution-type: source
+            distribution-repository: GitHub
+            package-name: PubNub Ruby SDK
+            location: https://github.com/pubnub/ruby
+            requires:
+              - name: addressable
+                min-version: 2.0.0
+                max-version: 2.7.0
+                location: https://rubygems.org/gems/addressable
+                license: Apache License 2.0
+                license-url: https://github.com/sporkmonger/addressable/blob/main/LICENSE.txt
+                is-required: Required
+                notes: Will be installed along with SDK
+              - name: concurrent-ruby
+                min-version: 1.1.5
+                max-version: 1.1.6
+                location: https://rubygems.org/gems/concurrent-ruby
+                license: MIT License
+                license-url: https://github.com/ruby-concurrency/concurrent-ruby/blob/master/LICENSE.txt
+                is-required: Required
+                notes: Will be installed along with SDK
+              - name: concurrent-ruby-edge
+                min-version: 0.5.0
+                max-version: 0.5.0
+                location: https://rubygems.org/gems/concurrent-ruby-edge
+                license: MIT License
+                license-url: https://github.com/ruby-concurrency/concurrent-ruby/blob/master/LICENSE.txt
+                is-required: Required
+                notes: Will be installed along with SDK
+              - name: dry-validation
+                min-version: 1.0.0
+                max-version: 1.5.3
+                location: https://rubygems.org/gems/dry-validation
+                license: MIT License
+                license-url: https://github.com/dry-rb/dry-validation/blob/master/LICENSE
+                is-required: Required
+                notes: Will be installed along with SDK
+              - name: httpclient
+                min-version: 2.8.3
+                max-version: 2.8.3
+                location: https://rubygems.org/gems/httpclient
+                license: Ruby License
+                license-url: https://github.com/nahi/httpclient#license
+                is-required: Required
+                notes: Will be installed along with SDK
+              - name: json
+                min-version: 2.2.0
+                max-version: 2.3.1
+                location: https://rubygems.org/gems/json
+                license: Ruby License
+                license-url: https://github.com/flori/json/blob/master/LICENSE
+                is-required: Required
+                notes: Will be installed along with SDK
+              - name: timers
+                min-version: 4.3.0
+                max-version: 4.3.0
+                location: https://rubygems.org/gems/timers
+                license: MIT License
+                license-url: https://github.com/socketry/timers#license
+                is-required: Required
+                notes: Will be installed along with SDK
+            supported-platforms:
+              supported-operating-systems:
+                macOS:
+                  runtime-version:
+                    - Ruby 2.4.x
+                    - Ruby 2.5.x
+                    - Ruby 2.6.x
+                    - Ruby 2.7.x
+                  minimum-os-version:
+                    - OS X 10.10
+                  maximum-os-version:
+                    - macOS 11.2.3
+                  target-architecture:
+                    - arm64
+                    - x86-64
+                Windows:
+                  runtime-version:
+                    - Ruby 2.4.x
+                    - Ruby 2.5.x
+                    - Ruby 2.6.x
+                    - Ruby 2.7.x
+                  minimum-os-version:
+                    - Windows 7 Professional
+                    - Windows 7 Enterprise
+                    - Windows 7 Ultimate
+                  maximum-os-version:
+                    - Windows 10 Pro
+                    - Windows 10 Enterprise
+                  target-architecture:
+                    - x86
+                    - x86-64
+                Linux:
+                  runtime-version:
+                    - Ruby 2.4.x
+                    - Ruby 2.5.x
+                    - Ruby 2.6.x
+                    - Ruby 2.7.x
+                  minimum-os-version:
+                    - Ubuntu 16.04 LTS
+                  maximum-os-version:
+                    - Ubuntu 18.04 LTS
+                  target-architecture:
+                    - x86
+                    - x86-64
+          - distribution-type: package
+            distribution-repository: RubyGems
+            package-name: pubnub-4.6.1.gem
+            location: https://rubygems.org/gems/pubnub
+            requires:
+              - name: addressable
+                min-version: 2.0.0
+                max-version: 2.7.0
+                location: https://rubygems.org/gems/addressable
+                license: Apache License 2.0
+                license-url: https://github.com/sporkmonger/addressable/blob/main/LICENSE.txt
+                is-required: Required
+                notes: Will be installed along with SDK
+              - name: concurrent-ruby
+                min-version: 1.1.5
+                max-version: 1.1.6
+                location: https://rubygems.org/gems/concurrent-ruby
+                license: MIT License
+                license-url: https://github.com/ruby-concurrency/concurrent-ruby/blob/master/LICENSE.txt
+                is-required: Required
+                notes: Will be installed along with SDK
+              - name: concurrent-ruby-edge
+                min-version: 0.5.0
+                max-version: 0.5.0
+                location: https://rubygems.org/gems/concurrent-ruby-edge
+                license: MIT License
+                license-url: https://github.com/ruby-concurrency/concurrent-ruby/blob/master/LICENSE.txt
+                is-required: Required
+                notes: Will be installed along with SDK
+              - name: dry-validation
+                min-version: 1.0.0
+                max-version: 1.5.3
+                location: https://rubygems.org/gems/dry-validation
+                license: MIT License
+                license-url: https://github.com/dry-rb/dry-validation/blob/master/LICENSE
+                is-required: Required
+                notes: Will be installed along with SDK
+              - name: httpclient
+                min-version: 2.8.3
+                max-version: 2.8.3
+                location: https://rubygems.org/gems/httpclient
+                license: Ruby License
+                license-url: https://github.com/nahi/httpclient#license
+                is-required: Required
+                notes: Will be installed along with SDK
+              - name: json
+                min-version: 2.2.0
+                max-version: 2.3.1
+                location: https://rubygems.org/gems/json
+                license: Ruby License
+                license-url: https://github.com/flori/json/blob/master/LICENSE
+                is-required: Required
+                notes: Will be installed along with SDK
+              - name: timers
+                min-version: 4.3.0
+                max-version: 4.3.0
+                location: https://rubygems.org/gems/timers
+                license: MIT License
+                license-url: https://github.com/socketry/timers#license
+                is-required: Required
+                notes: Will be installed along with SDK
+            supported-platforms:
+              supported-operating-systems:
+                macOS:
+                  runtime-version:
+                    - Ruby 2.4.x
+                    - Ruby 2.5.x
+                    - Ruby 2.6.x
+                    - Ruby 2.7.x
+                  minimum-os-version:
+                    - OS X 10.10
+                  maximum-os-version:
+                    - macOS 11.2.3
+                  target-architecture:
+                    - arm64
+                    - x86-64
+                Windows:
+                  runtime-version:
+                    - Ruby 2.4.x
+                    - Ruby 2.5.x
+                    - Ruby 2.6.x
+                    - Ruby 2.7.x
+                  minimum-os-version:
+                    - Windows 7 Professional
+                    - Windows 7 Enterprise
+                    - Windows 7 Ultimate
+                  maximum-os-version:
+                    - Windows 10 Pro
+                    - Windows 10 Enterprise
+                  target-architecture:
+                    - x86
+                    - x86-64
+                Linux:
+                  runtime-version:
+                    - Ruby 2.4.x
+                    - Ruby 2.5.x
+                    - Ruby 2.6.x
+                    - Ruby 2.7.x
+                  minimum-os-version:
+                    - Ubuntu 16.04 LTS
+                  maximum-os-version:
+                    - Ubuntu 18.04 LTS
+                  target-architecture:
+                    - x86
+                    - x86-64
+          - distribution-type: library
+            distribution-repository: GitHub release
+            package-name: pubnub-4.6.1.gem
+            location: https://github.com/pubnub/ruby/releases/download/v4.6.1/pubnub-4.6.1.gem
+            requires:
+              - name: addressable
+                min-version: 2.0.0
+                max-version: 2.7.0
+                location: https://rubygems.org/gems/addressable
+                license: Apache License 2.0
+                license-url: https://github.com/sporkmonger/addressable/blob/main/LICENSE.txt
+                is-required: Required
+              - name: concurrent-ruby
+                min-version: 1.1.5
+                max-version: 1.1.6
+                location: https://rubygems.org/gems/concurrent-ruby
+                license: MIT License
+                license-url: https://github.com/ruby-concurrency/concurrent-ruby/blob/master/LICENSE.txt
+                is-required: Required
+              - name: concurrent-ruby-edge
+                min-version: 0.5.0
+                max-version: 0.5.0
+                location: https://rubygems.org/gems/concurrent-ruby-edge
+                license: MIT License
+                license-url: https://github.com/ruby-concurrency/concurrent-ruby/blob/master/LICENSE.txt
+                is-required: Required
+              - name: dry-validation
+                min-version: 1.0.0
+                max-version: 1.5.3
+                location: https://rubygems.org/gems/dry-validation
+                license: MIT License
+                license-url: https://github.com/dry-rb/dry-validation/blob/master/LICENSE
+                is-required: Required
+              - name: httpclient
+                min-version: 2.8.3
+                max-version: 2.8.3
+                location: https://rubygems.org/gems/httpclient
+                license: Ruby License
+                license-url: https://github.com/nahi/httpclient#license
+                is-required: Required
+              - name: json
+                min-version: 2.2.0
+                max-version: 2.3.1
+                location: https://rubygems.org/gems/json
+                license: Ruby License
+                license-url: https://github.com/flori/json/blob/master/LICENSE
+                is-required: Required
+              - name: timers
+                min-version: 4.3.0
+                max-version: 4.3.0
+                location: https://rubygems.org/gems/timers
+                license: MIT License
+                license-url: https://github.com/socketry/timers#license
+                is-required: Required
+            supported-platforms:
+              supported-operating-systems:
+                macOS:
+                  runtime-version:
+                    - Ruby 2.4.x
+                    - Ruby 2.5.x
+                    - Ruby 2.6.x
+                    - Ruby 2.7.x
+                  minimum-os-version:
+                    - OS X 10.10
+                  maximum-os-version:
+                    - macOS 11.2.3
+                  target-architecture:
+                    - arm64
+                    - x86-64
+                Windows:
+                  runtime-version:
+                    - Ruby 2.4.x
+                    - Ruby 2.5.x
+                    - Ruby 2.6.x
+                    - Ruby 2.7.x
+                  minimum-os-version:
+                    - Windows 7 Professional
+                    - Windows 7 Enterprise
+                    - Windows 7 Ultimate
+                  maximum-os-version:
+                    - Windows 10 Pro
+                    - Windows 10 Enterprise
+                  target-architecture:
+                    - x86
+                    - x86-64
+                Linux:
+                  runtime-version:
+                    - Ruby 2.4.x
+                    - Ruby 2.5.x
+                    - Ruby 2.6.x
+                    - Ruby 2.7.x
+                  minimum-os-version:
+                    - Ubuntu 16.04 LTS
+                  maximum-os-version:
+                    - Ubuntu 18.04 LTS
+                  target-architecture:
+                    - x86
+                    - x86-64