stream-chat-ruby 1.1.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '079b1dd49ca55175f23ad66e3237cba1437a3b046db9631b1541ae630d31a996'
-  data.tar.gz: 3728ef3fc6b4da313cdf0eb8c8aa8e76b5d2b2756f5f830a2f68f4e2edd7a76f
+  metadata.gz: c7a819d41561a5fe8bf986b1ddcdc093a985a6de19bd256071a88efb4d790d58
+  data.tar.gz: e5cdc6e77fa5e453afbbbdf482c61f791a6896c47fe903f56acdca9794f662a6
 SHA512:
-  metadata.gz: a96841c65178ec69d31f3deb9744dd0afaf1173fe149a1be33c8234ae8ef8c8aaf9e337843d8afa01492f1c3aaae8374d7a9d11021dab37688f580d4c08b6616
-  data.tar.gz: 5a7ac658a2757d90f3356824731c436225272951ab261eb19a5c15f6b82ab81076be58808d12fb23c596f22bebf562b31e187b1c8493e2aca79cebc668456b4e
+  metadata.gz: 97fce2a3420903a2b9a88e7197a58683a5e3d0d54139350aec0d7c5029fd657352e2102be57fb398f5e389f5d97a500c5a88fce744f19ae2ffab2c5410ce297e
+  data.tar.gz: c9c2c76a61e874e43778b6181e1a2f68191aec1e0444272f043f6086f83f9151ae5a29d7c1255a60bf695520cdbe6e09bc5f87becda1dac93c461468a8b50539

data/.rubocop.yml

@@ -0,0 +1,34 @@
+AllCops:
+  DisabledByDefault: false
+  NewCops: enable
+  TargetRubyVersion: 2.5
+
+Layout/LineLength:
+  Enabled: false
+
+Lint/RedundantCopDisableDirective:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Security/Open:
+  Enabled: false
+
+Style/AccessorGrouping:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/DoubleCopDisableDirective:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.travis.yml

@@ -2,8 +2,9 @@ language: ruby
 before_install:
   - gem update bundler
 rvm:
-  - 2.3
-  - 2.4
   - 2.5
   - 2.6
   - 2.7
+script:
+  - bundle exec rake rubocop
+  - bundle exec rake test

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## October 2nd, 2020 - 2.0.0
+- Drop EOL Ruby versions: 2.3 && 2.4
+- Setup Rubocop and mark string literals as frozen
+
 ## August 3rd, 2020 - 1.1.3
 - Fixed Argument Error on delete_user
 

data/Gemfile

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
 
 group :dev do
-  gem "pry"
-  gem "pry-doc"
-  gem "method_source"
+  gem 'method_source'
+  gem 'pry'
+  gem 'pry-doc'
+  gem 'rubocop', require: false
 end
 
 group :test do
-  gem "faraday"
-  gem "rack"
-  gem "simplecov"
+  gem 'faraday'
+  gem 'rack'
+  gem 'simplecov'
 end
-

data/Rakefile

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 # rake spec
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) { |t| t.verbose = false   }
+RSpec::Core::RakeTask.new(:spec) { |t| t.verbose = false }
 
 # rake console
 task :console do
@@ -11,6 +13,10 @@ task :console do
   Pry.start
 end
 
-task :default => [:spec]
-task :test => [:spec]
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ['--display-cop-names']
+end
 
+task default: [:spec]
+task test: [:spec]

data/lib/stream-chat.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true # rubocop:todo Naming/FileName
+
 require 'stream-chat/client'

data/lib/stream-chat/channel.rb

@@ -1,72 +1,66 @@
+# frozen_string_literal: true
+
 require 'stream-chat/errors'
 
 module StreamChat
-
-  class Channel
+  class Channel # rubocop:todo Metrics/ClassLength # rubocop:todo Style/Documentation
     attr_reader :id
     attr_reader :channel_type
     attr_reader :custom_data
 
