mms-api 0.0.10 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f238c7242a72f7afcaf801e4471a6a772377b30
-  data.tar.gz: b7db404c176c296832c46552d104a7adb8abb899
+  metadata.gz: 91354b2007ab1bf12006b201e465bbc64c7c4e73
+  data.tar.gz: 0c1fdc6932a86acdc3f3f41061f2dcb8782bd612
 SHA512:
-  metadata.gz: b8dca3e5b69c6dc916920e52abffb1d1647f6a59571cbdf0307714564f7a8e43256dbb78ce46bea5d937eca2def867dc92e43d04e2ebd4e3182d2984df680ad8
-  data.tar.gz: 98f2a85f55e5f1cf942dda16d2745955745dee3ff52afbcb60d3c3261aa332e1e978d804eafeb16e99c59fd85098468f1c71b1e0e1dcbe6fd5b6824cf78e4b97
+  metadata.gz: 78d3bde92f63163a64454077f6edee97d82619458c3329f9ba5fa6f84eb2414a04452b46be57f3d0d8fabb9a9862fe2cc67ff48919c90433641b9bd621660479
+  data.tar.gz: e0210ba968b2d67ba035700b952b67445c896ab9b849ba1e1d9899369f18286b57c8d11aa45301de47d02a8cd6eb95815bb17b7e35819092c2f4712be82ff640

data/lib/mms.rb

@@ -21,6 +21,7 @@ module MMS
   require 'mms/resource/host'
   require 'mms/resource/cluster'
   require 'mms/resource/snapshot'
+  require 'mms/resource/snapshot_schedule'
   require 'mms/resource/restore_job'
   require 'mms/resource/alert'
 

data/lib/mms/agent.rb

@@ -4,18 +4,30 @@ module MMS
 
     attr_accessor :client
 
+    # @param [MMS::Client] client
     def initialize(client)
       @client = client
     end
 
+    # @param [String] apiurl
     def set_apiurl(apiurl)
       @client.url = apiurl
     end
 
+    # @return [Array<MMS::Resource::Group>]
     def groups
-      MMS::Resource::Group.findGroups(@client)
+      group_list = []
+      client.get('/groups').each do |group|
+        g = MMS::Resource::Group.new
+        g.set_client(client)
+        g.set_data(group)
+
+        group_list.push g
+      end
+      group_list
     end
 
+    # @return [Array<MMS::Resource::Host>]
     def hosts
       host_list = []
       groups.each do |group|
@@ -24,6 +36,7 @@ module MMS
       host_list
     end
 
+    # @return [Array<MMS::Resource::Cluster>]
     def clusters
       cluster_list = []
       groups.each do |group|
@@ -32,6 +45,7 @@ module MMS
       cluster_list
     end
 
+    # @return [Array<MMS::Resource::Snapshot>]
     def snapshots
       snapshot_list = []
       clusters.each do |cluster|
@@ -40,6 +54,7 @@ module MMS
       snapshot_list.sort_by { |snapshot| snapshot.created_date }.reverse
     end
 
+    # @return [Array<MMS::Resource::Alert>]
     def alerts
       alert_list = []
       groups.each do |group|
@@ -48,6 +63,7 @@ module MMS
       alert_list.sort_by { |alert| alert.created }.reverse
     end
 
+    # @return [Array<MMS::Resource::RestoreJob>]
     def restorejobs
       restorejob_list = []
       clusters.each do |cluster|
@@ -56,32 +72,43 @@ module MMS
       restorejob_list.sort_by { |job| job.created }.reverse
     end
 
+    # @param [String] type_value
+    # @param [String] group_id
+    # @param [String] cluster_id
+    # @return [Array<MMS::Resource::RestoreJob>]
     def restorejob_create(type_value, group_id, cluster_id)
       if type_value.length == 24
-        findGroup(group_id).cluster(cluster_id).snapshot(type_value).create_restorejob
+        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:s`') if datetime.nil?
         datetime_string = [[datetime.year, datetime.day, datetime.month].join('-'), 'T', [datetime.hour, datetime.minute, datetime.second].join(':'), 'Z'].join
-        findGroup(group_id).cluster(cluster_id).create_restorejob(datetime_string)
+        find_group(group_id).cluster(cluster_id).create_restorejob(datetime_string)
       end
     end
 
+    # @param [String] alert_id
+    # @param [String, Integer] timestamp
+    # @param [String] group_id
+    # @return [TrueClass, FalseClass]
     def alert_ack(alert_id, timestamp, group_id)
       timestamp = DateTime.now if timestamp == 'now'
       timestamp = DateTime.new(4000, 1, 1, 1, 1, 1, 1, 1) if timestamp == 'forever'
 
-      group = findGroup(group_id)
+      group = find_group(group_id)
 
       if alert_id == 'all'
         group.alerts.each do |alert|
           alert.ack(timestamp, 'Triggered by CLI for all alerts.')
         end
-      elsif group.alert(alert_id).ack(timestamp, 'Triggered by CLI.')
+      else
+        group.alert(alert_id).ack(timestamp, 'Triggered by CLI.')
       end
     end
 
-    def findGroup(id)
-      MMS::Resource::Group.new(@client, {'id' => id})
+    # @param [String] id
+    # @return [MMS::Resource::Group]
+    def find_group(id)
+      MMS::Resource::Group.find(@client, id)
     end
 
   end

data/lib/mms/cache.rb

@@ -12,14 +12,19 @@ module MMS
       @storage = Hash.new {|hash, key| hash[key] = nil }
     end
 
+    # @param [String] key
+    # @param [Object] value
     def set(key, value)
       @storage[key] = value
     end
 
+    # @param [String] key
+    # @return [Object]
     def get(key)
       @storage[key].nil? ? nil : @storage[key]
     end
 
+    # @param [String] key
     def delete(key)
       @storage.delete key unless @storage[key].nil?
     end

data/lib/mms/cli.rb

@@ -71,15 +71,35 @@ module MMS
 
       end
 
+      # @return [MMS::Agent]
       def agent
         @client = MMS::Client.new(@config.username, @config.apikey)
         @agent = MMS::Agent.new(client)
       end
 
+      # @return [Array<MMS::Resource::Group>]
+      def groups
+        id = ignore? ? nil : @config.default_group_id
+        id.nil? ? agent.groups : [agent.find_group(id)]
+      end
+
+      # @return [Array<MMS::Resource::Cluster>]
+      def clusters
+        id = ignore? ? nil : @config.default_cluster_id
+
+        groups.collect! do |group|
+          id.nil? ? group.clusters : group.cluster(id)
+        end.flatten
+      end
+
+      # @param [String] heading
+      # @param [Array<MMS::Resource>]
       def print(heading, resource_list)
         json? ? print_json(resource_list) : print_human(heading, resource_list)
       end
 
+      # @param [String] heading
+      # @param [Array<MMS::Resource>]
       def print_human(heading, resource_list)
         rows = []
 
@@ -87,11 +107,12 @@ module MMS
           rows += resource.table_section
         end
 
-        puts Terminal::Table.new :title => 'Hosts', :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>]
       def print_json(resource_list)
         rows = []
 
@@ -111,6 +132,8 @@ module MMS
         end
       end
 
+
+      # @param [Array] arguments
       def run(arguments)
         begin
           parse_user_home_config
@@ -127,27 +150,24 @@ module MMS
       end
     end
 
-    class MMS::CLI::Command::Hosts < MMS::CLI::Command
+    class MMS::CLI::Command::Groups < MMS::CLI::Command
 
-      subcommand 'list', 'Host list' do
+      subcommand 'list', 'Group list' do
 
         def execute
-          print(MMS::Resource::Host.table_header, agent.hosts)
+          print(MMS::Resource::Group.table_header, groups)
         end
       end
 
     end
 
-    class MMS::CLI::Command::Groups < MMS::CLI::Command
+    class MMS::CLI::Command::Hosts < MMS::CLI::Command
 
-      subcommand 'list', 'Group list' do
+      subcommand 'list', 'Host list' do
 
         def execute
-
-          group_list = agent.groups
-          group_list.reject! { |group| group.id != @config.default_group_id } unless @config.default_group_id.nil? or ignore?
-
-          print(MMS::Resource::Group.table_header, group_list)
+          host_list = groups.collect! { |group| group.hosts }.flatten
+          print(MMS::Resource::Host.table_header, host_list)
         end
       end
 
@@ -158,10 +178,15 @@ module MMS
       subcommand 'list', 'Cluster list' do
 
         def execute
-          cluster_list = agent.clusters
-          cluster_list.reject! { |cluster| cluster.id != @config.default_cluster_id } unless @config.default_cluster_id.nil? or ignore?
+          print(MMS::Resource::Cluster.table_header, clusters)
+        end
+      end
 
-          print(MMS::Resource::Cluster.table_header, cluster_list)
+      subcommand 'snapshot-schedule', 'Cluster snapshot schedule config' do
+
+        def execute
+          snapshot_schedule_list = clusters.collect! { |cluster| cluster.snapshot_schedule }.flatten
+          print(MMS::Resource::SnapshotSchedule.table_header, snapshot_schedule_list)
         end
       end
 
@@ -173,7 +198,8 @@ module MMS
       subcommand 'list', 'Alerts list' do
 
         def execute
-          print(MMS::Resource::Alert.table_header, agent.alerts)
+          alert_list = groups.collect! { |group| group.alerts }.flatten
+          print(MMS::Resource::Alert.table_header, alert_list)
         end
 
       end
@@ -199,7 +225,8 @@ module MMS
       subcommand 'list', 'Snapshot list' do
 
         def execute
-          print(MMS::Resource::Snapshot.table_header, agent.snapshots)
+          snapshot_list = clusters.collect! { |cluster| cluster.snapshots }.flatten.sort_by { |snapshot| snapshot.created_date }.reverse
+          print(MMS::Resource::Snapshot.table_header, snapshot_list)
         end
       end
 
@@ -210,7 +237,8 @@ module MMS
       subcommand 'list', 'Restorejob list' do
 
         def execute
-          print(MMS::Resource::RestoreJob.table_header, agent.restorejobs)
+          restorejob_list = clusters.collect! { |cluster| cluster.restorejobs }.flatten.sort_by { |job| job.created }.reverse
+          print(MMS::Resource::RestoreJob.table_header, restorejob_list)
         end
 
       end

data/lib/mms/client.rb

@@ -6,22 +6,33 @@ module MMS
     attr_accessor :apikey
     attr_accessor :url
 
+    # @param [String] username
+    # @param [String] apikey
+    # @param [String] url
     def initialize(username = nil, apikey = nil, url = nil)
       @username = username
       @apikey = apikey
       @url = url.nil? ? 'https://mms.mongodb.com:443/api/public/v1.0' : url
     end
 
+    # @param [String] path
+    # @return [Hash]
     def get(path)
       _get(@url + path, @username, @apikey)
     end
 
+    # @param [String] path
+    # @param [Hash] data
+    # @return [Hash]
     def post(path, data)
       _post(@url + path, data, @username, @apikey)
     end
 
     private
 
+    # @param [String] path
+    # @param [String] username
+    # @param [String] password
     def _get(path, username, password)
 
       digest_auth = Net::HTTP::DigestAuth.new
@@ -55,6 +66,10 @@ module MMS
       (response_json.nil? or response_json['results'].nil?) ? response_json : response_json['results']
     end
 
+    # @param [String] path
+    # @param [Hash] data
+    # @param [String] username
+    # @param [String] password
     def _post(path, data, username, password)
       digest_auth = Net::HTTP::DigestAuth.new
       digest_auth.next_nonce

data/lib/mms/errors.rb

@@ -2,6 +2,9 @@ module MMS
 
   class RuntimeError < StandardError;
 
+    # @param [String] message
+    # @param [Net::HTTPRequest] request
+    # @param [Net::HTTPResponse] response
     def initialize(message, request, response)
       super(message)
 
@@ -16,6 +19,8 @@ module MMS
 
   class ResourceError < StandardError
 
+    # @param [String] message
+    # @param [MMS::Resource] resource
     def initialize(message, resource)
       super(message)
 

data/lib/mms/resource.rb

@@ -5,13 +5,22 @@ module MMS
     attr_accessor :id
     attr_accessor :data
 
-    def initialize(id, data = nil)
-      @id = id
-      @data = data
+    attr_accessor :client
 
-      load
+    # @param [MMS::Client] client
+    def set_client(client)
+      @client = client
     end
 
+    # @param [Hash] data
+    def set_data(data)
+      @data = data
+      from_hash(data)
+      cache_key = "Class::#{self.class.name}:#{@id}"
+      MMS::Cache.instance.set(cache_key, data)
+    end
+
+    # @param [Hash] data
     def from_hash(data)
       unless data.nil?
         @id = data['id']
@@ -23,38 +32,17 @@ module MMS
       _to_hash
     end
 
-    def reload
-      @data = _load(@id)
-      save @data unless @data.nil? or @data.empty?
-    end
-
-    def load
-      _data = MMS::Cache.instance.get "Class::#{self.class.name}:#{@id}"
-
-      if _data.nil? and @data.nil?
-        _data = _load(@id) unless @id.nil?
-
-        if _data.nil?
-          raise "Cannot load data for #{self.class.name}, id `#{@id}`"
-        end
-      end
-
-      save _data || @data
-    end
-
-    def save(data)
-      from_hash data
-      MMS::Cache.instance.set "Class::#{self.class.name}:#{@id}", data
-    end
-
+    # @return [Array<String>]
     def table_row
       raise("`#{__method__}` is not implemented for `#{self.class.name}`")
     end
 
+    # @return [Array]
     def table_section
       raise("`#{__method__}` is not implemented for `#{self.class.name}`")
     end
 
+    # @return [Array<String>]
     def self.table_header
       raise("`#{__method__}` is not implemented for `#{self.class.name}`")
     end
@@ -63,12 +51,30 @@ module MMS
       raise("`#{__method__}` is not implemented for `#{self.class.name}`")
     end
 
+    # @param [Hash] data
     def _from_hash(data)
       raise("`#{__method__}` is not implemented for `#{self.class.name}`")
     end
 
+    # @return [Hash]
     def _to_hash
       raise("`#{__method__}` is not implemented for `#{self.class.name}`")
     end
+
+    # @param [MMS::Client] client
+    # @param arguments...
+    # @return self
+    def self.find(client, *arguments)
+      cache_key = "Class::#{self.name}:#{arguments.last()}"
+      data = MMS::Cache.instance.get(cache_key)
+      unless data
+        data = self._find(client, *arguments)
+      end
+
+      resource = self.new
+      resource.set_client(client)
+      resource.set_data(data)
+      resource
+    end
   end
 end

data/lib/mms/resource/alert.rb

@@ -2,10 +2,7 @@ module MMS
 
   class Resource::Alert < Resource
 
-    @client = nil
-
     attr_accessor :name
-    attr_accessor :group
 
     attr_accessor :type_name
     attr_accessor :event_type_name
@@ -17,37 +14,32 @@ module MMS
     attr_accessor :last_notified
     attr_accessor :current_value
 
-    def initialize(client, data)
-      id = data['id']
-      group_id = data['groupId']
-
-      raise MMS::ResourceError.new('`Id` for alert resource must be defined', self) if id.nil?
-      raise MMS::ResourceError.new('`groupId` for alert resource must be defined', self) if group_id.nil?
-
-      @client = client
-
-      @group = MMS::Resource::Group.new(client, {'id' => group_id})
-
-      super id, data
+    # @return [MMS::Resource::Group]
+    def group
+      MMS::Resource::Group.find(@client, @data['groupId'])
     end
 
+
+    # @param [Time, Integer] time
+    # @param [String] description
+    # @return [TrueClass, FalseClass]
     def ack(time, description)
       data = {
-          :acknowledgedUntil => time,
+          :acknowledgedUntil => time.to_i,
           :acknowledgementComment => description
       }
-      alert = @client.post '/groups/' + @group.id + '/alerts/' + @id, data
+      alert = @client.post '/groups/' + group.id + '/alerts/' + @id, data
       !alert.nil?
     end
 
     def table_row
-      [@status, @group.name, @type_name, @event_type_name, @created, @updated, @resolved, @last_notified, JSON.dump(@current_value)]
+      [@status, group.name, @type_name, @event_type_name, @created, @updated, @resolved, @last_notified, JSON.dump(@current_value)]
     end
 
     def table_section
       rows = []
       rows << table_row
-      rows << [{:value => "AlertId: #{@id}   GroupId: #{@group.id}", :colspan => 9, :alignment => :left}]
+      rows << [{:value => "AlertId: #{@id}   GroupId: #{group.id}", :colspan => 9, :alignment => :left}]
       rows << :separator
       rows
     end
@@ -56,12 +48,17 @@ module MMS
       ['Status', 'Group', 'Type', 'Event name', 'Created', 'Updated', 'Resolved', 'Last notified', 'Value']
     end
 
-    private
-
-    def _load(id)
-      @client.get '/groups/' + @group.id + '/alerts/' + id.to_s
+    # @param [MMS::Client] client
+    # @param [String] group_id
+    # @param [String] id
+    # @return [Hash]
+    def self._find(client, group_id, id)
+      client.get('/groups/' + group_id + '/alerts/' + id)
     end
 
+    private
+
+    # @param [Hash] data
     def _from_hash(data)
       @type_name = data['typeName']
       @event_type_name = data['eventTypeName']

data/lib/mms/resource/cluster.rb

@@ -2,10 +2,7 @@ module MMS
 
   class Resource::Cluster < Resource
 
-    @client = nil
-
     attr_accessor :name
-    attr_accessor :group
     attr_accessor :shard_name
     attr_accessor :replicaset_name
     attr_accessor :type_name
@@ -14,53 +11,59 @@ module MMS
     attr_accessor :snapshots
     attr_accessor :restorejobs
 
-    def initialize(client, data)
-      id = data['id']
-      group_id = data['groupId']
-
-      raise MMS::ResourceError.new('`Id` for cluster resource must be defined', self) if id.nil?
-      raise MMS::ResourceError.new('`groupId` for cluster resource must be defined', self) if group_id.nil?
-
+    def initialize
       @snapshots = []
       @restorejobs = []
+    end
 
-      @client = client
-
-      @group = MMS::Resource::Group.new(client, {'id' => group_id})
-
-      super id, data
+    def group
+      MMS::Resource::Group.find(@client, @data['groupId'])
     end
 
     def snapshot(id)
-      MMS::Resource::Snapshot.new(@client, {'id' => id, 'clusterId' => @id, 'groupId' => @group.id})
+      MMS::Resource::Snapshot.find(@client, group.id, @id, id)
     end
 
-    def snapshots(page = 1, limit = 10)
+    def snapshots(page = 1, limit = 1000)
       if @snapshots.empty?
-        @client.get('/groups/' + @group.id + '/clusters/' + @id + '/snapshots?pageNum=' + page.to_s + '&itemsPerPage=' + limit.to_s).each do |snapshot|
-          @snapshots.push MMS::Resource::Snapshot.new(@client, snapshot)
+        @client.get('/groups/' + group.id + '/clusters/' + @id + '/snapshots?pageNum=' + page.to_s + '&itemsPerPage=' + limit.to_s).each do |snapshot|
+          s = MMS::Resource::Snapshot.new
+          s.set_client(@client)
+          s.set_data(snapshot)
+
+          @snapshots.push s
         end
       end
       @snapshots
     end
 
-    def restorejobs(page = 1, limit = 10)
+    def snapshot_schedule
+      MMS::Resource::SnapshotSchedule.find(@client, group.id, @id)
+    end
+
+    def restorejobs(page = 1, limit = 1000)
       if @restorejobs.empty?
-        @client.get('/groups/' + @group.id + '/clusters/' + @id + '/restoreJobs?pageNum=' + page.to_s + '&itemsPerPage=' + limit.to_s).each do |job|
+        @client.get('/groups/' + group.id + '/clusters/' + @id + '/restoreJobs?pageNum=' + page.to_s + '&itemsPerPage=' + limit.to_s).each do |job|
 
           if job['snapshotId'].nil? and job['clusterId'].nil?
             raise MMS::ResourceError.new("RestoreJob `#{job['id']}` with status `#{job['statusName']}` has no `clusterId` and no `snapshotId`.", self)
           elsif job['clusterId'].nil?
-            snapshot = @group.findSnapshot(job['snapshotId'])
+            snapshot = group.find_snapshot(job['snapshotId'])
             job['clusterId'] = snapshot.cluster.id unless snapshot.nil?
           end
 
-          @restorejobs.push MMS::Resource::RestoreJob.new(@client, job)
+          j = MMS::Resource::RestoreJob.new
+          j.set_client(@client)
+          j.set_data(job)
+
+          @restorejobs.push j
         end
       end
       @restorejobs
     end
 
+    # @param [String] point_in_time
+    # @return [Array<MMS::Resource::RestoreJob>]
     def create_restorejob(point_in_time = nil)
       data = {
           'timestamp' => {
@@ -68,7 +71,7 @@ module MMS
               'increment' => 0
           }
       }
-      jobs = @client.post('/groups/' + @group.id + '/clusters/' + @id + '/restoreJobs', data)
+      jobs = @client.post('/groups/' + group.id + '/clusters/' + @id + '/restoreJobs', data)
 
       if jobs.nil?
         raise MMS::ResourceError.new("Cannot create job from snapshot `#{self.id}`", self)
@@ -102,7 +105,7 @@ module MMS
     end
 
     def table_row
-      [@group.name, @name, @shard_name, @replicaset_name, @type_name, @last_heartbeat, @id]
+      [group.name, @name, @shard_name, @replicaset_name, @type_name, @last_heartbeat, @id]
     end
 
     def table_section
@@ -113,12 +116,12 @@ module MMS
       ['Group', 'Cluster', 'Shard name', 'Replica name', 'Type', 'Last heartbeat', 'Cluster Id']
     end
 
-    private
-
-    def _load(id)
-      @client.get('/groups/' + @group.id + '/clusters/' + id.to_s)
+    def self._find(client, group_id, id)
+      client.get('/groups/' + group_id + '/clusters/' + id)
     end
 
+    private
+
     def _from_hash(data)
       @name = data['clusterName']
       @shard_name = data['shardName']

data/lib/mms/resource/group.rb

@@ -10,69 +10,79 @@ module MMS
 
     attr_accessor :clusters
 
-    @client = nil
-
-    def initialize(client, data)
-      id = data['id']
-
-      raise MMS::ResourceError.new('`Id` for group resource must be defined', self) if id.nil?
-
-      @client = client
-
+    def initialize
       @clusters = []
-
-      super id, data
-    end
-
-    def self.findGroups(client)
-      group_list = []
-      client.get('/groups').each do |group|
-        group_list.push MMS::Resource::Group.new(client, group)
-      end
-      group_list
     end
 
-    def hosts(page = 1, limit = 10)
+    # @param [Integer] page
+    # @param [Integer] limit
+    # @return [Array<MMS::Resource::Host>]
+    def hosts(page = 1, limit = 1000)
       host_list = []
       @client.get('/groups/' + @id + '/hosts?pageNum=' + page.to_s + '&itemsPerPage=' + limit.to_s).each do |host|
-        host_list.push MMS::Resource::Host.new(@client, host)
+        h = MMS::Resource::Host.new
+        h.set_client(@client)
+        h.set_data(host)
+
+        host_list.push h
       end
       host_list
     end
 
-    def alerts(page = 1, limit = 10, status = 'OPEN')
+    # @param [Integer] page
+    # @param [Integer] limit
+    # @param [String] status
+    # @return [Array<MMS::Resource::Alert>]
+    def alerts(page = 1, limit = 1000, status = 'OPEN')
       alert_list = []
       @client.get('/groups/' + @id + '/alerts?status=' + status + '&pageNum=' + page.to_s + '&itemsPerPage=' + limit.to_s).each do |alert|
-        alert_list.push MMS::Resource::Alert.new(@client, alert)
+        a = MMS::Resource::Alert.new
+        a.set_client(@client)
+        a.set_group(self)
+        a.set_data(data)
+
+        alert_list.push a
       end
       alert_list
     end
 
+    # @param [String] id
+    # @return [MMS::Resource::Alert]
     def alert(id)
-      MMS::Resource::Alert.new(@client, {'id' => id, 'groupId' => @id})
+      MMS::Resource::Alert.find(@client, @id, id)
     end
 
-    def clusters(page = 1, limit = 10)
+    # @param [Integer] page
+    # @param [Integer] limit
+    # @return [Array<MMS::Resource::Cluster>]
+    def clusters(page = 1, limit = 1000)
       if @clusters.empty?
         @client.get('/groups/' + @id + '/clusters?pageNum=' + page.to_s + '&itemsPerPage=' + limit.to_s).each do |cluster|
-          @clusters.push MMS::Resource::Cluster.new(@client, cluster)
+          c = MMS::Resource::Cluster.new
+          c.set_client(@client)
+          c.set_data(cluster)
+          @clusters.push c
         end
       end
       @clusters
     end
 
+    # @param [String] id
+    # @return [MMS::Resource::Cluster]
     def cluster(id)
-      MMS::Resource::Cluster.new(@client, {'id' => id, 'groupId' => @id})
+      MMS::Resource::Cluster.find(@client, @id, id)
     end
 
-    def findSnapshot(id)
+    # @param [String] id
+    # @return [MMS::Resource::Snapshot]
+    def find_snapshot(id)
       snapshot = nil
       clusters.each do |cluster|
         begin
           snapshot = cluster.snapshot(id)
         rescue => e
-          # cannot load snapshotId for cluster if config-server is the source?
-          # not supported in current MMS API version
+          # STDERR.puts 'cannot load snapshotId for cluster if config-server is the source!'
+          # STDERR.puts 'not supported in current MMS API version'
         end
       end
       snapshot
@@ -90,12 +100,12 @@ module MMS
       ['Name', 'Active Agents', 'Replicas count', 'Shards count', 'Last Active Agent', 'GroupId']
     end
 
-    private
-
-    def _load(id)
-      @client.get('/groups/' + id.to_s)
+    def self._find(client, id)
+      client.get('/groups/' + id)
     end
 
+    private
+
     def _from_hash(data)
       @name = data['name']
       @active_agent_count = data['activeAgentCount']
@@ -107,6 +117,5 @@ module MMS
     def _to_hash
       @data
     end
-
   end
 end

data/lib/mms/resource/host.rb

@@ -2,10 +2,7 @@ module MMS
 
   class Resource::Host < Resource
 
-    @client = nil
-
     attr_accessor :name
-    attr_accessor :group
     attr_accessor :hostname
     attr_accessor :port
     attr_accessor :type_name
@@ -20,22 +17,13 @@ module MMS
     attr_accessor :profiler_enabled
     attr_accessor :logs_enabled
 
-    def initialize(client, data)
-      id = data['id']
-      group_id = data['groupId']
-
-      raise MMS::ResourceError.new('`Id` for host resource must be defined', self) if id.nil?
-      raise MMS::ResourceError.new('`groupId` for host resource must be defined', self) if group_id.nil?
-
-      @client = client
-
-      @group = MMS::Resource::Group.new(client, {'id' => group_id})
-
-      super id, data
+    # @return [MMS::Resource::Group]
+    def group
+      MMS::Resource::Group.find(@client, @data['groupId'])
     end
 
     def table_row
-      [@group.name, @type_name, @name, @ip_address, @port, @last_ping, @alerts_enabled, @id, @shard_name, @replicaset_name]
+      [group.name, @type_name, @name, @ip_address, @port, @last_ping, @alerts_enabled, @id, @shard_name, @replicaset_name]
     end
 
     def table_section
@@ -46,12 +34,15 @@ module MMS
       ['Group', 'Type', 'Hostname', 'IP', 'Port', 'Last ping', 'Alerts enabled', 'HostId', 'Shard', 'Replica']
     end
 
-    private
-
-    def _load(id)
-      @client.get '/groups/' + @group.id + '/hosts/' + id.to_s
+    # @param [MMS::Client] client
+    # @param [String] group_id
+    # @param [String] id
+    def self._find(client, group_id, id)
+      client.get('/groups/' + group_id + '/hosts/' + id)
     end
 
+    private
+
     def _from_hash(data)
       @hostname = data['hostname']
       @port = data['port']

data/lib/mms/resource/restore_job.rb

@@ -4,13 +4,8 @@ module MMS
 
   class Resource::RestoreJob < Resource
 
-    @client = nil
-
     attr_accessor :name
 
-    # this is restore point cluster e.g full cluster (configs, replicas)
-    attr_accessor :cluster
-
     # this is source point from where RestoreJob was created
     # RestoreJob.snapshot.cluster is e.g replica, config server
     # RestoreJob.cluster is full cluster group (configs, replicas)
@@ -25,22 +20,22 @@ module MMS
     attr_accessor :delivery_status_name
     attr_accessor :delivery_url
 
-    def initialize(client, data)
-      id = data['id']
-      cluster_id = data['clusterId']
-      group_id = data['groupId']
-
-      raise MMS::ResourceError.new('`Id` for restorejob resource must be defined', self) if id.nil?
-      raise MMS::ResourceError.new('`clusterId` for restorejob resource must be defined', self) if cluster_id.nil?
-      raise MMS::ResourceError.new('`groupId` for restorejob resource must be defined', self) if group_id.nil?
-
-      @client = client
-
-      @cluster = MMS::Resource::Cluster.new(client, {'id' => cluster_id, 'groupId' => group_id})
-
-      super id, data
+    # @return [MMS::Resource::Cluster]
+    def cluster
+      begin
+        cluster = MMS::Resource::Cluster.find(@client, @data['groupId'], @data['clusterId'])
+      rescue
+        # Workaround
+        # time to time the mms-api return data without "clusterId" defined
+        # creation of empty clluster instance is a good solution here.
+        cluster = MMS::Resource::Cluster.new
+        cluster.set_client(@client)
+        cluster.set_data({'groupId' => @data['groupId']})
+      end
+      cluster
     end
 
+    # @return [TrueClass, FalseClass]
     def has_cluster
       # cluster definition for config-server cannot be loaded
       # as there is no clusterId for this type of group.
@@ -49,11 +44,12 @@ module MMS
       snapshot != nil
     end
 
+    # @return [MMS::Resource::Snapshot]
     def snapshot
       # snapshot details for config-server cannot be loaded
       # as there is no clusterId. See also has_cluster()
       if @snapshot.nil?
-        @snapshot = @cluster.group.findSnapshot(@snapshot_id)
+        @snapshot = cluster.group.find_snapshot(@snapshot_id)
       end
       @snapshot
     end
@@ -66,8 +62,8 @@ module MMS
     def table_section
       [
           table_row,
-          [@id, "#{@cluster.name} (#{@cluster.id})", {:value => '', :colspan => 5}],
-          ['', @cluster.group.name, {:value => '', :colspan => 5}],
+          [@id, "#{cluster.name} (#{cluster.id})", {:value => '', :colspan => 5}],
+          ['', cluster.group.name, {:value => '', :colspan => 5}],
           [{:value => 'download url:', :colspan => 7}],
           [{:value => @delivery_url || '(waiting for link)', :colspan => 7}],
           :separator
@@ -78,20 +74,21 @@ module MMS
       ['Timestamp / RestoreId', 'SnapshotId / Cluster / Group', 'Name (created)', 'Status', 'Point in time', 'Delivery', 'Restore status']
     end
 
-    private
+    # @return [Hash, NilClass]
+    def self.find_recursively(client, group_id, cluster_id, id)
+      cluster = MMS::Resource::Cluster.find(client, group_id, cluster_id)
+      # config server has no cluster but owns RestoreJob and Snapshot
+      restore_jobs = cluster.restorejobs
+      job = restore_jobs.select { |restorejob| restorejob.id == id }
+      job.first.data unless job.nil? and job.empty?
+    end
 
-    def _load(id)
-      if has_cluster
-        data = @client.get '/groups/' + snapshot.cluster.group.id + '/clusters/' + snapshot.cluster.id + '/restoreJobs/' + id.to_s
-      else
-        # config server has no cluster but owns RestoreJob and Snapshot
-        restore_jobs = @cluster.restorejobs
-        job = restore_jobs.select { |restorejob| restorejob.id == id }
-        data = job.first.data unless job.nil? and job.empty?
-      end
-      data
+    def self._find(client, group_id, cluster_id, id)
+      client.get('/groups/' + group_id + '/clusters/' + cluster_id + '/restoreJobs/' + id)
     end
 
+    private
+
     def _from_hash(data)
       @snapshot_id = data['snapshotId']
       @created = data['created']
@@ -107,6 +104,5 @@ module MMS
     def _to_hash
       @data
     end
-
   end
 end

data/lib/mms/resource/snapshot.rb

@@ -4,10 +4,7 @@ module MMS
 
   class Resource::Snapshot < Resource
 
-    @client = nil
-
     attr_accessor :name
-    attr_accessor :cluster
 
     attr_accessor :complete
     attr_accessor :created_date
@@ -15,46 +12,37 @@ module MMS
     attr_accessor :expires
     attr_accessor :parts
 
-    def initialize(client, data)
-      id = data['id']
-      cluster_id = data['clusterId']
-      group_id = data['groupId']
-
-      raise MMS::ResourceError.new('`Id` for restorejob resource must be defined', self) if id.nil?
-      raise MMS::ResourceError.new('`clusterId` for restorejob resource must be defined', self) if cluster_id.nil?
-      raise MMS::ResourceError.new('`groupId` for restorejob resource must be defined', self) if group_id.nil?
-
-      @client = client
-
-      @cluster = MMS::Resource::Cluster.new(client, {'id' => cluster_id, 'groupId' => group_id})
-
-      super id, data
-    end
-
+    # @return [TrueClass, FalseClass]
     def is_cluster
       @parts.length > 1
     end
 
+    # @return [TrueClass, FalseClass]
     def is_config
       @parts.length == 1 and @parts.first['typeName'] == 'CONFIG_SERVER'
     end
 
+    # @return [TrueClass, FalseClass]
     def is_replica
       @parts.length == 1 and @parts.first['typeName'] == 'REPLICA_SET'
     end
 
+    # @return [String, NilClass]
     def cluster_name
-      @cluster.name if is_cluster
+      cluster.name if is_cluster
     end
 
+    # @return [String, NilClass]
     def config_name
       'config' if is_config
     end
 
+    # @return [String, NilClass]
     def replica_name
       @parts.first['replicaSetName'] if is_replica
     end
 
+    # @return [String, NilClass]
     def source_name
       name = nil
       name = replica_name if is_replica
@@ -63,9 +51,15 @@ module MMS
       name
     end
 
+    # @return [MMS::Resource::Cluster]
+    def cluster
+      MMS::Resource::Cluster.find(@client, @data['groupId'], @data['clusterId'])
+    end
+
+    # @return [Array<MMS::Resource::RestoreJob>]
     def create_restorejob
       data = {:snapshotId => @id}
-      jobs = @client.post '/groups/' + @cluster.group.id + '/clusters/' + @cluster.id + '/restoreJobs', data
+      jobs = @client.post '/groups/' + cluster.group.id + '/clusters/' + cluster.id + '/restoreJobs', data
 
       if jobs.nil?
         raise MMS::ResourceError.new("Cannot create job from snapshot `#{self.id}`", self)
@@ -74,7 +68,7 @@ module MMS
       job_list = []
       # work around due to bug in MMS API; cannot read restoreJob using provided info.
       # The config-server RestoreJob and Snapshot has no own ClusterId to be accessed.
-      restore_jobs = @cluster.restorejobs
+      restore_jobs = cluster.restorejobs
       jobs.each do |job|
         _list = restore_jobs.select { |restorejob| restorejob.id == job['id'] }
         _list.each do |restorejob|
@@ -85,7 +79,7 @@ module MMS
     end
 
     def table_row
-      [@cluster.group.name, @cluster.name, @id, @complete, @created_increment, @name, @expires]
+      [cluster.group.name, cluster.name, @id, @complete, @created_increment, @name, @expires]
     end
 
     def table_section
@@ -106,12 +100,17 @@ module MMS
       ['Group', 'Cluster', 'SnapshotId', 'Complete', 'Created increment', 'Name (created date)', 'Expires']
     end
 
-    private
-
-    def _load(id)
-      @client.get '/groups/' + @cluster.group.id + '/clusters/' + @cluster.id + '/snapshots/' + id.to_s
+    # @param [MMS::Client] client
+    # @param [String] group_id
+    # @param [String] cluster_id
+    # @param [String] id
+    # @return [MMS::Resource::Snapshot]
+    def self._find(client, group_id, cluster_id, id)
+      client.get('/groups/' + group_id + '/clusters/' + cluster_id + '/snapshots/' + id.to_s)
     end
 
+    private
+
     def _from_hash(data)
       @complete = data['complete']
       @created_date = data['created'].nil? ? nil : data['created']['date']
@@ -119,8 +118,6 @@ module MMS
       @expires = data['expires']
       @parts = data['parts']
       @name = @created_date.nil? ? @id : DateTime.parse(@created_date).strftime("%Y-%m-%d %H:%M:%S")
-
-      @cluster = MMS::Resource::Cluster.new(@client, {'id' => data['clusterId'], 'groupId' => data['groupId']})
     end
 
     def _to_hash

data/lib/mms/resource/snapshot_schedule.rb

@@ -0,0 +1,60 @@
+module MMS
+
+  class Resource::SnapshotSchedule < Resource
+
+    attr_accessor :name
+
+    attr_accessor :snapshot_interval_hours
+    attr_accessor :snapshot_retention_days
+    attr_accessor :cluster_checkpoint_interval_min
+    attr_accessor :daily_snapshot_retention_days
+    attr_accessor :weekly_snapshot_retention_weeks
+    attr_accessor :monthly_snapshot_retention_months
+
+    # @return [MMS::Resource::Cluster]
+    def cluster
+      MMS::Resource::Cluster.find(@client, @data['groupId'], @data['clusterId'])
+    end
+
+    def table_row
+      [
+          cluster.group.name,
+          cluster.name,
+          @snapshot_interval_hours,
+          @snapshot_retention_days,
+          @cluster_checkpoint_interval_min,
+          @daily_snapshot_retention_days,
+          @weekly_snapshot_retention_weeks,
+          @monthly_snapshot_retention_months,
+      ]
+    end
+
+    def table_section
+      [table_row]
+    end
+
+    def self.table_header
+      ['Group', 'Cluster', 'IntervalHours', 'RetentionDays', 'CheckpointIntervalMin', 'RetentionDays', 'RetentionWeeks', 'RetentionMonths']
+    end
+
+    def self._find(client, group_id, cluster_id)
+      client.get('/groups/' + group_id + '/backupConfigs/' + cluster_id + '/snapshotSchedule')
+    end
+
+    private
+
+    def _from_hash(data)
+      @snapshot_interval_hours = data['snapshotIntervalHours']
+      @snapshot_retention_days = data['snapshotRetentionDays']
+      @cluster_checkpoint_interval_min = data['clusterCheckpointIntervalMin']
+      @daily_snapshot_retention_days = data['dailySnapshotRetentionDays']
+      @weekly_snapshot_retention_weeks = data['weeklySnapshotRetentionWeeks']
+      @monthly_snapshot_retention_months = data['monthlySnapshotRetentionMonths']
+    end
+
+    def _to_hash
+      @data
+    end
+
+  end
+end

data/lib/mms/version.rb

@@ -1,3 +1,3 @@
 module MMS
-  VERSION = '0.0.10'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mms-api
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.1.0
 platform: ruby
 authors:
 - Cargo Media
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-06 00:00:00.000000000 Z
+date: 2015-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http-digest_auth
@@ -120,6 +120,7 @@ files:
 - lib/mms/resource/host.rb
 - lib/mms/resource/restore_job.rb
 - lib/mms/resource/snapshot.rb
+- lib/mms/resource/snapshot_schedule.rb
 - lib/mms/version.rb
 homepage: https://github.com/cargomedia/mms-api
 licenses:
@@ -146,3 +147,4 @@ signing_key:
 specification_version: 4
 summary: MongoDB MMS API client
 test_files: []
+has_rdoc: