xmpp_simple 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8858b299fa6fee57b4a9aea3453a603d2a8171bd
+  data.tar.gz: be8e82a09dd4f06cd6c19e07b1f28924d9c5cb68
+SHA512:
+  metadata.gz: c1b3c60f6452814965902387d6d3e1639973f4ef6e6555db7e121ede4310c34ddea6525045892c74f9d6326d2f0482cfda93994d17b95f91b87fc604b311d710
+  data.tar.gz: 58d7bc1137044750b75a2f2713a1d5007dab973191ee84834b99cc5f9d5080f4a3c5960804cf835a1af5dabd6b5d0eea358cb030447b07e9b77581e52a3bccdb

data/.gitignore

@@ -0,0 +1,33 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  Exclude:
+    - 'vendor/**/*'
+LineLength:
+  Max: 120
+MethodLength:
+  Max: 15
+Documentation:
+  Enabled: false

data/.simplecov

@@ -0,0 +1 @@
+SimpleCov.start

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,11 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  # watch /lib/ files
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  # watch /spec/ files
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 l3akage
+
+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,59 @@
+# XmppSimple
+
+A simle xmpp implementation using celluloid
+intended to work with https://github.com/pushwerk/ccs
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'xmpp_simple', git: 'https://github.com/pushwerk/xmpp_simple.git'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+```
+class XMPPConnection
+  def initialize
+    xmpp_params = {
+      handler: self,
+      username: 'foobar',
+      password: 's3cr3t',
+      host: 'jabber.example.com',
+      port: 5222
+    }
+    @xmpp_client = XMPPSimple::Client.new(xmpp_params).connect
+  end
+
+  def send(xml)
+    @xmpp_client.write_data(xml)
+  end
+
+  # methods called by XMPPSimple
+  def message(node)
+    puts "received #{node.inspect}"
+  end
+
+  def disconnected
+    puts 'disconnected'
+  end
+
+  def connected
+    puts 'connected'
+  end
+end
+```
+
+## TODO
+* Probably more tests
+
+## Contributing
+
+1. Fork it ( https://github.com/pushwerk/xmpp_simple/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/xmpp_simple.rb

@@ -0,0 +1,30 @@
+require 'celluloid/io'
+require 'nokogiri'
+
+require 'xmpp_simple/stanzas/base_stanza'
+require 'xmpp_simple/stanzas/auth_mechanism'
+require 'xmpp_simple/stanzas/plain_auth'
+require 'xmpp_simple/stanzas/message'
+require 'xmpp_simple/stanzas/iq'
+require 'xmpp_simple/stanzas/bind'
+
+require 'xmpp_simple/client'
+require 'xmpp_simple/parser'
+require 'xmpp_simple/node'
+require 'xmpp_simple/jid'
+
+require 'xmpp_simple/version'
+
+module XMPPSimple
+  module_function
+
+  def logger=(value)
+    @logger = value
+  end
+
+  def logger
+    @logger ||= Logger.new($stdout).tap do |log|
+      log.level = Logger::ERROR
+    end
+  end
+end

data/lib/xmpp_simple/client.rb

@@ -0,0 +1,120 @@
+module XMPPSimple
+  class Client
+    include Celluloid::IO
+    finalizer :finalize
+
+    def initialize(params = {})
+      unless [:username, :password, :host, :port].all? { |s| params.key?(s) && params[s] }
+        raise 'username, password, host and port must be set'
+      end
+      @username = Jid.new(params[:username], params[:host])
+      @password = params[:password]
+      @host = params[:host]
+      @port = params[:port]
+      @handler = params[:handler]
+    end
+
+    def connect
+      XMPPSimple.logger.info "Connecting to #{@host}:#{@port}"
+      raw_socket = Celluloid::IO::TCPSocket.new(@host, @port)
+      @socket = Celluloid::IO::SSLSocket.new(raw_socket).connect
+      start
+      async.run
+      self
+    end
+
+    def disconnect
+      write_data close_stream_xml
+    end
+
+    def start
+      @parser = Parser.new(self)
+      write_data open_stream_xml
+    end
+
+    def reconnect
+      finalize
+      connect
+    end
+
+    def process(node)
+      XMPPSimple.logger.debug "Process: #{node}"
+      return unless respond_to?(node.name)
+      return unless %w(features success message iq).include?(node.name)
+      send(node.name, node)
+    end
+
+    def write_data(xml)
+      xml = xml.respond_to?(:to_xml) ? xml.to_xml : xml
+      XMPPSimple.logger.debug "Sending: #{xml}"
+      @socket.write xml
+    end
+
+    def features(node)
+      XMPPSimple.logger.debug "Features: #{node.class}"
+      if node.at('/features/bind:bind', 'bind' => 'urn:ietf:params:xml:ns:xmpp-bind')
+        write_data Bind.create
+      elsif node.at('/features/sasl:mechanisms', 'sasl' => 'urn:ietf:params:xml:ns:xmpp-sasl')
+        authenticate(node)
+      end
+    end
+
+    def authenticate(node)
+      mechanisms = node.xpath('/features/sasl:mechanisms/sasl:mechanism',
+                              'sasl' => 'urn:ietf:params:xml:ns:xmpp-sasl')
+      if mechanisms.any? { |m| m.inner_text == 'PLAIN' }
+        write_data PlainAuth.create(@username, @password)
+      else
+        XMPPSimple.logger.info 'No authentication method provided'
+        disconnect
+      end
+    end
+
+    def success(_node)
+      start
+    end
+
+    def message(node)
+      @handler.message(node.to_xml) if @handler.respond_to? :message
+    end
+
+    def iq(node)
+      XMPPSimple.logger.debug "Iq: #{node.inspect}"
+      return unless node.at('/iq/bind:bind', 'bind' => 'urn:ietf:params:xml:ns:xmpp-bind')
+      XMPPSimple.logger.debug 'Connected!'
+      @handler.connected if @handler.respond_to? :connected
+    end
+
+    def run
+      loop { @parser << @socket.readpartial(4096) }
+    rescue EOFError
+      XMPPSimple.logger.debug 'Socket disconnected'
+      @handler.disconnected if @handler.respond_to? :disconnected
+    rescue => e
+      XMPPSimple.logger.debug "Error: #{e}"
+      @handler.disconnected if @handler.respond_to? :disconnected
+    end
+
+    def finalize
+      return unless defined? @socket
+      return if @socket.nil?
+      disconnect
+      @socket.close
+    end
+
+    def open_stream_xml
+      <<-XML
+<stream:stream
+  xmlns:stream='http://etherx.jabber.org/streams'
+  xmlns='jabber:client'
+  to='#{@host}'
+  xml:lang='en'
+  version='1.0'>
+      XML
+    end
+
+    def close_stream_xml
+      '</stream>'
+    end
+  end
+end

data/lib/xmpp_simple/jid.rb

@@ -0,0 +1,19 @@
+module XMPPSimple
+  class Jid
+    attr_reader :username, :domain
+
+    def initialize(username, host = nil)
+      if username.to_s.include?('@')
+        @username, @domain = username.split('@')
+      else
+        raise 'set either host or username@host' if host.nil?
+        @username = username
+        @domain = host
+      end
+    end
+
+    def to_s
+      "#{@username}@#{@domain}"
+    end
+  end
+end

data/lib/xmpp_simple/node.rb

@@ -0,0 +1,21 @@
+module XMPPSimple
+  class Node < Nokogiri::XML::Node
+    def self.new(name = '', attrs = [], ns = [], doc = Nokogiri::XML::Document.new)
+      return if name.nil? || name.empty?
+      node = super(name, doc)
+      attrs.each { |a| node[a.localname] = a.value }
+      ns.each { |p, u| node.add_namespace(p, u) }
+      node
+    end
+
+    def at(*args)
+      document.root = self
+      document.at(*args)
+    end
+
+    def xpath(*args)
+      document.root = self
+      document.xpath(*args)
+    end
+  end
+end

data/lib/xmpp_simple/parser.rb

@@ -0,0 +1,49 @@
+module XMPPSimple
+  class Parser < Nokogiri::XML::SAX::Document
+    def initialize(client)
+      @parser = Nokogiri::XML::SAX::PushParser.new self
+      @client = client
+      @current = nil
+    end
+
+    def <<(data)
+      @parser << data
+      self
+    rescue Nokogiri::XML::SyntaxError => e
+      @parser = Nokogiri::XML::SAX::PushParser.new self
+      @current = nil
+      XMPPSimple.logger.error e.message
+    end
+
+    def start_element_namespace(name, attrs = [], prefix = nil, uri = nil, ns = [])
+      params = { name: name, attrs: attrs, prefix: prefix, uri: uri, ns: ns }
+      XMPPSimple.logger.debug "Parse start elem: #{params.inspect}"
+      return if name == 'stream'
+      doc = @current.nil? ? Nokogiri::XML::Document.new : @current.document
+      node = Node.new(name, attrs, ns, doc)
+      @current << node if @current
+      @current = node
+    end
+
+    def end_element_namespace(name, prefix = nil, uri = nil)
+      params = { name: name, prefix: prefix, uri: uri }
+      XMPPSimple.logger.debug "Parse end elem: #{params.inspect}"
+      return if name == 'stream'
+      if @current.parent
+        @current = @current.parent
+        return
+      end
+      process(@current)
+    end
+
+    def characters(chars = '')
+      XMPPSimple.logger.debug "Parse chars: #{chars}"
+      @current << Nokogiri::XML::Text.new(chars, @current.document) if @current
+    end
+
+    def process(node)
+      @current = nil
+      @client.process(node)
+    end
+  end
+end

data/lib/xmpp_simple/stanzas/auth_mechanism.rb

@@ -0,0 +1,12 @@
+module XMPPSimple
+  class AuthMechanism < BaseStanza
+    NAME = 'auth'.freeze
+
+    def self.create
+      super()
+      @node.add_namespace(nil, 'urn:ietf:params:xml:ns:xmpp-sasl')
+      @node['mechanism'] = self::MECHANISM
+      @node
+    end
+  end
+end

data/lib/xmpp_simple/stanzas/base_stanza.rb

@@ -0,0 +1,7 @@
+module XMPPSimple
+  class BaseStanza
+    def self.create
+      @node = Node.new(self::NAME)
+    end
+  end
+end

data/lib/xmpp_simple/stanzas/bind.rb

@@ -0,0 +1,10 @@
+module XMPPSimple
+  class Bind < Iq
+    def self.create
+      super()
+      bind = Nokogiri::XML::Node.new('bind', @node.document)
+      bind.add_namespace(nil, 'urn:ietf:params:xml:ns:xmpp-bind')
+      @node << bind
+    end
+  end
+end

data/lib/xmpp_simple/stanzas/iq.rb

@@ -0,0 +1,12 @@
+module XMPPSimple
+  class Iq < BaseStanza
+    NAME = 'iq'.freeze
+
+    def self.create
+      super()
+      @node['id'] = 'bind_1'
+      @node['type'] = 'set'
+      @node
+    end
+  end
+end

data/lib/xmpp_simple/stanzas/message.rb

@@ -0,0 +1,5 @@
+module XMPPSimple
+  class Message < BaseStanza
+    NAME = 'message'.freeze
+  end
+end

data/lib/xmpp_simple/stanzas/plain_auth.rb

@@ -0,0 +1,11 @@
+module XMPPSimple
+  class PlainAuth < AuthMechanism
+    MECHANISM = 'PLAIN'.freeze
+
+    def self.create(jid, password)
+      super()
+      @node.content = ["\x00#{jid}\x00#{password}"].pack('m').tr("\n", '')
+      @node
+    end
+  end
+end

data/lib/xmpp_simple/version.rb

@@ -0,0 +1,3 @@
+module XMPPSimple
+  VERSION = '0.1.0'.freeze
+end

data/xmpp_simple.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xmpp_simple/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'xmpp_simple'
+  spec.version       = XMPPSimple::VERSION
+  spec.authors       = ['l3akage']
+  spec.email         = ['info@l3akage.de']
+
+  spec.homepage      = 'https://github.com/pushwerk/xmpp_simple'
+  spec.summary       = 'Simple XMPP implementation'
+  spec.description   = 'A simle xmpp implementation using celluloid'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(/^bin/) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)/)
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_dependency 'celluloid-io', '~> 0.17.3'
+  spec.add_dependency 'nokogiri', '~> 1.6'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 11.1'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'equivalent-xml', '~> 0.6'
+  spec.add_development_dependency 'guard', '~> 2.13'
+  spec.add_development_dependency 'guard-rspec', '~> 4.6'
+  spec.add_development_dependency 'simplecov', '~> 0.11'
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: xmpp_simple
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- l3akage
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: celluloid-io
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.3
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: equivalent-xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: A simle xmpp implementation using celluloid
+email:
+- info@l3akage.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/xmpp_simple.rb
+- lib/xmpp_simple/client.rb
+- lib/xmpp_simple/jid.rb
+- lib/xmpp_simple/node.rb
+- lib/xmpp_simple/parser.rb
+- lib/xmpp_simple/stanzas/auth_mechanism.rb
+- lib/xmpp_simple/stanzas/base_stanza.rb
+- lib/xmpp_simple/stanzas/bind.rb
+- lib/xmpp_simple/stanzas/iq.rb
+- lib/xmpp_simple/stanzas/message.rb
+- lib/xmpp_simple/stanzas/plain_auth.rb
+- lib/xmpp_simple/version.rb
+- xmpp_simple.gemspec
+homepage: https://github.com/pushwerk/xmpp_simple
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Simple XMPP implementation
+test_files: []