xrc 0.0.1

data/lib/xrc/messages/base.rb

@@ -0,0 +1,37 @@
+module Xrc
+  module Messages
+    class Base
+      # @return [REXML::Element] Raw element object
+      attr_reader :element
+
+      # @param [REXML::Element] element A message element
+      def initialize(element)
+        @element = element
+      end
+
+      # Returns a JID of message sender
+      # @return [String]
+      # @example
+      #   message.from #=> "alice@example.com"
+      def from
+        @element.attribute("from").to_s
+      end
+
+      # Returns a JID of message address
+      # @return [String]
+      # @example
+      #   message.to #=> "bob@example.com"
+      def to
+        @element.attribute("to").to_s
+      end
+
+      # Returns the type of the message
+      # @return [String]
+      # @example
+      #   message.type #=> "groupchat"
+      def type
+        @element.attribute("type").to_s
+      end
+    end
+  end
+end

data/lib/xrc/messages/message.rb

@@ -0,0 +1,29 @@
+module Xrc
+  module Messages
+    class Message < Base
+      # Returns the message body (e.g. Hello)
+      # @return [String]
+      # @example
+      #   message.body #=> "Hello"
+      def body
+        @element.elements["body/text()"].to_s
+      end
+
+      # Returns this message in Hash format
+      # @return [Hash]
+      # @example
+      #   message.to_hash #=> {
+      #     :body => "bob@example.com",
+      #     :from => "alice@example.com",
+      #     :to   => "bob@example.com",
+      #   }
+      def to_hash
+        {
+          body: body,
+          from: from,
+          to: to,
+        }
+      end
+    end
+  end
+end

data/lib/xrc/messages/null.rb

@@ -0,0 +1,6 @@
+module Xrc
+  module Messages
+    class Null < Base
+    end
+  end
+end

data/lib/xrc/messages/private_message.rb

@@ -0,0 +1,6 @@
+module Xrc
+  module Messages
+    class PrivateMessage < Message
+    end
+  end
+end

data/lib/xrc/messages/room_message.rb

@@ -0,0 +1,6 @@
+module Xrc
+  module Messages
+    class RoomMessage < Message
+    end
+  end
+end

data/lib/xrc/messages/subject.rb

@@ -0,0 +1,29 @@
+module Xrc
+  module Messages
+    class Subject < Base
+      # Returns the message subject (e.g. Room1)
+      # @return [String]
+      # @example
+      #   message.subject #=> "Room1"
+      def subject
+        @element.elements["subject/text()"].to_s
+      end
+
+      # Returns this message in Hash format
+      # @return [Hash]
+      # @example
+      #   message.to_hash #=> {
+      #     :from    => "alice@example.com",
+      #     :subject => "Room1",
+      #     :to      => "bob@example.com",
+      #   }
+      def to_hash
+        {
+          from: from,
+          to: to,
+          subject: subject,
+        }
+      end
+    end
+  end
+end

data/lib/xrc/method_loggable.rb

@@ -0,0 +1,22 @@
+require "active_support/core_ext/module/aliasing"
+require "active_support/logger"
+
+module Xrc
+  module MethodLoggable
+    class << self
+      attr_writer :logger
+
+      def logger
+        @logger ||= ActiveSupport::Logger.new(STDOUT)
+      end
+    end
+
+    def log(method_name, &block)
+      define_method("#{method_name}_with_log") do |*args|
+        Xrc::MethodLoggable.logger.info(instance_exec(*args, &block))
+        __send__("#{method_name}_without_log", *args)
+      end
+      alias_method_chain method_name, :log
+    end
+  end
+end

data/lib/xrc/namespaces.rb

@@ -0,0 +1,11 @@
+module Xrc
+  module Namespaces
+    BIND = "urn:ietf:params:xml:ns:xmpp-bind"
+    MUC = "http://jabber.org/protocol/muc"
+    PING = "urn:xmpp:ping"
+    ROSTER = "jabber:iq:roster"
+    SASL = "urn:ietf:params:xml:ns:xmpp-sasl"
+    SESSION = "urn:ietf:params:xml:ns:xmpp-session"
+    TLS = "urn:ietf:params:xml:ns:xmpp-tls"
+  end
+end

data/lib/xrc/parser.rb

@@ -0,0 +1,89 @@
+module Xrc
+  class Parser < REXML::Parsers::SAX2Parser
+    EVENTS = [
+      :cdata,
+      :characters,
+      :end_document,
+      :end_element,
+      :start_element,
+    ]
+
+    attr_accessor :current
+
+    attr_reader :block, :options
+
+    def initialize(options, &block)
+      super(options[:socket])
+      @block = block
+      bind
+    end
+
+    private
+
+    def bind
+      EVENTS.each do |event|
+        listen(event) do |*args|
+          send(event, *args)
+        end
+      end
+    end
+
+    def cdata(text)
+      if current
+        cdata = REXML::CData.new(text)
+        current.add(cdata)
+      end
+    end
+
+    def characters(text)
+      if current
+        text = REXML::Text.new(text, current.whitespace, nil, true)
+        current.add(text)
+      end
+    end
+
+    def end_document
+    end
+
+    def end_element(uri, localname, qname)
+      consume if has_current? && !has_parent?
+      pop
+    end
+
+    def start_element(uri, localname, qname, attributes)
+      element = REXML::Element.new(qname)
+      element.add_attributes(attributes)
+      if qname == "stream:stream"
+        consume(element)
+      else
+        push(element)
+      end
+    end
+
+    def push(element)
+      if current
+        self.current = current.add_element(element)
+      else
+        self.current = element
+      end
+    end
+
+    def pop
+      if current
+        self.current = current.parent
+      end
+    end
+
+    def consume(element = current)
+      block.call(element)
+    end
+
+    def has_current?
+      !!current
+    end
+
+    def has_parent?
+      !current.parent.nil?
+    end
+  end
+end

data/lib/xrc/roster.rb

@@ -0,0 +1,28 @@
+module Xrc
+  class Roster
+    # @param [REXML::Element] element An element of the response of roster requirement
+    def initialize(element)
+      @element = element
+    end
+
+    # Find a Xrc::User object from its JID
+    # @param [String] jid JID
+    # @return [Xrc::User]
+    # @return [nil]
+    def [](jid)
+      users.find {|user| user.jid == jid }
+    end
+
+    private
+
+    def users
+      @users ||= @element.elements.collect("query/item") do |item|
+        User.new(
+          jid: item.attribute("jid").to_s,
+          mention_name: item.attribute("mention_name").to_s,
+          name: item.attribute("name").to_s,
+        )
+      end
+    end
+  end
+end

data/lib/xrc/socket.rb

@@ -0,0 +1,7 @@
+module Xrc
+  class Socket < OpenSSL::SSL::SSLSocket
+    def sysread(*args)
+      super.force_encoding(Encoding::UTF_8)
+    end
+  end
+end

data/lib/xrc/user.rb

@@ -0,0 +1,27 @@
+module Xrc
+  class User
+    # @option attributes [String] :jid JID
+    # @option attributes [String] :mention_name Mention name
+    # @option attributes [String] :name Full name
+    # @example
+    #   Xrc::Client.new(jid: "alice@example.com", mention_name: "alice", name: "Alice Liddel")
+    def initialize(attributes)
+      @attributes = attributes
+    end
+
+    # @return [Xrc::Jid] JID represented in a Xrc::Jid object
+    def jid
+      @jid ||= Jid.new(@attributes[:jid])
+    end
+
+    # @return [String] Mention name
+    def mention_name
+      @attributes[:mention_name]
+    end
+
+    # @return [String] Full name
+    def name
+      @attributes[:name]
+    end
+  end
+end

data/lib/xrc/version.rb

@@ -0,0 +1,3 @@
+module Xrc
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require "xrc"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end
+
+Xrc::MethodLoggable.logger.level = 2

data/spec/xrc/client_spec.rb

@@ -0,0 +1,75 @@
+require "spec_helper"
+require "active_support/core_ext/string/strip"
+require "stringio"
+
+describe Xrc::Client do
+  after do
+    server.close
+  end
+
+  let!(:server) do
+    TCPServer.new(port)
+  end
+
+  let(:instance) do
+    described_class.new(*args)
+  end
+
+  let(:args) do
+    [options]
+  end
+
+  let(:options) do
+    {
+      jid: jid,
+      port: port,
+    }
+  end
+
+  let(:port) do
+    5222
+  end
+
+  let(:jid) do
+    "#{node}@#{domain}/#{resource}"
+  end
+
+  let(:node) do
+    "alice"
+  end
+
+  let(:domain) do
+    "localhost"
+  end
+
+  let(:resource) do
+    "bot"
+  end
+
+  let(:socket) do
+    StringIO.new <<-EOS.strip_heredoc
+      <?xml version="1.0" encoding="UTF-8"?>
+      <stream:stream
+        from='#{domain}'
+        id='5d29a171a9472e73'
+        xmlns:stream='http://etherx.jabber.org/streams'
+        version='1.0'
+        xmlns='jabber:client'>
+        <stream:features>
+          <starttls xmlns='#{Namespaces::TLS}'/>
+          <required/>
+        </stream:features>
+    EOS
+  end
+
+  describe "#run" do
+    before do
+      pending
+      instance.stub(socket: socket)
+    end
+
+    it "parses received XML message" do
+      instance.run
+    end
+  end
+end

data/spec/xrc/jid_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe Xrc::Jid do
+  let(:instance) do
+    described_class.new(*args)
+  end
+
+  let(:args) do
+    [jid]
+  end
+
+  let(:jid) do
+    "#{node}@#{domain}/#{resource}"
+  end
+
+  let(:node) do
+    "alice"
+  end
+
+  let(:domain) do
+    "example.com"
+  end
+
+  let(:resource) do
+    "bot"
+  end
+
+  describe "#initialize" do
+    it "parses node, domain, resource sections" do
+      instance.node.should == node
+      instance.domain.should == domain
+      instance.resource.should == resource
+    end
+  end
+end