pubnub 4.1.2 → 4.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dc7c6dd7f233dd372e76fe0917b38906ec040295
-  data.tar.gz: a4066619d242cc01a496c201c260be44d6500041
+SHA256:
+  metadata.gz: 04517d5210c2213931c074c40ecbeeb804179cf8ce28c4f21350321e560b5560
+  data.tar.gz: 8a8b59f386f3d62e747707762856d517e936f0983a3ee393a39e7b97d515bd5b
 SHA512:
-  metadata.gz: 0538ad194245dc17b4a1e68860f30fa0d773e7ce74bd2b9de1b5d242a04f2612015e43db893e229b42cf98b31f4a297e2b80b24547a1dd419a5b13c4f7684ab3
-  data.tar.gz: c8512b8ebd757605b2037921f2832cd2891eaf9a3d034a2ca82903e5d9d986aa2182594e39eae0e6ec472a46d03bccb6ccb278b677b12711055c2e077dcae22e
+  metadata.gz: f294ccd614f20cc7d2ec694ecc9cf493d65c2460833638ec316d793b628e225d7d36c2827491ce4ca77eaf24d1f2daab6e2ede0bcd082123f9bc0aadbf8a266f
+  data.tar.gz: ffb4e0e6977f9efc895abf1fb20e4235fca9fe78a0ed8d8a3d52e2eac9f4bfe8d4d79f5161994df95592996a8925bb2a9c2d48ec0806f5467eee44eac3c1c0a0

data/.pubnub.yml

@@ -1,6 +1,18 @@
 ---
-version: "4.1.2"
+version: "4.1.6"
 changelog:
+  - changes:
+        - text: "Added signal feature"
+          type: feature
+      date: 21-8-2019
+      version: "4.1.6"
+  -
+    changes:
+      -
+        text: "Updated dependencies"
+        type: improvement
+    date: 29-7-2019
+    version: "4.1.5"
   -
     changes:
       -
@@ -288,6 +300,8 @@ features:
     - SUBSCRIBE-WITH-TIMETOKEN
     - SUBSCRIBE-WILDCARD
     - SUBSCRIBE-FILTER-EXPRESSION
+  signal:
+    - SIGNAL-SEND
   time: 
     - TIME-TIME
 name: ruby
@@ -296,15 +310,13 @@ scm: github.com/pubnub/ruby
 supported-platforms: 
   - 
     editors: 
-      - "ruby 2.4.0"
-      - "ruby 2.3.3"
-      - "ruby 2.2.6"
-      - "ruby 2.1.10"
-      - jruby-9.1.8.0
+      - "ruby 2.6"
+      - "ruby 2.5"
+      - "ruby 2.4"
     platforms: 
-      - "FreeBSD 8-STABLE or later, amd64, 386."
-      - "Linux 2.6 or later, amd64, 386."
-      - "Mac OS X 10.8 or later, amd64"
-      - "Windows 7 or later, amd64, 386, use rubyinstaller and dev pack."
-      - "Apart from the above, PubNub Ruby SDK works on mostly all platforms where the supported Ruby versions work. To use ssl connection, Ruby should be compiled with openssl support."
+      - "FreeBSD 8-STABLE or later, amd64, 386"
+      - "Linux 2.6 or later, amd64, 386"
+      - "macOS 10.8 or later, amd64"
+      - "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"

data/.rubocop.yml

@@ -1,4 +1,5 @@
 AllCops:
+  TargetRubyVersion: 2.4
   Exclude:
     - 'spec/**/*'
     - 'examples/**/*'
@@ -22,4 +23,5 @@ Metrics/PerceivedComplexity:
   Max: 10
 
 Metrics/CyclomaticComplexity:
-  Enabled: false
+  Enabled: false
+

data/.travis.yml

@@ -6,6 +6,7 @@ addons:
 
 before_install:
   # See https://github.com/travis-ci/travis-ci/issues/5861
+  - gem update --system
   - gem install bundler
   - gem update bundler
 
@@ -14,13 +15,13 @@ bundler_args: --without development
 script: bundle exec rspec
 
 rvm:
+  - 2.6.3
   - 2.5.1
   - 2.4.4
-  - 2.3.7
 
 matrix:
   include:
     - rvm: jruby-head
       env: JRUBY_OPTS="--server -J-Xms1500m -J-Xmx1500m -J-XX:+UseConcMarkSweepGC -J-XX:-UseGCOverheadLimit -J-XX:+CMSClassUnloadingEnabled"
-      jdk: oraclejdk8
+      jdk: oraclejdk9
 

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+##### 4.1.6
+* Added signal feature
+
+##### 4.1.5
+* Update dependency dry-validation
+* Includes minimum Ruby version requirement of 2.4+
+
 ##### 4.0.28
 * Added Concurrent-ruby Gem
 * Removed Celluloid

data/Gemfile.lock

@@ -1,131 +1,137 @@
 PATH
   remote: .
   specs:
-    pubnub (4.1.2)
-      concurrent-ruby (~> 1.0.5)
-      concurrent-ruby-edge (~> 0.3.1)
-      dry-validation (~> 0.10)
+    pubnub (4.1.6)
+      concurrent-ruby (~> 1.1.5)
+      concurrent-ruby-edge (~> 0.5.0)
+      dry-validation (~> 1.0)
       httpclient (~> 2.8, >= 2.8.3)
-      json (>= 1.8, < 3)
-      timers (>= 4.1.1)
+      json (>= 2.2.0, < 3)
+      timers (>= 4.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
+    addressable (2.6.0)
       public_suffix (>= 2.0.2, < 4.0)
     ast (2.4.0)
     awesome_print (1.8.0)
     binding_of_caller (0.8.0)
       debug_inspector (>= 0.0.1)
-    codacy-coverage (1.1.8)
+    codacy-coverage (2.1.0)
       simplecov
     coderay (1.1.2)
-    concurrent-ruby (1.0.5)
-    concurrent-ruby-edge (0.3.1)
-      concurrent-ruby (= 1.0.5)
+    concurrent-ruby (1.1.5)
+    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)
-    docile (1.3.1)
-    dry-configurable (0.7.0)
+    docile (1.3.2)
+    dry-configurable (0.8.3)
       concurrent-ruby (~> 1.0)
-    dry-container (0.6.0)
+      dry-core (~> 0.4, >= 0.4.7)
+    dry-container (0.7.2)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.7)
+    dry-core (0.4.8)
       concurrent-ruby (~> 1.0)
-    dry-equalizer (0.2.1)
+    dry-equalizer (0.2.2)
     dry-inflector (0.1.2)
-    dry-logic (0.4.2)
-      dry-container (~> 0.2, >= 0.2.6)
+    dry-initializer (3.0.1)
+    dry-logic (1.0.2)
+      concurrent-ruby (~> 1.0)
       dry-core (~> 0.2)
       dry-equalizer (~> 0.2)
-    dry-types (0.13.2)
+    dry-schema (1.3.1)
+      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.0)
+    dry-types (1.1.0)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.3)
       dry-core (~> 0.4, >= 0.4.4)
-      dry-equalizer (~> 0.2)
+      dry-equalizer (~> 0.2, >= 0.2.2)
       dry-inflector (~> 0.1, >= 0.1.2)
-      dry-logic (~> 0.4, >= 0.4.2)
-    dry-validation (0.12.1)
+      dry-logic (~> 1.0, >= 1.0.2)
+    dry-validation (1.2.1)
       concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1, >= 0.1.3)
-      dry-core (~> 0.2, >= 0.2.1)
+      dry-container (~> 0.7, >= 0.7.1)
+      dry-core (~> 0.4)
       dry-equalizer (~> 0.2)
-      dry-logic (~> 0.4, >= 0.4.0)
-      dry-types (~> 0.13.1)
-    ffi (1.9.25-java)
-    hashdiff (0.3.7)
-    hitimes (1.3.0)
+      dry-initializer (~> 3.0)
+      dry-schema (~> 1.0, >= 1.3.1)
+    ffi (1.11.1-java)
+    hashdiff (1.0.0)
     httpclient (2.8.3)
     interception (0.5)
-    jaro_winkler (1.5.1)
-    jaro_winkler (1.5.1-java)
-    json (2.1.0)
-    json (2.1.0-java)
-    method_source (0.9.0)
-    parallel (1.12.1)
-    parser (2.5.1.0)
+    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)
-    powerpack (0.1.2)
-    pry (0.11.3)
+    pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    pry (0.11.3-java)
+    pry (0.12.2-java)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
       spoon (~> 0.0)
-    pry-rescue (1.4.5)
+    pry-rescue (1.5.0)
       interception (>= 0.5)
-      pry
-    pry-stack_explorer (0.4.9.2)
+      pry (>= 0.12.0)
+    pry-stack_explorer (0.4.9.3)
       binding_of_caller (>= 0.7)
       pry (>= 0.9.11)
-    public_suffix (3.0.2)
+    public_suffix (3.1.1)
     rainbow (3.0.0)
     rr (1.2.1)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
+      rspec-support (~> 3.8.0)
     rspec-retry (0.6.1)
       rspec-core (> 3.3)
-    rspec-support (3.7.1)
-    rubocop (0.57.2)
+    rspec-support (3.8.2)
+    rubocop (0.73.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5)
-      powerpack (~> 0.1)
+      parser (>= 2.6)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
-    safe_yaml (1.0.4)
-    simplecov (0.16.1)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
+    simplecov (0.17.0)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
     spoon (0.0.6)
       ffi
-    timers (4.1.2)
-      hitimes
-    unicode-display_width (1.4.0)
-    vcr (4.0.0)
-    webmock (3.4.2)
+    timers (4.3.0)
+    unicode-display_width (1.6.0)
+    vcr (5.0.0)
+    webmock (3.6.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   java
@@ -149,4 +155,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.16.2
+   1.17.2

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

data/VERSION

@@ -1,2 +1 @@
-4.1.2
-
+4.1.6

data/fixtures/vcr_cassettes/lib/events/signal-error.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://ps.pndsn.com/signal/demo/demo/0/demo/0/%2200000000000000000000000000000000000000000000000000%22?auth=ruby-test-auth&ortt=%7B%22t%22:15663104632819572%7D&pnsdk=PubNub-Ruby/4.1.5&seqn=1&uuid=ruby-test-uuid
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.4.6 (2019-04-01))
+      Accept:
+      - "*/*"
+      Date:
+      - Tue, 20 Aug 2019 14:14:23 GMT
+  response:
+    status:
+      code: 400
+      message: INVALID
+    headers:
+      Date:
+      - Tue, 20 Aug 2019 14:14:25 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '47'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET
+    body:
+      encoding: UTF-8
+      string: '[0,"Signal size too large","15663104658224536"]'
+    http_version: 
+  recorded_at: Tue, 20 Aug 2019 14:14:23 GMT
+recorded_with: VCR 5.0.0

data/fixtures/vcr_cassettes/lib/events/signal.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://ps.pndsn.com/signal/demo/demo/0/demo/0/%22whatever%22?auth=ruby-test-auth&ortt=%7B%22t%22:15663104631310930%7D&pnsdk=PubNub-Ruby/4.1.5&seqn=1&uuid=ruby-test-uuid
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.4.6 (2019-04-01))
+      Accept:
+      - "*/*"
+      Date:
+      - Tue, 20 Aug 2019 14:14:23 GMT
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 20 Aug 2019 14:14:25 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '30'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET
+    body:
+      encoding: UTF-8
+      string: '[1,"Sent","15663104657143915"]'
+    http_version: 
+  recorded_at: Tue, 20 Aug 2019 14:14:23 GMT
+recorded_with: VCR 5.0.0

data/lib/pubnub/client/events.rb

@@ -5,7 +5,7 @@ module Pubnub
     # Module that holds generator for all events
     module Events
       EVENTS = %w[publish subscribe presence leave history here_now audit grant delete_messages
-                  revoke time heartbeat where_now set_state state channel_registration message_counts
+                  revoke time heartbeat where_now set_state state channel_registration message_counts signal
                   add_channels_to_push list_push_provisions remove_channels_from_push remove_device_from_push].freeze
 
       EVENTS.each do |event_name|

data/lib/pubnub/client.rb

@@ -49,6 +49,7 @@ require 'pubnub/validators/where_now'
 require 'pubnub/validators/delete'
 require 'pubnub/validators/message_counts'
 require 'pubnub/validators/push'
+require 'pubnub/validators/signal'
 
 Dir[File.join(File.dirname(__dir__), 'pubnub', 'events', '*.rb')].each do |file|
   require file

data/lib/pubnub/constants.rb

@@ -65,6 +65,7 @@ module Pubnub
     OPERATION_LIST_PUSH_PROVISIONS = :list_push_provisions
     OPERATION_REMOVE_CHANNELS_FROM_PUSH = :remove_channels_from_push
     OPERATION_REMOVE_DEVICE_FROM_PUSH = :remove_device_from_push
