pubnub 4.6.2 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cdeb3e7194c3ec7799eef208411d9278556e36a1eb75ea736b7891aebc537d3
-  data.tar.gz: 06347ae57e8a41fac5870cc3406e64acd846350d5dd4e5156e6e01d592d62320
+  metadata.gz: 94a5346f9874553c5abf72a14cd22f76fe14d268c81ac97e8c88c8489fba2bf4
+  data.tar.gz: 9c6517348ed1e98f0434105afadacbb3b1d381437edb996366d977ec9749ba53
 SHA512:
-  metadata.gz: 9b1bb676791d2be910ac576917456041e7ba6b188f4585900d42a6b05ecc8a07a8e965615ea94fac0325bebfc87508b89f70df9c3c72e5e97356340220ccb0e3
-  data.tar.gz: 63418083e5e96c00d36183ebec6be0d6c7d6d326bea0b80bc90dd203171f2820d49793f0d79cdc2888c96841b472d9765b3d69c83f8b8579b5cba9ba0fc3db28
+  metadata.gz: d16f505c9f0bddfb93e794abefe02f7e4c23e23158e755c97a942b27fae298d8c244d1e6cc1bae6d9ef439f5cc631354a50d401f419da2a0d3ce523474ccc737
+  data.tar.gz: cdab28581565cadc69597cc737b4fe616296e43f5c686a58543312d37fec6f8b4dd377d3fc26406a404e6791a4ba731bfe25cc8a5f899b1c5e054759286fcd4d

data/.github/CODEOWNERS

@@ -1 +1,3 @@
-*       @parfeon @CraigLn
+*         @parfeon @CraigLn @bartk @kleewho
+.github/* @parfeon @CraigLn @bartk @kleewho
+README.md @techwritermat @kazydek

data/.github/workflows/commands-handler.yml

@@ -0,0 +1,27 @@
+name: Commands processor
+
+on:
+  issue_comment:
+    types: [created]
+
+jobs:
+  process:
+    name: Process command
+    if: ${{ github.event.issue.pull_request && endsWith(github.repository, '-private') != true && startsWith(github.event.comment.body, '@client-engineering-bot ') }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+      - name: Checkout release actions
+        uses: actions/checkout@v2
+        with:
+          repository: pubnub/client-engineering-deployment-tools
+          ref: v1
+          token: ${{ secrets.GH_TOKEN }}
+          path: .github/.release/actions
+      - name: Process changelog entries
+        uses: ./.github/.release/actions/actions/commands
+        with:
+          token: ${{ secrets.GH_TOKEN }}
+          listener: client-engineering-bot
+          jira-api-key: ${{ secrets.JIRA_API_KEY }}

data/.github/workflows/release/versions.json

@@ -0,0 +1,17 @@
+{
+  ".pubnub.yml": [
+    { "pattern": "^version: \"(.+)\"$", "cleared": true },
+    { "pattern": "\\s+package-name: pubnub-(v?(\\d+\\.?){2,}([a-zA-Z0-9-]+(\\.?\\d+)?)?).gem$", "cleared": true },
+    { "pattern": "/releases/download/(v?(\\d+\\.?){2,}([a-zA-Z0-9-]+(\\.?\\d+)?)?)/pubnub-.*.gem$", "cleared": false },
+    { "pattern": "/releases/download/.*/pubnub-(v?(\\d+\\.?){2,}([a-zA-Z0-9-]+(\\.?\\d+)?)?).gem$", "cleared": true }
+  ],
+  "VERSION": [
+    { "pattern": "(v?(\\d+\\.?){2,}([a-zA-Z0-9-]+(\\.?\\d+)?)?)", "cleared": true }
+  ],
+  "Gemfile.lock": [
+    { "pattern": "^\\s{2,}pubnub \\((v?(\\d+\\.?){2,}([a-zA-Z0-9-]+(\\.?\\d+)?)?)\\)$", "cleared": true }
+  ],
+  "lib/pubnub/version.rb": [
+    { "pattern": "^\\s{2,}VERSION = '(v?(\\d+\\.?){2,}([a-zA-Z0-9-]+(\\.?\\d+)?)?)'.freeze", "cleared": true }
+  ]
+}

data/.github/workflows/release.yml

