stream-chat-ruby 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 520b69d498d01a2cf41b857e498d3dc0fc4c7dd6ac328848c2bf4f761862953e
-  data.tar.gz: '091b5137483ae1ec59a68b26026cad060adbdb19ada735f0f1933a6232c2823d'
+  metadata.gz: a991d6254ab0ce129f7828b9f28dc18f90b867ba87ad543d24058ee9742f466b
+  data.tar.gz: c08d620794b6ddb9e0be2b540a8b543b27eebdc34ac4b3a9db047933e574b90b
 SHA512:
-  metadata.gz: 2415204b5775bb39d620351a1d3b60474a18115c4f818eae55cab17982b1dd832b0458edbac3cb1b44ac926aabde06256cdc4e86b54ec2164f2bb9ca0e644e8e
-  data.tar.gz: 1535f8eadb39fab2f30a89a4649d6bfbfe013fd5fc77775eceda7c5d59ffcde6b344a7ae2f25c12bce535590ba7db161f6503c836058a75ae4c5d48e7b125a72
+  metadata.gz: b5f13aaefd25df7431ae242a41d38e6a1765b1f0419c14623a363baedc3d64eb197c30b8f03e91bb7513d6f8c8c674501abf1fb59680ee4385624f0e79d1dd08
+  data.tar.gz: efbfac2fe9675cc8077429c6e6cd71d9a10d6234f8b9dfe904b997be339876b62fe89d140c9521adaec3901731c58e117e1646a7b4b65b711a030fc3563fca8a

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 before_install:
   - gem update bundler
 rvm:
+  - 2.3.8
   - 2.4.6
   - 2.5.5
   - 2.6.3

data/README.md

