mongoid-shell 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=documentation
+

data/.travis.yml

@@ -0,0 +1,9 @@
+services:
+  - mongodb
+
+rvm:
+  - 1.9.3
+
+notifications:
+  email:
+    - dblock@dblock.org

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+0.1.0 (1/27/2013)
+==================
+
+* Initial public release with support for `mongodump` - [@dblock](https://github.com/dblock).

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem "rake"
+  gem "bundler"
+  gem "rspec"
+end

data/LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2012 Daniel Doubrovkine, Artsy Inc.
+
+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,37 @@
+Mongoid::Shell [![Build Status](https://travis-ci.org/dblock/mongoid-shell.png?branch=master)](https://travis-ci.org/dblock/mongoid-shell)
+==============
+
+Create mongo command-lines from Mongoid configuration. 
+
+Commands can be created for the current default session or you can pass a session as an argument to a new command.
+
+``` ruby
+Mongoid::Shell::Commands::Mongodump.new # will use Mongoid.default_session
+Mongoid::Shell::Commands::Mongodump.new(session: Moped::Session.new([ "127.0.0.1:27017" ]))
+```
+
+Supported Commands
+==================
+
+### Mongodump
+
+``` ruby
+mongodump = Mongoid::Shell::Commands::Mongodump.new({ collection: 'test' })
+mongodump.to_s # mongodump --host localhost:27017 --db test --collection test
+```
+
+Supports `--db`, `--host`, `--username`, `--password` and `--collection`.
+
+Contributing
+------------
+
+Fork the project. Make your feature addition or bug fix with tests. Send a pull request. Bonus points for topic branches.
+
+Copyright and License
+---------------------
+
+MIT License, see [LICENSE](http://github.com/dblock/mongoid-shell/raw/master/LICENSE.md) for details.
+
+(c) 2013 [Daniel Doubrovkine](http://github.com/dblock), [Artsy Inc.](http://artsy.net)
+
+

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'bundler/gem_tasks'
+
+require File.expand_path('../lib/mongoid/shell/version', __FILE__)
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+

data/lib/config/locales/en.yml

@@ -0,0 +1,10 @@
+en:
+  mongoid:
+    shell:
+      errors:
+        messages:
+          missing_session:
+            message: "Missing session."
+            summary: "The command requires a session."
+            resolution: "Your code is missing a parameter to `new` or `command_for`.
+              Typically you can obtain a session from `Mongoid.default_session`."

data/lib/mongoid-shell.rb

@@ -0,0 +1,8 @@
+require 'i18n'
+
+I18n.load_path << File.join(File.dirname(__FILE__), "config", "locales", "en.yml")
+
+require 'mongoid/shell/version'
+require 'mongoid/shell/errors'
+require 'mongoid/shell/properties'
+require 'mongoid/shell/commands'

data/lib/mongoid/shell/commands.rb

@@ -0,0 +1,2 @@
+require 'mongoid/shell/commands/base'
+require 'mongoid/shell/commands/mongodump'

data/lib/mongoid/shell/commands/base.rb

@@ -0,0 +1,46 @@
+module Mongoid
+  module Shell
+    module Commands
+      class Base
+
+        attr_accessor :session
+
+        class << self
+
+          def command_for(session)
+            self.new({ session: session })
+          end
+
+        end
+
+        def initialize(options = nil)
+          options ||= {}
+          options[:session] ||= Mongoid.default_session
+          options.each do |sym, val|
+            self.send "#{sym}=", val
+          end
+          raise Mongoid::Shell::Errors::MissingSessionError unless @session
+        end
+
+        def cmd
+          self.class.name.downcase.split(':').last
+        end
+
+        def vargs(args = {})
+          args.map do |key, property|
+            value = self.send(property)
+            next unless value
+            # TODO: quote other special characters?
+            value = '"' + value + '"' if value.include? ' '
+            "#{key} #{value}"
+          end
+        end
+
+        def to_s
+          [ self.cmd, vargs ].flatten.compact.join(" ")
+        end
+
+      end
+    end
+  end
+end

data/lib/mongoid/shell/commands/mongodump.rb

@@ -0,0 +1,30 @@
+module Mongoid
+  module Shell
+    module Commands
+      class Mongodump < Mongoid::Shell::Commands::Base
+        include Mongoid::Shell::Properties::Host
+        include Mongoid::Shell::Properties::Database
+        include Mongoid::Shell::Properties::Username
+        include Mongoid::Shell::Properties::Password
+
+        attr_accessor :collection, :query
+
+        def initialize(attrs = {})
+          super
+        end
+
+        def vargs
+          super({
+            '--host' => :host,
+            '--db' => :database_name,
+            '--username' => :username,
+            '--password' => :password,
+            '--collection' => :collection,
+            '--query' => :query
+          })
+        end
+
+      end
+    end
+  end
+end

data/lib/mongoid/shell/errors.rb

@@ -0,0 +1,2 @@
+require 'mongoid/shell/errors/base'
+require 'mongoid/shell/errors/missing_session_error'

data/lib/mongoid/shell/errors/base.rb

@@ -0,0 +1,81 @@
+module Mongoid
+  module Shell
+    module Errors
+      class Base < StandardError
+
+        # Problem occurred.
+        attr_reader :problem
+
+        # Summary of the problem.
+        attr_reader :summary
+
+        # Suggested problem resolution.
+        attr_reader :resolution
+
+        # Compose the message.
+        # === Parameters
+        # [key] Lookup key in the translation table.
+        # [attributes] The objects to pass to create the message.
+        def compose_message(key, attributes = {})
+          @problem = create_problem(key, attributes)
+          @summary = create_summary(key, attributes)
+          @resolution = create_resolution(key, attributes)
+
+          "\nProblem:\n  #{@problem}"+
+          "\nSummary:\n  #{@summary}"+
+          "\nResolution:\n  #{@resolution}"
+        end
+
+        private
+
+          BASE_KEY = "mongoid.shell.errors.messages" #:nodoc:
+
+          # Given the key of the specific error and the options hash, translate the
+          # message.
+          #
+          # === Parameters
+          # [key] The key of the error in the locales.
+          # [options] The objects to pass to create the message.
+          #
+          # Returns a localized error message string.
+          def translate(key, options)
+            ::I18n.translate("#{BASE_KEY}.#{key}", { :locale => :en }.merge(options)).strip
+          end
+
+          # Create the problem.
+          #
+          # === Parameters
+          # [key] The error key.
+          # [attributes] The attributes to interpolate.
+          #
+          # Returns the problem.
+          def create_problem(key, attributes)
+            translate("#{key}.message", attributes)
+          end
+
+          # Create the summary.
+          #
+          # === Parameters
+          # [key] The error key.
+          # [attributes] The attributes to interpolate.
+          #
+          # Returns the summary.
+          def create_summary(key, attributes)
+            translate("#{key}.summary", attributes)
+          end
+
+          # Create the resolution.
+          #
+          # === Parameters
+          # [key] The error key.
+          # [attributes] The attributes to interpolate.
+          #
+          # Returns the resolution.
+          def create_resolution(key, attributes)
+            translate("#{key}.resolution", attributes)
+          end
+
+      end
+    end
+  end
+end

data/lib/mongoid/shell/errors/missing_session_error.rb

@@ -0,0 +1,11 @@
+module Mongoid
+  module Shell
+    module Errors
+      class MissingSessionError < Mongoid::Shell::Errors::Base
+        def initialize
+          super(compose_message("missing_session"))
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/shell/properties.rb

@@ -0,0 +1,4 @@
+require 'mongoid/shell/properties/host'
+require 'mongoid/shell/properties/database'
+require 'mongoid/shell/properties/username'
+require 'mongoid/shell/properties/password'

data/lib/mongoid/shell/properties/database.rb

@@ -0,0 +1,14 @@
+module Mongoid
+  module Shell
+    module Properties
+      module Database
+
+        # current database name
+        def database_name
+          session.send(:current_database).name
+        end
+
+      end
+    end
+  end
+end

data/lib/mongoid/shell/properties/host.rb

@@ -0,0 +1,14 @@
+module Mongoid
+  module Shell
+    module Properties
+      module Host
+
+        # database host
+        def host
+          session.cluster.nodes.first.address
+        end
+
+      end
+    end
+  end
+end

data/lib/mongoid/shell/properties/password.rb

@@ -0,0 +1,15 @@
+module Mongoid
+  module Shell
+    module Properties
+      module Password
+
+        # current password
+        def password
+          return nil unless session.context.cluster.auth && session.context.cluster.auth.first
+          session.context.cluster.auth.first[1][1]
+        end
+
+      end
+    end
+  end
+end

data/lib/mongoid/shell/properties/username.rb

@@ -0,0 +1,15 @@
+module Mongoid
+  module Shell
+    module Properties
+      module Username
+
+        # current username
+        def username
+          return nil unless session.context.cluster.auth && session.context.cluster.auth.first
+          session.context.cluster.auth.first[1][0]
+        end
+
+      end
+    end
+  end
+end

data/lib/mongoid/shell/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module Shell
+    VERSION = '0.1.0'
+  end
+end

data/lib/mongoid_shell.rb

@@ -0,0 +1,2 @@
+require 'mongoid-shell'
+

data/mongoid-shell.gemspec

@@ -0,0 +1,20 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "mongoid/shell/version"
+
+Gem::Specification.new do |s|
+  s.name = "mongoid-shell"
+  s.version = Mongoid::Shell::VERSION
+  s.authors = [ "Daniel Doubrovkine" ]
+  s.email = "dblock@dblock.org"
+  s.platform = Gem::Platform::RUBY
+  s.required_rubygems_version = '>= 1.3.6'
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = [ "lib" ]
+  s.homepage = "http://github.com/dblock/mongoid-shell"
+  s.licenses = [ "MIT" ]
+  s.summary = "Derive shell commands from Mongoid configuration options."
+  s.add_dependency "mongoid"
+  s.add_dependency "i18n"
+end
+
+

data/spec/mongoid/commands/base_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Mongoid::Shell::Commands::Base do
+  context "without a default session" do
+    before :each do
+      Mongoid.stub(:default_session).and_return(nil)
+    end
+    it "raises an exception when a session is missing" do
+      expect { 
+        Mongoid::Shell::Commands::Base.new({})
+      }.to raise_error Mongoid::Shell::Errors::MissingSessionError, /Missing session./
+    end
+    it "raises an exception when options are missing" do
+      expect { 
+        Mongoid::Shell::Commands::Base.new(nil)
+      }.to raise_error Mongoid::Shell::Errors::MissingSessionError, /Missing session./
+    end
+  end
+  it "creates a command using the default session" do
+    command = Mongoid::Shell::Commands::Base.new
+    command.session.should eq Mongoid.default_session
+  end
+  it "creates a command using the session provided" do
+    session = Moped::Session.new([ "127.0.0.1:27017" ])
+    command = Mongoid::Shell::Commands::Base.new(session: session)
+    command.session.should eq session
+  end
+  it "command_for" do
+    command = Mongoid::Shell::Commands::Base.command_for(Mongoid.default_session)
+    command.session.should eq Mongoid.default_session
+  end
+end

data/spec/mongoid/commands/mongodump_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Mongoid::Shell::Commands::Mongodump do
+  context "default session" do
+    it "defaults to local" do
+      Mongoid::Shell::Commands::Mongodump.new.to_s.should == "mongodump --host localhost:27017 --db mongoid_shell_tests"
+    end
+    it "includes collection" do
+      Mongoid::Shell::Commands::Mongodump.new({ 
+        collection: 'test'
+      }).to_s.should == "mongodump --host localhost:27017 --db mongoid_shell_tests --collection test"
+    end
+    it "includes query" do
+      Mongoid::Shell::Commands::Mongodump.new({ 
+        query: 'find x' 
+      }).to_s.should == 'mongodump --host localhost:27017 --db mongoid_shell_tests --query "find x"'
+    end
+  end
+end

data/spec/mongoid/mongoid_shell_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Mongoid::Shell do
+  it "has a version" do
+    Mongoid::Shell::VERSION.should_not be_nil
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'rspec'
+require 'mongoid'
+require 'mongoid-shell'
+
+Mongoid.configure do |config|
+  config.connect_to('mongoid_shell_tests')
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-shell
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Daniel Doubrovkine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: dblock@dblock.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/config/locales/en.yml
+- lib/mongoid-shell.rb
+- lib/mongoid/shell/commands.rb
+- lib/mongoid/shell/commands/base.rb
+- lib/mongoid/shell/commands/mongodump.rb
+- lib/mongoid/shell/errors.rb
+- lib/mongoid/shell/errors/base.rb
+- lib/mongoid/shell/errors/missing_session_error.rb
+- lib/mongoid/shell/properties.rb
+- lib/mongoid/shell/properties/database.rb
+- lib/mongoid/shell/properties/host.rb
+- lib/mongoid/shell/properties/password.rb
+- lib/mongoid/shell/properties/username.rb
+- lib/mongoid/shell/version.rb
+- lib/mongoid_shell.rb
+- mongoid-shell.gemspec
+- spec/mongoid/commands/base_spec.rb
+- spec/mongoid/commands/mongodump_spec.rb
+- spec/mongoid/mongoid_shell_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/dblock/mongoid-shell
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 408535153
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Derive shell commands from Mongoid configuration options.
+test_files: []