@@ -0,0 +1,58 @@
+name: Automated product release
+
+on:
+  pull_request:
+    branches: [ master ]
+    types: [ closed ]
+
+
+jobs:
+  check-release:
+    name: Check release required
+    runs-on: ubuntu-latest
+    if: ${{ github.event.pull_request.merged && endsWith(github.repository, '-private') != true }}
+    outputs:
+      release: ${{ steps.check.outputs.ready }}
+    steps:
+      - name: Checkout actions
+        uses: actions/checkout@v2
+        with:
+          repository: pubnub/client-engineering-deployment-tools
+          ref: v1
+          token: ${{ secrets.GH_TOKEN }}
+          path: .github/.release/actions
+      - id: check
+        name: Check pre-release completed
+        uses: ./.github/.release/actions/actions/checks/release
+        with:
+          token: ${{ secrets.GH_TOKEN }}
+  publish:
+    name: Publish package
+    runs-on: ubuntu-latest
+    needs: check-release
+    if: ${{ needs.check-release.outputs.release == 'true' }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        with:
+          # This should be the same as the one specified for on.pull_request.branches
+          ref: master
+      - name: Checkout actions
+        uses: actions/checkout@v2
+        with:
+          repository: pubnub/client-engineering-deployment-tools
+          ref: v1
+          token: ${{ secrets.GH_TOKEN }}
+          path: .github/.release/actions
+      - name: Publish to RubyGems
+        uses: ./.github/.release/actions/actions/services/rubygems
+        with:
+          token: ${{ secrets.GH_TOKEN }}
+          gem-username: ${{ secrets.GEMS_ACCOUNT }}
+          gem-token: ${{ secrets.GEMS_API_KEY }}
+      - name: Create Release
+        uses: ./.github/.release/actions/actions/services/github-release
+        with:
+          token: ${{ secrets.GH_TOKEN }}
+          jira-api-key: ${{ secrets.JIRA_API_KEY }}
+          last-service: true

data/.github/workflows/run_acceptance_tests.yml

@@ -0,0 +1,46 @@
+name: run_acceptance_tests
+
+on: [push]
+
+jobs:
+  build:
+    name: Perform Acceptance BDD tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout project
+        uses: actions/checkout@v2
+      - name: Checkout mock-server action
+        uses: actions/checkout@v2
+        with:
+          repository: pubnub/client-engineering-deployment-tools
+          ref: github-actions
+          token: ${{ secrets.GH_TOKEN }}
+          path: client-engineering-deployment-tools
+      - name: Run mock server action
+        uses: ./client-engineering-deployment-tools/actions/mock-server
+        with:
+          token: ${{ secrets.GH_TOKEN }}
+      - name: Install dependencies
+        run: |
+          sudo gem install bundler &&
+          bundle install
+      - name: Run acceptance tests (optional)
+        run: bundle exec cucumber sdk-specifications/features/ -p mock -p run_beta -p report_beta -f pretty
+        continue-on-error: true
+      - name: Run acceptance tests (required)
+        run: bundle exec cucumber sdk-specifications/features/ -p mock -p run_main -p report_main -f pretty
+      - name: Combine test results
+        if: always()
+        run: |
+          sudo npm install -g junit-report-merger &&
+          jrm ./main.xml "./main/**/*.xml" &&
+          jrm ./beta.xml "./beta/**/*.xml"
+      - name: Expose main report
+        uses: actions/upload-artifact@v2
+        if: always()
+        with:
+          name: acceptance-test-reports
+          path: |
+            main.xml
+            beta.xml
+          retention-days: 7

data/.gitignore

@@ -8,3 +8,21 @@ log/*
 examples/test.rb
 coverage
 dev_scripts
+
+# GitHub Actions #
+##################
+.github/.release
+.bundle/ruby
+
+.travis/README.md
+.travis/scripts
+
+deployment_keys
+deployment_keys-private
+deployment_keys.tar
+
+.travis/github-labels-policy.json
+.travis/github-labels.json
+/.rvmrc
+/.bundle/
+/features/*.feature

data/.pubnub.yml

@@ -1,6 +1,28 @@
 ---
-version: "4.6.2"
+version: "5.0.0"
 changelog:
+  - date: 2022-01-13
+    version: v5.0.0
+    changes:
+      - type: improvement
+        text: "BREAKING CHANGES: uuid is required parameter to create PubNub instance."
+  - date: 2021-12-16
+    version: v4.8.0
+    changes:
+      - type: feature
+        text: "Add revoke token feature."
+  - date: 2021-11-24
+    version: v4.7.1
+    changes:
+      - type: feature
+        text: "Add new method `all_history_messages` which return messages from requested interval or `since` / `before` date in single object."
+      - type: bug
+        text: "Fix exception raised when optional start / end not passed to `paged_history`."
+  - date: 2021-11-09
+    version: v4.7.0
+    changes:
+      - type: feature
+        text: "Grant_token allows generation of signed token with permissions for channels, channel groups and uuids."
   -
     changes:
       -
@@ -391,6 +413,10 @@ features:
   access:
     - ACCESS-GRANT
     - ACCESS-SECRET-KEY-ALL-ACCESS
+    - ACCESS-GRANT-TOKEN
+    - ACCESS-PARSE-TOKEN
+    - ACCESS-SET-TOKEN
+    - ACCESS-REVOKE-TOKEN
   channel-groups:
     - CHANNEL-GROUPS-ADD-CHANNELS
     - CHANNEL-GROUPS-REMOVE-CHANNELS
@@ -600,7 +626,7 @@ sdks:
                     - x86-64
           - distribution-type: package
             distribution-repository: RubyGems
-            package-name: pubnub-4.6.1.gem
+            package-name: pubnub-5.0.0.gem
             location: https://rubygems.org/gems/pubnub
             requires:
               - name: addressable
@@ -705,8 +731,8 @@ sdks:
                     - 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.2/pubnub-4.6.1.gem
+            package-name: pubnub-5.0.0.gem
+            location: https://github.com/pubnub/ruby/releases/download/v5.0.0/pubnub-5.0.0.gem
             requires:
               - name: addressable
                 min-version: 2.0.0

data/.travis.yml

@@ -16,10 +16,6 @@ stages:
 
 jobs:
   include:
-    - stage: "test"
-      name: 'Ruby 2.4.10'
-      rvm: '2.4.10'
-      script: bundle exec rspec
     - name: 'Ruby 2.5.8'
       rvm: '2.5.8'
       script: bundle exec rspec

data/CHANGELOG.md

@@ -1,13 +1,40 @@
-##### v4.6.2
+## v5.0.0
+January 13 2022
 
-- Add new `sdks` section to `.pubnub.yml` with information about available artifacts and distribution variants. 
-
-##### v4.6.1
-
-- Exclude `spec` and `fixtures` from built gem file. 
-- Fix Ruby SDK repository location under `sdks` section in `.pubnub.yml`. 
-- Add new section to `.pubnub.yml` file with information about SDK and destribution types. 
+#### Modified
+- BREAKING CHANGES: uuid is required parameter to create PubNub instance.
 
+## v4.8.0
+December 16 2021
+
+#### Added
+- Add revoke token feature.
+
+## v4.7.1
+November 24 2021
+
+#### Added
+- Add new method `all_history_messages` which return messages from requested interval or `since` / `before` date in single object.
+
+#### Fixed
+- Fix exception raised when optional start / end not passed to `paged_history`.
+
+## v4.7.0
+November 09 2021
+
+#### Added
+- Grant_token allows generation of signed token with permissions for channels, channel groups and uuids.
+
+##### v4.6.2
+
+- Add new `sdks` section to `.pubnub.yml` with information about available artifacts and distribution variants. 
+
+##### v4.6.1
+
+- Exclude `spec` and `fixtures` from built gem file. 
+- Fix Ruby SDK repository location under `sdks` section in `.pubnub.yml`. 
+- Add new section to `.pubnub.yml` file with information about SDK and destribution types. 
+
 ##### v4.6.0
 
 - BREAKING CHANGE: Add randomized initialization vector usage by default for data encryption / decryption in publish / subscribe / history API calls. 

data/Gemfile

@@ -7,10 +7,12 @@ group :test do
   gem 'rr'
   gem 'rspec'
   gem 'rspec-retry'
+  gem 'rspec-expectations'
   gem 'rubocop'
   gem 'simplecov', '>= 0.12', require: false
   gem 'vcr'
   gem 'webmock'
+  gem 'cucumber'
 end
 
 group :development, :test do

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pubnub (4.6.2)
+    pubnub (5.0.0)
       addressable (>= 2.0.0)
       concurrent-ruby (~> 1.1.5)
       concurrent-ruby-edge (~> 0.5.0)
@@ -19,6 +19,7 @@ GEM
     awesome_print (1.8.0)
     binding_of_caller (0.8.0)
       debug_inspector (>= 0.0.1)
+    builder (3.2.4)
     codacy-coverage (2.2.1)
       simplecov
     coderay (1.1.3)
@@ -27,6 +28,37 @@ GEM
       concurrent-ruby (~> 1.1.5)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
+    cucumber (7.0.0)
+      builder (~> 3.2, >= 3.2.4)
+      cucumber-core (~> 10.0, >= 10.0.1)
+      cucumber-create-meta (~> 6.0, >= 6.0.1)
+      cucumber-cucumber-expressions (~> 12.1, >= 12.1.1)
+      cucumber-gherkin (~> 20.0, >= 20.0.1)
+      cucumber-html-formatter (~> 16.0, >= 16.0.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+      cucumber-wire (~> 6.0, >= 6.0.1)
+      diff-lcs (~> 1.4, >= 1.4.4)
+      mime-types (~> 3.3, >= 3.3.1)
+      multi_test (~> 0.1, >= 0.1.2)
+      sys-uname (~> 1.2, >= 1.2.2)
+    cucumber-core (10.0.1)
+      cucumber-gherkin (~> 20.0, >= 20.0.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+      cucumber-tag-expressions (~> 3.0, >= 3.0.1)
+    cucumber-create-meta (6.0.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+      sys-uname (~> 1.2, >= 1.2.2)
+    cucumber-cucumber-expressions (12.1.3)
+    cucumber-gherkin (20.0.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+    cucumber-html-formatter (16.0.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+    cucumber-messages (17.1.1)
+    cucumber-tag-expressions (3.0.1)
+    cucumber-wire (6.1.1)
+      cucumber-core (~> 10.0, >= 10.0.1)
+      cucumber-cucumber-expressions (~> 12.1, >= 12.1.2)
+      cucumber-messages (~> 17.0, >= 17.0.1)
     debug_inspector (0.0.3)
     diff-lcs (1.4.4)
     docile (1.3.2)
@@ -68,6 +100,7 @@ GEM
       dry-equalizer (~> 0.2)
       dry-initializer (~> 3.0)
       dry-schema (~> 1.5)
+    ffi (1.13.1)
     ffi (1.13.1-java)
     hashdiff (1.0.1)
     httpclient (2.8.3)
@@ -75,6 +108,10 @@ GEM
     json (2.3.1)
     json (2.3.1-java)
     method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0901)
+    multi_test (0.1.2)
     parallel (1.19.2)
     parser (2.7.1.4)
       ast (~> 2.4.1)
@@ -130,6 +167,8 @@ GEM
     simplecov-html (0.12.2)
     spoon (0.0.6)
       ffi
+    sys-uname (1.2.2)
+      ffi (~> 1.1)
     timers (4.3.0)
     unicode-display_width (1.7.0)
     vcr (6.0.0)
@@ -145,12 +184,14 @@ PLATFORMS
 DEPENDENCIES
   awesome_print
   codacy-coverage
+  cucumber
   pry
   pry-rescue
   pry-stack_explorer
   pubnub!
   rr
   rspec
+  rspec-expectations
   rspec-retry
   rubocop
   simplecov (>= 0.12)

data/VERSION

@@ -1 +1 @@
-4.6.2
+5.0.0

data/config/cucumber.yml

@@ -0,0 +1,7 @@
+default: -p mock -p run_main
+run_main: -t "not @skip and not @na=ruby and not @beta"
+report_main: -f junit --out main
+run_beta: -t "not @skip and not @na=ruby and @beta"
+report_beta: -f junit --out beta
+mock: SERVER_MOCK=true PAM_SUB_KEY=subKey PAM_PUB_KEY=pubKey PAM_SEC_KEY=secKey SERVER_HOST=localhost SERVER_PORT=8090
+prod: SERVER_MOCK=false