feat: expose rate limits (#72)

Author: peterdeme

lib/stream-chat/client.rb

@@ -8,6 +8,7 @@
 require 'time'
 require 'stream-chat/channel'
 require 'stream-chat/errors'
+require 'stream-chat/stream_response'
 require 'stream-chat/version'
 require 'stream-chat/util'
 
@@ -514,7 +515,7 @@ def parse_response(response)
       end
       raise StreamAPIException, response if response.status >= 399
 
-      parsed_result
+      StreamResponse.new(parsed_result, response)
     end
 
     def make_http_request(method, relative_url, params: nil, data: nil)

lib/stream-chat/stream_rate_limits.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# lib/stream_rate_limits.rb
+
+module StreamChat
+  class StreamRateLimits
+    attr_reader :limit
+    attr_reader :remaining
+    attr_reader :reset
+
+    def initialize(limit, remaining, reset)
+      @limit = limit.to_i
+      @remaining = remaining.to_i
+      @reset = Time.at(reset.to_i)
+    end
+  end
+end

lib/stream-chat/stream_response.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# lib/stream_response.rb
+require 'stream-chat/stream_rate_limits'
+
+module StreamChat
+  class StreamResponse < Hash
+    attr_reader :rate_limit
+    attr_reader :status_code
+    attr_reader :headers
+
+    def initialize(hash, response)
+      super(nil)
+      merge!(hash)
+
+      if response.headers.key?('X-Ratelimit-Limit')
+        @rate_limit = StreamRateLimits.new(
+          response.headers['X-Ratelimit-Limit'],
+          response.headers['X-Ratelimit-Remaining'],
+          response.headers['X-Ratelimit-Reset']
+        )
+      end
+
+      @status_code = response.status
+      @headers = response.headers
+    end
+  end
+end

spec/client_spec.rb

@@ -43,6 +43,16 @@ def loop_times(times)
     @client.update_users(@random_users)
   end
 
+  it 'properly handles stream response class' do
+    response = @client.get_app_settings
+    expect(response.rate_limit.limit).to be > 0
+    expect(response.rate_limit.remaining).to be > 0
+    expect(response.rate_limit.reset).to be_within(120).of Time.now.utc
+    expect(response.status_code).to be 200
+    expect(response.to_json).not_to include 'rate_limit'
+    expect(response.to_json).not_to include 'status_code'
+  end
+
   it 'mutes users' do
     response = @client.mute_user(@random_users[0][:id], @random_users[1][:id])
     expect(response).to include 'mute'

stream-chat.gemspec

@@ -12,9 +12,9 @@ Gem::Specification.new do |gem|
   gem.summary = 'The low level client for serverside calls for Stream Chat.'
   gem.email = '[email protected]'
   gem.homepage = 'http://github.com/GetStream/stream-chat-ruby'
-  gem.authors = ['Mircea Cosbuc']
+  gem.authors = ['getstream.io']
   gem.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|\.github|scripts)/}) }
   end
   gem.required_ruby_version = '>=2.5.0'
   gem.metadata = {