stream-chat-ruby 2.20.0 → 2.21.0

data/lib/stream-chat/errors.rb

@@ -1,25 +1,41 @@
+# typed: strict
 # frozen_string_literal: true
 
-# lib/errors.rb
-
 module StreamChat
   class StreamAPIException < StandardError
+    extend T::Sig
+    T::Configuration.default_checked_level = :never
+    # For now we disable runtime type checks.
+    # We will enable it with a major bump in the future,
+    # but for now, let's just run a static type check.
+
+    sig { returns(Integer) }
     attr_reader :error_code
+
+    sig { returns(String) }
     attr_reader :error_message
 
+    sig { returns(T::Boolean) }
+    attr_reader :json_response
+
+    sig { returns(Faraday::Response) }
+    attr_reader :response
+
+    sig { params(response: Faraday::Response).void }
     def initialize(response)
       super()
       @response = response
       begin
         parsed_response = JSON.parse(response.body)
-        @json_response = true
-        @error_code = parsed_response.fetch('code', 'unknown')
-        @error_message = parsed_response.fetch('message', 'unknown')
+        @json_response = T.let(true, T::Boolean)
+        @error_code = T.let(parsed_response.fetch('code', 'unknown'), Integer)
+        @error_message = T.let(parsed_response.fetch('message', 'unknown'), String)
       rescue JSON::ParserError
         @json_response = false
       end
     end
 
+    sig { returns(String) }
     def message
       if @json_response
         "StreamChat error code #{@error_code}: #{@error_message}"
@@ -28,10 +44,7 @@ module StreamChat
       end
     end
 
-    def json_response?
-      @json_response
-    end
-
+    sig { returns(String) }
     def to_s
       message
     end

data/lib/stream-chat/stream_rate_limits.rb

@@ -1,17 +1,28 @@
+# typed: strict
 # frozen_string_literal: true
 
-# lib/stream_rate_limits.rb
-
 module StreamChat
   class StreamRateLimits
+    extend T::Sig
+    T::Configuration.default_checked_level = :never
+    # For now we disable runtime type checks.
+    # We will enable it with a major bump in the future,
+    # but for now, let's just run a static type check.
+
+    sig { returns(Integer) }
     attr_reader :limit
+
+    sig { returns(Integer) }
     attr_reader :remaining
+
+    sig { returns(Time) }
     attr_reader :reset
 
+    sig { params(limit: String, remaining: String, reset: String).void }
     def initialize(limit, remaining, reset)
-      @limit = limit.to_i
-      @remaining = remaining.to_i
-      @reset = Time.at(reset.to_i)
+      @limit = T.let(limit.to_i, Integer)
+      @remaining = T.let(remaining.to_i, Integer)
+      @reset = T.let(Time.at(reset.to_i), Time)
     end
   end
 end

data/lib/stream-chat/stream_response.rb

@@ -1,28 +1,41 @@
+# typed: true
 # frozen_string_literal: true
 
-# lib/stream_response.rb
 require 'stream-chat/stream_rate_limits'
+require 'stream-chat/types'
 
 module StreamChat
   class StreamResponse < Hash
+    extend T::Sig
+    T::Configuration.default_checked_level = :never
+    # For now we disable runtime type checks.
+    # We will enable it with a major bump in the future,
+    # but for now, let's just run a static type check.
+
+    sig { returns(StreamRateLimits) }
     attr_reader :rate_limit
+
+    sig { returns(Integer) }
     attr_reader :status_code
+
+    sig { returns(StringKeyHash) }
     attr_reader :headers
 
+    sig { params(hash: T::Hash[T.untyped, T.untyped], response: Faraday::Response).void }
     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']
-        )
+        @rate_limit = T.let(StreamRateLimits.new(
+                              T.must(response.headers['X-Ratelimit-Limit']),
+                              T.must(response.headers['X-Ratelimit-Remaining']),
+                              T.must(response.headers['X-Ratelimit-Reset'])
+                            ), StreamRateLimits)
       end
 
-      @status_code = response.status
-      @headers = response.headers
+      @status_code = T.let(response.status, Integer)
+      @headers = T.let(response.headers, StringKeyHash)
     end
   end
 end

data/lib/stream-chat/types.rb

@@ -0,0 +1,13 @@
+# typed: strict
+# frozen_string_literal: true
+
+module StreamChat
+  extend T::Sig
+  T::Configuration.default_checked_level = :never
+  # For now we disable runtime type checks.
+  # We will enable it with a major bump in the future,
+  # but for now, let's just run a static type check.
+
+  StringKeyHash = T.type_alias { T::Hash[T.any(String, Symbol), T.untyped] }
+  SortArray = T.type_alias { T::Array[{ field: String, direction: Integer }] }
+end

data/lib/stream-chat/util.rb

@@ -1,11 +1,21 @@
+# typed: strict
 # frozen_string_literal: true
 
-# lib/util.rb
+require 'stream-chat/types'
 
-def get_sort_fields(sort)
-  sort_fields = []
-  sort&.each do |k, v|
-    sort_fields << { field: k, direction: v }
+module StreamChat
+  extend T::Sig
+  T::Configuration.default_checked_level = :never
+  # For now we disable runtime type checks.
+  # We will enable it with a major bump in the future,
+  # but for now, let's just run a static type check.
+
+  sig { params(sort: T.nilable(T::Hash[String, Integer])).returns(SortArray) }
+  def self.get_sort_fields(sort)
+    sort_fields = T.let([], SortArray)
+    sort&.each do |k, v|
+      sort_fields << { field: k, direction: v }
+    end
+    sort_fields
   end
-  sort_fields
 end

data/lib/stream-chat/version.rb

@@ -1,7 +1,6 @@
+# typed: strict
 # frozen_string_literal: true
 
-# lib/version.rb
-
 module StreamChat
-  VERSION = '2.20.0'
+  VERSION = '2.21.0'
 end

data/lib/stream-chat.rb

@@ -1,3 +1,4 @@
-# frozen_string_literal: true # rubocop:todo Naming/FileName
+# typed: strict # rubocop:todo Naming/FileName
+# frozen_string_literal: true
 
 require 'stream-chat/client'

data/stream-chat.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |gem|
   gem.homepage = 'http://github.com/GetStream/stream-chat-ruby'
   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|\.github|scripts)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|sorbet|spec|\.github|scripts|assets)/}) }
   end
   gem.required_ruby_version = '>=2.5.0'
   gem.metadata = {
@@ -31,6 +31,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'faraday-net_http_persistent'
   gem.add_dependency 'jwt'
   gem.add_dependency 'net-http-persistent'
+  gem.add_dependency 'sorbet-runtime'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'simplecov'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stream-chat-ruby
 version: !ruby/object:Gem::Version
-  version: 2.20.0
+  version: 2.21.0
 platform: ruby
 authors:
 - getstream.io
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-04 00:00:00.000000000 Z
+date: 2022-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +146,7 @@ files:
 - ".rubocop.yml"
 - ".versionrc.js"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - PULL_REQUEST_TEMPLATE.md
@@ -143,6 +158,7 @@ files:
 - lib/stream-chat/errors.rb
 - lib/stream-chat/stream_rate_limits.rb
 - lib/stream-chat/stream_response.rb
+- lib/stream-chat/types.rb
 - lib/stream-chat/util.rb
 - lib/stream-chat/version.rb
 - stream-chat.gemspec