[CHAT-2402] Add delete users/channels support (#54)

Author: ferhatelmas

lib/stream-chat/client.rb

@@ -12,6 +12,8 @@
 
 module StreamChat
   DEFAULT_BLOCKLIST = 'profanity_en_2020_v1'
+  SOFT_DELETE = 'soft'
+  HARD_DELETE = 'hard'
 
   class Client
     BASE_URL = 'https://chat.stream-io-api.com'
@@ -293,6 +295,18 @@ def get_export_channel_status(task_id)
       get("export_channels/#{task_id}")
     end
 
+    def get_task(task_id)
+      get("tasks/#{task_id}")
+    end
+
+    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
+
+    def delete_channels(cids, hard_delete: false)
+      post('channels/delete', data: { cids: cids, hard_delete: hard_delete })
+    end
+
     def revoke_tokens(before)
       before = before.rfc3339 if before.instance_of?(DateTime)
       update_app_settings({ 'revoke_tokens_issued_before' => before })

spec/client_spec.rb

@@ -390,6 +390,14 @@
     )
   end
 
+  it 'check status for a task that does not exist' do
+    expect do
+      @client.get_task(SecureRandom.uuid)
+    end.to raise_error(
+      /Can't find task with id/
+    )
+  end
+
   it 'request the export for a channel that does not exist' do
     expect do
       @client.export_channels({ type: 'messaging', id: SecureRandom.uuid })
@@ -420,6 +428,74 @@
     end
   end
 
+  it 'request delete channels' do
+    ch1 = @client.channel('messaging', channel_id: SecureRandom.uuid)
+    ch1.create(@random_user[:id])
+    ch1.send_message({ text: 'Hey Joni' }, @random_user[:id])
+    cid1 = "#{ch1.channel_type}:#{ch1.id}"
+
+    ch2 = @client.channel('messaging', channel_id: SecureRandom.uuid)
+    ch2.create(@random_user[:id])
+    ch2.send_message({ text: 'Hey Joni' }, @random_user[:id])
+    cid2 = "#{ch2.channel_type}:#{ch2.id}"
+
+    resp = @client.delete_channels([cid1, cid2], hard_delete: true)
+    expect(resp['task_id']).not_to be_empty
+
+    task_id = resp['task_id']
+    loop do
+      resp = @client.get_task(task_id)
+      expect(resp['status']).not_to be_empty
+      expect(resp['created_at']).not_to be_empty
+      expect(resp['updated_at']).not_to be_empty
+      if resp['status'] == 'completed'
+        result = resp['result']
+        expect(result).not_to be_empty
+        expect(result[cid1]).not_to be_empty
+        expect(result[cid1]['status']).to eq 'ok'
+        expect(result[cid2]).not_to be_empty
+        expect(result[cid2]['status']).to eq 'ok'
+        break
+      end
+      sleep(0.5)
+    end
+  end
+
+  it 'request delete users' do
+    user_id1 = SecureRandom.uuid
+    user_id2 = SecureRandom.uuid
+    @client.update_users([{ id: user_id1 }, { id: user_id2 }])
+
+    ch1 = @client.channel('messaging', channel_id: SecureRandom.uuid)
+    ch1.create(user_id1)
+    ch1.send_message({ text: 'Hey Joni' }, user_id1)
+
+    ch2 = @client.channel('messaging', channel_id: SecureRandom.uuid)
+    ch2.create(user_id2)
+    ch2.send_message({ text: 'Hey Joni' }, user_id1)
+
+    resp = @client.delete_users([user_id1, user_id2], user: StreamChat::HARD_DELETE)
+    expect(resp['task_id']).not_to be_empty
+
+    task_id = resp['task_id']
+    loop do
+      resp = @client.get_task(task_id)
+      expect(resp['status']).not_to be_empty
+      expect(resp['created_at']).not_to be_empty
+      expect(resp['updated_at']).not_to be_empty
+      if resp['status'] == 'completed'
+        result = resp['result']
+        expect(result).not_to be_empty
+        expect(result[user_id1]).not_to be_empty
+        expect(result[user_id1]['status']).to eq 'ok'
+        expect(result[user_id2]).not_to be_empty
+        expect(result[user_id2]['status']).to eq 'ok'
+        break
+      end
+      sleep(0.5)
+    end
+  end
+
   it 'check_sqs with an invalid queue url should fail' do
     resp = @client.check_sqs('key', 'secret', 'https://foo.com/bar')
     expect(resp['status']).to eq 'error'