Permissionsv2 (#62)

* [CHAT-2584] Add permissions v2 methods

* Add host env variable for CI

* Run rubocop in separate step

Author: Eugene

.github/workflows/ci.yml

@@ -17,9 +17,9 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
 
+      - run: bundle exec rake rubocop
       - env:
           STREAM_CHAT_API_KEY: ${{ secrets.STREAM_CHAT_API_KEY }}
           STREAM_CHAT_API_SECRET: ${{ secrets.STREAM_CHAT_API_SECRET }}
-        run: |
-          bundle exec rake rubocop
-          bundle exec rake test
+          STREAM_CHAT_API_HOST: ${{ secrets.STREAM_CHAT_API_HOST }}
+        run: bundle exec rake test

lib/stream-chat/channel.rb

@@ -115,6 +115,10 @@ def remove_members(user_ids)
       @client.post(url, data: { remove_members: user_ids })
     end
 
+    def assign_roles(members, message = nil)
+      @client.post(url, data: { assign_roles: members, message: message })
+    end
+
     def demote_moderators(user_ids)
       @client.post(url, data: { demote_moderators: user_ids })
     end

lib/stream-chat/client.rb

@@ -429,6 +429,38 @@ def list_commands
       get('commands')
     end
 
+    def list_permissions
+      get('permissions')
+    end
+
+    def get_permission(id)
+      get("permissions/#{id}")
+    end
+
+    def create_permission(permission)
+      post('permissions', data: permission)
+    end
+
+    def update_permission(id, permission)
+      put("permissions/#{id}", data: permission)
+    end
+
+    def delete_permission(id)
+      delete("permissions/#{id}")
+    end
+
+    def create_role(name)
+      post('roles', data: { name: name })
+    end
+
+    def delete_role(name)
+      delete("roles/#{name}")
+    end
+
+    def list_roles
+      get('roles')
+    end
+
     private
 
     def get_default_params

spec/channel_spec.rb

@@ -4,6 +4,20 @@
 require 'stream-chat'
 
 describe StreamChat::Channel do
+  def loop_times(times)
+    loop do
+      begin
+        yield()
+        return
+      rescue StandardError, RSpec::Expectations::ExpectationNotMetError
+        raise if times == 0
+      end
+
+      sleep(1)
+      times -= 1
+    end
+  end
+
   before(:all) do
     @client = StreamChat::Client.new(ENV['STREAM_CHAT_API_KEY'], ENV['STREAM_CHAT_API_SECRET'], base_url: ENV['STREAM_CHAT_API_HOST'])
   end
@@ -84,9 +98,13 @@
 
   it 'can truncate with message' do
     text = SecureRandom.uuid.to_s
-    response = @channel.truncate(message: { text: text, user_id: @random_user[:id] })
-    expect(response).to include 'message'
-    expect(response['message']['text']).to eq(text)
+    @channel.truncate(message: { text: text, user_id: @random_user[:id] })
+
+    loop_times 60 do
+      channel_state = @channel.query
+      expect(channel_state).to include 'messages'
+      expect(channel_state['messages'][0]['text']).to eq(text)
+    end
   end
 
   it 'can add members' do

spec/client_spec.rb

@@ -5,6 +5,20 @@
 require 'stream-chat'
 
 describe StreamChat::Client do
+  def loop_times(times)
+    loop do
+      begin
+        yield()
+        return
+      rescue StandardError, RSpec::Expectations::ExpectationNotMetError
+        raise if times == 0
+      end
+
+      sleep(1)
+      times -= 1
+    end
+  end
+
   before(:all) do
     @client = StreamChat::Client.new(ENV['STREAM_CHAT_API_KEY'], ENV['STREAM_CHAT_API_SECRET'], base_url: ENV['STREAM_CHAT_API_HOST'])
 
@@ -458,7 +472,7 @@
   it 'request the export for a channel that does not exist' do
     expect do
       @client.export_channels({ type: 'messaging', id: SecureRandom.uuid })
-    end.to raise_error
+    end.to raise_error StreamChat::StreamAPIException
   end
 
   it 'request the channel export' do
@@ -594,4 +608,93 @@
       end
     end
   end
+
+  describe 'permissions' do
+    before(:all) do
+      @permission_id = SecureRandom.uuid
+    end
+
+    it 'create a permission' do
+      @client.create_permission({
+                                  id: @permission_id,
+                                  name: @permission_id,
+                                  action: 'CreateChannel',
+                                  owner: false,
+                                  same_team: false,
+                                  condition: {
+                                    '$subject.magic_custom_field': 'custom'
+                                  }
+                                })
+    end
+
+    it 'get permission' do
+      loop_times 10 do
+        permission = @client.get_permission(@permission_id)
+        expect(permission['id']).to eq @cmd
+        expect(permission['name']).to eq @cmd
+      end
+    end
+
+    it 'update that permission' do
+      loop_times 10 do
+        @client.update_permission(@permission_id, {
+                                    id: @permission_id,
+                                    name: @permission_id,
+                                    description: 'desc',
+                                    action: 'CreateChannel',
+                                    condition: {
+                                      '$subject.magic_custom_field': 'custom'
+                                    }
+                                  })
+        permission = @client.get_permission(@permission_id)['permission']
+        expect(permission['name']).to eq @permission_id
+        expect(permission['description']).to eq 'desc'
+      end
+    end
+
+    it 'list permissions' do
+      loop_times 10 do
+        permissions = @client.list_permissions['permissions']
+        found = false
+        permissions.each do |permission|
+          if permission['id'] == @permission_id
+            found = true
+            break
+          end
+        end
+
+        expect(found).to be true
+      end
+    end
+
+    it 'delete that permission' do
+      loop_times 10 do
+        @client.delete_permission(@permission_id)
+      end
+    end
+
+    it 'create role' do
+      @client.create_role(@permission_id)
+    end
+
+    it 'list new role' do
+      loop_times 10 do
+        roles = @client.list_roles['roles']
+        found = false
+        roles.each do |role|
+          if role['name'] == @permission_id
+            found = true
+            break
+          end
+        end
+        expect(found).to be true
+      end
+    end
+
+    it 'delete role' do
+      loop_times 10 do
+        @client.delete_role @permission_id
+      end
+    end
+  end
 end