Feature: Search endpoint improvements (#49)

Author: miagilepner

lib/stream-chat/client.rb

@@ -92,13 +92,21 @@ def get_message(id)
       get("messages/#{id}")
     end
 
-    def search(filter_conditions, query, **options)
-      params = options.merge({
-                               filter_conditions: filter_conditions,
-                               query: query
-                             })
-
-      get('search', params: { payload: params.to_json })
+    def search(filter_conditions, query, sort: nil, **options)
+      offset = options[:offset]
+      next_value = options[:next]
+      raise ArgumentError, 'cannot use offset with next or sort parameters' if offset&.positive? && (next_value || (!sort.nil? && !sort.empty?))
+
+      to_merge = {
+        filter_conditions: filter_conditions,
+        sort: get_sort_fields(sort)
+      }
+      if query.is_a? String
+        to_merge[:query] = query
+      else
+        to_merge[:message_filter_conditions] = query
+      end
+      get('search', params: { payload: options.merge(to_merge).to_json })
     end
 
     def update_users(users)

spec/client_spec.rb

@@ -253,11 +253,43 @@
     end
   end
 
-  it 'search for messages' do
-    text = SecureRandom.uuid
-    @channel.send_message({ text: text }, 'legolas')
-    resp = @client.search({ members: { '$in' => ['legolas'] } }, text)
-    expect(resp['results'].length).to eq(1)
+  describe 'search' do
+    it 'search for messages' do
+      text = SecureRandom.uuid
+      @channel.send_message({ text: text }, 'legolas')
+      resp = @client.search({ members: { '$in' => ['legolas'] } }, text)
+      expect(resp['results'].length).to eq(1)
+    end
+    it 'search for messages with filter conditions' do
+      text = SecureRandom.uuid
+      @channel.send_message({ text: text }, 'legolas')
+      resp = @client.search({ members: { '$in' => ['legolas'] } }, { text: { '$q': text } })
+      expect(resp['results'].length).to eq(1)
+    end
+    it 'offset with sort should fail' do
+      expect do
+        @client.search({ members: { '$in' => ['legolas'] } }, SecureRandom.uuid, sort: [{ created_at: -1 }], offset: 2)
+      end.to raise_error(/cannot use offset with next or sort parameters/)
+    end
+    it 'offset with next should fail' do
+      expect do
+        @client.search({ members: { '$in' => ['legolas'] } }, SecureRandom.uuid,  offset: 2, next: SecureRandom.uuid)
+      end.to raise_error(/cannot use offset with next or sort parameters/)
+    end
+    xit 'search for messages with sorting' do
+      text = SecureRandom.uuid
+      message_ids = ["0-#{text}", "1-#{text}"]
+      @channel.send_message({ id: message_ids[0], text: text }, 'legolas')
+      @channel.send_message({ id: message_ids[1], text: text }, 'legolas')
+      page1 = @client.search({ members: { '$in' => ['legolas'] } }, text, sort: [{ created_at: -1 }], limit: 1)
+      expect(page1['results'].length).to eq
+      expect(page1['results'][0]['message']['id']).to eq(message_ids[1])
+      expect(page1['next']).not_to be_empty
+      page2 = @client.search({ members: { '$in' => ['legolas'] } }, text, limit: 1, next: page1['next'])
+      expect(page2['results'].length).to eq(1)
+      expect(page2['results'][0]['message']['id']).to eq(message_ids[0])
+      expect(page2['previous']).not_to be_empty
+    end
   end
 
   describe 'blocklist' do