vines-mongomapper 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NWZiY2MwZWY1NDhkYjAyYzQ2YWVmODY4NWEwZjIxODJhYThmN2NjNg==
+  data.tar.gz: !binary |-
+    YzYxNTk5YmRiZjA3OTA5Zjk3NWU4NjVlYjE0OTc4NmQ3YTI1ODJlNg==
+SHA512:
+  metadata.gz: !binary |-
+    YWRkNDAyOTdjZWVhOTczMTU5N2QxZTcyYjQyYTZjNDU4OWYzM2UwMjBiYzc2
+    OTcxNGU1MmIzZDU2ZTA3MGVkMWE2ZWM2Y2Y4YzA3MTI0NDljN2U2MjgwMzA4
+    ODk3YTE3MmE3NGNkMGMyMDhiMTVmMDg1MjI4ZjhhZWQxZWQ0M2I=
+  data.tar.gz: !binary |-
+    NjA3YTYyOTEwNTVhNGNiNTViODk0NDhiY2I1ODU0ZDgwNDA2N2NkZjY5YThi
+    Y2E5ZDVlZTc1MzNjMmVmOTI3ZWI2NTU2MjI2ZjUwZjFjNmM3ODBlZWE2NjQ3
+    YTUyNzY2ZTM5MDMyMDMyMDRiYjJkYzE0ZTkyNDg1MTdhN2E5MmI=

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p392

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'mongo_mapper'
+group :test  do
+  gem 'database_cleaner'
+  gem 'rspec'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 sawyerzhang
+
+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,71 @@
+
+# Welcome to Vines-Mongompper
+
+Vines is a scalable XMPP chat server, using EventMachine for asynchronous IO.
+
+This gem is inspired by another mongo storage for Vines: [vines-mongodb](https://github.com/negativecode/vines-mongodb.git).
+
+And provides more:
+
+1. Use MongoMapper to model Resources.
+2. Use BOSN ObjectID to id a resource instead of using a JID. This makes integration with frameworks like Rails much easier.
+3. Test with real Mongodb, instead of Mock, this makes it more flexible to develop and extend
+
+
+## Assumptions
+
+This storage has few assumptions:
+
+1. User is identified by his BSON id and user name, keyed by _id and user_name respectively.
+2. User can use _id@domain and user_name@domain as jid to login.
+
+## Usage
+
+```
+$ gem install vines vines-mongomapper
+$ 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 'mongomapper' do
+  host 'localhost', 27017
+  host 'localhost', 27018 # optional, connects to replica set
+  database 'xmpp'
+  tls true
+  username ''
+  password ''
+  pool 5
+end
+```
+
+## Development
+
+```
+$ bundle install
+$ bundle exec rspec spec
+```
+
+## 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
+
+
+## Contact
+
+* Sawyer ZHANG <sawyerzhangdev@gmeil.com>
+
+## License
+
+Vines is released under the MIT license. Check the LICENSE file for details.
+
+

data/Rakefile

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

data/lib/vines/model/user.rb

@@ -0,0 +1,24 @@
+module Vines
+  class User
+
+
+    include MongoMapper::Document
+    set_collection_name "users"
+    key :name, String #display name
+    key :user_name,String # jid node
+    key :password,String
+
+
+
+    attr_accessor :jid,:roster
+
+
+    def initialize(args={})
+      @name = args[:name]
+      @user_name = args[:user_name]
+      @password = args[:password]
+      @roster = args[:roster] || []
+    end
+
+  end
+end

data/lib/vines/mongomapper.rb

@@ -0,0 +1,153 @@
+require_relative 'model/user'
+
+
+module Vines
+  class Storage
+    class Mongomapper < Storage
+      register :mongomapper
+
+      %w[database tls 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, @hosts = {}, []
+        instance_eval(&block)
+        raise "Must provide database" unless @config[:database]
+        raise "Must provide at least one host connection" if @hosts.empty?
+        connect
+      end
+
+      def host(name, port)
+        pair = [name, port]
+        raise "duplicate hosts not allowed: #{name}:#{port}" if @hosts.include?(pair)
+        @hosts << pair
+      end
+
+      def find_user(jid)
+
+
+        jid = JID.new(jid).bare.to_s
+        return if jid.empty?
+
+        #find a usr by it's bson id
+        u = Vines::User.where(:_id=>jid_to_bson_id(jid)).first
+
+        # find a user by it's name
+        user_name = jid.split('@')[0]
+        u = Vines::User.where(:user_name=>user_name).first unless u
+        u.jid = JID.new(jid)if u
+        u.roster=[] if u
+        u
+
+      end
+      #
+      # def save_user(user)
+      #
+      #   jid = user.jid.bare.to_s
+      #   user_name = user.user_name
+      #
+      #   #find a user by name create a new if failed
+      #   u = Vines::User.where(:user_name=>user_name).first
+      #   u = Vines::User.new(jid:user.jid) unless u
+      #
+      #
+      #   u.email = jid
+      #   u.name = user.name
+      #   u.user_name = user_name
+      #   u.password = user.password
+      #
+      #   # doc['roster'] = {}
+      #   # user.roster.each do |contact|
+      #   #   doc['roster'][contact.jid.bare.to_s] = contact.to_h
+      #   # end
+      #   save(u)
+      #
+      #
+      #
+      #
+      #
+      #
+      # end
+
+      def find_vcard(jid)
+
+      end
+
+      def save_vcard(jid, card)
+
+      end
+
+      def find_fragment(jid, node)
+
+      end
+
+      def save_fragment(jid, node)
+
+      end
+
+
+      def get
+
+      end
+
+
+      def save(model)
+        model.save!
+      end
+
+      private
+
+      def fragment_id(jid, node)
+        id = Digest::SHA1.hexdigest("#{node.name}:#{node.namespace.href}")
+        "#{jid}:#{id}"
+      end
+
+
+      defer :get
+
+
+      defer :save
+
+
+
+
+      def jid_to_bson_id(jid)
+        id = jid.split('@')[0]
+        BSON::ObjectId(id) rescue nil
+      end
+
+      def connect
+
+        opts = {
+            pool_timeout: 5,
+            pool_size: @config[:pool] || 5,
+            ssl: @config[:tls]
+        }
+
+
+
+        conn = if @hosts.size == 1
+                 Mongo::Connection.new(@hosts.first[0], @hosts.first[1], opts)
+               else
+                 Mongo::ReplSetConnection.new(*@hosts, opts)
+               end
+
+        # conn.db(@config[:database]).tap do |db|
+        #   user = @config[:username] || ''
+        #   pass = @config[:password] || ''
+        #   db.authenticate(user, pass) unless user.empty? || pass.empty?
+        # end
+        # MongoMapper.connection = conn
+        MongoMapper.database = @config[:database]
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+require 'database_cleaner'
+require 'mongo_mapper'
+require 'vines'
+require_relative '../lib/vines/mongomapper'
+
+# require 'rspec/autorun'
+
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+  config.before :each do
+    DatabaseCleaner.strategy = :truncation
+    DatabaseCleaner.start
+  end
+
+  config.after do
+    DatabaseCleaner.clean
+  end
+end
+
+

data/spec/storage_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+def storage
+  storage = Vines::Storage::Mongomapper.new do
+    host 'localhost', 27017
+    database 'vines_mongo_rails_test'
+  end
+  def storage.db
+    MOCK_MONGO
+  end
+  storage
+end
+
+def fibered
+  EM.run do
+    Fiber.new do
+      yield
+      EM.stop
+    end.resume
+  end
+end
+
+describe 'User' do
+
+
+  it 'should save a user' do
+
+    fibered do
+      db = storage
+      user = Vines::User.new(
+          jid: 'saved_user@domain.tld/resource1',
+          name: 'Save User',
+          user_name:'saved_user',
+          password: 'secret')
+      user.roster << Vines::Contact.new(
+          jid: 'contact1@domain.tld/resource2',
+          name: 'Contact 1')
+
+      user.save!
+      user = db.find_user('saved_user@domain.tld')
+      expect(user.jid.to_s).to eq 'saved_user@domain.tld'
+      expect(user.name).to eq('Save User')
+      expect(user.user_name).to eq('saved_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
+
+
+  it 'should auth a user' do
+
+    fibered do
+      db = storage
+      Vines::User.create({jid: 'empty@wonderland.lit',user_name:'empty'})
+      Vines::User.create({jid: 'no_password@wonderland.lit',user_name:'no_password', 'foo' => 'bar'})
+      Vines::User.create({jid: 'clear_password@wonderland.lit',user_name:'clear_password', password:'secret'})
+      Vines::User.create({jid: 'bcrypt_password@wonderland.lit',user_name:'bcrypt_password',name:'a good user', password: BCrypt::Password.create('secret')})
+
+      expect(db.authenticate(nil, nil)).to be_nil
+      expect(db.authenticate(nil,'secret' )).to be_nil
+      expect(db.authenticate('bogus', nil)).to be_nil
+      expect(db.authenticate('bogus', 'secret')).to be_nil
+      expect(db.authenticate('empty@wonderland.lit', 'secret')).to be_nil
+      expect(db.authenticate('no_password@wonderland.lit', 'secret')).to be_nil
+      expect(db.authenticate('clear_password@wonderland.lit', 'secret')).to be_nil
+
+      user = db.authenticate('bcrypt_password@wonderland.lit', 'secret')
+      expect(user.name).to eq('a good user')
+      expect(user.jid.to_s).to eq 'bcrypt_password@wonderland.lit'
+
+    end
+  end
+end

data/vines-mongomapper.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "vines-mongomapper"
+  spec.version       = "0.1.0"
+  spec.authors       = ["sawyerzhang"]
+  spec.email         = ["sawyerzhangdev@gmail.com"]
+  spec.summary      = %q[Provides a MongoMapper storage adapter for the Vines XMPP chat server.]
+  spec.description  = %q[Stores Vines user data in MongoMapper.]
+
+  spec.homepage      = ""
+  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_dependency 'mongo_mapper'
+  spec.add_dependency 'bson_ext'
+  spec.add_dependency 'vines', '>= 0.4.5'
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.required_ruby_version = '>= 1.9.3'
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: vines-mongomapper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sawyerzhang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongo_mapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vines
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Stores Vines user data in MongoMapper.
+email:
+- sawyerzhangdev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vines/model/user.rb
+- lib/vines/mongomapper.rb
+- spec/spec_helper.rb
+- spec/storage_spec.rb
+- vines-mongomapper.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Provides a MongoMapper storage adapter for the Vines XMPP chat server.
+test_files:
+- spec/spec_helper.rb
+- spec/storage_spec.rb