stream-chat-ruby 2.5.0 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cff8888b576ad92ca17c3275504e585b1490e3935e7d86595aad795dfea67a7d
-  data.tar.gz: 8aa309ce84be59f966edee13e0e8957f863f59c535bc8df9d41d90484e8b1cb5
+  metadata.gz: 99eb51b056c6265c10b7452897fef2ac5691def3e80819692c7755574b7e7672
+  data.tar.gz: 644d0384df490767e94588f1f76b0f0f0bd5012a1dfb9b2490c375e67dd6eacf
 SHA512:
-  metadata.gz: 9ca7b965ba2ca2fdffcb3ff667d93a1081e5aa15f40d3aeb9a167c945f26e54d3e773e826ca583c445c0da02acb5f67f3c450d7fc3fce98fcb958acd7e9077cf
-  data.tar.gz: 98b040deb4906b952d393244fb228843e77d669481104fa0ca75512cdcaacfccd75d8733c9ade31854366ab066ff6c58a54d2ff3c89e6c590d5a8c9fdc17c888
+  metadata.gz: f172bdeebb0ddde0b55827be7f20ab72af074782ea2af5db7ad0bbda97f6d6abbc8b83e3098fdb34eb5b4312018320df42463a9a7ecc20afec370c8daefb0c0b
+  data.tar.gz: 70e907012a5fe56e57b5ec52a76a5ab24dfef914afe27e82eee6c47f22d701354ee2ba1bd057cb00da0dcc39f71d4a0edfcf70a60020aa3215f3aa6fa2907923

data/.github/workflows/ci.yml

@@ -6,9 +6,10 @@ jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
+      max-parallel: 1
       matrix:
-        ruby: [ '2.5', '2.6', '2.7' ]
-    name: Ruby ${{ matrix.ruby }} sample
+        ruby: ['2.5', '2.6', '2.7', '3.0']
+    name: Ruby ${{ matrix.ruby }}
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-ruby@v1
@@ -18,7 +19,6 @@ jobs:
       - env:
           STREAM_CHAT_API_KEY: ${{ secrets.STREAM_CHAT_API_KEY }}
           STREAM_CHAT_API_SECRET: ${{ secrets.STREAM_CHAT_API_SECRET }}
-          BLOCKLIST: ${{ matrix.ruby == '2.7' }}
         run: |
           gem install bundler
           bundle install --jobs 4 --retry 3

data/.gitignore

@@ -48,3 +48,4 @@ Gemfile.lock
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+.envrc

data/CHANGELOG.md

@@ -1,17 +1,46 @@
+## June 25th, 2021 - 2.11.0
+
+- Add support for improved search
+
+## June 4th, 2021 - 2.10.0
+
+- Add custom command CRUD support
+
+## May 31st, 2021 - 2.9.0
+
+- Add support for app and user level token revoke
+
+## May 21st, 2021 - 2.8.0
+
+- Add query message flags support
+
+## March 17th, 2021 - 2.7.0
+
+- Add Ruby 3.x support
+- Update CI to run all tests for all versions
+
+## March 9th, 2021 - 2.6.0
+
+- Add get_rate_limits endpoint
+
 ## February 3rd, 2021 - 2.5.0
+
 - Add channel partial update
 - Increase convenience in query members
 - Improve internal symbol conversions
 
 ## January 20th, 2021 - 2.4.0
+
 - Add query_members to channel
 - Use post endpoint for query channels instead of get
 - Extract common code for sorting into a helper for query calls
 
 ## January 5th, 2021 - 2.3.0
+
 - Add check SQS helper
 
 ## January 4th, 2021 - 2.2.0
+
 - Add support for export channels
 - Improve readme for blocklist and export channels
 - Improve running tests for multiple versions of ruby
@@ -19,27 +48,34 @@
 - Move to GitHub Actions
 
 ## October 5th, 2020 - 2.1.0
+
 - Add support for blocklist
 
 ## October 2nd, 2020 - 2.0.0
