backchat 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.ruby-version
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Zach Pendleton
+
+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,72 @@
+# Backchat
+
+Backchat is a JRuby-only gem that provides the
+[Smack](http://www.igniterealtime.org/projects/smack/) XMPP libraries
+and adds connection-pooling resources to them. It exists because there
+are [no](https://github.com/ln/xmpp4r) [good](https://github.com/blaine/xmpp4r-simple)
+[native](https://github.com/bryanwoods/babylon) XMPP libraries for Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'backchat'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install backchat
+
+## Usage
+
+You'll need to require all of the Smack libraries you need inside your app with
+the standard JRuby syntax:
+
+```ruby
+java_import 'org.jivesoftware.smacmx.muc.MultiUserChat'
+java_import 'org.jivesoftware.smacmx.Form'
+...
+```
+
+But you'll get connection pooling for free. Yay! Inside your app, configure
+Backchat's pool in some kind of initializer:
+
+```ruby
+Backchat::ConnectionPool.configure do
+  host 'jabber.org'
+  username 'admin'
+  password 's3cr3t$@ren0fun'
+  pool_size: 5 # five connections is the default
+end
+
+# configure also accepts a hash
+Backchat::ConnectionPool.configure(host: 'jabber.org', username: 'admin',
+  password: 's3cr3t$@ren0fun', pool_size: 5)
+```
+
+Once Backchat is configured, you can use the connection pool like magic:
+
+```ruby
+# connection_pool takes a block and passes it an XMPPConnection.
+Backchat.connection_pool do |conn|
+  chat = MultiUserChat.new(conn, 'my-room@solonely.localhost')
+  chat.create('me')
+end
+```
+
+The connection pool is created on the first call to `Backchat#connection_pool`,
+provides authenticated connections, and blocks until a connection is available.
+In the future it seems like it'd be nice to have a group of unauthenticated
+connections so the pool could be used with multiple users, but my current use
+case doesn't require it so it's missing in this version.
+
+## 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

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task default: [:test]
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/test_*.rb'
+end

data/backchat.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'backchat/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'backchat'
+  spec.version       = Backchat::VERSION
+  spec.authors       = ['Zach Pendleton']
+  spec.email         = ['zachpendleton@gmail.com']
+  spec.description   = %q{Smack XMPP libraries for JRuby. With connection pooling!!}
+  spec.summary       = %q{Include Smack XMPP libraries in JRuby and use them with connection pooling.}
+  spec.homepage      = 'https://github.com/zachpendleton/backchat'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler',            '~> 1.3'
+  spec.add_development_dependency 'minitest',           '~> 4.6.2'
+  spec.add_development_dependency 'mocha',              '~> 0.13.3'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake',               '>= 0.9.6'
+end

data/lib/backchat.rb

@@ -0,0 +1,10 @@
+require     'java/smack'
+require     'java/smackx'
+java_import 'org.jivesoftware.smack.XMPPConnection'
+java_import 'java.util.concurrent.ArrayBlockingQueue'
+require     'backchat/connection_pool'
+require     'backchat/version'
+
+module Backchat
+  # Your code goes here...
+end

data/lib/backchat/connection_pool.rb

@@ -0,0 +1,90 @@
+module Backchat
+  class ConnectionPool
+    include Enumerable
+
+    DEFAULT_SETTINGS = {
+      host: 'localhost',
+      username: 'admin',
+      password: 'password',
+      pool_size: 5 }
+
+    @settings = DEFAULT_SETTINGS
+
+    def initialize(count = self.class.settings[:pool_size])
+      @queue = fill(ArrayBlockingQueue.new(count))
+    end
+
+    def each(&block)
+      queue.each(&block)
+    end
+
+    def take
+      queue.take
+    end
+
+    def add(connection)
+      queue.add(connection)
+    end
+
+    def with_connection
+      connection = take
+      yield connection
+    ensure
+      add(connection)
+    end
+
+
+    class << self
+      attr_reader :settings
+
+      def configure(settings = {}, &block)
+        if block_given?
+          instance_eval(&block)
+        else
+          @settings.merge!(settings)
+        end
+      end
+
+      def connection(credentials = {})
+        connection = XMPPConnection.new(settings[:host])
+        connection.connect
+        if (credentials.keys & [:username, :password]).count == 2
+          connection.login(*credentials.values_at(:username, :password))
+        end
+
+        yield connection
+      ensure
+        connection.disconnect
+      end
+
+      private
+      [:host, :username, :password, :pool_size].each do |key|
+        define_method("#{key}") do |val|
+          @settings ||= {}
+          @settings[key] = val
+        end
+      end
+    end
+
+    private
+    attr_reader :queue
+
+    def fill(queue)
+      while queue.remaining_capacity > 0
+        conn = XMPPConnection.new(self.class.settings[:host])
+        conn.connect
+        conn.login(self.class.settings[:username],
+                   self.class.settings[:password], conn.connection_id)
+
+        queue.add(conn)
+      end
+
+      queue
+    end
+  end
+
+  def self.connection_pool(&block)
+    @connection_pool = ConnectionPool.new
+    block_given? ? @connection_pool.with_connection(&block) : @connection_pool
+  end
+end

data/lib/backchat/version.rb

@@ -0,0 +1,3 @@
+module Backchat
+  VERSION = '0.0.1'
+end

data/test/lib/backchat/test_connection_pool.rb

@@ -0,0 +1,124 @@
+require File.expand_path('../../test_helper', File.dirname(__FILE__))
+
+class BackchatConnectionPoolTest < MiniTest::Unit::TestCase
+  def setup
+    XMPPConnection.any_instance.stubs(:connect).returns(nil)
+    XMPPConnection.any_instance.stubs(:login).returns(nil)
+
+    @pool = Backchat::ConnectionPool.new(5)
+  end
+
+  def test_configure_saves_settings_passed_in_a_block
+    Backchat::ConnectionPool.configure do
+      host     'example.com'
+      username 'don_draper'
+      password 'secret'
+      pool_size 1
+    end
+
+    assert_equal Backchat::ConnectionPool.settings, { host: 'example.com',
+                                                      username: 'don_draper',
+                                                      password: 'secret',
+                                                      pool_size: 1 }
+  end
+
+  def test_configure_accepts_a_hash
+    Backchat::ConnectionPool.configure(host: 'example.com', username: 'don_draper',
+                                       password: 'secret', pool_size: 1)
+
+    assert_equal Backchat::ConnectionPool.settings, { host: 'example.com',
+                                                      username: 'don_draper',
+                                                      password: 'secret',
+                                                      pool_size: 1 }
+  end
+
+  def test_configure_allows_partial_settings_in_a_block
+    Backchat::ConnectionPool.configure { host 'example.com' }
+
+    assert_equal Backchat::ConnectionPool.settings,
+      Backchat::ConnectionPool::DEFAULT_SETTINGS.merge(host: 'example.com')
+  end
+
+  def test_configure_allows_partial_settings_in_a_hash
+    Backchat::ConnectionPool.configure(host: 'example.com')
+
+    assert_equal Backchat::ConnectionPool.settings,
+      Backchat::ConnectionPool::DEFAULT_SETTINGS.merge(host: 'example.com')
+  end
+
+  def test_initialize_creates_a_queue
+    assert_includes @pool.instance_variables, :@queue
+  end
+
+  def test_queue_is_an_array_blocking_queue
+    assert_instance_of ArrayBlockingQueue, @pool.instance_variable_get(:@queue)
+  end
+
+  def test_initialize_fills_the_pool_with_connections
+    assert_equal 5, @pool.count
+  end
+
+  def test_initialize_fills_the_pool_with_the_number_of_connections_it_is_passed
+    assert_equal 1, Backchat::ConnectionPool.new(1).count
+  end
+
+  def test_initialize_connects_new_connections
+    XMPPConnection.any_instance.expects(:connect)
+    Backchat::ConnectionPool.new(1)
+  end
+
+  def test_initialize_authenticates_new_connections
+    XMPPConnection.any_instance.expects(:login)
+    Backchat::ConnectionPool.new(1)
+  end
+
+  def test_take_removes_a_connection_from_the_queue
+    @pool.take
+    assert_equal 4, @pool.count
+  end
+
+  def test_add_adds_a_connection_to_the_queue
+    conn = @pool.take
+    @pool.add(conn)
+
+    assert_equal 5, @pool.count
+  end
+
+  def test_with_connection_yields_a_block_with_a_connection
+    @pool.with_connection do |conn|
+      assert_instance_of XMPPConnection, conn
+    end
+  end
+
+  def test_with_connection_removes_a_connection_from_the_pool_and_returns_it
+    @pool.with_connection do |conn|
+      assert_equal 4, @pool.count
+    end
+
+    assert_equal 5, @pool.count
+  end
+
+  def test_with_connection_ensures_that_a_connection_is_returned_to_the_pool
+    @pool.with_connection { |conn| raise 'Error' }
+  rescue
+    assert_equal 5, @pool.count
+  end
+
+  def test_connection_yields_with_an_unauthenticated_connection
+    XMPPConnection.any_instance.expects(:login).never
+
+    Backchat::ConnectionPool.connection { |conn| }
+  end
+
+  def test_connection_accepts_credentials
+    XMPPConnection.any_instance.expects(:login)
+
+    Backchat::ConnectionPool.connection(username: 'don_draper',
+                                        password: 'secret') { |conn| }
+  end
+
+  def test_backchat_connection_pool_creates_a_pool
+    refute Backchat.instance_variable_get(:@connection_pool)
+    assert_instance_of Backchat::ConnectionPool, Backchat.connection_pool
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler.require
+
+require 'minitest/autorun'
+require 'mocha/setup'
+require 'pry'
+
+$:.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+
+require 'backchat'

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: backchat
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.0.1
+platform: ruby
+authors:
+- Zach Pendleton
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: minitest
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.2
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.2
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: mocha
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: pry
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+    none: false
+  prerelease: false
+  type: :development
+description: Smack XMPP libraries for JRuby. With connection pooling!!
+email:
+- zachpendleton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- backchat.gemspec
+- lib/backchat.rb
+- lib/backchat/connection_pool.rb
+- lib/backchat/version.rb
+- lib/java/smack.jar
+- lib/java/smackx.jar
+- test/lib/backchat/test_connection_pool.rb
+- test/test_helper.rb
+homepage: https://github.com/zachpendleton/backchat
+licenses:
+- MIT
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: !binary |-
+        MA==
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: !binary |-
+        MA==
+  none: false
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: Include Smack XMPP libraries in JRuby and use them with connection pooling.
+test_files:
+- test/lib/backchat/test_connection_pool.rb
+- test/test_helper.rb