stream-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c1225f2fbc4300a3dc90c9798396eec25fc1b46
+  data.tar.gz: 31c0a060ab08e8c6ef5dcdb5d42ef47d1cc2437d
+SHA512:
+  metadata.gz: c07f32235abbff7cd5883eabbb1583064fc7f4c7768ae3ade4df2472909fe20f61d979e12b309683fa7a2be06ae573cc321e3e6c3a3a057a0c72f07ece4abba8
+  data.tar.gz: 6fa48a3b8a86450a376c9e830670596946811df1feff3906cca9bb28909d173561fa61cd657b33453e22af5ce3f653f6c8a5b421f75631f3ce7340761edb389c

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2014, Tommaso Barbugli
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the {organization} nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,49 @@
+stream-ruby
+=========
+
+.. image:: https://circleci.com/gh/tbarbugli/stream-ruby.png
+   :target: https://circleci.com/gh/tbarbugli/stream-ruby.png/tree/master
+
+
+stream-ruby is a Ruby client for `Stream <https://getstream.io/>`_.
+
+.. code-block:: ruby
+
+    # Instantiate a new client
+    require 'stream'
+    client = Stream::Client.new('YOUR_API_KEY', 'API_KEY_SECRET')
+
+    # Instantiate a feed object
+    user_feed_1 = client.feed('user:1')
+
+    # Get activities from 5 to 10 (slow pagination)
+    result = user_feed_1.get(:limit=>5, :offset=>5)
+    # (Recommended & faster) Filter on an id less than 112334
+    result = user_feed_1.get(:limit=>5, :id_lt=>112334)
+    
+    # Create a new activity
+    activity_data = {:actor => 1, :verb => 'tweet', :object => 1}
+    activity_response = user_feed_1.add_activity(activity_data)
+
+    # Remove an activity by its id
+    user_feed_1.remove('12345678910')
+    
+    # Follow another feed
+    user_feed_1.follow('flat:42')
+
+    # Stop following another feed
+    user_feed_1.unfollow('flat:42')
+    
+    
+Docs are available on `GetStream.io`_.
+
+.. _GetStream.io: http://getstream.io/docs/
+
+
+Installation
+------------
+
+.. code-block:: bash
+
+    gem "stream"
+

data/lib/stream.rb

@@ -0,0 +1 @@
+require 'stream/base'

data/lib/stream/base.rb

@@ -0,0 +1,15 @@
+require 'stream/client'
+require 'stream/version'
+require 'stream/signer'
+
+module Stream
+    class << self
+        def connect(api_key, api_secret)
+            Stream::Client.new(api_key, api_secret)
+        end
+
+        def clean_feed_id(feed_id)
+            feed_id.sub(':', '')
+        end
+    end
+end

data/lib/stream/client.rb

@@ -0,0 +1,20 @@
+require 'stream/signer'
+require 'stream/feed'
+
+module Stream
+    class Client
+
+        def initialize(api_key, api_secret)
+            @api_key = api_key
+            @api_secret = api_secret
+            @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(feed_id, @api_key, signature)
+        end
+
+    end
+end

data/lib/stream/feed.rb

@@ -0,0 +1,76 @@
+require 'httparty'
+require 'stream/signer'
+
+
+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)
+            response = self.class.send(method, relative_url, headers: headers, query: params, body: data)
+        end
+
+    end
+
+    class Feed
+        @@http_client = nil
+
+        attr_reader :feed_id
+
+        def initialize(feed_id, api_key, signature)
+            @feed_id = Stream::clean_feed_id(feed_id)
+            @feed_url = feed_id.sub(':', '/')
+            @api_key = api_key
+            @auth_headers = {'Authorization' => "#{@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)
+            self.get_http_client.make_http_request(method, relative_url, default_params, data, @auth_headers)
+        end
+
+        def get(params = {})
+            uri = "/feed/#{@feed_url}/"
+            self.make_request(:get, uri, params)
+        end
+
+        def add_activity(activity_data)
+            uri = "/feed/#{@feed_url}/"
+            self.make_request(:post, uri, nil, activity_data)
+        end
+
+        def remove(activity_id)
+            uri = "/feed/#{@feed_url}/#{activity_id}/"
+            self.make_request(:delete, uri)
+        end
+
+        def follow(target_feed_id)
+            uri = "/feed/#{@feed_url}/follows/"
+            follow_data = {:target => target_feed_id}
+            self.make_request(:post, uri, nil, follow_data)
+        end
+
+        def unfollow(target_feed_id)
+            uri = "/feed/#{@feed_url}/follows/#{target_feed_id}/"
+            self.make_request(:delete, uri)
+        end
+
+    end
+end

data/lib/stream/signer.rb

@@ -0,0 +1,23 @@
+require 'openssl'
+require 'base64'
+
+module Stream
+    class Signer
+        @key = nil
+
+        def initialize(key)
+            @key = key.to_s
+            @sha1 = OpenSSL::Digest::Digest.new('sha1')
+        end
+
+        def urlSafeB64encode(value)
+            value.gsub('+', '-').gsub('/', '_').gsub(/^=+/, '').gsub(/=+$/, '')
+        end
+
+        def signature(message)
+            key = Digest::SHA1.digest @key.to_s
+            signature = Base64.strict_encode64(OpenSSL::HMAC.digest(@sha1, key, message.to_s))
+            self.urlSafeB64encode(signature)
+        end
+    end
+end

data/lib/stream/version.rb

@@ -0,0 +1,3 @@
+module Stream
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: stream-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tommaso Barbugli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-30 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
+  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'
+description: 
+email: tbarbugli@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- lib/stream.rb
+- lib/stream/base.rb
+- lib/stream/client.rb
+- lib/stream/feed.rb
+- lib/stream/signer.rb
+- lib/stream/version.rb
+homepage: http://github.com/tbarbugli/stream-ruby
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A gem that provides a client interface for getstream.io
+test_files: []