# typed: strict # frozen_string_literal: true require 'open-uri' require 'faraday' require 'faraday/multipart' require 'faraday/net_http_persistent' require 'jwt' require 'time' require 'sorbet-runtime' require 'stream-chat/channel' require 'stream-chat/errors' require 'stream-chat/stream_response' require 'stream-chat/version' require 'stream-chat/util' require 'stream-chat/types' module StreamChat DEFAULT_BLOCKLIST = 'profanity_en_2020_v1' SOFT_DELETE = 'soft' HARD_DELETE = 'hard' class Client extend T::Sig T::Configuration.default_checked_level = :never # For now we disable runtime type checks. # We will enable it with a major bump in the future, # but for now, let's just run a static type check. DEFAULT_BASE_URL = 'https://chat.stream-io-api.com' DEFAULT_TIMEOUT = 6.0 sig { returns(String) } attr_reader :api_key sig { returns(String) } attr_reader :api_secret sig { returns(Faraday::Connection) } attr_reader :conn # initializes a Stream Chat API Client # # @param [string] api_key your application api_key # @param [string] api_secret your application secret # @param [float] timeout the timeout for the http requests # @param [Hash] options extra options such as base_url # # @example initialized the client with a timeout setting # StreamChat::Client.new('my_key', 'my_secret', 3.0) # sig { params(api_key: String, api_secret: String, timeout: T.nilable(T.any(Float, String)), options: T.untyped).void } def initialize(api_key, api_secret, timeout = nil, **options) raise ArgumentError, 'api_key and api_secret are required' if api_key.to_s.empty? || api_secret.to_s.empty? @api_key = api_key @api_secret = api_secret @timeout = T.let(timeout&.to_f || DEFAULT_TIMEOUT, Float) @auth_token = T.let(JWT.encode({ server: true }, @api_secret, 'HS256'), String) @base_url = T.let(options[:base_url] || DEFAULT_BASE_URL, String) conn = Faraday.new(@base_url) do |faraday| faraday.options[:open_timeout] = @timeout faraday.options[:timeout] = @timeout faraday.request :multipart faraday.adapter :net_http_persistent, pool_size: 5 do |http| # AWS load balancer idle timeout is 60 secs, so let's make it 59 http.idle_timeout = 59 end end @conn = T.let(conn, Faraday::Connection) end # initializes a Stream Chat API Client from STREAM_KEY and STREAM_SECRET # environmental variables. STREAM_CHAT_TIMEOUT and STREAM_CHAT_URL # variables are optional. # @param [StringKeyHash] options extra options sig { params(options: T.untyped).returns(Client) } def self.from_env(**options) Client.new(T.must(ENV['STREAM_KEY']), T.must(ENV['STREAM_SECRET']), ENV['STREAM_CHAT_TIMEOUT'], **{ base_url: ENV['STREAM_CHAT_URL'] }.merge(options)) end # Sets the underlying Faraday http client. # # @param [client] an instance of Faraday::Connection sig { params(client: Faraday::Connection).void } def set_http_client(client) @conn = client end sig { params(user_id: String, exp: T.nilable(Integer), iat: T.nilable(Integer)).returns(String) } 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 sig { params(settings: T.untyped).returns(StreamChat::StreamResponse) } def update_app_settings(**settings) patch('app', data: settings) end sig { returns(StreamChat::StreamResponse) } def get_app_settings get('app') end sig { params(id: String, options: T.untyped).returns(StreamChat::StreamResponse) } def flag_message(id, **options) payload = { target_message_id: id }.merge(options) post('moderation/flag', data: payload) end sig { params(id: String, options: T.untyped).returns(StreamChat::StreamResponse) } def unflag_message(id, **options) payload = { target_message_id: id }.merge(options) post('moderation/unflag', data: payload) end sig { params(filter_conditions: StringKeyHash, options: T.untyped).returns(StreamChat::StreamResponse) } def query_message_flags(filter_conditions, **options) params = options.merge({ filter_conditions: filter_conditions }) get('moderation/flags/message', params: { payload: params.to_json }) end sig { params(id: String, options: T.untyped).returns(StreamChat::StreamResponse) } def flag_user(id, **options) payload = { target_user_id: id }.merge(options) post('moderation/flag', data: payload) end sig { params(id: String, options: T.untyped).returns(StreamChat::StreamResponse) } def unflag_user(id, **options) payload = { target_user_id: id }.merge(options) post('moderation/unflag', data: payload) end sig { params(options: T.untyped).returns(StreamChat::StreamResponse) } def query_flag_reports(**options) data = { filter_conditions: options } post('moderation/reports', data: data) end sig { params(report_id: String, review_result: String, user_id: String, details: T.untyped).returns(StreamChat::StreamResponse) } def review_flag_report(report_id, review_result, user_id, **details) data = { review_result: review_result, user_id: user_id, review_details: details } patch("moderation/reports/#{report_id}", data: data) end sig { params(id: String).returns(StreamChat::StreamResponse) } def get_message(id) get("messages/#{id}") end sig { params(filter_conditions: StringKeyHash, query: T.any(String, StringKeyHash), sort: T.nilable(T::Hash[String, Integer]), options: T.untyped).returns(StreamChat::StreamResponse) } def search(filter_conditions, query, sort: nil, **options) offset = T.cast(options[:offset], T.nilable(Integer)) next_value = options[:next] raise ArgumentError, 'cannot use offset with next or sort parameters' if offset&.positive? && (next_value || (!sort.nil? && !sort.empty?)) to_merge = { filter_conditions: filter_conditions, sort: StreamChat.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 # DEPRECATED: Please use upsert_users instead. sig { params(users: T::Array[StringKeyHash]).returns(StreamChat::StreamResponse) } def update_users(users) warn '[DEPRECATION] `update_users` is deprecated. Please use `upsert_users` instead.' upsert_users(users) end # DEPRECATED: Please use upsert_user instead. sig { params(user: StringKeyHash).returns(StreamChat::StreamResponse) } def update_user(user) warn '[DEPRECATION] `update_user` is deprecated. Please use `upsert_user` instead.' upsert_user(user) end sig { params(users: T::Array[StringKeyHash]).returns(StreamChat::StreamResponse) } def upsert_users(users) payload = {} users.each do |user| id = user[:id] || user['id'] raise ArgumentError, 'user must have an id' unless id payload[id] = user end post('users', data: { users: payload }) end sig { params(user: StringKeyHash).returns(StreamChat::StreamResponse) } def upsert_user(user) upsert_users([user]) end sig { params(updates: T::Array[StringKeyHash]).returns(StreamChat::StreamResponse) } def update_users_partial(updates) patch('users', data: { users: updates }) end sig { params(update: StringKeyHash).returns(StreamChat::StreamResponse) } def update_user_partial(update) update_users_partial([update]) end sig { params(user_id: String, options: T.untyped).returns(StreamChat::StreamResponse) } def delete_user(user_id, **options) delete("users/#{user_id}", params: options) end sig { params(user_id: String, options: T.untyped).returns(StreamChat::StreamResponse) } def deactivate_user(user_id, **options) post("users/#{user_id}/deactivate", params: options) end sig { params(user_id: String, options: T.untyped).returns(StreamChat::StreamResponse) } def reactivate_user(user_id, **options) post("users/#{user_id}/reactivate", params: options) end sig { params(user_id: String, options: T.untyped).returns(StreamChat::StreamResponse) } def export_user(user_id, **options) get("users/#{user_id}/export", params: options) end sig { params(target_id: String, options: T.untyped).returns(StreamChat::StreamResponse) } def ban_user(target_id, **options) payload = { target_user_id: target_id }.merge(options) post('moderation/ban', data: payload) end sig { params(target_id: String, options: T.untyped).returns(StreamChat::StreamResponse) } def unban_user(target_id, **options) params = { target_user_id: target_id }.merge(options) delete('moderation/ban', params: params) end sig { params(target_id: String, options: T.untyped).returns(StreamChat::StreamResponse) } def shadow_ban(target_id, **options) payload = { target_user_id: target_id, shadow: true }.merge(options) post('moderation/ban', data: payload) end sig { params(target_id: String, options: T.untyped).returns(StreamChat::StreamResponse) } def remove_shadow_ban(target_id, **options) params = { target_user_id: target_id, shadow: true }.merge(options) delete('moderation/ban', params: params) end sig { params(target_id: String, user_id: String).returns(StreamChat::StreamResponse) } def mute_user(target_id, user_id) payload = { target_id: target_id, user_id: user_id } post('moderation/mute', data: payload) end sig { params(target_id: String, user_id: String).returns(StreamChat::StreamResponse) } def unmute_user(target_id, user_id) payload = { target_id: target_id, user_id: user_id } post('moderation/unmute', data: payload) end sig { params(user_id: String).returns(StreamChat::StreamResponse) } def mark_all_read(user_id) payload = { user: { id: user_id } } post('channels/read', data: payload) end sig { params(message_id: String, user_id: String, expiration: T.nilable(String)).returns(StreamChat::StreamResponse) } 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 sig { params(message_id: String, user_id: String).returns(StreamChat::StreamResponse) } def unpin_message(message_id, user_id) updates = { set: { pinned: false } } update_message_partial(message_id, updates, user_id: user_id) end sig { params(message: StringKeyHash).returns(StreamChat::StreamResponse) } def update_message(message) raise ArgumentError, 'message must have an id' unless message.key? 'id' post("messages/#{message['id']}", data: { message: message }) end sig { params(message_id: String, updates: StringKeyHash, user_id: T.nilable(String), options: T.untyped).returns(StreamChat::StreamResponse) } 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 sig { params(message_id: String, options: T.untyped).returns(StreamChat::StreamResponse) } def delete_message(message_id, **options) delete("messages/#{message_id}", params: options) end sig { params(filter_conditions: StringKeyHash, sort: T.nilable(T::Hash[String, Integer]), options: T.untyped).returns(StreamChat::StreamResponse) } def query_banned_users(filter_conditions, sort: nil, **options) params = options.merge({ filter_conditions: filter_conditions, sort: StreamChat.get_sort_fields(sort) }) get('query_banned_users', params: { payload: params.to_json }) end sig { params(filter_conditions: StringKeyHash, sort: T.nilable(T::Hash[String, Integer]), options: T.untyped).returns(StreamChat::StreamResponse) } def query_users(filter_conditions, sort: nil, **options) params = options.merge({ filter_conditions: filter_conditions, sort: StreamChat.get_sort_fields(sort) }) get('users', params: { payload: params.to_json }) end sig { params(filter_conditions: StringKeyHash, sort: T.nilable(T::Hash[String, Integer]), options: T.untyped).returns(StreamChat::StreamResponse) } def query_channels(filter_conditions, sort: nil, **options) data = { state: true, watch: false, presence: false } data = data.merge(options).merge({ filter_conditions: filter_conditions, sort: StreamChat.get_sort_fields(sort) }) post('channels', data: data) end sig { params(data: StringKeyHash).returns(StreamChat::StreamResponse) } def create_channel_type(data) data['commands'] = ['all'] unless data.key?('commands') || data['commands'].nil? || data['commands'].empty? post('channeltypes', data: data) end sig { params(channel_type: String).returns(StreamChat::StreamResponse) } def get_channel_type(channel_type) get("channeltypes/#{channel_type}") end sig { returns(StreamChat::StreamResponse) } def list_channel_types get('channeltypes') end sig { params(channel_type: String, options: T.untyped).returns(StreamChat::StreamResponse) } def update_channel_type(channel_type, **options) put("channeltypes/#{channel_type}", data: options) end sig { params(channel_type: String).returns(StreamChat::StreamResponse) } def delete_channel_type(channel_type) delete("channeltypes/#{channel_type}") end # Creates a channel instance # # @param [string] channel_type the channel type # @param [string] channel_id the channel identifier # @param [StringKeyHash] data additional channel data # # @return [StreamChat::Channel] # sig { params(channel_type: String, channel_id: T.nilable(String), data: T.nilable(StringKeyHash)).returns(StreamChat::Channel) } def channel(channel_type, channel_id: nil, data: nil) StreamChat::Channel.new(self, channel_type, channel_id, data) end sig { params(device_id: String, push_provider: String, user_id: String, push_provider_name: T.nilable(String)).returns(StreamChat::StreamResponse) } def add_device(device_id, push_provider, user_id, push_provider_name = nil) post('devices', data: { id: device_id, push_provider: push_provider, push_provider_name: push_provider_name, user_id: user_id }) end sig { params(device_id: String, user_id: String).returns(StreamChat::StreamResponse) } def delete_device(device_id, user_id) delete('devices', params: { id: device_id, user_id: user_id }) end sig { params(user_id: String).returns(StreamChat::StreamResponse) } def get_devices(user_id) get('devices', params: { user_id: user_id }) end sig { params(server_side: T::Boolean, android: T::Boolean, ios: T::Boolean, web: T::Boolean, endpoints: T::Array[String]).returns(StreamChat::StreamResponse) } 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 sig { params(request_body: String, x_signature: String).returns(T::Boolean) } def verify_webhook(request_body, x_signature) signature = OpenSSL::HMAC.hexdigest('SHA256', @api_secret, request_body) signature == x_signature end sig { params(user_id: String, event: StringKeyHash).returns(StreamChat::StreamResponse) } def send_user_event(user_id, event) post("users/#{user_id}/event", data: event) end sig { params(message_id: String, language: String).returns(StreamChat::StreamResponse) } def translate_message(message_id, language) post("messages/#{message_id}/translate", data: { language: language }) end sig { params(message_id: String, data: StringKeyHash).returns(StreamChat::StreamResponse) } def run_message_action(message_id, data) post("messages/#{message_id}/action", data: data) end sig { params(user: StringKeyHash).returns(StreamChat::StreamResponse) } def create_guest(user) post('guests', data: user) end sig { returns(StreamChat::StreamResponse) } def list_blocklists get('blocklists') end sig { params(name: String).returns(StreamChat::StreamResponse) } def get_blocklist(name) get("blocklists/#{name}") end sig { params(name: String, words: StringKeyHash).returns(StreamChat::StreamResponse) } def create_blocklist(name, words) post('blocklists', data: { name: name, words: words }) end sig { params(name: String, words: StringKeyHash).returns(StreamChat::StreamResponse) } def update_blocklist(name, words) put("blocklists/#{name}", data: { words: words }) end sig { params(name: String).returns(StreamChat::StreamResponse) } def delete_blocklist(name) delete("blocklists/#{name}") end sig { params(channels: StringKeyHash, options: T.untyped).returns(StreamChat::StreamResponse) } def export_channels(*channels, **options) post('export_channels', data: { channels: channels, **options }) end sig { params(task_id: String).returns(StreamChat::StreamResponse) } def get_export_channel_status(task_id) get("export_channels/#{task_id}") end sig { params(task_id: String).returns(StreamChat::StreamResponse) } def get_task(task_id) get("tasks/#{task_id}") end sig { params(user_ids: T::Array[String], user: String, messages: T.nilable(StringKeyHash), conversations: T.nilable(String)).returns(StreamChat::StreamResponse) } 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 sig { params(cids: T::Array[String], hard_delete: T::Boolean).returns(StreamChat::StreamResponse) } def delete_channels(cids, hard_delete: false) post('channels/delete', data: { cids: cids, hard_delete: hard_delete }) end sig { params(before: T.any(DateTime, String)).returns(StreamChat::StreamResponse) } def revoke_tokens(before) before = T.cast(before, DateTime).rfc3339 if before.instance_of?(DateTime) update_app_settings({ 'revoke_tokens_issued_before' => before }) end sig { params(user_id: String, before: T.any(DateTime, String)).returns(StreamChat::StreamResponse) } def revoke_user_token(user_id, before) revoke_users_token([user_id], before) end sig { params(user_ids: T::Array[String], before: T.any(DateTime, String)).returns(StreamChat::StreamResponse) } def revoke_users_token(user_ids, before) before = T.cast(before, DateTime).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 sig { params(relative_url: String, params: T.nilable(StringKeyHash), data: T.nilable(StringKeyHash)).returns(StreamChat::StreamResponse) } def put(relative_url, params: nil, data: nil) make_http_request(:put, relative_url, params: params, data: data) end sig { params(relative_url: String, params: T.nilable(StringKeyHash), data: T.nilable(StringKeyHash)).returns(StreamChat::StreamResponse) } def post(relative_url, params: nil, data: nil) make_http_request(:post, relative_url, params: params, data: data) end sig { params(relative_url: String, params: T.nilable(StringKeyHash)).returns(StreamChat::StreamResponse) } def get(relative_url, params: nil) make_http_request(:get, relative_url, params: params) end sig { params(relative_url: String, params: T.nilable(StringKeyHash)).returns(StreamChat::StreamResponse) } def delete(relative_url, params: nil) make_http_request(:delete, relative_url, params: params) end sig { params(relative_url: String, params: T.nilable(StringKeyHash), data: T.nilable(StringKeyHash)).returns(StreamChat::StreamResponse) } def patch(relative_url, params: nil, data: nil) make_http_request(:patch, relative_url, params: params, data: data) end sig { params(relative_url: String, file_url: String, user: StringKeyHash, content_type: T.nilable(String)).returns(StreamChat::StreamResponse) } def send_file(relative_url, file_url, user, content_type = nil) url = [@base_url, relative_url].join('/') body = { user: user.to_json } body[:file] = Faraday::UploadIO.new(file_url, content_type || 'application/octet-stream') response = @conn.post url do |req| req.headers['X-Stream-Client'] = get_user_agent req.headers['Authorization'] = @auth_token req.headers['stream-auth-type'] = 'jwt' req.params = get_default_params req.body = body end parse_response(response) end sig { params(push_data: StringKeyHash).returns(StreamChat::StreamResponse) } def check_push(push_data) post('check_push', data: push_data) end sig { params(sqs_key: T.nilable(String), sqs_secret: T.nilable(String), sqs_url: T.nilable(String)).returns(StreamChat::StreamResponse) } 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 sig { params(command: StringKeyHash).returns(StreamChat::StreamResponse) } def create_command(command) post('commands', data: command) end sig { params(name: String).returns(StreamChat::StreamResponse) } def get_command(name) get("commands/#{name}") end sig { params(name: String, command: StringKeyHash).returns(StreamChat::StreamResponse) } def update_command(name, command) put("commands/#{name}", data: command) end sig { params(name: String).returns(StreamChat::StreamResponse) } def delete_command(name) delete("commands/#{name}") end sig { returns(StreamChat::StreamResponse) } def list_commands get('commands') end sig { returns(StreamChat::StreamResponse) } def list_permissions get('permissions') end sig { params(id: String).returns(StreamChat::StreamResponse) } def get_permission(id) get("permissions/#{id}") end sig { params(permission: StringKeyHash).returns(StreamChat::StreamResponse) } def create_permission(permission) post('permissions', data: permission) end sig { params(id: String, permission: StringKeyHash).returns(StreamChat::StreamResponse) } def update_permission(id, permission) put("permissions/#{id}", data: permission) end sig { params(id: String).returns(StreamChat::StreamResponse) } def delete_permission(id) delete("permissions/#{id}") end sig { params(name: String).returns(StreamChat::StreamResponse) } def create_role(name) post('roles', data: { name: name }) end sig { params(name: String).returns(StreamChat::StreamResponse) } def delete_role(name) delete("roles/#{name}") end sig { returns(StreamChat::StreamResponse) } def list_roles get('roles') end sig { params(push_provider: StringKeyHash).returns(StreamChat::StreamResponse) } def upsert_push_provider(push_provider) post('push_providers', data: { push_provider: push_provider }) end sig { params(type: String, name: String).returns(StreamChat::StreamResponse) } def delete_push_provider(type, name) delete("push_providers/#{type}/#{name}") end sig { returns(StreamChat::StreamResponse) } def list_push_providers get('push_providers') end private sig { returns(T::Hash[String, String]) } def get_default_params { api_key: @api_key } end sig { returns(String) } def get_user_agent "stream-ruby-client-#{StreamChat::VERSION}" end sig { returns(T::Hash[String, String]) } def get_default_headers { 'Content-Type': 'application/json', 'X-Stream-Client': get_user_agent } end sig { params(response: Faraday::Response).returns(StreamChat::StreamResponse) } def parse_response(response) begin parsed_result = JSON.parse(response.body) rescue JSON::ParserError raise StreamAPIException, response end raise StreamAPIException, response if response.status >= 399 StreamResponse.new(parsed_result, response) end sig { params(method: Symbol, relative_url: String, params: T.nilable(StringKeyHash), data: T.nilable(StringKeyHash)).returns(StreamChat::StreamResponse) } def make_http_request(method, relative_url, params: nil, data: nil) headers = get_default_headers headers['Authorization'] = @auth_token headers['stream-auth-type'] = 'jwt' params = {} if params.nil? params = (get_default_params.merge(params).sort_by { |k, _v| k.to_s }).to_h url = "#{relative_url}?#{URI.encode_www_form(params)}" body = data.to_json if %w[patch post put].include? method.to_s response = @conn.run_request( method, url, body, headers ) parse_response(response) end end end