marathon-api 1.2.5 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2bcd9ae14a3459ba8f19f3be38d2f1aa5bdb5746
-  data.tar.gz: d3c3091fcdc97ecab48f942588bcba2b8cdeed43
+  metadata.gz: d3921a3fe5bd4c9ad4c204cdc19817507e74bfd4
+  data.tar.gz: fa9a7edb2421055296268c1675a6a1af4a164e2d
 SHA512:
-  metadata.gz: c16b9ee84d8b507a4c62c8a29b63e2922be7b519986a513b63331241b3f77a27d7d200e2c29d557a4123bb9ad44f1e9c25e64fd2fb4acc16c1610fbcd6ea8a37
-  data.tar.gz: 487c87de5f3a68325c8f421e4006f86f892166ce694d0c4d603cc024390e252ff2339eea2ceda78bed5893f0cb85fbbaa27c4f216c6cc8b48846abd0a331fefc
+  metadata.gz: 64b24ff2efea7b645643255e82da98d8fb28d73a69ac1f3a7034de3fcaca1960c9c354ee9faf877b145758637caaea975c5b7e3715cd06d67fbf0b4107fad8e0
+  data.tar.gz: b8f95656fe4c1dda9eddb51adea9ec0d7137dc437d9cc17aee50406a87c21e0bee0bd2e913c938080e0eb830a16917da3442288253154266b1c6d81503012258

data/.gitignore

@@ -5,3 +5,4 @@
 Gemfile.lock
 vendor
 coverage/
+.idea

data/lib/marathon.rb

@@ -31,8 +31,56 @@ module Marathon
   require 'marathon/queue'
   require 'marathon/task'
 
+  # Represents an instance of Marathon
+  class MarathonInstance
+    attr_reader :connection
+
+    def initialize(url, options)
+      @connection = Connection.new(url,options)
+    end
+
+    def ping
+      connection.get('/ping')
+    end
+
+    # Get information about the marathon server
+    def info
+      connection.get('/v2/info')
+    end
+
+    def apps
+      Marathon::Apps.new(connection)
+    end
+
+    def deployments
+      Marathon::Deployments.new(connection)
+    end
+
+    def tasks
+      Marathon::Tasks.new(connection)
+    end
+
+    def queues
+      Marathon::Queues.new(connection)
+    end
+
+    def leaders
+      Marathon::Leader.new(connection)
+    end
+
+    def event_subscriptions
+      Marathon::EventSubscriptions.new(connection)
+    end
+
+  end
+
+
   DEFAULT_URL = 'http://localhost:8080'
 
+  attr_reader :singleton
+
+  @singleton = MarathonInstance::new(DEFAULT_URL,{})
+
   # Get the marathon url from environment
   def env_url
     ENV['MARATHON_URL']
@@ -60,36 +108,41 @@ module Marathon
   # Set a new url
   def url=(new_url)
     @url = new_url
-    reset_connection!
+    reset_singleton!
   end
 
   # Set new options
   def options=(new_options)
     @options = env_options.merge(new_options || {})
-    reset_connection!
+    reset_singleton!
   end
 
   # Set a new connection
   def connection
-    @connection ||= Connection.new(url, options)
+    singleton.connection
+  end
+
+
+  def reset_singleton!
+    @singleton = MarathonInstance.new(url,options)
   end
 
-  # Reset the connection
   def reset_connection!
-    @connection = nil
+    reset_singleton!
   end
 
   # Get information about the marathon server
   def info
-    connection.get('/v2/info')
+    singleton.info
   end
 
   # Ping marathon
   def ping
-    connection.get('/ping')
+    singleton.ping
   end
 
   module_function :connection, :env_options, :env_url, :info, :logger, :logger=, :ping,
-                  :options, :options=, :url, :url= ,:reset_connection!
+                  :options, :options=, :url, :url= ,:reset_connection!,:reset_singleton!,:singleton
+
 
 end

data/lib/marathon/app.rb

@@ -168,8 +168,7 @@ Version:    #{version}
     # List the application with id.
     # ++id++: Application's id.
     def get(id)
