stream-ruby 2.2.3 → 2.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67555d94a5b00d5dceacd6a619e4eed4ca5398e4
-  data.tar.gz: f40750f2291767e9058433d8d04781c7c093f847
+  metadata.gz: 359b8889235fc2df03b84b7330e7ce994dcd1618
+  data.tar.gz: 709c31cfb3240ef88e63e2c0171a2f75b2b369e3
 SHA512:
-  metadata.gz: 5901f6942db86d474c60c56c4e5432d7d17cd3023c1b47ec6334cdfa0bfeb0c5b891ddd61a3dbb578a125ea67f40651a1e7089b7c87808124afd44a2f1a222e4
-  data.tar.gz: 2ebe60f2812cb254195dc44aef96a643adb3051afc6d98b97bcffa104263241a39d08d86da9ea17f40a73e0bb74b48a4b9360b6683f9442a794d2826aa80f852
+  metadata.gz: 0bff2687b955dfae9cb454ca4affa5d241cc12ae3ad6e823fdab5edeec641c3b990c01110fbdfe813c336e449a0d9504e2ac94fb68034275d2a54a289c3421e4
+  data.tar.gz: d4e5dd145db0481d83ca6fc4838c86687a1f34ab3983d7821fa69227d483c92c43086eef4ed23e222975a38dfe82dbc930ffbb799a274eb52f224eef84babeed

data/README.md

@@ -3,13 +3,8 @@ stream-ruby
 
 [![Build Status](https://travis-ci.org/GetStream/stream-ruby.svg?branch=master)](https://travis-ci.org/GetStream/stream-ruby) [![Gem Version](https://badge.fury.io/rb/stream-ruby.svg)](http://badge.fury.io/rb/stream-ruby)
 
-
-
-
-stream-ruby is a Ruby client for [Stream](https://getstream.io/).
-
-**Users of versions < 2.0.0, Stream::Feed constructor signature and other methods has changed. Please read this before upgrading:** [Breaking Changes](http://github.com/GetStream/stream-ruby/blob/master/upgrading.txt)
-
+stream-ruby is the official Ruby client for [Stream](https://getstream.io/), a web service for building scalable newsfeeds and activity streams. 
+The full documentation is available on [GetStream.io/docs](http://getstream.io/docs/). Note that there is also a [higher level Rails integration](https://github.com/getstream/stream-rails) which hooks into your ORM.
 
 ### Installation
 
@@ -61,14 +56,14 @@ activities = [
     [:actor => '1', :verb => 'tweet', :object => '1'],
     [:actor => '2', :verb => 'like', :object => '3']
 ]
-user_feed_1.addActivities(activities)
+user_feed_1.add_activities(activities)
 
 # Batch following many feeds (requires ruby 2.1 or later)
-follows = {[
+follows = [{
     :source => 'flat:1', :target => 'user:1',
     :source => 'flat:1', :target => 'user:2',
     :source => 'flat:1', :target => 'user:3'
-]}
+}]
 client.follow_many(follows)
 
 # Add an activity and push it to other feeds too using the `to` field
@@ -104,6 +99,10 @@ user_feed_1.following(10, 10)
 # Check if user_feed_1 follows specific feeds
 user_feed_1.following(0, 2, filter=['user:42', 'user:43'])
 
+# Add one activity to many feeds in one request
+feeds = ['flat:1', 'flat:2', 'flat:3', 'flat:4']
+activity = {:actor => "User:2", :verb => "pin", :object => "Place:42", :target => "Board:1"}
+client.add_to_many(activity, feeds)
 ```
 
 Docs are available on [GetStream.io](http://getstream.io/docs/).

data/lib/stream.rb

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

data/lib/stream/base.rb

@@ -1,17 +1,17 @@
-require 'json'
-require 'stream/client'
-require 'stream/version'
-require 'stream/signer'
-require 'stream/exceptions'
+require "json"
+require "stream/client"
+require "stream/errors"
+require "stream/version"
+require "stream/signer"
 
 module Stream
-    class << self
-        def connect(api_key, api_secret)
-            Stream::Client.new(api_key, api_secret)
-        end
+  class << self
+    def connect(api_key, api_secret)
+      Stream::Client.new(api_key, api_secret)
+    end
 
-        def get_feed_slug_and_id(feed_id)
-            feed_id.sub(':', '')
-        end
+    def get_feed_slug_and_id(feed_id)
+      feed_id.sub(":", "")
     end
-end
+  end
+end

data/lib/stream/batch.rb

@@ -1,41 +1,39 @@
 module Stream
-
   module Batch
-      #
-      # Follows many feeds in one single request
-      #
-      # @param [Array<Hash<:source, :target>>] follows the list of follows
-      #
-      # @return [nil]
-      # 
-      # @example
-      # 
-      # 
-      # follows = [
-      #   {:source => 'flat:1', :target => 'user:1'},
-      #   {:source => 'flat:1', :target => 'user:3'}
-      # ]
-      # @client.follow_many(follows)
-      # 
-      def follow_many(follows)
-          self.make_signed_request(:post, '/follow_many/', {}, follows)
-      end
-
-      #
-      # Adds an activity to many feeds in one single request
-      #
-      # @param [Hash] activity_data the activity do add
-      # @param [Array<string>] feeds list of feeds (eg. 'user:1', 'flat:2')
-      #
-      # @return [nil]
-      # 
-      def add_to_many(activity_data, feeds)
-          data = {
-              :feeds => feeds,
-              :activity => activity_data
-          }
-          self.make_signed_request(:post, '/feed/add_to_many/', {}, data)
-      end
+    #
+    # Follows many feeds in one single request
+    #
+    # @param [Array<Hash<:source, :target>>] follows the list of follows
+    #
+    # @return [nil]
+    #
+    # @example
+    #
+    #
+    # follows = [
+    #   {:source => 'flat:1', :target => 'user:1'},
+    #   {:source => 'flat:1', :target => 'user:3'}
+    # ]
+    # @client.follow_many(follows)
+    #
+    def follow_many(follows)
+      make_signed_request(:post, "/follow_many/", {}, follows)
     end
 
+    #
+    # Adds an activity to many feeds in one single request
+    #
+    # @param [Hash] activity_data the activity do add
+    # @param [Array<string>] feeds list of feeds (eg. 'user:1', 'flat:2')
+    #
+    # @return [nil]
+    #
+    def add_to_many(activity_data, feeds)
+      data = {
+        :feeds => feeds,
+        :activity => activity_data
+      }
+      make_signed_request(:post, "/feed/add_to_many/", {}, data)
+    end
+  end
 end

data/lib/stream/client.rb

@@ -1,123 +1,117 @@
-require 'httparty'
-require 'stream/exceptions'
-require 'stream/feed'
-require 'stream/signer'
-
+require "httparty"
+require "stream/errors"
+require "stream/feed"
+require "stream/signer"
 
 module Stream
-    STREAM_URL_RE = /https\:\/\/(?<key>\w+)\:(?<secret>\w+)@((api\.)|((?<location>[-\w]+)\.))?getstream\.io\/[\w=-\?%&]+app_id=(?<app_id>\d+)/i
-
-    class Client
-        attr_reader :api_key
-        attr_reader :api_secret
-        attr_reader :app_id
-        attr_reader :api_version
-        attr_reader :location
-        attr_reader :default_timeout
-
-        if RUBY_VERSION.to_f >= 2.1
-            require 'stream/batch'
-            require 'stream/signedrequest'
-
-            include Stream::SignedRequest
-            include Stream::Batch
-        end
-
-        #
-        # initializes a Stream API Client
-        #
-        # @param [string] api_key your application api_key
-        # @param [string] api_secret your application secret
-        # @param [string] app_id the id of your application (optional)
-        # @param [hash] opts extra options
-        # 
-        # @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 and (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']
-            end
-
-            if api_key.nil? || api_key.empty?
-                raise ArgumentError, 'empty api_key parameter and missing or invalid STREAM_URL env variable'
-            end
-
-            @api_key = api_key
-            @api_secret = api_secret
-            @app_id = app_id
-            @location = opts[:location]
-            @api_version = opts.fetch(:api_version, 'v1.0')
-            @default_timeout = opts.fetch(:default_timeout, 3)
-            @signer = Stream::Signer.new(api_secret)
-        end
-
-        #
-        # Creates a feed instance
-        #
-        # @param [string] feed_slug the feed slug (eg. flat, aggregated...)
-        # @param [user_id] user_id the user_id of this feed (eg. User42)
-        #
-        # @return [Stream::Feed]
-        # 
-        def feed(feed_slug, user_id)
-            token = @signer.sign(feed_slug, user_id)
-            Stream::Feed.new(self, feed_slug, user_id, token)
-        end
-
-        def get_default_params
-            {:api_key => @api_key}
-        end
-
-        def get_http_client
-            StreamHTTPClient.new(@api_version, @location, @default_timeout)
-        end
-
-        def make_query_params(params)
-            self.get_default_params.merge(params)
-        end
+  STREAM_URL_RE = %r{https\:\/\/(?<key>\w+)\:(?<secret>\w+)@((api\.)|((?<location>[-\w]+)\.))?getstream\.io\/[\w=-\?%&]+app_id=(?<app_id>\d+)}i
+
+  class Client
+    attr_reader :api_key
+    attr_reader :api_secret
+    attr_reader :app_id
+    attr_reader :api_version
+    attr_reader :location
+    attr_reader :default_timeout
+
+    if RUBY_VERSION.to_f >= 2.1
+      require "stream/batch"
+      require "stream/signedrequest"
+
+      include Stream::SignedRequest
+      include Stream::Batch
+    end
 
-        def make_request(method, relative_url, signature, params={}, data={}, headers={})
-            headers['Authorization'] = signature
-            self.get_http_client.make_http_request(method, relative_url, self.make_query_params(params), data, headers)
-        end
+    #
+    # initializes a Stream API Client
+    #
+    # @param [string] api_key your application api_key
+    # @param [string] api_secret your application secret
+    # @param [string] app_id the id of your application (optional)
+    # @param [hash] opts extra options
+    #
+    # @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"]
+      end
+
+      if api_key.nil? || api_key.empty?
+        raise ArgumentError, "empty api_key parameter and missing or invalid STREAM_URL env variable"
+      end
+
+      @api_key = api_key
+      @api_secret = api_secret
+      @app_id = app_id
+      @location = opts[:location]
+      @api_version = opts.fetch(:api_version, "v1.0")
+      @default_timeout = opts.fetch(:default_timeout, 3)
+      @signer = Stream::Signer.new(api_secret)
+    end
 
+    #
+    # Creates a feed instance
+    #
+    # @param [string] feed_slug the feed slug (eg. flat, aggregated...)
+    # @param [user_id] user_id the user_id of this feed (eg. User42)
+    #
+    # @return [Stream::Feed]
+    #
+    def feed(feed_slug, user_id)
+      token = @signer.sign(feed_slug, user_id)
+      Stream::Feed.new(self, feed_slug, user_id, token)
     end
 
-    class StreamHTTPClient
+    def get_default_params
+      { :api_key => @api_key }
+    end
 
-        include HTTParty
-        attr_reader :base_path
+    def get_http_client
+      StreamHTTPClient.new(@api_version, @location, @default_timeout)
+    end
 
-        def initialize(api_version='v1.0', location=nil, default_timeout=3)
-            if location.nil?
-                location_name = "api"
-            else
-                location_name = "#{location}-api"
-            end
-            @base_path = "/api/#{api_version}"
-            self.class.base_uri "https://#{location_name}.getstream.io#{@base_path}"
-            self.class.default_timeout default_timeout
-        end
+    def make_query_params(params)
+      get_default_params.merge(params)
+    end
 
-        def make_http_request(method, relative_url, params=nil, data=nil, headers=nil)
-            headers['Content-Type'] = 'application/json'
-            headers['User-Agent'] = "stream-ruby-#{Stream::VERSION}"
-            if ['post', 'put'].include? method.to_s 
-                body = data.to_json
-            end
-            response = self.class.send(method, relative_url, :headers => headers, :query => params, :body => body )
-            case response.code
-              when 200..203
-                return response
-              when 204...600
-                raise StreamApiResponseException, "#{response['exception']} details: #{response['detail']}"
-            end
-        end
+    def make_request(method, relative_url, signature, params = {}, data = {}, headers = {})
+      headers["Authorization"] = signature
+      get_http_client.make_http_request(method, relative_url, make_query_params(params), data, headers)
+    end
+  end
+
+  class StreamHTTPClient
+    include HTTParty
+    attr_reader :base_path
+
+    def initialize(api_version = "v1.0", location = nil, default_timeout = 3)
+      if location.nil?
+        location_name = "api"
+      else
+        location_name = "#{location}-api"
+      end
+      @base_path = "/api/#{api_version}"
+      self.class.base_uri "https://#{location_name}.getstream.io#{@base_path}"
+      self.class.default_timeout default_timeout
     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}"
+      body = data.to_json if ["post", "put"].include? method.to_s
+      response = self.class.send(method, relative_url, :headers => headers, :query => params, :body => body)
+      case response.code
+      when 200..203
+        return response
+      when 204...600
+        raise StreamApiResponseException, "#{response['exception']} details: #{response['detail']}"
+      end
+    end
+  end
 end

data/lib/stream/errors.rb

@@ -0,0 +1,5 @@
+module Stream
+  class Error < StandardError; end
+  class StreamApiResponseException < Error; end
+  class StreamInputData < Error; end
+end

data/lib/stream/exceptions.rb

@@ -1,8 +1,2 @@
-module Stream
-
-    class StreamApiResponseException < Exception
-    end
-
-    class StreamInputData < Exception
-    end
-end
+warn "Requiring 'stream/exceptions' is deprecated. Use 'stream/errors' instead."
+require "stream/errors"

data/lib/stream/feed.rb

@@ -1,127 +1,120 @@
-require 'stream/signer'
-
+require "stream/signer"
 
 module Stream
+  class Feed
+    attr_reader :id
+    attr_reader :slug
+    attr_reader :user_id
+    attr_reader :token
+    attr_reader :signature
+
+    def initialize(client, feed_slug, user_id, token)
+      unless valid_feed_slug feed_slug
+        raise StreamInputData, "feed_slug can only contain alphanumeric characters"
+      end
+
+      unless valid_user_id user_id
+        raise StreamInputData, "user_id can only contain alphanumeric characters plus underscores and dashes"
+      end
+
+      @id = "#{feed_slug}:#{user_id}"
+      @client = client
+      @user_id = user_id
+      @slug = feed_slug
+      @feed_url = "#{feed_slug}/#{user_id}"
+      @token = token
+      @signature = "#{feed_slug}#{user_id} #{token}"
+    end
+
+    def valid_feed_slug(feed_slug)
+      !feed_slug[/^[^_\W]+$/].nil?
+    end
 
-    class Feed
-
-        attr_reader :id
-        attr_reader :slug
-        attr_reader :user_id
-        attr_reader :token
-        attr_reader :signature
-
-        def initialize(client, feed_slug, user_id, token)
-
-            if !self.valid_feed_slug feed_slug
-                raise StreamInputData, "feed_slug can only contain alphanumeric characters plus \"_\""
-            end
-
-            if !self.valid_user_id user_id
-                raise StreamInputData, "user_id can only contain alphanumeric characters plus underscores and dashes"
-            end
-
-            @id = "#{feed_slug}:#{user_id}"
-            @client = client
-            @user_id = user_id
-            @slug = feed_slug
-            @feed_url = "#{feed_slug}/#{user_id}"
-            @token = token
-            @signature = "#{feed_slug}#{user_id} #{token}"
-        end
-
-        def valid_feed_slug(feed_slug)
-            !feed_slug[/^\w+$/].nil?
-        end
-
-        def valid_user_id(user_id)
-            !user_id.to_s[/^[\w-]+$/].nil?
-        end
-
-        def get(params = {})
-            uri = "/feed/#{@feed_url}/"
-            if params[:mark_read] and params[:mark_read].kind_of?(Array)
-                params[:mark_read] = params[:mark_read].join(",")
-            end
-            if params[:mark_seen] and params[:mark_seen].kind_of?(Array)
-                params[:mark_seen] = params[:mark_seen].join(",")
-            end
-            @client.make_request(:get, uri, @signature, params)
-        end
-
-        def sign_to_field(to)
-            to.map do |feed_id|
-                feed_slug, user_id = feed_id.split(':')
-                feed = @client.feed(feed_slug, user_id)
-                "#{feed.id} #{feed.token}"
-            end
-        end
-
-        def add_activity(activity_data)
-            uri = "/feed/#{@feed_url}/"
-            activity_data[:to] &&= self.sign_to_field(activity_data[:to])
-            @client.make_request(:post, uri, @signature, {}, activity_data)
-        end
-
-        def add_activities(activities)
-            uri = "/feed/#{@feed_url}/"
-            activities.each do |activity|
-                activity[:to] &&= self.sign_to_field(activity[:to])
-            end
-            data = {:activities => activities}
-            @client.make_request(:post, uri, @signature, {}, data)
-        end
-
-        def remove(activity_id, foreign_id=false)
-            self.remove_activity(activity_id, foreign_id)
-        end
-
-        def remove_activity(activity_id, foreign_id=false)
-            uri = "/feed/#{@feed_url}/#{activity_id}/"
-            params = {}
-            if foreign_id
-                params = {'foreign_id' => 1}
-            end
-            @client.make_request(:delete, uri, @signature, params)
-        end
-
-        def delete()
-            uri = "/feed/#{@feed_url}/"
-            @client.make_request(:delete, uri, @signature)
-        end
-
-        def follow(target_feed_slug, target_user_id)
-            uri = "/feed/#{@feed_url}/follows/"
-            follow_data = {
-                :target => "#{target_feed_slug}:#{target_user_id}",
-                :target_token => @client.feed(target_feed_slug, target_user_id).token
-            }
-            @client.make_request(:post, uri, @signature, {}, follow_data)
-        end
-
-        def followers(offset=0, limit=25)
-            uri = "/feed/#{@feed_url}/followers/"
-            params = {
-                'offset' => offset,
-                'limit' => limit
-            }
-            @client.make_request(:get, uri, @signature, params)
-        end
-
-        def following(offset=0, limit=25, filter=[])
-            uri = "/feed/#{@feed_url}/follows/"
-            params = {
-                'offset' => offset,
-                'limit' => limit,
-                'filter' => filter.join(",")
-            }
-            @client.make_request(:get, uri, @signature, params)
-        end
-
-        def unfollow(target_feed_slug, target_user_id)
-            uri = "/feed/#{@feed_url}/follows/#{target_feed_slug}:#{target_user_id}/"
-            @client.make_request(:delete, uri, @signature)
-        end
+    def valid_user_id(user_id)
+      !user_id.to_s[/^[\w-]+$/].nil?
+    end
+
+    def get(params = {})
+      uri = "/feed/#{@feed_url}/"
+      if params[:mark_read] && params[:mark_read].is_a?(Array)
+        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(",")
+      end
+      @client.make_request(:get, uri, @signature, params)
+    end
+
+    def sign_to_field(to)
+      to.map do |feed_id|
+        feed_slug, user_id = feed_id.split(":")
+        feed = @client.feed(feed_slug, user_id)
+        "#{feed.id} #{feed.token}"
+      end
+    end
+
+    def add_activity(activity_data)
+      uri = "/feed/#{@feed_url}/"
+      activity_data[:to] &&= sign_to_field(activity_data[:to])
+      @client.make_request(:post, uri, @signature, {}, activity_data)
+    end
+
+    def add_activities(activities)
+      uri = "/feed/#{@feed_url}/"
+      activities.each do |activity|
+        activity[:to] &&= sign_to_field(activity[:to])
+      end
+      data = { :activities => activities }
+      @client.make_request(:post, uri, @signature, {}, data)
+    end
+
+    def remove(activity_id, foreign_id = false)
+      remove_activity(activity_id, foreign_id)
+    end
+
+    def remove_activity(activity_id, foreign_id = false)
+      uri = "/feed/#{@feed_url}/#{activity_id}/"
+      params = {}
+      params = { "foreign_id" => 1 } if foreign_id
+      @client.make_request(:delete, uri, @signature, params)
+    end
+
+    def delete
+      uri = "/feed/#{@feed_url}/"
+      @client.make_request(:delete, uri, @signature)
+    end
+
+    def follow(target_feed_slug, target_user_id)
+      uri = "/feed/#{@feed_url}/follows/"
+      follow_data = {
+        :target => "#{target_feed_slug}:#{target_user_id}",
+        :target_token => @client.feed(target_feed_slug, target_user_id).token
+      }
+      @client.make_request(:post, uri, @signature, {}, follow_data)
+    end
+
+    def followers(offset = 0, limit = 25)
+      uri = "/feed/#{@feed_url}/followers/"
+      params = {
+        "offset" => offset,
+        "limit" => limit
+      }
+      @client.make_request(:get, uri, @signature, params)
+    end
+
+    def following(offset = 0, limit = 25, filter = [])
+      uri = "/feed/#{@feed_url}/follows/"
+      params = {
+        "offset" => offset,
+        "limit" => limit,
+        "filter" => filter.join(",")
+      }
+      @client.make_request(:get, uri, @signature, params)
+    end
 
+    def unfollow(target_feed_slug, target_user_id)
+      uri = "/feed/#{@feed_url}/follows/#{target_feed_slug}:#{target_user_id}/"
+      @client.make_request(:delete, uri, @signature)
     end
+  end
 end