mms-api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91354b2007ab1bf12006b201e465bbc64c7c4e73
-  data.tar.gz: 0c1fdc6932a86acdc3f3f41061f2dcb8782bd612
+  metadata.gz: 0f46973360a5bc90648f5db16ed68f2a715df24f
+  data.tar.gz: 87a3cdbe52ea77dd5b1778d8df9318a2b34734e6
 SHA512:
-  metadata.gz: 78d3bde92f63163a64454077f6edee97d82619458c3329f9ba5fa6f84eb2414a04452b46be57f3d0d8fabb9a9862fe2cc67ff48919c90433641b9bd621660479
-  data.tar.gz: e0210ba968b2d67ba035700b952b67445c896ab9b849ba1e1d9899369f18286b57c8d11aa45301de47d02a8cd6eb95815bb17b7e35819092c2f4712be82ff640
+  metadata.gz: 34e98f586c2a03de4ea3260a11f22fba361e93407de77f740f0f12b5c2a79144befb8ed1343ccff7143f3fed09238fd048c4415d7915a69115bb14ca4be823b1
+  data.tar.gz: 2cbf2343574237b3814aae43a47815591d0b5cf773da2555ceb08271b4836cb50442c437b1a38b9a5af6f76b1589b6be88e73d7c92bc4abfb61eea1a7f26b2e5

data/README.md

@@ -12,35 +12,91 @@ 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| + | + | | | | |
-|Alerts| + | + | | | | |
-|Restore Jobs| + | + | + | | | |
-
-Config
-------
+|Resource     |Get All |Get One |Create |Update |Delete |
+|:------------|:------:|:------:|:-----:|:-----:|:-----:|
+|Groups       | +      | +      |       |       |       |
+|Hosts        | +      | +      |       |       |       |
+|Clusters     | +      | +      |       |       |       |
+|Snapshots    | +      | +      |       |       |       |
+|Alerts       | +      | +      |       |       |       |
+|Restore Jobs | +      | +      | +     |       |       |
+
+Library usage
+-------------
+
+Source code itself is well-documented so when writing code it should auto-complete and hint in all supported usages.
+
+
+### Client
+Most important part of the api is client. In order to make any request you need to instantiate client with correct params.
+
 ```ruby
-config = MMS::Config.new
+client = MMS::Client.new('username', 'api_key')
 ```
 
-Client
-------
+This client is used by all other classes connecting to api no matter if it's Resource or helper class like Agent.
+
+
+### Agent
+Agent is simple wrapper class for listing all accessible resources.
+
 ```ruby
-client = MMS::Client.new(config.username, config.apikey)
+client = MMS::Client.new('username', 'api_key')
+agent = MMS::Agent.new(client)
+
+agent.alerts.each do |alert|
+    alert.ack('now')
+end
 ```
 
-Agent
------
+List of resource-listing agent methods:
+- groups
+- hosts
+- clusters
+- snapshots
+- alerts
+- restorejobs
+
+### Resources
+
+You can find lists of resource by using agent as pointed above, or by various resource methods.
+Each resource have a find method loading certain resource with provided id (plus corresponding parent ids), e.g.
 ```ruby
-agent = MMS::Agent.new(client)
+client = new MMS::Client.new('username', 'api_key')
+host = MMS::Resource::Host.find(client, 'group_id', 'host_id')
+```
+
+Additionally some resources have additional instance methods to retrieve sub-resources, e.g.
+```ruby
+client = new MMS::Client.new('username', 'api_key')
+group = MMS::Resource::Group.find(client, 'group_id')
+hosts = group.hosts
+```
+
+Cli usage
+---------
+
+There is a built-in cli with several commands retrieving api resource lists.
+
+### Configuration
+
+Cli uses configuration with all values set to default ones.
+Config itself has `config_file` property which merges itself with params from the file.
+By default `config_file` points to home directory, but it can be changed to points to any file.
+
+```
+username=sysadmin@example.tld
+apikey=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+apiurl=https://mms.mydomain.tld/api/public/v1.0
+default_group_id=your-group-id
+default_cluster_id=your-cluster-id
 ```
 
-Cli
----
+Additionally some options can be modified using cli options.
+
+### Available commands
+
+
 ```bash
 $ mms-api --help
 Usage:
@@ -71,13 +127,3 @@ Options:
     -j, --json                    Print JSON output (default: false)
     -l, --limit <integer>         Limit for result items
 ```
-
-`mms-api` reads default configuration from your home directory `~/.mms-api`. Example configuration:
-
-```
-username=sysadmin@example.tld
-apikey=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
-# apiurl=https://mms.mydomain.tld/api/public/v1.0
-default_group_id=your-group-id
-default_cluster_id=your-cluster-id
-```

data/lib/mms/resource.rb

@@ -16,8 +16,7 @@ module MMS
     def set_data(data)
       @data = data
       from_hash(data)
-      cache_key = "Class::#{self.class.name}:#{@id}"
-      MMS::Cache.instance.set(cache_key, data)
+      MMS::Cache.instance.set(cache_key(@id), data)
     end
 
     # @param [Hash] data
@@ -61,11 +60,15 @@ module MMS
       raise("`#{__method__}` is not implemented for `#{self.class.name}`")
     end
 
+    def invalidate_cache
+      MMS::Cache.instance.delete(cache_key(@id))
+    end
+
     # @param [MMS::Client] client
     # @param arguments...
     # @return self
     def self.find(client, *arguments)
-      cache_key = "Class::#{self.name}:#{arguments.last()}"
+      cache_key = self.cache_key(arguments.last())
       data = MMS::Cache.instance.get(cache_key)
       unless data
         data = self._find(client, *arguments)
@@ -76,5 +79,16 @@ module MMS
       resource.set_data(data)
       resource
     end
+
+    private
+
+    def cache_key(id)
+      "Class::#{self.class.name}:#{id}"
+    end
+
+    def self.cache_key(id)
+      "Class::#{self.name}:#{id}"
+    end
+
   end
 end

data/lib/mms/resource/cluster.rb

@@ -45,12 +45,8 @@ module MMS
       if @restorejobs.empty?
         @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.find_snapshot(job['snapshotId'])
-            job['clusterId'] = snapshot.cluster.id unless snapshot.nil?
-          end
+          job['clusterId'] = @id
+          job['groupId'] = group.id
 
           j = MMS::Resource::RestoreJob.new
           j.set_client(@client)
@@ -66,42 +62,23 @@ module MMS
     # @return [Array<MMS::Resource::RestoreJob>]
     def create_restorejob(point_in_time = nil)
       data = {
-          'timestamp' => {
-              'date' => point_in_time,
-              'increment' => 0
-          }
+        'timestamp' => {
+          'date' => point_in_time,
+          'increment' => 0
+        }
       }
-      jobs = @client.post('/groups/' + group.id + '/clusters/' + @id + '/restoreJobs', data)
+      job_data_list = @client.post('/groups/' + group.id + '/clusters/' + @id + '/restoreJobs', data)
 
-      if jobs.nil?
+      if job_data_list.nil?
         raise MMS::ResourceError.new("Cannot create job from snapshot `#{self.id}`", self)
       end
 
-      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.
-      tries = 5
-      while tries > 0
-        begin
-          restore_jobs = restorejobs
-          tries = 0
-        rescue Exception => e
-          tries-=1;
-          raise MMS::ResourceError.new(e.message, self) if tries < 1
-
-          STDERR.puts e.message
-          STDERR.puts 'Sleeping for 5 seconds. Trying again...'
-          sleep(5)
-        end
-      end
-
-      jobs.each do |job|
-        _list = restore_jobs.select { |restorejob| restorejob.id == job['id'] }
-        _list.each do |restorejob|
-          job_list.push restorejob
-        end
+      job_data_list.map do |job_data|
+        j = MMS::Resource::RestoreJob.new
+        j.set_client(@client)
+        j.set_data(job_data)
+        j
       end
-      job_list
     end
 
     def table_row

data/lib/mms/resource/group.rb

@@ -74,15 +74,15 @@ module MMS
     end
 
     # @param [String] id
-    # @return [MMS::Resource::Snapshot]
+    # @return [MMS::Resource::Snapshot, NilClass]
     def find_snapshot(id)
       snapshot = nil
       clusters.each do |cluster|
         begin
           snapshot = cluster.snapshot(id)
-        rescue => e
-          # STDERR.puts 'cannot load snapshotId for cluster if config-server is the source!'
-          # STDERR.puts 'not supported in current MMS API version'
+          break unless snapshot.nil?
+        rescue MMS::ApiError => e
+          # Snapshot is not available on this cluster. Skip it!
         end
       end
       snapshot

data/lib/mms/resource/restore_job.rb

@@ -20,38 +20,17 @@ module MMS
     attr_accessor :delivery_status_name
     attr_accessor :delivery_url
 
+    attr_accessor :cluster_id
+    attr_accessor :group_id
+
     # @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
+      MMS::Resource::Cluster.find(@client, @group_id, @cluster_id)
     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.
-      # there is snapshotId for RestoreJob but seems to be stored
-      # internally in MMS API. Not accessible by public API.
-      snapshot != nil
-    end
-
-    # @return [MMS::Resource::Snapshot]
+    # @return [MMS::Resource::Snapshot, NilClass]
     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.find_snapshot(@snapshot_id)
-      end
-      @snapshot
+      @snapshot ||= cluster.group.find_snapshot(@snapshot_id)
     end
 
     def table_row
@@ -61,12 +40,12 @@ module MMS
 
     def table_section
       [
-          table_row,
-          [@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
+        table_row,
+        [@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
       ]
     end
 
@@ -74,17 +53,22 @@ module MMS
       ['Timestamp / RestoreId', 'SnapshotId / Cluster / Group', 'Name (created)', 'Status', 'Point in time', 'Delivery', 'Restore status']
     end
 
-    # @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?
+    def self._find(client, group_id, cluster_id, id)
+      begin
+        client.get('/groups/' + group_id + '/clusters/' + cluster_id + '/restoreJobs/' + id)
+      rescue MMS::ApiError => e
+        # workaround for https://jira.mongodb.org/browse/DOCS-5017
+        self._find_from_list(client, group_id, cluster_id, id)
+      end
     end
 
-    def self._find(client, group_id, cluster_id, id)
-      client.get('/groups/' + group_id + '/clusters/' + cluster_id + '/restoreJobs/' + id)
+    def self._find_from_list(client, group_id, cluster_id, id)
+      cluster = MMS::Resource::Cluster.find(client, group_id, cluster_id)
+
+      job = cluster.restorejobs.find { |restorejob| restorejob.id == id }
+      raise("Cannot find RestoreJob id `#{id}`") if job.nil?
+
+      job.data
     end
 
     private
@@ -99,6 +83,8 @@ module MMS
       @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")
+      @cluster_id = data['clusterId']
+      @group_id = data['groupId']
     end
 
     def _to_hash

data/lib/mms/resource/snapshot.rb

@@ -11,6 +11,7 @@ module MMS
     attr_accessor :created_increment
     attr_accessor :expires
     attr_accessor :parts
+    attr_accessor :is_possibly_inconsistent
 
     # @return [TrueClass, FalseClass]
     def is_cluster
@@ -59,27 +60,22 @@ module MMS
     # @return [Array<MMS::Resource::RestoreJob>]
     def create_restorejob
       data = {:snapshotId => @id}
-      jobs = @client.post '/groups/' + cluster.group.id + '/clusters/' + cluster.id + '/restoreJobs', data
+      job_data_list = @client.post '/groups/' + cluster.group.id + '/clusters/' + cluster.id + '/restoreJobs', data
 
-      if jobs.nil?
+      if job_data_list.nil?
         raise MMS::ResourceError.new("Cannot create job from snapshot `#{self.id}`", self)
       end
 
-      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|
-          job_list.push restorejob
-        end
+      job_data_list.map do |job_data|
+        j = MMS::Resource::RestoreJob.new
+        j.set_client(@client)
+        j.set_data(job_data)
+        j
       end
-      job_list
     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, @is_possibly_inconsistent]
     end
 
     def table_section
@@ -97,7 +93,7 @@ module MMS
     end
 
     def self.table_header
-      ['Group', 'Cluster', 'SnapshotId', 'Complete', 'Created increment', 'Name (created date)', 'Expires']
+      ['Group', 'Cluster', 'SnapshotId', 'Complete', 'Created increment', 'Name (created date)', 'Expires', 'Inconsistent']
     end
 
     # @param [MMS::Client] client
@@ -117,6 +113,7 @@ module MMS
       @created_increment = data['created'].nil? ? nil : data['created']['increment']
       @expires = data['expires']
       @parts = data['parts']
+      @is_possibly_inconsistent = data['isPossiblyInconsistent']
       @name = @created_date.nil? ? @id : DateTime.parse(@created_date).strftime("%Y-%m-%d %H:%M:%S")
     end
 

data/lib/mms/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mms-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Cargo Media
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-20 00:00:00.000000000 Z
+date: 2015-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http-digest_auth
@@ -142,9 +142,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: MongoDB MMS API client
 test_files: []
-has_rdoc: