ruby_new_bosh 0.7.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Pradeep Elankumaran
+
+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.

data/README

@@ -0,0 +1,43 @@
+ruby_bosh
+=========
+
+The RubyBOSH library handles creating and pre-authenticating BOSH streams inside your Ruby application before passing them off to your template engine. 
+
+This method allows you to hide authentication details for your users' XMPP accounts.  
+
+Tested on Rails 2.x with eJabberd 1.2+
+
+References
+==========
+BOSH: http://xmpp.org/extensions/xep-0124.html
+XMPP via BOSH: http://xmpp.org/extensions/xep-0206.html
+
+Example
+=======
+In your Ruby app controller (or equivalent):
+
+@session_jid, @session_id, @session_random_id = 
+  RubyBOSH.initialize_session("me@jabber.org", "my_password", "http://localhost:5280/http-bind")
+
+If you want to define your own resource name, include it within the jid.  RubyBOSH will create a random one if none is supplied.
+To define a resource name of 'home', do the following:
+
+@session_jid, @session_id, @session_random_id = 
+  RubyBOSH.initialize_session("me@jabber.org/home", "my_password", "http://localhost:5280/http-bind")
+
+In your template, you would then pass these directly to your javascript BOSH connector:
+
+var bosh_jid = '<%= @session_jid %>';
+var bosh_sid = '<%= @session_id %>';
+var bosh_rid = '<%= @session_random_id %>';
+
+// using Strophe:
+connect.attach(bosh_jid, bosh_sid, bosh_rid, onConnectHandlerFunction); 
+
+Acknowledgements
+================
+Jack Moffit
+- thanks for the nice Django example :)
+#=> http://metajack.im/2008/10/03/getting-attached-to-strophe/
+
+Copyright (c) 2008 Pradeep Elankumaran. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "ruby_bosh"
+    s.summary = %Q{A BOSH session pre-initializer for Ruby web applications}
+    s.email = "pradeep@intridea.com"
+    s.homepage = "http://github.com/skyfallsin/ruby_bosh"
+    s.description = "An XMPP BOSH session pre-initializer for Ruby web applications"
+    s.authors = ["Pradeep Elankumaran"]
+    
+    s.add_dependency("builder")
+    s.add_dependency("rest-client")
+    s.add_dependency("hpricot")
+    s.add_dependency("SystemTimer")
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'ruby_bosh'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    t.libs << 'test'
+    t.test_files = FileList['test/**/*_test.rb']
+    t.verbose = true
+  end
+rescue LoadError
+  puts "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+end
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+rescue LoadError
+  puts "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+end
+
+task :default => :test

data/TODO

@@ -0,0 +1,2 @@
+write basic tests
+

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:major: 0
+:build: 
+:minor: 7
+:patch: 0

data/autotest/discover.rb

@@ -0,0 +1,5 @@
+$:.push(File.join(File.dirname(__FILE__), %w[.. .. rspec]))  
+   
+Autotest.add_discovery do  
+  "rspec"  
+end  

data/lib/ruby_bosh.rb

@@ -0,0 +1,196 @@
+require 'rest_client'
+require 'builder'
+require 'rexml/document'
+require 'base64'
+require 'hpricot'
+
+class RubyBOSH  
+  BOSH_XMLNS    = 'http://jabber.org/protocol/httpbind'
+  TLS_XMLNS     = 'urn:ietf:params:xml:ns:xmpp-tls'
+  SASL_XMLNS    = 'urn:ietf:params:xml:ns:xmpp-sasl'
+  BIND_XMLNS    = 'urn:ietf:params:xml:ns:xmpp-bind'
+  SESSION_XMLNS = 'urn:ietf:params:xml:ns:xmpp-session'
+  CLIENT_XMLNS  = 'jabber:client'
+
+  class Error < StandardError; end
+  class Timeout < RubyBOSH::Error; end
+  class AuthFailed < RubyBOSH::Error; end
+  class ConnFailed < RubyBOSH::Error; end
+
+  @@logging = true
+  def self.logging=(value)
+    @@logging = value
+  end
+
+  attr_accessor :jid, :rid, :sid, :success , :custom_resource
+  def initialize(jid, pw, service_url, opts={}) 
+    @service_url = service_url
+    # Extract the resource if present
+    split_jid = jid.split("/")
+    @jid = split_jid.first
+    @custom_resource = split_jid.last if split_jid.length > 1
+    @pw = pw
+    @host = @jid.split("@").last
+    @success = false
+    @timeout = opts[:timeout] || 3 #seconds 
+    @headers = {"Content-Type" => "text/xml; charset=utf-8",
+                "Accept" => "text/xml"}
+    @wait    = opts[:wait]   || 5
+    @hold    = opts[:hold]   || 3
+    @window  = opts[:window] || 5
+  end
+
+  def success?
+    @success == true
+  end
+
+  def self.initialize_session(*args)
+    new(*args).connect
+  end
+
+  def connect
+    initialize_bosh_session
+    if send_auth_request 
+      send_restart_request
+      request_resource_binding
+      @success = send_session_request
+    end
+
+    raise RubyBOSH::AuthFailed, "could not authenticate #{@jid}" unless success?
+    @rid += 1 #updates the rid for the next call from the browser
+    
+    [@jid, @sid, @rid]
+  end
+
+  private
+  def initialize_bosh_session 
+    response = deliver(construct_body(:wait => @wait, :to => @host,
+                                      :hold => @hold, :window => @window,
+                                      "xmpp:version" => '1.0'))
+    parse(response)
+  end
+
+  def construct_body(params={}, &block)
+    @rid ? @rid+=1 : @rid=rand(100000)
+
+    builder = Builder::XmlMarkup.new
+    parameters = {:rid => @rid, :xmlns => BOSH_XMLNS,
+                  "xmpp:version" => "1.0", 
+                  "xmlns:xmpp" => "urn:xmpp:xbosh"}.merge(params)
+
+    if block_given?
+      builder.body(parameters) {|body| yield(body)}
+    else
+      builder.body(parameters)
+    end
+  end
+
+  def send_auth_request 
+    request = construct_body(:sid => @sid) do |body|
+      auth_string = "#{@jid}\x00#{@jid.split("@").first.strip}\x00#{@pw}" 
+      body.auth(Base64.encode64(auth_string).gsub(/\s/,''), 
+                    :xmlns => SASL_XMLNS, :mechanism => 'PLAIN')
+    end
+
+    response = deliver(request)
+    response.include?("success")
+  end
+
+  def send_restart_request
+    request = construct_body(:sid => @sid, "xmpp:restart" => true, "xmlns:xmpp" => 'urn:xmpp:xbosh')
+    deliver(request).include?("stream:features")
+  end
+
+  def request_resource_binding
+    request = construct_body(:sid => @sid) do |body|
+      body.iq(:id => "bind_#{rand(100000)}", :type => "set", 
+              :xmlns => "jabber:client") do |iq|
+        iq.bind(:xmlns => BIND_XMLNS) do |bind|
+          bind.resource(resource_name)
+        end
+      end
+    end
+    
+    response = deliver(request)
+    response.include?("<jid>") 
+  end
+
+  def send_session_request
+    request = construct_body(:sid => @sid) do |body|
+      body.iq(:xmlns => CLIENT_XMLNS, :type => "set",
+              :id => "sess_#{rand(100000)}") do |iq|
+        iq.session(:xmlns => SESSION_XMLNS)
+      end 
+    end
+
+    response = deliver(request)
+    response.include?("body") 
+  end
+
+  def parse(_response)
+    doc = Hpricot(_response.to_s)
+    doc.search("//body").each do |body|
+      @sid = body.attributes["sid"].to_s
+    end
+    _response
+  end
+
+  begin
+    require 'system_timer'
+    def deliver(xml)
+      SystemTimer.timeout(@timeout) do 
+        send(xml)
+        recv(RestClient.post(@service_url, xml, @headers))
+      end
+    rescue ::Timeout::Error => e
+      raise RubyBOSH::Timeout, e.message
+    rescue Errno::ECONNREFUSED => e
+      raise RubyBOSH::ConnFailed, "could not connect to #{@host}\n#{e.message}"
+    rescue Exception => e
+      raise RubyBOSH::Error, e.message
+    end
+  rescue LoadError
+    warn "WARNING: using the built-in Timeout class which is known to have issues when used for opening connections. Install the SystemTimer gem if you want to make sure the Redis client will not hang." unless RUBY_VERSION >= "1.9" || RUBY_PLATFORM =~ /java/
+
+    require "timeout"
+    def deliver(xml)
+      ::Timeout::timeout(@timeout) do 
+        send(xml)
+        recv(RestClient.post(@service_url, xml, @headers))
+      end
+    rescue ::Timeout::Error => e
+      raise RubyBOSH::Timeout, e.message
+    rescue Errno::ECONNREFUSED => e
+      raise RubyBOSH::ConnFailed, "could not connect to #{@host}\n#{e.message}"
+    rescue Exception => e
+      raise RubyBOSH::Error, e.message
+    end
+  end
+
+  def send(msg)
+    puts("Ruby-BOSH - SEND\n[#{now}]: #{msg}") if @@logging; msg
+  end
+
+  def recv(msg)
+    puts("Ruby-BOSH - RECV\n[#{now}]: #{msg}") if @logging; msg
+  end
+
+  private
+  def now 
+    Time.now.strftime("%a %b %d %H:%M:%S %Y")
+  end
+
+  def resource_name
+    if @custom_resource.nil?
+      "bosh_#{rand(10000)}"
+    else
+      @custom_resource
+    end
+  end
+end
+
+
+if __FILE__ == $0
+  p RubyBOSH.initialize_session(ARGV[0], ARGV[1], 
+      "http://localhost:5280/http-bind")
+end

data/ruby_new_bosh.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ruby_new_bosh}
+  s.version = "0.7.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Pradeep Elankumaran"]
+  s.date = %q{2011-05-03}
+  s.description = %q{An XMPP BOSH session pre-initializer for Ruby web applications}
+  s.email = %q{pradeep@intridea.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README",
+    "TODO"
+  ]
+  s.files = [
+    "LICENSE",
+    "README",
+    "Rakefile",
+    "TODO",
+    "VERSION.yml",
+    "autotest/discover.rb",
+    "lib/ruby_bosh.rb",
+    "ruby_new_bosh.gemspec",
+    "spec/ruby_bosh_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/skyfallsin/ruby_bosh}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{A BOSH session pre-initializer for Ruby web applications}
+  s.test_files = [
+    "spec/ruby_bosh_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<builder>, [">= 0"])
+      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+      s.add_runtime_dependency(%q<hpricot>, [">= 0"])
+      if RUBY_VERSION < "1.9"
+        s.add_runtime_dependency(%q<SystemTimer>, [">= 0"])
+      end
+    else
+      s.add_dependency(%q<builder>, [">= 0"])
+      s.add_dependency(%q<rest-client>, [">= 0"])
+      s.add_dependency(%q<hpricot>, [">= 0"])
+      if RUBY_VERSION < "1.9"
+        s.add_dependency(%q<SystemTimer>, [">= 0"])
+      end
+    end
+  else
+    s.add_dependency(%q<builder>, [">= 0"])
+    s.add_dependency(%q<rest-client>, [">= 0"])
+    s.add_dependency(%q<hpricot>, [">= 0"])
+    if RUBY_VERSION < "1.9"
+      s.add_dependency(%q<SystemTimer>, [">= 0"])
+    end
+  end
+end
+

data/spec/ruby_bosh_spec.rb

@@ -0,0 +1,64 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe RubyBOSH do
+  before(:each) do 
+    RubyBOSH.logging = false
+    @rbosh = RubyBOSH.new("skyfallsin@localhost", "skyfallsin",
+                          "http://localhost:5280/http-bind")
+    #@rbosh.stub!(:success?).and_return(true)
+    #@rbosh.stub!(:initialize_bosh_session).and_return(true)
+    @rbosh.stub!(:send_auth_request).and_return(true)
+    @rbosh.stub!(:send_restart_request).and_return(true)
+    @rbosh.stub!(:request_resource_binding).and_return(true)
+    @rbosh.stub!(:send_session_request).and_return(true)
+    RestClient.stub!(:post).and_return("<body sid='123456'></body>")
+  end
+
+  it "should set the sid attribute after the session creation request" do
+    @rbosh.connect
+    @rbosh.sid.should == '123456'
+  end
+
+  it "should update the rid on every call to the BOSH server" do
+    @rbosh.rid = 100
+    @rbosh.connect
+    @rbosh.rid.should > 100
+  end
+
+  it "should return an array with [jid, sid, rid] on success" do
+    s = @rbosh.connect
+    s.should be_kind_of(Array)
+    s.size.should == 3
+    s.first.should == 'skyfallsin@localhost' 
+    s.last.should be_kind_of(Fixnum)
+    s[1].should == '123456'
+  end
+
+  describe "Errors" do
+    it "should crash with AuthFailed when its not a success?" do
+      @rbosh.stub!(:send_session_request).and_return(false)
+      lambda { @rbosh.connect }.should raise_error(RubyBOSH::AuthFailed)
+    end
+
+    it "should raise a ConnFailed if a connection could not be made to the XMPP server" do
+      RestClient.stub!(:post).and_raise(Errno::ECONNREFUSED)
+      lambda { @rbosh.connect }.should raise_error(RubyBOSH::ConnFailed)
+    end
+
+    it "should raise a Timeout::Error if the BOSH call takes forever" do
+      SystemTimer.stub!(:timeout).and_raise(::Timeout::Error)
+      lambda { @rbosh.connect }.should raise_error(RubyBOSH::Timeout)
+    end
+
+    it "should crash with a generic error on any other problem" do
+      [RestClient::ServerBrokeConnection, RestClient::RequestTimeout].each{|err|
+        RestClient.stub!(:post).and_raise(err)
+        lambda { @rbosh.connect }.should raise_error(RubyBOSH::Error)
+      }
+    end
+
+    after(:each) do
+      lambda { @rbosh.connect }.should raise_error(RubyBOSH::Error)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require File.join(File.dirname(__FILE__), '..', "lib", "ruby_bosh")
+require 'spec'
+

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: ruby_new_bosh
+version: !ruby/object:Gem::Version
+  version: 0.7.2
+  prerelease: 
+platform: ruby
+authors:
+- Pradeep Elankumaran
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: builder
+  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'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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'
+- !ruby/object:Gem::Dependency
+  name: hpricot
+  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: An XMPP BOSH session pre-initializer for Ruby web applications
+email: pradeep@intridea.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README
+- TODO
+files:
+- LICENSE
+- README
+- Rakefile
+- TODO
+- VERSION.yml
+- autotest/discover.rb
+- lib/ruby_bosh.rb
+- ruby_new_bosh.gemspec
+- spec/ruby_bosh_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/skyfallsin/ruby_bosh
+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: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A BOSH session pre-initializer for Ruby web applications
+test_files:
+- spec/ruby_bosh_spec.rb
+- spec/spec_helper.rb