+
 - Drop EOL Ruby versions: 2.3 && 2.4
 - Setup Rubocop and mark string literals as frozen
 
 ## August 3rd, 2020 - 1.1.3
+
 - Fixed Argument Error on delete_user
 
 ## April 23th, 2020 - 1.1.2
+
 - Fixed ArgumentError when no users was passed
 
 ## March 30th, 2020 - 1.1.1
+
 - Fixed few minor issues
 
 ## Oct 27th, 2019 - 1.1.0
+
 - Mark gems use for testing as development dependencies
 - Added `send_file`, `send_image`, `delete_file`, `delete_image`
 - Added `invite_members`
 
 ## Oct 19th, 2019 - 1.0.0
+
 - Added `channel.hide` and `channel.show`
 - Added `client.flag_message` and `client.unflag_message`
 - Added `client.flag_user` and `client.unflag_user`

data/README.md

@@ -1,20 +1,20 @@
 # stream-chat-ruby
 
- [![build](https://github.com/GetStream/stream-chat-ruby/workflows/build/badge.svg)](https://github.com/GetStream/stream-chat-ruby/actions) [![Gem Version](https://badge.fury.io/rb/stream-chat-ruby.svg)](http://badge.fury.io/rb/stream-chat-ruby)
+[![build](https://github.com/GetStream/stream-chat-ruby/workflows/build/badge.svg)](https://github.com/GetStream/stream-chat-ruby/actions) [![Gem Version](https://badge.fury.io/rb/stream-chat-ruby.svg)](http://badge.fury.io/rb/stream-chat-ruby)
 
 stream-chat-ruby is the official Ruby client for [Stream chat](https://getstream.io/chat/) a service for building chat applications.
 
 You can sign up for a Stream account at https://getstream.io/chat/get_started/.
 
 You can use this library to access chat API endpoints server-side. For the
-client-side integrations (web and mobile) have a look at the Javascript, iOS and
+client-side integrations (web and mobile) have a look at the JavaScript, iOS and
 Android SDK libraries (https://getstream.io/chat/).
 
 ### Installation
 
 stream-chat-ruby supports:
 
-- Ruby (2.7, 2.6, 2.5)
+- Ruby (3.0, 2.7, 2.6, 2.5)
 
 #### Install
 
@@ -165,6 +165,7 @@ client.remove_device(jane_phone['id'], jane_phone['user_id'])
 ```
 
 ### Blocklists
+
 ```ruby
 # Create a blocklist
 client.create_blocklist('my_blocker', %w[fudge cream sugar])
@@ -180,6 +181,7 @@ client.delete_blocklist('my_blocker')
 ```
 
 ### Export Channels
+
 ```ruby
 # Register an export
 response = client.export_channels({type: 'messaging', id: 'jane'})
@@ -189,6 +191,19 @@ status_response = client.get_export_channel_status(response['task_id'])
 # status_response['status'] == 'pending', 'completed'
 ```
 
+### Rate limits
+
+```ruby
+# Get all rate limits
+limits = client.get_rate_limits
+
+# Get rate limits for specific platform(s)
+limits = client.get_rate_limits(server_side: true)
+
+# Get rate limits for specific platforms and endpoints
+limits = client.get_rate_limits(android: true, ios: true, endpoints: ['QueryChannels', 'SendMessage'])
+```
+
 ### Example Rails application
 
 See [an example rails application using the Ruby SDK](https://github.com/GetStream/rails-chat-example).

data/lib/stream-chat/client.rb

@@ -4,6 +4,7 @@
 require 'open-uri'
 require 'faraday'
 require 'jwt'
+require 'time'
 require 'stream-chat/channel'
 require 'stream-chat/errors'
 require 'stream-chat/version'
@@ -45,9 +46,10 @@ module StreamChat
       end
     end
 
-    def create_token(user_id, exp = nil)
+    def create_token(user_id, exp = nil, iat = nil)
       payload = { user_id: user_id }
       payload['exp'] = exp unless exp.nil?
+      payload['iat'] = iat unless iat.nil?
       JWT.encode(payload, @api_secret, 'HS256')
     end
 
@@ -69,6 +71,13 @@ module StreamChat
       post('moderation/unflag', data: payload)
     end
 
+    def query_message_flags(filter_conditions, **options)
+      params = options.merge({
+                               filter_conditions: filter_conditions
+                             })
+      get('moderation/flags/message', params: { payload: params.to_json })
+    end
+
     def flag_user(id, **options)
       payload = { target_user_id: id }.merge(options)
       post('moderation/flag', data: payload)
@@ -83,13 +92,21 @@ module StreamChat
       get("messages/#{id}")
     end
 
-    def search(filter_conditions, query, **options)
-      params = options.merge({
-                               filter_conditions: filter_conditions,
-                               query: query
-                             })
+    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?))
 
-      get('search', params: { payload: params.to_json })
+      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)
@@ -232,6 +249,17 @@ module StreamChat
       get('devices', params: { user_id: user_id })
     end
 
+    def get_rate_limits(server_side: false, android: false, ios: false, web: false, endpoints: [])
+      params = {}
+      params['server_side'] = server_side if server_side
+      params['android'] = android if android
+      params['ios'] = ios if ios
+      params['web'] = web if web
+      params['endpoints'] = endpoints.join(',') unless endpoints.empty?
+
+      get('rate_limits', params: params)
+    end
+
     def verify_webhook(request_body, x_signature)
       signature = OpenSSL::HMAC.hexdigest('SHA256', @api_secret, request_body)
       signature == x_signature
@@ -265,6 +293,30 @@ module StreamChat
       get("export_channels/#{task_id}")
     end
 
+    def revoke_tokens(before)
+      before = before.rfc3339 if before.instance_of?(DateTime)
+      update_app_settings({ 'revoke_tokens_issued_before' => before })
+    end
+
+    def revoke_user_token(user_id, before)
+      revoke_users_token([user_id], before)
+    end
+
+    def revoke_users_token(user_ids, before)
+      before = before.rfc3339 if before.instance_of?(DateTime)
+
+      updates = []
+      user_ids.each do |user_id|
+        updates.push({
+                       'id' => user_id,
+                       'set' => {
+                         'revoke_tokens_issued_before' => before
+                       }
+                     })
+      end
+      update_users_partial(updates)
+    end
+
     def put(relative_url, params: nil, data: nil)
       make_http_request(:put, relative_url, params: params, data: data)
     end
@@ -308,6 +360,26 @@ module StreamChat
       post('check_sqs', data: { sqs_key: sqs_key, sqs_secret: sqs_secret, sqs_url: sqs_url })
     end
 
+    def create_command(command)
+      post('commands', data: command)
+    end
+
+    def get_command(name)
+      get("commands/#{name}")
+    end
+
+    def update_command(name, command)
+      put("commands/#{name}", data: command)
+    end
+
+    def delete_command(name)
+      delete("commands/#{name}")
+    end
+
+    def list_commands
+      get('commands')
+    end
+
     private
 
     def get_default_params
@@ -320,8 +392,8 @@ module StreamChat
 
     def get_default_headers
       {
-        "Content-Type": 'application/json',
-        "X-Stream-Client": get_user_agent
+        'Content-Type': 'application/json',
+        'X-Stream-Client': get_user_agent
       }
     end
 
@@ -342,7 +414,7 @@ module StreamChat
       headers['stream-auth-type'] = 'jwt'
       url = [@base_url, relative_url].join('/')
       params = params.nil? ? {} : params
-      params = Hash[get_default_params.merge(params).sort_by { |k, _v| k.to_s }]
+      params = (get_default_params.merge(params).sort_by { |k, _v| k.to_s }).to_h
       url = "#{url}?#{URI.encode_www_form(params)}"
 
       body = data.to_json if %w[patch post put].include? method.to_s

data/lib/stream-chat/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stream-chat-ruby
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.11.0
 platform: ruby
 authors:
 - Mircea Cosbuc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-02 00:00:00.000000000 Z
+date: 2021-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday