mikemarsian-ruby_bosh 0.13

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e9733286d7e012ea738fe3a704149ae3570b6569
+  data.tar.gz: b7176f5e8a292ae00a8e27114691076946018dd7
+SHA512:
+  metadata.gz: 8c6a252002fe19fc8293b18cbfc83607955f9dd2049239357a2c2ce6ff97349ea3ab8289e4f4decfefd74bb75d06ac37c69ea719f3108a1fa095ba8bf41722e3
+  data.tar.gz: dfb7c28b100e3a3fbf6cb1823d669715a052ceee6ca7018db2c776cf982877488541e593c0f9146052e0f758e40e00d57b9fddaf5cb2e3786307847475720379

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,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/TODO

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

data/VERSION.yml

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

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,180 @@
+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 TimeoutError < 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 "timeout"
+    def deliver(xml)
+      ::Timeout.timeout(@timeout) do 
+        send(xml)
+        recv(RestClient.post(@service_url, xml, @headers))
+      end
+    rescue Timeout::Error => e
+      raise RubyBOSH::TimeoutError, 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_bosh.gemspec

@@ -0,0 +1,43 @@
+Gem::Specification.new do |s|
+  s.name = "mikemarsian-ruby_bosh"
+  s.version = "0.13"
+
+  s.require_paths = ["lib"]
+  s.authors = ["Original author: Pradeep Elankumaran. Update for ruby 2: Mike Polischuk"]
+  s.date = "2016-07-27"
+  s.description = "An XMPP BOSH session pre-initializer for Ruby web applications"
+  s.email = "mike@polischuk.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README",
+    "TODO"
+  ]
+  s.licenses = ['MIT']
+  s.files = [
+    "LICENSE",
+    "README",
+    "Rakefile",
+    "TODO",
+    "VERSION.yml",
+    "autotest/discover.rb",
+    "lib/ruby_bosh.rb",
+    "ruby_bosh.gemspec",
+    "spec/ruby_bosh_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.homepage = "http://github.com/mikemarsian/ruby_bosh"
+  s.summary = "A BOSH session pre-initializer for Ruby web applications (for Ruby 2)"
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.add_development_dependency "bundler", "~> 1.10"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "rspec", '~> 3.0'
+  s.add_development_dependency "rspec_junit_formatter", '0.2.2'
+
+  s.add_dependency "builder", "~> 3.0"
+  s.add_dependency "rest-client" , "~> 1.8"
+  s.add_dependency "hpricot", "~> 0.8"
+
+end
+

data/spec/ruby_bosh_spec.rb

@@ -0,0 +1,58 @@
+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(: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 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,15 @@
+require 'rubygems'
+require 'rspec'
+require File.join(File.dirname(__FILE__), '..', "lib", "ruby_bosh")
+
+RSpec.configure do |config|
+
+  config.expect_with :rspec do |c|
+    c.syntax = :should
+  end
+  config.mock_with :rspec do |c|
+    c.syntax = :should
+  end
+
+end
+

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: mikemarsian-ruby_bosh
+version: !ruby/object:Gem::Version
+  version: '0.13'
+platform: ruby
+authors:
+- 'Original author: Pradeep Elankumaran. Update for ruby 2: Mike Polischuk'
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: hpricot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: An XMPP BOSH session pre-initializer for Ruby web applications
+email: mike@polischuk.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README
+- TODO
+files:
+- LICENSE
+- README
+- Rakefile
+- TODO
+- VERSION.yml
+- autotest/discover.rb
+- lib/ruby_bosh.rb
+- ruby_bosh.gemspec
+- spec/ruby_bosh_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/mikemarsian/ruby_bosh
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+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 BOSH session pre-initializer for Ruby web applications (for Ruby 2)
+test_files:
+- spec/ruby_bosh_spec.rb
+- spec/spec_helper.rb
+has_rdoc: