gomon 0.0.1

data/README.md

@@ -0,0 +1,61 @@
+# Gomon
+
+Ruby wrappers around mongodb cli tools.
+
+## Prerequisites
+
+This gem depends on no other gems. Ruby 1.9+
+It assumes the presence of `mongorestore` and `mongodump` commands.
+It was built around the latest tools at the moment of this writing, meaning version 2.2.2. So if is possible that arguments format and/or names have changed from previous versions, making them potentially not compatible with Gomon.
+
+## Installation
+
+Directly : `gem install gomon`.  
+Gemfile : `gem 'gomon'`.
+
+## Usage
+
+The tools currently supported are `mongodump` and `mongorestore`.  
+They are wrapped in `Gomon::Dump` and `Gomon::Restore` respectively.
+
+These two classes are used in the same way: first, instantiate the object, then, invoke `call` without arguments on it. In most cases, the only difference of usage will be the options passed to the constructor.
+
+### Example
+
+    > gd = Gomon::Dump.new uri: "mongodb://user:pass@host:12345/database", other: '--journal'
+    > gd.cmd_string
+    => "mongodump --host 'host' --port '12345' --username 'user' --password 'pass' --db 'database' --journal"
+    > gd.call
+    # Dumping `database` from host...
+    # Executing: mongodump --host 'host' --port '12345' --username 'user' --password 'pass' --db 'database' --journal
+    # ....
+    # Done dumping.
+    => nil
+
+### Options
+
+The two classes accepts a hash of options when initializing, as in `gd = Gomon::Dumper.new(db: 'gem_test')`. This hash can contain:
+
+* Any option accepted by `mongodump` or `mongorestore`. You should refer to the [MongoDB Manual](http://docs.mongodb.org/manual/reference/mongorestore/) for more on them;
+* Singular options that have no value, as '--drop', can be supplied with the key `:other`;
+* If the key `:uri` is present, its value will be parsed and split to retrieve the username, password, host, port, and database;
+* Specific to `Gomon::Restore`: the option value for the key `:path` will be used as its last argument, as is.
+
+If you want to set options once the object is already created, you can use `add_option(key, value)` or `add_options({key: value, ...})`. However, there will be no special treatment for options: even if you supply `:uri`, or `:other`, they won't be handled the way they are when creating the object.
+
+
+## What's next
+
+* There is no test at all yet. This shall change.
+* Better support for manipulating options once the object is created.
+
+## Contributions
+
+1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug. In the first case, please include a use-case.
+2. Fork the repository on Github, make a feature branch, work on this branch.
+3. If necessary, write a test which shows that the bug was fixed or that the feature works as expected.
+4. Send a pull request and annoy us until we notice it. :)
+
+## Changelog
+
+* `0.1`: First version. Provices basic functionnality for `Gomon::Dump` & `Gomon::Restore`

data/gomon.gemspec

@@ -0,0 +1,17 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'gomon/version'
+
+Gem::Specification.new do |s|
+  s.name                      = "gomon"
+  s.version                   = Gomon::VERSION
+  s.platform                  = Gem::Platform::RUBY
+  s.authors                   = ["Novelys", "Kevin Soltysiak"]
+  s.email                     = ["contact@novelys.com"]
+  s.homepage                  = "http://github.com/novelys/gomon"
+  s.summary                   = "Ruby wrappers around mongo utilities."
+  s.description               = "A set of ruby classing wrapping mongodb cli tools, making them pleasant to integrate to ruby scripts, rake tasks, etc"
+  s.rubyforge_project         = s.name
+  s.required_rubygems_version = ">= 1.3.6"
+  s.files                     = `git ls-files`.split("\n")
+  s.require_path              = 'lib'
+end

data/lib/gomon.rb

@@ -0,0 +1,4 @@
+require 'gomon/base'
+require 'gomon/dump'
+require 'gomon/restore'
+require 'gomon/version'

data/lib/gomon/base.rb

@@ -0,0 +1,37 @@
+require 'gomon/options'
+require 'gomon/uri'
+
+module Gomon
+  class Base
+    include Options
+    include Uri
+
+    def initialize(opts = {})
+      @tool = 'mongodump'
+
+      # Default options
+      @options = {host: 'localhost', port: '27017'}
+      @singular_options = opts.delete(:other)
+
+      # Extract uri into options
+      if (uri = opts.delete(:uri))
+        add_options parse_uri(uri)
+      end
+
+      # Keep track of other options
+      add_options opts
+    end
+
+    # String to execute
+    def cmd_string
+      "#{tool} #{cli_options}"
+    end
+
+    # Execute before/after hookes if any, execute command
+    def call
+      before_cmd
+      system(cmd_string)
+      after_cmd
+    end
+  end
+end

data/lib/gomon/dump.rb

@@ -0,0 +1,22 @@
+require 'gomon/base'
+
+module Gomon
+  class Dump < Base
+    attr_reader :tool
+
+    def initialize(opts = {})
+      super
+
+      @tool = 'mongodump'
+    end
+
+    def before_cmd
+      puts "Dumping `#{@options[:db]}` from #{@options[:host]}..."
+      puts "Executing: #{cmd_string}"
+    end
+
+    def after_cmd
+      puts "Done dumping."
+    end
+  end
+end

data/lib/gomon/options.rb

@@ -0,0 +1,29 @@
+module Gomon
+  module Options
+    # Add a single options
+    def add_option(key, value)
+      add_options({key => value})
+    end
+
+    # Add many options
+    def add_options(opts = {})
+      @options.merge! opts
+    end
+
+    # Returns the options string
+    def cli_options
+      options_as_array.join(' ')
+    end
+
+    # Returns options as an array
+    def options_as_array
+      ary = @options.each_with_object([]) do |(key, value), memo|
+        memo << "--#{key} '#{value}'"
+      end
+
+      ary << @singular_options if @singular_options
+
+      ary
+    end
+  end
+end

data/lib/gomon/restore.rb

@@ -0,0 +1,29 @@
+require 'gomon/base'
+
+module Gomon
+  class Restore < Base
+    attr_reader :tool
+
+    def initialize(opts = {})
+      @path = opts.delete(:path) || 'dump/*'
+      super(opts)
+      @tool = 'mongorestore'
+    end
+
+    # String to execute
+    def cmd_string
+      "#{super} '#{@path}'"
+    end
+
+    # Hook to execute before restoring
+    def before_cmd
+      puts "Restoring from dir `#{@path}` into `#{@options[:db]}` at #{@options[:host]}..."
+      puts "Executing: #{cmd_string}"
+    end
+
+    # Hook to execute after restoring
+    def after_cmd
+      puts "Done restoring."
+    end
+  end
+end

data/lib/gomon/uri.rb

@@ -0,0 +1,16 @@
+module Gomon
+  module Uri
+    # Parse mongodb uri into options
+    def parse_uri(uri)
+      matches = uri.match /mongodb:\/\/([^:]*):([^@]*)@([^:]*):(\d*)\/(.*)/i
+
+      {
+        username: matches[1],
+        password: matches[2],
+        host:     matches[3],
+        port:     matches[4],
+        db:       matches[5]
+      }
+    end
+  end
+end

data/lib/gomon/version.rb

@@ -0,0 +1,3 @@
+module Gomon
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: gomon
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Novelys
+- Kevin Soltysiak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-13 00:00:00.000000000 Z
+dependencies: []
+description: A set of ruby classing wrapping mongodb cli tools, making them pleasant
+  to integrate to ruby scripts, rake tasks, etc
+email:
+- contact@novelys.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- gomon.gemspec
+- lib/gomon.rb
+- lib/gomon/base.rb
+- lib/gomon/dump.rb
+- lib/gomon/options.rb
+- lib/gomon/restore.rb
+- lib/gomon/uri.rb
+- lib/gomon/version.rb
+homepage: http://github.com/novelys/gomon
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: gomon
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Ruby wrappers around mongo utilities.
+test_files: []