marathon-api 0.9.0

data/fixtures/vcr/Marathon_EventSubscriptions/_list/lists_callbacks.yml

@@ -0,0 +1,30 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:8080/v2/eventSubscriptions
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(8.y.z-SNAPSHOT)
+    body:
+      encoding: UTF-8
+      string: '{"callbackUrls":["http://localhost/events/foo"]}'
+    http_version: 
+  recorded_at: Tue, 03 Mar 2015 18:31:15 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr/Marathon_EventSubscriptions/_register/registers_callback.yml

@@ -0,0 +1,30 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:8080/v2/eventSubscriptions?callbackUrl=http://localhost/events/foo
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(8.y.z-SNAPSHOT)
+    body:
+      encoding: UTF-8
+      string: '{"clientIp":"10.0.2.2","callbackUrl":"http://localhost/events/foo","eventType":"subscribe_event","timestamp":"2015-03-03T18:31:14.688Z"}'
+    http_version: 
+  recorded_at: Tue, 03 Mar 2015 18:31:14 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr/Marathon_EventSubscriptions/_unregister/unregisters_callback.yml

@@ -0,0 +1,30 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: http://localhost:8080/v2/eventSubscriptions?callbackUrl=http://localhost/events/foo
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(8.y.z-SNAPSHOT)
+    body:
+      encoding: UTF-8
+      string: '{"clientIp":"10.0.2.2","callbackUrl":"http://localhost/events/foo","eventType":"unsubscribe_event","timestamp":"2015-03-03T18:31:15.066Z"}'
+    http_version: 
+  recorded_at: Tue, 03 Mar 2015 18:31:15 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr/Marathon_Leader/_delete/delete/.yml

@@ -0,0 +1,30 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: http://localhost:8080/v2/leader
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(8.y.z-SNAPSHOT)
+    body:
+      encoding: UTF-8
+      string: '{"message":"Leadership abdicted"}'
+    http_version: 
+  recorded_at: Mon, 02 Mar 2015 10:49:28 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr/Marathon_Leader/_get/get/.yml

@@ -0,0 +1,30 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:8080/v2/leader
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(8.y.z-SNAPSHOT)
+    body:
+      encoding: UTF-8
+      string: '{"leader":"mesos:8080"}'
+    http_version: 
+  recorded_at: Mon, 02 Mar 2015 10:49:28 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr/Marathon_Queue/_list/lists_queue.yml

@@ -0,0 +1,33 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:8080/v2/queue
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      User-Agent:
+      - ub0r/Marathon-API 0.8.0
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(8.y.z-SNAPSHOT)
+    body:
+      encoding: UTF-8
+      string: '{"queue":[{"app":{"id":"/test","cmd":"sleep 10","args":null,"user":null,"env":{},"instances":1,"cpus":0.1,"mem":32.0,"disk":0.0,"executor":"","constraints":[],"uris":[],"storeUrls":[],"ports":[10002],"requirePorts":false,"backoffSeconds":1,"backoffFactor":1.15,"maxLaunchDelaySeconds":3600,"container":null,"healthChecks":[],"dependencies":[],"upgradeStrategy":{"minimumHealthCapacity":1.0,"maximumOverCapacity":1.0},"labels":{},"version":"2015-03-04T16:34:16.561Z"},"count":0},{"app":{"id":"/ubuntu2","cmd":"while
+        sleep 10; do date -u +%T; done","args":null,"user":null,"env":{},"instances":1,"cpus":0.1,"mem":64.0,"disk":0.0,"executor":"","constraints":[],"uris":[],"storeUrls":[],"ports":[10001],"requirePorts":false,"backoffSeconds":1,"backoffFactor":1.15,"maxLaunchDelaySeconds":3600,"container":{"type":"DOCKER","volumes":[],"docker":{"image":"libmesos/ubuntu","network":null,"portMappings":null,"privileged":false,"parameters":[]}},"healthChecks":[],"dependencies":[],"upgradeStrategy":{"minimumHealthCapacity":1.0,"maximumOverCapacity":1.0},"labels":{},"version":"2015-03-04T16:34:15.691Z"},"count":0}]}'
+    http_version: 
+  recorded_at: Wed, 04 Mar 2015 18:38:40 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr/Marathon_Task/_delete/kills_a_tasks_of_an_app.yml

@@ -0,0 +1,57 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:8080/v2/apps//ubuntu2/tasks
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(8.y.z-SNAPSHOT)
+    body:
+      encoding: UTF-8
+      string: '{"tasks":[{"appId":"/ubuntu2","id":"ubuntu2.37fbe1bc-c1d0-11e4-82d4-46b02d3b7f9e","host":"mesos","ports":[31290],"startedAt":"2015-03-03T18:07:57.097Z","stagedAt":"2015-03-03T18:07:56.457Z","version":"2015-03-03T18:07:47.581Z"}]}'
+    http_version: 
+  recorded_at: Tue, 03 Mar 2015 18:08:30 GMT
+- request:
+    method: delete
+    uri: http://localhost:8080/v2/apps//ubuntu2/tasks/ubuntu2.37fbe1bc-c1d0-11e4-82d4-46b02d3b7f9e
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(8.y.z-SNAPSHOT)
+    body:
+      encoding: UTF-8
+      string: '{"task":{"id":"ubuntu2.37fbe1bc-c1d0-11e4-82d4-46b02d3b7f9e","host":"mesos","ports":[31290],"startedAt":"2015-03-03T18:07:57.097Z","stagedAt":"2015-03-03T18:07:56.457Z","version":"2015-03-03T18:07:47.581Z"}}'
+    http_version: 
+  recorded_at: Tue, 03 Mar 2015 18:08:30 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr/Marathon_Task/_delete_all/kills_all_tasks_of_an_app.yml

@@ -0,0 +1,30 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: http://localhost:8080/v2/apps//ubuntu2/tasks
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(8.y.z-SNAPSHOT)
+    body:
+      encoding: UTF-8
+      string: '{"tasks":[{"id":"ubuntu2.37fbe1bc-c1d0-11e4-82d4-46b02d3b7f9e","host":"mesos","ports":[31290],"startedAt":"2015-03-03T18:07:57.097Z","stagedAt":"2015-03-03T18:07:56.457Z","version":"2015-03-03T18:07:47.581Z"}]}'
+    http_version: 
+  recorded_at: Tue, 03 Mar 2015 18:08:30 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr/Marathon_Task/_get/gets_tasks_of_an_app.yml

@@ -0,0 +1,30 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:8080/v2/apps//ubuntu2/tasks
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(8.y.z-SNAPSHOT)
+    body:
+      encoding: UTF-8
+      string: '{"tasks":[{"appId":"/ubuntu2","id":"ubuntu2.37fbe1bc-c1d0-11e4-82d4-46b02d3b7f9e","host":"mesos","ports":[31290],"startedAt":"2015-03-03T18:07:57.097Z","stagedAt":"2015-03-03T18:07:56.457Z","version":"2015-03-03T18:07:47.581Z"}]}'
+    http_version: 
+  recorded_at: Tue, 03 Mar 2015 18:08:30 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr/Marathon_Task/_list/lists_running_tasks.yml

@@ -0,0 +1,30 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:8080/v2/tasks?status=running
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(8.y.z-SNAPSHOT)
+    body:
+      encoding: UTF-8
+      string: '{"tasks":[{"appId":"/test","id":"test.482155d0-c1d0-11e4-82d4-46b02d3b7f9e","host":"mesos","ports":[31026],"startedAt":"2015-03-03T18:08:24.116Z","stagedAt":"2015-03-03T18:08:23.546Z","version":"2015-03-02T11:30:30.096Z","servicePorts":[10002]},{"appId":"/ubuntu2","id":"ubuntu2.37fbe1bc-c1d0-11e4-82d4-46b02d3b7f9e","host":"mesos","ports":[31290],"startedAt":"2015-03-03T18:07:57.097Z","stagedAt":"2015-03-03T18:07:56.457Z","version":"2015-03-03T18:07:47.581Z","servicePorts":[10001]}]}'
+    http_version: 
+  recorded_at: Tue, 03 Mar 2015 18:08:30 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr/Marathon_Task/_list/lists_tasks.yml

@@ -0,0 +1,30 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:8080/v2/tasks
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(8.y.z-SNAPSHOT)
+    body:
+      encoding: UTF-8
+      string: '{"tasks":[{"appId":"/test","id":"test.482155d0-c1d0-11e4-82d4-46b02d3b7f9e","host":"mesos","ports":[31026],"startedAt":"2015-03-03T18:08:24.116Z","stagedAt":"2015-03-03T18:08:23.546Z","version":"2015-03-02T11:30:30.096Z","servicePorts":[10002]},{"appId":"/ubuntu2","id":"ubuntu2.37fbe1bc-c1d0-11e4-82d4-46b02d3b7f9e","host":"mesos","ports":[31290],"startedAt":"2015-03-03T18:07:57.097Z","stagedAt":"2015-03-03T18:07:56.457Z","version":"2015-03-03T18:07:47.581Z","servicePorts":[10001]}]}'
+    http_version: 
+  recorded_at: Tue, 03 Mar 2015 18:08:30 GMT
+recorded_with: VCR 2.9.3

data/lib/marathon.rb

@@ -0,0 +1,65 @@
+require 'rubygems/package'
+require 'httparty'
+require 'json'
+require 'uri'
+
+# The top-level module for this gem. It's purpose is to hold global
+# configuration variables that are used as defaults in other classes.
+module Marathon
+
+  attr_accessor :logger
+
+  require 'marathon/util'
+  require 'marathon/error'
+  require 'marathon/connection'
+  require 'marathon/app'
+  require 'marathon/deployment'
+  require 'marathon/event_subscriptions'
+  require 'marathon/leader'
+  require 'marathon/queue'
+  require 'marathon/task'
+  require 'marathon/version'
+
+  DEFAULT_URL = 'http://localhost:8080'
+
+  # Get the marathon url from environment
+  def env_url
+    ENV['MARATHON_URL']
+  end
+
+  # Get the marathon url
+  def url
+    @url ||= env_url || DEFAULT_URL
+    @url
+  end
+
+  # Set a new url
+  def url=(new_url)
+    @url = new_url
+    reset_connection!
+  end
+
+  # Set a new connection
+  def connection
+    @connection ||= Connection.new(url)
+  end
+
+  # Reset the connection
+  def reset_connection!
+    @connection = nil
+  end
+
+  # Get information about the marathon server
+  def info
+    connection.get('/v2/info')
+  end
+
+  # Ping marathon
+  def ping
+    connection.get('/ping')
+  end
+
+  module_function :connection, :env_url, :info, :logger, :logger=,
+                  :ping, :url, :url= ,:reset_connection!
+
+end

data/lib/marathon/app.rb

@@ -0,0 +1,200 @@
+# This class represents a Marathon App.
+# See https://mesosphere.github.io/marathon/docs/rest-api.html#apps for full list of API's methods.
+class Marathon::App
+
+  attr_reader :info, :read_only
+
+  # Create a new application object.
+  # ++hash++: Hash including all attributes.
+  #           See https://mesosphere.github.io/marathon/docs/rest-api.html#post-/v2/apps for full details.
+  # ++read_only++: prevent actions on this application
+  def initialize(hash = {}, read_only = false)
+    @info = hash
+    @read_only = read_only
+  end
+
+  # Shortcuts for reaching attributes
+  %w[ id args cmd cpus disk env executor instances mem ports requirePorts
+      storeUris tasksRunning tasksStaged uris user version ].each do |method|
+    define_method(method) { |*args, &block| info[method] }
+  end
+
+  # Prevent actions on read only instances.
+  # Raises an ArgumentError when triying to change read_only instances.
+  def check_read_only
+    if read_only
+      raise Marathon::Error::ArgumentError, "This app is 'read only' and does not support any actions"
+    end
+  end
+
+  # List all running tasks for the application.
+  # Returns an Array of Task objects.
+  def tasks
+    check_read_only
+    unless @info['tasks']
+      refresh
+    end
+
+    raise Marathon::Error::UnexpectedResponseError, "Expected to find tasks element in app's info" unless @info['tasks']
+
+    @info['tasks'].map { |e| Marathon::Task.new(e) }
+  end
+
+  # List the versions of the application.
+  # ++version++: Get a specific versions
+  # Returns Array of Strings if ++version = nil++,
+  # else returns Hash with version information.
+  def versions(version = nil)
+    if version
+      self.class.version(id, version)
+    else
+      self.class.versions(id)
+    end
+  end
+
+  # Reload attributes from marathon API.
+  def refresh
+    check_read_only
+    new_app = self.class.get(id)
+    @info = new_app.info
+  end
+
+  # Create and start the application.
+  def start!
+    check_read_only
+    new_app = self.class.start(info)
+    @info = new_app.info
+  end
+
+  # Initiates a rolling restart of all running tasks of the given app.
+  # This call respects the configured minimumHealthCapacity.
+  # ++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!(force = false)
+    check_read_only
+    self.class.restart(id, force)
+  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.
+  # ++hash++: Hash of attributes to change.
+  # ++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!(hash, force = false)
+    check_read_only
+    self.class.change(id, hash, force)
+  end
+
+  # Create a new version with parameters of an old version.
+  # Currently running tasks are restarted, while maintaining the minimumHealthCapacity.
+  # ++version++: Version name of the old 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 roll_back!(version, force = false)
+    change!({'version' => version}, force)
+  end
+
+  # Change the number of desired instances.
+  # ++instances++: Number of running instances.
+  # ++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 scale!(instances, force = false)
+    change!({'instances' => instances}, force)
+  end
+
+  # Change the number of desired instances to 0.
+  # ++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 suspend!(force = false)
+    scale!(0, force)
+  end
+
+  def to_s
+    "Marathon::App { :id => #{self.id} }"
+  end
+
+  # Return application as JSON formatted string.
+  def to_json
+    info.to_json
+  end
+
+  class << self
+
+    # List the application with id.
+    # ++id++: Application's id.
+    def get(id)
+      json = Marathon.connection.get("/v2/apps/#{id}")['app']
+      new(json)
+    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 = Marathon.connection.get('/v2/apps', query)['apps']
+      json.map { |j| new(j) }
+    end
+
+    # Delete the application with id.
+    # ++id++: Application's id.
+    def delete(id)
+      Marathon.connection.delete("/v2/apps/#{id}")
+    end
+    alias :remove :delete
+
+    # 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 = Marathon.connection.post('/v2/apps', nil, :body => hash)
+      new(json)
+    end
+    alias :create :start
+
+    # 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 = Marathon.connection.post("/v2/apps/#{id}/restart", query)
+      # TODO parse deploymentId + version
+    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 = Marathon.connection.put("/v2/apps/#{id}", query, :body => hash)
+      # TODO parse deploymentId + version
+    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']
+    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)
+    end
+  end
+end