stream-ruby 1.0.5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54aa50f3ed493baf8e6a3a6a2df25859facdc696
-  data.tar.gz: 495aba5daa3fb1d36c3c0bc9bdedf6993102fd75
+  metadata.gz: 98bb84c852a5f3ecd8ae404c9253c03ebd876596
+  data.tar.gz: f218d9d8f3a8a2d776c307a0a8c6b0c375787bb8
 SHA512:
-  metadata.gz: fe178a263bb210866451c3268ce307a7b512c49708b52aefdf7e49c7c4bf9449ccd62f810b829d63733e8b9d7a124af70f141b02ab16c43630b6998dad1fa1d7
-  data.tar.gz: 961d0889af207061376d97c9c31e61e27180ce92ca8d91dfc19c79275d38c856b40068f772a16148c35ffd38dfee886917b72345b9056a3c9cfb36c60194b738
+  metadata.gz: 65aaf626783bcb8bce5bb8041dd4dae9ace6d78bb0337f51e630ef7b0fe343d4c0110794ca5d1114f9394095f4b13f30c01a01954078a5a51ee397f7d67e17e5
+  data.tar.gz: 91c658f7c1fce6d50f5dc9c882c591bf6cf66405652be0b161bffd4345e0c8f610b3ec6b33ab57fa4a0168d16fc4bdda85b457aa3a7efe7f61b8375a3e059dea

data/README.md

@@ -20,7 +20,7 @@ client = Stream::Client.new('YOUR_API_KEY', 'API_KEY_SECRET')
 # Find your API keys here https://getstream.io/dashboard/
 
 # Instantiate a feed object
-user_feed_1 = client.feed('user:1')
+user_feed_1 = client.feed('user', '1')
 
 # Get activities from 5 to 10 (slow pagination)
 result = user_feed_1.get(:limit=>5, :offset=>5)
@@ -45,10 +45,10 @@ user_feed_1.remove('e561de8f-00f1-11e4-b400-0cc47a024be0')
 user_feed_1.remove('tweet:1', foreign_id=true)
 
 # Follow another feed
-user_feed_1.follow('flat:42')
+user_feed_1.follow('flat', '42')
 
 # Stop following another feed
-user_feed_1.unfollow('flat:42')
+user_feed_1.unfollow('flat', '42')
 
 # Batch adding activities
 activities = [
@@ -76,19 +76,19 @@ token = user_feed_1.token
 # user1 = client.feed('user:1', '{{ token }}');
 
 # Retrieve first 10 followers of a feed
-user_feed_1.followers(0, 10);
+user_feed_1.followers(0, 10)
 
 # Retrieve followers from 10 to 20
-user_feed_1.followers(10, 10);
+user_feed_1.followers(10, 10)
 
 # Retrieve 10 feeds followed by user_feed_1
-user_feed_1.following(10);
+user_feed_1.following(10)
 
 # Retrieve 10 feeds followed by user_feed_1 starting from the 11th
-user_feed_1.following(10, 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']);
+user_feed_1.following(0, 2, filter=['user:42', 'user:43'])
 
 ```
 

data/lib/stream/base.rb

@@ -9,7 +9,7 @@ module Stream
             Stream::Client.new(api_key, api_secret)
         end
 
-        def clean_feed_id(feed_id)
+        def get_feed_slug_and_id(feed_id)
             feed_id.sub(':', '')
         end
     end

data/lib/stream/client.rb

@@ -1,21 +1,25 @@
-require 'stream/signer'
+require 'httparty'
+require 'stream/exceptions'
 require 'stream/feed'
+require 'stream/signer'
+
 
 module Stream
-    STREAM_URL_RE = /https\:\/\/(?<key>\w+)\:(?<secret>\w+).*site=(?<site>\d+)/i
+    STREAM_URL_RE = /https\:\/\/(?<key>\w+)\:(?<secret>\w+).*app_id=(?<app_id>\d+)/i
 
     class Client
+        @@http_client = nil
         attr_reader :api_key
         attr_reader :api_secret
-        attr_reader :site
+        attr_reader :app_id
+        attr_reader :api_version
 
-        def initialize(api_key='', api_secret='', site=0)
-            
+        def initialize(api_key='', api_secret='', app_id=nil)
             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']
-                site = matches['site']
+                app_id = matches['app_id']
             end
 
             if api_key.nil? || api_key.empty?
@@ -24,15 +28,51 @@ module Stream
 
             @api_key = api_key
             @api_secret = api_secret
-            @site = site
+            @app_id = app_id
             @signer = Stream::Signer.new(api_secret)
         end
 
-        def feed(feed_id)
-            cleaned_feed_id = Stream::clean_feed_id(feed_id)
-            signature = @signer.signature(cleaned_feed_id)
-            Stream::Feed.new(self, feed_id, @api_key, signature)
+        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
+            @@http_client ||= StreamHTTPClient.new
+        end
+
+        def make_request(method, relative_url, signature, params=nil, data=nil)
+            auth_headers = {'Authorization' => signature}
+            params = params.nil? ? {} : params
+            data = data.nil? ? {} : data
+            default_params = self.get_default_params
+            default_params.merge!(params)
+            response = self.get_http_client.make_http_request(method, relative_url, default_params, data, auth_headers)
         end
 
     end
-end
+
+    class StreamHTTPClient
+
+        include HTTParty
+        base_uri 'https://getstream.io/api/v1.0'
+        default_timeout 3
+
+        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}"
+            response = self.class.send(method, relative_url, :headers => headers, :query => params, :body => data.to_json )
+            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/feed.rb

@@ -1,61 +1,24 @@
-require 'httparty'
 require 'stream/signer'
-require 'stream/exceptions'
 
-module Stream
-
-    class StreamHTTPClient
-
-        include HTTParty
-        base_uri 'https://getstream.io/api'
-
-        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}"
-            response = self.class.send(method, relative_url, :headers => headers, :query => params, :body => data.to_json )
-            case response.code
-              when 200..203
-                return response
-              when 204...600
-                raise StreamApiResponseException, response
-            end
-        end
 
-    end
+module Stream
 
     class Feed
-        @@http_client = nil
 
-        attr_reader :feed_id
+        attr_reader :id
+        attr_reader :slug
+        attr_reader :user_id
         attr_reader :token
+        attr_reader :signature
 
-        def initialize(client, feed_id, api_key, signature)
+        def initialize(client, feed_slug, user_id, token)
+            @id = "#{feed_slug}:#{user_id}"
             @client = client
-            @feed_id = feed_id
-            @feed_url = feed_id.sub(':', '/')
-            @api_key = api_key
-            @token = signature
-            cleaned_feed_id = Stream::clean_feed_id(feed_id)
-            @auth_headers = {'Authorization' => "#{cleaned_feed_id} #{signature}"}
-        end
-
-        def get_http_client
-            if @@http_client.nil?
-                @@http_client = StreamHTTPClient.new
-            end
-            @@http_client
-        end
-
-        def get_default_params
-            {:api_key => @api_key}
-        end
-
-        def make_request(method, relative_url, params=nil, data=nil)
-            params = params.nil? ? {} : params
-            data = data.nil? ? {} : data
-            default_params = self.get_default_params
-            default_params.merge!(params)
-            response = self.get_http_client.make_http_request(method, relative_url, default_params, data, @auth_headers)
+            @user_id = user_id
+            @slug = feed_slug
+            @feed_url = "#{feed_slug}/#{user_id}"
+            @token = token
+            @signature = "#{feed_slug}#{user_id} #{token}"
         end
 
         def get(params = {})
@@ -66,34 +29,30 @@ module Stream
             if params[:mark_seen] and params[:mark_seen].kind_of?(Array)
                 params[:mark_seen] = params[:mark_seen].join(",")
             end
-            self.make_request(:get, uri, params)
+            @client.make_request(:get, uri, @signature, params)
         end
 
         def sign_to_field(to)
-            to.map do |feed|
-                feed_id = Stream::clean_feed_id(feed)
-                token = @client.feed(feed_id).token
-                "#{feed} #{token}"
+            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}/"
-            if !activity_data[:to].nil?
-                activity_data[:to] = self.sign_to_field(activity_data[:to])
-            end
-            self.make_request(:post, uri, nil, activity_data)
+            activity_data[:to] &&= self.sign_to_field(activity_data[:to])
+            @client.make_request(:post, uri, @signature, nil, activity_data)
         end
 
         def add_activities(activities)
             uri = "/feed/#{@feed_url}/"
             activities.each do |activity|
-                if !activity[:to].nil?
-                    activity[:to] = self.sign_to_field(activity[:to])
-                end
+                activity[:to] &&= self.sign_to_field(activity[:to])
             end
             data = {:activities => activities}
-            self.make_request(:post, uri, nil, data)
+            @client.make_request(:post, uri, @signature, nil, data)
         end
 
         def remove(activity_id, foreign_id=false)
@@ -102,21 +61,21 @@ module Stream
             if foreign_id
                 params = {'foreign_id' => 1}
             end
-            self.make_request(:delete, uri, params)
+            @client.make_request(:delete, uri, @signature, params)
         end
 
         def delete()
             uri = "/feed/#{@feed_url}/"
-            self.make_request(:delete, uri)
+            @client.make_request(:delete, uri, @signature)
         end
 
-        def follow(target_feed_id)
+        def follow(target_feed_slug, target_user_id)
             uri = "/feed/#{@feed_url}/follows/"
             follow_data = {
-                :target => target_feed_id,
-                :target_token => @client.feed(target_feed_id).token
+                :target => "#{target_feed_slug}:#{target_user_id}",
+                :target_token => @client.feed(target_feed_slug, target_user_id).token
             }
-            self.make_request(:post, uri, nil, follow_data)
+            @client.make_request(:post, uri, @signature, nil, follow_data)
         end
 
         def followers(offset=0, limit=25)
@@ -125,7 +84,7 @@ module Stream
                 'offset' => offset,
                 'limit' => limit
             }
-            self.make_request(:get, uri, params)
+            @client.make_request(:get, uri, @signature, params)
         end
 
         def following(offset=0, limit=25, filter=[])
@@ -135,12 +94,12 @@ module Stream
                 'offset' => offset,
                 'filter' => filter.join(",")
             }
-            self.make_request(:get, uri, params)
+            @client.make_request(:get, uri, @signature, params)
         end
 
-        def unfollow(target_feed_id)
-            uri = "/feed/#{@feed_url}/follows/#{target_feed_id}/"
-            self.make_request(:delete, uri)
+        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

data/lib/stream/signer.rb

@@ -14,10 +14,12 @@ module Stream
             value.gsub('+', '-').gsub('/', '_').gsub(/^=+/, '').gsub(/=+$/, '')
         end
 
-        def signature(message)
+        def sign(feed_slug, user_id)
+            message = "#{feed_slug}#{user_id}"
             key = Digest::SHA1.digest @key.to_s
-            signature = Base64.strict_encode64(OpenSSL::HMAC.digest(@sha1, key, message.to_s))
-            self.urlSafeB64encode(signature)
+            token = Base64.strict_encode64(OpenSSL::HMAC.digest(@sha1, key, message))
+            self.urlSafeB64encode(token)
         end
+
     end
 end

data/lib/stream/version.rb

@@ -1,3 +1,3 @@
 module Stream
-  VERSION = "1.0.5"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: stream-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 2.0.0
 platform: ruby
 authors:
 - Tommaso Barbugli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-30 00:00:00.000000000 Z
+date: 2014-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -58,15 +58,15 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
-description: 
+        version: '0.7'
+description: Ruby client for getstream.io service
 email: tbarbugli@gmail.com
 executables: []
 extensions: []