jacha 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+jacha.rb

data/Gemfile

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

data/README.md

@@ -0,0 +1,49 @@
+## What is this?
+
+Jacha is a xmpp4r based bot. Currently, it only handles XMPP connection pool and checks whether given JID is online.
+Also, it can be started as a dedicated service.
+
+## Installation
+
+    gem 'jacha'
+
+## Configuration
+
+Put somewhere in your initializers the following code:
+
+```ruby
+Jacha.configure do |config|
+  config.jid = 'jid@example.com'
+  config.password = 'password'
+  config.size = 3
+  # uncomment to apply charset related xmpp4r monkeypatch
+  # config.fix_charset!
+end
+
+if some_environment_specific_condition
+  Jacha::ConnectionPool.spawn
+end
+```
+
+Then you anytime can get a random connection from the pool and perform some actions.
+
+```ruby
+jacha_connection = Jacha::ConnectionPool.get_connection
+jacha_connection.jabber  # here is wrapped Jabber::Client from xmpp4r
+jacha_connection.online? 'someone@example.com'
+jacha_connection.online? 'another@example.com', optional_timeout_in_seconds
+```
+
+Credits
+-------
+
+<img src="http://roundlake.ru/assets/logo.png" align="right" />
+
+* Alexander Pavlenko ([@alerticus](http://twitter.com/#!/alerticus))
+
+<br/>
+
+LICENSE
+-------
+
+It is free software, and may be redistributed under the terms of MIT license.

data/Rakefile

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

data/config.ru

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift ::File.expand_path(::File.dirname(__FILE__) + '/lib')
+require 'jacha'
+require 'jacha/server'
+
+config = ::File.expand_path(ENV['JACHACONFIG'] || 'jacha.rb')
+if ::File.exists?(config)
+  load config
+end
+
+use Rack::ShowExceptions
+run Jacha::Server.new

data/jacha.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "jacha/version"
+
+Gem::Specification.new do |s|
+  s.name        = "jacha"
+  s.version     = Jacha::VERSION
+  s.authors     = ["AlexanderPavlenko"]
+  s.email       = ["a.pavlenko@roundlake.ru"]
+  s.homepage    = "http://github.com/roundlake/jacha"
+  s.summary     = %q{Simple xmpp4r bot}
+  s.description = %q{xmpp4r bot that can be included to project as well as started as a standalone service}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "xmpp4r"
+end

data/lib/jacha/connection.rb

@@ -0,0 +1,96 @@
+require 'xmpp4r'
+
+module Jacha
+  class Connection
+
+    attr_reader :jabber
+    attr_accessor :pool
+
+    def initialize(jid, password)
+      @password = password
+      @jabber = Jabber::Client.new "#{jid}/#{Time.now.to_f}"
+      @jabber.on_exception do
+        unless broken?
+          broken!
+          logger.warn "#{Time.now}: broken XmppConnection: #{self}"
+          destroy
+          pool.respawn
+        end
+      end
+      connect!
+      @pinger = Thread.new do
+        while true
+          if connected?
+            sleep 180
+            online!
+          else
+            connect!
+          end
+        end
+      end
+    end
+
+    def connect!
+      @jabber.connect
+      @jabber.auth @password
+      online!
+    end
+
+    def online!(&block)
+      packet = Jabber::Presence.new
+      packet.from = @jabber.jid
+      @jabber.send packet, &block
+    end
+
+    def connected?
+      @jabber.is_connected?
+    end
+
+    def online?(jid, timeout=1.5)
+      # Only works if our bot is authorized by the given JID
+      # see Presence with type :subscribe for more details
+      # Also, bot should be online by itself
+      jid = Jabber::JID.new(jid)
+      pinger = Thread.new do
+        pinger[:online] = nil
+        packet = Jabber::Presence.new
+        packet.to = jid
+        packet.from = @jabber.jid
+        packet.type = :probe
+        @jabber.send(packet) do |presence|
+          from = Jabber::JID.new presence.from
+          if from.node == jid.node && from.domain == jid.domain
+            if presence.type.nil?
+              pinger[:online] = true
+              pinger.stop
+            elsif presence.type == :error
+              pinger.stop
+            end
+          end
+        end
+      end
+      pinger.join timeout
+      result = pinger[:online]
+      pinger.kill
+      result
+    end
+
+    def destroy
+      broken!
+      @pinger.kill
+      @jabber.close
+    end
+
+    def broken!
+      @broken = true
+    end
+
+    def broken?
+      @broken
+    end
+
+    def logger
+      pool.logger
+    end
+  end
+end

data/lib/jacha/connection_pool.rb

@@ -0,0 +1,71 @@
+module Jacha
+  class ConnectionPool
+    include Singleton
+
+    attr_accessor :jid, :password, :size, :logger
+
+    def pool
+      @connections ||= []
+    end
+
+    def size
+      @size ||= 3
+    end
+
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
+
+    def get_connection
+      pool.sample
+    end
+
+    def spawn(number=nil)
+      (number || size).times do
+        logger.warn "#{Time.now}: Spawning XmppConnection"
+        spawner = Thread.new do
+          begin
+            connection = Connection.new @jid, @password
+            spawner[:connection] = connection
+          rescue => ex
+            logger.warn "#{Time.now}: Error on XmppConnection spawn: #{ex}"
+          end
+        end
+        spawner.join 7
+        connection = spawner[:connection]
+        spawner.kill
+        if connection && connection.connected?
+          connection.pool = self
+          pool << connection
+          logger.warn "#{Time.now}: XmppConnection spawned: #{connection}"
+        else
+          logger.warn "#{Time.now}: XmppConnection spawn failed. Retrying in 7 seconds."
+          sleep 7
+          spawn 1
+        end
+      end
+    end
+
+    def respawn
+      pool.delete_if &:broken?
+      spawn @size - pool.size
+    end
+
+    def destroy
+      pool.map &:destroy
+      pool.clear
+    end
+
+    def fix_charset!
+      require_relative '../xmpp4r_monkeypatch'
+    end
+
+    def self.method_missing(sym, *args, &block)
+      if instance.respond_to? sym
+        instance.send(sym, *args, &block)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/jacha/server.rb

@@ -0,0 +1,18 @@
+require 'logger'
+require 'sinatra'
+
+module Jacha
+  class Server < Sinatra::Application
+
+    def initialize
+      super
+      ConnectionPool.instance.spawn
+    end
+
+    get '/check' do
+      checker = ConnectionPool.instance.get_connection
+      result = checker.online? params['jid']
+      "#{!!result}"
+    end
+  end
+end

data/lib/jacha/version.rb

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

data/lib/jacha.rb

@@ -0,0 +1,9 @@
+require 'jacha/version'
+require 'jacha/connection'
+require 'jacha/connection_pool'
+
+module Jacha
+  def self.configure
+    yield ConnectionPool.instance if block_given?
+  end
+end

data/lib/xmpp4r_monkeypatch.rb

@@ -0,0 +1,29 @@
+if RUBY_VERSION >= '1.9'
+  # Encoding patch
+  # see https://github.com/ln/xmpp4r/issues/3#issuecomment-1739952
+  require 'socket'
+  class TCPSocket
+    def external_encoding
+      Encoding::BINARY
+    end
+  end
+
+  require 'rexml/source'
+  class REXML::IOSource
+    alias_method :encoding_assign, :encoding=
+    def encoding=(value)
+      encoding_assign(value) if value
+    end
+  end
+
+  begin
+    # OpenSSL is optional and can be missing
+    require 'openssl'
+    class OpenSSL::SSL::SSLSocket
+      def external_encoding
+        Encoding::BINARY
+      end
+    end
+  rescue
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: jacha
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- AlexanderPavlenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xmpp4r
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: xmpp4r bot that can be included to project as well as started as a standalone
+  service
+email:
+- a.pavlenko@roundlake.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- config.ru
+- jacha.gemspec
+- lib/jacha.rb
+- lib/jacha/connection.rb
+- lib/jacha/connection_pool.rb
+- lib/jacha/server.rb
+- lib/jacha/version.rb
+- lib/xmpp4r_monkeypatch.rb
+homepage: http://github.com/roundlake/jacha
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.18
+signing_key: 
+specification_version: 3
+summary: Simple xmpp4r bot
+test_files: []