feat: add campaign support (#124)

Author: ferhatelmas

README.md

@@ -57,7 +57,7 @@ client = StreamChat::Client.new('STREAM_KEY', 'STREAM_SECRET')
 > # Wrong:
 > user = { "user" => { "id" => "bob-1"}}
 > # Correct:
-> user = { :user => { :id => "bob-1" }}
+> user = { user: { id: "bob-1" }}
 > ```
 
 ### Generate a token for client-side usage:
@@ -70,25 +70,25 @@ client.create_token('bob-1')
 
 ```ruby
 client.upsert_user({
-    :id => 'bob-1',
-    :role => 'admin',
-    :name => 'Robert Tables'
+    id: 'bob-1',
+    role: 'admin',
+    name: 'Robert Tables'
 })
 
 # Batch update is also supported
-jane = {:id => 'jane-1'}
-june = {:id => 'june-1'}
+jane = {id: 'jane-1'}
+june = {id: 'june-1'}
 client.upsert_users([jane, june])
 ```
 
 ### Channel types
 
 ```ruby
 client.create_channel_type({
-    :name => 'livechat',
-    :automod => 'disabled',
-    :commands => ['ban'],
-    :mutes => true
+    name: 'livechat',
+    automod: 'disabled',
+    commands: ['ban'],
+    mutes: true
 })
 
 channel_types = client.list_channel_types()
@@ -109,7 +109,7 @@ chan.add_members(['bob-1', 'jane-77'])
 
 ### Reactions
 ```ruby
-chan.send_reaction(m1['id'], {:type => 'like'}, 'bob-1')
+chan.send_reaction(m1['id'], {type: 'like'}, 'bob-1')
 ```
 
 ### Moderation
@@ -125,7 +125,7 @@ chan.unban_user('bob-1')
 ### Messages
 
 ```ruby
-m1 = chan.send_message({:text => 'Hi Jane!'}, 'bob-1')
+m1 = chan.send_message({text: 'Hi Jane!'}, 'bob-1')
 
 deleted_message = client.delete_message(m1['message']['id'])
 
@@ -158,13 +158,39 @@ client.delete_blocklist('my_blocker')
 
 ```ruby
 # Register an export
-response = client.export_channels({:type => 'messaging', :id => 'jane'})
+response = client.export_channels({type: 'messaging', id: 'jane'})
 
 # Check completion
 status_response = client.get_export_channel_status(response['task_id'])
 # status_response['status'] == 'pending', 'completed'
 ```
 
+### Campaigns
+
+```ruby
+# Create a user or channel segment
+client.create_segment({ name: 'test', type: 'user', filter: { uniq: 'a flag on users' } })
+
+# Create a campaign that uses the segment
+client.create_campaign({
+    name: 'test',
+    text: 'Hi',
+    sender_id: campaign_sender,
+    segment_id: segment_id,
+    channel_type: 'messaging'
+})
+
+# Schedule the campaign
+client.schedule_campaign(campaign_id, Time.now.to_i)
+
+# Query the campaign to check the status
+response = client.query_campaigns(filter_conditions: { id: campaign_id })
+response['campaigns'][0]['status'] == 'completed'
+
+# Read sent information
+client.query_recipients(filter_conditions: { campaign_id: campaign_id })
+```
+
 ### Rate limits
 
 ```ruby

lib/stream-chat/client.rb

@@ -869,16 +869,10 @@ 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)
+    # Queries campaigns similar to query_channels or query_users.
+    sig { params(params: T.untyped).returns(StreamChat::StreamResponse) }
+    def query_campaigns(**params)
+      get('campaigns', params: { payload: params.to_json })
     end
 
     # Updates a campaign.
@@ -894,9 +888,9 @@ def delete_campaign(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 })
+    sig { params(campaign_id: String, scheduled_for: Integer).returns(StreamChat::StreamResponse) }
+    def schedule_campaign(campaign_id, scheduled_for)
+      patch("campaigns/#{campaign_id}/schedule", data: { scheduled_for: scheduled_for })
     end
 
     # Stops a campaign.
@@ -923,16 +917,10 @@ 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)
+    # Queries campaign segments.
+    sig { params(params: T.untyped).returns(StreamChat::StreamResponse) }
+    def query_segments(**params)
+      get('segments', params: { payload: params.to_json })
     end
 
     # Updates a campaign segment.
@@ -947,6 +935,12 @@ def delete_segment(segment_id)
       delete("segments/#{segment_id}")
     end
 
+    # Queries campaign recipients.
+    sig { params(params: T.untyped).returns(StreamChat::StreamResponse) }
+    def query_recipients(**params)
+      get('recipients', params: { payload: params.to_json })
+    end
+
     private
 
     sig { returns(T::Hash[String, String]) }

spec/client_spec.rb

@@ -729,6 +729,39 @@ def loop_times(times)
     end
   end
 
+  describe 'campaigns', campaigns: true do
+    before(:all) do
+      @campaign_selector = SecureRandom.uuid
+      @campaign_receiver = SecureRandom.uuid
+      @campaign_sender = SecureRandom.uuid
+      @client.upsert_user({ id: @campaign_receiver, uniq: @campaign_selector, receiver: true })
+      @client.upsert_user({ id: @campaign_sender, sender: true })
+    end
+
+    it 'full flow' do
+      response = @client.create_segment({ name: 'test', type: 'user', filter: { uniq: @campaign_selector } })
+      segment = response['segment']
+      response = @client.create_campaign({ name: 'test', text: 'Hi', sender_id: @campaign_sender, segment_id: segment['id'], channel_type: 'messaging' })
+      campaign = response['campaign']
+      @client.schedule_campaign(campaign['id'], Time.now.to_i)
+
+      response = @client.query_segments(filter_conditions: { id: segment['id'] })
+      expect(response['segments'].length).to eq 1
+
+      loop do
+        response = @client.query_campaigns(filter_conditions: { id: campaign['id'] })
+        if response['campaigns'].length == 1 && response['campaigns'][0]['status'] == 'completed'
+          response = @client.query_recipients(filter_conditions: { campaign_id: campaign['id'] })
+          puts response.to_json
+          expect(response['recipients'].length).to eq 1
+          expect(response['recipients'][0]['receiver_id']).to eq @campaign_receiver
+          break
+        end
+        sleep(0.5)
+      end
+    end
+  end
+
   describe 'permissions' do
     before(:all) do
       @permission_id = SecureRandom.uuid