+    OPERATION_SIGNAL = :signal
 
     OPERATIONS = [
       OPERATION_SUBSCRIBE, OPERATION_HEARTBEAT, OPERATION_PRESENCE, OPERATION_TIME, OPERATION_HISTORY,
@@ -72,7 +73,7 @@ module Pubnub
       OPERATION_LIST_ALL_CHANNELS_IN_CHANNEL_GROUP, OPERATION_CHANNEL_GROUP_ADD, OPERATION_CHANNEL_GROUP_REMOVE,
       OPERATION_AUDIT, OPERATION_GRANT, OPERATION_REVOKE, OPERATION_WHERE_NOW, OPERATION_MESSAGE_COUNTS,
       OPERATION_ADD_CHANNELS_TO_PUSH, OPERATION_LIST_PUSH_PROVISIONS, OPERATION_REMOVE_CHANNELS_FROM_PUSH,
-      OPERATION_REMOVE_DEVICE_FROM_PUSH
+      OPERATION_REMOVE_DEVICE_FROM_PUSH, OPERATION_SIGNAL
     ].freeze
 
     # Announcements

data/lib/pubnub/events/add_channels_to_push.rb

@@ -6,9 +6,10 @@ module Pubnub
     include Pubnub::Validator::Push
 
     def initialize(options, app)
-      @event = current_operation
-      @params = options
       super
+      @event = current_operation
+      @auth_key = options[:auth_key]
+      @params = @given_options
     end
 
     private

data/lib/pubnub/events/list_push_provisions.rb

@@ -6,9 +6,9 @@ module Pubnub
     include Pubnub::Validator::Push
 
     def initialize(options, app)
-      @event = current_operation
-      @params = options
       super
+      @event = current_operation
+      @params = @given_options
     end
 
     private

data/lib/pubnub/events/remove_channels_from_push.rb

@@ -6,9 +6,10 @@ module Pubnub
     include Pubnub::Validator::Push
 
     def initialize(options, app)
-      @event = current_operation
-      @params = options
       super
+      @event = current_operation
+      @params = @given_options
+      @auth_key = options[:auth_key]
     end
 
     private

data/lib/pubnub/events/remove_device_from_push.rb

@@ -6,9 +6,9 @@ module Pubnub
     include Pubnub::Validator::Push
 
     def initialize(options, app)
-      @event = current_operation
-      @params = options
       super
+      @event = current_operation
+      @params = @given_options
     end
 
     private

data/lib/pubnub/events/signal.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+# Toplevel Pubnub module.
+module Pubnub
+  # Holds history functionality
+  class Signal < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::Signal
+
+    attr_reader :store
+
+    def initialize(options, app)
+      @event = :signal
+      @telemetry_name = :l_sig
+      super
+      @sequence_number = sequence_number!
+      @origination_time_token = @app.generate_ortt
+    end
+
+    private
+
+    def current_operation
+      Pubnub::Constants::OPERATION_SIGNAL
+    end
+
+    def parameters(*_args)
+      params = super
+
+      params = params.merge(seqn: @sequence_number,
+                            ortt: { t: @origination_time_token })
+      params
+    end
+
+    def path
+      '/' + [
+        'signal',
+        @publish_key,
+        @subscribe_key,
+        '0',
+        Formatter.format_channel(@channel, true),
+        '0',
+        Formatter.format_message(@message, @cipher_key)
+      ].join('/')
+    end
+
+    def sequence_number!
+      @app.sequence_number_for_publish!
+    end
+
+    def timetoken(parsed_response)
+      parsed_response[2]
+    rescue StandardError
+      nil
+    end
+
+    def response_message(parsed_response)
+      parsed_response[1]
+    rescue StandardError
+      nil
+    end
+
+    def valid_envelope(parsed_response, req_res_objects)
+      Pubnub::Envelope.new(
+        event: @event,
+        event_options: @given_options,
+        timetoken: timetoken(parsed_response),
+        status: {
+          code: req_res_objects[:response].code,
+          operation: Pubnub::Constants::OPERATION_SIGNAL,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: nil,
+          category: Pubnub::Constants::STATUS_ACK,
+          error: false,
+          auto_retried: false,
+
+          current_timetoken: nil,
+          last_timetoken: nil,
+          subscribed_channels: nil,
+          subscribed_channel_groups: nil,
+
+          config: get_config
+        }
+      )
+    end
+  end
+end