stream-ruby 2.5.8 → 2.5.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c574df76ea568aae6df6bc23389620694877ef1
-  data.tar.gz: 46424a58f936da6ea646d6c8e5ce4003761cec04
+  metadata.gz: 1a89b73bd4cda76d4266cf20ec867a3c96428b55
+  data.tar.gz: c80d98f021dfb1aab797a43bcf0f1b6484d36b0d
 SHA512:
-  metadata.gz: 4db2fa01486a78daf5ea3574bee4c9bbfdc5345bd4a352731c82c80b2fc72d47fa46c04cffa511aa4a69347eba47ae1657024318f9a791a7ac13b79ec3a097b5
-  data.tar.gz: 183ffd03c3ad120b3c5a20850f8b63994ba18c1d56c4f688ef7527fb8db3cc464391a72618cddc400408102403c356eda8344980e0233f155d19651ad3ba000f
+  metadata.gz: 32099413dc479ffccb0d4c21da3c4150ca3a0af4907f0333a661cff9eed5a7efb01abf351105d5d92cabac4f7ae9e83a18c96ea2361891f510dc2a5cc0e5451f
+  data.tar.gz: 3f6f59e178336340c907ffb5d00f400b6905448413ab20787b128ee2e760a1fe8531ffa700e3d35ad6b6540ee26fcd3d2ad46ca43ef17bdbd4afe9a16595914b

data/README.md

@@ -9,15 +9,16 @@ Note there is also a higher level [Ruby on Rails - Stream integration](https://g
 
 You can sign up for a Stream account at https://getstream.io/get_started.
 
-### Ruby Language Support
-
-We will support the following versions of Ruby:
+#### Ruby version requirements and support
 
+This API Client project requires Ruby 2.2.8 at a minimum. We will support the following versions:
 - 2.2.8
 - 2.3.1
 - 2.3.5
 - 2.4.2
 
+See the [Travis configuration](.travis.yml) for details of how it is built and tested.
+
 ### Installation
 
 ```bash

data/lib/stream.rb

@@ -1 +1 @@
-require "stream/base"
+require 'stream/base'

data/lib/stream/base.rb

@@ -1,8 +1,8 @@
-require "json"
-require "stream/client"
-require "stream/errors"
-require "stream/version"
-require "stream/signer"
+require 'json'
+require 'stream/client'
+require 'stream/errors'
+require 'stream/version'
+require 'stream/signer'
 
 module Stream
   class << self
@@ -11,7 +11,7 @@ module Stream
     end
 
     def get_feed_slug_and_id(feed_id)
-      feed_id.sub(":", "")
+      feed_id.sub(':', '')
     end
   end
 end

data/lib/stream/batch.rb

@@ -19,9 +19,9 @@ module Stream
     def follow_many(follows, activity_copy_limit = nil)
       query_params = {}
       unless activity_copy_limit.nil?
-        query_params["activity_copy_limit"] = activity_copy_limit
+        query_params['activity_copy_limit'] = activity_copy_limit
       end
-      make_signed_request(:post, "/follow_many/", query_params, follows)
+      make_signed_request(:post, '/follow_many/', query_params, follows)
     end
 
     #
@@ -37,7 +37,7 @@ module Stream
         :feeds => feeds,
         :activity => activity_data
       }
-      make_signed_request(:post, "/feed/add_to_many/", {}, data)
+      make_signed_request(:post, '/feed/add_to_many/', {}, data)
     end
   end
 end

data/lib/stream/client.rb

@@ -1,10 +1,11 @@
-require "faraday"
-require "stream/errors"
-require "stream/feed"
-require "stream/signer"
+require 'faraday'
+require 'stream/errors'
+require 'stream/feed'
+require 'stream/signer'
 
 module Stream
-  STREAM_URL_RE = %r{https\:\/\/(?<key>\w+)\:(?<secret>\w+)@((api\.)|((?<location>[-\w]+)\.))?getstream\.io\/[\w=-\?%&]+app_id=(?<app_id>\d+)}i
+  STREAM_URL_COM_RE = %r{https\:\/\/(?<key>\w+)\:(?<secret>\w+)@((api\.)|((?<location>[-\w]+)\.))?(?<api_hostname>stream-io-api\.com)\/[\w=-\?%&]+app_id=(?<app_id>\d+)}i
+  STREAM_URL_IO_RE = %r{https\:\/\/(?<key>\w+)\:(?<secret>\w+)@((api\.)|((?<location>[-\w]+)\.))?(?<api_hostname>getstream\.io)\/[\w=-\?%&]+app_id=(?<app_id>\d+)}i
 
   class Client
     attr_reader :api_key
@@ -13,8 +14,8 @@ module Stream
     attr_reader :client_options
 
     if RUBY_VERSION.to_f >= 2.1
-      require "stream/batch"
-      require "stream/signedrequest"
+      require 'stream/batch'
+      require 'stream/signedrequest'
 
       include Stream::SignedRequest
       include Stream::Batch
@@ -31,17 +32,25 @@ module Stream
     # @example initialise the client to connect to EU-West location
     #   Stream::Client.new('my_key', 'my_secret', 'my_app_id', :location => 'us-east')
     #
-    def initialize(api_key = "", api_secret = "", app_id = nil, opts = {})
-      if ENV["STREAM_URL"] =~ Stream::STREAM_URL_RE && (api_key.nil? || api_key.empty?)
-        matches = Stream::STREAM_URL_RE.match(ENV["STREAM_URL"])
-        api_key = matches["key"]
-        api_secret = matches["secret"]
-        app_id = matches["app_id"]
-        opts[:location] = matches["location"]
+    def initialize(api_key = '', api_secret = '', app_id = nil, opts = {})
+      if ENV['STREAM_URL'] =~ Stream::STREAM_URL_COM_RE && (api_key.nil? || api_key.empty?)
+        matches = Stream::STREAM_URL_COM_RE.match(ENV['STREAM_URL'])
+        api_key = matches['key']
+        api_secret = matches['secret']
+        app_id = matches['app_id']
+        opts[:location] = matches['location']
+        opts[:api_hostname] = matches['api_hostname']
+      elsif ENV['STREAM_URL'] =~ Stream::STREAM_URL_IO_RE && (api_key.nil? || api_key.empty?)
+        matches = Stream::STREAM_URL_IO_RE.match(ENV['STREAM_URL'])
+        api_key = matches['key']
+        api_secret = matches['secret']
+        app_id = matches['app_id']
+        opts[:location] = matches['location']
+        opts[:api_hostname] = matches['api_hostname']
       end
 
       if api_key.nil? || api_key.empty?
-        raise ArgumentError, "empty api_key parameter and missing or invalid STREAM_URL env variable"
+        raise ArgumentError, 'empty api_key parameter and missing or invalid STREAM_URL env variable'
       end
 
       @api_key = api_key
@@ -50,10 +59,11 @@ module Stream
       @signer = Stream::Signer.new(api_secret)
 
       @client_options = {
-        :api_version => opts.fetch(:api_version, "v1.0"),
-        :location => opts.fetch(:location, nil),
-        :default_timeout => opts.fetch(:default_timeout, 3),
-        :api_key => @api_key
+          api_version: opts.fetch(:api_version, 'v1.0'),
+          location: opts.fetch(:location, nil),
+          default_timeout: opts.fetch(:default_timeout, 3),
+          api_key: @api_key,
+          api_hostname: opts.fetch(:api_hostname, 'stream-io-api.com')
       }
     end
 
@@ -74,12 +84,12 @@ module Stream
     end
 
     def update_activities(activities)
-      auth_token = Stream::Signer.create_jwt_token("activities", "*", @api_secret, "*")
-      make_request(:post, "/activities/", auth_token, {}, "activities" => activities)
+      auth_token = Stream::Signer.create_jwt_token('activities', '*', @api_secret, '*')
+      make_request(:post, '/activities/', auth_token, {}, 'activities' => activities)
     end
 
     def get_default_params
-      { :api_key => @api_key }
+      {:api_key => @api_key}
     end
 
     def get_http_client
@@ -87,19 +97,19 @@ module Stream
     end
 
     def make_query_params(params)
-      Hash[get_default_params.merge(params).sort_by { |k, v| k.to_s }]
+      Hash[get_default_params.merge(params).sort_by {|k, v| k.to_s}]
     end
 
     def make_request(method, relative_url, signature, params = {}, data = {}, headers = {})
-      headers["Authorization"] = signature
-      headers["stream-auth-type"] = "jwt"
+      headers['Authorization'] = signature
+      headers['stream-auth-type'] = 'jwt'
 
       get_http_client.make_http_request(method, relative_url, make_query_params(params), data, headers)
     end
   end
 
   class StreamHTTPClient
-    require "faraday"
+    require 'faraday'
 
     attr_reader :conn
     attr_reader :options
@@ -107,14 +117,14 @@ module Stream
 
     def initialize(client_params)
       @options = client_params
-      location_name = "api"
+      location_name = 'api'
       unless client_params[:location].nil?
         location_name = "#{client_params[:location]}-api"
       end
 
       protocol = 'https'
       port = ':443'
-      if @options[:location] == "qa" || @options[:location] == "localhost"
+      if @options[:location] == 'qa' || @options[:location] == 'localhost'
         protocol = 'http'
         port = ':80'
         if @options[:location] == 'localhost'
@@ -122,8 +132,13 @@ module Stream
         end
       end
 
+      api_hostname = 'stream-io-api.com'
+      if @options[:api_hostname]
+        api_hostname = @options[:api_hostname]
+      end
+
       @base_path = "/api/#{@options[:api_version]}"
-      base_url = "#{protocol}://#{location_name}.getstream.io#{port}#{@base_path}"
+      base_url = "#{protocol}://#{location_name}.#{api_hostname}#{port}#{@base_path}"
 
       @conn = Faraday.new(:url => base_url) do |faraday|
         # faraday.request :url_encoded
@@ -136,21 +151,21 @@ module Stream
     end
 
     def make_http_request(method, relative_url, params = nil, data = nil, headers = nil)
-      headers["Content-Type"] = "application/json"
-      headers["X-Stream-Client"] = "stream-ruby-client-#{Stream::VERSION}"
-      params["api_key"] = @options[:api_key]
+      headers['Content-Type'] = 'application/json'
+      headers['X-Stream-Client'] = "stream-ruby-client-#{Stream::VERSION}"
+      params['api_key'] = @options[:api_key]
       relative_url = "#{@base_path}#{relative_url}?#{URI.encode_www_form(params)}"
       body = data.to_json if %w(post put).include? method.to_s
       response = @conn.run_request(
-        method,
-        relative_url,
-        body,
-        headers
+          method,
+          relative_url,
+          body,
+          headers
       )
 
       case response[:status].to_i
-      when 200..203
-        return ::JSON.parse(response[:body])
+        when 200..203
+          return ::JSON.parse(response[:body])
       end
     end
   end
@@ -159,21 +174,20 @@ module Stream
     def call(env)
       @app.call(env).on_complete do |response|
         case response[:status].to_i
-        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))
+          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))
         end
       end
     end
 
-
     def initialize(app)
       super app
       @parser = nil
@@ -184,8 +198,8 @@ module Stream
     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|
+      if response.key?('exception_fields')
+        response['exception_fields'].map do |field, messages|
           msg << "\n#{field}: #{messages}"
         end
       end

data/lib/stream/exceptions.rb

@@ -1,2 +1,2 @@
 warn "Requiring 'stream/exceptions' is deprecated. Use 'stream/errors' instead."
-require "stream/errors"
+require 'stream/errors'

data/lib/stream/feed.rb

@@ -1,5 +1,5 @@
-require "stream/signer"
-require "jwt"
+require 'stream/signer'
+require 'jwt'
 
 module Stream
   class Feed
@@ -10,11 +10,11 @@ module Stream
 
     def initialize(client, feed_slug, user_id, token)
       unless valid_feed_slug feed_slug
-        raise StreamInputData, "feed_slug can only contain alphanumeric characters plus underscores"
+        raise StreamInputData, 'feed_slug can only contain alphanumeric characters plus underscores'
       end
 
       unless valid_user_id user_id
-        raise StreamInputData, "user_id can only contain alphanumeric characters plus underscores and dashes"
+        raise StreamInputData, 'user_id can only contain alphanumeric characters plus underscores and dashes'
       end
 
       @id = "#{feed_slug}:#{user_id}"
@@ -27,7 +27,7 @@ module Stream
     end
 
     def readonly_token
-      create_jwt_token("*", "read")
+      create_jwt_token('*', 'read')
     end
 
     def valid_feed_slug(feed_slug)
@@ -41,19 +41,19 @@ module Stream
     def get(params = {})
       uri = "/feed/#{@feed_url}/"
       if params[:mark_read] && params[:mark_read].is_a?(Array)
-        params[:mark_read] = params[:mark_read].join(",")
+        params[:mark_read] = params[:mark_read].join(',')
       end
       if params[:mark_seen] && params[:mark_seen].is_a?(Array)
-        params[:mark_seen] = params[:mark_seen].join(",")
+        params[:mark_seen] = params[:mark_seen].join(',')
       end
-      auth_token = create_jwt_token("feed", "read")
+      auth_token = create_jwt_token('feed', 'read')
 
       @client.make_request(:get, uri, auth_token, params)
     end
 
     def sign_to_field(to)
       to.map do |feed_id|
-        feed_slug, user_id = feed_id.split(":")
+        feed_slug, user_id = feed_id.split(':')
         feed = @client.feed(feed_slug, user_id)
         "#{feed.id} #{feed.token}"
       end
@@ -62,7 +62,7 @@ module Stream
     def add_activity(activity_data)
       uri = "/feed/#{@feed_url}/"
       activity_data[:to] &&= sign_to_field(activity_data[:to])
-      auth_token = create_jwt_token("feed", "write")
+      auth_token = create_jwt_token('feed', 'write')
 
       @client.make_request(:post, uri, auth_token, {}, activity_data)
     end
@@ -72,8 +72,8 @@ module Stream
       activities.each do |activity|
         activity[:to] &&= sign_to_field(activity[:to])
       end
-      data = { :activities => activities }
-      auth_token = create_jwt_token("feed", "write")
+      data = {:activities => activities}
+      auth_token = create_jwt_token('feed', 'write')
 
       @client.make_request(:post, uri, auth_token, {}, data)
     end
@@ -85,8 +85,8 @@ module Stream
     def remove_activity(activity_id, foreign_id = false)
       uri = "/feed/#{@feed_url}/#{activity_id}/"
       params = {}
-      params = { "foreign_id" => 1 } if foreign_id
-      auth_token = create_jwt_token("feed", "delete")
+      params = {foreign_id: 1} if foreign_id
+      auth_token = create_jwt_token('feed', 'delete')
 
       @client.make_request(:delete, uri, auth_token, params)
     end
@@ -96,14 +96,14 @@ module Stream
     end
 
     def update_activities(activities)
-      auth_token = create_jwt_token("activities", "*", "*")
+      auth_token = create_jwt_token('activities', '*', '*')
 
-      @client.make_request(:post, "/activities/", auth_token, {}, "activities" => activities)
+      @client.make_request(:post, '/activities/', auth_token, {}, 'activities' => activities)
     end
 
     def delete
       uri = "/feed/#{@feed_url}/"
-      auth_token = create_jwt_token("feed", "delete")
+      auth_token = create_jwt_token('feed', 'delete')
 
       @client.make_request(:delete, uri, auth_token)
     end
@@ -114,11 +114,11 @@ module Stream
       activity_copy_limit = 1000 if activity_copy_limit > 1000
 
       follow_data = {
-        target: "#{target_feed_slug}:#{target_user_id}",
-        target_token: @client.feed(target_feed_slug, target_user_id).token,
-        activity_copy_limit: activity_copy_limit
+          target: "#{target_feed_slug}:#{target_user_id}",
+          target_token: @client.feed(target_feed_slug, target_user_id).token,
+          activity_copy_limit: activity_copy_limit
       }
-      auth_token = create_jwt_token("follower", "write")
+      auth_token = create_jwt_token('follower', 'write')
 
       @client.make_request(:post, uri, auth_token, {}, follow_data)
     end
@@ -126,10 +126,10 @@ module Stream
     def followers(offset = 0, limit = 25)
       uri = "/feed/#{@feed_url}/followers/"
       params = {
-        "offset" => offset,
-        "limit" => limit
+          offset: offset,
+          limit: limit
       }
-      auth_token = create_jwt_token("follower", "read")
+      auth_token = create_jwt_token('follower', 'read')
 
       @client.make_request(:get, uri, auth_token, params)
     end
@@ -137,20 +137,20 @@ module Stream
     def following(offset = 0, limit = 25, filter = [])
       uri = "/feed/#{@feed_url}/follows/"
       params = {
-        "offset" => offset,
-        "limit" => limit,
-        "filter" => filter.join(",")
+          offset: offset,
+          limit: limit,
+          filter: filter.join(',')
       }
-      auth_token = create_jwt_token("follower", "read")
+      auth_token = create_jwt_token('follower', 'read')
 
       @client.make_request(:get, uri, auth_token, params)
     end
 
     def unfollow(target_feed_slug, target_user_id, keep_history = false)
       uri = "/feed/#{@feed_url}/follows/#{target_feed_slug}:#{target_user_id}/"
-      auth_token = create_jwt_token("follower", "delete")
+      auth_token = create_jwt_token('follower', 'delete')
       params = {}
-      params["keep_history"] = true if keep_history
+      params['keep_history'] = true if keep_history
       @client.make_request(:delete, uri, auth_token, params)
     end
 

data/lib/stream/signedrequest.rb

@@ -1,11 +1,12 @@
-require "http_signatures"
-require "net/http"
-require "time"
+require 'http_signatures'
+require 'net/http'
+require 'time'
 
 module Stream
   module SignedRequest
     module ClassMethods
-      def supports_signed_requests; end
+      def supports_signed_requests;
+      end
     end
 
     def self.included(klass)
@@ -15,26 +16,26 @@ module Stream
     def make_signed_request(method, relative_url, params = {}, data = {})
       query_params = make_query_params(params)
       context = HttpSignatures::Context.new(
-        keys: { @api_key => @api_secret },
-        algorithm: "hmac-sha256",
-        headers: ["(request-target)", "Date"]
+          keys: {@api_key => @api_secret},
+          algorithm: 'hmac-sha256',
+          headers: %w((request-target) Date)
       )
       method_map = {
-        :get => Net::HTTP::Get,
-        :delete => Net::HTTP::Delete,
-        :put => Net::HTTP::Put,
-        :post => Net::HTTP::Post
+          :get => Net::HTTP::Get,
+          :delete => Net::HTTP::Delete,
+          :put => Net::HTTP::Put,
+          :post => Net::HTTP::Post
       }
       request_date = Time.now.rfc822
       message = method_map[method].new(
-        "#{get_http_client.base_path}#{relative_url}?#{URI.encode_www_form(query_params)}",
-        "Date" => request_date
+          "#{get_http_client.base_path}#{relative_url}?#{URI.encode_www_form(query_params)}",
+          'Date' => request_date
       )
       context.signer.sign(message)
       headers = {
-        "Authorization" => message["Signature"],
-        "Date" => request_date,
-        "X-Api-Key" => api_key
+          Authorization: message['Signature'],
+          Date: request_date,
+          'X-Api-Key' => api_key
       }
       get_http_client.make_http_request(method, relative_url, query_params, data, headers)
     end

data/lib/stream/signer.rb

@@ -1,5 +1,5 @@
-require "openssl"
-require "base64"
+require 'openssl'
+require 'base64'
 
 module Stream
   class Signer
@@ -7,11 +7,11 @@ module Stream
 
     def initialize(key)
       @key = key.to_s
-      @sha1 = OpenSSL::Digest.new("sha1")
+      @sha1 = OpenSSL::Digest.new('sha1')
     end
 
     def urlsafe_encodeb64(value)
-      value.tr("+", "-").tr("/", "_").gsub(/^=+/, "").gsub(/=+$/, "")
+      value.tr('+', '-').tr('/', '_').gsub(/^=+/, '').gsub(/=+$/, '')
     end
 
     def sign_message(message)
@@ -26,13 +26,13 @@ module Stream
 
     def self.create_jwt_token(resource, action, api_secret, feed_id = nil, user_id = nil)
       payload = {
-        "resource" => resource,
-        "action" => action
+          resource: resource,
+          action: action
       }
-      payload["feed_id"] = feed_id if feed_id
-      payload["user_id"] = user_id if user_id
+      payload['feed_id'] = feed_id if feed_id
+      payload['user_id'] = user_id if user_id
 
-      JWT.encode(payload, api_secret, "HS256")
+      JWT.encode(payload, api_secret, 'HS256')
     end
   end
 end

data/lib/stream/version.rb

@@ -1,3 +1,3 @@
 module Stream
-  VERSION = "2.5.8".freeze
+  VERSION = '2.5.9'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stream-ruby
 version: !ruby/object:Gem::Version
-  version: 2.5.8
+  version: 2.5.9
 platform: ruby
 authors:
 - Tommaso Barbugli
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-21 00:00:00.000000000 Z
+date: 2017-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -141,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A gem that provides a client interface for getstream.io