mongoid-shell 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 281b10f7bd8d03398017dd86286d9fb9f188738f
-  data.tar.gz: e45e3e8df36e8df3dc6ccad7451e84580c69fd40
+  metadata.gz: b0e80be659912607683e05be144ad4456b51a999
+  data.tar.gz: 9d43a23815209ba7354f1fc22bc8a7f54286d382
 SHA512:
-  metadata.gz: 01de62b1af19ff3d15b3deb906e534bb46124549a934ee9122bfcb885569b1a8a6aa653d3738cd9504812d40dc94b6485356a62cf383a8025494067808a8d049
-  data.tar.gz: 3ae7256e0dfc0f4800b7c1c8087cf8cc9d2b1a9b7947f79d744f232a5aa14dca4f0de971ce9b5d1a0ed9ea323d67ad90cf89867f2c8f0d8bc00bc398660c25e3
+  metadata.gz: d7fb5e80531426776aa4828a30e9dd5d328dff0db4430e20e50f5498c8ad72a1146c5b493e688283ec95ef65fc648fbd6fae72db52ff2d15eac0200d8b332aed
+  data.tar.gz: 8a35c2256c55e8fa5c2ac3dcf2b998e7b8e32331b3f35e27fac021ffac1cf676419afd2ad42670443142465a2973a1294f4ccf81fcc53ef3bfb1344f03397ddf

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.4.5 (9/7/2017)
+
+* [#13](https://github.com/mongoid/mongoid-shell/issues/13): Support masking sensitive values with `to_s(mask_sensitive: true)` - [@dblock](https://github.com/dblock).
+* [#14](https://github.com/mongoid/mongoid-shell/pull/14): Refactored arg definitions into `arg` and `option` - [@dblock](https://github.com/dblock).
+
 ### 0.4.4 (6/4/2017)
 
 * [#11](https://github.com/mongoid/mongoid-shell/pull/11): Compatibility with Mongoid 6 - [@jbach](https://github.com/jbach).

data/README.md

@@ -43,6 +43,15 @@ mongodump = Mongoid::Shell::Commands::Mongodump.new(excludeCollection: %w(users
 system mongodump.to_s # mongodump --excludeCollection users --excludeCollection products
 ```
 
+To use output in logs, pass the `mask_sensitive` option to `to_s`.
+
+``` ruby
+> Mongoid::Shell::Commands::Mongo.new.to_s(mask_sensitive: true)
+ => "mongo 59.1.22.1:27017/mongoid --username user --password ********"
+
+> Mongoid::Shell::Commands::Mongo.new.to_s(mask_sensitive: '(masked)')
+ => "mongo 59.1.22.1:27017/mongoid --username user --password (masked)"
+```
 
 Compatibility
 -------------

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

@@ -5,9 +5,31 @@ module Mongoid
         attr_accessor :session
 
         class << self
+          attr_accessor :args
+          @args = {}
+
+          def inherit_args(args)
+            @args ||= {}
+            @args.merge(args || {})
+          end
+
+          def inherited(sublass)
+            sublass.inherit_args(@args)
+          end
+
           def command_for(session)
             new(session: session)
           end
+
+          def arg(name, options = {})
+            attr_accessor name unless instance_methods.include?(name)
+            args[name] = { property: name }.merge(options)
+          end
+
+          def option(name, options = {})
+            attr_accessor name unless instance_methods.include?(name)
+            args[name] = { key: "--#{name}", property: name }.merge(options)
+          end
         end
 
         def initialize(options = nil)
@@ -23,24 +45,31 @@ module Mongoid
           self.class.name.downcase.split(':').last
         end
 
-        def vargs(args = {})
-          args.map do |key, property|
-            value = send(property)
+        def vargs(options = {})
+          mask_sensitive = options[:mask_sensitive]
+          mask_sensitive = '********' if mask_sensitive && mask_sensitive.is_a?(TrueClass)
+          self.class.args.values.map do |arg|
+            key = arg[:key]
+            value = send(arg[:property])
             next unless value
             case value
             when Boolean, TrueClass then key
             when Array then value.map { |v| "#{key} #{v}" }.join(' ')
             else
-              value = value.to_s
-              # TODO: quote other special characters?
-              value = '"' + value + '"' if value.include? ' '
-              key[0] == '-' ? "#{key} #{value}" : value
+              if mask_sensitive && arg[:sensitive]
+                value = mask_sensitive
+              else
+                # TODO: quote other special characters?
+                value = value.to_s
+                value = '"' + value + '"' if value.include? ' '
+              end
+              key ? "#{key} #{value}" : value
             end
           end
         end
 
-        def to_s
-          [cmd, vargs].flatten.compact.join(' ')
+        def to_s(options = {})
+          [cmd, vargs(options)].flatten.compact.join(' ')
         end
 
         private

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

@@ -7,28 +7,19 @@ module Mongoid
         include Mongoid::Shell::Properties::Username
         include Mongoid::Shell::Properties::Password
 
-        attr_accessor :eval, :nodb, :norc, :quiet, :ipv6
+        arg :host_port_and_db
 
-        def initialize(attrs = {})
-          super
-        end
+        option :username
+        option :password, sensitive: true
+        option :eval
+        option :nodb
+        option :norc
+        option :quiet
+        option :ipv6
 
         def host_port_and_db
           [primary, db].compact.join('/')
         end
-
-        def vargs
-          super({
-            'db address' => :host_port_and_db,
-            '--username' => :username,
-            '--password' => :password,
-            '--eval' => :eval,
-            '--nodb' => :nodb,
-            '--norc' => :norc,
-            '--quiet' => :quiet,
-            '--ipv6' => :ipv6
-          })
-        end
       end
     end
   end

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

@@ -7,33 +7,22 @@ module Mongoid
         include Mongoid::Shell::Properties::Username
         include Mongoid::Shell::Properties::Password
 
-        attr_accessor :collection, :query, :out, :directoryperdb, :journal, :oplog, :repair, :forceTableScan, :dbpath, :ipv6, :excludeCollection,
-                      :excludeCollectionsWithPrefix
-
-        def initialize(attrs = {})
-          super
-        end
-
-        def vargs
-          super({
-            '--host' => :host,
-            '--db' => :db,
-            '--username' => :username,
-            '--password' => :password,
-            '--collection' => :collection,
-            '--excludeCollection' => :excludeCollection,
-            '--excludeCollectionsWithPrefix' => :excludeCollectionsWithPrefix,
-            '--query' => :query,
-            '--out' => :out,
-            '--directoryperdb' => :directoryperdb,
-            '--journal' => :journal,
-            '--oplog' => :oplog,
-            '--repair' => :repair,
-            '--forceTableScan' => :forceTableScan,
-            '--dbpath' => :dbpath,
-            '--ipv6' => :ipv6
-          })
-        end
+        option :host
+        option :db
+        option :username
+        option :password, sensitive: true
+        option :collection
+        option :excludeCollection
+        option :excludeCollectionsWithPrefix
+        option :query
+        option :out
+        option :directoryperdb
+        option :journal
+        option :oplog
+        option :repair
+        option :forceTableScan
+        option :dbpath
+        option :ipv6
       end
     end
   end

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

@@ -7,62 +7,50 @@ module Mongoid
         include Mongoid::Shell::Properties::Username
         include Mongoid::Shell::Properties::Password
 
-        attr_accessor :verbose, :quiet, :port, :ipv6, :ssl, :sslCAFile,
-                      :sslPEMKeyFile, :sslPEMKeyPassword, :sslCRLFile,
-                      :sslAllowInvalidCertificates, :sslAllowInvalidHostnames, :sslFIPSMode,
-                      :authenticationDatabase, :authenticationMechanism, :gssapiServiceName,
-                      :gssapiHostName, :collection, :fields, :fieldFile, :query, :csv,
-                      :type, :out, :jsonArray, :pretty, :slaveOk, :forceTableScan, :skip,
-                      :limit, :sort, :directoryperdb, :journal, :dbpath
+        # args
+        option :db
+        option :host
+        option :port
+        option :sslCAFile
+        option :sslPEMKeyFile
+        option :sslPEMKeyPassword, sensitive: true
+        option :sslCRLFile
+        option :username
+        option :password, sensitive: true
+        option :authenticationDatabase
+        option :authenticationMechanism
+        option :collection
+        option :fields
+        option :fieldFile
+        option :query
+        option :type
+        option :out
+        option :skip
+        option :limit
+        option :sort
 
-        def initialize(attrs = {})
-          super
-        end
+        # boolean options
+        option :verbose
+        option :quiet
+        option :ipv6
+        option :ssl
+        option :sslAllowInvalidCertificates
+        option :sslAllowInvalidHostnames
+        option :sslFIPSMode
+        option :gssapiServiceName
+        option :gssapiHostName
+        option :jsonArray
+        option :pretty
+        option :slaveOk
+        option :forceTableScan
 
-        def vargs
-          super var_options.merge(boolean_options)
-        end
+        # is deprecated from Mongo version 3.0.0, use type instead
+        option :csv
 
-        private
-
-        def var_options
-          {
-            '--db' => :db, '--host' => :host, '--port' => :port,
-            '--sslCAFile' => :sslCAFile,
-            '--sslPEMKeyFile' => :sslPEMKeyFile,
-            '--sslPEMKeyPassword' => :sslPEMKeyPassword,
-            '--sslCRLFile' => :sslCRLFile,
-            '--username' => :username,
-            '--password' => :password,
-            '--authenticationDatabase' => :authenticationDatabase,
-            '--authenticationMechanism' => :authenticationMechanism,
-            '--collection' => :collection,
-            '--fields' => :fields, '--fieldFile' => :fieldFile,
-            '--query' => :query,
-            '--type' => :type, '--out' => :out,
-            '--skip' => :skip, '--limit' => :limit, '--sort' => :sort
-          }
-        end
-
-        def boolean_options
-          {
-            '--verbose' => :verbose, '--quiet' => :quiet,
-            '--ipv6' => :ipv6, '--ssl' => :ssl,
-            '--sslAllowInvalidCertificates' => :sslAllowInvalidCertificates,
-            '--sslAllowInvalidHostnames' => :sslAllowInvalidHostnames,
-            '--sslFIPSMode' => :sslFIPSMode,
-            '--gssapiServiceName' => :gssapiServiceName,
-            '--gssapiHostName' => :gssapiHostName,
-            '--jsonArray' => :jsonArray,
-            '--pretty' => :pretty,
-            '--slaveOk' => :slaveOk,
-            '--forceTableScan' => :forceTableScan,
-            '--csv' => :csv, # is deprecated from Mongo version 3.0.0, use type instead
-            # these 3 below are deprecated from Mongo version 3.0.0
-            '--directoryperdb' => :directoryperdb,
-            '--journal' => :journal, '--dbpath' => :dbpath
-          }
-        end
+        # these 3 below are deprecated from Mongo version 3.0.0
+        option :directoryperdb
+        option :journal
+        option :dbpath
       end
     end
   end

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

@@ -7,67 +7,47 @@ module Mongoid
         include Mongoid::Shell::Properties::Username
         include Mongoid::Shell::Properties::Password
 
-        attr_accessor :verbose, :quiet, :port, :ipv6, :ssl, :sslCAFile,
-                      :sslPEMKeyFile, :sslPEMKeyPassword, :sslCRLFile,
-                      :sslAllowInvalidCertificates, :sslAllowInvalidHostnames, :sslFIPSMode,
-                      :authenticationDatabase, :authenticationMechanism, :gssapiServiceName,
-                      :gssapiHostName, :collection, :fields, :directoryperdb, :journal, :dbpath,
-                      :fieldFile, :ignoreBlanks, :type, :file, :drop, :headerline, :upsert,
-                      :upsertFields, :stopOnError, :jsonArray, :maintainInsertionOrder,
-                      :numInsertionWorkers, :writeConcern
-
-        def initialize(attrs = {})
-          super
-        end
-
-        def vargs
-          super({
-
-          })
-        end
-
-        def vargs
-          super var_options.merge(boolean_options)
-        end
-
-        private
-
-        def var_options
-          {
-            '--db' => :db, '--host' => :host, '--port' => :port,
-            '--sslCAFile' => :sslCAFile,
-            '--sslPEMKeyFile' => :sslPEMKeyFile,
-            '--sslPEMKeyPassword' => :sslPEMKeyPassword,
-            '--sslCRLFile' => :sslCRLFile,
-            '--username' => :username, '--password' => :password,
-            '--authenticationDatabase' => :authenticationDatabase,
-            '--authenticationMechanism' => :authenticationMechanism,
-            '--collection' => :collection, '--fields' => :fields,
-            '--fieldFile' => :fieldFile, '--type' => :type, '--file' => :file,
-            '--upsertFields' => :upsertFields,
-            '--maintainInsertionOrder' => :maintainInsertionOrder,
-            '--numInsertionWorkers' => :numInsertionWorkers,
-            '--writeConcern' => :writeConcern,
-            # these 3 below are deprecated from Mongo version 3.0.0
-            '--directoryperdb' => :directoryperdb,
-            '--journal' => :journal, '--dbpath' => :dbpath
-          }
-        end
-
-        def boolean_options
-          {
-            '--verbose' => :verbose, '--quiet' => :quiet,
-            '--ipv6' => :ipv6, '--ssl' => :ssl,
-            '--sslAllowInvalidCertificates' => :sslAllowInvalidCertificates,
-            '--sslAllowInvalidHostnames' => :sslAllowInvalidHostnames,
-            '--sslFIPSMode' => :sslFIPSMode,
-            '--gssapiServiceName' => :gssapiServiceName,
-            '--gssapiHostName' => :gssapiHostName,
-            '--ignoreBlanks' => :ignoreBlanks, '--drop' => :drop,
-            '--headerline' => :headerline, '--upsert' => :upsert,
-            '--stopOnError' => :stopOnError, '--jsonArray' => :jsonArray
-          }
-        end
+        option :db
+        option :host
+        option :port
+        option :sslCAFile
+        option :sslPEMKeyFile
+        option :sslPEMKeyPassword, sensitive: true
+        option :sslCRLFile
+        option :username
+        option :password, sensitive: true
+        option :authenticationDatabase
+        option :authenticationMechanism
+        option :collection
+        option :fields
+        option :fieldFile
+        option :type
+        option :file
+        option :upsertFields
+        option :maintainInsertionOrder
+        option :numInsertionWorkers
+        option :writeConcern
+
+        # these 3 below are deprecated from Mongo version 3.0.0
+        option :directoryperdb
+        option :journal
+        option :dbpath
+
+        option :verbose
+        option :quiet
+        option :ipv6
+        option :ssl
+        option :sslAllowInvalidCertificates
+        option :sslAllowInvalidHostnames
+        option :sslFIPSMode
+        option :gssapiServiceName
+        option :gssapiHostName
+        option :ignoreBlanks
+        option :drop
+        option :headerline
+        option :upsert
+        option :stopOnError
+        option :jsonArray
       end
     end
   end

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

@@ -7,36 +7,27 @@ module Mongoid
         include Mongoid::Shell::Properties::Username
         include Mongoid::Shell::Properties::Password
 
-        attr_accessor :host, :collection, :ipv6, :dbpath, :directoryperdb, :journal, :objcheck, :filter, :drop, :oplogReplay, :keepIndexVersion, :noIndexRestore, :restore
+        option :host
+        option :db
+        option :username
+        option :password, sensitive: true
+        option :collection
+        option :ipv6
+        option :dbpath
+        option :directoryperdb
+        option :journal
+        option :objcheck
+        option :filter
+        option :drop
+        option :oplogReplay
+        option :keepIndexVersion
+        option :noIndexRestore
 
-        def initialize(attrs = {})
-          super
-        end
+        arg :restore
 
         def host
           @host || primary
         end
-
-        def vargs
-          super({
-            '--host' => :host,
-            '--db' => :db,
-            '--username' => :username,
-            '--password' => :password,
-            '--collection' => :collection,
-            '--ipv6' => :ipv6,
-            '--dbpath' => :dbpath,
-            '--directoryperdb' => :directoryperdb,
-            '--journal' => :journal,
-            '--objcheck' => :objcheck,
-            '--filter' => :filter,
-            '--drop' => :drop,
-            '--oplogReplay' => :oplogReplay,
-            '--keepIndexVersion' => :keepIndexVersion,
-            '--noIndexRestore' => :noIndexRestore,
-            'directory or filename to restore from' => :restore
-          })
-        end
       end
     end
   end

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

@@ -7,24 +7,14 @@ module Mongoid
         include Mongoid::Shell::Properties::Username
         include Mongoid::Shell::Properties::Password
 
-        attr_accessor :rowcount, :discover, :all, :http, :noheaders
-
-        def initialize(attrs = {})
-          super
-        end
-
-        def vargs
-          super({
-            '--host' => :host,
-            '--username' => :username,
-            '--password' => :password,
-            '--rowcount' => :rowcount,
-            '--discover' => :discover,
-            '--noheaders' => :noheaders,
-            '--http' => :http,
-            '--all' => :all
-          })
-        end
+        option :host
+        option :username
+        option :password, sensitive: true
+        option :rowcount
+        option :discover
+        option :noheaders
+        option :http
+        option :all
       end
     end
   end

data/lib/mongoid/shell/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Shell
-    VERSION = '0.4.4'.freeze
+    VERSION = '0.4.5'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-shell
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-04 00:00:00.000000000 Z
+date: 2017-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid