mms-api 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9f237818d6e0c66e6511c157bbd76e0339c0a76
-  data.tar.gz: 8dd890ae570320a80c0bd084ca81a2c5c5af5900
+  metadata.gz: dcfd755e463ac666d8e74d34a431c3717b077740
+  data.tar.gz: 729f27cc6f767df07686fbaae459636e489c2561
 SHA512:
-  metadata.gz: d4de5e93a356694501f7a7a6948e16243f967f84d50485cb58a425302425526b320d640baa604312c486e9d01e6e89644153d7855d74570c71b8fc6c3cbc1847
-  data.tar.gz: 2ff3507c8107f1811e440479d53259bda028a9150b3a135aa8d65c960cf861b6c97e1d0f21f1b6c8314978929d29497afcb4c279b007626cd78a20b837d88135
+  metadata.gz: cfe42349fbce3d933b355a92c173bbdde3cc6852fdcdac9141658eba1b05419f22e150dd9538b2ef4150ac06ecf55658f7f691ef512db1046cbca2d5752aae9e
+  data.tar.gz: 010ec281cb1a8251c3950b92d724208e0bcb1ad208a34ce6635102b8e17917a49c382460d1e618fc661d7a3787316d7e372e082790fbde7c05fcc2c3a0d397fd

data/README.md

@@ -32,8 +32,21 @@ Options:
     -h, --help                        Show this help
 ```
 
-Development
------------
+API coverage
+------------
+The MMS Public API follows the principles of the REST architectural style to expose a number of internal resources which enable programmatic access to [MMS’s features](http://mms.mongodb.com/help/reference/api/). Current implementation support only a few of API features.
+
+|Resource|Get All|Get One|Create|Update|Delete|
+|:---|:---:|:---:|:---:|:---:|:---:|
+|Groups| + | + | | | | |
+|Hosts| + | + | | | | |
+|Clusters| + | + | | | | |
+|Snapshots| + | + | | | | |
+|Restore Jobs| + | + | + | | | |
+
+
+Example
+-------
 ```ruby
 require 'mms'
 

data/bin/mms-api

@@ -89,14 +89,14 @@ begin
         rows << [group.name, group.active_agent_count, group.replicaset_count, group.shard_count, group.last_active_agent, group.id]
       end
     when 'hosts'
-      heading = ['Group', 'Type', 'Hostname', 'IP', 'Port', 'Last ping', 'Alerts enabled', 'HostId']
+      heading = ['Group', 'Type', 'Hostname', 'IP', 'Port', 'Last ping', 'Alerts enabled', 'HostId', 'Shard', 'Replica']
       results.each do |host|
-        rows << [host.group.name, host.type_name, host.name, host.ip_address, host.port, host.last_ping, host.alerts_enabled, host.id]
+        rows << [host.group.name, host.type_name, host.name, host.ip_address, host.port, host.last_ping, host.alerts_enabled, host.id, host.shard_name, host.replicaset_name]
       end
     when 'clusters'
-      heading = ['Group', 'Cluster', 'Shard name', 'Replica name', 'Type', 'Last heartbeat']
+      heading = ['Group', 'Cluster', 'Shard name', 'Replica name', 'Type', 'Last heartbeat', 'Cluster Id']
       results.each do |cluster|
-        rows << [cluster.group.name, cluster.name, cluster.shard_name, cluster.replicaset_name, cluster.type_name, cluster.last_heartbeat]
+        rows << [cluster.group.name, cluster.name, cluster.shard_name, cluster.replicaset_name, cluster.type_name, cluster.last_heartbeat, cluster.id]
       end
     when 'snapshots'
       heading = ['Group', 'Cluster', 'SnapshotId', 'Complete', 'Created increment', 'Name (created date)', 'Expires']

data/lib/mms/resource.rb

@@ -19,6 +19,11 @@ module MMS
       end
     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}"
 

data/lib/mms/resource/cluster.rb

@@ -9,30 +9,38 @@ module MMS
     attr_accessor :type_name
     attr_accessor :last_heartbeat
 
+    attr_accessor :snapshots
+    attr_accessor :restorejobs
+
     def initialize(id, group_id, data = nil)
+      @snapshots = []
+      @restorejobs = []
+
       @group = MMS::Resource::Group.new(group_id)
 
       super id, data
     end
 
     def snapshot(id)
-      MMS::Resource::Snapshot.new id, self.id, self.group.id
+      MMS::Resource::Snapshot.new id, @id, @group.id
     end
 
     def snapshots(page = 1, limit = 1000)
-      snapshot_list = []
-      MMS::Client.instance.get('/groups/' + @group.id + '/clusters/' + @id + '/snapshots?pageNum=' + page.to_s + '&itemsPerPage=' + limit.to_s).each do |snapshot|
-        snapshot_list.push MMS::Resource::Snapshot.new(snapshot['id'], snapshot['clusterId'], snapshot['groupId'], snapshot)
+      if @snapshots.empty?
+        MMS::Client.instance.get('/groups/' + @group.id + '/clusters/' + @id + '/snapshots?pageNum=' + page.to_s + '&itemsPerPage=' + limit.to_s).each do |snapshot|
+          @snapshots.push MMS::Resource::Snapshot.new(snapshot['id'], snapshot['clusterId'], snapshot['groupId'], snapshot)
+        end
       end
-      snapshot_list
+      @snapshots
     end
 
     def restorejobs(page = 1, limit = 1000)
-      job_list = []
-      MMS::Client.instance.get('/groups/' + @group.id + '/clusters/' + @id + '/restoreJobs?pageNum=' + page.to_s + '&itemsPerPage=' + limit.to_s).each do |job|
-        job_list.push MMS::Resource::RestoreJob.new(job['id'], job['clusterId'], job['groupId'], job)
+      if @restorejobs.empty?
+        MMS::Client.instance.get('/groups/' + @group.id + '/clusters/' + @id + '/restoreJobs?pageNum=' + page.to_s + '&itemsPerPage=' + limit.to_s).each do |job|
+          @restorejobs.push MMS::Resource::RestoreJob.new(job['id'], job['clusterId'], job['groupId'], job)
+        end
       end
-      job_list
+      @restorejobs
     end
 
     def _load(id)

data/lib/mms/resource/group.rb

@@ -8,7 +8,11 @@ module MMS
     attr_reader :shard_count
     attr_reader :last_active_agent
 
+    attr_accessor :clusters
+
     def initialize(id, data = nil)
+      @clusters = []
+
       super id, data
     end
 
@@ -21,15 +25,29 @@ module MMS
     end
 
     def clusters(page = 1, limit = 1000)
-      cluster_list = []
-      MMS::Client.instance.get('/groups/' + @id + '/clusters?pageNum=' + page.to_s + '&itemsPerPage=' + limit.to_s).each do |cluster|
-        cluster_list.push MMS::Resource::Cluster.new(cluster['id'], cluster['groupId'], cluster)
+      if @clusters.empty?
+        MMS::Client.instance.get('/groups/' + @id + '/clusters?pageNum=' + page.to_s + '&itemsPerPage=' + limit.to_s).each do |cluster|
+          @clusters.push MMS::Resource::Cluster.new(cluster['id'], cluster['groupId'], cluster)
+        end
       end
-      cluster_list
+      @clusters
     end
 
     def cluster(id)
-      MMS::Resource::Cluster.new id, self.id
+      MMS::Resource::Cluster.new id, @id
+    end
+
+    def findSnapshot(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
+        end
+      end
+      snapshot
     end
 
     def _load(id)

data/lib/mms/resource/host.rb

@@ -14,6 +14,9 @@ module MMS
     attr_accessor :replicaset_name
     attr_accessor :replica_state_name
     attr_accessor :alerts_enabled
+    attr_accessor :host_enabled
+    attr_accessor :profiler_enabled
+    attr_accessor :logs_enabled
 
     def initialize(id, group_id, data = nil)
       @group = MMS::Resource::Group.new(group_id)
@@ -36,6 +39,9 @@ module MMS
       @replicaset_name = data['replicaSetName']
       @replica_state_name = data['replicaStateName']
       @alerts_enabled = data['alertsEnabled']
+      @host_enabled = data['hostEnabled']
+      @profiler_enabled = data['profilerEnabled']
+      @logs_enabled = data['logsEnabled']
       @name = @hostname
     end
   end

data/lib/mms/resource/restore_job.rb

@@ -5,8 +5,15 @@ module MMS
   class Resource::RestoreJob < Resource
 
     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)
+    attr_accessor :snapshot
+
     attr_accessor :snapshot_id
     attr_accessor :created
     attr_accessor :status_name
@@ -21,8 +28,33 @@ module MMS
       super id, data
     end
 
+    def has_cluster
+      # cluster definition for config-server cannot be loaded
+      # as there is no clusterId for this type of group.
+      # there is snapshotId for RestoreJob but seems to be stored
+      # internally in MMS API. Not accessible by public API.
+      snapshot != nil
+    end
+
+    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)
+      end
+      @snapshot
+    end
+
     def _load(id)
-      MMS::Client.instance.get '/groups/' + @cluster.group.id + '/clusters/' + @cluster.id + '/restoreJobs/' + id.to_s
+      if has_cluster
+        data = MMS::Client.instance.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
     end
 
     def _from_hash(data)
@@ -30,9 +62,9 @@ module MMS
       @created = data['created']
       @status_name = data['statusName']
       @point_in_time = data['pointInTime']
-      @delivery_method_name = data['delivery']['methodName']
-      @delivery_status_name = data['delivery']['statusName']
-      @delivery_url = data['delivery']['url']
+      @delivery_method_name = data['delivery']['methodName'] unless data['delivery'].nil?
+      @delivery_status_name = data['delivery']['statusName'] unless data['delivery'].nil?
+      @delivery_url = data['delivery']['url'] unless data['delivery'].nil?
       @name = DateTime.parse(@created).strftime("%Y-%m-%d %H:%M:%S")
     end
   end

data/lib/mms/resource/snapshot.rb

@@ -19,8 +19,36 @@ module MMS
       super id, data
     end
 
-    def _load(id)
-      MMS::Client.instance.get '/groups/' + @cluster.group.id + '/clusters/' + @cluster.id + '/snapshots/' + id.to_s
+    def is_cluster
+      @parts.length > 1
+    end
+
+    def is_config
+      @parts.length == 1 and @parts.first['typeName'] == 'CONFIG_SERVER'
+    end
+
+    def is_replica
+      @parts.length == 1 and @parts.first['typeName'] == 'REPLICA_SET'
+    end
+
+    def cluster_name
+      @cluster.name if is_cluster
+    end
+
+    def config_name
+      'config' if is_config
+    end
+
+    def replica_name
+      @parts.first['replicaSetName'] if is_replica
+    end
+
+    def source_name
+      name = nil
+      name = replica_name if is_replica
+      name = config_name if is_config
+      name = cluster_name if is_cluster
+      name
     end
 
     def create_restorejob
@@ -33,21 +61,21 @@ 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
-
       jobs.each do |job|
         _list = restore_jobs.select {|restorejob| restorejob.id == job['id'] }
         _list.each do |restorejob|
-          begin
-            job_list.push MMS::Resource::RestoreJob.new(restorejob.id, restorejob.cluster.id, restorejob.cluster.group.id)
-          rescue => e
-            puts "load error #{e.message}"
-          end
+          job_list.push restorejob
         end
       end
       job_list
     end
 
+    def _load(id)
+      MMS::Client.instance.get '/groups/' + @cluster.group.id + '/clusters/' + @cluster.id + '/snapshots/' + id.to_s
+    end
+
     def _from_hash(data)
       @complete = data['complete']
       @created_date = data['created']['date']
@@ -55,6 +83,8 @@ module MMS
       @expires = data['expires']
       @parts = data['parts']
       @name = DateTime.parse(@created_date).strftime("%Y-%m-%d %H:%M:%S")
+
+      @cluster = MMS::Resource::Cluster.new data['clusterId'], data['groupId']
     end
   end
 end

data/lib/mms/version.rb

@@ -1,3 +1,3 @@
 module MMS
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mms-api
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Cargo Media
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-27 00:00:00.000000000 Z
+date: 2014-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http-digest_auth