jubjub 0.0.1

data/.infinity_test

@@ -0,0 +1,35 @@
+infinity_test do
+
+  notifications :growl do
+    show_images :mode => :mario_bros
+  end
+
+  use :rubies => %w(1.9.2 ree), :test_framework => :rspec
+
+  # use :specific_options => {'jruby' => 'J-cp bar/whisky-in-the.jar:.'}
+
+  before(:each_ruby) do |environment|
+    # ...
+  end
+
+  after(:each_ruby) do |environment|
+    # ...
+  end
+
+  before_run do
+    clear :terminal
+  end
+
+  after_run do
+    # ...
+  end
+
+  #heuristics('my_pattern') do |file|
+    # ...
+  #end
+
+  replace_patterns do |application|
+    # ...
+  end
+
+end

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--tty

data/LICENSE

@@ -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

@@ -0,0 +1,78 @@
+Description
+===========
+
+Jubjub is an object to XMPP mapping library designed to be used inside of a web app to simplify the administration of XMPP resources. It aims to provide a very simple interface which hides the complexity of the XMPP protocol allowing your code to communicate intent rather than implementation details. This also makes the code significantly easier to mock and test.
+
+Currently it uses [xmpp_gateway](https://github.com/theozaurus/xmpp_gateway) to communicate to the XMPP server. This allows Jubjub to be used within non evented web servers like [Phusion Passenger](http://www.modrails.com).
+
+It is currently alpha software and merely a proof of concept.
+
+Requirements
+============
+
+It is currently fully tested against:
+
+ - Ruby 1.8.7
+ - Ruby 1.9.2
+ 
+Examples
+========
+
+    require 'jubjub'
+    class User
+  
+      attr_accessor :xmpp_jid, :xmpp_password
+  
+      # :jid and :password are used to point to methods that contain
+      # the credentials required to login as a user
+      include Jubjub::User
+      jubjub_client :jid => :xmpp_jid, :password => :xmpp_password
+  
+    end
+
+    u = User.new
+    u.xmpp_jid = "theozaurus@jabber.org"
+    u.xmpp_password = "ruby"
+
+    # Sensibly defaults to conference.YOUR_CONNECTION_JID
+    u.mucs
+    => [
+      #<Jubjub::Muc:0x1027222b8 @jid="all@conference.jabber.org" @name="all">,
+      #<Jubjub::Muc:0x102722038 @jid="all-linux-ru@conference.jabber.org" @name="all-linux-ru">,
+      #<Jubjub::Muc:0x102721b60 @jid="allgorithmus@conference.jabber.org" @name="Allgorithmus Project">,
+    ...
+
+    # Fancy a list from a different service?
+    u.mucs('conference.jabber.ru')
+    => [
+      #<Jubjub::Muc:0x10166e930 @jid="tota-room@conference.jabber.ru" @name="tota-room (5)">,
+      #<Jubjub::Muc:0x10166e6b0 @jid="friends_room@conference.jabber.ru" @name="Friends (6)">,
+      #<Jubjub::Muc:0x10166dcb0 @jid="think_linux@conference.jabber.ru" @name="think_linux (n/a)">
+    ...
+
+    # Create a room
+    room = u.mucs.create('jubjub')
+    => #<Jubjub::Muc:0x101532f58 @jid="jubjub@conference.jabber.org" @name=nil>
+
+    # Create a room somewhere else
+    room = u.mucs('chat.test.com').create('jubjub')
+    => #<Jubjub::Muc:0x10161c3b0 @jid="jubjub@chat.test.com" @name=nil>
+
+    # Create a room with a custom configuration
+    room = u.mucs.create('customjub'){|c|
+      c['muc#roomconfig_allowinvites'] = false
+    }
+
+    # Destroy a room
+    room.destroy
+    => true
+    
+TODO
+====
+
+ - Error handling
+ - MUC user role and affiliation control
+ - Service discovery
+ - Pubsub / PEP
+ - Operations that are not IQ based, such as rosters and two way messaging
+ - Other backends (for servers that are evented)

data/lib/jubjub/connection/xmpp_gateway/helper.rb

@@ -0,0 +1,17 @@
+module Jubjub
+  module Connection
+    class XmppGateway
+      module Helper
+        
+        def initialize(connection)
+          @connection = connection
+        end
+        
+        def write(stanza)
+          @connection.write(stanza)
+        end
+        
+      end
+    end
+  end
+end

data/lib/jubjub/connection/xmpp_gateway/muc.rb

@@ -0,0 +1,353 @@
+require 'jubjub/connection/xmpp_gateway/helper'
+require 'jubjub/muc'
+
+module Jubjub
+  module Connection
+    class XmppGateway
+      class Muc
+        
+        include Helper
+        
+        def initialize(connection)
+          @connection = connection
+        end
+        
+        # http://xmpp.org/extensions/xep-0045.html#createroom-instant
+        # <presence
+        #     from='crone1@shakespeare.lit/desktop'
+        #     to='darkcave@chat.shakespeare.lit/firstwitch'>
+        #   <x xmlns='http://jabber.org/protocol/muc'/>
+        # </presence> 
+        # <iq from='crone1@shakespeare.lit/desktop'
+        #     id='create1'
+        #     to='darkcave@chat.shakespeare.lit'
+        #     type='set'>
+        #   <query xmlns='http://jabber.org/protocol/muc#owner'>
+        #     <x xmlns='jabber:x:data' type='submit'/>
+        #   </query>
+        # </iq>
+        #
+        # Expected
+        # <iq from='darkcave@chat.shakespeare.lit'
+        #     id='create2'
+        #     to='crone1@shakespeare.lit/desktop'
+        #     type='result'/>
+        #
+        def create(full_jid, configuration = nil)
+          room_jid = Jubjub::Jid.new full_jid.node, full_jid.domain
+          
+          request = Nokogiri::XML::Builder.new do |xml|
+            xml.iq(:type => 'set', :to => room_jid) {
+              xml.query('xmlns' => 'http://jabber.org/protocol/muc#owner'){
+                xml.x('xmlns' => 'jabber:x:data', :type => 'submit') {
+                  configuration.settings.each{|name,values|
+                    xml.field('var' => name){
+                      values.each {|v|
+                        xml.value v
+                      }
+                    }
+                  } if configuration
+                }
+              }
+            }
+          end
+          
+          presence full_jid
+          
+          success = write(
+            # Open room
+            request.to_xml
+          ).xpath(
+            # Check for valid response
+            '//iq[@type="result"]'
+          ).any?
+          Jubjub::Muc.new room_jid, nil, @connection if success
+        end
+        
+        # http://xmpp.org/extensions/xep-0045.html#createroom-reserved
+        # <presence
+        #     from='crone1@shakespeare.lit/desktop'
+        #     to='darkcave@chat.shakespeare.lit/firstwitch'>
+        #   <x xmlns='http://jabber.org/protocol/muc'/>
+        # </presence>
+        # <iq from='crone1@shakespeare.lit/desktop'
+        #     id='create1'
+        #     to='darkcave@chat.shakespeare.lit'
+        #     type='get'>
+        #   <query xmlns='http://jabber.org/protocol/muc#owner'/>
+        # </iq>
+        #
+        # Expected
+        # <iq from='darkcave@chat.shakespeare.lit'
+        #     id='create1'
+        #     to='crone1@shakespeare.lit/desktop'
+        #     type='result'>
+        #   <query xmlns='http://jabber.org/protocol/muc#owner'>
+        #     <x xmlns='jabber:x:data' type='form'>
+        #       <title>Configuration for "darkcave" Room</title>
+        #       <instructions>
+        #           Your room darkcave@macbeth has been created!
+        #           The default configuration is as follows:
+        #             - No logging
+        #             - No moderation
+        #             - Up to 20 occupants
+        #             - No password required
+        #             - No invitation required
+        #             - Room is not persistent
+        #             - Only admins may change the subject
+        #             - Presence broadcasted for all users
+        #           To accept the default configuration, click OK. To
+        #           select a different configuration, please complete
+        #           this form.
+        #       </instructions>
+        #       <field
+        #           type='hidden'
+        #           var='FORM_TYPE'>
+        #         <value>http://jabber.org/protocol/muc#roomconfig</value>
+        #       </field>
+        #       <field
+        #           label='Natural-Language Room Name'
+        #           type='text-single'
+        #           var='muc#roomconfig_roomname'/>
+        #       <field
+        #           label='Natural Language for Room Discussions'
+        #           type='text-single'
+        #           var='muc#roomconfig_lang'/>
+        #       <field
+        #           label='Enable Public Logging?'
+        #           type='boolean'
+        #           var='muc#roomconfig_enablelogging'>
+        #         <value>0</value>
+        #       </field>
+        #       <field
+        #           label='Maximum Number of Occupants'
+        #           type='list-single'
+        #           var='muc#roomconfig_maxusers'>
+        #         <value>20</value>
+        #         <option label='10'><value>10</value></option>
+        #         <option label='20'><value>20</value></option>
+        #         <option label='30'><value>30</value></option>
+        #         <option label='50'><value>50</value></option>
+        #         <option label='100'><value>100</value></option>
+        #         <option label='None'><value>none</value></option>
+        #       </field>
+        #       <field
+        #           label='Roles for which Presence is Broadcast'
+        #           type='list-multi'
+        #           var='muc#roomconfig_presencebroadcast'>
+        #         <value>moderator</value>
+        #         <value>participant</value>
+        #         <value>visitor</value>
+        #         <option label='Moderator'><value>moderator</value></option>
+        #         <option label='Participant'><value>participant</value></option>
+        #         <option label='Visitor'><value>visitor</value></option>
+        #       </field>
+        #       <field
+        #           label='Roles and Affiliations that May Retrieve Member List'
+        #           type='list-multi'
+        #           var='muc#roomconfig_getmemberlist'>
+        #         <value>moderator</value>
+        #         <value>participant</value>
+        #         <value>visitor</value>
+        #         <option label='Moderator'><value>moderator</value></option>
+        #         <option label='Participant'><value>participant</value></option>
+        #         <option label='Visitor'><value>visitor</value></option>
+        #       </field>
+        #       <field
+        #           label='Make Room Publicly Searchable?'
+        #           type='boolean'
+        #           var='muc#roomconfig_publicroom'>
+        #         <value>1</value>
+        #       </field>
+        #       <field
+        #           label='Make Room Persistent?'
+        #           type='boolean'
+        #           var='muc#roomconfig_persistentroom'>
+        #         <value>0</value>
+        #       </field>
+        #       <field type='fixed'>
+        #         <value>
+        #           If a password is required to enter this room,
+        #           you must specify the password below.
+        #         </value>
+        #       </field>
+        #       <field
+        #           label='Password'
+        #           type='text-private'
+        #           var='muc#roomconfig_roomsecret'/>
+        #       <field
+        #           label='Who May Discover Real JIDs?'
+        #           type='list-single'
+        #           var='muc#roomconfig_whois'>
+        #         <option label='Moderators Only'>
+        #           <value>moderators</value>
+        #         </option>
+        #         <option label='Anyone'>
+        #           <value>anyone</value>
+        #         </option>
+        #       </field>
+        #       <field type='fixed'>
+        #         <value>
+        #           You may specify additional people who have
+        #           administrative privileges in the room. Please
+        #           provide one Jabber ID per line.
+        #         </value>
+        #       </field>
+        #       <field
+        #           label='Room Admins'
+        #           type='jid-multi'
+        #           var='muc#roomconfig_roomadmins'/>
+        #       <field type='fixed'>
+        #         <value>
+        #           You may specify additional owners for this
+        #           room. Please provide one Jabber ID per line.
+        #         </value>
+        #       </field>
+        #       <field
+        #           label='Room Owners'
+        #           type='jid-multi'
+        #           var='muc#roomconfig_roomowners'/>
+        #     </x>
+        #   </query>
+        # </iq>
+        def configuration(full_jid)
+          room_jid = Jubjub::Jid.new full_jid.node, full_jid.domain
+          
+          request = Nokogiri::XML::Builder.new do |xml|
+            xml.iq(:to => room_jid, :type => 'get') {
+              xml.query('xmlns' => 'http://jabber.org/protocol/muc#owner')
+            }
+          end
+          
+          presence full_jid
+          response = write(
+            # Request room configuration
+            request.to_xml
+          ).xpath(
+            # Get fields
+            "//iq[@type='result']/muc_owner:query/x_data:x[@type='form']/x_data:field",
+            namespaces
+          ).inject({}){|result,field|
+            # Build MucConfiguration parameters
+            hash = {}
+            hash[:type]  = field.attr 'type'
+            hash[:label] = field.attr 'label'
+            
+            value = field.xpath('x_data:value', namespaces)
+            hash[:value] = hash[:type].match(/\-multi$/) ? value.map{|e| e.content } : value.text
+            
+            options = field.xpath('x_data:option', namespaces).map{|o|
+              { :label => o.attr('label'), :value => o.xpath('x_data:value', namespaces).text }
+            }
+            hash[:options] = options if options.any?
+            
+            result[field.attr 'var'] = hash
+            result
+          }
+          
+          Jubjub::MucConfiguration.new response
+        end
+        
+        # http://xmpp.org/extensions/xep-0045.html#destroyroom
+        # <iq from='crone1@shakespeare.lit/desktop'
+        #     id='begone'
+        #     to='heath@chat.shakespeare.lit'
+        #     type='set'>
+        #   <query xmlns='http://jabber.org/protocol/muc#owner'>
+        #     <destroy jid='darkcave@chat.shakespeare.lit'>
+        #       <reason>Macbeth doth come.</reason>
+        #     </destroy>
+        #   </query>
+        # </iq>
+        #
+        # Expected
+        # <iq from='heath@chat.shakespeare.lit'
+        #     id='begone'
+        #     to='crone1@shakespeare.lit/desktop'
+        #     type='result'/>
+        def destroy(jid)
+          request = Nokogiri::XML::Builder.new do |xml|
+            xml.iq(:to => jid, :type => 'set') {
+              xml.query('xmlns' => 'http://jabber.org/protocol/muc#owner'){
+                xml.destroy
+              }
+            }
+          end
+          
+          write(
+            # Generate stanza
+            request.to_xml
+          ).xpath(
+            # Check for valid response
+            '//iq[@type="result"]'
+          ).any?
+        end
+        
+        # http://xmpp.org/extensions/xep-0045.html#disco-rooms
+        # <iq from='hag66@shakespeare.lit/pda'
+        #     id='disco2'
+        #     to='chat.shakespeare.lit'
+        #     type='get'>
+        #   <query xmlns='http://jabber.org/protocol/disco#items'/>
+        # </iq>
+        #
+        # Expected
+        # <iq from='chat.shakespeare.lit'
+        #     id='disco2'
+        #     to='hag66@shakespeare.lit/pda'
+        #     type='result'>
+        #   <query xmlns='http://jabber.org/protocol/disco#items'>
+        #     <item jid='heath@chat.shakespeare.lit'
+        #           name='A Lonely Heath'/>
+        #     <item jid='darkcave@chat.shakespeare.lit'
+        #           name='A Dark Cave'/>
+        #     <item jid='forres@chat.shakespeare.lit'
+        #           name='The Palace'/>
+        #     <item jid='inverness@chat.shakespeare.lit'
+        #           name='Macbeth&apos;s Castle'/>
+        #   </query>
+        # </iq>
+        def list(jid)
+          request = Nokogiri::XML::Builder.new do |xml|
+            xml.iq(:to => jid, :type => 'get') {
+              xml.query('xmlns' => 'http://jabber.org/protocol/disco#items')
+            }
+          end
+          
+          write(
+            # Generate stanza
+            request.to_xml
+          ).xpath(
+            # Pull out required parts
+            '//iq[@type="result"]/disco_items:query/disco_items:item',
+            namespaces
+          ).map{|item| 
+            # Convert to Jubjub object
+            Jubjub::Muc.new item.attr('jid'), item.attr('name'), @connection
+          }
+        end
+        
+      private
+      
+        def presence(full_jid)
+          request = Nokogiri::XML::Builder.new do |xml|
+            xml.presence(:to => full_jid) {
+              xml.x('xmlns' => 'http://jabber.org/protocol/muc')
+            }
+          end
+          
+          write request.to_xml
+        end
+        
+        def namespaces
+          {
+            'disco_items' => 'http://jabber.org/protocol/disco#items',
+            'muc_owner'   => "http://jabber.org/protocol/muc#owner",
+            'x_data'      => 'jabber:x:data'
+          }
+        end
+        
+      end
+    end
+  end
+end

data/lib/jubjub/connection/xmpp_gateway.rb

@@ -0,0 +1,47 @@
+require "net/http"
+require "nokogiri"
+require "jubjub/connection/xmpp_gateway/muc"
+
+module Jubjub
+  module Connection
+    class XmppGateway
+      
+      attr_reader :jid
+      
+      def initialize(jid,password,settings)
+        @jid      = jid
+        @password = password
+        @settings = settings
+      end
+      
+      def muc
+        @muc ||= Muc.new(self)
+      end
+      
+      def write(stanza)
+        req = Net::HTTP::Post.new( url.path )
+        req.basic_auth( @jid.to_s, @password )
+        req.set_form_data( { 'stanza'=> stanza }, ';' )
+        res = Net::HTTP.new(url.host, url.port).start {|http| http.request req }
+        case res
+        when Net::HTTPSuccess
+          # OK
+        else
+          #res.error!
+        end      
+        decode res.body
+      end
+
+    private
+    
+      def url
+        URI.parse "http://#{@settings[:host]}:#{@settings[:port]}/"
+      end
+      
+      def decode(http_body)
+        Nokogiri::XML::Document.parse http_body
+      end
+
+    end
+  end
+end

data/lib/jubjub/errors.rb

@@ -0,0 +1,7 @@
+module Jubjub
+  class Error < StandardError
+  end
+  
+  class ArgumentError < Error
+  end
+end

data/lib/jubjub/jid.rb

@@ -0,0 +1,33 @@
+module Jubjub
+  class Jid
+    
+    PATTERN = /^(?:([^@]*)@)??([^@\/]*)(?:\/(.*?))?$/
+    
+    attr_reader :node, :domain, :resource
+    
+    def initialize(node, domain = nil, resource = nil)
+      if node.is_a? Jid
+        @node = node.node
+        @domain = node.domain
+        @resource = node.resource
+      else
+        @node = node
+        @domain = domain
+        @resource = resource
+      end
+      
+      if @domain.nil? && @resource.nil?
+        @node, @domain, @resource = node.to_s.scan(PATTERN).first
+      end
+    end
+    
+    def to_s
+      (node ? "#{node}@" : '') + domain + (resource ? "/#{resource}" : '')
+    end
+    
+    def ==(obj)
+      obj.is_a?( self.class ) && obj.to_s == self.to_s
+    end
+    
+  end
+end