docs: update readme

README.md

@@ -20,6 +20,8 @@
 
 ## 📝 About Stream
 
+> 💡 This is a library for the **Feeds** product. The Chat SDKs can be found [here](https://getstream.io/chat/docs/).
+
 You can sign up for a Stream account at our [Get Started](https://getstream.io/get_started/) page.
 
 You can use this library to access Feeds API endpoints server-side.

lib/stream/client.rb

@@ -38,15 +38,15 @@ class Client
     #
     def initialize(api_key = '', api_secret = '', app_id = nil, opts = {})
       if api_key.nil? || api_key.empty?
-        env_url = ENV['STREAM_URL']
+        env_url = ENV.fetch('STREAM_URL', nil)
         if env_url =~ Stream::STREAM_URL_COM_RE
           re = Stream::STREAM_URL_COM_RE
         elsif env_url =~ Stream::STREAM_URL_IO_RE
           re = Stream::STREAM_URL_IO_RE
         end
         raise ArgumentError, 'empty api_key parameter and missing or invalid STREAM_URL env variable' unless re
 
-        matches = re.match(ENV['STREAM_URL'])
+        matches = re.match(ENV.fetch('STREAM_URL', nil))
         api_key = matches['key']
         api_secret = matches['secret']
         app_id = matches['app_id']

lib/stream/url.rb

@@ -12,8 +12,8 @@ def initialize(options)
       location = make_location(options[:location])
       location ||= 'api'
       api_version = options[:api_version] || 'v1.0'
-      if ENV['STREAM_URL']
-        uri = URI.parse(ENV['STREAM_URL'])
+      if ENV.fetch('STREAM_URL', nil)
+        uri = URI.parse(ENV.fetch('STREAM_URL'))
         scheme = uri.scheme
         host = uri.host
         port = uri.port
@@ -22,7 +22,7 @@ def initialize(options)
         host = options[:api_hostname]
         port = 443
       end
-      unless ENV['STREAM_URL'] =~ /localhost/
+      unless ENV.fetch('STREAM_URL', nil) =~ /localhost/
         host_parts = host.split('.')
         host = host_parts.slice(1..-1).join('.') if host_parts.length == 3
         host = "#{location}.#{host}" if location

spec/client_spec.rb

@@ -3,12 +3,12 @@
 
 describe Stream::Client do
   before do
-    @env_url = ENV['STREAM_URL']
+    @env_url = ENV.fetch('STREAM_URL')
   end
 
   after do
     ENV.delete 'STREAM_URL'
-    ENV['STREAM_URL'] = @env_url if @env_url
+    ENV.fetch('STREAM_URL') = @env_url if @env_url
   end
 
   it 'feed returns a Feed instance with id' do
@@ -41,7 +41,7 @@
   end
 
   it 'on heroku we connect using environment variables' do
-    ENV['STREAM_URL'] = 'https://thierry:[email protected]/?app_id=1'
+    ENV.fetch('STREAM_URL') = 'https://thierry:[email protected]/?app_id=1'
     client = Stream::Client.new
     expect(client.api_key).to eq 'thierry'
     expect(client.api_secret).to eq 'pass'
@@ -51,7 +51,7 @@
   end
 
   it 'old heroku url' do
-    ENV['STREAM_URL'] = 'https://thierry:[email protected]/?app_id=1'
+    ENV.fetch('STREAM_URL') = 'https://thierry:[email protected]/?app_id=1'
     client = Stream::Client.new
     expect(client.api_key).to eq 'thierry'
     expect(client.api_secret).to eq 'pass'
@@ -61,7 +61,7 @@
   end
 
   it 'heroku url with location' do
-    ENV['STREAM_URL'] = 'https://thierry:[email protected]/?app_id=1'
+    ENV.fetch('STREAM_URL') = 'https://thierry:[email protected]/?app_id=1'
     client = Stream::Client.new
     expect(client.api_key).to eq 'thierry'
     expect(client.api_secret).to eq 'pass'
@@ -71,7 +71,7 @@
   end
 
   it 'heroku with getstream.io url with location' do
-    ENV['STREAM_URL'] = 'https://thierry:[email protected]/?app_id=1'
+    ENV.fetch('STREAM_URL') = 'https://thierry:[email protected]/?app_id=1'
     client = Stream::Client.new
     expect(client.api_key).to eq 'thierry'
     expect(client.api_secret).to eq 'pass'
@@ -81,7 +81,7 @@
   end
 
   it 'heroku url with location and extra vars' do
-    ENV['STREAM_URL'] = 'https://thierry:[email protected]/?something_else=2&app_id=1&something_more=3'
+    ENV.fetch('STREAM_URL') = 'https://thierry:[email protected]/?something_else=2&app_id=1&something_more=3'
     client = Stream::Client.new
     expect(client.api_key).to eq 'thierry'
     expect(client.api_secret).to eq 'pass'
@@ -91,12 +91,12 @@
   end
 
   it 'wrong heroku vars' do
-    ENV['STREAM_URL'] = 'https://thierry:[email protected]/?a=1'
+    ENV.fetch('STREAM_URL') = 'https://thierry:[email protected]/?a=1'
     expect { Stream::Client.new }.to raise_error(ArgumentError)
   end
 
   it 'but overwriting environment variables should be possible' do
-    ENV['STREAM_URL'] = 'https://thierry:[email protected]/?app_id=1'
+    ENV.fetch('STREAM_URL') = 'https://thierry:[email protected]/?app_id=1'
     client = Stream::Client.new('1', '2', '3')
     expect(client.api_key).to eq '1'
     expect(client.api_secret).to eq '2'

spec/integration_spec.rb

@@ -8,7 +8,7 @@
 
 describe 'Integration tests' do
   before(:all) do
-    @client = Stream::Client.new(ENV['STREAM_API_KEY'], ENV['STREAM_API_SECRET'], nil, location: ENV['STREAM_REGION'], default_timeout: 10)
+    @client = Stream::Client.new(ENV.fetch('STREAM_API_KEY'), ENV.fetch('STREAM_API_SECRET'), nil, location: ENV.fetch('STREAM_REGION'), default_timeout: 10)
     @feed42 = @client.feed('flat', generate_uniq_feed_name)
     @feed43 = @client.feed('flat', generate_uniq_feed_name)