stream-chat-ruby 2.22.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bfc513b8901c9efe810c00bb59d9aa23b3e12e0816af1896c31a54b69614053
-  data.tar.gz: ad8e9b4f3b2e4f1a4515226382e8fbf243acfdb46bbab93ba0c9a5c27d8208de
+  metadata.gz: cf7346fa100815ad5e6ded38ee11d3941ce5b8ef33e180ab39f0ce7d5edf1321
+  data.tar.gz: 1d4276d85a538fa0e3aa46b8836383e9a674b5701350ea834acfbed87406d07c
 SHA512:
-  metadata.gz: 8189c936e8c1df17285a51e5410be20f1c6852f92f688a8b1292a971550399404848739772099cfd6e506c89fa5911063793ba46859d757160aa7fe000c8ed8d
-  data.tar.gz: 47de88506b215de1098ae643e7f08cd3636a71709470057a7d672849479f28351f66851e22508e31a59e888bb10b71cf1af99521f15884e1bf385f6b1b760d72
+  metadata.gz: ebcd5bcf54929c7d7c93194c447f511b0e1a341fbae359ba06d8757e3e3b8097ef468da0d0bc9f0ea401fcd2c95a051c3acdab5797c864b5298387c87d0e7f4a
+  data.tar.gz: 12730b06d2997b07b91bef7f9e19f7c40b3d059b3b5b97e490190f80a1837650189190a121fa891a63145cf783262d9cf7b41d51846f05dae3a7ee0238803a05

data/CHANGELOG.md

@@ -2,6 +2,36 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [3.0.0](https://github.com/GetStream/stream-chat-ruby/compare/v2.23.0...v3.0.0) (2022-05-24)
+
+
+### ⚠ BREAKING CHANGES
+
+* **sorbet:** enable runtime typecheck (#104)
+
+> In this release we have enabled runtime level typechecking for Sorbet. This means that if you input parameters
+are invalid **your code will throw an error during runtime**. Please ensure that your code is properly tested
+before continuing with v3.0.0 of this library.
+
+### Features
+
+* **sorbet:** enable runtime typecheck ([#104](https://github.com/GetStream/stream-chat-ruby/issues/104)) ([97d5f29](https://github.com/GetStream/stream-chat-ruby/commit/97d5f299b652e8328af6e76d0d605c59f05a5cc3))
+
+## [2.23.0](https://github.com/GetStream/stream-chat-ruby/compare/v2.22.2...v2.23.0) (2022-05-19)
+
+
+### Features
+
+* **campaign:** add campaign endpoints ([c8c698b](https://github.com/GetStream/stream-chat-ruby/commit/c8c698b51ee2c9f54819c2b9407a3fff7808efd5))
+* **import:** add import endpoints ([#102](https://github.com/GetStream/stream-chat-ruby/issues/102)) ([4d7358d](https://github.com/GetStream/stream-chat-ruby/commit/4d7358d39615c5346f9fdcb2b0dfbffa3c2ae79c))
+
+### [2.22.2](https://github.com/GetStream/stream-chat-ruby/compare/v2.22.1...v2.22.2) (2022-04-21)
+
+
+### Bug Fixes
+
+* **sorbet:** turn off runtime checks properly ([#98](https://github.com/GetStream/stream-chat-ruby/issues/98)) ([29e9e73](https://github.com/GetStream/stream-chat-ruby/commit/29e9e73ac07d163e8c1ca7b24516cb7ac61e93cd))
+
 ### [2.22.1](https://github.com/GetStream/stream-chat-ruby/compare/v2.22.0...v2.22.1) (2022-04-20)
 
 ### Features

data/README.md

@@ -47,6 +47,8 @@ client = StreamChat::Client.new(api_key='STREAM_KEY', api_secret='STREAM_SECRET'
 > 💡 Note: since v2.21.0 we implemented [Sorbet](https://sorbet.org/) type checker. As of v2.x.x we only use it for static type checks and you won't notice any difference, but from v3.0.0 **we will enable runtime checks** 🚨 🚨 🚨.
 
 > What this means, is that you'll receive an error during runtime if you pass an invalid type to our methods. To prepare for that, just make sure whatever you pass in, matches the method signature (`sig { ... }`).
+
+> **Update (2022-May-24)**: we have relased [v3.0.0](https://github.com/GetStream/stream-chat-ruby/releases/tag/v3.0.0) with enabled runtime checks.
  
 ---
 

data/lib/stream-chat/channel.rb

@@ -9,10 +9,6 @@ require 'stream-chat/types'
 module StreamChat
   class Channel
     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(T.nilable(String)) }
     attr_reader :id

data/lib/stream-chat/client.rb

@@ -22,10 +22,6 @@ module StreamChat
 
   class Client
     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.
 
     DEFAULT_BASE_URL = 'https://chat.stream-io-api.com'
     DEFAULT_TIMEOUT = 6.0
@@ -76,10 +72,10 @@ module StreamChat
     # @param [StringKeyHash] options extra options
     sig { params(options: T.untyped).returns(Client) }
     def self.from_env(**options)
-      Client.new(T.must(ENV['STREAM_KEY']),
-                 T.must(ENV['STREAM_SECRET']),
-                 ENV['STREAM_CHAT_TIMEOUT'],
-                 **{ base_url: ENV['STREAM_CHAT_URL'] }.merge(options))
+      Client.new(ENV.fetch('STREAM_KEY'),
+                 ENV.fetch('STREAM_SECRET'),
+                 ENV.fetch('STREAM_CHAT_TIMEOUT', DEFAULT_TIMEOUT),
+                 **{ base_url: ENV.fetch('STREAM_CHAT_URL', DEFAULT_BASE_URL) }.merge(options))
     end
 
     # Sets the underlying Faraday http client.
@@ -207,14 +203,14 @@ module StreamChat
       get('search', params: { payload: options.merge(to_merge).to_json })
     end
 
-    # <b>DEPRECATED:</b> Please use <tt>upsert_users</tt> instead.
+    # @deprecated Use {#upsert_users} instead.
     sig { params(users: T::Array[StringKeyHash]).returns(StreamChat::StreamResponse) }
     def update_users(users)
       warn '[DEPRECATION] `update_users` is deprecated.  Please use `upsert_users` instead.'
       upsert_users(users)
     end
 
-    # <b>DEPRECATED:</b> Please use <tt>upsert_user</tt> instead.
+    # @deprecated Use {#upsert_user} instead.
     sig { params(user: StringKeyHash).returns(StreamChat::StreamResponse) }
     def update_user(user)
       warn '[DEPRECATION] `update_user` is deprecated.  Please use `upsert_user` instead.'
@@ -583,7 +579,7 @@ module StreamChat
     # of the most common profane words.
     # You can manage your own block lists via the Stream dashboard or APIs to a manage
     # blocklists and configure your channel types to use them.
-    sig { params(name: String, words: StringKeyHash).returns(StreamChat::StreamResponse) }
+    sig { params(name: String, words: T::Array[String]).returns(StreamChat::StreamResponse) }
     def create_blocklist(name, words)
       post('blocklists', data: { name: name, words: words })
     end
@@ -595,7 +591,7 @@ module StreamChat
     # of the most common profane words.
     # You can manage your own block lists via the Stream dashboard or APIs to a manage
     # blocklists and configure your channel types to use them.
-    sig { params(name: String, words: StringKeyHash).returns(StreamChat::StreamResponse) }
+    sig { params(name: String, words: T::Array[String]).returns(StreamChat::StreamResponse) }
     def update_blocklist(name, words)
       put("blocklists/#{name}", data: { words: words })
     end
@@ -635,7 +631,7 @@ module StreamChat
     end
 
     # Delete users asynchronously. Use `get_task` to check the status of the task.
-    sig { params(user_ids: T::Array[String], user: String, messages: T.nilable(StringKeyHash), conversations: T.nilable(String)).returns(StreamChat::StreamResponse) }
+    sig { params(user_ids: T::Array[String], user: String, messages: T.nilable(String), conversations: T.nilable(String)).returns(StreamChat::StreamResponse) }
     def delete_users(user_ids, user: SOFT_DELETE, messages: nil, conversations: nil)
       post('users/delete', data: { user_ids: user_ids, user: user, messages: messages, conversations: conversations })
     end
@@ -835,6 +831,122 @@ module StreamChat
       get('push_providers')
     end
 
+    # Creates a signed URL for imports.
+    # @example
+    #   url_resp = client.create_import_url('myfile.json')
+    #   Faraday.put(url_resp['upload_url'], File.read('myfile.json'), 'Content-Type' => 'application/json')
+    #   client.create_import(url_resp['path'], 'upsert')
+    sig { params(filename: String).returns(StreamChat::StreamResponse) }
+    def create_import_url(filename)
+      post('import_urls', data: { filename: filename })
+    end
+
+    # Creates a new import.
+    # @example
+    #   url_resp = client.create_import_url('myfile.json')
+    #   Faraday.put(url_resp['upload_url'], File.read('myfile.json'), 'Content-Type' => 'application/json')
+    #   client.create_import(url_resp['path'], 'upsert')
+    sig { params(path: String, mode: String).returns(StreamChat::StreamResponse) }
+    def create_import(path, mode)
+      post('imports', data: { path: path, mode: mode })
+    end
+
+    # Returns an import by id.
+    sig { params(id: String).returns(StreamChat::StreamResponse) }
+    def get_import(id)
+      get("imports/#{id}")
+    end
+
+    # Lists imports. Options dictionary can contain 'offset' and 'limit' keys for pagination.
+    sig { params(options: T.untyped).returns(StreamChat::StreamResponse) }
+    def list_imports(options)
+      get('imports', params: options)
+    end
+
+    # Creates a campaign.
+    sig { params(campaign: StringKeyHash).returns(StreamChat::StreamResponse) }
+    def create_campaign(campaign)
+      post('campaigns', data: { campaign: campaign })
+    end
+
+    # Gets a campaign.
+    sig { params(campaign_id: String).returns(StreamChat::StreamResponse) }
+    def get_campaign(campaign_id)
+      get("campaigns/#{campaign_id}")
+    end
+
+    # Lists all campaigns. Options dictionary can contain 'offset' and 'limit' keys for pagination.
+    sig { params(options: StringKeyHash).returns(StreamChat::StreamResponse) }
+    def list_campaigns(options)
+      get('campaigns', params: options)
+    end
+
+    # Updates a campaign.
+    sig { params(campaign_id: String, campaign: StringKeyHash).returns(StreamChat::StreamResponse) }
+    def update_campaign(campaign_id, campaign)
+      put("campaigns/#{campaign_id}", data: { campaign: campaign })
+    end
+
+    # Deletes a campaign.
+    sig { params(campaign_id: String).returns(StreamChat::StreamResponse) }
+    def delete_campaign(campaign_id)
+      delete("campaigns/#{campaign_id}")
+    end
+
+    # Schedules a campaign.
+    sig { params(campaign_id: String, send_at: Integer).returns(StreamChat::StreamResponse) }
+    def schedule_campaign(campaign_id, send_at)
+      patch("campaigns/#{campaign_id}/schedule", data: { send_at: send_at })
+    end
+
+    # Stops a campaign.
+    sig { params(campaign_id: String).returns(StreamChat::StreamResponse) }
+    def stop_campaign(campaign_id)
+      patch("campaigns/#{campaign_id}/stop")
+    end
+
+    # Resumes a campaign.
+    sig { params(campaign_id: String).returns(StreamChat::StreamResponse) }
+    def resume_campaign(campaign_id)
+      patch("campaigns/#{campaign_id}/resume")
+    end
+
+    # Tests a campaign.
+    sig { params(campaign_id: String, users: T::Array[StringKeyHash]).returns(StreamChat::StreamResponse) }
+    def test_campaign(campaign_id, users)
+      post("campaigns/#{campaign_id}/test", data: { users: users })
+    end
+
+    # Creates a campaign segment.
+    sig { params(segment: StringKeyHash).returns(StreamChat::StreamResponse) }
+    def create_segment(segment)
+      post('segments', data: { segment: segment })
+    end
+
+    # Gets a campaign segment.
+    sig { params(segment_id: String).returns(StreamChat::StreamResponse) }
+    def get_segment(segment_id)
+      get("segments/#{segment_id}")
+    end
+
+    # Lists all campaign segments. Options dictionary can contain 'offset' and 'limit' keys for pagination.
+    sig { params(options: StringKeyHash).returns(StreamChat::StreamResponse) }
+    def list_segments(options)
+      get('segments', params: options)
+    end
+
+    # Updates a campaign segment.
+    sig { params(segment_id: String, segment: StringKeyHash).returns(StreamChat::StreamResponse) }
+    def update_segment(segment_id, segment)
+      put("segments/#{segment_id}", data: { segment: segment })
+    end
+
+    # Deletes a campaign segment.
+    sig { params(segment_id: String).returns(StreamChat::StreamResponse) }
+    def delete_segment(segment_id)
+      delete("segments/#{segment_id}")
+    end
+
     private
 
     sig { returns(T::Hash[String, String]) }

data/lib/stream-chat/errors.rb

@@ -4,10 +4,6 @@
 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

data/lib/stream-chat/stream_rate_limits.rb

@@ -4,10 +4,6 @@
 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

data/lib/stream-chat/stream_response.rb

@@ -7,10 +7,6 @@ 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

data/lib/stream-chat/types.rb

@@ -3,10 +3,6 @@
 
 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 }] }

data/lib/stream-chat/util.rb

@@ -5,10 +5,6 @@ require 'stream-chat/types'
 
 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)

data/lib/stream-chat/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module StreamChat
-  VERSION = '2.22.1'
+  VERSION = '3.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stream-chat-ruby
 version: !ruby/object:Gem::Version
-  version: 2.22.1
+  version: 3.0.0
 platform: ruby
 authors:
 - getstream.io
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-20 00:00:00.000000000 Z
+date: 2022-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday