RubyGems - xmpp_gateway - Versions diffs - 0.0.2 - Mend

xmpp_gateway 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

data/LICENSE +19 -0
data/README.mdown +67 -0
data/bin/xmpp_gateway +9 -0
data/lib/xmpp_gateway.rb +93 -0
data/lib/xmpp_gateway/http_interface.rb +148 -0
data/lib/xmpp_gateway/logger.rb +15 -0
data/lib/xmpp_gateway/xmpp_interface.rb +93 -0
data/lib/xmpp_gateway/xmpp_pool.rb +63 -0
metadata +100 -0

data/LICENSE ADDED Viewed

@@ -0,0 +1,19 @@
+Copyright (C) 2010 by Theo Cushion
+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.mdown ADDED Viewed

@@ -0,0 +1,67 @@
+Description
+===========
+XMPP Gateway provides a HTTP interface to talking to an XMPP server. It is designed to speed up and simplify communications between a web app and a generic XMPP server. It achieves this by taking care of the XMPP connection management, and allowing the sending and receiving of replies via a very simple synchronous HTTP interface.
+HTTP Basic Authentication is used to provide the credentials for authenticating an XMPP session. An XMPP stanza can then be sent by making a HTTP Post (see 'Operation' below).
+There are 3 stanza types in XMPP: IQ, message and presence. IQ always expects a reply, and this will be returned in the body of the HTTP response. Message and presence are purely fire and forget.
+Currently it is not production ready and merely a proof of concept.
+Requirements
+============
+- ruby 1.9.2
+Operation
+=========
+To install the gems
+    $ gem install xmpp_gateway
+To start the server
+    $ xmpp_gateway --debug
+Server should now be available on [http://127.0.0.1:8000](http://127.0.0.1:8000)
+To send a message:
+    $ curl --user YOURNAME@jabber.org:PASSWORD --data "stanza=<message to='theozaurus@jabber.org'><body>Howdy</body></message>" http://127.0.0.1:8000
+To send an IQ:
+    $ curl --user YOURNAME@jabber.org:PASSWORD -d "stanza=<iq to='jabber.org'><query xmlns='http://jabber.org/protocol/disco#info'/></iq>" http://127.0.0.1:8000
+    <iq type="result" id="blather0007" from="jabber.org" to="theozaurus@jabber.org/457fd1b2e49ebb39">
+      <query xmlns="http://jabber.org/protocol/disco#info">
+        <identity category="server" type="im" name="Isode M-Link 14.6a6"/>
+        <identity category="pubsub" type="pep"/>
+        <feature var="http://jabber.org/protocol/disco#info"/>
+        <feature var="http://jabber.org/protocol/disco#items"/>
+        <feature var="urn:xmpp:ping"/>
+        <feature var="vcard-temp"/>
+        <feature var="http://jabber.org/protocol/commands"/>
+        <feature var="http://jabber.org/protocol/compress"/>
+        <feature var="jabber:iq:auth"/>
+        <feature var="jabber:iq:private"/>
+        <feature var="jabber:iq:version"/>
+        <feature var="http://jabber.org/protocol/pubsub#access-presence"/>
+        <feature var="http://jabber.org/protocol/pubsub#auto-create"/>
+        <feature var="http://jabber.org/protocol/pubsub#auto-subscribe"/>
+        <feature var="http://jabber.org/protocol/pubsub#create-nodes"/>
+        <feature var="http://jabber.org/protocol/pubsub#filtered-notifications"/>
+        <feature var="http://jabber.org/protocol/pubsub#publish"/>
+        <feature var="http://jabber.org/protocol/pubsub#retrieve-items"/>
+        <feature var="http://jabber.org/protocol/pubsub#subscribe"/>
+      </query>
+    </iq>
+TODO
+====
+- Test suite
+- Add HTTP callbacks so that asynchronous events can be fed back to the HTTP server
+- HTTPS support

data/bin/xmpp_gateway ADDED Viewed

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+begin
+  require "xmpp_gateway"
+rescue LoadError
+  xmpp_gateway_path = File.expand_path('../../lib', __FILE__)
+  $:.unshift(xmpp_gateway_path)
+  require "xmpp_gateway"
+end

data/lib/xmpp_gateway.rb ADDED Viewed

@@ -0,0 +1,93 @@
+require 'optparse'
+options = {
+  bind: '127.0.0.1',
+  port: '8000'
+}
+optparse = OptionParser.new do |opts|
+  opts.banner = "Run with #{$0}"
+  opts.on('-b', '--bind', "What address to bind to, by default #{options[:bind]}") do |bind|
+    options[:bind] = bind
+  end
+  opts.on('-p', '--port', "What port to bind to, by default #{options[:port]}") do |port|
+    options[:port] = port
+  end
+  opts.on('-D', '--debug', 'Run in debug mode') do
+    options[:debug] = true
+  end
+  opts.on('-d', '--daemonize', 'Daemonize the process') do |daemonize|
+    options[:daemonize] = daemonize
+  end
+  opts.on('-p', '--pid', 'Write the PID to this file') do |pid|
+    if !File.writable?(File.dirname(pid))
+      $stderr.puts "Unable to write log file to #{pid}"
+      exit 1
+    end
+    options[:pid] = pid
+  end
+  opts.on('-l', '--log', 'Write the Log to this file instead of stdout/stderr') do |log|
+    if !File.writable?(File.dirname(log))
+      $stderr.puts "Unable to write log file to #{log}"
+      exit 1
+    end
+    options[:log] = log
+  end
+  opts.on_tail('-h', '--help', 'Show this message') do
+    puts opts
+    exit
+  end
+end
+optparse.parse!
+at_exit do
+  def run(options)
+    require_relative 'xmpp_gateway/http_interface'
+    require_relative 'xmpp_gateway/logger'
+    $stdin.reopen "/dev/null"
+    if options[:log]
+      log = File.new(options[:log], 'a')
+      log.sync = options[:debug]
+      $stdout.reopen log
+      $stderr.reopen $stdout
+    end
+    XmppGateway.logger.level = Logger::DEBUG if options[:debug]
+    trap(:INT)  { EventMachine.stop }
+    trap(:TERM) { EventMachine.stop }
+    EventMachine.run do
+      include XmppGateway
+      HttpInterface.start(options[:bind],options[:port])
+    end
+    XmppGateway.logger.info("Stopped server")
+  end
+  if options[:daemonize]
+    pid = fork do
+      Process.setsid
+      exit if fork
+      File.open(options[:pid], 'w') { |f| f << Process.pid } if options[:pid]
+      run options
+      FileUtils.rm(options[:pid]) if options[:pid]
+    end
+    ::Process.detach pid
+    exit
+  else
+    run options
+  end
+end

data/lib/xmpp_gateway/http_interface.rb ADDED Viewed

@@ -0,0 +1,148 @@
+require 'evma_httpserver'
+require 'base64'
+require 'cgi'
+require_relative 'xmpp_pool'
+module XmppGateway
+  class HttpInterface < EM::Connection
+    include EM::HttpServer
+    def self.start(host = '127.0.0.1', port = 8000)
+      XmppGateway.logger.info "Starting server at http://#{host}:#{port}"
+      EM.start_server(host, port, self)
+    end
+    def acceptable_method?
+      %w(GET POST).include? @http_request_method
+    end
+    def process_http_request
+      # the http request details are available via the following instance variables:
+      #   @http_protocol
+      #   @http_request_method
+      #   @http_cookie
+      #   @http_if_none_match
+      #   @http_content_type
+      #   @http_path_info
+      #   @http_request_uri
+      #   @http_query_string
+      #   @http_post_content
+      #   @http_headers
+      XmppGateway.logger.info "Received request #{@http_request_method} #{post_params.inspect}"
+      Fiber.new{
+        if acceptable_method?
+          user, password = credentials
+          @connection = XmppPool.new( user, password )
+          if @connection.connected
+            case @http_request_method
+            when "GET"
+              get.send_response
+            when "POST"
+              stanza = XmppPool.stanza(post_params['stanza'])
+              if stanza
+                result = @connection.write stanza
+                response(result).send_response
+              else
+                bad_request.send_response
+              end
+            else
+              # acceptable_method should have stopped us arriving here
+              # battle on bravely
+              method_not_allowed.send_response
+            end
+          else
+            unauthorized.send_response
+          end
+        else
+          method_not_allowed.send_response
+        end
+      }.resume
+    end
+    def headers
+      @headers ||= Hash[@http_headers.split("\000").map{|kv| kv.split(':',2).map{|v| v.strip} }]
+    end
+    def basic_auth
+      @_basic_auth ||= ( headers['Authorization'] || '' ).match(/\ABasic +(.+)\Z/).to_a[1]
+    end
+    def post_params
+      @_post_params ||= Hash[@http_post_content.split('&').map{|kv| kv.split('=',2).map{|v| CGI.unescape v } }]
+    end
+    def credentials
+      if basic_auth
+        Base64.decode64(basic_auth).split(':')
+      end
+    end
+    def response(stanza)
+      XmppGateway.logger.debug "Success"
+      response = EM::DelegatedHttpResponse.new(self)
+      response.status = 200
+      response.content_type 'application/xml'
+      response.content = stanza.to_s + "\n"
+      return response
+    end
+    def unauthorized
+      XmppGateway.logger.debug "Unauthorized, username & password wrong"
+      response = EM::DelegatedHttpResponse.new(self)
+      response.status = 401
+      response.content_type 'text/html'
+      response.headers = {"WWW-Authenticate" => 'Basic realm="Secure Area"'}
+      response.content = "Unauthorised\n"
+      return response
+    end
+    def method_not_allowed
+      XmppGateway.logger.debug "Method #{@http_request_method} not allowed"
+      response = EM::DelegatedHttpResponse.new(self)
+      response.status = 405
+      response.content_type 'text/html'
+      response.content = "Method not allowed\n"
+      return response
+    end
+    def bad_request
+      XmppGateway.logger.debug "Bad request '#{post_params['stanza']}' is not a valid stanza"
+      response = EM::DelegatedHttpResponse.new(self)
+      response.status = 400
+      response.content_type 'text/html'
+      response.content = "Please send a valid stanza\n"
+      return response
+    end
+    def get
+      XmppGateway.logger.debug "Success, send stanza form"
+      response = EM::DelegatedHttpResponse.new(self)
+      response.status = 200
+      response.content_type 'text/html'
+      response.content =
+      "<h1>Enter Stanza</h1>" +
+      "<form method='post'>" +
+        "<label for='stanza'>Stanza</label>" +
+        "<textarea name='stanza' cols=50 rows=20>" +
+          "<iq type='get'\n" +
+          "    to='#{@connection.client.jid.domain}'\n" +
+          "    id='info1'>\n" +
+          "  <query xmlns='http://jabber.org/protocol/disco#info'/>\n" +
+          "</iq>" +
+        "</textarea>" +
+        "<input type='submit' value='Submit'/>" +
+      "</form>\n"
+      return response
+    end
+  end
+end

data/lib/xmpp_gateway/logger.rb ADDED Viewed

@@ -0,0 +1,15 @@
+module XmppGateway
+  def self.logger
+    @@logger ||= begin
+      l = Logger.new($stdout)
+      l.level = Logger::INFO
+      l
+    end
+  end
+  def self.logger=(logger)
+    @@logger = logger
+  end
+end

data/lib/xmpp_gateway/xmpp_interface.rb ADDED Viewed

@@ -0,0 +1,93 @@
+require "fiber"
+require "blather/client/client"
+module XmppGateway
+  class XmppInterface
+    attr_reader :client
+    attr_reader :connected
+    def self.stanza(stanza)
+      noko = Nokogiri::XML::Document.parse( stanza ).root
+      return nil unless noko
+      blather = Blather::XMPPNode.import( noko )
+      return nil if blather.class == Blather::XMPPNode # This means it isn't a valid presence, iq or message stanza
+      return blather
+    end
+    def initialize(user,password)
+      @jid = Blather::JID.new(user)
+      f = Fiber.current
+      @client = Blather::Client.setup @jid, password
+      @client.register_handler(:ready) do
+        @connected = true
+        f.resume( @connected ) if f.alive?
+      end
+      @client.register_handler(:disconnected) do
+        XmppGateway.logger.debug "XMPP connection #{@jid} disconnected"
+        @connected = false
+        f.resume( @connected ) if f.alive?
+        # Prevent EventMachine from stopping by returning true on disconnected
+        true
+      end
+      @client.clear_handlers(:error)
+      @client.register_handler(:error){ f.resume( false ) if f.alive? }
+      begin
+        @client.run
+      rescue
+        @connected = false
+      end
+      # Waits until it has connected unless an error was thrown
+      @connected = Fiber.yield if @connected.nil?
+      schedule_activity_monitor
+      XmppGateway.logger.debug "XMPP connection #{@jid} #{@connected ? '' : 'not '}connected"
+    end
+    def write(stanza)
+      XmppGateway.logger.debug "Sending stanza #{stanza.to_s}"
+      f = Fiber.current
+      @client.write_with_handler( stanza ){|result|
+        f.resume(result) if f.alive?
+      }
+      if reply_expected stanza
+        # Remove timer while we wait for response
+        cancel_timer
+        reply = Fiber.yield
+        XmppGateway.logger.debug "Received #{reply}"
+        # Schedule new timer
+        schedule_activity_monitor
+        return reply
+      end
+      schedule_activity_monitor
+    end
+  private
+    def schedule_activity_monitor
+      @timer = EventMachine::Timer.new(60) do
+        XmppGateway.logger.debug "XMPP connection #{@jid} inactive for over 60 seconds"
+        @client.close if @connected
+      end if @connected
+    end
+    def cancel_timer
+      @timer.cancel if @timer
+    end
+    def reply_expected(stanza)
+      stanza.is_a? Blather::Stanza::Iq
+    end
+  end
+end

data/lib/xmpp_gateway/xmpp_pool.rb ADDED Viewed

@@ -0,0 +1,63 @@
+require_relative 'xmpp_interface'
+module XmppGateway
+  class XmppPool
+    attr_reader :connected
+    def self.stanza(s)
+      XmppInterface.stanza s
+    end
+    def self.connections
+      @@connections ||= {}
+    end
+    def initialize(user, password)
+      @jid = Blather::JID.new(user)
+      if stale?
+        XmppGateway.logger.debug "Stale XMPP connection #{@jid}"
+        connections.delete @jid.to_s
+      end
+      if record = connections[@jid.to_s]
+        # Connection exists
+        XmppGateway.logger.debug "Reusing XMPP connection #{@jid}"
+        @connection = record[:connection]
+        @connected  = record[:password] == password
+      else
+        # Create connection
+        XmppGateway.logger.debug "Creating XMPP connection #{@jid}"
+        @connection = XmppInterface.new(user, password)
+        @connected  = @connection.connected
+        if @connected
+          # Cache the connection
+          connections[@jid.to_s] = {:password => password, :connection => @connection}
+        end
+      end
+    end
+    def client
+      @connection.client
+    end
+    def write(s)
+      @connection.write(s)
+    end
+  private
+    def stale?
+      connections[@jid.to_s] && !connections[@jid.to_s][:connection].connected
+    end
+    def connections
+      self.class.connections
+    end
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: xmpp_gateway
+version: !ruby/object:Gem::Version
+  prerelease: false
+  segments:
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors:
+- Theo Cushion
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2011-01-24 00:00:00 +00:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: blather
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        segments:
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency
+  name: eventmachine_httpserver
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        segments:
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: XmppGateway is a server that allows XMPP stanzas to be posted via HTTP POST requests, it provides a synchronous API for IQ messages so that a reply is included in the body of the response
+email: theo.c@zepler.net
+executables:
+- xmpp_gateway
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/xmpp_gateway
+- lib/xmpp_gateway/http_interface.rb
+- lib/xmpp_gateway/logger.rb
+- lib/xmpp_gateway/xmpp_interface.rb
+- lib/xmpp_gateway/xmpp_pool.rb
+- lib/xmpp_gateway.rb
+- LICENSE
+- README.mdown
+has_rdoc: true
+homepage: http://github.com/theozaurus/xmpp_gateway
+licenses:
+- MIT
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 1
+      - 9
+      - 2
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.7
+signing_key:
+specification_version: 3
+summary: A server for sending and receiving XMPP stanzas via a HTTP interface
+test_files: []