-    def initialize(client, channel_type, channel_id=nil, custom_data=nil)
+    def initialize(client, channel_type, channel_id = nil, custom_data = nil)
       @channel_type = channel_type
       @id = channel_id
       @client = client
       @custom_data = custom_data
-      if @custom_data == nil
-        @custom_data = {}
-      end
+      @custom_data = {} if @custom_data.nil?
     end
 
     def url
-      if @id == nil
-        raise StreamChannelException "channel does not have an id"
-      end
+      raise StreamChannelException 'channel does not have an id' if @id.nil?
+
       "channels/#{@channel_type}/#{@id}"
     end
 
     def send_message(message, user_id)
-      payload = {"message": add_user_id(message, user_id)}
+      payload = { "message": add_user_id(message, user_id) }
       @client.post("#{url}/message", data: payload)
     end
 
     def send_event(event, user_id)
-      payload = {'event' => add_user_id(event, user_id)}
+      payload = { 'event' => add_user_id(event, user_id) }
       @client.post("#{url}/event", data: payload)
     end
 
     def send_reaction(message_id, reaction, user_id)
-      payload = {"reaction": add_user_id(reaction, user_id)}
+      payload = { "reaction": add_user_id(reaction, user_id) }
       @client.post("messages/#{message_id}/reaction", data: payload)
     end
 
     def delete_reaction(message_id, reaction_type, user_id)
       @client.delete(
         "messages/#{message_id}/reaction/#{reaction_type}",
-        params: {"user_id": user_id}
+        params: { "user_id": user_id }
       )
     end
 
     def create(user_id)
-      @custom_data["created_by"] = {"id": user_id}
+      @custom_data['created_by'] = { "id": user_id }
       query(watch: false, state: false, presence: false)
     end
 
     def query(**options)
-      payload = {"state": true, "data": @custom_data}.merge(options)
+      payload = { "state": true, "data": @custom_data }.merge(options)
       url = "channels/#{@channel_type}"
-      if @id != nil
-        url = "#{url}/#{@id}"
-      end
+      url = "#{url}/#{@id}" unless @id.nil?
 
       state = @client.post("#{url}/query", data: payload)
-      if @id == nil
-        @id = state["channel"]["id"]
-      end
+      @id = state['channel']['id'] if @id.nil?
       state
     end
 
-    def update(channel_data, update_message=nil)
-      payload = {"data": channel_data, "message": update_message}
+    def update(channel_data, update_message = nil)
+      payload = { "data": channel_data, "message": update_message }
       @client.post(url, data: payload)
     end
 
@@ -79,23 +73,23 @@ module StreamChat
     end
 
     def add_members(user_ids)
-      @client.post(url, data: {"add_members": user_ids})
+      @client.post(url, data: { "add_members": user_ids })
     end
 
     def invite_members(user_ids)
-      @client.post(url, data: {"invites": user_ids})
+      @client.post(url, data: { "invites": user_ids })
     end
 
     def add_moderators(user_ids)
-      @client.post(url, data: {"add_moderators": user_ids})
+      @client.post(url, data: { "add_moderators": user_ids })
     end
 
     def remove_members(user_ids)
-      @client.post(url, data: {"remove_members": user_ids})
+      @client.post(url, data: { "remove_members": user_ids })
     end
 
     def demote_moderators(user_ids)
-      @client.post(url, data: {"demote_moderators": user_ids})
+      @client.post(url, data: { "demote_moderators": user_ids })
     end
 
     def mark_read(user_id, **options)
@@ -120,11 +114,11 @@ module StreamChat
     end
 
     def hide(user_id)
-      @client.post("#{url}/hide", data: {user_id: user_id})
+      @client.post("#{url}/hide", data: { user_id: user_id })
     end
 
     def show(user_id)
-      @client.post("#{url}/show", data: {user_id: user_id})
+      @client.post("#{url}/show", data: { user_id: user_id })
     end
 
     def send_file(url, user, content_type = nil)
@@ -136,18 +130,17 @@ module StreamChat
     end
 
     def delete_file(url)
-      @client.delete("#{self.url}/file", params: {"url": url})
+      @client.delete("#{self.url}/file", params: { "url": url })
     end
 
     def delete_image(url)
-      @client.delete("#{self.url}/image", params: {"url": url})
+      @client.delete("#{self.url}/image", params: { "url": url })
     end
 
     private
 
     def add_user_id(payload, user_id)
-      payload.merge({"user": {"id": user_id}})
+      payload.merge({ "user": { "id": user_id } })
     end
-
   end
 end

data/lib/stream-chat/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # lib/client.rb
 require 'open-uri'
 require 'faraday'
@@ -30,7 +32,7 @@ module StreamChat
       @api_secret = api_secret
       @timeout = timeout
       @options = options
-      @auth_token = JWT.encode({server: true}, @api_secret, 'HS256')
+      @auth_token = JWT.encode({ server: true }, @api_secret, 'HS256')
       @base_url = options[:base_url] || BASE_URL
       @conn = Faraday.new(url: @base_url) do |faraday|
         faraday.options[:open_timeout] = @timeout
@@ -41,10 +43,8 @@ module StreamChat
     end
 
     def create_token(user_id, exp = nil)
-      payload = {user_id: user_id}
-      if exp != nil
-        payload['exp'] = exp
-      end
+      payload = { user_id: user_id }
+      payload['exp'] = exp unless exp.nil?
       JWT.encode(payload, @api_secret, 'HS256')
     end
 
@@ -57,23 +57,23 @@ module StreamChat
     end
 
     def flag_message(id, **options)
-      payload = {'target_message_id': id}.merge(options)
-      post("moderation/flag", data: payload)
+      payload = { 'target_message_id': id }.merge(options)
+      post('moderation/flag', data: payload)
     end
 
     def unflag_message(id, **options)
-      payload = {'target_message_id': id}.merge(options)
-      post("moderation/unflag", data: payload)
+      payload = { 'target_message_id': id }.merge(options)
+      post('moderation/unflag', data: payload)
     end
 
     def flag_user(id, **options)
-      payload = {'target_user_id': id}.merge(options)
-      post("moderation/flag", data: payload)
+      payload = { 'target_user_id': id }.merge(options)
+      post('moderation/flag', data: payload)
     end
 
     def unflag_user(id, **options)
-      payload = {'target_user_id': id}.merge(options)
-      post("moderation/unflag", data: payload)
+      payload = { 'target_user_id': id }.merge(options)
+      post('moderation/unflag', data: payload)
     end
 
     def get_message(id)
@@ -82,21 +82,22 @@ module StreamChat
 
     def search(filter_conditions, query, **options)
       params = options.merge({
-        "filter_conditions": filter_conditions,
-        "query": query,
-      })
+                               "filter_conditions": filter_conditions,
+                               "query": query
+                             })
 
-      get("search", params: {"payload": params.to_json})
+      get('search', params: { "payload": params.to_json })
     end
 
     def update_users(users)
       payload = {}
       users.each do |user|
-        id = user[:id] || user["id"]
-        raise ArgumentError, "user must have an id" unless id
+        id = user[:id] || user['id']
+        raise ArgumentError, 'user must have an id' unless id
+
         payload[id] = user
       end
-      post('users', data: {'users': payload})
+      post('users', data: { 'users': payload })
     end
 
     def update_user(user)
@@ -104,7 +105,7 @@ module StreamChat
     end
 
     def update_users_partial(updates)
-      patch('users', data: {'users': updates})
+      patch('users', data: { 'users': updates })
     end
 
     def update_user_partial(update)
@@ -128,35 +129,34 @@ module StreamChat
     end
 
     def ban_user(target_id, **options)
-      payload = {'target_user_id': target_id}.merge(options)
-      post("moderation/ban", data: payload)
+      payload = { 'target_user_id': target_id }.merge(options)
+      post('moderation/ban', data: payload)
     end
 
     def unban_user(target_id, **options)
-      params = {'target_user_id': target_id}.merge(options)
-      delete("moderation/ban", params: params)
+      params = { 'target_user_id': target_id }.merge(options)
+      delete('moderation/ban', params: params)
     end
 
     def mute_user(target_id, user_id)
-      payload = {'target_id': target_id, 'user_id': user_id}
+      payload = { 'target_id': target_id, 'user_id': user_id }
       post('moderation/mute', data: payload)
     end
 
     def unmute_user(target_id, user_id)
-      payload = {'target_id': target_id, 'user_id': user_id}
+      payload = { 'target_id': target_id, 'user_id': user_id }
       post('moderation/unmute', data: payload)
     end
 
     def mark_all_read(user_id)
-      payload = {'user': {'id': user_id}}
+      payload = { 'user': { 'id': user_id } }
       post('channels/read', data: payload)
     end
 
     def update_message(message)
-      if !message.key? 'id'
-        raise ArgumentError "message must have an id"
-      end
-      post("messages/#{message['id']}", data: {'message': message})
+      raise ArgumentError 'message must have an id' unless message.key? 'id'
+
+      post("messages/#{message['id']}", data: { 'message': message })
     end
 
     def delete_message(message_id)
@@ -165,38 +165,32 @@ module StreamChat
 
     def query_users(filter_conditions, sort: nil, **options)
       sort_fields = []
-      if sort != nil
-        sort.each do |k ,v|
-          sort_fields << {"field": k, "direction":  v}
-        end
+      sort&.each do |k, v|
+        sort_fields << { "field": k, "direction": v }
       end
       params = options.merge({
-        "filter_conditions": filter_conditions,
-        "sort": sort_fields
-      })
-      get("users", params: {"payload": params.to_json})
+                               "filter_conditions": filter_conditions,
+                               "sort": sort_fields
+                             })
+      get('users', params: { "payload": params.to_json })
     end
 
     def query_channels(filter_conditions, sort: nil, **options)
-      params = {"state": true, "watch": false, "presence": false}
+      params = { "state": true, "watch": false, "presence": false }
       sort_fields = []
-      if sort != nil
-        sort.each do |k, v|
-          sort_fields << {"field": k, "direction": v}
-        end
+      sort&.each do |k, v|
+        sort_fields << { "field": k, "direction": v }
       end
       params = params.merge(options).merge({
-        "filter_conditions": filter_conditions,
-        "sort": sort_fields
-      })
-      get("channels", params: {"payload": params.to_json})
+                                             "filter_conditions": filter_conditions,
+                                             "sort": sort_fields
+                                           })
+      get('channels', params: { "payload": params.to_json })
     end
 
     def create_channel_type(data)
-      if !data.key? "commands" || data["commands"].nil? || data["commands"].empty?
-        data["commands"] = ["all"]
-      end
-      post("channeltypes", data: data)
+      data['commands'] = ['all'] unless data.key?('commands') || data['commands'].nil? || data['commands'].empty?
+      post('channeltypes', data: data)
     end
 
     def get_channel_type(channel_type)
@@ -204,7 +198,7 @@ module StreamChat
     end
 
     def list_channel_types
-      get("channeltypes")
+      get('channeltypes')
     end
 
     def update_channel_type(channel_type, **options)
@@ -228,23 +222,23 @@ module StreamChat
     end
 
     def add_device(device_id, push_provider, user_id)
-      post("devices", data: {
-        "id": device_id,
-        "push_provider": push_provider,
-        "user_id": user_id
-      })
+      post('devices', data: {
+             "id": device_id,
+             "push_provider": push_provider,
+             "user_id": user_id
+           })
     end
 
     def delete_device(device_id, user_id)
-      delete("devices", params: {"id": device_id, "user_id": user_id})
+      delete('devices', params: { "id": device_id, "user_id": user_id })
     end
 
     def get_devices(user_id)
-      get("devices", params: {"user_id": user_id})
+      get('devices', params: { "user_id": user_id })
     end
 
     def verify_webhook(request_body, x_signature)
-      signature = OpenSSL::HMAC.hexdigest("SHA256", @api_secret, request_body)
+      signature = OpenSSL::HMAC.hexdigest('SHA256', @api_secret, request_body)
       signature == x_signature
     end
 
@@ -272,14 +266,14 @@ module StreamChat
       url = [@base_url, relative_url].join('/')
 
       file = open(file_url)
-      body = {user: user.to_json}
+      body = { user: user.to_json }
 
       body[:file] = Faraday::UploadIO.new(file, content_type)
 
       response = @conn.post url do |req|
-        req.headers["X-Stream-Client"] = get_user_agent
+        req.headers['X-Stream-Client'] = get_user_agent
         req.headers['Authorization'] = @auth_token
-        req.headers["stream-auth-type"] = "jwt"
+        req.headers['stream-auth-type'] = 'jwt'
         req.params = get_default_params
         req.body = body
       end
@@ -290,7 +284,7 @@ module StreamChat
     private
 
     def get_default_params
-      {api_key: @api_key}
+      { api_key: @api_key }
     end
 
     def get_user_agent
@@ -299,7 +293,7 @@ module StreamChat
 
     def get_default_headers
       {
-        "Content-Type": "application/json",
+        "Content-Type": 'application/json',
         "X-Stream-Client": get_user_agent
       }
     end
@@ -308,26 +302,23 @@ module StreamChat
       begin
         parsed_result = JSON.parse(response.body)
       rescue JSON::ParserError
-        raise StreamAPIException.new(response)
+        raise StreamAPIException, response
       end
-      if response.status >= 399
-        raise StreamAPIException.new(response)
-      end
-      return parsed_result
+      raise StreamAPIException, response if response.status >= 399
+
+      parsed_result
     end
 
     def make_http_request(method, relative_url, params: nil, data: nil)
       headers = get_default_headers
       headers['Authorization'] = @auth_token
-      headers["stream-auth-type"] = "jwt"
+      headers['stream-auth-type'] = 'jwt'
       url = [@base_url, relative_url].join('/')
-      params = params != nil ? params : {}
-      params = Hash[get_default_params.merge(params).sort_by { |k, v| k.to_s }]
+      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)}"
 
-      if %w[patch post put].include? method.to_s
-        body = data.to_json
-      end
+      body = data.to_json if %w[patch post put].include? method.to_s
 
       response = @conn.run_request(
         method,
@@ -337,7 +328,5 @@ module StreamChat
       )
       parse_response(response)
     end
-
   end
 end
-

data/lib/stream-chat/errors.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 # lib/errors.rb
 
 module StreamChat
   class StreamAPIException < StandardError
-    
     def initialize(response)
+      super()
       @response = response
       p response
       begin
         parsed_response = JSON.parse(response.body)
         @json_response = true
-        @error_code = parsed_response.fetch("code", "unknown")
-        @error_message = parsed_response.fetch("message", "unknown")
+        @error_code = parsed_response.fetch('code', 'unknown')
+        @error_message = parsed_response.fetch('message', 'unknown')
       rescue JSON::ParserError
         @json_response = false
       end

data/lib/stream-chat/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 # lib/version.rb
 
 module StreamChat
-  VERSION = "1.1.3".freeze
+  VERSION = '2.0.0'
 end

data/stream-chat.gemspec

@@ -1,4 +1,6 @@
-lib = File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'stream-chat/version'
 
@@ -11,9 +13,10 @@ Gem::Specification.new do |gem|
   gem.email = 'support@getstream.io'
   gem.homepage = 'http://github.com/GetStream/stream-chat-ruby'
   gem.authors = ['Mircea Cosbuc']
-  gem.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+  gem.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
+  gem.required_ruby_version = '>=2.5.0'
 
   gem.add_dependency 'faraday'
   gem.add_dependency 'jwt'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stream-chat-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Mircea Cosbuc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-04 00:00:00.000000000 Z
+date: 2020-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -87,6 +87,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -111,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="