mms-api 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e348b26040968b5237a1ecf092521d1b7a9fee4
-  data.tar.gz: 315480e20f2e2df40e5d7371f711d51e24caae69
+  metadata.gz: 522bb6499771a5d35e3775dc983f503c17213531
+  data.tar.gz: c1a3b629f19493576070783dfa937d0611195169
 SHA512:
-  metadata.gz: 9937df53420d73716e1146f6d33669e94cc96fd0bac80035696f219524188a79fb95bd5f0dffc32ca6c93d304064768b8c220859a737f48dda8c34eb1ccb76c1
-  data.tar.gz: 53306305960f12f8d1716c2aec73baf36392cb59668ac8549ea561cbad03a0cc48672d975deffce68e7f3e2317f98be023d0829c8f8c90e3e2bf58bff3682b8f
+  metadata.gz: 0feb735e81520656658e134e5fccbd5a46af4e192862b4072aae6a431c4e0796e7d4bb1f688c962a661d0445da7bcc4f4e477cf9d99874aa57963215de1b30b2
+  data.tar.gz: 7bbbf7c6f5d75db491d175aa11f9b6a5774b3a862bf1400c37fac9e75b83a7491facd32651bb1d6e7326ba34b8d891298681259a9e9cc4a942b9e8f784f2ba0b

data/README.md

@@ -14,14 +14,20 @@ The MMS Public API follows the principles of the REST architectural style to exp
 
 |Resource       |Get All |Get One |Create |Update |Delete |
 |:--------------|:------:|:------:|:-----:|:-----:|:-----:|
-|Groups         | +      | +      |       |       |       |
-|Hosts          | +      | +      |       |       |       |
-|Clusters       | +      | +      |       |       |       |
-|Snapshots      | +      | +      |       |       |       |
-|Alerts         | +      | +      |       |       |       |
-|Restore Jobs   | +      | +      | +     |       |       |
-|Backup Configs | +      | +      |       |       |       |
-|Metrics        | +      | +      |       |       |       |
+|Groups         | +      | +      | -     | -     | -     |
+|Hosts          | +      | +      | +     | +     | +     |
+|Clusters       | +      | +      | x     | +     | x     |
+|Snapshots      | +      | +      | x     | x     | -     |
+|Alerts         | +      | +      | x     | -     | x     |
+|Restore Jobs   | +      | +      | +     | x     | x     |
+|Backup Configs | +      | +      | x     | -     | x     |
+|Metrics        | +      | +      | x     | x     | x     |
+
+```
++ : supported by gem
+- : not supported by gem
+x : not supported by MMS
+```
 
 Library usage
 -------------

data/lib/mms.rb

@@ -1,10 +1,10 @@
 module MMS
-  require 'rubygems'  # For ruby < 1.9
+  require 'rubygems' # For ruby < 1.9
 
-  require "uri"
-  require "json"
-  require "cgi"
-  require "net/http"
+  require 'uri'
+  require 'json'
+  require 'cgi'
+  require 'net/http'
   require 'net/http/digest_auth'
   require 'terminal-table'
   require 'pathname'

data/lib/mms/agent.rb

@@ -1,7 +1,5 @@
 module MMS
-
   class Agent
-
     attr_accessor :client
 
     # @param [MMS::Client] client
@@ -10,7 +8,7 @@ module MMS
     end
 
     # @param [String] apiurl
-    def set_apiurl(apiurl)
+    def apiurl(apiurl)
       @client.url = apiurl
     end
 
@@ -19,8 +17,8 @@ module MMS
       group_list = []
       client.get('/groups').each do |group|
         g = MMS::Resource::Group.new
-        g.set_client(client)
-        g.set_data(group)
+        g.client(client)
+        g.data(group)
 
         group_list.push g
       end
@@ -36,6 +34,72 @@ module MMS
       host_list
     end
 
+    # @param [String] groupid
+    # @param [String] hostname
+    # @param [Integer] port
+    # @option options [String] username Required if authMechanismName is MONGODB_CR. Otherwise illegal.
+    # @option options [String] password Required if authMechanismName is MONGODB_CR. Otherwise illegal.
+    # @option options [TrueClass, FalseClass] sslEnabled Must be true if the authMechanismName is MONGODB_X509. Default is false if omitted.
+    # @option options [TrueClass, FalseClass] logsEnabled Default is false if omitted.
+    # @option options [TrueClass, FalseClass] alertsEnabled Default is true if omitted.
+    # @option options [TrueClass, FalseClass] profilerEnabled Default is false if omitted.
+    # @option options [Integer] muninPort Default is 0 and Munin stats are not collected if omitted.
+    # @option options [String] authMechanismName Default is NONE if omitted. If set to MONGODB_CR then you must provide the username and password.
+    # @return [<MMS::Resource::Host>]
+    def host_create(groupid, hostname, port, options = {})
+      data = {}
+      data[:hostname] = hostname
+      data[:port] = port
+      data[:username] = options[:username] || nil
+      data[:password] = options[:password] || nil
+      data[:sslEnabled] = options[:sslEnabled] || false
+      data[:logsEnabled] = options[:logsEnabled] || false
+      data[:alertsEnabled] = options[:alertsEnabled] || true
+      data[:profilerEnabled] = options[:profilerEnabled] || false
+      data[:muninPort] = options[:muninPort] || 0
+      data[:authMechanismName] = options[:authMechanismName] || nil
+      ret_host = client.post("/groups/#{groupid}/hosts", data)
+      host = MMS::Resource::Host.new
+      host._from_hash(ret_host)
+      host
+    end
+
+    # @param [String] groupid
+    # @param [String] hostid
+    # @option options [String] username Required if authMechanismName is MONGODB_CR. Otherwise illegal.
+    # @option options [String] password Required if authMechanismName is MONGODB_CR. Otherwise illegal.
+    # @option options [TrueClass, FalseClass] sslEnabled Must be true if the authMechanismName is MONGODB_X509. Default is false if omitted.
+    # @option options [TrueClass, FalseClass] logsEnabled Default is false if omitted.
+    # @option options [TrueClass, FalseClass] alertsEnabled Default is true if omitted.
+    # @option options [TrueClass, FalseClass] profilerEnabled Default is false if omitted.
+    # @option options [Integer] muninPort Default is 0 and Munin stats are not collected if omitted.
+    # @option options [String] authMechanismName Default is NONE if omitted. If set to MONGODB_CR then you must provide the username and password.
+    # @return [<MMS::Resource::Host>]
+    def host_update(groupid, hostid, options = {})
+      data = {}
+      data[:username] = options[:username] if options.include?(:username)
+      data[:password] = options[:password] if options.include?(:password)
+      data[:sslEnabled] = options[:sslEnabled] if options.include?(:sslEnabled)
+      data[:logsEnabled] = options[:logsEnabled] if options.include?(:logsEnabled)
+      data[:alertsEnabled] = options[:alertsEnabled] if options.include?(:alertsEnabled)
+      data[:profilerEnabled] = options[:profilerEnabled] if options.include?(:profilerEnabled)
+      data[:muninPort] = options[:muninPort] if options.include?(:muninPort)
+      data[:authMechanismName] = options[:authMechanismName] if options.include?(:authMechanismName)
+      ret_host = client.patch("/groups/#{groupid}/hosts/#{hostid}", data)
+      host = MMS::Resource::Host.new
+      host._from_hash(ret_host)
+      host
+    end
+
+    # @param [String] groupid
+    # @param [String] hostid
+    # @return [TrueClass, FalseClass]
+    def host_delete(groupid, hostid)
+      client.delete("/groups/#{groupid}/hosts/#{hostid}")
+      host = client.delete("/groups/#{groupid}/hosts/#{hostid}")
+      host == {} ? true : false
+    end
+
     # @return [Array<MMS::Resource::Cluster>]
     def clusters
       cluster_list = []
@@ -45,13 +109,25 @@ module MMS
       cluster_list
     end
 
+    # @param [String] groupid
+    # @param [String] clusterid
+    # @param [String] name
+    # @return [<MMS::Resource::Cluster>]
+    def cluster_update(groupid, clusterid, name)
+      data = { clusterName: name }
+      ret_cluster = client.patch("/groups/#{groupid}/clusters/#{clusterid}", data)
+      cluster = MMS::Resource::Cluster.new
+      cluster._from_hash(ret_cluster)
+      cluster
+    end
+
     # @return [Array<MMS::Resource::Snapshot>]
     def snapshots
       snapshot_list = []
       clusters.each do |cluster|
         snapshot_list.concat cluster.snapshots
       end
-      snapshot_list.sort_by { |snapshot| snapshot.created_date }.reverse
+      snapshot_list.sort_by(&:created_date).reverse
     end
 
     # @return [Array<MMS::Resource::Alert>]
@@ -60,7 +136,7 @@ module MMS
       groups.each do |group|
         alert_list.concat group.alerts
       end
-      alert_list.sort_by { |alert| alert.created }.reverse
+      alert_list.sort_by(&:created).reverse
     end
 
     # @return [Array<MMS::Resource::RestoreJob>]
@@ -69,7 +145,7 @@ module MMS
       clusters.each do |cluster|
         restorejob_list.concat cluster.restorejobs
       end
-      restorejob_list.sort_by { |job| job.created }.reverse
+      restorejob_list.sort_by(&:created).reverse
     end
 
     # @param [String] type_value
@@ -79,8 +155,9 @@ module MMS
     def restorejob_create(type_value, group_id, cluster_id)
       if type_value.length == 24
         find_group(group_id).cluster(cluster_id).snapshot(type_value).create_restorejob
-      elsif datetime = (type_value == 'now' ? DateTime.now : DateTime.parse(type_value))
-        raise('Invalid datetime. Correct `YYYY-MM-RRTH:m:sZ`') if datetime.nil?
+      else
+        datetime = (type_value == 'now' ? DateTime.now : DateTime.parse(type_value))
+        fail('Invalid datetime. Correct `YYYY-MM-RRTH:m:sZ`') if datetime.nil?
         datetime_string = [[datetime.year, datetime.month, datetime.day].join('-'), 'T', [datetime.hour, datetime.minute, datetime.second].join(':'), 'Z'].join
         find_group(group_id).cluster(cluster_id).create_restorejob(datetime_string)
       end
@@ -110,6 +187,5 @@ module MMS
     def find_group(id)
       MMS::Resource::Group.find(@client, id)
     end
-
   end
 end

data/lib/mms/cache.rb

@@ -1,15 +1,14 @@
 require 'singleton'
 
 module MMS
-
   class Cache
-
     include Singleton
 
     attr_accessor :storage
+    attr_reader :storage
 
     def initialize
-      @storage = Hash.new {|hash, key| hash[key] = nil }
+      @storage = Hash.new { |hash, key| hash[key] = nil }
     end
 
     # @param [String] key
@@ -32,9 +31,5 @@ module MMS
     def clear
       initialize
     end
-
-    def storage
-      @storage
-    end
   end
 end

data/lib/mms/cli.rb

@@ -2,11 +2,8 @@ require 'clamp'
 require 'parseconfig'
 
 module MMS
-
   class CLI
-
     class MMS::CLI::Command < Clamp::Command
-
       attr_accessor :app_name
       attr_accessor :config
 
@@ -25,7 +22,7 @@ module MMS
         @config.apiurl = u
       end
 
-      option ['-v', '--version'], :flag, 'Version' do |v|
+      option ['-v', '--version'], :flag, 'Version' do |_v|
         puts "mms-api v#{MMS::VERSION}"
         exit
       end
@@ -43,28 +40,28 @@ module MMS
         parse_user_home_config
       end
 
-      option ['-i', '--ignore'], :flag, 'Ignore flag of --group-id and -cluster-id', :default => false
+      option ['-i', '--ignore'], :flag, 'Ignore flag of --group-id and -cluster-id', default: false
 
-      option ['-j', '--json'], :flag, 'Print JSON output', :default => false
+      option ['-j', '--json'], :flag, 'Print JSON output', default: false
 
       option ['-l', '--limit'], '<integer>', 'Limit for result items' do |l|
         @config.limit = Integer(l)
       end
 
-      def initialize(invocation_path, context = {}, parent_attribute_values = {})
+      def initialize(_invocation_path, _context = {}, _parent_attribute_values = {})
         @config ||= MMS::Config.new
       end
 
       def parse_user_home_config
