pubnub 4.0.28 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88b73fbc6592b489fa25a48028c0d6b80b4c0b70
-  data.tar.gz: 4e9a790b61303e81badf79e9c02651138029e329
+  metadata.gz: c6bb57cb1493dd96f772d531a71cf21efd28d4c3
+  data.tar.gz: bb6308568e32afea2d41eb3ee5c811048ba5827b
 SHA512:
-  metadata.gz: a43bcb6b9c28dc29523832cf90f03b4da53260a389c871de888958d405d6e1077a8b1c5af3db9103f546e4b4575b0d0037dcf1645283693abac470348705a6a2
-  data.tar.gz: f7fefe6f2e4db1f86652dbac011bc3a47b5ddda8ce132fc72db88a85a02d649403a4d830280ea50be8c05d272793a541c592fe6e7861d631c82f5a8e25793acd
+  metadata.gz: c032947e4382d77011413d0b3836ec421c705ea45c7bb1bfa9a5acee2ec82e29a55d911aa58c205c460d593e04c104d39fa67a2204e19ea12c5c13ba1c783f66
+  data.tar.gz: d13d358cec383eae31e3fda5dfed3297fae8b3fb2bc13e19fb7d40480dfaf29b891dd399250e3f779160b57e206b447e32f98334253cd1c4813ddc3051720e24

data/.pubnub.yml

@@ -1,6 +1,13 @@
 ---
-version: "4.0.28"
+version: "4.1.0"
 changelog:
+  -
+    changes:
+      -
+        text: "Added 'message_count' API endpoint"
+        type: feature
+    date: 28-2-2019
+    version: "4.1.0"
   -
     changes:
       -
@@ -265,6 +272,7 @@ features:
     - STORAGE-START-END
     - STORAGE-COUNT
     - STORAGE-DELETE-MESSAGES
+    - STORAGE-MESSAGE-COUNT
   subscribe: 
     - SUBSCRIBE-CHANNELS
     - SUBSCRIBE-CHANNEL-GROUPS

data/.travis.yml

@@ -17,7 +17,6 @@ rvm:
   - 2.5.1
   - 2.4.4
   - 2.3.7
-  - 2.2.10
 
 matrix:
   include:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pubnub (4.0.28)
+    pubnub (4.1.0)
       concurrent-ruby (~> 1.0.5)
       concurrent-ruby-edge (~> 0.3.1)
       dry-validation (~> 0.10)
@@ -22,7 +22,6 @@ GEM
       simplecov
     coderay (1.1.2)
     concurrent-ruby (1.0.5)
-    concurrent-ruby (1.0.5-java)
     concurrent-ruby-edge (0.3.1)
       concurrent-ruby (= 1.0.5)
     crack (0.4.3)
@@ -35,7 +34,7 @@ GEM
     dry-container (0.6.0)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.6)
+    dry-core (0.4.7)
       concurrent-ruby (~> 1.0)
     dry-equalizer (0.2.1)
     dry-inflector (0.1.2)
@@ -50,7 +49,7 @@ GEM
       dry-equalizer (~> 0.2)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 0.4, >= 0.4.2)
-    dry-validation (0.12.0)
+    dry-validation (0.12.1)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
       dry-core (~> 0.2, >= 0.2.1)
@@ -60,8 +59,6 @@ GEM
     ffi (1.9.25-java)
     hashdiff (0.3.7)
     hitimes (1.3.0)
-    hitimes (1.3.0-java)
-    hitimes (1.3.0-x64-mingw32)
     httpclient (2.8.3)
     interception (0.5)
     jaro_winkler (1.5.1)

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

data/VERSION

@@ -1 +1 @@
-4.0.28
+4.1.0

data/fixtures/vcr_cassettes/examples/message_counts/1.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://balancer1g.bronze.aws-pdx-1.ps.pn/v3/history/sub-key/demo-36/message-counts/a,b,c,d?auth=ruby-test-auth-client-one&pnsdk=PubNub-Ruby/4.1.0&timetoken=12123&uuid=ruby-test-uuid-client-one
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.4.2 (2017-09-14))
+      Accept:
+      - "*/*"
+      Date:
+      - Wed, 27 Feb 2019 20:08:09 GMT
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 27 Feb 2019 20:08:09 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '91'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET, DELETE, OPTIONS
+      Accept-Ranges:
+      - bytes
+      Age:
+      - '0'
+      Server:
+      - Pubnub
+    body:
+      encoding: UTF-8
+      string: '{"status": 200, "error": false, "error_message": "", "channels": {"a":0,"c":0,"b":1,"d":0}}'
+    http_version:
+  recorded_at: Wed, 27 Feb 2019 20:08:10 GMT
+recorded_with: VCR 4.0.0

data/lib/pubnub/client.rb

@@ -47,6 +47,7 @@ require 'pubnub/validators/subscribe'
 require 'pubnub/validators/time'
 require 'pubnub/validators/where_now'
 require 'pubnub/validators/delete'
+require 'pubnub/validators/message_counts'
 
 require 'pubnub/events/audit'
 require 'pubnub/events/channel_registration'
@@ -54,6 +55,7 @@ require 'pubnub/events/grant'
 require 'pubnub/events/heartbeat'
 require 'pubnub/events/here_now'
 require 'pubnub/events/history'
+require 'pubnub/events/message_counts'
 require 'pubnub/events/leave'
 require 'pubnub/events/presence'
 require 'pubnub/events/publish'

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].freeze
+                  revoke time heartbeat where_now set_state state channel_registration message_counts].freeze
 
       EVENTS.each do |event_name|
         define_method event_name do |options = {}, &block|

data/lib/pubnub/constants.rb

@@ -60,12 +60,13 @@ module Pubnub
     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
+    OPERATION_MESSAGE_COUNTS = :message_counts
 
     OPERATIONS = [
       OPERATION_SUBSCRIBE, OPERATION_HEARTBEAT, OPERATION_PRESENCE, OPERATION_TIME, OPERATION_HISTORY,
       OPERATION_HERE_NOW, OPERATION_GLOBAL_HERE_NOW, OPERATION_GET_STATE, OPERATION_LIST_ALL_CHANNEL_GROUPS,
       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_AUDIT, OPERATION_GRANT, OPERATION_REVOKE, OPERATION_WHERE_NOW, OPERATION_MESSAGE_COUNTS
     ].freeze
 
     # Announcements

data/lib/pubnub/events/message_counts.rb

@@ -0,0 +1,90 @@
+# Toplevel Pubnub module.
+module Pubnub
+  # Holds history functionality
+  class MessageCounts < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::MessageCounts
+
+    def initialize(options, app)
+      @event = :message_counts
+      @telemetry_name = :l_mc
+      @timetokens = parse_timetokens options[:channel_timetokens] || []
+      super
+    end
+
+    private
+
+    def current_operation
+      Pubnub::Constants::OPERATION_MESSAGE_COUNTS
+    end
+
+    def response_message(parsed_response)
+      parsed_response[1]
+    rescue StandardError
+      nil
+    end
+
+    def path
+      '/' + [
+        'v3',
+        'history',
+        'sub-key',
+        @subscribe_key,
+        'message-counts',
+        Formatter.channels_for_url(@channel)
+      ].join('/')
+    end
+
+    def parameters(*_args)
+      params = super
+      if @timetokens.length == 1
+        params[:timetoken] = @timetokens.first
+      elsif @timetokens.length > 1
+        params[:channelTimetokens] = @timetokens.join(',')
+      end
+      params
+    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,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+
+          category: Pubnub::Constants::STATUS_ACK,
+          error: false,
+          auto_retried: false,
+
+          data: nil,
+          current_timetoken: nil,
+          last_timetoken: nil,
+          subscribed_channels: nil,
+          subscribed_channel_groups: nil,
+
+          config: get_config
+        },
+        result: {
+          code: req_res_objects[:response].code,
+          operation: Pubnub::Constants::OPERATION_HISTORY,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: parsed_response
+        }
+      )
+    end
+
+    def parse_timetokens(timetokens)
+      timetokens ||= []
+      if timetokens.is_a? String
+        timetokens = timetokens.split(/\s*,\s*/)
+      elsif timetokens.is_a? Integer
+        timetokens = [timetokens]
+      end
+      timetokens.map(&:to_i)
+    end
+  end
+end

data/lib/pubnub/validators/message_counts.rb

@@ -0,0 +1,42 @@
+# Toplevel Pubnub module.
+module Pubnub
+  # Validator module that holds all validators modules
+  module Validator
+    # Validator for History event
+    module MessageCounts
+      include CommonValidator
+
+      def validate!
+        return if @skip_validate
+        
+        validate_channel!
+      end
+
+      private
+
+      def validate_channel!
+        chans = @channels
+        chans = @channels.split(',') if @channels.is_a? String
+        tokens = @timetokens
+
+        if tokens.length.zero?
+          raise(
+            ArgumentError.new(
+              object: self,
+              message: 'channel_timetokens: must contain single or multiple timetokens equaling to number of channels given must be provided.'
+            ),
+            'channel_timetokens: must contain single or multiple timetokens equaling to number of channels given must be provided.'
+          )
+        elsif tokens.length > 1 && tokens.length != chans.length
+          raise(
+            ArgumentError.new(
+              object: self,
+              message: 'Number of channel_timetokens: elements must be 1 or same as number of provided channels.'
+            ),
+            'Number of channel_timetokens: elements must be 1 or same as number of provided channels.'
+          )
+        end
+      end
+    end
+  end
+end

