stream-chat-ruby 2.13.0 → 2.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d913a2d883a67d7e06afd1e57febfb5565cbcd23d69249e101f72163084f7b96
-  data.tar.gz: af4374cd74b9789c5751f6569e9317e46289207daa6a72eea0e53a20ad3ee43f
+  metadata.gz: b89ec4be90e50aefec0c944f7dcd33ea5cca18b709f431467f20e44a303b7bfe
+  data.tar.gz: a94ca94e1c4144f9bdc699d694a55f88ab1a1f46306941ffa912573af45a2bb7
 SHA512:
-  metadata.gz: 5c7ed7f7f94d009b4e3a091942f6b59cfa14087d02ba4b2659e18755dbb62a8bbe471e0497ce46a113598fd1e36aa2c7a3749f4ca3505f6f18e28a8d2ca3e663
-  data.tar.gz: 4c0dbed5b2230c4ce9fb3b8630f6d8fa72dd58097b35b12d78a6b355635cd7d9b0b63e38e1b011b57d7ce647fb271b0b225977e02c35718d549fc9d9c9ad7da3
+  metadata.gz: b9a030a478585db63eaccc77cfe5375610afe83c2a4858f6e5f3965ad0802f08a2eba9a949f66bc3bf7e89dd8b8211098d782e9096b83b1ed946a3a113704d72
+  data.tar.gz: b7d4e530a4a5599fce27c56d18b2689980a5aae0153290aa0065bf9e2efde674555693c3ebfb19a27eeba28f238b80814b5679afb8fb81dd1c0062a0ec0d46bd

data/.github/workflows/ci.yml

@@ -8,18 +8,26 @@ jobs:
     strategy:
       max-parallel: 1
       matrix:
-        ruby: ['2.5', '2.6', '2.7', '3.0']
-    name: Ruby ${{ matrix.ruby }}
+        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
 
-      - env:
+      - 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 }}
-        run: |
-          bundle exec rake rubocop
-          bundle exec rake test
+          STREAM_CHAT_API_HOST: ${{ secrets.STREAM_CHAT_API_HOST }}

data/.github/workflows/initiate_release.yml

@@ -0,0 +1,47 @@
+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

@@ -0,0 +1,40 @@
+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/.gitignore

@@ -9,6 +9,7 @@
 /test/tmp/
 /test/version_tmp/
 /tmp/
+.vscode
 
 # Used by dotenv library to load environment variables.
 # .env
@@ -43,7 +44,7 @@ build-iPhoneSimulator/
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
 Gemfile.lock
-# .ruby-version
+.ruby-version
 # .ruby-gemset
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:

data/.rubocop.yml

@@ -21,9 +21,6 @@ Metrics/MethodLength:
 Naming/AccessorMethodName:
   Enabled: false
 
-Security/Open:
-  Enabled: false
-
 Style/AccessorGrouping:
   Enabled: false
 Style/Documentation:
@@ -32,3 +29,6 @@ Style/DoubleCopDisableDirective:
   Enabled: false
 Style/FrozenStringLiteralComment:
   Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false

data/.versionrc.js

@@ -0,0 +1,16 @@
+const versionFileUpdater = {
+    VERSION_REGEX: /VERSION = '(.+)'/,
+
+    readVersion: function (contents) {
+        const version = this.VERSION_REGEX.exec(contents)[1];
+        return version;
+    },
+
+    writeVersion: function (contents, version) {
+        return contents.replace(this.VERSION_REGEX.exec(contents)[0], `VERSION = '${version}'`);
+    }
+}
+
+module.exports = {
+    bumpFiles: [{ filename: './lib/stream-chat/version.rb', updater: versionFileUpdater }],
+}

data/CHANGELOG.md

@@ -1,3 +1,32 @@
+# Changelog
+
+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.17.0](https://github.com/GetStream/stream-chat-ruby/compare/v2.16.0...v2.17.0) (2022-01-14)
+
+
+### Features
+
+* add options to add members ([#63](https://github.com/GetStream/stream-chat-ruby/issues/63)) ([89c9fa9](https://github.com/GetStream/stream-chat-ruby/commit/89c9fa98e19565c4b5353077523a1d407e1f10c9))
+
+## [2.16.0](https://github.com/GetStream/stream-chat-ruby/compare/v2.15.0...v2.16.0) (2021-12-01)
+
+- Add permissions v2 APIs by @ffenix113 in #62
+
+## [2.15.0](https://github.com/GetStream/stream-chat-ruby/compare/v2.14.0...v2.15.0) (2021-11-25)
+
+- Add configuration support for channel truncate
+  - truncated_at: to truncate channel up to given time
+  - message: a system message to be added via truncation
+  - skip_push: don't send a push notification for system message
+  - hard_delete: true if truncation should delete messages instead of hiding
+
+## November 24th, 2021 - 2.14.0
+
+- Add new flags for export channels
+  - clear_deleted_message_text (default: false)
+  - include_truncated_messages (default: false)
+
 ## November 17th, 2021 - 2.13.0
 
 - Add support for shadow banning user

data/Gemfile

@@ -13,6 +13,7 @@ end
 
 group :test do
   gem 'faraday'
+  gem 'faraday-multipart'
   gem 'rack'
   gem 'simplecov'
 end

data/README.md

@@ -14,7 +14,7 @@ Android SDK libraries (https://getstream.io/chat/).
 
 stream-chat-ruby supports:
 
-- Ruby (3.0, 2.7, 2.6, 2.5)
+- Ruby (2.5, 2.6, 2.7, 3.0, 3.1)
 
 #### Install
 
@@ -216,12 +216,16 @@ First, make sure you can run the test suite. Tests are run via rspec
 STREAM_CHAT_API_KEY=my_api_key STREAM_CHAT_API_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.
+
 ### Releasing a new version
 
 In order to release new version you need to be a maintainer of the library.
 
-- Update CHANGELOG
-- Update the version in `lib/stream-chat/version.rb`
-- Commit and push to GitHub
-- Build the gem with `bundle exec rake build`
-- Publish the gem with `bundle exec rake release`
+- Kick off a job called `initiate_release` ([link](https://github.com/GetStream/stream-chat-ruby/actions/workflows/initiate_release.yml)).
+
+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.

data/lib/stream-chat/channel.rb

@@ -95,12 +95,13 @@ module StreamChat
       @client.delete(url)
     end
 
-    def truncate
-      @client.post("#{url}/truncate")
+    def truncate(**options)
+      @client.post("#{url}/truncate", data: options)
     end
 
-    def add_members(user_ids)
-      @client.post(url, data: { add_members: user_ids })
+    def add_members(user_ids, **options)
+      payload = options.merge({ add_members: user_ids })
+      @client.post(url, data: payload)
     end
 
     def invite_members(user_ids)
@@ -115,6 +116,10 @@ module StreamChat
       @client.post(url, data: { remove_members: user_ids })
     end
 
+    def assign_roles(members, message = nil)
+      @client.post(url, data: { assign_roles: members, message: message })
+    end
+
     def demote_moderators(user_ids)
       @client.post(url, data: { demote_moderators: user_ids })
     end

data/lib/stream-chat/client.rb

@@ -3,6 +3,7 @@
 # lib/client.rb
 require 'open-uri'
 require 'faraday'
+require 'faraday/multipart'
 require 'jwt'
 require 'time'
 require 'stream-chat/channel'
@@ -322,8 +323,8 @@ module StreamChat
       delete("blocklists/#{name}")
     end
 
-    def export_channels(*channels)
-      post('export_channels', data: { channels: channels })
+    def export_channels(*channels, **options)
+      post('export_channels', data: { channels: channels, **options })
     end
 
     def get_export_channel_status(task_id)
@@ -389,10 +390,9 @@ module StreamChat
     def send_file(relative_url, file_url, user, content_type = 'application/octet-stream')
       url = [@base_url, relative_url].join('/')
 
-      file = open(file_url)
       body = { user: user.to_json }
 
-      body[:file] = Faraday::UploadIO.new(file, content_type)
+      body[:file] = Faraday::UploadIO.new(file_url, content_type)
 
       response = @conn.post url do |req|
         req.headers['X-Stream-Client'] = get_user_agent
@@ -429,6 +429,38 @@ module StreamChat
       get('commands')
     end
 
+    def list_permissions
+      get('permissions')
+    end
+
+    def get_permission(id)
+      get("permissions/#{id}")
+    end
+
+    def create_permission(permission)
+      post('permissions', data: permission)
+    end
+
+    def update_permission(id, permission)
+      put("permissions/#{id}", data: permission)
+    end
+
+    def delete_permission(id)
+      delete("permissions/#{id}")
+    end
+
+    def create_role(name)
+      post('roles', data: { name: name })
+    end
+
+    def delete_role(name)
+      delete("roles/#{name}")
+    end
+
+    def list_roles
+      get('roles')
+    end
+
     private
 
     def get_default_params

data/lib/stream-chat/version.rb

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

data/scripts/get_changelog_diff.js

@@ -0,0 +1,26 @@
+/*
+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
+}

data/stream-chat.gemspec

@@ -23,5 +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'
+  gem.metadata['rubygems_mfa_required'] = 'false'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stream-chat-ruby
 version: !ruby/object:Gem::Version
-  version: 2.13.0
+  version: 2.17.0
 platform: ruby
 authors:
 - Mircea Cosbuc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-17 00:00:00.000000000 Z
+date: 2022-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -88,8 +88,11 @@ extra_rdoc_files: []
 files:
 - ".github/CODEOWNERS"
 - ".github/workflows/ci.yml"
+- ".github/workflows/initiate_release.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".versionrc.js"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -102,11 +105,12 @@ files:
 - lib/stream-chat/errors.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: []
 metadata:
-  rubygems_mfa_required: 'true'
+  rubygems_mfa_required: 'false'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -122,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: The low level client for serverside calls for Stream Chat.