[CHA-17] - added support for pinning, archiving and partial member update (#142)

Author: totalimmersion

.github/workflows/ci.yml

@@ -15,10 +15,6 @@ jobs:
         with:
           fetch-depth: 0 # gives the commit linter access to previous commits
 
-      - name: Commit message linter
-        if: ${{ matrix.ruby == '2.7' }}
-        uses: wagoid/commitlint-github-action@v4
-
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}

lib/stream-chat/channel.rb

@@ -16,6 +16,9 @@ class Channel
     sig { returns(String) }
     attr_reader :channel_type
 
+    sig { returns(String) }
+    attr_reader :cid
+
     sig { returns(StringKeyHash) }
     attr_reader :custom_data
 
@@ -166,6 +169,68 @@ def unmute(user_id)
       @client.post('moderation/unmute/channel', data: { 'user_id' => user_id, 'channel_cid' => @cid })
     end
 
+    # Pins a channel for a user.
+    sig { params(user_id: String).returns(StreamChat::StreamResponse) }
+    def pin(user_id)
+      raise StreamChannelException, 'user ID must not be empty' if user_id.empty?
+
+      payload = {
+        set: {
+          pinned: true
+        }
+      }
+      @client.patch("#{url}/member/#{CGI.escape(user_id)}", data: payload)
+    end
+
+    # Unins a channel for a user.
+    sig { params(user_id: String).returns(StreamChat::StreamResponse) }
+    def unpin(user_id)
+      raise StreamChannelException, 'user ID must not be empty' if user_id.empty?
+
+      payload = {
+        set: {
+          pinned: false
+        }
+      }
+      @client.patch("#{url}/member/#{CGI.escape(user_id)}", data: payload)
+    end
+
+    # Archives a channel for a user.
+    sig { params(user_id: String).returns(StreamChat::StreamResponse) }
+    def archive(user_id)
+      raise StreamChannelException, 'user ID must not be empty' if user_id.empty?
+
+      payload = {
+        set: {
+          archived: true
+        }
+      }
+      @client.patch("#{url}/member/#{CGI.escape(user_id)}", data: payload)
+    end
+
+    # Archives a channel for a user.
+    sig { params(user_id: String).returns(StreamChat::StreamResponse) }
+    def unarchive(user_id)
+      raise StreamChannelException, 'user ID must not be empty' if user_id.empty?
+
+      payload = {
+        set: {
+          archived: false
+        }
+      }
+      @client.patch("#{url}/member/#{CGI.escape(user_id)}", data: payload)
+    end
+
+    # Updates a member partially in the channel.
+    sig { params(user_id: String, set: T.nilable(StringKeyHash), unset: T.nilable(T::Array[String])).returns(StreamChat::StreamResponse) }
+    def update_member_partial(user_id, set: nil, unset: nil)
+      raise StreamChannelException, 'user ID must not be empty' if user_id.empty?
+      raise StreamChannelException, 'set or unset is required' if set.nil? && unset.nil?
+
+      payload = { set: set, unset: unset }
+      @client.patch("#{url}/member/#{CGI.escape(user_id)}", data: payload)
+    end
+
     # Adds members to the channel.
     sig { params(user_ids: T::Array[String], options: T.untyped).returns(StreamChat::StreamResponse) }
     def add_members(user_ids, **options)

spec/channel_spec.rb

@@ -288,4 +288,67 @@ def loop_times(times)
     response = @channel.query_members(filter_conditions: { notifications_muted: true })
     expect(response['members'].length).to eq 2
   end
+
+  it 'can pin and unpin a channel' do
+    @channel.add_members([@random_users[0][:id]])
+    @channel.add_members([@random_users[1][:id]])
+
+    # Pin the channel
+    now = Time.now
+    response = @channel.pin(@random_users[0][:id])
+    expect(response['channel_member']['pinned_at']).not_to be_nil
+    expect(Time.parse(response['channel_member']['pinned_at']).to_i).to be >= now.to_i
+
+    # Query for pinned channel
+    response = @client.query_channels({ 'pinned' => true, 'cid' => @channel.cid }, sort: nil, user_id: @random_users[0][:id])
+    expect(response['channels'].length).to eq 1
+    expect(response['channels'][0]['channel']['cid']).to eq @channel.cid
+
+    # Unpin the channel
+    response = @channel.unpin(@random_users[0][:id])
+    expect(response['channel_member']).not_to have_key('pinned_at')
+
+    # Query for unpinned channel
+    response = @client.query_channels({ 'pinned' => false, 'cid' => @channel.cid }, sort: nil, user_id: @random_users[0][:id])
+    expect(response['channels'].length).to eq 1
+    expect(response['channels'][0]['channel']['cid']).to eq @channel.cid
+  end
+
+  it 'can archive and unarchive a channel' do
+    @channel.add_members([@random_users[0][:id]])
+    @channel.add_members([@random_users[1][:id]])
+
+    # Pin the channel
+    now = Time.now
+    response = @channel.archive(@random_users[0][:id])
+    expect(response['channel_member']['archived_at']).not_to be_nil
+    expect(Time.parse(response['channel_member']['archived_at']).to_i).to be >= now.to_i
+
+    # Query for archived channel
+    response = @client.query_channels({ 'archived' => true, 'cid' => @channel.cid }, sort: nil, user_id: @random_users[0][:id])
+    expect(response['channels'].length).to eq 1
+    expect(response['channels'][0]['channel']['cid']).to eq @channel.cid
+
+    # Unarchive the channel
+    response = @channel.unarchive(@random_users[0][:id])
+    expect(response['channel_member']).not_to have_key('archived_at')
+
+    # Query for unarchived channel
+    response = @client.query_channels({ 'archived' => false, 'cid' => @channel.cid }, sort: nil, user_id: @random_users[0][:id])
+    expect(response['channels'].length).to eq 1
+    expect(response['channels'][0]['channel']['cid']).to eq @channel.cid
+  end
+
+  it 'can update channel member partially' do
+    @channel.add_members([@random_users[0][:id]])
+
+    # Test setting a field
+    response = @channel.update_member_partial(@random_users[0][:id], set: { 'hat' => 'blue' })
+    expect(response['channel_member']['hat']).to eq 'blue'
+
+    # Test setting and unsetting fields
+    response = @channel.update_member_partial(@random_users[0][:id], set: { 'color' => 'red' }, unset: ['hat'])
+    expect(response['channel_member']['color']).to eq 'red'
+    expect(response['channel_member']).not_to have_key('hat')
+  end
 end

spec/client_spec.rb

@@ -718,7 +718,7 @@ def loop_times(times)
     end
 
     it 'import end2end' do
-      url_resp = @client.create_import_url("#{SecureRandom.uuid}.json'")
+      url_resp = @client.create_import_url("#{SecureRandom.uuid}.json")
       expect(url_resp['upload_url']).not_to be_empty
       expect(url_resp['path']).not_to be_empty