pubnub 4.0.23 → 4.0.25

data/gemfiles/celluloid_master.gemfile

@@ -0,0 +1,25 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'celluloid', git: 'https://github.com/celluloid/celluloid.git'
+
+# dry-validation depends on dry-types that is not compatible with ruby
+# 2.1.0 from 0.11.0.
+gem 'dry-validation', '>= 0.10', '< 0.11'
+
+group :test do
+  gem 'rubocop'
+  gem 'simplecov', '>= 0.12', require: false
+  gem 'codacy-coverage', require: false
+  gem 'rspec'
+  gem 'rspec-wait'
+  gem 'vcr'
+  gem 'rr'
+  gem 'webmock'
+end
+
+group :development, :test do
+  gem 'pry'
+  gem 'awesome_print'
+end

data/gemfiles/celluloid_master.gemfile.lock

@@ -0,0 +1,155 @@
+GIT
+  remote: https://github.com/celluloid/celluloid.git
+  revision: 727fa67545f663536ab5792fe08db0870b1a15fb
+  specs:
+    celluloid (0.18.0.pre)
+      celluloid-pool (~> 0.20)
+      celluloid-supervision (~> 0.20)
+      timers (~> 4)
+
+PATH
+  remote: ..
+  specs:
+    pubnub (4.0.24)
+      celluloid (~> 0.17)
+      dry-validation (~> 0.10)
+      httpclient (~> 2.8, >= 2.8.3)
+      json (>= 1.8, < 3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.3.0)
+    awesome_print (1.8.0)
+    celluloid-pool (0.20.5)
+      timers (>= 4.1.1)
+    celluloid-supervision (0.20.6)
+      timers (>= 4.1.1)
+    codacy-coverage (1.1.7)
+      simplecov
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.0.5-java)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    dry-configurable (0.7.0)
+      concurrent-ruby (~> 1.0)
+    dry-container (0.6.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.3.3)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.2.0)
+    dry-logic (0.4.1)
+      dry-container (~> 0.2, >= 0.2.6)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-types (0.11.1)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1)
+      dry-container (~> 0.3)
+      dry-core (~> 0.2, >= 0.2.1)
+      dry-equalizer (~> 0.2)
+      dry-logic (~> 0.4, >= 0.4.0)
+      inflecto (~> 0.0.0, >= 0.0.2)
+    dry-validation (0.10.7)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+      dry-core (~> 0.2, >= 0.2.1)
+      dry-equalizer (~> 0.2)
+      dry-logic (~> 0.4, >= 0.4.0)
+      dry-types (~> 0.9, >= 0.9.0)
+    ffi (1.9.18-java)
+    hashdiff (0.3.6)
+    hitimes (1.2.6)
+    hitimes (1.2.6-java)
+    httpclient (2.8.3)
+    inflecto (0.0.2)
+    json (2.1.0)
+    json (2.1.0-java)
+    method_source (0.8.2)
+    parallel (1.12.0)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry (0.10.4-java)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+      spoon (~> 0.0)
+    public_suffix (3.0.0)
+    rainbow (2.2.2)
+      rake
+    rake (12.1.0)
+    rr (1.2.1)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rspec-wait (0.0.9)
+      rspec (>= 3, < 4)
+    rubocop (0.49.1)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    safe_yaml (1.0.4)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    slop (3.6.0)
+    spoon (0.0.6)
+      ffi
+    timers (4.1.2)
+      hitimes
+    unicode-display_width (1.3.0)
+    vcr (3.0.3)
+    webmock (3.0.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bundler (~> 1.7)
+  celluloid!
+  codacy-coverage
+  dry-validation (>= 0.10, < 0.11)
+  pry
+  pubnub!
+  rr
+  rspec
+  rspec-wait
+  rubocop
+  simplecov (>= 0.12)
+  vcr
+  webmock
+
+BUNDLED WITH
+   1.15.4

data/lib/pubnub.rb

@@ -4,6 +4,9 @@ require 'zlib'
 require 'open-uri'
 require 'openssl'
 require 'celluloid/current'
+
+Celluloid.boot
+
 require 'timers'
 require 'httpclient'
 require 'logger'

data/lib/pubnub/client.rb

@@ -20,6 +20,7 @@ require 'pubnub/subscribe_event'
 require 'pubnub/pam'
 require 'pubnub/heart'
 require 'pubnub/subscriber'
+require 'pubnub/telemetry'
 
 require 'pubnub/envelope'
 require 'pubnub/error_envelope'
@@ -46,6 +47,7 @@ require 'pubnub/validators/state'
 require 'pubnub/validators/subscribe'
 require 'pubnub/validators/time'
 require 'pubnub/validators/where_now'
+require 'pubnub/validators/delete'
 
 require 'pubnub/events/audit'
 require 'pubnub/events/channel_registration'
@@ -62,6 +64,7 @@ require 'pubnub/events/state'
 require 'pubnub/events/subscribe'
 require 'pubnub/events/time'
 require 'pubnub/events/where_now'
+require 'pubnub/events/delete_messages'
 
 # Toplevel Pubnub module.
 module Pubnub
@@ -73,7 +76,7 @@ module Pubnub
     include Helpers
     include GettersSetters
 
-    attr_reader :env, :subscriber, :heart
+    attr_reader :env, :subscriber, :telemetry
 
     VERSION = Pubnub::VERSION
 
@@ -160,6 +163,7 @@ module Pubnub
       clean_env
       prepare_env
       validate! @env
+      @telemetry = Telemetry.new
       Pubnub.logger.debug('Pubnub::Client') do
         "Created new Pubnub::Client instance. Version: #{Pubnub::VERSION}"
       end
@@ -298,6 +302,14 @@ module Pubnub
       (::Time.now.to_f * 10_000_000).to_i
     end
 
+    def record_telemetry(telemetry_type, time_start, time_end)
+      @telemetry.record_request(telemetry_type, time_start, time_end)
+    end
+
+    def telemetry_for(event)
+      @telemetry.fetch_average(event)
+    end
+
     private
 
     def create_state_pools(event)

data/lib/pubnub/client/events.rb

@@ -4,7 +4,7 @@ module Pubnub
   class Client
     # Module that holds generator for all events
     module Events
-      EVENTS = %w(publish subscribe presence leave history here_now audit grant
+      EVENTS = %w(publish subscribe presence leave history here_now audit grant delete_messages
                   revoke time heartbeat where_now set_state state channel_registration)
 
       EVENTS.each do |event_name|

data/lib/pubnub/constants.rb

@@ -57,6 +57,7 @@ module Pubnub
     OPERATION_AUDIT                              = :audit
     OPERATION_GRANT                              = :grant
     OPERATION_REVOKE                             = :revoke
+    OPERATION_DELETE                             = :delete
     OPERATION_LIST_ALL_CHANNEL_GROUPS            = :list_all_channel_groups
     OPERATION_LIST_ALL_CHANNELS_IN_CHANNEL_GROUP = :list_all_channels_in_channel_group
 

data/lib/pubnub/event.rb

@@ -49,23 +49,38 @@ module Pubnub
       sender = request_dispatcher
       Pubnub.logger.debug('Pubnub::Event') { '#send_request got sender' }
 
-      if compressed_body.empty?
-        sender.get(uri.to_s)
+      telemetry_time_start = ::Time.now.to_f
+      if @event == Pubnub::Constants::OPERATION_DELETE
+        response = sender.delete(uri.to_s)
+      elsif compressed_body.empty?
+        response = sender.get(uri.to_s)
       else
-        sender.post(uri.to_s, body: compressed_body)
+        response = sender.post(uri.to_s, body: compressed_body)
       end
+
+      @app.record_telemetry(@telemetry_name, telemetry_time_start, ::Time.now.to_f)
+
+      return response
+
     rescue => error
       error
     end
 
-    def uri
+    def uri(memo = true)
+      unless self.is_a? SubscribeEvent
+        return @uri = uri(false) if memo
+        return @uri if @uri
+      end
+
       sa_signature = super_admin_signature unless parameters.include?(:signature)
+      telemetry = @app.telemetry_for(@telemetry_name)
 
       uri = @ssl ? 'https://' : 'http://'
       uri += @origin
       uri += path
       uri += '?' + Formatter.params_hash_to_url_params(parameters)
       uri += "&signature=#{sa_signature}" if sa_signature
+      uri += "&#{@telemetry_name}=#{telemetry.round(3)}" if telemetry
       Pubnub.logger.debug('Pubnub::Event') { "Requested URI: #{uri}" }
       URI uri
     end
@@ -174,7 +189,7 @@ module Pubnub
       when JSON::ParserError
         error_category = Pubnub::Constants::STATUS_NON_JSON_RESPONSE
         code = req_res_objects[:response].code
-      when HTTPClient::ReceiveTimeoutError
+      when HTTPClient::TimeoutError
         error_category = Pubnub::Constants::STATUS_TIMEOUT
         code = 408
       when OpenSSL::SSL::SSLError

data/lib/pubnub/event/formatter.rb

@@ -5,9 +5,7 @@ module Pubnub
     # Module that holds formatters for events
     module EFormatter
       def format_envelopes(response, request)
-        if response.is_a? HTTPClient::ReceiveTimeoutError
-          return error_envelope(nil, response, request: request, response: response)
-        elsif response.is_a? OpenSSL::SSL::SSLError
+        if response.kind_of?(HTTPClient::TimeoutError) || response.is_a?(OpenSSL::SSL::SSLError)
           return error_envelope(nil, response, request: request, response: response)
         else
           parsed_response, error = Formatter.parse_json(response.body)

data/lib/pubnub/events/channel_registration.rb

@@ -7,6 +7,7 @@ module Pubnub
 
     def initialize(options, app)
       @event = :channel_registration
+      @telemetry_name = :l_cg
       super
       @action = @action.to_sym unless @action.nil?
     end

data/lib/pubnub/events/delete_messages.rb

@@ -0,0 +1,63 @@
+# Toplevel Pubnub module.
+module Pubnub
+  # Holds delete functionality
+  class DeleteMessages < SingleEvent
+    include Celluloid
+    include Pubnub::Validator::Delete
+
+    def initialize(options, app)
+      @event = :delete
+      @telemetry_name = :l_hist
+      super
+    end
+
+    private
+
+    def current_operation
+      Pubnub::Constants::OPERATION_DELETE
+    end
+
+    def parameters(signature = false)
+      {
+        start: @start,
+        end: @end
+      }.select { |_, value| !value.blank? }.merge(super(signature))
+    end
+
+    def path
+      '/' + [
+          'v3',
+          'history',
+          'sub-key',
+          @subscribe_key,
+          'channel',
+          @channel
+      ].join('/')
+    end
+
+    def valid_envelope(parsed_response, req_res_objects)
+      Pubnub::Envelope.new(
+        event: @event,
+        event_options: @given_options,
+        timetoken: nil,
+        status: {
+          code: req_res_objects[:response].code,
+          operation: Pubnub::Constants::OPERATION_DELETE,
+          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

data/lib/pubnub/events/heartbeat.rb

@@ -7,6 +7,7 @@ module Pubnub
     include Pubnub::Formatter
 
     def initialize(options, app)
+      @telemetry_name = :l_pres
       @event = :heartbeat
       super
     end

data/lib/pubnub/events/here_now.rb

@@ -7,6 +7,7 @@ module Pubnub
 
     def initialize(options, app)
       @event = :here_now
+      @telemetry_name = :l_pres
       super
     end
 

data/lib/pubnub/events/history.rb

@@ -7,6 +7,7 @@ module Pubnub
 
     def initialize(options, app)
       @event = :history
+      @telemetry_name = :l_hist
       super
     end
 

data/lib/pubnub/events/leave.rb

@@ -7,6 +7,7 @@ module Pubnub
 
     def initialize(options, app)
       @event = :leave
+      @telemetry_name = :l_pub
       super
     end
 

data/lib/pubnub/events/presence.rb

@@ -8,6 +8,7 @@ module Pubnub
 
     def initialize(options, app)
       @event = :presence
+      @telemetry_name = :l_pres
       super
     end
 

data/lib/pubnub/events/publish.rb

@@ -9,6 +9,7 @@ module Pubnub
 
     def initialize(options, app)
       @event = :publish
+      @telemetry_name = :l_pub
       super
       @sequence_number = sequence_number!
       @origination_time_token = @app.generate_ortt