Skip to content
This repository has been archived by the owner on May 25, 2021. It is now read-only.

vessi/mruby-mongo

Repository files navigation

Mongo driver for mRuby

Join the chat at https://gitter.im/vessi/mruby-mongo

Usage

If you want to use mruby-mongo, just add

conf.gem :git => 'https://github.com/vessi/mruby-mongo.git'

to your build_config.rb file and do make to build or make test to do tests.

Reference

You can take a look at API reference here.

Dependencies

To build this gem you should have mongo-c-driver installed at least with version 1.0.

This gem tests has next requirements:

  • local mongo server, up and running on localhost:27017

Tests

To launch test you just need to have Ruby installed and launch

$> rake

Default rake task will fetch mruby and launch tests

Contribution

If you want to contribute, please follow next instructions:

  1. Fork project
  2. Do your changes
  3. Write tests for them
  4. Do a pull-request

Any help would be greatly appreciated. I am not a C developer, I am much more familiar to Ruby, so code has bad style. Feel free to contribute.

License

The MIT License (MIT)

Copyright (c) 2015 Mikhail Bortnyk([email protected])

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.