tambur-client 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in ruby-tambur.gemspec
+gemspec

data/README.md

@@ -0,0 +1,58 @@
+## Ruby Tambur.io REST API Client [![Build Status](https://secure.travis-ci.org/tamburio/ruby-tambur.png?branch=master)](http://travis-ci.org/tamburio/ruby-tambur)
+Tambur.io provides a pain-free websocket experience.
+###Preliminary
+Install this library preferably using [bundler][1]:
+
+    gem "ruby-tambur", :git => "git://github.com/tamburio/ruby-tambur.git", :branch => "master"
+
+Please register on [Tambur.io][2] and create at least one app. This will give you the unique API\_KEY, an APP\_ID and a SECRET, which you need to initialize the client.
+
+###Example
+```ruby
+require 'ruby-tambur'
+tambur = Tambur::Connector.new(API_KEY, APP_ID, SECRET)
+tambur.publish('mystream', 'some message')
+```
+The example above publishes the given message to all subscribed clients. Clients can set different modes for streams they have subscribed. Currently the Tambur.io supports a 'auth', 'presence', and 'direct' mode. But you must grant permission by issueing a specific mode token. For generating such tokens you typically need the StreamName, the SubscriberId, and for direct- and presence-modes the UserId. The SubscriberId is the only parameter your clients must send you e.g. through some AJAX request which you can answer with the generated mode token.
+
+####Auth Mode
+If you issue an auth mode token, the client can authenticate himself for a particular stream. If you use the <code>auth:</code> stream prefix you can control how we deliver your message.
+```ruby
+tambur.publish('auth:mystream', 'some auth message')
+```
+The example above publishes the given message to all subscribed clients that have the auth mode enabled.
+Issuing an auth mode token is straight forward:
+```ruby
+tambur.generate_auth_token('mystream', subscriber_id)
+```
+
+####Presence Mode 
+If you issue a presence mode token, the client can switch on and off presence mode. If presence mode is switched on the client will receive join- and leave-events of all the other presence clients in that particular stream. Issuing a presence mode token needs an extra 'User-Id' parameter, which enables you to connect a tambur.io subscriber-id to a User-Id used in your application:
+```ruby
+tambur.generate_presence_token('mystream', 'Alice', subscriber_id)
+```
+
+####Direct Mode
+If you issue a direct mode token, the client can switch on and off direct mode. If direct mode is switched on the client can send and receive messages from other clients in that particular stream. Issuing a direct mode token needs an extra 'User-Id' parameter, which enables you to connect a tambur.io subscriber-id to a User-Id used in your application:
+```ruby
+tambur.generate_direct_token('mystream', 'Alice', subscriber_id)
+```
+
+####Private Messages
+If you want to further limit your receivers to one specific subscriber you can do this using the 'private' stream.
+```ruby
+tambur.publish('private:' + subscriber_id, 'some private message')
+```
+
+##License (MIT)
+Copyright (c) \<2012\> \<Tambur.io\>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+  [1]: http://gembundler.com//
+  [2]: http://tambur.io

data/Rakefile

@@ -0,0 +1,32 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :default => ['test:units']
+
+def rubies
+  require 'yaml'
+  rubies = YAML.load_file('.travis.yml')['rvm']
+end
+
+namespace :test do
+  Rake::TestTask.new(:units) do |t|
+    t.libs << "test"
+    t.test_files = FileList['test/*_test.rb']
+
+    t.verbose = true
+  end
+
+  desc 'run bundle install for all rubies'
+  task :prepare_rubies do
+    rubies.each do |ruby_version|
+      puts `rvm use #{ruby_version} && gem install bundler && bundle`
+    end
+  end
+
+  desc 'run test suite with all ruby versions'
+  task :multi_ruby do
+    rubies.each do |ruby_version|
+      puts `rvm use #{ruby_version} && bundle exec rake`
+    end
+  end
+end

data/lib/ruby-tambur/vendor/oauth_util.rb

