xrc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1765652f98f9ded0ba8dc89c729babf653461914
+  data.tar.gz: d2192424e3c6737e616d2774d02fefa485ba029c
+SHA512:
+  metadata.gz: 26d909993287c8bef933efc2b7f5a6121216240dc107e31c55410d7eefba4ee3c900a4bdf66476e62c952ef59ef47ac791d01d2730e7b597b06d507e8cc0cbd8
+  data.tar.gz: d1278831dabc08f37324389d1532bfd16c73599ded497b2118d3c1b3fc41d588dbdca9b511eaeda7042a79f90939c14ee8e9d4c3f168eed8a28a7958d9e78134

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ryo Nakamura
+
+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,34 @@
+# Xrc
+XMPP Ruby Client.
+
+## Usage
+```ruby
+# Loads all classes & modules defined in this library.
+require "xrc"
+
+# Constructs a new Client class to connect to a XMPP server.
+client = Xrc::Client.new(
+  jid: "foo@example.com",      # required
+  nickname: "bot"              # optional
+  password: "xxx",             # optional
+  port: 5222,                  # optional, default: 5222
+  room_jid: "bar@example.com", # optional
+)
+
+# Responds to "ping" and returns "pong".
+client.on_private_message do |message|
+  if message.body == "ping"
+    client.reply(body: "pong", to: message)
+  end
+end
+
+# Responds to "Thank you" and returns "You're welcome".
+client.on_room_message do |message|
+  if message.body == "Thank you"
+    client.reply(body: "You're welcome", to: message)
+  end
+end
+
+# Connects to a XMPP server and waits for new messages.
+client.connect
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/xrc.rb

@@ -0,0 +1,43 @@
+require "active_support/core_ext/enumerable"
+require "active_support/core_ext/object/try"
+require "active_support/core_ext/string/indent"
+require "base64"
+require "openssl"
+require "ostruct"
+require "resolv"
+require "rexml/document"
+require "rexml/element"
+require "rexml/parsers/sax2parser"
+require "securerandom"
+require "socket"
+
+require "xrc/method_loggable"
+require "xrc/client"
+require "xrc/connection"
+require "xrc/connection/connector"
+require "xrc/connection/tsl_connector"
+require "xrc/elements/auth"
+require "xrc/elements/bind"
+require "xrc/elements/message"
+require "xrc/elements/presence"
+require "xrc/elements/join"
+require "xrc/elements/ping"
+require "xrc/elements/roster"
+require "xrc/elements/session"
+require "xrc/elements/starttls"
+require "xrc/elements/stream"
+require "xrc/hosts_resolver"
+require "xrc/message_builder"
+require "xrc/messages/base"
+require "xrc/messages/null"
+require "xrc/messages/message"
+require "xrc/messages/private_message"
+require "xrc/messages/room_message"
+require "xrc/messages/subject"
+require "xrc/namespaces"
+require "xrc/jid"
+require "xrc/parser"
+require "xrc/roster"
+require "xrc/socket"
+require "xrc/user"
+require "xrc/version"

data/lib/xrc/client.rb

@@ -0,0 +1,318 @@
+module Xrc
+  class Client
+    DEFAULT_PORT = 5222
+
+    PING_INTERVAL = 30
+
+    # @return [Xrc::Roster] Users information existing in the server
+    attr_reader :users
+
+    # @option options [String] :port Port number to connect server (default: 5222)
+    # @option options [String] :jid Jabber ID of your account (required)
+    # @option options [String] :nickname Pass nickname for the Room (optional)
+    # @option options [String] :password Password to connect server (optional)
+    # @option options [String] :room_jid Room Jabber ID to join in after authentication (optional)
+    # @example
+    #   client = Xrc::Client.new(jid: "alice@example.com")
+    def initialize(options = {})
+      @options = options
+    end
+
+    # Connects to the JID's server and waits for message
+    # @return [nil] Returns nothing
+    def connect
+      connection.connect
+      nil
+    end
+
+    # Registers a callback called when client received a new private message (a.k.a. 1vs1 message)
+    # @yield Executes a given callback in the Client's context
+    # @yieldparam element [Xrc::Message] Represents a given message
+    # @return [Proc] Returns given block
+    # @example
+    #   client.on_private_message do |message|
+    #     puts "#{message.from}: #{message.body}"
+    #   end
+    #
+    def on_private_message(&block)
+      @on_private_message_block = block
+    end
+
+    # Registers a callback called when client received a new room message
+    # @yield Executes a given callback in the Client's context
+    # @yieldparam element [Xrc::Message] Represents a given message
+    # @return [Proc] Returns given block
+    # @example
+    #   client.on_room_message do |message|
+    #     puts "#{message.from}: #{message.body}"
+    #   end
+    #
+    def on_room_message(&block)
+      @on_room_message_block = block
+    end
+
+    # Registers a callback called when client received a new message with subject
+    # @yield Executes a given callback in the Client's context
+    # @yieldparam element [Xrc::Message] Represents a given message
+    # @return [Proc] Returns given block
+    # @example
+    #   client.on_subject do |element|
+    #     puts "Subject: #{element.subject}"
+    #   end
+    #
+    def on_subject(&block)
+      @on_subject_block = block
+    end
+
+    # Registers a callback called when client received a new XML element from server
+    # @yield Executes a given callback in the Client's context
+    # @yieldparam element [REXML::Element] Represents a new XML element
+    # @return [Proc] Returns given block
+    # @example
+    #   client.on_event do |element|
+    #     puts "Received #{element}"
+    #   end
+    #
+    def on_event(&block)
+      @on_event_block = block
+    end
+
+    # Replies to given message
+    # @option options [Xrc::Messages::Base] :to A message object given from server
+    # @option options [String] :body A text to be sent to server
+    # @return [REXML::Element] Returns an element sent to server
+    # @example
+    #   client.reply(body: "Thanks", to: message)
+    def reply(options)
+      say(
+        body: options[:body],
+        from: options[:to].to,
+        to: options[:to].from,
+        type: options[:to].type,
+      )
+    end
+
+    # @return [String] Mention name of this account
+    # @example
+    #   client.mention_name #=> "alice"
+    def mention_name
+      users[jid].try(:mention_name)
+    end
+
+    private
+
+    def on_event_block
+      @on_event_block ||= ->(element) {}
+    end
+
+    def on_private_message_block
+      @on_private_message_block ||= ->(element) {}
+    end
+
+    def on_room_message_block
+      @on_room_message_block ||= ->(element) {}
+    end
+
+    def on_subject_block
+      @on_subject_block ||= ->(element) {}
+    end
+
+    def on_received(element)
+      on_event_block.call(element)
+      case
+      when element.attribute("id") && has_reply_callbacks_to?(element.attribute("id").value)
+        on_replied(element)
+      when element.name == "message"
+        on_room_message_received(element)
+      when element.prefix == "stream" && element.name == "features"
+        on_features_received(element)
+      when element.name == "proceed" && element.namespace == Namespaces::TLS
+        on_tls_proceeded(element)
+      when element.name == "success" && element.namespace == Namespaces::SASL
+        on_authentication_succeeded(element)
+      when element.name == "failure" && element.namespace == Namespaces::SASL
+        on_authentication_failed(element)
+      end
+    end
+
+    def jid
+      @jid ||= Jid.new(@options[:jid])
+    end
+
+    def password
+      @options[:password]
+    end
+
+    def nickname
+      @options[:nickname]
+    end
+
+    def port
+      @options[:port] || DEFAULT_PORT
+    end
+
+    def room_jid
+      Jid.new("#{@options[:room_jid]}") if @options[:room_jid]
+    end
+
+    def connection
+      @connection ||= Connection.new(domain: jid.domain, port: port) do |element|
+        on_received(element)
+      end
+    end
+
+    def on_room_message_received(element)
+      case message = MessageBuilder.build(element)
+      when Messages::RoomMessage
+        on_room_message_block.call(message)
+      when Messages::PrivateMessage
+        on_private_message_block.call(message)
+      when Messages::Subject
+        on_subject_block.call(message)
+      end
+    end
+
+    def on_bound(element)
+      @jid = Jid.new(element.elements["/bind/jid/text()"].value)
+      establish_session
+      require_roster
+    end
+
+    def on_replied(element)
+      id = element.attribute("id").value
+      callback = reply_callbacks.delete(id)
+      callback.call(element)
+    end
+
+    def on_features_received(element)
+      element.each do |feature|
+        case
+        when feature.name == "bind" && feature.namespace == Namespaces::BIND
+          bind
+        when feature.name == "starttls" && feature.namespace == Namespaces::TLS
+          start_tls
+        when feature.name == "mechanisms" && feature.namespace == Namespaces::SASL
+          on_mechanisms_received(feature)
+        else
+          features[feature.name] = feature.namespace
+        end
+      end
+    end
+
+    def on_authentication_succeeded(element)
+      connection.open
+    end
+
+    def on_authentication_failed(element)
+      raise NotImplementedError
+    end
+
+    def on_tls_proceeded(element)
+      connection.encrypt
+    end
+
+    def on_mechanisms_received(element)
+      element.each_element("mechanism") do |mechanism|
+        mechanisms << mechanism.text
+      end
+      authenticate if password
+    end
+
+    def on_roster_received(element)
+      @users = Roster.new(element)
+      attend
+      on_connection_established
+    end
+
+    def on_connection_established
+      join if room_jid
+      start_ping_thread
+    end
+
+    def features
+      @features ||= {}
+    end
+
+    def mechanisms
+      @mechanisms ||= []
+    end
+
+    def reply_callbacks
+      @reply_callbacks ||= {}
+    end
+
+    def has_reply_callbacks_to?(id)
+      reply_callbacks.has_key?(id)
+    end
+
+    def post(element, &block)
+      if block
+        id = generate_id
+        element.add_attributes("id" => id)
+        reply_callbacks[id] = block
+      end
+      connection.write(element)
+      element
+    end
+
+    # See RFC1750 for Randomness Recommendations for Security
+    def generate_id
+      SecureRandom.hex(8)
+    end
+
+    def bind
+      post(Elements::Bind.new(resource: jid.resource), &method(:on_bound))
+    end
+
+    def establish_session
+      post(Elements::Session.new)
+    end
+
+    def require_roster
+      post(Elements::Roster.new, &method(:on_roster_received))
+    end
+
+    def attend
+      post(Elements::Presence.new)
+    end
+
+    def join
+      post(Elements::Join.new(from: jid.strip, to: "#{room_jid}/#{nickname}"))
+    end
+
+    def ping
+      post(Elements::Ping.new(from: jid.to_s, to: jid.domain))
+    end
+
+    def start_tls
+      post(Elements::Starttls.new)
+    end
+
+    def start
+      post(Elements::Stream.new(domain: jid.domain))
+    end
+
+    # Only supports PLAIN authentication
+    def authenticate
+      post(Elements::Auth.new(jid: jid, password: password))
+    end
+
+    def say(options)
+      post Elements::Message.new(
+        body: options[:body],
+        from: options[:from],
+        to: options[:to],
+        type: options[:type],
+      )
+    end
+
+    def start_ping_thread
+      Thread.new do
+        loop do
+          ping
+          sleep(PING_INTERVAL)
+        end
+      end
+    end
+  end
+end