@@ -14,7 +14,7 @@ Android SDK libraries (https://getstream.io/chat/).
 
 stream-chat-ruby supports:
 
-- Ruby (2.6, 2.5, 2.4)
+- Ruby (2.6, 2.5, 2.4, 2.3)
 
 #### Install
 
@@ -26,10 +26,6 @@ gem install stream-chat-ruby
 
 [Official API docs](https://getstream.io/chat/docs/)
 
-### How to build a chat app with Ruby tutorial
-
-TODO: add a sample Ruby chat program
-
 ### Supported features
 
 - Chat channels
@@ -42,23 +38,124 @@ TODO: add a sample Ruby chat program
 - User search
 - Channel search
 
-### Quickstart
+### Import
+
+```ruby
+require 'stream-chat'
+```
+
+### Initialize client
+
+```ruby
+client = StreamChat::Client.new(api_key='STREAM_KEY', api_secret='STREAM_SECRET')
+```
+
+### Generate a token for client side use
+
+```ruby
+client.create_token('bob-1')
+```
+
+### Create/Update users
 
 ```ruby
-chat = StreamChat::Client.new(api_key='STREAM_KEY', api_secret='STREAM_SECRET')
+client.update_user({
+    'id' => 'bob-1',
+    'role' => 'admin',
+    'name' => 'Robert Tables'
+})
+
+# batch update is also supported
+jane = ...
+june = ...
+client.update_users([jane, june])
+```
+
+### Channel types CRUD
 
-# add a user
-chat.update_user({'id' => 'chuck', 'name' => 'Chuck'})
+```ruby
+# Create
+client.create_channel_type({
+    'name' => 'livechat',
+    'automod' => 'disabled',
+    'commands' => ['ban'],
+    'mutes' => true
+})
 
-# create a channel about kung-fu
-channel = chat.channel('messaging', 'kung-fu')
-channel.create('chuck')
+# Update
+client.update_channel_type('livechat', 'automod' => 'enabled'})
 
-# add a first message to the channel
-channel.send_message({'text' => 'AMA about kung-fu'})
+# Get
+client.get_channel_type('livechat')
 
+# List
+client.list_channel_types
+
+# Delete
+client.delete_channel_type('livechat')
 ```
 
+### Channels
+
+```ruby
+# Create a channel with members from the start
+chan = client.channel("messaging", channel_id: "bob-and-jane", data: {'members'=> ['bob-1', 'jane-77']})
+chan.create('bob-1')
+
+# Create a channel and then add members
+chan = client.channel("messaging", channel_id: "bob-and-jane")
+chan.create('bob-1')
+chan.add_members(['bob-1', 'jane-77'])
+
+# Send messages
+m1 = chan.send_message({'text' => 'Hi Jane!'}, 'bob-1')
+m2 = chan.send_message({'text' => 'Hi Bob'}, 'jane-77')
+
+# Send replies
+r1 = chan.send_message({'text' => 'And a good day!', 'parent_id' => m1['id']}, 'bob-1')
+
+# Send reactions
+chan.send_reaction(m1['id'], {'type' => 'like'}, 'bob-1')
+
+# Add/remove moderators
+chan.add_moderators(['jane-77'])
+chan.demote_moderators(['bob-1'])
+
+# Add a ban with a timeout
+chan.ban_user('bob-1', timeout: 30)
+
+# Remove a ban
+chan.unban_user('bob-1')
+
+# Query channel state
+chan.query({'messages' => { 'limit' => 10, 'id_lte' => m1['id']}})
+```
+
+### Messages
+
+```ruby
+# Delete a message from any channel by ID
+deleted_message = client.delete_message(r1['id'])
+
+```
+
+### Devices
+
+```ruby
+# Add device
+jane_phone = client.add_device({'id' => 'iOS Device Token', 'push_provider' => push_provider.apn, 'user_id' => 'jane-77'})
+
+# List devices
+client.get_devices('jane-77')
+
+# Remove device
+client.remove_device(jane_phone['id'], jane_phone['user_id'])
+```
+
+### Example Rails application
+
+See [an example rails application using the Ruby SDK](https://github.com/GetStream/rails-chat-example).
+
 ### Contributing
 
 First, make sure you can run the test suite. Tests are run via rspec

data/lib/stream-chat/channel.rb

@@ -4,7 +4,7 @@ module StreamChat
     attr_reader :id
     attr_reader :channel_type
     attr_reader :custom_data
-    
+
     def initialize(client, channel_type, channel_id=nil, custom_data=nil)
       @channel_type = channel_type
       @id = channel_id
@@ -114,10 +114,10 @@ module StreamChat
     end
 
     private
-    
+
     def add_user_id(payload, user_id)
       payload.merge({"user": {"id": user_id}})
     end
-    
+
   end
 end

data/lib/stream-chat/client.rb

@@ -3,6 +3,7 @@ require 'faraday'
 require 'jwt'
 require 'stream-chat/channel'
 require 'stream-chat/errors'
+require 'stream-chat/version'
 
 module StreamChat
   class Client
@@ -35,7 +36,7 @@ module StreamChat
         faraday.adapter Faraday.default_adapter
       end
     end
-    
+
     def create_token(user_id, exp = nil)
       payload = {user_id: user_id}
       if exp != nil
@@ -69,7 +70,7 @@ module StreamChat
     end
 
     def deactivate_user(user_id, **options)
-      post("users/#{user_id}/deactivate", **options)      
+      post("users/#{user_id}/deactivate", **options)
     end
 
     def export_user(user_id, **options)
@@ -151,13 +152,13 @@ module StreamChat
     def get_channel_type(channel_type)
       get("channeltypes/#{channel_type}")
     end
-        
+
     def list_channel_types
       get("channeltypes")
     end
 
     def update_channel_type(channel_type, **options)
-      put
+      put("channeltypes/#{channel_type}", **options)
     end
 
     def delete_channel_type(channel_type)
@@ -171,7 +172,7 @@ module StreamChat
     # @param [hash] data additional channel data
     #
     # @return [StreamChat::Channel]
-    # 
+    #
     def channel(channel_type, channel_id: nil, data: nil)
       StreamChat::Channel.new(self, channel_type, channel_id, data)
     end
@@ -222,7 +223,7 @@ module StreamChat
     def get_default_params
       {api_key: @api_key}
     end
-    
+
     def get_user_agent
       "stream-ruby-client-#{StreamChat::VERSION}"
     end
@@ -245,7 +246,7 @@ module StreamChat
       end
       return parsed_result
     end
-    
+
     def make_http_request(method, relative_url, params: nil, data: nil)
       headers = get_default_headers
       headers['Authorization'] = @auth_token

data/lib/stream-chat/version.rb

@@ -1,5 +1,5 @@
 # lib/version.rb
 
 module StreamChat
-  VERSION = "0.1.1".freeze
+  VERSION = "0.1.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stream-chat-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Mircea Cosbuc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-15 00:00:00.000000000 Z
+date: 2019-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday