bosh4r 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bosh4r.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ganesh Gunaegaran
+
+MIT License
+
+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.md

@@ -0,0 +1,58 @@
+# Bosh
+
+## Status
+
+The following features are currently implemented
+### Session
+
+Initializes a BOSH session with an XMPP server
+and returns the session identifier and request identifier.
+
+Session identifier and request identifier are typically used to
+attach another client side session with the XMPP server
+Ex: http://strophe.im/strophejs/doc/1.0.2/files2/strophe-js.html#Strophe.Connection.attach
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bosh4r'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bosh4r
+
+## Usage
+
+    Bosh4r::Session.new('gg@air.local', 'password').sid
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+    Copyright (C) 2012 Ganesh Gunasegaran
+
+    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/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bosh4r.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/bosh4r/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ganesh Gunaegaran"]
+  gem.email         = ["me@itsgg.com"]
+  gem.description   = %q{BOSH ruby client}
+  gem.summary       = %q{XMPP BOSH ruby client}
+  gem.homepage      = "https://github.com/itsgg/bosh4r"
+  gem.add_dependency 'rest-client', '>= 1.6.7'
+  gem.add_dependency 'builder', '>= 3.0.0'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "bosh4r"
+  gem.require_paths = ["lib"]
+  gem.version       = Bosh4r::VERSION
+end

data/examples/sample.rb

@@ -0,0 +1,4 @@
+require 'bosh4r'
+
+session = Bosh4r::Session.new('gg@localhost', 'password')
+p session.sid

data/lib/bosh4r/error.rb

@@ -0,0 +1,3 @@
+module Bosh4r
+  class Error < StandardError; end
+end

data/lib/bosh4r/session.rb

@@ -0,0 +1,107 @@
+# Middleware that initializes a BOSH session with an XMPP server
+# and returns the session identifier and request identifier.
+#
+# Session identifier and request identifier are typically used to
+# attach another client side session with the XMPP server.
+# Ex: http://strophe.im/strophejs/doc/1.0.2/files2/strophe-js.html#Strophe.Connection.attach
+#
+# Author        :  Ganesh Gunasegaran <me@itsgg.com>
+# Last Modified :  June 16, 2012
+# Website       :  https://github.com/itsgg/bosh_session
+# Copyright     :  MIT License
+
+require 'rexml/document'
+require 'rexml/xpath'
+require 'base64'
+require_relative 'error'
+require_relative 'utils'
+
+module Bosh4r
+  class Session
+    include Bosh4r::Utils
+
+    attr_reader :sid, :rid
+
+    def initialize(jabber_id, password, options = {})
+      split_jabber_id = jabber_id.split('/')
+      bare_jabber_id = split_jabber_id.first
+      resource_name = split_jabber_id.last if split_jabber_id.size > 1
+
+      @jabber_id = bare_jabber_id
+      @password = password
+      @host = @jabber_id.split('@').last
+
+      @bosh_url = options[:bosh_url] || 'http://localhost:5280/http-bind'
+      @timeout = options[:timeout] || 5     # Network timeout
+      @wait = options[:wait] || 5           # Longest time the connection manager is allowed to wait before responding
+      @hold = options[:hold] || 1           # Number of connections that the connection manager can hold
+      @version = options[:version] || '1.0' # BOSH protocol version
+      @rid = rand(1000)
+      @resource_name = resource_name.nil? ? "bosh_#{Time.now.to_i.to_s(36)}" : resource_name
+      connect
+    end
+
+    def connected?
+      @connected
+    end
+
+    protected
+    def connect
+      throw Bosh4r::Error.new('Failed to initiate BOSH session') unless initiate_session
+      throw Bosh4r::Error.new('Failed to authenticate BOSH session') unless authenticate_session
+      throw Bosh4r::Error.new('Failed to restart BOSH stream') unless restart_stream
+      throw Bosh4r::Error.new('Failed to bind resource') unless bind_resource
+      throw Bosh4r::Error.new('Failed to request BOSH session') unless request_session
+      @connected = true
+      self
+    end
+
+    def initiate_session
+      params = build_xml(:wait => @wait, :to => @host, :hold => @hold,
+                         'xmpp:version' => @version, :rid => @rid += 1)
+      parsed_response = send_bosh_request(@bosh_url, params)
+      sid = (REXML::XPath.first parsed_response, '/body').attribute('sid').value()
+      @sid = sid
+    end
+
+    def authenticate_session
+      # Use SASL with base64 encoding
+      username = @jabber_id.split('@').first
+      # admin@imac.local
+      # admin
+      # password
+      auth_str = "#{@jabber_id}\u0000#{username}\u0000#{@password}"
+      auth_key = Base64.encode64(auth_str).gsub(/\s/, '')
+      params = build_xml(:sid => @sid, 'xmpp:version' => @version, :rid => @rid += 1) do |body|
+        body.auth(auth_key, :xmlns => 'urn:ietf:params:xml:ns:xmpp-sasl', :mechanism => 'PLAIN')
+      end
+      REXML::XPath.first send_bosh_request(@bosh_url, params), '/body/success'
+    end
+
+    def restart_stream
+      params = build_xml(:sid => @sid, 'xmpp:restart' => true,
+                         'xmpp:version' => @version, :rid => @rid += 1)
+      REXML::XPath.first send_bosh_request(@bosh_url, params), '/body/stream:features'
+    end
+
+    def bind_resource
+      params = build_xml(:sid => @sid, 'xmpp:version' => @version, :rid => @rid += 1) do |body|
+        body.iq(:id => "bind_#{rand(1000000)}", :type => 'set', :xmlns => "jabber:client") do |iq|
+          iq.bind(:xmlns => 'urn:ietf:params:xml:ns:xmpp-bind') do |bind|
+            bind.resource(@resource_name)
+          end
+        end
+      end
+      REXML::XPath.first send_bosh_request(@bosh_url, params), '//jid'
+    end
+
+    def request_session
+      params = build_xml(:sid => @sid, 'xmpp:version' => @version, :rid => @rid += 1) do |body|
+        body.iq(:id => "session_#{rand(1000000)}", :type => 'set', :xmlns => 'jabber:client') do |iq|
+          iq.session(:xmlns => 'urn:ietf:params:xml:ns:xmpp-session')
+        end
+      end
+      REXML::XPath.first send_bosh_request(@bosh_url, params), '/body/iq/session'
+    end
+  end
+end

data/lib/bosh4r/utils.rb

@@ -0,0 +1,36 @@
+require 'rest_client'
+require 'builder'
+require_relative 'error'
+
+module Bosh4r
+  module Utils
+    def build_xml(options = {}, &callback)
+      builder = Builder::XmlMarkup.new
+      params = {
+        :xmlns => 'http://jabber.org/protocol/httpbind',
+        'xmlns:xmpp' => 'urn:xmpp:xbosh'
+      }.merge(options)
+      if block_given?
+        builder.body(params) { |body|
+          yield(body)
+        }
+      else
+        builder.body(params)
+      end
+    end
+
+    # Sends bosh request
+    def send_bosh_request(url, params)
+      response = RestClient.post(url, params, {
+        'Content-Type' => 'text/xml; charset=utf-8',
+        'Accept' => 'text/xml'
+      })
+      parsed_response = REXML::Document.new(response)
+      terminate = (REXML::XPath.first parsed_response, '/body').attribute('type') == 'terminate'
+      throw Bosh4r::Error.new 'Check your BOSH endpoint' if terminate
+      parsed_response
+    rescue => e
+      throw Bosh4r::Error.new(e.message)
+    end
+  end
+end

data/lib/bosh4r/version.rb

@@ -0,0 +1,3 @@
+module Bosh4r
+  VERSION = "0.0.2"
+end

data/lib/bosh4r.rb

@@ -0,0 +1,3 @@
+require_relative "bosh4r/version"
+require_relative "bosh4r/error"
+require_relative "bosh4r/session"

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: bosh4r
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Ganesh Gunaegaran
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &70104704864100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *70104704864100
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: &70104704848500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70104704848500
+description: BOSH ruby client
+email:
+- me@itsgg.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bosh4r.gemspec
+- examples/sample.rb
+- lib/bosh4r.rb
+- lib/bosh4r/error.rb
+- lib/bosh4r/session.rb
+- lib/bosh4r/utils.rb
+- lib/bosh4r/version.rb
+homepage: https://github.com/itsgg/bosh4r
+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.10
+signing_key: 
+specification_version: 3
+summary: XMPP BOSH ruby client
+test_files: []