jabber4r-revive 0.9.0 → 0.10.0

data/.gitignore

@@ -1,4 +1,5 @@
-.rvmrc
-
-tmp/
-pkg/
+.rvmrc
+Gemfile.lock
+
+tmp/
+pkg/

data/.rspec

@@ -1,3 +1,3 @@
---color
---format progress
---order random
+--color
+--format progress
+--order random

data/.travis.yml

@@ -1,8 +1,8 @@
-language: ruby
-rvm:
-  - 1.9.2
-  - 1.9.3
-branches:
-  only:
-    - master
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+branches:
+  only:
+    - master
 script: bundle exec rspec

data/CHANGELOG

@@ -1,15 +1,25 @@
 
+v0.10.0
+  - 2013/07/08: fix(changelog) fixed version recognition (Strech (aka Sergey Fedorov))
+  - 2013/07/05: feature(bosh) added authentication via sasl and non-sasl technology (Strech (aka Sergey Fedorov))
+  - 2013/07/02: fix(rfc) added 'version' attribute to plain open stream tag (Strech (aka Sergey Fedorov))
+  - 2013/06/28: chore(gemspec) removed Gemfile.lock (Strech (aka Sergey Fedorov))
+  - 2013/06/28: style(protocol) removed debug information (Strech (aka Sergey Fedorov))
+  - 2013/06/28: refactor(all) change host to domain (Aelphy)
+  - 2013/06/26: style(all) debug methods added (Strech (aka Sergey Fedorov))
+
 v0.9.0
+  - 2013/06/26: Release 0.9.0 (Strech (aka Sergey Fedorov))
   - 2013/06/26: feature(changelog) added changelog file (Strech (aka Sergey Fedorov))
   - 2013/06/26: Jabber::BoshSession : Modified to_json method (Strech (aka Sergey Fedorov))
   - 2013/06/25: Jabber::BoshSession : XMPP over BOSH (XEP-0206) (Strech (aka Sergey Fedorov))
   - 2013/06/20: Jabber::Connection : Change method parse_failure (Strech (aka Sergey Fedorov))
   - 2013/06/20: Jabber::Connection : Refactoring (Strech (aka Sergey Fedorov))
   - 2013/06/20: Rspec : Socket mock changed. Jabber::Connection : Specs for #send (Strech (aka Sergey Fedorov))
+  - 2013/06/20: Jabber::Connection : add_filter and remove_filter refactoring (Strech (aka Sergey Fedorov))
   - 2013/06/20: Rspec : Change rspec dummy text (Strech (aka Sergey Fedorov))
   - 2013/06/20: Jabber::Debugger : Added (Strech (aka Sergey Fedorov))
   - 2013/06/20: Jabber : Moved up on one level (Strech (aka Sergey Fedorov))
-  - 2013/06/20: Jabber::Connection : add_filter and remove_filter refactoring (Strech (aka Sergey Fedorov))
   - 2013/06/20: F (Strech (aka Sergey Fedorov))
   - 2013/06/20: F (Strech (aka Sergey Fedorov))
   - 2013/06/19: Jabber::Connection : New method force_close! added (Strech (aka Sergey Fedorov))

data/Gemfile

@@ -1,3 +1,3 @@
-source 'https://rubygems.org'
-
-gemspec
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -1,29 +1,29 @@
-# Jabber4r (revive)
-
-Original [README](http://rubydoc.info/gems/jabber4r/file/README) and original [jabber4r web-site](http://jabber4r.rubyforge.org/)
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'jabber4r-revive'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install jabber4r-revive
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+# Jabber4r (revive)
+
+Original [README](http://rubydoc.info/gems/jabber4r/file/README) and original [jabber4r web-site](http://jabber4r.rubyforge.org/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jabber4r-revive'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jabber4r-revive
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -1,71 +1,71 @@
-# coding: utf-8
-
-require "bundler/gem_tasks"
-require "pty"
-
-# ============================== Support =======================================
-
-ROOT_PATH = File.expand_path("..", __FILE__)
-VERSION_PATH = File.join(ROOT_PATH, "lib", "jabber4r", "version.rb")
-CHANGELOG_PATH = File.join(ROOT_PATH, "CHANGELOG")
-
-# get current version from version.rb file
-def current_version
-  version = File.read(VERSION_PATH).gsub(/[^\d\.]+/, "").strip.chomp
-end
-
-# get released version from git
-def released_version
-  /\Av([\d\.]+)\z/ === `git describe --tags --abbrev=0 2>/dev/null || echo 'v0.0.0'`.chomp.strip
-
-  $1
-end
-
-# run +cmd+ in subprocess, redirect its stdout to parent's stdout
-def spawn(cmd, stdout = STDOUT)
-  puts ">> #{cmd}"
-
-  cmd += ' 2>&1'
-  PTY.spawn cmd do |r, w, pid|
-    begin
-      r.sync
-      r.each_char { |chr| stdout.write(chr) }
-    rescue Errno::EIO => e
-      # simply ignoring this
-    ensure
-      ::Process.wait pid
-    end
-  end
-  abort "#{cmd} failed" unless $? && $?.exitstatus == 0
-end
-
-# =============================== Tasks ========================================
-
-namespace :version do
-  task :current do
-    puts current_version
-  end
-
-  desc "Release new version"
-  task release: [:changelog, :commit, :tag]
-
-  desc "Add new version to git repo"
-  task :commit do
-    spawn "git add '#{VERSION_PATH}'"
-    spawn "git diff --cached --exit-code > /dev/null || git commit -m \"Release #{current_version}\" || echo -n"
-  end
-
-  desc "Add git tag for new version"
-  task :tag do
-    spawn "git tag v#{current_version}"
-  end
-
-  desc "Generate file CHANGELOG"
-  task :changelog do
-    spawn "changelogger changelog '#{ROOT_PATH}' --top_version='v#{current_version}' > '#{CHANGELOG_PATH}'"
-    spawn "git add '#{CHANGELOG_PATH}'"
-  end
-end
-
-desc "Show current version"
+# coding: utf-8
+
+require "bundler/gem_tasks"
+require "pty"
+
+# ============================== Support =======================================
+
+ROOT_PATH = File.expand_path("..", __FILE__)
+VERSION_PATH = File.join(ROOT_PATH, "lib", "jabber4r", "version.rb")
+CHANGELOG_PATH = File.join(ROOT_PATH, "CHANGELOG")
+
+# get current version from version.rb file
+def current_version
+  version = File.read(VERSION_PATH).match(/VERSION \= \"(\d+\.\d+\.\d+)\"/)[1].strip.chomp
+end
+
+# get released version from git
+def released_version
+  /\Av([\d\.]+)\z/ === `git describe --tags --abbrev=0 2>/dev/null || echo 'v0.0.0'`.chomp.strip
+
+  $1
+end
+
+# run +cmd+ in subprocess, redirect its stdout to parent's stdout
+def spawn(cmd, stdout = STDOUT)
+  puts ">> #{cmd}"
+
+  cmd += ' 2>&1'
+  PTY.spawn cmd do |r, w, pid|
+    begin
+      r.sync
+      r.each_char { |chr| stdout.write(chr) }
+    rescue Errno::EIO => e
+      # simply ignoring this
+    ensure
+      ::Process.wait pid
+    end
+  end
+  abort "#{cmd} failed" unless $? && $?.exitstatus == 0
+end
+
+# =============================== Tasks ========================================
+
+namespace :version do
+  task :current do
+    puts current_version
+  end
+
+  desc "Release new version"
+  task release: [:changelog, :commit, :tag]
+
+  desc "Add new version to git repo"
+  task :commit do
+    spawn "git add '#{VERSION_PATH}'"
+    spawn "git diff --cached --exit-code > /dev/null || git commit -m \"Release #{current_version}\" || echo -n"
+  end
+
+  desc "Add git tag for new version"
+  task :tag do
+    spawn "git tag v#{current_version}"
+  end
+
+  desc "Generate file CHANGELOG"
+  task :changelog do
+    spawn "changelogger changelog '#{ROOT_PATH}' --top_version='v#{current_version}' > '#{CHANGELOG_PATH}'"
+    spawn "git add '#{CHANGELOG_PATH}'"
+  end
+end
+
+desc "Show current version"
 task version: "version:current"

data/jabber4r-revive.gemspec

@@ -1,25 +1,25 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "jabber4r/version"
-
-Gem::Specification.new do |gem|
-  gem.name          = "jabber4r-revive"
-  gem.version       = Jabber::VERSION
-  gem.authors       = ["Richard Kilmer", "Sergey Fedorov"]
-  gem.email         = ["rich@infoether.com", "strech_ftf@mail.ru"]
-  gem.description   = "The purpose of this library is to allow Ruby applications to  talk to a Jabber IM system. Jabber is an open-source instant  messaging service, which can be learned about at http://www.jabber.org"
-  gem.summary       = "Read more http://jabber4r.rubyforge.org"
-  gem.homepage      = "https://github.com/Strech/jabber4r-revive"
-
-  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.require_paths = ["lib"]
-
-  gem.add_dependency "ox"
-
-  gem.add_development_dependency "rspec"
-  gem.add_development_dependency "webmock"
-  gem.add_development_dependency "changelogger"
-end
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jabber4r/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "jabber4r-revive"
+  gem.version       = Jabber::VERSION
+  gem.authors       = ["Richard Kilmer", "Sergey Fedorov"]
+  gem.email         = ["rich@infoether.com", "strech_ftf@mail.ru"]
+  gem.description   = "The purpose of this library is to allow Ruby applications to  talk to a Jabber IM system. Jabber is an open-source instant  messaging service, which can be learned about at http://www.jabber.org"
+  gem.summary       = "Read more http://jabber4r.rubyforge.org"
+  gem.homepage      = "https://github.com/Strech/jabber4r-revive"
+
+  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.require_paths = ["lib"]
+
+  gem.add_dependency "ox", "~> 2.0.4"
+
+  gem.add_development_dependency "rspec", "~> 2.13.0"
+  gem.add_development_dependency "webmock", "~> 1.11.0"
+  gem.add_development_dependency "changelogger", "~> 0.0.3"
+end

data/lib/jabber4r.rb

@@ -1,33 +1,38 @@
-# License: see LICENSE.txt
-# Jabber4R - Jabber Instant Messaging Library for Ruby
-# Copyright (C) 2002  Rich Kilmer <rich@infoether.com>
-
-
-# The Jabber module is the main namespace for all Jabber modules
-# and classes.
-module Jabber
-  DEBUG = false
-
-  # Public: Should raise if connection was force closed
-  class ConnectionForceCloseError < StandardError; end
-
-  # Public: Should raise if received XML data is malformed
-  class XMLMalformedError < StandardError; end
-
-  # Public: Should raise if authentication failed
-  class AuthenticationError < StandardError; end
-end
-
-require "jabber4r/debugger"
-require "jabber4r/session"
-require "jabber4r/bosh_session"
-require "jabber4r/protocol"
-require "jabber4r/connection"
-require "jabber4r/protocol/iq"
-require "jabber4r/protocol/presence"
-require "jabber4r/protocol/message"
-require "jabber4r/protocol/xml_element"
-require "jabber4r/protocol/parsed_xml_element"
-require "jabber4r/roster"
-require "jabber4r/jid"
-require "jabber4r/vcard"
+# License: see LICENSE.txt
+# Jabber4R - Jabber Instant Messaging Library for Ruby
+# Copyright (C) 2002  Rich Kilmer <rich@infoether.com>
+
+
+# The Jabber module is the main namespace for all Jabber modules
+# and classes.
+module Jabber
+  DEBUG = false
+
+  # Public: Should raise if connection was force closed
+  class ConnectionForceCloseError < StandardError; end
+
+  # Public: Should raise if received XML data is malformed
+  class XMLMalformedError < StandardError; end
+
+  # Public: Should raise if authentication failed
+  class AuthenticationError < StandardError; end
+end
+
+require "jabber4r/debugger"
+
+require "jabber4r/protocol"
+require "jabber4r/connection"
+
+require "jabber4r/protocol/iq"
+require "jabber4r/protocol/presence"
+require "jabber4r/protocol/message"
+require "jabber4r/protocol/xml_element"
+require "jabber4r/protocol/parsed_xml_element"
+require "jabber4r/protocol/authentication"
+
+require "jabber4r/jid"
+require "jabber4r/bosh"
+require "jabber4r/session"
+
+require "jabber4r/roster"
+require "jabber4r/vcard"

data/lib/jabber4r/bosh.rb

@@ -0,0 +1,21 @@
+# coding: utf-8
+
+# License: see LICENSE
+# Jabber4R - Jabber Instant Messaging Library for Ruby
+# Copyright (C) 2002  Rich Kilmer <rich@infoether.com>
+# Copyright (C) 2013  Sergey Fedorov <strech_ftf@mail.ru>
+
+module Jabber
+  module Bosh
+    # Public: Default connection options
+    DEFAULTS = {
+      domain: "localhost",
+      port: 5280,
+      bind_uri: "/http-bind",
+      use_sasl: true
+    }.freeze
+  end
+end
+
+require "jabber4r/bosh/authentication"
+require "jabber4r/bosh/session"

data/lib/jabber4r/bosh/authentication.rb

@@ -0,0 +1,13 @@
+# coding: utf-8
+
+# License: see LICENSE
+# Jabber4R - Jabber Instant Messaging Library for Ruby
+# Copyright (C) 2002  Rich Kilmer <rich@infoether.com>
+# Copyright (C) 2013  Sergey Fedorov <strech_ftf@mail.ru>
+
+module Jabber::Bosh
+  module Authentication; end
+end
+
+require "jabber4r/bosh/authentication/sasl"
+require "jabber4r/bosh/authentication/non_sasl"

data/lib/jabber4r/bosh/authentication/non_sasl.rb

@@ -0,0 +1,219 @@
+# coding: utf-8
+
+# License: see LICENSE
+# Jabber4R - Jabber Instant Messaging Library for Ruby
+# Copyright (C) 2002  Rich Kilmer <rich@infoether.com>
+# Copyright (C) 2013  Sergey Fedorov <strech_ftf@mail.ru>
+
+require "ox"
+
+module Jabber::Bosh::Authentication
+  # This class provides Non-SASL authentication for BOSH session
+  class NonSASL
+    # Public: Instance of Jabber::Bosh::Session
+    attr_reader :session
+
+    # Public: Opened stream identifier
+    attr_reader :stream_id
+
+    def initialize(session)
+      @session = session
+    end
+
+    def authenticate(jid, password)
+      open_stream
+
+      pass_authentication(jid, password)
+    end
+
+    # Internal: Send open stream command to jabber server
+    #
+    # Raises XMLMalformedError
+    # Returns boolean
+    def open_stream
+      body = Ox::Element.new("body").tap do |element|
+        element[:xmlns]   = "http://jabber.org/protocol/httpbind"
+        element[:content] = "text/xml; charset=utf-8"
+        element[:rid]     = session.generate_next_rid
+        element[:to]      = session.domain
+        element[:secure]  = true
+        element[:wait]    = 60
+        element[:hold]    = 1
+      end
+
+      Jabber.debug(%Q[Open (rid="#{body.rid}") new session])
+
+      response = session.post(Ox.dump body)
+      xml = Ox.parse(response.body.tr("'", '"'))
+
+      [:sid, :authid].each do |m|
+        raise Jabber::XMLMalformedError,
+          "Couldn't find <body /> attribute [#{m}]" if xml[m].nil?
+      end
+
+      session.sid, @stream_id = xml.sid, xml.authid
+
+      true
+    end
+
+    # Internal: Send login request to jabber server
+    #
+    # jid      - Jabber::JID the jid of jabber user
+    # password - String the password of jabber user
+    #
+    # Raises TypeError
+    # Raises XMLMalformedError
+    # Returns boolean
+    def pass_authentication(jid, password)
+      raise TypeError,
+        "Jabber::JID expected, but #{jid.class} was given" unless jid.is_a?(Jabber::JID)
+
+      body = Ox::Element.new("body").tap do |element|
+        element[:xmlns]   = 'http://jabber.org/protocol/httpbind'
+        element[:content] = "text/xml; charset=utf-8"
+        element[:rid]     = session.generate_next_rid
+        element[:sid]     = session.sid
+
+        element << Query.new(jid, password, stream_id: stream_id, mechanism: :digest).to_ox
+      end
+
+      Jabber.debug(%Q[Authenticate {Non-SASL} (rid="#{body.rid}" sid="#{body.sid}") in opened session] +
+                   %Q[ as #{session.jid.node}/#{session.jid.resource}])
+
+      response = session.post(Ox.dump body)
+      xml = Ox.parse(response.body.tr("'", '"'))
+
+      raise Jabber::XMLMalformedError, "Couldn't find xml tag <iq/>" if xml.locate("iq").empty?
+      return false unless xml.iq[:type] == "result"
+
+      true
+    end
+
+    private
+    class Query
+      MECHANISMS = [:plain, :digest].freeze
+
+      attr_reader :jid, :password
+      attr_reader :stream_id, :mechanism
+
+      # Public: Creates new Non-SASL authentication object
+      #
+      # jid      - [Jabber::JID|String] the jid of jabber server user
+      # password - String the user password
+      # options  - Hash the authentication options (default: Empty hash)
+      #            :stream_id - String the stream identifier (authid)
+      #            :mechanism - Symbol the name of mechnism to use
+      #
+      # Examples
+      #
+      # non_sasl = Jabber::Protocol::Authentication::NonSASL.new("strech@localhost/res-1", "my-pass-phrase")
+      # non_sasl.plain? # => true
+      # non_sasl.to_xml # =>
+      #
+      # <iq type="set" id="...">
+      #   <query xmlns="jabber:iq:auth">
+      #     <username>strech</username>
+      #     <password>my-pass-phrase</password>
+      #     <resource>res-1</resource>
+      #   </query>
+      # </iq>
+      def initialize(jid, password, options = {})
+        raise TypeError,
+          "Class(Jabber::JID) or Class(String) expected," +
+          " but #{jid.class} was given" unless jid.is_a?(Jabber::JID) || jid.is_a?(String)
+
+        @jid = jid.is_a?(Jabber::JID) ? jid : Jabber::JID.new(jid)
+        @password = password
+
+        @mechanism = options.fetch(:mechanism, :plain)
+        @stream_id = options.fetch(:stream_id) if digest?
+
+        raise ArgumentError,
+          "Unknown authentication mechanism '#{mechanism}'," +
+          " available is [#{MECHANISMS * ", "}]" unless MECHANISMS.include?(mechanism)
+      end
+
+      # Public: Is NonSASL object is for plain authentication
+      #
+      # Returns boolean
+      def plain?
+        mechanism == :plain
+      end
+
+      # Public: Is NonSASL object is for digest authentication
+      #
+      # Returns boolean
+      def digest?
+        mechanism == :digest
+      end
+
+      # Public: Create XML string from NonSASL object
+      #
+      # Returns String
+      def dump
+        Ox.dump(send mechanism)
+      end
+      alias :to_xml :dump
+
+      # Public: Create Ox::Element from NonSASL object
+      #
+      # Returns Ox::Element
+      def to_ox
+        send(mechanism)
+      end
+
+      private
+      # Internal: Make xml object for plain authentication mechanism
+      #
+      # Returns Ox:Element
+      def plain
+        query = Ox::Element.new("query").tap do |element|
+          element[:xmlns] = "jabber:iq:auth"
+
+          element << (Ox::Element.new("username") << jid.node)
+          element << (Ox::Element.new("password") << password)
+          element << (Ox::Element.new("resource") << jid.resource)
+        end
+
+        build_iq(query)
+      end
+
+      # Internal: Make xml object for digest authentication mechanism
+      #
+      # Returns Ox:Element
+      def digest
+        query = Ox::Element.new("query").tap do |element|
+          element[:xmlns] = "jabber:iq:auth"
+
+          digest_password = self.class.generate_digest(stream_id, password)
+
+          element << (Ox::Element.new("username") << jid.node)
+          element << (Ox::Element.new("digest")   << digest_password)
+          element << (Ox::Element.new("resource") << jid.resource)
+        end
+
+        build_iq(query)
+      end
+
+      # Internal: The root iq stanza for authentication
+      #
+      # Returns Ox:Element
+      def build_iq(query)
+        Ox::Element.new("iq").tap do |element|
+          element[:xmlns] = "jabber:client"
+          element[:type]  = "set"
+          element[:id]    = Jabber.gen_random_id
+
+          element << query
+        end
+      end
+
+      # Internal: Generate hex string consist of concatination stream_id and password
+      #
+      # Returns String
+      def self.generate_digest(stream_id, password)
+        Digest::SHA1.hexdigest([stream_id, password].join)
+      end
+    end
+  end
+end