-        raise(MMS::ConfigError.new('Config file path is not set!')) if @config.config_path.nil?
+        fail(MMS::ConfigError.new('Config file path is not set!')) if @config.config_path.nil?
         config_file = Pathname.new(@config.config_path)
-        raise(MMS::ConfigError.new("Config file `#{config_file}` does not exist")) unless config_file.exist?
+        fail(MMS::ConfigError.new("Config file `#{config_file}` does not exist")) unless config_file.exist?
 
         config = ParseConfig.new(config_file)
         config.params.map do |key, value|
           begin
             @config.send("#{key}=", value)
-          rescue Exception => e
+          rescue Exception => _e
             raise MMS::ConfigError.new("Config option `#{key}` from file `#{config_file}` is not allowed!")
           end
         end
@@ -92,13 +89,13 @@ module MMS
       end
 
       # @param [String] heading
-      # @param [Array<MMS::Resource>]
+      # @param [Array<MMS::Resource>] resource_list
       def print(heading, resource_list)
         json? ? print_json(resource_list) : print_human(heading, resource_list)
       end
 
       # @param [String] heading
-      # @param [Array<MMS::Resource>]
+      # @param [Array<MMS::Resource>] resource_list
       def print_human(heading, resource_list)
         rows = []
 
@@ -106,12 +103,12 @@ module MMS
           rows += resource.table_section
         end
 
-        puts Terminal::Table.new :headings => (heading.nil? ? [] : heading), :rows => rows
+        puts Terminal::Table.new headings: (heading.nil? ? [] : heading), rows: rows
 
         print_tips unless ignore?
       end
 
-      # @param [Array<MMS::Resource>]
+      # @param [Array<MMS::Resource>] resource_list
       def print_json(resource_list)
         rows = []
 
@@ -126,127 +123,100 @@ module MMS
         puts 'Default group: ' + @config.default_group_id unless @config.default_group_id.nil?
         puts 'Default cluster: ' + @config.default_cluster_id unless @config.default_cluster_id.nil?
 
-        if !@config.default_group_id.nil? or !@config.default_cluster_id.nil?
+        if !@config.default_group_id.nil? || !@config.default_cluster_id.nil?
           puts "Add flag --ignore or update --default-group-id, --default-cluster-id or update your `#{@config.config_path}` to see all resources"
         end
       end
 
-
       # @param [Array] arguments
       def run(arguments)
-        begin
-          parse_user_home_config
-          super
-        rescue Clamp::HelpWanted => e
-          raise(help)
-        rescue Clamp::UsageError => e
-          raise([e.message, help].join("\n"))
-        rescue MMS::AuthError => e
-          raise('Authorisation problem. Please check you credential!')
-        rescue MMS::ResourceError => e
-          raise(["Resource #{e.resource.class.name} problem:", e.message].join("\n"))
-        end
+        parse_user_home_config
+        super
+      rescue Clamp::HelpWanted => _e
+        raise(help)
+      rescue Clamp::UsageError => e
+        raise([e.message, help].join("\n"))
+      rescue MMS::AuthError => _e
+        raise('Authorisation problem. Please check you credential!')
+      rescue MMS::ResourceError => e
+        raise(["Resource #{e.resource.class.name} problem:", e.message].join("\n"))
       end
     end
 
     class MMS::CLI::Command::Groups < MMS::CLI::Command
-
       subcommand 'list', 'Group list' do
-
         def execute
           print(MMS::Resource::Group.table_header, groups)
         end
       end
-
     end
 
     class MMS::CLI::Command::Hosts < MMS::CLI::Command
-
       subcommand 'list', 'Host list' do
-
         def execute
-          host_list = groups.collect! { |group| group.hosts }.flatten
+          host_list = groups.collect!(&:hosts).flatten
           print(MMS::Resource::Host.table_header, host_list)
         end
       end
-
     end
 
     class MMS::CLI::Command::Clusters < MMS::CLI::Command
-
       subcommand 'list', 'Cluster list' do
-
         def execute
           print(MMS::Resource::Cluster.table_header, clusters)
         end
       end
 
       subcommand 'snapshot-schedule', 'Cluster snapshot schedule config' do
-
         def execute
-          snapshot_schedule_list = clusters.collect! { |cluster| cluster.snapshot_schedule }.flatten
+          snapshot_schedule_list = clusters.collect!(&:snapshot_schedule).flatten
           print(MMS::Resource::SnapshotSchedule.table_header, snapshot_schedule_list)
         end
       end
-
     end
 
-
     class MMS::CLI::Command::Alerts < MMS::CLI::Command
-
       subcommand 'list', 'Alerts list' do
-
         def execute
-          alert_list = groups.collect! { |group| group.alerts }.flatten
+          alert_list = groups.collect!(&:alerts).flatten
           print(MMS::Resource::Alert.table_header, alert_list)
         end
-
       end
 
       subcommand 'ack', 'Acknowledge alert' do
-
-        parameter '[alert-id]', 'Alert ID', :default => 'all'
-        parameter '[group-id]', 'Group ID', :default => '--default-group-id'
-        parameter '[timestamp]', 'Postpone to timestamp', :default => 'forever'
+        parameter '[alert-id]', 'Alert ID', default: 'all'
+        parameter '[group-id]', 'Group ID', default: '--default-group-id'
+        parameter '[timestamp]', 'Postpone to timestamp', default: 'forever'
 
         def execute
           g_id = group_id == '--default-group-id' ? @config.default_group_id : group_id
           agent.alert_ack(alert_id, timestamp, g_id)
           puts 'Done.'
         end
-
       end
-
     end
 
     class MMS::CLI::Command::Snapshots < MMS::CLI::Command
-
       subcommand 'list', 'Snapshot list' do
-
         def execute
-          snapshot_list = clusters.collect! { |cluster| cluster.snapshots }.flatten.sort_by { |snapshot| snapshot.created_date }.reverse
+          snapshot_list = clusters.collect!(&:snapshots).flatten.sort_by(&:created_date).reverse
           print(MMS::Resource::Snapshot.table_header, snapshot_list)
         end
       end
-
     end
 
     class MMS::CLI::Command::RestoreJobs < MMS::CLI::Command
-
       subcommand 'list', 'Restorejob list' do
-
         def execute
-          restorejob_list = clusters.collect! { |cluster| cluster.restorejobs }.flatten.sort_by { |job| job.created }.reverse
+          restorejob_list = clusters.collect!(&:restorejobs).flatten.sort_by(&:created).reverse
           print(MMS::Resource::RestoreJob.table_header, restorejob_list)
         end
-
       end
 
       subcommand 'create', 'Restorejob create' do
-
-        parameter '[snapshot-source]', 'Restore from source. Options: now | timestamp | snapshot-id', :default => 'now'
-        parameter '[group-id]', 'Group ID', :default => '--default-group-id'
-        parameter '[cluster-id]', 'Cluster ID', :default => '--default-cluster-id'
+        parameter '[snapshot-source]', 'Restore from source. Options: now | timestamp | snapshot-id', default: 'now'
+        parameter '[group-id]', 'Group ID', default: '--default-group-id'
+        parameter '[cluster-id]', 'Cluster ID', default: '--default-cluster-id'
 
         def execute
           g_id = group_id == '--default-group-id' ? @config.default_group_id : group_id
@@ -256,19 +226,14 @@ module MMS
 
           puts 'Done.'
         end
-
       end
-
     end
 
     class MMS::CLI::CommandManager < MMS::CLI::Command
-
       def run(arguments)
-        begin
-          super
-        rescue Exception => e
-          abort(e.message.empty? ? 'Unknown error/Interrupt' : e.message)
-        end
+        super
+      rescue Exception => e
+        abort(e.message.empty? ? 'Unknown error/Interrupt' : e.message)
       end
 
       subcommand 'groups', 'Groups ', MMS::CLI::Command::Groups
@@ -277,9 +242,6 @@ module MMS
       subcommand 'alerts', 'Alerts', MMS::CLI::Command::Alerts
       subcommand 'snapshots', 'Snapshots', MMS::CLI::Command::Snapshots
       subcommand 'restorejobs', 'Restorejobs', MMS::CLI::Command::RestoreJobs
-
     end
-
   end
-
 end