-      json = Marathon.connection.get("/v2/apps/#{id}")['app']
-      new(json)
+      Marathon.singleton.apps.get(id)
     end
 
     # List all applications.
@@ -179,17 +178,13 @@ Version:    #{version}
     #               "apps.tasks". Apps' tasks are not embedded in the response by default.
     #               "apps.failures". Apps' last failures are not embedded in the response by default.
     def list(cmd = nil, embed = nil)
-      query = {}
-      query[:cmd] = cmd if cmd
-      Marathon::Util.add_choice(query, :embed, embed, %w[apps.tasks apps.failures])
-      json = Marathon.connection.get('/v2/apps', query)['apps']
-      json.map { |j| new(j) }
+      Marathon.singleton.apps.list(cmd,embed)
     end
 
     # Delete the application with id.
     # ++id++: Application's id.
     def delete(id)
-      Marathon.connection.delete("/v2/apps/#{id}")
+      Marathon.singleton.apps.delete(id)
     end
     alias :remove :delete
 
@@ -197,8 +192,7 @@ Version:    #{version}
     # ++hash++: Hash including all attributes
     #           see https://mesosphere.github.io/marathon/docs/rest-api.html#post-/v2/apps for full details
     def start(hash)
-      json = Marathon.connection.post('/v2/apps', nil, :body => hash)
-      new(json)
+      Marathon.singleton.apps.start(hash)
     end
     alias :create :start
 
@@ -207,10 +201,7 @@ Version:    #{version}
     # ++force++: If the app is affected by a running deployment, then the update operation will fail.
     #            The current deployment can be overridden by setting the `force` query parameter.
     def restart(id, force = false)
-      query = {}
-      query[:force] = true if force
-      json = Marathon.connection.post("/v2/apps/#{id}/restart", query)
-      Marathon::DeploymentInfo.new(json)
+      Marathon.singleton.apps.restart(id,force)
     end
 
     # Change parameters of a running application. The new application parameters apply only to subsequently
@@ -220,25 +211,102 @@ Version:    #{version}
     # ++force++: If the app is affected by a running deployment, then the update operation will fail.
     #            The current deployment can be overridden by setting the `force` query parameter.
     def change(id, hash, force = false)
-      query = {}
-      query[:force] = true if force
-      json = Marathon.connection.put("/v2/apps/#{id}", query, :body => hash.merge(:id => id))
-      Marathon::DeploymentInfo.new(json)
+      Marathon.singleton.apps.change(id,hash,force)
     end
 
     # List the versions of the application with id.
     # ++id++: Application id
     def versions(id)
-      json = Marathon.connection.get("/v2/apps/#{id}/versions")
-      json['versions']
+      Marathon.singleton.apps.versions(id)
     end
 
     # List the configuration of the application with id at version.
     # ++id++: Application id
     # ++version++: Version name
     def version(id, version)
-      json = Marathon.connection.get("/v2/apps/#{id}/versions/#{version}")
-      new(json, true)
+      Marathon.singleton.apps.version(id,version)
     end
   end
 end
+
+# This class represents a set of Apps
+class Marathon::Apps
+  def initialize(connection)
+    @connection = connection
+  end
+
+  # List the application with id.
+  # ++id++: Application's id.
+  def get(id)
+    json = @connection.get("/v2/apps/#{id}")['app']
+    Marathon::App.new(json)
+  end
+
+  # Delete the application with id.
+  # ++id++: Application's id.
+  def delete(id)
+    @connection.delete("/v2/apps/#{id}")
+  end
+
+  # Create and start an application.
+  # ++hash++: Hash including all attributes
+  #           see https://mesosphere.github.io/marathon/docs/rest-api.html#post-/v2/apps for full details
+  def start(hash)
+    json = @connection.post('/v2/apps', nil, :body => hash)
+    Marathon::App.new(json)
+  end
+
+  # Restart the application with id.
+  # ++id++: Application's id.
+  # ++force++: If the app is affected by a running deployment, then the update operation will fail.
+  #            The current deployment can be overridden by setting the `force` query parameter.
+  def restart(id, force = false)
+    query = {}
+    query[:force] = true if force
+    json = @connection.post("/v2/apps/#{id}/restart", query)
+    Marathon::DeploymentInfo.new(json)
+  end
+
+  # Change parameters of a running application. The new application parameters apply only to subsequently
+  # created tasks. Currently running tasks are restarted, while maintaining the minimumHealthCapacity.
+  # ++id++: Application's id.
+  # ++hash++: A subset of app's attributes.
+  # ++force++: If the app is affected by a running deployment, then the update operation will fail.
+  #            The current deployment can be overridden by setting the `force` query parameter.
+  def change(id, hash, force = false)
+    query = {}
+    query[:force] = true if force
+    json = @connection.put("/v2/apps/#{id}", query, :body => hash.merge(:id => id))
+    Marathon::DeploymentInfo.new(json)
+  end
+
+  # List the versions of the application with id.
+  # ++id++: Application id
+  def versions(id)
+    json = @connection.get("/v2/apps/#{id}/versions")
+    json['versions']
+  end
+
+  # List the configuration of the application with id at version.
+  # ++id++: Application id
+  # ++version++: Version name
+  def version(id, version)
+    json = @connection.get("/v2/apps/#{id}/versions/#{version}")
+    Marathon::App.new(json, true)
+  end
+
+  # List all applications.
+  # ++:cmd++: Filter apps to only those whose commands contain cmd.
+  # ++:embed++: Embeds nested resources that match the supplied path.
+  #             Possible values:
+  #               "apps.tasks". Apps' tasks are not embedded in the response by default.
+  #               "apps.failures". Apps' last failures are not embedded in the response by default.
+  def list(cmd = nil, embed = nil)
+    query = {}
+    query[:cmd] = cmd if cmd
+    Marathon::Util.add_choice(query, :embed, embed, %w[apps.tasks apps.failures])
+    json = @connection.get('/v2/apps', query)['apps']
+    json.map { |j| Marathon::App.new(j) }
+  end
+
+end

data/lib/marathon/deployment.rb

@@ -32,8 +32,7 @@ class Marathon::Deployment < Marathon::Base
 
     # List running deployments.
     def list
-      json = Marathon.connection.get('/v2/deployments')
-      json.map { |j| new(j) }
+      Marathon.singleton.deployments.list
     end
 
     # Cancel the deployment with id.
@@ -42,12 +41,34 @@ class Marathon::Deployment < Marathon::Base
     #            is created to restore the previous configuration. If set to true, then the deployment
     #            is still canceled but no rollback deployment is created.
     def delete(id, force = false)
-      query = {}
-      query[:force] = true if force
-      json = Marathon.connection.delete("/v2/deployments/#{id}")
-      Marathon::DeploymentInfo.new(json)
+      Marathon.singleton.deployments.delete(id,force)
     end
     alias :cancel :delete
     alias :remove :delete
   end
 end
+
+# This class represents a set of Deployments
+class Marathon::Deployments
+  def initialize(connection)
+    @connection = connection
+  end
+  # List running deployments.
+  def list
+    json = @connection.get('/v2/deployments')
+    json.map { |j| Marathon::Deployment.new(j) }
+  end
+
+  # Cancel the deployment with id.
+  # ++id++: Deployment's id
+  # ++force++: If set to false (the default) then the deployment is canceled and a new deployment
+  #            is created to restore the previous configuration. If set to true, then the deployment
+  #            is still canceled but no rollback deployment is created.
+  def delete(id, force = false)
+    query = {}
+    query[:force] = true if force
+    json = @connection.delete("/v2/deployments/#{id}")
+    Marathon::DeploymentInfo.new(json)
+  end
+
+end

data/lib/marathon/event_subscriptions.rb

@@ -2,32 +2,57 @@
 # See https://mesosphere.github.io/marathon/docs/rest-api.html#event-subscriptions for full list of API's methods.
 class Marathon::EventSubscriptions
 
+  def initialize(connection)
+    @connection = connection
+  end
+
+  # List all event subscriber callback URLs.
+  # Returns a list of strings/URLs.
+  def list
+    json = @connection.get('/v2/eventSubscriptions')
+    json['callbackUrls']
+  end
+
+  # Register a callback URL as an event subscriber.
+  # ++callbackUrl++: URL to which events should be posted.
+  # Returns an event as hash.
+  def register(callbackUrl)
+    query = {}
+    query[:callbackUrl] = callbackUrl
+    json = @connection.post('/v2/eventSubscriptions', query)
+    json
+  end
+
+  # Unregister a callback URL from the event subscribers list.
+  # ++callbackUrl++: URL passed when the event subscription was created.
+  # Returns an event as hash.
+  def unregister(callbackUrl)
+    query = {}
+    query[:callbackUrl] = callbackUrl
+    json = @connection.delete('/v2/eventSubscriptions', query)
+    json
+  end
+
+
   class << self
     # List all event subscriber callback URLs.
     # Returns a list of strings/URLs.
     def list
-      json = Marathon.connection.get('/v2/eventSubscriptions')
-      json['callbackUrls']
+      Marathon.singleton.event_subscriptions.list
     end
 
     # Register a callback URL as an event subscriber.
     # ++callbackUrl++: URL to which events should be posted.
     # Returns an event as hash.
     def register(callbackUrl)
-      query = {}
-      query[:callbackUrl] = callbackUrl
-      json = Marathon.connection.post('/v2/eventSubscriptions', query)
-      json
+      Marathon.singleton.event_subscriptions.register(callbackUrl)
     end
 
     # Unregister a callback URL from the event subscribers list.
     # ++callbackUrl++: URL passed when the event subscription was created.
     # Returns an event as hash.
     def unregister(callbackUrl)
-      query = {}
-      query[:callbackUrl] = callbackUrl
-      json = Marathon.connection.delete('/v2/eventSubscriptions', query)
-      json
+      Marathon.singleton.event_subscriptions.unregister(callbackUrl)
     end
   end
 end

data/lib/marathon/leader.rb

@@ -2,18 +2,33 @@
 # See https://mesosphere.github.io/marathon/docs/rest-api.html#get-/v2/leader for full list of API's methods.
 class Marathon::Leader
 
+  def initialize(connection)
+    @connection = connection
+  end
+
+  # Returns the current leader. If no leader exists, raises NotFoundError.
+  def get
+    json = @connection.get('/v2/leader')
+    json['leader']
+  end
+
+  # Causes the current leader to abdicate, triggering a new election.
+  # If no leader exists, raises NotFoundError.
+  def delete
+    json = @connection.delete('/v2/leader')
+    json['message']
+  end
+
   class << self
     # Returns the current leader. If no leader exists, raises NotFoundError.
     def get
-      json = Marathon.connection.get('/v2/leader')
-      json['leader']
+      Marathon.singleton.leaders.get
     end
 
     # Causes the current leader to abdicate, triggering a new election.
     # If no leader exists, raises NotFoundError.
     def delete
-      json = Marathon.connection.delete('/v2/leader')
-      json['message']
+      Marathon.singleton.leaders.delete
     end
   end
-end
+end

data/lib/marathon/queue.rb

@@ -20,8 +20,22 @@ class Marathon::Queue < Marathon::Base
     # Show content of the task queue.
     # Returns Array of Queue objects.
     def list
-      json = Marathon.connection.get('/v2/queue')['queue']
-      json.map { |j| new(j) }
+      Marathon.singleton.queues.list
     end
   end
+end
+
+# This class represents the Queue with all its elements
+class Marathon::Queues
+  def initialize(connection)
+    @connection = connection
+  end
+
+  # Show content of the task queue.
+  # Returns Array of Queue objects.
+  def list
+    json = @connection.get('/v2/queue')['queue']
+    json.map { |j| Marathon::Queue.new(j) }
+  end
+
 end

data/lib/marathon/task.rb

@@ -41,17 +41,13 @@ Version:    #{version}
     # ++status++: Return only those tasks whose status matches this parameter.
     #             If not specified, all tasks are returned. Possible values: running, staging.
     def list(status = nil)
-      query = {}
-      Marathon::Util.add_choice(query, :status, status, %w[running staging])
-      json = Marathon.connection.get('/v2/tasks', query)['tasks']
-      json.map { |j| new(j) }
+      Marathon.singleton.tasks.list(status)
     end
 
     # List all running tasks for application appId.
     # ++appId++: Application's id
     def get(appId)
-      json = Marathon.connection.get("/v2/apps/#{appId}/tasks")['tasks']
-      json.map { |j| new(j) }
+      Marathon.singleton.tasks.get(appId)
     end
 
     # Kill the given list of tasks and scale apps if requested.
@@ -59,10 +55,7 @@ Version:    #{version}
     # ++scale++: Scale the app down (i.e. decrement its instances setting by the number of tasks killed)
     #            after killing the specified tasks.
     def delete(ids, scale = false)
-      query = {}
-      query[:scale] = true if scale
-      ids = [ids] if ids.is_a?(String)
-      Marathon.connection.post("/v2/tasks/delete", query, :body => {:ids => ids})
+      Marathon.singleton.tasks.delete(ids,scale)
     end
     alias :remove :delete
     alias :kill :delete
@@ -73,14 +66,58 @@ Version:    #{version}
     # ++scale++: Scale the app down (i.e. decrement its instances setting by the number of tasks killed)
     #            after killing the specified tasks.
     def delete_all(appId, host = nil, scale = false)
-      query = {}
-      query[:host] = host if host
-      query[:scale] = true if scale
-      json = Marathon.connection.delete("/v2/apps/#{appId}/tasks", query)['tasks']
-      json.map { |j| new(j) }
+      Marathon.singleton.tasks.delete_all(appId,host,scale)
     end
     alias :remove_all :delete_all
     alias :kill_all :delete_all
   end
+end
+
+# This class represents a set of Tasks
+class Marathon::Tasks
+  def initialize(connection)
+    @connection = connection
+  end
+
+  # List tasks of all applications.
+  # ++status++: Return only those tasks whose status matches this parameter.
+  #             If not specified, all tasks are returned. Possible values: running, staging.
+  def list(status = nil)
+    query = {}
+    Marathon::Util.add_choice(query, :status, status, %w[running staging])
+    json = @connection.get('/v2/tasks', query)['tasks']
+    json.map { |j| Marathon::Task.new(j) }
+  end
+
+  # List all running tasks for application appId.
+  # ++appId++: Application's id
+  def get(appId)
+    json = @connection.get("/v2/apps/#{appId}/tasks")['tasks']
+    json.map { |j| Marathon::Task.new(j) }
+  end
+
+  # Kill the given list of tasks and scale apps if requested.
+  # ++ids++: Id or list of ids with target tasks.
+  # ++scale++: Scale the app down (i.e. decrement its instances setting by the number of tasks killed)
+  #            after killing the specified tasks.
+  def delete(ids, scale = false)
+    query = {}
+    query[:scale] = true if scale
+    ids = [ids] if ids.is_a?(String)
+    @connection.post("/v2/tasks/delete", query, :body => {:ids => ids})
+  end
+
+  # Kill tasks that belong to the application appId.
+  # ++appId++: Application's id
+  # ++host++: Kill only those tasks running on host host.
+  # ++scale++: Scale the app down (i.e. decrement its instances setting by the number of tasks killed)
+  #            after killing the specified tasks.
+  def delete_all(appId, host = nil, scale = false)
+    query = {}
+    query[:host] = host if host
+    query[:scale] = true if scale
+    json = @connection.delete("/v2/apps/#{appId}/tasks", query)['tasks']
+    json.map { |j| Marathon::Task.new(j) }
+  end
 
 end

data/lib/marathon/version.rb

@@ -1,3 +1,3 @@
 module Marathon
-  VERSION = '1.2.5'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marathon-api
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.3.0
 platform: ruby
 authors:
 - Felix Bechstein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-15 00:00:00.000000000 Z
+date: 2015-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json