stream-chat-ruby 2.1.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b1c2b73dbb2e8e0e65aaa47da051ad41694ae5faf6c1d6d1de9e368d9f6bea6
-  data.tar.gz: 45a43c071349a05ce38a9df5840182ce299f3c41942c351dfb033aad314bba32
+  metadata.gz: e7f6c91605363e141dcbaeaf6818c8fb8b32266c6afc652a84785c488a4d5227
+  data.tar.gz: eeeaec08c0c1eb776010740264b056689c9bb32983dbdf89a434e2527c9c928e
 SHA512:
-  metadata.gz: 37f5d1762e3185a5a92698b0e3ea9f8358d21a5d90c9683387b29a8b64e31e6548d1ac3090bf111b83175e1a228ecf6ed711123e9b080ea01332de5d8d33a9d4
-  data.tar.gz: 68eb7fee75f01cae1d684fd4c9f51354914656193e4681d2d8a398659613f45bbf37f2322874d01e12f41a395f9a6f68431586a36b1c7094ccf770d85012c3eb
+  metadata.gz: a4e2fd98ecab0fb43f91141e175d71677248cb0e5869184b91e6d5d1b182610953f3e0762396cdc8a2f663d949fd26449e336157c58dcd8c0b3a4a0c96a9d2e2
+  data.tar.gz: 07f07ffd865cb2b9efbf89ca2827e7e49f949c1b045102a2ce70a6654590079217bc60d8f0709989d3cbc71ac109ec4cbacf32dc856aa43bc2c18bb60712d04f

