stream-chat-ruby 2.11.1 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94aa7ad5ea3a88c5bf5e20cf49d5d73379df7a2b6944565e7dd853fe026f6b6c
-  data.tar.gz: 84a37542aa8790e4f328aff6f5c748eef76df32d0f23404ff5e487453e10681d
+  metadata.gz: d913a2d883a67d7e06afd1e57febfb5565cbcd23d69249e101f72163084f7b96
+  data.tar.gz: af4374cd74b9789c5751f6569e9317e46289207daa6a72eea0e53a20ad3ee43f
 SHA512:
-  metadata.gz: 7daa874596aabbe29e2cfa48d530c396e686ba949477f9212eb21d080f28f5ba1e6d8a28f1524121a315a3c5f15d6d64da9ef3ff96c2209d4fa57e5386433127
-  data.tar.gz: 35f6745c799556c623541922c8bb8863b4b93469eb57d69662b3c3525c46cdeae3fb3fef6731f5cf633996fdb1ed5c8d902b7a2bf20d43e4fd81e820d114a1c1
+  metadata.gz: 5c7ed7f7f94d009b4e3a091942f6b59cfa14087d02ba4b2659e18755dbb62a8bbe471e0497ce46a113598fd1e36aa2c7a3749f4ca3505f6f18e28a8d2ca3e663
+  data.tar.gz: 4c0dbed5b2230c4ce9fb3b8630f6d8fa72dd58097b35b12d78a6b355635cd7d9b0b63e38e1b011b57d7ce647fb271b0b225977e02c35718d549fc9d9c9ad7da3

data/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @ffenix113

data/.github/workflows/ci.yml

@@ -1,9 +1,9 @@
-name: build
+name: test
 
 on: [pull_request]
 
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
     strategy:
       max-parallel: 1
@@ -12,15 +12,14 @@ jobs:
     name: Ruby ${{ matrix.ruby }}
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
+      - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
 
       - env:
           STREAM_CHAT_API_KEY: ${{ secrets.STREAM_CHAT_API_KEY }}
           STREAM_CHAT_API_SECRET: ${{ secrets.STREAM_CHAT_API_SECRET }}
         run: |
-          gem install bundler
-          bundle install --jobs 4 --retry 3
           bundle exec rake rubocop
           bundle exec rake test

data/CHANGELOG.md

@@ -1,3 +1,35 @@
+## November 17th, 2021 - 2.13.0
+
+- Add support for shadow banning user
+  - shadow_ban
+  - remove_shadow_ban
+- Add support for pinning messages
+  - pin_message
+  - unpin_message
+- Add support for partial updating messages
+  - update_message_partial
+- Add support for updating channel ownership for Deleted Users
+
+## November 1st, 2021 - 2.12.0
+
+- Add support for async endpoints
+  - get_task
+  - delete_channels
+  - delete_users
+
+## October 22nd, 2021 - 2.11.3
+
+- Don't log the entire response when creating exception
+- Access error details through StreamAPIException class attr_readers
+
+## October 5th, 2021 - 2.11.2
+
+- Add Codeowners file
+- Fix StreamChannelException raises
+- Fix rubocop linting error
+- Fix channel export test
+- Update Github action
+
 ## August 23rd, 2021 - 2.11.1
 
 - Use edge as base url

data/lib/stream-chat/channel.rb

@@ -19,7 +19,7 @@ module StreamChat
     end
 
     def url
-      raise StreamChannelException 'channel does not have an id' if @id.nil?
+      raise StreamChannelException, 'channel does not have an id' if @id.nil?
 
       "channels/#{@channel_type}/#{@id}"
     end
@@ -85,7 +85,7 @@ module StreamChat
     end
 
     def update_partial(set = nil, unset = nil)
-      raise StreamChannelException 'set or unset is needed' if set.nil? && unset.nil?
+      raise StreamChannelException, 'set or unset is needed' if set.nil? && unset.nil?
 
       payload = { set: set, unset: unset }
       @client.patch(url, data: payload)

data/lib/stream-chat/client.rb

@@ -12,6 +12,8 @@ require 'stream-chat/util'
 
 module StreamChat
   DEFAULT_BLOCKLIST = 'profanity_en_2020_v1'
+  SOFT_DELETE = 'soft'
+  HARD_DELETE = 'hard'
 
   class Client
     BASE_URL = 'https://chat.stream-io-api.com'
@@ -158,6 +160,16 @@ module StreamChat
       delete('moderation/ban', params: params)
     end
 
+    def shadow_ban(target_id, **options)
+      payload = { target_user_id: target_id, shadow: true }.merge(options)
+      post('moderation/ban', data: payload)
+    end
+
+    def remove_shadow_ban(target_id, **options)
+      params = { target_user_id: target_id, shadow: true }.merge(options)
+      delete('moderation/ban', params: params)
+    end
+
     def mute_user(target_id, user_id)
       payload = { target_id: target_id, user_id: user_id }
       post('moderation/mute', data: payload)
@@ -173,12 +185,37 @@ module StreamChat
       post('channels/read', data: payload)
     end
 
+    def pin_message(message_id, user_id, expiration: nil)
+      updates = {
+        set: {
+          pinned: true,
+          pin_expires: expiration
+        }
+      }
+      update_message_partial(message_id, updates, user_id: user_id)
+    end
+
+    def unpin_message(message_id, user_id)
+      updates = {
+        set: {
+          pinned: false
+        }
+      }
+      update_message_partial(message_id, updates, user_id: user_id)
+    end
+
     def update_message(message)
       raise ArgumentError 'message must have an id' unless message.key? 'id'
 
       post("messages/#{message['id']}", data: { message: message })
     end
 
+    def update_message_partial(message_id, updates, user_id: nil, **options)
+      params = updates.merge(options)
+      params['user'] = { id: user_id } if user_id
+      put("messages/#{message_id}", data: params)
+    end
+
     def delete_message(message_id)
       delete("messages/#{message_id}")
     end
@@ -293,6 +330,18 @@ module StreamChat
       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 })
@@ -413,7 +462,7 @@ module StreamChat
       headers['Authorization'] = @auth_token
       headers['stream-auth-type'] = 'jwt'
       url = [@base_url, relative_url].join('/')
-      params = params.nil? ? {} : params
+      params = {} if params.nil?
       params = (get_default_params.merge(params).sort_by { |k, _v| k.to_s }).to_h
       url = "#{url}?#{URI.encode_www_form(params)}"
 

data/lib/stream-chat/errors.rb

@@ -4,10 +4,12 @@
 
 module StreamChat
   class StreamAPIException < StandardError
+    attr_reader :error_code
+    attr_reader :error_message
+
     def initialize(response)
       super()
       @response = response
-      p response
       begin
         parsed_response = JSON.parse(response.body)
         @json_response = true
@@ -25,6 +27,14 @@ module StreamChat
         "StreamChat error HTTP code: #{@response.status}"
       end
     end
+
+    def json_response?
+      @json_response
+    end
+
+    def to_s
+      message
+    end
   end
 
   class StreamChannelException < StandardError; end

data/lib/stream-chat/version.rb

@@ -3,5 +3,5 @@
 # lib/version.rb
 
 module StreamChat
-  VERSION = '2.11.1'
+  VERSION = '2.13.0'
 end

data/stream-chat.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'simplecov'
+  gem.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stream-chat-ruby
 version: !ruby/object:Gem::Version
-  version: 2.11.1
+  version: 2.13.0
 platform: ruby
 authors:
 - Mircea Cosbuc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-23 00:00:00.000000000 Z
+date: 2021-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -86,6 +86,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CODEOWNERS"
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
@@ -104,7 +105,8 @@ files:
 - stream-chat.gemspec
 homepage: http://github.com/GetStream/stream-chat-ruby
 licenses: []
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -120,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: The low level client for serverside calls for Stream Chat.