vines-couchdb 0.1.0

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010-2013 Negative Code
+
+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,52 @@
+# Welcome to Vines
+
+Vines is a scalable XMPP chat server, using EventMachine for asynchronous IO.
+This gem provides support for storing user data in
+[Apache CouchDB](https://couchdb.apache.org/).
+
+Additional documentation can be found at [getvines.org](http://www.getvines.org/).
+
+## Usage
+
+```
+$ gem install vines vines-couchdb
+$ vines init wonderland.lit
+$ cd wonderland.lit && vines start
+```
+
+## Configuration
+
+Add the following configuration block to a virtual host definition in
+the server's `conf/config.rb` file.
+
+```ruby
+storage 'couchdb' do
+  host 'localhost'
+  port 6984
+  database 'xmpp'
+  tls true
+  username ''
+  password ''
+end
+```
+
+## Dependencies
+
+Vines requires Ruby 1.9.3 or better. Instructions for installing the
+needed OS packages, as well as Ruby itself, are available at
+[getvines.org/ruby](http://www.getvines.org/ruby).
+
+## Development
+
+```
+$ script/bootstrap
+$ script/tests
+```
+
+## Contact
+
+* David Graham <david@negativecode.com>
+
+## License
+
+Vines is released under the MIT license. Check the LICENSE file for details.

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+
+CLOBBER.include('pkg')
+
+directory 'pkg'
+
+desc 'Build distributable packages'
+task :build => [:pkg] do
+  system 'gem build vines-couchdb.gemspec && mv vines-*.gem pkg/'
+end
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'spec'
+  test.pattern = 'spec/**/*_spec.rb'
+  test.warning = false
+end
+
+task :default => [:clobber, :test, :build]

data/lib/vines/storage/couchdb.rb

@@ -0,0 +1,131 @@
+require 'digest/sha1'
+require 'em-http'
+require 'uri'
+
+module Vines
+  class Storage
+    class CouchDB < Storage
+      register :couchdb
+
+      %w[host port database tls username password].each do |name|
+        define_method(name) do |*args|
+          if args.first
+            @config[name.to_sym] = args.first
+          else
+            @config[name.to_sym]
+          end
+        end
+      end
+
+      def initialize(&block)
+        @config = {}
+        instance_eval(&block)
+        [:host, :port, :database].each {|key| raise "Must provide #{key}" unless @config[key] }
+        @url = url(@config)
+      end
+
+      def find_user(jid)
+        jid = JID.new(jid).bare.to_s
+        return if jid.empty?
+        doc = get("user:#{jid}")
+        return unless doc && doc['type'] == 'User'
+        User.new(jid: jid).tap do |user|
+          user.name, user.password = doc.values_at('name', 'password')
+          (doc['roster'] || {}).each_pair do |jid, props|
+            user.roster << Contact.new(
+              jid: jid,
+              name: props['name'],
+              subscription: props['subscription'],
+              ask: props['ask'],
+              groups: props['groups'] || [])
+          end
+        end
+      end
+
+      def save_user(user)
+        id = "user:#{user.jid.bare}"
+        doc = get(id) || {'_id' => id}
+        doc['type'] = 'User'
+        doc['name'] = user.name
+        doc['password'] = user.password
+        doc['roster'] = {}
+        user.roster.each do |contact|
+          doc['roster'][contact.jid.bare.to_s] = contact.to_h
+        end
+        save_doc(doc)
+      end
+
+      def find_vcard(jid)
+        jid = JID.new(jid).bare.to_s
+        return if jid.empty?
+        doc = get("vcard:#{jid}")
+        return unless doc && doc['type'] == 'Vcard'
+        Nokogiri::XML(doc['card']).root rescue nil
+      end
+
+      def save_vcard(jid, card)
+        jid = JID.new(jid).bare.to_s
+        id = "vcard:#{jid}"
+        doc = get(id) || {'_id' => id}
+        doc['type'] = 'Vcard'
+        doc['card'] = card.to_xml
+        save_doc(doc)
+      end
+
+      def find_fragment(jid, node)
+        jid = JID.new(jid).bare.to_s
+        return if jid.empty?
+        doc = get(fragment_id(jid, node))
+        return unless doc && doc['type'] == 'Fragment'
+        Nokogiri::XML(doc['xml']).root rescue nil
+      end
+
+      def save_fragment(jid, node)
+        jid = JID.new(jid).bare.to_s
+        id = fragment_id(jid, node)
+        doc = get(id) || {'_id' => id}
+        doc['type'] = 'Fragment'
+        doc['xml'] = node.to_xml
+        save_doc(doc)
+      end
+
+      private
+
+      def fragment_id(jid, node)
+        id = Digest::SHA1.hexdigest("#{node.name}:#{node.namespace.href}")
+        "fragment:#{jid}:#{id}"
+      end
+
+      def url(config)
+        scheme = config[:tls] ? 'https' : 'http'
+        user, password = config.values_at(:username, :password)
+        credentials = empty?(user, password) ? '' : "%s:%s@" % [user, password]
+        "%s://%s%s:%s/%s" % [scheme, credentials, *config.values_at(:host, :port, :database)]
+      end
+
+      def get(jid)
+        http = EM::HttpRequest.new("#{@url}/#{escape(jid)}").get
+        http.errback { yield }
+        http.callback do
+          doc = if http.response_header.status == 200
+            JSON.parse(http.response) rescue nil
+          end
+          yield doc
+        end
+      end
+      fiber :get
+
+      def save_doc(doc)
+        head = {'Content-Type' => 'application/json'}
+        http = EM::HttpRequest.new(@url).post(head: head, body: doc.to_json)
+        http.callback { yield }
+        http.errback  { yield }
+      end
+      fiber :save_doc
+
+      def escape(jid)
+        URI.escape(jid, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'vines'
+require 'storage_specs'
+require 'minitest/autorun'

data/spec/storage/couchdb_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+describe Vines::Storage::CouchDB do
+  include StorageSpecs
+
+  URL = 'http://localhost:5984/xmpp_testcase'.freeze
+
+  before do
+    fibered do
+      database(:put)
+      save_doc({'_id' => 'user:empty@wonderland.lit'})
+
+      save_doc({
+        '_id'  => 'user:no_password@wonderland.lit',
+        'type' => 'User',
+        'foo'  => 'bar'})
+
+      save_doc({
+        '_id'      => 'user:clear_password@wonderland.lit',
+        'type'     => 'User',
+        'password' => 'secret'})
+
+      save_doc({
+        '_id'      => 'user:bcrypt_password@wonderland.lit',
+        'type'     => 'User',
+        'password' => BCrypt::Password.create('secret')})
+
+      save_doc({
+        '_id'      => 'user:full@wonderland.lit',
+        'type'     => 'User',
+        'password' => BCrypt::Password.create('secret'),
+        'name'     => 'Tester',
+        'roster'   => {
+          'contact1@wonderland.lit' => {
+            'name'   => 'Contact1',
+            'groups' => %w[Group1 Group2]
+          },
+          'contact2@wonderland.lit' => {
+            'name'   => 'Contact2',
+            'groups' => %w[Group3 Group4]
+          }
+        }
+      })
+
+      save_doc({
+        '_id'  => 'vcard:full@wonderland.lit',
+        'type' => 'Vcard',
+        'card' => vcard.to_xml
+      })
+
+      save_doc({
+        '_id'  => "fragment:full@wonderland.lit:#{fragment_id}",
+        'type' => 'Fragment',
+        'xml'  => fragment.to_xml
+      })
+    end
+  end
+
+  after do
+    fibered do
+      database(:delete)
+    end
+  end
+
+  def save_doc(doc)
+    fiber = Fiber.current
+    http = EM::HttpRequest.new(URL).post(
+      head: {'Content-Type' => 'application/json'},
+      body: doc.to_json)
+    http.callback { fiber.resume }
+    http.errback { raise 'save_doc failed' }
+    Fiber.yield
+  end
+
+  def database(method=:put)
+    fiber = Fiber.current
+    http = EM::HttpRequest.new(URL).send(method)
+    http.callback { fiber.resume }
+    http.errback { raise "#{method} database failed" }
+    Fiber.yield
+  end
+
+  def storage
+    Vines::Storage::CouchDB.new do
+      host 'localhost'
+      port 5984
+      database 'xmpp_testcase'
+    end
+  end
+
+  describe 'creating a new instance' do
+    it 'raises with no host' do
+      fibered do
+        -> { Vines::Storage::CouchDB.new {} }.must_raise RuntimeError
+      end
+    end
+
+    it 'raises with no port' do
+      fibered do
+        -> { Vines::Storage::CouchDB.new { host 'localhost' } }.must_raise RuntimeError
+      end
+    end
+
+    it 'does not raise when given all args' do
+      fibered do
+        obj =
+          Vines::Storage::CouchDB.new do
+            host 'localhost'
+            port '5984'
+            database 'test'
+          end
+        obj.wont_be_nil
+      end
+    end
+  end
+end

data/spec/storage_specs.rb

@@ -0,0 +1,182 @@
+# Mixin methods for storage implementation test classes. The behavioral
+# tests are the same regardless of implementation so share those methods
+# here.
+module StorageSpecs
+  def fragment_id
+    Digest::SHA1.hexdigest("characters:urn:wonderland")
+  end
+
+  def fragment
+    Nokogiri::XML(%q{
+      <characters xmlns="urn:wonderland">
+        <character>Alice</character>
+      </characters>
+    }.strip).root
+  end
+
+  def vcard
+    Nokogiri::XML(%q{
+      <vCard xmlns="vcard-temp">
+        <FN>Alice in Wonderland</FN>
+      </vCard>
+    }.strip).root
+  end
+
+  def fibered
+    EM.run do
+      Fiber.new do
+        yield
+        EM.stop
+      end.resume
+    end
+  end
+
+  def test_authenticate
+    fibered do
+      db = storage
+      db.authenticate(nil, nil).must_be_nil
+      db.authenticate(nil, 'secret').must_be_nil
+      db.authenticate('bogus', nil).must_be_nil
+      db.authenticate('bogus', 'secret').must_be_nil
+      db.authenticate('empty@wonderland.lit', 'secret').must_be_nil
+      db.authenticate('no_password@wonderland.lit', 'secret').must_be_nil
+      db.authenticate('clear_password@wonderland.lit', 'secret').must_be_nil
+
+      user = db.authenticate('bcrypt_password@wonderland.lit', 'secret')
+      user.wont_be_nil
+      user.jid.to_s.must_equal 'bcrypt_password@wonderland.lit'
+
+      user = db.authenticate('full@wonderland.lit', 'secret')
+      user.wont_be_nil
+      user.name.must_equal 'Tester'
+      user.jid.to_s.must_equal 'full@wonderland.lit'
+
+      user.roster.length.must_equal 2
+      user.roster[0].jid.to_s.must_equal 'contact1@wonderland.lit'
+      user.roster[0].name.must_equal 'Contact1'
+      user.roster[0].groups.length.must_equal 2
+      user.roster[0].groups[0].must_equal 'Group1'
+      user.roster[0].groups[1].must_equal 'Group2'
+
+      user.roster[1].jid.to_s.must_equal 'contact2@wonderland.lit'
+      user.roster[1].name.must_equal 'Contact2'
+      user.roster[1].groups.length.must_equal 2
+      user.roster[1].groups[0].must_equal 'Group3'
+      user.roster[1].groups[1].must_equal 'Group4'
+    end
+  end
+
+  def test_find_user
+    fibered do
+      db = storage
+      user = db.find_user(nil)
+      user.must_be_nil
+
+      user = db.find_user('full@wonderland.lit')
+      user.wont_be_nil
+      user.jid.to_s.must_equal 'full@wonderland.lit'
+
+      user = db.find_user(Vines::JID.new('full@wonderland.lit'))
+      user.wont_be_nil
+      user.jid.to_s.must_equal 'full@wonderland.lit'
+
+      user = db.find_user(Vines::JID.new('full@wonderland.lit/resource'))
+      user.wont_be_nil
+      user.jid.to_s.must_equal 'full@wonderland.lit'
+    end
+  end
+
+  def test_save_user
+    fibered do
+      db = storage
+      user = Vines::User.new(
+        jid: 'save_user@domain.tld/resource1',
+        name: 'Save User',
+        password: 'secret')
+      user.roster << Vines::Contact.new(
+        jid: 'contact1@domain.tld/resource2',
+        name: 'Contact 1')
+      db.save_user(user)
+      user = db.find_user('save_user@domain.tld')
+      user.wont_be_nil
+      user.jid.to_s.must_equal 'save_user@domain.tld'
+      user.name.must_equal 'Save User'
+      user.roster.length.must_equal 1
+      user.roster[0].jid.to_s.must_equal 'contact1@domain.tld'
+      user.roster[0].name.must_equal 'Contact 1'
+    end
+  end
+
+  def test_find_vcard
+    fibered do
+      db = storage
+      card = db.find_vcard(nil)
+      card.must_be_nil
+
+      card = db.find_vcard('full@wonderland.lit')
+      card.wont_be_nil
+      card.to_s.must_equal vcard.to_s
+
+      card = db.find_vcard(Vines::JID.new('full@wonderland.lit'))
+      card.wont_be_nil
+      card.to_s.must_equal vcard.to_s
+
+      card = db.find_vcard(Vines::JID.new('full@wonderland.lit/resource'))
+      card.wont_be_nil
+      card.to_s.must_equal vcard.to_s
+    end
+  end
+
+  def test_save_vcard
+    fibered do
+      db = storage
+      db.save_user(Vines::User.new(jid: 'save_user@domain.tld'))
+      db.save_vcard('save_user@domain.tld/resource1', vcard)
+      card = db.find_vcard('save_user@domain.tld')
+      card.wont_be_nil
+      card.to_s.must_equal vcard.to_s
+    end
+  end
+
+  def test_find_fragment
+    fibered do
+      db = storage
+      root = Nokogiri::XML(%q{<characters xmlns="urn:wonderland"/>}).root
+      bad_name = Nokogiri::XML(%q{<not_characters xmlns="urn:wonderland"/>}).root
+      bad_ns = Nokogiri::XML(%q{<characters xmlns="not:wonderland"/>}).root
+
+      node = db.find_fragment(nil, nil)
+      node.must_be_nil
+
+      node = db.find_fragment('full@wonderland.lit', bad_name)
+      node.must_be_nil
+
+      node = db.find_fragment('full@wonderland.lit', bad_ns)
+      node.must_be_nil
+
+      node = db.find_fragment('full@wonderland.lit', root)
+      node.wont_be_nil
+      node.to_s.must_equal fragment.to_s
+
+      node = db.find_fragment(Vines::JID.new('full@wonderland.lit'), root)
+      node.wont_be_nil
+      node.to_s.must_equal fragment.to_s
+
+      node = db.find_fragment(Vines::JID.new('full@wonderland.lit/resource'), root)
+      node.wont_be_nil
+      node.to_s.must_equal fragment.to_s
+    end
+  end
+
+  def test_save_fragment
+    fibered do
+      db = storage
+      root = Nokogiri::XML(%q{<characters xmlns="urn:wonderland"/>}).root
+      db.save_user(Vines::User.new(jid: 'save_user@domain.tld'))
+      db.save_fragment('save_user@domain.tld/resource1', fragment)
+      node = db.find_fragment('save_user@domain.tld', root)
+      node.wont_be_nil
+      node.to_s.must_equal fragment.to_s
+    end
+  end
+end

data/vines-couchdb.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name         = 'vines-couchdb'
+  s.version      = '0.1.0'
+  s.summary      = %q[Provides an Apache CouchDB storage adapter for the Vines XMPP chat server.]
+  s.description  = %q[Stores Vines user data in Apache CouchDB.]
+
+  s.authors      = ['David Graham']
+  s.email        = %w[david@negativecode.com]
+  s.homepage     = 'http://www.getvines.org'
+  s.license      = 'MIT'
+
+  s.files        = Dir['[A-Z]*', 'vines-couchdb.gemspec', 'lib/**/*'] - ['Gemfile.lock']
+  s.test_files   = Dir['spec/**/*']
+  s.require_path = 'lib'
+
+  s.add_dependency 'em-http-request', '~> 1.0.3'
+  s.add_dependency 'vines', '>= 0.4.5'
+
+  s.add_development_dependency 'minitest', '~> 4.7.4'
+  s.add_development_dependency 'rake', '~> 10.1.0'
+
+  s.required_ruby_version = '>= 1.9.3'
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: vines-couchdb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- David Graham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: vines
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.7.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.7.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+description: Stores Vines user data in Apache CouchDB.
+email:
+- david@negativecode.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- Rakefile
+- README.md
+- vines-couchdb.gemspec
+- lib/vines/storage/couchdb.rb
+- spec/spec_helper.rb
+- spec/storage/couchdb_spec.rb
+- spec/storage_specs.rb
+homepage: http://www.getvines.org
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2430317977277905770
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Provides an Apache CouchDB storage adapter for the Vines XMPP chat server.
+test_files:
+- spec/spec_helper.rb
+- spec/storage/couchdb_spec.rb
+- spec/storage_specs.rb