data/lib/pubnub/version.rb

@@ -1,4 +1,4 @@
 # Toplevel Pubnub module.
 module Pubnub
-  VERSION = '4.0.28'.freeze
+  VERSION = '4.1.0'.freeze
 end

data/spec/lib/events/message_counts_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require 'pry'
+
+describe Pubnub::Presence do
+
+  let(:client) {Pubnub.new(subscribe_key: :key)}
+
+  around :each do |example|
+    example.run_with_retry retry: 10
+  end
+
+  it 'client has \'message_counts\' method' do
+    expect(client).to respond_to(:message_counts)
+  end
+
+
+  it 'raises an exception when no channel is provided' do
+    expect{client.message_counts()}.to raise_error(Pubnub::ArgumentError)
+  end
+
+  context 'when number of timetokens is one' do
+    it 'does not raise exception' do
+      expect{client.message_counts(channels: 'a', channel_timetokens: 123123123)}.not_to raise_error
+    end
+  end
+
+  context 'when number of timetokens in greater than one' do
+    it 'raises an exception when number of timetokens and channels mismatches' do
+      params = {
+          channels: ['12', '123'],
+          channel_timetokens: [123123, 123123, 1231231254]
+      }
+
+      expect{client.message_counts(**params)}.to raise_error(Pubnub::ArgumentError)
+    end
+
+    it 'does not raise an exception when number of timetokens and channels is the same' do
+      params = {
+          channels: ['123123', '12312312'],
+          channel_timetokens: [123123, 123123]
+      }
+
+      expect{client.message_counts(**params)}.not_to raise_error
+    end
+  end
+
+  context 'integration test' do
+    it 'returns valid response' do
+      VCR.use_cassette('examples/message_counts/1', record: :none) do
+        pubnub = Pubnub.new(
+            publish_key: 'demo-36',
+            subscribe_key: 'demo-36',
+            uuid: 'ruby-test-uuid-client-one',
+            auth_key: 'ruby-test-auth-client-one',
+            origin: 'balancer1g.bronze.aws-pdx-1.ps.pn'
+            )
+        envelope = pubnub.message_counts(channel:['a,b,c,d'], channel_timetokens: 12123).value
+        res = envelope.result[:data]
+        expect(res.keys).to contain_exactly("channels", "error", "error_message", "status")
+        expect(res["channels"].keys).to contain_exactly("a", "b", "c", "d")
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pubnub
 version: !ruby/object:Gem::Version
-  version: 4.0.28
+  version: 4.1.0
 platform: ruby
 authors:
 - PubNub
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-30 00:00:00.000000000 Z
+date: 2019-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -3863,6 +3863,7 @@ files:
 - fixtures/vcr_cassettes/examples/leave/7.yml
 - fixtures/vcr_cassettes/examples/leave/8.yml
 - fixtures/vcr_cassettes/examples/leave/9.yml
+- fixtures/vcr_cassettes/examples/message_counts/1.yml
 - fixtures/vcr_cassettes/examples/presence/0.yml
 - fixtures/vcr_cassettes/examples/presence/1.yml
 - fixtures/vcr_cassettes/examples/presence/10.yml
@@ -10577,6 +10578,7 @@ files:
 - lib/pubnub/events/here_now.rb
 - lib/pubnub/events/history.rb
 - lib/pubnub/events/leave.rb
+- lib/pubnub/events/message_counts.rb
 - lib/pubnub/events/presence.rb
 - lib/pubnub/events/publish.rb
 - lib/pubnub/events/revoke.rb
@@ -10612,6 +10614,7 @@ files:
 - lib/pubnub/validators/here_now.rb
 - lib/pubnub/validators/history.rb
 - lib/pubnub/validators/leave.rb
+- lib/pubnub/validators/message_counts.rb
 - lib/pubnub/validators/presence.rb
 - lib/pubnub/validators/publish.rb
 - lib/pubnub/validators/revoke.rb
@@ -10652,6 +10655,7 @@ files:
 - spec/lib/events/here_now_spec.rb
 - spec/lib/events/history_spec.rb
 - spec/lib/events/leave_spec.rb
+- spec/lib/events/message_counts_spec.rb
 - spec/lib/events/presence_delta_spec.rb
 - spec/lib/events/presence_spec.rb
 - spec/lib/events/publish_spec.rb
@@ -10725,6 +10729,7 @@ test_files:
 - spec/lib/events/here_now_spec.rb
 - spec/lib/events/history_spec.rb
 - spec/lib/events/leave_spec.rb
+- spec/lib/events/message_counts_spec.rb
 - spec/lib/events/presence_delta_spec.rb
 - spec/lib/events/presence_spec.rb
 - spec/lib/events/publish_spec.rb