data/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: build
+
+on: [pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.5', '2.6', '2.7' ]
+    name: Ruby ${{ matrix.ruby }} sample
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - 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
+          bundle exec rake rubocop
+          bundle exec rake test

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+## 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
+- Fix issues from the latest version of rubocop
+- Move to GitHub Actions
+
 ## October 5th, 2020 - 2.1.0
 - Add support for blocklist
 
@@ -15,13 +38,11 @@
 - 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,6 +1,6 @@
 # stream-chat-ruby
 
-[![Build Status](https://travis-ci.com/GetStream/stream-chat-ruby.svg?branch=master)](https://travis-ci.com/GetStream/stream-chat-ruby) [![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.
 
@@ -14,7 +14,7 @@ Android SDK libraries (https://getstream.io/chat/).
 
 stream-chat-ruby supports:
 
-- Ruby (2.6, 2.5, 2.4, 2.3)
+- Ruby (2.7, 2.6, 2.5)
 
 #### Install
 
@@ -28,15 +28,16 @@ gem install stream-chat-ruby
 
 ### Supported features
 
-- Chat channels
+- Chat channel type, channels and members
 - Messages
-- Chat channel types
 - User management
 - Moderation API
 - Push configuration
 - User devices
 - User search
 - Channel search
+- Blocklists
+- Export channels
 
 ### Import
 
@@ -129,6 +130,17 @@ chan.unban_user('bob-1')
 
 # Query channel state
 chan.query({'messages' => { 'limit' => 10, 'id_lte' => m1['id']}})
+
+# Update metadata (overwrite)
+chan.update({'motd' => 'one apple a day....'})
+
+# Update partial
+# 1. key-value pairs to set
+# 2. keys to unset (remove)
+chan.update_partial({color: 'blue', age: 30}, ['motd'])
+
+# Query channel members
+chan.query_members({name: {'$autocomplete': 'test'}}, sort: {last_created_at: -1}, offset: 5, limit: 5)
 ```
 
 ### Messages
@@ -152,6 +164,43 @@ client.get_devices('jane-77')
 client.remove_device(jane_phone['id'], jane_phone['user_id'])
 ```
 
+### Blocklists
+```ruby
+# Create a blocklist
+client.create_blocklist('my_blocker', %w[fudge cream sugar])
+
+# Enable it on messaging channel type
+client.update_channel_type('messaging', blocklist: 'my_blocker', blocklist_behavior: 'block')
+
+# Get the details of the blocklist
+client.get_blocklist('my_blocker')
+
+# Delete the blocklist
+client.delete_blocklist('my_blocker')
+```
+
+### Export Channels
+```ruby
+# Register an export
+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'
+```
+
+### 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/channel.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 require 'stream-chat/errors'
+require 'stream-chat/util'
 
 module StreamChat
   class Channel # rubocop:todo Metrics/ClassLength # rubocop:todo Style/Documentation
     attr_reader :id
     attr_reader :channel_type
     attr_reader :custom_data
+    attr_reader :members
 
     def initialize(client, channel_type, channel_id = nil, custom_data = nil)
       @channel_type = channel_type
@@ -23,7 +25,7 @@ module StreamChat
     end
 
     def send_message(message, user_id)
-      payload = { "message": add_user_id(message, user_id) }
+      payload = { message: add_user_id(message, user_id) }
       @client.post("#{url}/message", data: payload)
     end
 
@@ -33,24 +35,24 @@ module StreamChat
     end
 
     def send_reaction(message_id, reaction, user_id)
-      payload = { "reaction": add_user_id(reaction, user_id) }
+      payload = { reaction: add_user_id(reaction, user_id) }
       @client.post("messages/#{message_id}/reaction", data: payload)
     end
 
     def delete_reaction(message_id, reaction_type, user_id)
       @client.delete(
         "messages/#{message_id}/reaction/#{reaction_type}",
-        params: { "user_id": user_id }
+        params: { user_id: user_id }
       )
     end
 
     def create(user_id)
-      @custom_data['created_by'] = { "id": user_id }
+      @custom_data['created_by'] = { id: user_id }
       query(watch: false, state: false, presence: false)
     end
 
     def query(**options)
-      payload = { "state": true, "data": @custom_data }.merge(options)
+      payload = { state: true, data: @custom_data }.merge(options)
       url = "channels/#{@channel_type}"
       url = "#{url}/#{@id}" unless @id.nil?
 
@@ -59,11 +61,36 @@ module StreamChat
       state
     end
 
+    def query_members(filter_conditions = {}, sort: nil, **options)
+      params = {}.merge(options).merge({
+                                         id: @id,
+                                         type: @channel_type,
+                                         filter_conditions: filter_conditions,
+                                         sort: get_sort_fields(sort)
+                                       })
+
+      if @id == '' && @members.length.positive?
+        params['members'] = []
+        @members&.each do |m|
+          params['members'] << m['user'].nil? ? m['user_id'] : m['user']['id']
+        end
+      end
+
+      @client.get('members', params: { payload: params.to_json })
+    end
+
     def update(channel_data, update_message = nil)
-      payload = { "data": channel_data, "message": update_message }
+      payload = { data: channel_data, message: update_message }
       @client.post(url, data: payload)
     end
 
+    def update_partial(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)
+    end
+
     def delete
       @client.delete(url)
     end
@@ -73,23 +100,23 @@ module StreamChat
     end
 
     def add_members(user_ids)
-      @client.post(url, data: { "add_members": user_ids })
+      @client.post(url, data: { add_members: user_ids })
     end
 
     def invite_members(user_ids)
-      @client.post(url, data: { "invites": user_ids })
+      @client.post(url, data: { invites: user_ids })
     end
 
     def add_moderators(user_ids)
-      @client.post(url, data: { "add_moderators": user_ids })
+      @client.post(url, data: { add_moderators: user_ids })
     end
 
     def remove_members(user_ids)
-      @client.post(url, data: { "remove_members": user_ids })
+      @client.post(url, data: { remove_members: user_ids })
     end
 
     def demote_moderators(user_ids)
-      @client.post(url, data: { "demote_moderators": user_ids })
+      @client.post(url, data: { demote_moderators: user_ids })
     end
 
     def mark_read(user_id, **options)
@@ -130,17 +157,17 @@ module StreamChat
     end
 
     def delete_file(url)
-      @client.delete("#{self.url}/file", params: { "url": url })
+      @client.delete("#{self.url}/file", params: { url: url })
     end
 
     def delete_image(url)
-      @client.delete("#{self.url}/image", params: { "url": url })
+      @client.delete("#{self.url}/image", params: { url: url })
     end
 
     private
 
     def add_user_id(payload, user_id)
-      payload.merge({ "user": { "id": user_id } })
+      payload.merge({ user: { id: user_id } })
     end
   end
 end

data/lib/stream-chat/client.rb

@@ -7,8 +7,11 @@ require 'jwt'
 require 'stream-chat/channel'
 require 'stream-chat/errors'
 require 'stream-chat/version'
+require 'stream-chat/util'
 
 module StreamChat
+  DEFAULT_BLOCKLIST = 'profanity_en_2020_v1'
+
   class Client
     BASE_URL = 'https://chat-us-east-1.stream-io-api.com'
 
@@ -57,22 +60,22 @@ module StreamChat
     end
 
     def flag_message(id, **options)
-      payload = { 'target_message_id': id }.merge(options)
+      payload = { target_message_id: id }.merge(options)
       post('moderation/flag', data: payload)
     end
 
     def unflag_message(id, **options)
-      payload = { 'target_message_id': id }.merge(options)
+      payload = { target_message_id: id }.merge(options)
       post('moderation/unflag', data: payload)
     end
 
     def flag_user(id, **options)
-      payload = { 'target_user_id': id }.merge(options)
+      payload = { target_user_id: id }.merge(options)
       post('moderation/flag', data: payload)
     end
 
     def unflag_user(id, **options)
-      payload = { 'target_user_id': id }.merge(options)
+      payload = { target_user_id: id }.merge(options)
       post('moderation/unflag', data: payload)
     end
 
@@ -82,11 +85,11 @@ module StreamChat
 
     def search(filter_conditions, query, **options)
       params = options.merge({
-                               "filter_conditions": filter_conditions,
-                               "query": query
+                               filter_conditions: filter_conditions,
+                               query: query
                              })
 
-      get('search', params: { "payload": params.to_json })
+      get('search', params: { payload: params.to_json })
     end
 
     def update_users(users)
@@ -97,7 +100,7 @@ module StreamChat
 
         payload[id] = user
       end
-      post('users', data: { 'users': payload })
+      post('users', data: { users: payload })
     end
 
     def update_user(user)
@@ -105,7 +108,7 @@ module StreamChat
     end
 
     def update_users_partial(updates)
-      patch('users', data: { 'users': updates })
+      patch('users', data: { users: updates })
     end
 
     def update_user_partial(update)
@@ -129,34 +132,34 @@ module StreamChat
     end
 
     def ban_user(target_id, **options)
-      payload = { 'target_user_id': target_id }.merge(options)
+      payload = { target_user_id: target_id }.merge(options)
       post('moderation/ban', data: payload)
     end
 
     def unban_user(target_id, **options)
-      params = { 'target_user_id': target_id }.merge(options)
+      params = { target_user_id: target_id }.merge(options)
       delete('moderation/ban', params: params)
     end
 
     def mute_user(target_id, user_id)
-      payload = { 'target_id': target_id, 'user_id': user_id }
+      payload = { target_id: target_id, user_id: user_id }
       post('moderation/mute', data: payload)
     end
 
     def unmute_user(target_id, user_id)
-      payload = { 'target_id': target_id, 'user_id': user_id }
+      payload = { target_id: target_id, user_id: user_id }
       post('moderation/unmute', data: payload)
     end
 
     def mark_all_read(user_id)
-      payload = { 'user': { 'id': user_id } }
+      payload = { user: { id: user_id } }
       post('channels/read', data: payload)
     end
 
     def update_message(message)
       raise ArgumentError 'message must have an id' unless message.key? 'id'
 
-      post("messages/#{message['id']}", data: { 'message': message })
+      post("messages/#{message['id']}", data: { message: message })
     end
 
     def delete_message(message_id)
@@ -164,28 +167,20 @@ module StreamChat
     end
 
     def query_users(filter_conditions, sort: nil, **options)
-      sort_fields = []
-      sort&.each do |k, v|
-        sort_fields << { "field": k, "direction": v }
-      end
       params = options.merge({
-                               "filter_conditions": filter_conditions,
-                               "sort": sort_fields
+                               filter_conditions: filter_conditions,
+                               sort: get_sort_fields(sort)
                              })
-      get('users', params: { "payload": params.to_json })
+      get('users', params: { payload: params.to_json })
     end
 
     def query_channels(filter_conditions, sort: nil, **options)
-      params = { "state": true, "watch": false, "presence": false }
-      sort_fields = []
-      sort&.each do |k, v|
-        sort_fields << { "field": k, "direction": v }
-      end
-      params = params.merge(options).merge({
-                                             "filter_conditions": filter_conditions,
-                                             "sort": sort_fields
-                                           })
-      get('channels', params: { "payload": params.to_json })
+      data = { state: true, watch: false, presence: false }
+      data = data.merge(options).merge({
+                                         filter_conditions: filter_conditions,
+                                         sort: get_sort_fields(sort)
+                                       })
+      post('channels', data: data)
     end
 
     def create_channel_type(data)
@@ -223,18 +218,29 @@ module StreamChat
 
     def add_device(device_id, push_provider, user_id)
       post('devices', data: {
-             "id": device_id,
-             "push_provider": push_provider,
-             "user_id": user_id
+             id: device_id,
+             push_provider: push_provider,
+             user_id: user_id
            })
     end
 
     def delete_device(device_id, user_id)
-      delete('devices', params: { "id": device_id, "user_id": user_id })
+      delete('devices', params: { id: device_id, user_id: user_id })
     end
 
     def get_devices(user_id)
-      get('devices', params: { "user_id": user_id })
+      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)
@@ -251,17 +257,25 @@ module StreamChat
     end
 
     def create_blocklist(name, words)
-      post('blocklists', data: { "name": name, "words": words })
+      post('blocklists', data: { name: name, words: words })
     end
 
     def update_blocklist(name, words)
-      put("blocklists/#{name}", data: { "words": words })
+      put("blocklists/#{name}", data: { words: words })
     end
 
     def delete_blocklist(name)
       delete("blocklists/#{name}")
     end
 
+    def export_channels(*channels)
+      post('export_channels', data: { channels: channels })
+    end
+
+    def get_export_channel_status(task_id)
+      get("export_channels/#{task_id}")
+    end
+
     def put(relative_url, params: nil, data: nil)
       make_http_request(:put, relative_url, params: params, data: data)
     end
@@ -301,6 +315,10 @@ module StreamChat
       parse_response(response)
     end
 
+    def check_sqs(sqs_key = nil, sqs_secret = nil, sqs_url = nil)
+      post('check_sqs', data: { sqs_key: sqs_key, sqs_secret: sqs_secret, sqs_url: sqs_url })
+    end
+
     private
 
     def get_default_params
@@ -334,8 +352,8 @@ module StreamChat
       headers['Authorization'] = @auth_token
       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 = params.nil? ? {} : params
+      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/errors.rb

@@ -26,5 +26,6 @@ module StreamChat
       end
     end
   end
+
   class StreamChannelException < StandardError; end
 end

data/lib/stream-chat/util.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# lib/util.rb
+
+def get_sort_fields(sort)
+  sort_fields = []
+  sort&.each do |k, v|
+    sort_fields << { field: k, direction: v }
+  end
+  sort_fields
+end

data/lib/stream-chat/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stream-chat-ruby
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Mircea Cosbuc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-05 00:00:00.000000000 Z
+date: 2021-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -86,9 +86,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -99,6 +99,7 @@ files:
 - lib/stream-chat/channel.rb
 - lib/stream-chat/client.rb
 - lib/stream-chat/errors.rb
+- lib/stream-chat/util.rb
 - lib/stream-chat/version.rb
 - stream-chat.gemspec
 homepage: http://github.com/GetStream/stream-chat-ruby

data/.travis.yml

@@ -1,10 +0,0 @@
-language: ruby
-before_install:
-  - gem update bundler
-rvm:
-  - 2.5
-  - 2.6
-  - 2.7
-script:
-  - bundle exec rake rubocop
-  - bundle exec rake test