Skip to content

Commit 74d3163

Browse files
authored
feat(update_user): deprecate update in favor of upsert (#91)
1 parent aa6723c commit 74d3163

File tree

2 files changed

+18
-4
lines changed

2 files changed

+18
-4
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ client.create_token('bob-1')
6767
### Create/Update users
6868

6969
```ruby
70-
client.update_user({
70+
client.upsert_user({
7171
:id => 'bob-1',
7272
:role => 'admin',
7373
:name => 'Robert Tables'
@@ -76,7 +76,7 @@ client.update_user({
7676
# Batch update is also supported
7777
jane = {:id => 'jane-1'}
7878
june = {:id => 'june-1'}
79-
client.update_users([jane, june])
79+
client.upsert_users([jane, june])
8080
```
8181

8282
### Channel types

lib/stream-chat/client.rb

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,8 +179,22 @@ def search(filter_conditions, query, sort: nil, **options)
179179
get('search', params: { payload: options.merge(to_merge).to_json })
180180
end
181181

182+
# <b>DEPRECATED:</b> Please use <tt>upsert_users</tt> instead.
182183
sig { params(users: T::Array[StringKeyHash]).returns(StreamChat::StreamResponse) }
183184
def update_users(users)
185+
warn '[DEPRECATION] `update_users` is deprecated. Please use `upsert_users` instead.'
186+
upsert_users(users)
187+
end
188+
189+
# <b>DEPRECATED:</b> Please use <tt>upsert_user</tt> instead.
190+
sig { params(user: StringKeyHash).returns(StreamChat::StreamResponse) }
191+
def update_user(user)
192+
warn '[DEPRECATION] `update_user` is deprecated. Please use `upsert_user` instead.'
193+
upsert_user(user)
194+
end
195+
196+
sig { params(users: T::Array[StringKeyHash]).returns(StreamChat::StreamResponse) }
197+
def upsert_users(users)
184198
payload = {}
185199
users.each do |user|
186200
id = user[:id] || user['id']
@@ -192,8 +206,8 @@ def update_users(users)
192206
end
193207

194208
sig { params(user: StringKeyHash).returns(StreamChat::StreamResponse) }
195-
def update_user(user)
196-
update_users([user])
209+
def upsert_user(user)
210+
upsert_users([user])
197211
end
198212

199213
sig { params(updates: T::Array[StringKeyHash]).returns(StreamChat::StreamResponse) }

0 commit comments

Comments
 (0)