stream-ruby 4.5.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae1395d26cf2fc594224dfc4fb2acd18d5b9ecacb5c8def51ce8df295e1fead8
-  data.tar.gz: 4765a2b7e087bc060e22d14eca4ee37875c24d802c21455655eaa0c44b466ada
+  metadata.gz: bdef85497ab7ca002728c569b246ad90a804ea8f40a7bc0596cd22190df551d6
+  data.tar.gz: e7a9977ea752848600e057f38ebdeefbe8762da4eb1a6c8d66173efd8d332c24
 SHA512:
-  metadata.gz: ca9c4dc2e6978ccc1961821c6375607bd4ad10f22ffd3f950bf1493a616d4262b6e027cd26cee507260b6238814854edafe0b6a9b7fbc54732430693422bdbd3
-  data.tar.gz: 81996ad7e64df4fb2da41487a05570395a185000c2dd5124721b637959f7c6c2782d40089dc8461933d93654f145c3872ae3167b727c8ee8cd8cc1243744e81d
+  metadata.gz: f88ce620bb7d599a7b6d557c97c7170240193c1a3ed8541e02fb84f631ab9a986d1e8404f54e8205b2cdb7882516dd1f37b6739d8a05390ae63b858641cb1318
+  data.tar.gz: ea8247db45adad7bc0e339ecc0de437089cae55c7272d5e6980e0bd82dacf688af6e31e0aaa03714424288fecdbb4a90fbf7bdc0e0c6751cef882debd3a075a0

data/README.md

@@ -1,30 +1,47 @@
-# stream-ruby
+# Official Ruby SDK for [Stream Feeds](https://getstream.io/activity-feeds/)
 
 [![build](https://github.com/GetStream/stream-ruby/workflows/build/badge.svg)](https://github.com/GetStream/stream-ruby/actions) [![Gem Version](https://badge.fury.io/rb/stream-ruby.svg)](http://badge.fury.io/rb/stream-ruby)
 
-[stream-ruby](https://github.com/GetStream/stream-ruby) is the official Ruby client for [Stream](https://getstream.io/), a web service for building scalable newsfeeds and activity streams.
+<p align="center">
+    <img src="./assets/logo.svg" width="50%" height="50%">
+</p>
+<p align="center">
+    Official Ruby API client for Stream Feeds, a web service for building scalable newsfeeds and activity streams.
+    <br />
+    <a href="https://getstream.io/activity-feeds/"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+    <a href="https://github.com/GetStream/stream-rails">Code Samples</a>
+    ·
+    <a href="https://github.com/GetStream/stream-ruby/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/GetStream/stream-ruby/issues">Request Feature</a>
+</p>
 
-Note there is also a higher level [Ruby on Rails - Stream integration](https://github.com/getstream/stream-rails) library which hooks into the Ruby on Rails ORM.
+## 📝 About Stream
 
-You can sign up for a Stream account at https://getstream.io/get_started.
+> 💡 This is a library for the **Feeds** product. The Chat SDKs can be found [here](https://getstream.io/chat/docs/).
 
-#### Ruby version requirements and support
+You can sign up for a Stream account at our [Get Started](https://getstream.io/get_started/) page.
 
-This API Client project requires Ruby 2.5.x at a minimum.
+You can use this library to access Feeds API endpoints server-side.
 
-See the [Travis configuration](.travis.yml) for details of how it is built and tested.
+For the client-side integrations (web and mobile) have a look at the JavaScript, iOS and Android SDK libraries ([docs](https://getstream.io/activity-feeds/)). This API Client project requires Ruby 2.5.x at a minimum.
 
-### Installation
+> 💡 We have a Rails integration available [here](https://github.com/GetStream/stream-rails).
+
+## ⚙️ Installation
 
 ```bash
 gem install 'stream-ruby'
 ```
 
-### Full documentation
+
+## 📚 Full documentation
 
 Documentation for this Ruby client are available at the [Stream website](https://getstream.io/docs/ruby/?language=ruby).
 
-### Usage
+## ✨ Getting started
 
 ```ruby
 # Instantiate a new client to connect to us east API endpoint
@@ -151,11 +168,12 @@ client.add_to_many(activity, feeds)
 client.og('https://google.com')
 ```
 
-### Copyright and License Information
-
+## ✍️ Contributing
 Project is licensed under the [BSD 3-Clause](LICENSE).
 
-## We are hiring!
+We welcome code changes that improve this library or fix a problem, please make sure to follow all best practices and add tests if applicable before submitting a Pull Request on Github. We are very happy to merge your code in the official repository. Make sure to sign our [Contributor License Agreement (CLA)](https://docs.google.com/forms/d/e/1FAIpQLScFKsKkAJI7mhCr7K9rEIOpqIDThrWxuvxnwUq2XkHyG154vQ/viewform) first. See our [license file](./LICENSE) for more details.
+
+## 🧑‍💻 We are hiring!
 
 We've recently closed a [$38 million Series B funding round](https://techcrunch.com/2021/03/04/stream-raises-38m-as-its-chat-and-activity-feed-apis-power-communications-for-1b-users/) and we keep actively growing.
 Our APIs are used by more than a billion end-users, and you'll have a chance to make a huge impact on the product within a team of the strongest engineers all over the world.

data/lib/stream/client.rb

@@ -38,7 +38,7 @@ module Stream
     #
     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
@@ -46,7 +46,7 @@ module Stream
         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']
@@ -203,17 +203,12 @@ module Stream
   class RaiseHttpException < Faraday::Middleware
     def call(env)
       @app.call(env).on_complete do |response|
-        case response[:status].to_i
+        status_code = response[:status].to_i
+        case status_code
         when 200..203
           return response
-        when 401
-          raise StreamApiResponseException, error_message(response, 'Bad feed')
-        when 403
-          raise StreamApiResponseException, error_message(response, 'Bad auth/headers')
-        when 404
-          raise StreamApiResponseException, error_message(response, 'url not found')
-        when 204...600
-          raise StreamApiResponseException, error_message(response, _build_error_message(response.body))
+        else
+          parse_error(response, status_code: status_code)
         end
       end
     end
@@ -225,11 +220,48 @@ module Stream
 
     private
 
-    def _build_error_message(response)
-      response = JSON.parse(response)
-      msg = "#{response['exception']} details: #{response['detail']}"
-      if response.key?('exception_fields')
-        response['exception_fields'].map do |field, messages|
+    EXCEPTION_CLASS_MAPPING = {
+      2 => StreamApiResponseApiKeyException,
+      3 => StreamApiResponseSignatureException,
+      4 => StreamApiResponseInputException,
+      5 => StreamApiResponseCustomFieldException,
+      6 => StreamApiResponseFeedConfigException,
+      7 => StreamApiResponseSiteSuspendedException,
+      8 => StreamApiResponseInvalidPaginationException,
+      9 => StreamApiResponseRateLimitReached,
+      10 => StreamApiResponseMissingUserException,
+      11 => StreamApiResponseRankingException,
+      12 => StreamApiResponseMissingRankingException,
+      13 => StreamApiResponseOldStorageBackendException,
+      14 => StreamApiResponseJinjaRuntimeException,
+      15 => StreamApiResponseBestPracticeException,
+      16 => StreamApiResponseDoesNotExistException,
+      17 => StreamApiResponseNotAllowedException,
+      22 => StreamApiResponseConflictException
+    }.freeze
+    private_constant :EXCEPTION_CLASS_MAPPING
+
+    def parse_error(response, status_code:)
+      body = JSON.parse(response.body)
+      code = body['code']
+
+      exception_class = EXCEPTION_CLASS_MAPPING[code] || StreamApiResponseException
+      case status_code
+      when 401
+        raise exception_class, error_message(response, 'Bad feed')
+      when 403
+        raise exception_class, error_message(response, 'Bad auth/headers')
+      when 404
+        raise exception_class, error_message(response, 'url not found')
+      when 204...600
+        raise exception_class, error_message(response, _build_error_message(body))
+      end
+    end
+
+    def _build_error_message(body)
+      msg = "#{body['exception']} details: #{body['detail']}"
+      if body.key?('exception_fields')
+        body['exception_fields'].map do |field, messages|
           msg << "\n#{field}: #{messages}"
         end
       end

data/lib/stream/errors.rb

@@ -3,5 +3,39 @@ module Stream
 
   class StreamApiResponseException < Error; end
 
+  class StreamApiResponseApiKeyException < StreamApiResponseException; end
+
+  class StreamApiResponseSignatureException < StreamApiResponseException; end
+
+  class StreamApiResponseInputException < StreamApiResponseException; end
+
+  class StreamApiResponseCustomFieldException < StreamApiResponseException; end
+
+  class StreamApiResponseFeedConfigException < StreamApiResponseException; end
+
+  class StreamApiResponseSiteSuspendedException < StreamApiResponseException; end
+
+  class StreamApiResponseInvalidPaginationException < StreamApiResponseException; end
+
+  class StreamApiResponseRateLimitReached < StreamApiResponseException; end
+
+  class StreamApiResponseMissingRankingException < StreamApiResponseFeedConfigException; end
+
+  class StreamApiResponseMissingUserException < StreamApiResponseException; end
+
+  class StreamApiResponseRankingException < StreamApiResponseFeedConfigException; end
+
+  class StreamApiResponseOldStorageBackendException < StreamApiResponseException; end
+
+  class StreamApiResponseJinjaRuntimeException < StreamApiResponseException; end
+
+  class StreamApiResponseBestPracticeException < StreamApiResponseException; end
+
+  class StreamApiResponseDoesNotExistException < StreamApiResponseException; end
+
+  class StreamApiResponseNotAllowedException < StreamApiResponseException; end
+
+  class StreamApiResponseConflictException < StreamApiResponseException; end
+
   class StreamInputData < Error; end
 end

data/lib/stream/feed.rb

@@ -158,6 +158,19 @@ module Stream
       @client.make_request(:delete, uri, auth_token, params)
     end
 
+    def follow_stats(followers_slugs = nil, following_slugs = nil)
+      uri = '/stats/follow'
+      params = {
+        followers: @id,
+        following: @id
+      }
+      params[:followers_slugs] = followers_slugs.join(',') if followers_slugs
+      params[:following_slugs] = following_slugs.join(',') if following_slugs
+      auth_token = create_jwt_token('*', 'read', '*')
+
+      @client.make_request(:get, uri, auth_token, params)
+    end
+
     private
 
     def create_jwt_token(resource, action, feed_id = nil, user_id = nil)

data/lib/stream/url.rb

@@ -12,8 +12,8 @@ module Stream
       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 @@ module Stream
         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

data/lib/stream/version.rb

@@ -1,3 +1,3 @@
 module Stream
-  VERSION = '4.5.0'.freeze
+  VERSION = '4.6.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stream-ruby
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.6.0
 platform: ruby
 authors:
 - Tommaso Barbugli
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-26 00:00:00.000000000 Z
+date: 2022-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -139,6 +139,7 @@ homepage: http://github.com/GetStream/stream-ruby
 licenses:
 - BSD-3-Clause
 metadata:
+  rubygems_mfa_required: 'false'
   homepage_uri: https://getstream.io/activity-feeds/
   bug_tracker_uri: https://github.com/GetStream/stream-ruby/issues
   documentation_uri: https://getstream.io/activity-feeds/docs/ruby/?language=ruby