stream-chat-ruby 2.17.2 → 2.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 657677c7a41b9b356a92c750e823a3b9689e0a5af3e0e19e3178b443d653a6ed
-  data.tar.gz: 3025aaf97b2508822c27476dd58c053f2d823b6fb30f25ff05cef1cd49590ace
+  metadata.gz: af3ba47a48c7b729201b5db3401986f5d45007030b4caa86053399f5faf12aba
+  data.tar.gz: ba8243a507b81682a5f283f09e5075dd21a9c345c9043c8bf118ea423db1a1da
 SHA512:
-  metadata.gz: ed000d8a280c6fb8334cc0f3bfb20a42300b551ba5c98084ccbe2c2cc4b06deebc90962bcfe4605f91d30a2d1ae2b73c2f193e25540458262b1d88802f9c25f0
-  data.tar.gz: 4cd5063de70c7e26f90f15b1962825cae3121620fa36e0554ac49c9cc3eb4e118629da6af8e2d64596812d74a3d498dbd1562b5f12571b74a85c3beee206c5cc
+  metadata.gz: b004af8b95616a958803f632a434ae0ac1a6cd7504725faeceb76a2b27e75cdee45541ad876f598dc465ff02edee5662f4521437a9a74c5db3ef84c08dee6845
+  data.tar.gz: ca7d458fe80c3417f4058e7c876ea4984818e3c0b072f4bedd962f96a5b556d7835a36748f5da9e1ed968fe52e8711ca2c4011b463eec4108590d9b384ecb047

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [2.18.0](https://github.com/GetStream/stream-chat-ruby/compare/v2.17.2...v2.18.0) (2022-01-26)
+
+
+### Features
+
+* expose rate limits ([#72](https://github.com/GetStream/stream-chat-ruby/issues/72)) ([3f1ad5c](https://github.com/GetStream/stream-chat-ruby/commit/3f1ad5c8f43263424e934055d0ac283cdcce9376))
+* full feature parity ([#71](https://github.com/GetStream/stream-chat-ruby/issues/71)) ([a25a1b6](https://github.com/GetStream/stream-chat-ruby/commit/a25a1b66f9eadd77d09b99d5c3cfba27bba52f17))
+
 ### [2.17.2](https://github.com/GetStream/stream-chat-ruby/compare/v2.17.1...v2.17.2) (2022-01-17)
 
 ### Features

data/README.md

@@ -213,7 +213,7 @@ See [an example rails application using the Ruby SDK](https://github.com/GetStre
 First, make sure you can run the test suite. Tests are run via rspec
 
 ```bash
-STREAM_CHAT_API_KEY=my_api_key STREAM_CHAT_API_SECRET=my_api_secret bundle exec rake spec
+STREAM_KEY=my_api_key STREAM_SECRET=my_api_secret bundle exec rake spec
 ```
 
 This repository follows a commit message convention in order to automatically generate the [CHANGELOG](./CHANGELOG.md). Make sure you follow the rules of [conventional commits](https://www.conventionalcommits.org/) when opening a pull request.
@@ -229,3 +229,10 @@ The job creates a pull request with the changelog. Check if it looks good.
 - Merge the pull request.
 
 Once the PR is merged, it automatically kicks off another job which will upload the Gem to RubyGems.org and creates a GitHub release.
+
+## We are hiring!
+
+We've recently closed a [$38 million Series B funding round](https://techcrunch.com/2021/03/04/stream-raises-38m-as-its-chat-and-activity-feed-apis-power-communications-for-1b-users/) and we keep actively growing.
+Our APIs are used by more than a billion end-users, and you'll have a chance to make a huge impact on the product within a team of the strongest engineers all over the world.
+
+Check out our current openings and apply via [Stream's website](https://getstream.io/team/#jobs).

data/lib/stream-chat/channel.rb

@@ -13,6 +13,7 @@ module StreamChat
     def initialize(client, channel_type, channel_id = nil, custom_data = nil)
       @channel_type = channel_type
       @id = channel_id
+      @cid = "#{@channel_type}:#{@id}"
       @client = client
       @custom_data = custom_data
       @custom_data = {} if @custom_data.nil?
@@ -24,6 +25,10 @@ module StreamChat
       "channels/#{@channel_type}/#{@id}"
     end
 
+    def get_messages(message_ids)
+      @client.get("#{url}/messages", params: { 'ids' => message_ids.join(',') })
+    end
+
     def send_message(message, user_id)
       payload = { message: add_user_id(message, user_id) }
       @client.post("#{url}/message", data: payload)
@@ -99,6 +104,16 @@ module StreamChat
       @client.post("#{url}/truncate", data: options)
     end
 
+    def mute(user_id, expiration = nil)
+      data = { user_id: user_id, channel_cid: @cid }
+      data['expiration'] = expiration if expiration
+      @client.post('moderation/mute/channel', data: data)
+    end
+
+    def unmute(user_id)
+      @client.post('moderation/unmute/channel', data: { 'user_id' => user_id, 'channel_cid' => @cid })
+    end
+
     def add_members(user_ids, **options)
       payload = options.merge({ add_members: user_ids })
       @client.post(url, data: payload)

data/lib/stream-chat/client.rb

@@ -8,6 +8,7 @@ require 'jwt'
 require 'time'
 require 'stream-chat/channel'
 require 'stream-chat/errors'
+require 'stream-chat/stream_response'
 require 'stream-chat/version'
 require 'stream-chat/util'
 
@@ -35,12 +36,12 @@ module StreamChat
     #   StreamChat::Client.new('my_key', 'my_secret', 3.0)
     #
     def initialize(api_key = '', api_secret = '', timeout = 6.0, **options)
-      @api_key = api_key
-      @api_secret = api_secret
-      @timeout = timeout
+      @api_key = api_key || ENV['STREAM_KEY']
+      @api_secret = api_secret || ENV['STREAM_SECRET']
+      @timeout = timeout || ENV['STREAM_CHAT_TIMEOUT']
       @options = options
       @auth_token = JWT.encode({ server: true }, @api_secret, 'HS256')
-      @base_url = options[:base_url] || BASE_URL
+      @base_url = options[:base_url] || ENV['STREAM_CHAT_URL'] || BASE_URL
       @conn = Faraday.new(url: @base_url) do |faraday|
         faraday.options[:open_timeout] = @timeout
         faraday.options[:timeout] = @timeout
@@ -221,6 +222,14 @@ module StreamChat
       delete("messages/#{message_id}")
     end
 
+    def query_banned_users(filter_conditions, sort: nil, **options)
+      params = options.merge({
+                               filter_conditions: filter_conditions,
+                               sort: get_sort_fields(sort)
+                             })
+      get('query_banned_users', params: { payload: params.to_json })
+    end
+
     def query_users(filter_conditions, sort: nil, **options)
       params = options.merge({
                                filter_conditions: filter_conditions,
@@ -303,6 +312,22 @@ module StreamChat
       signature == x_signature
     end
 
+    def send_user_event(user_id, event)
+      post("users/#{user_id}/event", data: event)
+    end
+
+    def translate_message(message_id, language)
+      post("messages/#{message_id}/translate", data: { language: language })
+    end
+
+    def run_message_action(message_id, data)
+      post("messages/#{message_id}/action", data: data)
+    end
+
+    def create_guest(user)
+      post('guests', data: user)
+    end
+
     def list_blocklists
       get('blocklists')
     end
@@ -405,6 +430,10 @@ module StreamChat
       parse_response(response)
     end
 
+    def check_push(push_data)
+      post('check_push', data: push_data)
+    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
@@ -486,7 +515,7 @@ module StreamChat
       end
       raise StreamAPIException, response if response.status >= 399
 
-      parsed_result
+      StreamResponse.new(parsed_result, response)
     end
 
     def make_http_request(method, relative_url, params: nil, data: nil)

data/lib/stream-chat/stream_rate_limits.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# lib/stream_rate_limits.rb
+
+module StreamChat
+  class StreamRateLimits
+    attr_reader :limit
+    attr_reader :remaining
+    attr_reader :reset
+
+    def initialize(limit, remaining, reset)
+      @limit = limit.to_i
+      @remaining = remaining.to_i
+      @reset = Time.at(reset.to_i)
+    end
+  end
+end

data/lib/stream-chat/stream_response.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# lib/stream_response.rb
+require 'stream-chat/stream_rate_limits'
+
+module StreamChat
+  class StreamResponse < Hash
+    attr_reader :rate_limit
+    attr_reader :status_code
+    attr_reader :headers
+
+    def initialize(hash, response)
+      super(nil)
+      merge!(hash)
+
+      if response.headers.key?('X-Ratelimit-Limit')
+        @rate_limit = StreamRateLimits.new(
+          response.headers['X-Ratelimit-Limit'],
+          response.headers['X-Ratelimit-Remaining'],
+          response.headers['X-Ratelimit-Reset']
+        )
+      end
+
+      @status_code = response.status
+      @headers = response.headers
+    end
+  end
+end

data/lib/stream-chat/version.rb

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

data/stream-chat.gemspec

@@ -12,9 +12,9 @@ Gem::Specification.new do |gem|
   gem.summary = 'The low level client for serverside calls for Stream Chat.'
   gem.email = 'support@getstream.io'
   gem.homepage = 'http://github.com/GetStream/stream-chat-ruby'
-  gem.authors = ['Mircea Cosbuc']
+  gem.authors = ['getstream.io']
   gem.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|\.github|scripts)/}) }
   end
   gem.required_ruby_version = '>=2.5.0'
   gem.metadata = {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stream-chat-ruby
 version: !ruby/object:Gem::Version
-  version: 2.17.2
+  version: 2.18.0
 platform: ruby
 authors:
-- Mircea Cosbuc
+- getstream.io
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-17 00:00:00.000000000 Z
+date: 2022-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -100,10 +100,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/CODEOWNERS"
-- ".github/workflows/ci.yml"
-- ".github/workflows/initiate_release.yml"
-- ".github/workflows/release.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".versionrc.js"
@@ -117,9 +113,10 @@ files:
 - lib/stream-chat/channel.rb
 - lib/stream-chat/client.rb
 - lib/stream-chat/errors.rb
+- lib/stream-chat/stream_rate_limits.rb
+- lib/stream-chat/stream_response.rb
 - lib/stream-chat/util.rb
 - lib/stream-chat/version.rb
-- scripts/get_changelog_diff.js
 - stream-chat.gemspec
 homepage: http://github.com/GetStream/stream-chat-ruby
 licenses: []

data/.github/CODEOWNERS

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

data/.github/workflows/ci.yml

@@ -1,33 +0,0 @@
-name: test
-
-on: [pull_request]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      max-parallel: 1
-      matrix:
-        ruby: ['2.5', '2.6', '2.7', '3.0', '3.1']
-    name: 💎 Ruby ${{ matrix.ruby }}
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          fetch-depth: 0 # gives the commit linter access to previous commits
-
-      - name: Commit message linter
-        if: ${{ matrix.ruby == '2.5' }}
-        uses: wagoid/commitlint-github-action@v4
-
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - run: bundle exec rake rubocop
-
-      - run: bundle exec rake test
-        env:
-          STREAM_CHAT_API_KEY: ${{ secrets.STREAM_CHAT_API_KEY }}
-          STREAM_CHAT_API_SECRET: ${{ secrets.STREAM_CHAT_API_SECRET }}
-          STREAM_CHAT_API_HOST: ${{ secrets.STREAM_CHAT_API_HOST }}

data/.github/workflows/initiate_release.yml

@@ -1,47 +0,0 @@
-name: Create release PR
-
-on:
-  workflow_dispatch:
-    inputs:
-      version:
-        description: "The new version number with 'v' prefix. Example: v1.40.1"
-        required: true
-
-jobs:
-  init_release:
-    name: 🚀 Create release PR
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          fetch-depth: 0 # gives the changelog generator access to all previous commits
-
-      - name: Update CHANGELOG.md, version.rb and push release branch
-        env:
-          VERSION: ${{ github.event.inputs.version }}
-        run: |
-          npx --yes standard-version@9.3.2 --release-as "$VERSION" --skip.tag --skip.commit --tag-prefix=v
-          git config --global user.name 'github-actions' 
-          git config --global user.email 'release@getstream.io'
-          git checkout -q -b "release-$VERSION"
-          git commit -am "chore(release): $VERSION"
-          git push -q -u origin "release-$VERSION"
-
-      - name: Get changelog diff
-        uses: actions/github-script@v5
-        with:
-          script: |
-            const get_change_log_diff = require('./scripts/get_changelog_diff.js')
-            core.exportVariable('CHANGELOG', get_change_log_diff())
-
-      - name: Open pull request
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          gh pr create \
-            -t "Release ${{ github.event.inputs.version }}" \
-            -b "# :rocket: ${{ github.event.inputs.version }}
-            Make sure to use squash & merge when merging!
-            Once this is merged, another job will kick off automatically and publish the package.
-            # :memo: Changelog
-            ${{ env.CHANGELOG }}"

data/.github/workflows/release.yml

@@ -1,40 +0,0 @@
-name: Release
-
-on:
-  pull_request:
-    types: [closed]
-    branches:
-      - master
-
-jobs:
-  Release:
-    name: 🚀 Release
-    if: github.event.pull_request.merged && startsWith(github.head_ref, 'release-')
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
-  
-      - uses: actions/github-script@v5
-        with:
-          script: |
-            const get_change_log_diff = require('./scripts/get_changelog_diff.js')
-            core.exportVariable('CHANGELOG', get_change_log_diff())
-
-            // Getting the release version from the PR source branch
-            // Source branch looks like this: release-1.0.0
-            const version = context.payload.pull_request.head.ref.split('-')[1]
-            core.exportVariable('VERSION', version)
-
-      - name: Publish gem
-        uses: dawidd6/action-publish-gem@v1
-        with:
-          api_key: ${{secrets.RUBYGEMS_API_KEY}}
-
-      - name: Create release on GitHub
-        uses: ncipollo/release-action@v1
-        with:
-          body: ${{ env.CHANGELOG }}
-          tag: ${{ env.VERSION }}
-          token: ${{ secrets.GITHUB_TOKEN }}

data/scripts/get_changelog_diff.js

@@ -1,26 +0,0 @@
-/*
-Here we're trying to parse the latest changes from CHANGELOG.md file.
-The changelog looks like this:
-
-## 0.0.3
-- Something #3
-## 0.0.2
-- Something #2
-## 0.0.1
-- Something #1
-
-In this case we're trying to extract "- Something #3" since that's the latest change.
-*/
-module.exports = () => {
-    const fs = require('fs')
-
-    changelog = fs.readFileSync('CHANGELOG.md', 'utf8')
-    releases = changelog.match(/## [?[0-9](.+)/g)
-
-    current_release = changelog.indexOf(releases[0])
-    previous_release = changelog.indexOf(releases[1])
-
-    latest_changes = changelog.substr(current_release, previous_release - current_release)
-
-    return latest_changes
-}