stream-ruby 2.1.4 → 2.2

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 5b6e6a3468fc1757df4b358a7f521fe32d94e455
-  data.tar.gz: 856c8f50608e8084528344fc89c37e5277cc8e11
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzdlMDc4MGY1MDM0MmE3Y2UwYWMyMGIzODNkMDM4YjRiZTQ0NTY5Mw==
+  data.tar.gz: !binary |-
+    MjhhZjVhOTRmM2I5YTBiZWYxNDIwNDZjY2IyNThjOTViY2JlNDBhYQ==
 SHA512:
-  metadata.gz: 63268718ab521073158953dcf4625913544e224df1ec71c4be95f795b6b6f21df9ead1f611ed66d7ac994b5b5a0244c552603c73aae3fd9cba53735067087d0d
-  data.tar.gz: 33ab5d87d4016bc853549be59dce853d530723345bfeb4acd4f9b382716fd4daf712c87be82fe986d7051dbd10e287d4b1463991d0be51e22fa68bd7a112a0d1
+  metadata.gz: !binary |-
+    MjMyYzY2M2ZjZjgxMTJiMmQwY2U5YTI3OTJkZDE5MjdmOGIwNjAyYzY1Yzg1
+    ZTMyMmY0MDUyZWE0ZmRmYjlkZTc3MTYzZDc1NzFjNWRjZWZhMDc4NTc5MTdk
+    MzU1MGFjM2YwODc1ZDE5NWM2YzgxM2JhYmVhNDliNDAzZTNkMzI=
+  data.tar.gz: !binary |-
+    ODZlZDlhYTBiMzBjNzU5MDg4OTU0NTJkNDA5NmQzY2IyZWQwNzExYmQ3ZThi
+    NTFiMWQzNmFlYTMyMmI5NzE3MDlmODRmMmZkYzJlNzAwZmM0NzdkMjZkNzQ4
+    NjNjMTljNWQ2YjZjODE5MDExMzA1NmE1OTIwM2I5YTNhMmM3NDk=

data/README.md

@@ -41,7 +41,7 @@ activity_data = {:actor => 1, :verb => 'tweet', :object => 1, :foreign_id => 'tw
 	:course => {:name => 'Golden Gate park', :distance => 10},
 	:participants => ['Thierry', 'Tommaso'],
 	:started_at => DateTime.now()
-};
+}
 activity_response = user_feed_1.add_activity(activity_data)
 
 # Remove an activity by its id
@@ -60,8 +60,16 @@ user_feed_1.unfollow('flat', '42')
 activities = [
     [:actor => '1', :verb => 'tweet', :object => '1'],
     [:actor => '2', :verb => 'like', :object => '3']
-];
-user_feed_1.addActivities(activities);
+]
+user_feed_1.addActivities(activities)
+
+# Batch following many feeds
+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
 data = [
@@ -69,8 +77,8 @@ data = [
     :verb => "like",
     :object_id => "3",
     :to => ["user:44", "user:45"]
-];
-user_feed_1.add_activity(data);
+]
+user_feed_1.add_activity(data)
 
 # Remove a feed and its content
 user_feed_1.delete

data/lib/stream/batch.rb

@@ -0,0 +1,36 @@
+module Stream
+
+  module Batch
+      #
+      # Follows many feeds in one single request
+      #
+      # @param [Array<Hash<:source, :target>>] follows the list of follows
+      #
+      # @return [nil]
+      # 
+      # @example
+      # 
+      # client.follow_many([['flat:4', 'user:1'], ['flat:4', 'user:2']])
+      # 
+      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
+    end
+
+end

data/lib/stream/client.rb

@@ -3,6 +3,7 @@ require 'stream/exceptions'
 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
 
@@ -14,6 +15,24 @@ module Stream
         attr_reader :location
         attr_reader :default_timeout
 
+        if RUBY_VERSION >= "2.0"
+            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'])
@@ -36,6 +55,14 @@ module Stream
             @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)
@@ -49,13 +76,13 @@ module Stream
             StreamHTTPClient.new(@api_version, @location, @default_timeout)
         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)
+        def make_query_params(params)
+            self.get_default_params.merge(params)
+        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
 
     end
@@ -63,6 +90,7 @@ module Stream
     class StreamHTTPClient
 
         include HTTParty
+        attr_reader :base_path
 
         def initialize(api_version='v1.0', location=nil, default_timeout=3)
             if location.nil?
@@ -70,7 +98,8 @@ module Stream
             else
                 location_name = "#{location}-api"
             end
-            self.class.base_uri "https://#{location_name}.getstream.io/api/#{api_version}"
+            @base_path = "/api/#{api_version}"
+            self.class.base_uri "https://#{location_name}.getstream.io#{@base_path}"
             self.class.default_timeout default_timeout
         end
 

data/lib/stream/feed.rb

@@ -60,7 +60,7 @@ module Stream
         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, nil, activity_data)
+            @client.make_request(:post, uri, @signature, {}, activity_data)
         end
 
         def add_activities(activities)
@@ -69,7 +69,7 @@ module Stream
                 activity[:to] &&= self.sign_to_field(activity[:to])
             end
             data = {:activities => activities}
-            @client.make_request(:post, uri, @signature, nil, data)
+            @client.make_request(:post, uri, @signature, {}, data)
         end
 
         def remove(activity_id, foreign_id=false)
@@ -78,7 +78,7 @@ module Stream
 
         def remove_activity(activity_id, foreign_id=false)
             uri = "/feed/#{@feed_url}/#{activity_id}/"
-            params = nil
+            params = {}
             if foreign_id
                 params = {'foreign_id' => 1}
             end
@@ -96,7 +96,7 @@ module Stream
                 :target => "#{target_feed_slug}:#{target_user_id}",
                 :target_token => @client.feed(target_feed_slug, target_user_id).token
             }
-            @client.make_request(:post, uri, @signature, nil, follow_data)
+            @client.make_request(:post, uri, @signature, {}, follow_data)
         end
 
         def followers(offset=0, limit=25)

data/lib/stream/signedrequest.rb

@@ -0,0 +1,36 @@
+require "http_signatures"
+require "net/http"
+require "time"
+
+module Stream
+
+  module SignedRequest
+    def make_signed_request(method, relative_url, params={}, data={})
+        query_params = self.make_query_params(params)
+        context = HttpSignatures::Context.new(
+            keys: {@api_key => @api_secret},
+            algorithm: "hmac-sha256",
+            headers: ["(request-target)", "Date"],
+        )
+        method_map = {
+            :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(
+          "#{self.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' => self.api_key
+        }
+        self.get_http_client.make_http_request(method, relative_url, query_params, data, headers)
+    end
+  end
+
+end

data/lib/stream/signer.rb

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

data/lib/stream/version.rb

@@ -1,3 +1,3 @@
 module Stream
-  VERSION = "2.1.4"
+  VERSION = "2.2"
 end

metadata

@@ -1,69 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: stream-ruby
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: '2.2'
 platform: ruby
 authors:
 - Tommaso Barbugli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-16 00:00:00.000000000 Z
+date: 2015-01-25 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: http_signatures
+  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
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.10'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.7'
 description: Ruby client for getstream.io service
@@ -103,9 +117,11 @@ files:
 - lib/coverage/index.html
 - lib/stream.rb
 - lib/stream/base.rb
+- lib/stream/batch.rb
 - lib/stream/client.rb
 - lib/stream/exceptions.rb
 - lib/stream/feed.rb
+- lib/stream/signedrequest.rb
 - lib/stream/signer.rb
 - lib/stream/version.rb
 homepage: http://github.com/GetStream/stream-ruby
@@ -118,12 +134,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -133,3 +149,4 @@ signing_key:
 specification_version: 4
 summary: A gem that provides a client interface for getstream.io
 test_files: []
+has_rdoc: true