vines-sql 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,53 @@
+# Welcome to Vines
+
+Vines is a scalable XMPP chat server, using EventMachine for asynchronous IO.
+This gem provides support for storing user data in SQL databases with Active
+Record.
+
+Additional documentation can be found at [getvines.org](http://www.getvines.org/).
+
+## Usage
+
+```
+$ gem install vines vines-sql
+$ 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 'sql' do
+  adapter 'postgresql'
+  host 'localhost'
+  port 5432
+  database 'xmpp'
+  username ''
+  password ''
+  pool 5
+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-sql.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/sql.rb

@@ -0,0 +1,220 @@
+require 'active_record'
+
+module Vines
+  class Storage
+    class Sql < Storage
+      register :sql
+
+      class Contact < ActiveRecord::Base
+        belongs_to :user
+      end
+      class Fragment < ActiveRecord::Base
+        belongs_to :user
+      end
+      class Group < ActiveRecord::Base; end
+      class User < ActiveRecord::Base
+        has_many :contacts,  :dependent => :destroy
+        has_many :fragments, :dependent => :delete_all
+      end
+
+      # Wrap the method with ActiveRecord connection pool logic, so we properly
+      # return connections to the pool when we're finished with them. This also
+      # defers the original method by pushing it onto the EM thread pool because
+      # ActiveRecord uses blocking IO.
+      def self.with_connection(method, args={})
+        deferrable = args.key?(:defer) ? args[:defer] : true
+        old = instance_method(method)
+        define_method method do |*args|
+          ActiveRecord::Base.connection_pool.with_connection do
+            old.bind(self).call(*args)
+          end
+        end
+        defer(method) if deferrable
+      end
+
+      %w[adapter host port database username password pool].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)
+        required = [:adapter, :database]
+        required << [:host, :port] unless @config[:adapter] == 'sqlite3'
+        required.flatten.each {|key| raise "Must provide #{key}" unless @config[key] }
+        [:username, :password].each {|key| @config.delete(key) if empty?(@config[key]) }
+        establish_connection
+      end
+
+      def find_user(jid)
+        jid = JID.new(jid).bare.to_s
+        return if jid.empty?
+        xuser = user_by_jid(jid)
+        return Vines::User.new(jid: jid).tap do |user|
+          user.name, user.password = xuser.name, xuser.password
+          xuser.contacts.each do |contact|
+            groups = contact.groups.map {|group| group.name }
+            user.roster << Vines::Contact.new(
+              jid: contact.jid,
+              name: contact.name,
+              subscription: contact.subscription,
+              ask: contact.ask,
+              groups: groups)
+          end
+        end if xuser
+      end
+      with_connection :find_user
+
+      def save_user(user)
+        xuser = user_by_jid(user.jid) || Sql::User.new(jid: user.jid.bare.to_s)
+        xuser.name = user.name
+        xuser.password = user.password
+
+        # remove deleted contacts from roster
+        xuser.contacts.delete(xuser.contacts.select do |contact|
+          !user.contact?(contact.jid)
+        end)
+
+        # update contacts
+        xuser.contacts.each do |contact|
+          fresh = user.contact(contact.jid)
+          contact.update_attributes(
+            name: fresh.name,
+            ask: fresh.ask,
+            subscription: fresh.subscription,
+            groups: groups(fresh))
+        end
+
+        # add new contacts to roster
+        jids = xuser.contacts.map {|c| c.jid }
+        user.roster.select {|contact| !jids.include?(contact.jid.bare.to_s) }
+          .each do |contact|
+            xuser.contacts.build(
+              user: xuser,
+              jid: contact.jid.bare.to_s,
+              name: contact.name,
+              ask: contact.ask,
+              subscription: contact.subscription,
+              groups: groups(contact))
+          end
+        xuser.save
+      end
+      with_connection :save_user
+
+      def find_vcard(jid)
+        jid = JID.new(jid).bare.to_s
+        return if jid.empty?
+        if xuser = user_by_jid(jid)
+          Nokogiri::XML(xuser.vcard).root rescue nil
+        end
+      end
+      with_connection :find_vcard
+
+      def save_vcard(jid, card)
+        xuser = user_by_jid(jid)
+        if xuser
+          xuser.vcard = card.to_xml
+          xuser.save
+        end
+      end
+      with_connection :save_vcard
+
+      def find_fragment(jid, node)
+        jid = JID.new(jid).bare.to_s
+        return if jid.empty?
+        if fragment = fragment_by_jid(jid, node)
+          Nokogiri::XML(fragment.xml).root rescue nil
+        end
+      end
+      with_connection :find_fragment
+
+      def save_fragment(jid, node)
+        jid = JID.new(jid).bare.to_s
+        fragment = fragment_by_jid(jid, node) ||
+          Sql::Fragment.new(
+            user: user_by_jid(jid),
+            root: node.name,
+            namespace: node.namespace.href)
+        fragment.xml = node.to_xml
+        fragment.save
+      end
+      with_connection :save_fragment
+
+      # Create the tables and indexes used by this storage engine.
+      def create_schema(args={})
+        args[:force] ||= false
+
+        ActiveRecord::Schema.define do
+          create_table :users, force: args[:force] do |t|
+            t.string :jid,      limit: 512, null: false
+            t.string :name,     limit: 256, null: true
+            t.string :password, limit: 256, null: true
+            t.text   :vcard,    null: true
+          end
+          add_index :users, :jid, unique: true
+
+          create_table :contacts, force: args[:force] do |t|
+            t.integer :user_id,      null: false
+            t.string  :jid,          limit: 512, null: false
+            t.string  :name,         limit: 256, null: true
+            t.string  :ask,          limit: 128, null: true
+            t.string  :subscription, limit: 128, null: false
+          end
+          add_index :contacts, [:user_id, :jid], unique: true
+
+          create_table :groups, force: args[:force] do |t|
+            t.string :name, limit: 256, null: false
+          end
+          add_index :groups, :name, unique: true
+
+          create_table :contacts_groups, id: false, force: args[:force] do |t|
+            t.integer :contact_id, null: false
+            t.integer :group_id,   null: false
+          end
+          add_index :contacts_groups, [:contact_id, :group_id], unique: true
+
+          create_table :fragments, force: args[:force] do |t|
+            t.integer :user_id,   null: false
+            t.string  :root,      limit: 256, null: false
+            t.string  :namespace, limit: 256, null: false
+            t.text    :xml,       null: false
+          end
+          add_index :fragments, [:user_id, :root, :namespace], unique: true
+        end
+      end
+      with_connection :create_schema, defer: false
+
+      private
+
+      def establish_connection
+        ActiveRecord::Base.logger = Logger.new('/dev/null')
+        ActiveRecord::Base.establish_connection(@config)
+        # has_and_belongs_to_many requires a connection so configure the
+        # associations here rather than in the class definitions above.
+        Sql::Contact.has_and_belongs_to_many :groups
+        Sql::Group.has_and_belongs_to_many :contacts
+      end
+
+      def user_by_jid(jid)
+        jid = JID.new(jid).bare.to_s
+        Sql::User.find_by_jid(jid, :include => {:contacts => :groups})
+      end
+
+      def fragment_by_jid(jid, node)
+        jid = JID.new(jid).bare.to_s
+        clause = 'user_id=(select id from users where jid=?) and root=? and namespace=?'
+        Sql::Fragment.where(clause, jid, node.name, node.namespace.href).first
+      end
+
+      def groups(contact)
+        contact.groups.map {|name| Sql::Group.find_or_create_by_name(name.strip) }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

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

data/spec/storage/sql_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Vines::Storage::Sql do
+  include StorageSpecs
+
+  DB_FILE = "./xmpp_testcase.db"
+  ActiveRecord::Migration.verbose = false
+
+  before do
+    storage.create_schema(force: true)
+    Vines::Storage::Sql::User.new(jid: 'empty@wonderland.lit', name: '', password: '').save
+    Vines::Storage::Sql::User.new(jid: 'no_password@wonderland.lit', name: '', password: '').save
+    Vines::Storage::Sql::User.new(jid: 'clear_password@wonderland.lit', name: '', password: 'secret').save
+    Vines::Storage::Sql::User.new(jid: 'bcrypt_password@wonderland.lit', name: '',
+      password: BCrypt::Password.create('secret')).save
+    groups = %w[Group1 Group2 Group3 Group4].map do |name|
+      Vines::Storage::Sql::Group.find_or_create_by_name(name)
+    end
+    full = Vines::Storage::Sql::User.new(
+      jid: 'full@wonderland.lit',
+      name: 'Tester',
+      password: BCrypt::Password.create('secret'),
+      vcard: vcard.to_xml)
+    full.contacts << Vines::Storage::Sql::Contact.new(
+      jid: 'contact1@wonderland.lit',
+      name: 'Contact1',
+      groups: groups[0, 2],
+      subscription: 'both')
+    full.contacts << Vines::Storage::Sql::Contact.new(
+      jid: 'contact2@wonderland.lit',
+      name: 'Contact2',
+      groups: groups[2, 2],
+      subscription: 'both')
+    full.save
+
+    partial = Vines::Storage::Sql::Fragment.new(
+      user: full,
+      root: 'characters',
+      namespace: 'urn:wonderland',
+      xml: fragment.to_xml)
+    partial.save
+  end
+
+  after do
+    File.delete(DB_FILE) if File.exist?(DB_FILE)
+  end
+
+  def storage
+    Vines::Storage::Sql.new { adapter 'sqlite3'; database DB_FILE }
+  end
+
+  describe 'creating a new instance' do
+    it 'raises with no arguments' do
+      -> { Vines::Storage::Sql.new {} }.must_raise RuntimeError
+    end
+
+    it 'raises with no database' do
+      -> { Vines::Storage::Sql.new { adapter 'postgresql' } }.must_raise RuntimeError
+    end
+
+    it 'does not raise with adapter and database' do
+      obj = Vines::Storage::Sql.new { adapter 'sqlite3'; database ':memory:' }
+      obj.wont_be_nil
+    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-sql.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name         = 'vines-sql'
+  s.version      = '0.1.0'
+  s.summary      = %q[Provides an SQL storage adapter for the Vines XMPP chat server.]
+  s.description  = %q[Stores Vines user data in an SQL database.]
+
+  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-sql.gemspec', 'lib/**/*'] - ['Gemfile.lock']
+  s.test_files   = Dir['spec/**/*']
+  s.require_path = 'lib'
+
+  s.add_dependency 'activerecord', '~> 3.2.13'
+  s.add_dependency 'vines', '>= 0.4.5'
+
+  s.add_development_dependency 'minitest', '~> 4.7.4'
+  s.add_development_dependency 'rake', '~> 10.1.0'
+  s.add_development_dependency 'sqlite3', '~> 1.3.7'
+
+  s.required_ruby_version = '>= 1.9.3'
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: vines-sql
+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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+- !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
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+description: Stores Vines user data in an SQL database.
+email:
+- david@negativecode.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- Rakefile
+- README.md
+- vines-sql.gemspec
+- lib/vines/storage/sql.rb
+- spec/spec_helper.rb
+- spec/storage/sql_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: 320932205411331743
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Provides an SQL storage adapter for the Vines XMPP chat server.
+test_files:
+- spec/spec_helper.rb
+- spec/storage/sql_spec.rb
+- spec/storage_specs.rb