@@ -0,0 +1,102 @@
+module Tambur
+  begin
+    require 'uri'
+    require 'cgi'
+    require 'openssl'
+    require 'base64'
+  rescue LoadError
+  end
+
+  module Util
+    # A utility for signing an url using OAuth in a way that's convenient for debugging
+    # Note: the standard Ruby OAuth lib is here http://github.com/mojodna/oauth
+    # License: http://gist.github.com/375593
+    # Usage: see example.rb below
+    class OAuth
+
+      attr_accessor :consumer_key, :consumer_secret, :token, :token_secret, :req_method,
+        :sig_method, :oauth_version, :callback_url, :params, :req_url, :base_str
+
+      def initialize
+        @consumer_key = ''
+        @consumer_secret = ''
+        @token = ''
+        @token_secret = ''
+        @req_method = 'GET'
+        @sig_method = 'HMAC-SHA1'
+        @oauth_version = '1.0'
+        @callback_url = ''
+      end
+
+      # openssl::random_bytes returns non-word chars, which need to be removed. using alt method to get length
+      # ref http://snippets.dzone.com/posts/show/491
+      def nonce
+        Array.new( 5 ) { rand(256) }.pack('C*').unpack('H*').first
+      end
+
+      def percent_encode( string )
+        return URI.escape( string, /[^a-zA-Z0-9\-\.\_\~]/)
+      end
+
+      # @ref http://oauth.net/core/1.0/#rfc.section.9.2
+      def signature
+        key = percent_encode( @consumer_secret ) + '&' + percent_encode( @token_secret )
+
+        # ref: http://blog.nathanielbibler.com/post/63031273/openssl-hmac-vs-ruby-hmac-benchmarks
+        digest = OpenSSL::Digest::Digest.new( 'sha1' )
+        hmac = OpenSSL::HMAC.digest( digest, key, @base_str )
+
+        # ref http://groups.google.com/group/oauth-ruby/browse_thread/thread/9110ed8c8f3cae81
+        Base64.encode64( hmac ).chomp.gsub( /\n/, '' )
+      end
+
+      # sort (very important as it affects the signature), concat, and percent encode
+      # @ref http://oauth.net/core/1.0/#rfc.section.9.1.1
+      # @ref http://oauth.net/core/1.0/#9.2.1
+      # @ref http://oauth.net/core/1.0/#rfc.section.A.5.1
+      def query_string
+        pairs = []
+        @params.sort.each { | key, val |
+          pairs.push( "#{ percent_encode( key ) }=#{ percent_encode( val.to_s ) }" )
+        }
+        pairs.join '&'
+      end
+
+      # organize params & create signature
+      def sign( parsed_url )
+
+        @params = {
+          'oauth_consumer_key' => @consumer_key,
+          'oauth_nonce' => nonce,
+          'oauth_signature_method' => @sig_method,
+          'oauth_timestamp' => Time.now.to_i.to_s,
+          'oauth_version' => @oauth_version
+        }
+
+        # if url has query, merge key/values into params obj overwriting defaults
+        if parsed_url.query
+          @params.merge! CGI.parse( parsed_url.query ).inject({}){|h, (k, v)|h[k.to_s] = v[0];h}
+        end
+
+        # @ref http://oauth.net/core/1.0/#rfc.section.9.1.2
+        @req_url = parsed_url.scheme + '://' + parsed_url.host + parsed_url.path
+
+        # create base str. make it an object attr for ez debugging
+        # ref http://oauth.net/core/1.0/#anchor14
+        @base_str = [
+          @req_method,
+          percent_encode( req_url ),
+
+          # normalization is just x-www-form-urlencoded
+          percent_encode( query_string )
+
+        ].join( '&' )
+
+        # add signature
+        @params[ 'oauth_signature' ] = signature
+
+        return self
+      end
+    end
+  end
+end

data/lib/ruby-tambur/version.rb

@@ -0,0 +1,3 @@
+module Tambur
+  VERSION = "0.0.1"
+end

data/lib/ruby-tambur.rb

@@ -0,0 +1,53 @@
+require "ruby-tambur/version"
+require "ruby-tambur/vendor/oauth_util.rb"
+require 'net/http'
+require 'openssl'
+
+module Tambur
+    class Connector
+        def initialize(api_key, app_id, secret, options = {})
+            @app_id = app_id
+            @api_host = options[:api_host] || 'api.tambur.io'
+            @oauth = Tambur::Util::OAuth.new()
+            @oauth.consumer_key=api_key
+            @oauth.consumer_secret=secret
+            @oauth.req_method='POST'
+        end
+
+        def publish(stream, message)
+            path = '/app/' + @app_id + '/stream/' + stream.to_str+'?api_version=1.0&message='+ CGI::escape(message)
+            url = URI.parse('http://' + @api_host + path)
+            Net::HTTP.start(url.host) do | http |
+                request = Net::HTTP::Post.new(url.path)
+                request.body = @oauth.sign(url).query_string()
+                request['Content-Type'] = 'application/x-www-form-urlencoded'
+                response = http.request(request)
+                if response.code == '204'
+                    return true
+                else
+                    raise 'publish error: '+response.read_body
+                end
+            end
+        end
+
+        def generate_auth_token(stream, subscriber_id)
+            return generate_mode_token('auth', stream, subscriber_id)
+        end
+
+        def generate_presence_token(stream, user_id, subscriber_id)
+            return generate_mode_token('presence', stream + ':' + user_id, subscriber_id)
+        end
+
+        def generate_direct_token(stream, user_id, subscriber_id)
+            return generate_mode_token('direct', stream + ':' + user_id, subscriber_id)
+        end
+
+        private
+        def generate_mode_token(mode, property, subscriber_id)
+            mode_string = @oauth.consumer_key + ':' + @app_id + ':' + mode + ':' + property + ':' + subscriber_id
+            digest = OpenSSL::Digest::Digest.new( 'sha1' )
+            return OpenSSL::HMAC.hexdigest( digest, @oauth.consumer_secret, mode_string)
+        end
+
+    end
+end

data/ruby-tambur.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ruby-tambur/version"
+
+Gem::Specification.new do |s|
+  s.name        = "tambur-client"
+  s.version     = Tambur::VERSION
+  s.authors     = ["Andre Graf"]
+  s.email       = ["graf@tambur.io"]
+  s.homepage    = "https://github.com/tamburio/ruby-tambur"
+  s.summary     = %q{Simple Client for the Tambur.io REST API}
+  s.description = %q{Simple Client for the Tambur.io REST API}
+
+  s.rubyforge_project = "ruby-tambur"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rake"
+  s.add_runtime_dependency "json"
+end

data/test/tambur_test.rb

@@ -0,0 +1,84 @@
+require 'test_helper'
+
+class TamburPublishTest < Test::Unit::TestCase
+
+    def setup
+        url = URI.parse('http://wsbot.tambur.io')
+        Net::HTTP::start(url.host, url.port) {|http|
+            credentials = JSON.parse(http.get('/credentials').read_body)
+            @api_key = credentials['api_key']
+            @app_id = credentials['app_id']
+            @secret = credentials['secret']
+            @subscriber_id = http.get('/subscriber_id').read_body
+        }
+        @tambur = Tambur::Connector.new(@api_key, @app_id, @secret)
+    end
+
+    def test_publish
+        publish('test', 'test message')
+    end
+
+    def test_auth_publish
+        publish('auth:test', 'test message')
+    end
+
+    def test_private_publish
+        publish('private:'+@subscriber_id, 'test message')
+    end
+
+    def publish(stream, msg)
+        handle = generate_handle()
+        msg = {'handle' => handle, 'msg' => msg}
+        json_msg = msg.to_json()
+        assert_equal(true, @tambur.publish(stream, json_msg))
+        sleep(0.5)
+        url = URI.parse('http://wsbot.tambur.io')
+        Net::HTTP.start(url.host) { | http |
+            request = Net::HTTP::Get.new('/results?handle='+handle)
+        results = JSON.parse(http.request(request).read_body)
+        assert_equal(1, results.length)
+        if stream.start_with? 'private'
+            assert_equal(results[0][handle], {'private' => msg})
+        else
+            assert_equal(results[0][handle], {stream => msg})
+        end
+        }
+
+    end
+end
+
+class TamburAuthTokenTest < Test::Unit::TestCase
+
+    def setup
+        @tambur = Tambur::Connector.new('30af96de47e3c58329045ff136a4a3ea', 'ws-bot-1', 'wsbot')
+    end
+
+    def test_generate_auth_token
+        stream = 'test'
+        subscriber_id = 'a0629978-28d8-4fd4-b862-f67e9b6dfd8f'
+        token = @tambur.generate_auth_token(stream, subscriber_id)
+        assert_equal('2f25ad1ce5afab906cc582b6254a912590c60f73', token)
+    end
+
+    def test_generate_presence_token
+        stream = 'test'
+        user_id = 'test_user'
+        subscriber_id = 'a0629978-28d8-4fd4-b862-f67e9b6dfd8f'
+        token = @tambur.generate_presence_token(stream, user_id, subscriber_id)
+        assert_equal('dcadf9659116ebbe024a4cd5ae12bde48d95408e', token)
+    end
+
+    def test_generate_direct_token
+        stream = 'test'
+        user_id = 'test_user'
+        subscriber_id = 'a0629978-28d8-4fd4-b862-f67e9b6dfd8f'
+        token = @tambur.generate_direct_token(stream, user_id, subscriber_id)
+        assert_equal('2403374744295f5d22e3f999d4eb85b3f689c6b2', token)
+    end
+end
+
+def generate_handle
+    s = ""
+    6.times { s << (i = Kernel.rand(62); i += ((i < 10) ? 48 : ((i < 36) ? 55 : 61 ))).chr }
+    return s
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift( File.join( File.dirname(__FILE__), "..", "lib") )
+
+require 'rubygems'
+require 'test/unit'
+require 'net/http'
+require 'json'
+require 'ruby-tambur'

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: tambur-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andre Graf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple Client for the Tambur.io REST API
+email:
+- graf@tambur.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- lib/ruby-tambur.rb
+- lib/ruby-tambur/vendor/oauth_util.rb
+- lib/ruby-tambur/version.rb
+- ruby-tambur.gemspec
+- test/tambur_test.rb
+- test/test_helper.rb
+homepage: https://github.com/tamburio/ruby-tambur
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: ruby-tambur
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple Client for the Tambur.io REST API
+test_files:
+- test/tambur_test.rb
+- test/test_helper.rb