mongo_sync 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02b246444c20f0a2d3b86ebba7c368f96811e58f
-  data.tar.gz: a9ab33f1c9e0a2c3db648abf4555f321e1434860
+  metadata.gz: e8465776703c0c1d48a595cb27c8e5bce56fb0c7
+  data.tar.gz: edf1461081606f6a6573fbdaef2a883ee34804c3
 SHA512:
-  metadata.gz: 9e17dc26dbfb7343cbbdc7a9cc5dceea1633afd2eab7aacdd6047e0733fae63384f822489e422dc15989a340ed12c2783ab08e5b490a2f3a48f8671b8a0e5166
-  data.tar.gz: 53da72230fb5985f6967169a1a630de0c8a10ecc4f329af4d4281b8ede384e57a901abb4b7a07cd8e6b601ac21f7cee3279bee39d816f89080757b9530ef1519
+  metadata.gz: 8e1338e1f0cf1b6bb3c15dbf536a40762819970537947eb152f3507f58abde773e4870141d54f67200a3ff627f5c975ae25c70b92a1f187e067b081028ee59fc
+  data.tar.gz: f25459fd62dc93b501fcfe178585e5c2ad12d13f551d81c727d2513f7d690c8397964ca42ae3c1be5a691d3a58af21f0d24ebb96c588b23645857e5f5f1a6fab

data/README.md

@@ -1,30 +1,148 @@
-mongo_sync
-==========
+MongoSync
+=========
+
+> Sync Remote and Local MongoDB Databases in Ruby! Works with MongoHQ/Compose, MongoLab and other Heroku-hosted MongoDBs too!
+
+Based on my [mongo-sync](https://github.com/sheharyarn/mongo-sync) shell script.
 
-> Sync Remote and Local MongoDB Databases in Ruby!
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
+```ruby
+group :development do
     gem 'mongo_sync'
+end
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install mongo_sync
+```bash
+$ gem install mongo_sync
+```
+
 
 ## Usage
 
-TODO: Write usage instructions here
+### Rails
+
+In Rails, run this generator to set up a `mongo_sync.yml` configuration template:
+
+```bash
+rails g mongo_sync:config
+```
+
+Now edit the newly created `config/mongo_sync.yml`, putting in details of your remote and local DBs:
+
+```yaml
+local:
+  db: 'local_db_name'
+
+remote:
+  db: 'remote_db_name'
+  host:
+    url: 'some.remoteurl.com'
+    port: 27017
+  access:
+    username: 'remote_mongo_user'
+    password: 'remote_mongo_pass'
+
+# For Heroku MongoDB URLs, here's the legend:
+# mongodb://username:password@hosturl.com:port/db_name
+
+# All fields are required
+```
+
+Now, to start syncing, use these rake tasks:
+
+```sh
+rake mongo_sync:push       # Push DB to Remote
+rake mongo_sync:pull       # Pull DB to Local
+```
+
+### Non-Rails
+
+1. Create a `mongo_sync.yml` in your project.
+2. In your project, add this:
+
+    ```ruby
+    require 'rake'
+    require 'mongo_sync'
+    load 'tasks/mongo_sync.rake'
+    ```
+
+3. Pass the path of your config file in the tasks:
+
+    ```sh
+    rake mongo_sync:push['path/to/mongo_sync.yml']
+    ```
+
+### Console / Command-line
+
+```ruby
+require 'mongo_sync'
+
+# Looks for config/mongo_sync.yml - Rails only
+MongoSync.pull
+
+# You can pass path of your config file as well
+MongoSync.push "path/to/mongo_sync.yml"
+```
+
+
+## Notes 
+
+ - Pushing/Pulling overwrites the Target DB
+ - It's a good idea to keep your `mongo_sync.yml` in `.gitignore` or load the values from the `ENV`
+
+
+## TODO
+
+ - Add more options and ways to enter DB details in `mongo_sync.yml`
+ - Add a `backup` command/task and an `auto-backup` feature
+ - Write Tests
+ - Add a `no-overwrite` feature, so that it doesn't drop the target DB before restoring it, and _actually_ tries to sync it
+
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/mongo_sync/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
+1. [Fork it](https://github.com/sheharyarn/mongo-sync-ruby/fork)
+2. Create your feature/fix branch (`git checkout -b feature/my-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
+4. Push to the branch (`git push origin feature/my-feature`)
+5. Create a new Pull Request
+
+
+## License
+
+Copyright (c) 2015 Sheharyar Naseer
+
+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/lib/mongo_sync/version.rb

@@ -1,3 +1,3 @@
 module MongoSync
-	VERSION = "0.1.1"
+	VERSION = "0.1.2"
 end

data/lib/tasks/mongo_sync.rake

@@ -1,4 +1,4 @@
-namespace :mongosync do
+namespace :mongo_sync do
 
     desc "Push DB to Remote from Local"
     task :push, [:config] => :environment do |t, args|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongo_sync
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Sheharyar Naseer