stream-chat-ruby 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b1c2b73dbb2e8e0e65aaa47da051ad41694ae5faf6c1d6d1de9e368d9f6bea6
-  data.tar.gz: 45a43c071349a05ce38a9df5840182ce299f3c41942c351dfb033aad314bba32
+  metadata.gz: 431753dd911d42b0ca289bc4ca1b35f0043dca65d0bc846bb1af6128c491f386
+  data.tar.gz: 7f48350204e9bad4de4a975c2d88339934e8cf195c7b38fc876a22bdd9139c63
 SHA512:
-  metadata.gz: 37f5d1762e3185a5a92698b0e3ea9f8358d21a5d90c9683387b29a8b64e31e6548d1ac3090bf111b83175e1a228ecf6ed711123e9b080ea01332de5d8d33a9d4
-  data.tar.gz: 68eb7fee75f01cae1d684fd4c9f51354914656193e4681d2d8a398659613f45bbf37f2322874d01e12f41a395f9a6f68431586a36b1c7094ccf770d85012c3eb
+  metadata.gz: fbf182d9dd41639610ac84a3e34b80a2620b707f4f5ebe67f947b7cffd1cd8b69dd43add8025177958a8be80bb521805ee8c36f564a4059a47723eb935f424b5
+  data.tar.gz: d32a9947b564c61a9918ed72dbbf1ec38e160c754f6105213dd1d3595c53bcb8bacdf75581056d2aea9b6a27635127836fd7688c9b2b8cf0753cde99947e66ef

data/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+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 }}
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rake rubocop
+          bundle exec rake test

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 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
 

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
 
@@ -37,6 +37,8 @@ gem install stream-chat-ruby
 - User devices
 - User search
 - Channel search
+- Blocklists
+- Export channels
 
 ### Import
 
@@ -152,6 +154,31 @@ 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'
+```
+
 ### 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

@@ -9,6 +9,8 @@ require 'stream-chat/errors'
 require 'stream-chat/version'
 
 module StreamChat
+  DEFAULT_BLOCKLIST = 'profanity_en_2020_v1'
+
   class Client
     BASE_URL = 'https://chat-us-east-1.stream-io-api.com'
 
@@ -262,6 +264,14 @@ module StreamChat
       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
@@ -334,7 +344,7 @@ module StreamChat
       headers['Authorization'] = @auth_token
       headers['stream-auth-type'] = 'jwt'
       url = [@base_url, relative_url].join('/')
-      params = !params.nil? ? params : {}
+      params = params.nil? ? {} : params
       params = Hash[get_default_params.merge(params).sort_by { |k, _v| k.to_s }]
       url = "#{url}?#{URI.encode_www_form(params)}"
 

data/lib/stream-chat/errors.rb

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

data/lib/stream-chat/version.rb

@@ -3,5 +3,5 @@
 # lib/version.rb
 
 module StreamChat
-  VERSION = '2.1.0'
+  VERSION = '2.2.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.2.0
 platform: ruby
 authors:
 - Mircea Cosbuc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-05 00:00:00.000000000 Z
+date: 2021-01-05 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

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