mongo-db-utils 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4b606d4315fee51104eb916d246ddb99f72f1e7
-  data.tar.gz: 1fa85aef6b8ba85fc9003816104a5fa148f58cfa
+  metadata.gz: 0ebe472c1c71790c06618838dac17a6da13db206
+  data.tar.gz: e8a5fa1960f3a5c988818fdab24657f167adeaf6
 SHA512:
-  metadata.gz: c3b8e02d0069b541d7c65da085dc6df197e4adf96206ec9f54b47e79ae013a115802a5e35b062295eda0a5ed2737d28243f1494853cd34d4cea3a18737ad0f61
-  data.tar.gz: 64fdf69be96e95b613d8daff5ecd81c243d4db1efe10f3f4e03cf862d2b205802df8c75ceefd9ea79ab99bb381106acdffbee5df7f16f4a6eff60e7b64f0712a
+  metadata.gz: 825c9dd5b70b4729afaea862888d5cd308c36ed9edf004dd60aa5e66e4b8f31d17fc3b1cffcfe2dc4761151dd60aa770208c104c0cd53996fea9c25d24338dd5
+  data.tar.gz: ac3a00ea228736521b54495d38ad0bae15b1bda24993cf93bc94c08d8fc44e8ae0c7d9d65030e77d44de3f08095a88598df0d9766deabceb2851e9cc1e016878

data/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://travis-ci.org/edeustace/mongo-db-utils.png)](https://travis-ci.org/edeustace/mongo-db-utils)
 
 
-### !Current version 0.0.9.3 is in Beta - for a safer version use 0.0.9
+### !Current version 0.1.1 is in Beta - for a safer version use 0.0.9
 
 A little gem that simplifies backing up and copying your mongo dbs.
 
@@ -55,6 +55,12 @@ When it does backups it stores them in ````~/.mongo-db-utils/backups/````. The n
 
 
 ## Release Notes
+* 0.1.2 - BETA
+  - Added 'host' and 'port' getters to Db AND 'hosts' getter to ReplicaSetDb
+
+* 0.1.1 - BETA
+  - Tidy up Tools - add Import and Restore to tool set
+
 * 0.1.0 - BETA
   - Fixed CLI backup and backup_s3 not using the config-loader correctly.
 

data/lib/mongo-db-utils/cmd.rb

@@ -4,6 +4,8 @@ require 'mongo'
 module MongoDbUtils
   class Cmd
 
+    include MongoDbUtils::Tools
+
     def self.backup(db, folder, final_path = nil, tar_it = true)
       puts ">> Backing up: #{db}, #{folder}, #{final_path}"
       unless( db_exists?(db) )
@@ -21,12 +23,12 @@ module MongoDbUtils
       puts ">> final backup path: #{full_path}"
 
       FileUtils.mkdir_p(full_path)
-      MongoDbUtils::Tools::Dump.run(
+      Dump.new(
         db.to_host_s,
         db.name,
         full_path,
         db.username,
-        db.password)
+        db.password).run
 
       if( tar_it )
         Dir.chdir(full_path)
@@ -66,12 +68,12 @@ module MongoDbUtils
         password = ""
       end
 
-      MongoDbUtils::Tools::Restore.run(
+      Restore.new(
         destination.to_host_s,
         destination.name,
         "#{tmp_dump_path}",
         username,
-        password)
+        password).run
 
       `rm -fr #{tmp_path}`
     end

data/lib/mongo-db-utils/models/db.rb

@@ -1,6 +1,23 @@
 module MongoDbUtils
   module Model
 
+
+    # This method accepts 2 possible uri formats
+    # 1. the conventional mongo_uri format: mongodb://xxxxxxxx
+    # 2. the non standard way of representing a replicaset uri:
+    # --> replica_set|mongo_uri
+    # --> Eg: my-set|mongodb://xxxxxxx
+    # This is useful because many mongo commands require the set name
+    # when invoking them and this bundles the 2 things together
+    def self.db_from_uri(uri)
+      if(uri.include? "|")
+        split = uri.split("|")
+        ReplicaSetDb.new(split[1], split[0])
+      else
+        Db.new(uri)
+      end
+    end
+
     # A Db stored in the config
     class Db
 
@@ -33,6 +50,14 @@ module MongoDbUtils
         has?(self.username) && has?(self.password)
       end
 
+      def host
+        host_and_port[:host]
+      end
+
+      def port
+        host_and_port[:port]
+      end
+
       # Return the host string in a format that is compatable with mongo binary tools
       # See: http://docs.mongodb.org/manual/reference/program/mongodump/#cmdoption-mongodump--host
       def to_host_s
@@ -55,6 +80,12 @@ module MongoDbUtils
       def has?(s)
         !s.nil? && !s.empty?
       end
+
+
+      def host_and_port
+        match, host,port = *@host_port.match(/(.*):(.*)/)
+        { :host => host, :port => port }
+      end
     end
 
 
@@ -66,6 +97,22 @@ module MongoDbUtils
         @set_name = name
       end
 
+
+      # Return an array of host:port strings
+      def hosts
+        @host_port.split(",")
+      end
+
+      # Block usage of this method from the super
+      def host
+        raise "'host' is not a valid method for a ReplicaSetDb - use 'hosts' instead."
+      end
+
+      # Block usage of this method from the super
+      def port
+        raise "'port' is not a valid method for a ReplicaSetDb - use 'hosts' instead."
+      end
+
       # Note: we override this to provide a replica set format
       def to_host_s
         "#{@set_name}/#{@host_port}"

data/lib/mongo-db-utils/tools/commands.rb

@@ -13,13 +13,30 @@ module MongoDbUtils
     end
 
     class BaseCmd
+
+      def initialize(cmd_name, host_and_port, db, username = "", password = "")
+        @options = build_base_options(host_and_port, db, username, password)
+        @cmd_name = cmd_name
+      end
+
+      def run
+        puts "[#{self.class}] run: #{cmd}"
+        output = `#{cmd}`
+        raise ToolsException.new("#{cmd}", output) unless $?.to_i == 0
+      end
+
+      def cmd
+        "#{@cmd_name} #{options_string(@options)}"
+      end
+
       private
-      def self.o(key,value)
+
+      def o(key,value)
         Option.new(key,value)
       end
 
       # options common to all commands
-      def self.build_base_options(host_and_port,db,username="",password="")
+      def build_base_options(host_and_port,db,username="",password="")
         options = []
         options << o("-h", host_and_port)
         options << o("-db", db)
@@ -29,57 +46,73 @@ module MongoDbUtils
       end
 
       # given an array of options build a string of those options unless the option is empty
-      def self.options_string(opts)
-        out = ""
-        opts.each do |o|
-          out << "#{o.key} #{o.value} " unless o.empty?
-        end
-        out.strip
+      def options_string(opts)
+        opt_strings = opts.reject{ |o| o.empty? }.map { |o| o.to_s }
+        opt_strings.join(" ").strip
       end
     end
 
     class Dump < BaseCmd
-      # create the cmd string that will be executed by the system
-      def self.cmd(host_and_port,db,output,username = "", password = "")
-        options = build_base_options(host_and_port,db,username,password)
-        options << o("-o", output)
-        "mongodump #{options_string(options)}"
-      end
-
-      # run the command
-      def self.run(host_and_port,db,output,username="", password ="")
-        cmd_string = self.cmd(host_and_port,db,output,username,password)
-        puts "[Dump] run: #{cmd_string}"
-        output = `#{cmd_string}`
-        raise ToolsException.new("#{cmd_string}", output) unless $?.to_i == 0
+      def initialize(host_and_port,db,output,username = "", password = "")
+        super("mongodump", host_and_port, db, username, password)
+        @options << o("-o", output)
       end
     end
 
     class Restore < BaseCmd
-      def self.cmd(host_and_port,db,source_folder,username = "", password = "")
-        options = build_base_options(host_and_port,db,username,password)
-        params = options_string(options) << " --drop #{source_folder}"
-        "mongorestore #{params}"
+      def initialize(host_and_port,db,source_folder,username = "", password = "")
+        super("mongorestore", host_and_port, db, username, password)
+        @options << "--drop"
+        @source_folder = source_folder
       end
 
-      def self.run(host_and_port,db,source_folder,username="", password ="")
-        cmd_string = self.cmd(host_and_port,db,source_folder,username,password)
-        puts "[Restore] run: #{cmd_string}"
-        output = `#{cmd_string}`
-        raise ToolsException.new("#{cmd_string}", output) unless $?.to_i == 0
+      def cmd
+        "#{super} #{@source_folder}"
       end
     end
 
+    class Import < BaseCmd
+      def initialize(host_and_port, db, collection, file, username = "", password = "", opts = {})
+        super("mongoimport", host_and_port, db, username, password)
+        @options << o("-c", collection)
+        @options << o("--file", file)
+        @options << "--jsonArray" if opts[:json_array]
+      end
+    end
+
+    class Export < BaseCmd
+
+      def initialize(host_and_port, db, collection, query, output, username = "", password = "", opts = {})
+        super("mongoexport", host_and_port, db, username, password)
+        @options << o("-c", collection)
+        @options << o("-o", output)
+        @options << o("--query", "'#{query}'")
+        @options << "--jsonArray" if opts[:json_array]
+      end
+    end
 
     class Option
       attr_accessor :key, :value
 
-      def initialize(key,value)
+      def initialize(key,value = nil)
         @key = key
         @value = value
       end
 
       def empty?
+        (@value.nil? || @value.empty?)
+      end
+
+      def to_s
+        if empty?
+          nil
+        else
+          "#{@key} #{@value}"
+        end
+      end
+
+      private
+      def value_empty?
         @value.nil? || @value.empty?
       end
     end

data/lib/mongo-db-utils/version.rb

@@ -1,4 +1,4 @@
 module MongoDbUtils
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
   READY_FOR_USE = "(Beta version)"
 end

data/spec/models/db_spec.rb

@@ -13,6 +13,8 @@ describe MongoDbUtils::Model::Db do
     db.password.should == "pass"
     db.uri == "mongodb://user:pass@localhost:27017/db"
     db.authentication_required?.should == true
+    db.host.should == "localhost"
+    db.port.should == "27017"
   end
 
   it "should construct - no user/pass" do
@@ -23,6 +25,8 @@ describe MongoDbUtils::Model::Db do
     db.password.should == ""
     db.uri == "mongodb://localhost:27017/db"
     db.authentication_required?.should == false
+    db.host.should == "localhost"
+    db.port.should == "27017"
   end
 
   it "should build a replicaset db" do
@@ -31,6 +35,28 @@ describe MongoDbUtils::Model::Db do
     rs.to_host_s === "my-set/host:port,host2:port2"
     rs.uri.should == "mongodb://user:pass@host:port,host2:port2/db"
     rs.authentication_required?.should == true
+
+    expect{ rs.host }.to raise_error
+    expect{ rs.port }.to raise_error
+
+    rs.hosts.should == ["host:port", "host2:port2"]
+
+  end
+
+
+  it "should parse the uri correctly" do
+    MongoDbUtils::Model.db_from_uri("mongodb://localhost:27017/db").class.to_s.should == "MongoDbUtils::Model::Db"
+    MongoDbUtils::Model.db_from_uri("set|mongodb://s:2,s:3/db").class.to_s.should == "MongoDbUtils::Model::ReplicaSetDb"
+  end
+
+
+  it "should parse a full url" do
+
+    uri = "rs-ds063347|mongodb://user:pass@ds063347-a0.mongolab.com:63347,ds063347-a1.mongolab.com:63347/staging"
+    db = MongoDbUtils::Model.db_from_uri(uri)
+    db.username.should eql "user"
+    db.password.should == "pass"
+    db.to_host_s.should == "rs-ds063347/ds063347-a0.mongolab.com:63347,ds063347-a1.mongolab.com:63347"
   end
 
 end

data/spec/mongo_tools_cmd_spec.rb

@@ -1,38 +1,78 @@
 require 'mongo-db-utils/tools/commands'
 
-describe MongoDbUtils::Tools::Dump do
+include MongoDbUtils::Tools
 
-  dump = MongoDbUtils::Tools::Dump
+describe Dump do
 
   it "should work with single uris" do
-    dump.cmd("host:port", "db", "out", "user", "pass").should eql "mongodump -h host:port -db db -u user -p pass -o out"
+    Dump.new("host:port", "db", "out", "user", "pass").cmd.should eql "mongodump -h host:port -db db -u user -p pass -o out"
   end
-
   it "should work with single uris - no user/pass" do
-    dump.cmd("host:port", "db", "out").should eql "mongodump -h host:port -db db -o out"
+    Dump.new("host:port", "db", "out").cmd.should eql "mongodump -h host:port -db db -o out"
   end
 
   it "should work with replica set uris" do
     expected = "mongodump -h setname/host1:port1,host2:port2 -db db -u user -p pass -o out"
-    dump.cmd("setname/host1:port1,host2:port2","db", "out", "user", "pass").should eql expected
+    Dump.new("setname/host1:port1,host2:port2","db", "out", "user", "pass").cmd.should eql expected
   end
 end
 
-
-describe MongoDbUtils::Tools::Restore do
-
-  restore = MongoDbUtils::Tools::Restore
+describe Restore do
 
   it "should work with single uris" do
-    restore.cmd("host:port", "db", "source", "user", "pass").should eql "mongorestore -h host:port -db db -u user -p pass --drop source"
+    Restore.new("host:port", "db", "source", "user", "pass").cmd.should eql "mongorestore -h host:port -db db -u user -p pass --drop source"
   end
 
   it "should work with single uris" do
-    restore.cmd("host:port", "db", "source").should eql "mongorestore -h host:port -db db --drop source"
+    Restore.new("host:port", "db", "source").cmd.should eql "mongorestore -h host:port -db db --drop source"
   end
 
   it "should work with replica set uris" do
     expected = "mongorestore -h setname/host1:port1,host2:port2 -db db -u user -p pass --drop source"
-    restore.cmd("setname/host1:port1,host2:port2","db", "source", "user", "pass").should eql expected
+    Restore.new("setname/host1:port1,host2:port2","db", "source", "user", "pass").cmd.should eql expected
+  end
+end
+
+describe Import do
+
+  it "should work with single uris - with user/pass" do
+    Import.new("host:port", "db", "coll", "myfile.json", "user", "pass").cmd.should eql "mongoimport -h host:port -db db -u user -p pass -c coll --file myfile.json"
   end
-end
+
+  it "should work with single uris - no user/pass" do
+    Import.new("host:port", "db", "coll", "myfile.json").cmd.should eql "mongoimport -h host:port -db db -c coll --file myfile.json"
+  end
+
+  it "should work with replica set uris" do
+    expected = "mongoimport -h setname/host1:port1,host2:port2 -db db -u user -p pass -c coll --file myfile.json --jsonArray"
+    Import.new("setname/host1:port1,host2:port2","db", "coll", "myfile.json", "user", "pass", { :json_array => true} ).cmd.should eql expected
+  end
+end
+
+describe Export do
+
+  it "should work with single uris - with user/pass" do
+    Export.new("host:port", "db", "coll", "{query}", "myfile.json", "user", "pass").cmd.should eql "mongoexport -h host:port -db db -u user -p pass -c coll -o myfile.json --query '{query}'"
+  end
+
+  it "should work with single uris - no user/pass" do
+    Export.new("host:port", "db", "coll", "{query}", "myfile.json").cmd.should eql "mongoexport -h host:port -db db -c coll -o myfile.json --query '{query}'"
+  end
+
+  it "should work with replica set uris" do
+    expected = "mongoexport -h setname/host1:port1,host2:port2 -db db -u user -p pass -c coll -o myfile.json --query '{query}' --jsonArray"
+    Export.new("setname/host1:port1,host2:port2","db", "coll", "{query}", "myfile.json", "user", "pass", { :json_array => true} ).cmd.should eql expected
+  end
+end
+
+describe Option do
+
+  it "should return empty? correctly" do
+    Option.new("a", "b").empty?.should eql false
+    Option.new("a", "b").to_s.should eql "a b"
+    Option.new("a").empty?.should eql true
+    Option.new("a").to_s.should eql nil
+    Option.new("").empty?.should eql true
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongo-db-utils
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - edeustace
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-28 00:00:00.000000000 Z
+date: 2013-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec