marathon-api 0.9.0

data/lib/marathon/connection.rb

@@ -0,0 +1,97 @@
+# This class represents a Marathon API Connection.
+class Marathon::Connection
+
+  include Marathon::Error
+  include HTTParty
+
+  headers(
+    'Content-Type' => 'application/json',
+    'Accept' => 'application/json',
+    'User-Agent' => "ub0r/Marathon-API #{Marathon::VERSION}"
+  )
+
+  default_timeout 5
+  maintain_method_across_redirects
+
+  attr_reader :url
+
+  # Create a new API connection.
+  # ++url++: URL of the marathon API.
+  def initialize(url)
+    @url = url
+  end
+
+  # Delegate all HTTP methods to the #request.
+  [:get, :put, :post, :delete].each do |method|
+    define_method(method) { |*args, &block| request(method, *args) }
+  end
+
+  def to_s
+    "Marathon::Connection { :url => #{url} }"
+  end
+
+private
+
+  # Create URL suffix for a hash of query parameters.
+  # URL escaping is done internally.
+  # ++query++: Hash of query parameters.
+  def query_params(query)
+    query = query.select { |k,v| !v.nil? }
+    URI.escape(query.map { |k,v| "#{k}=#{v}" }.join('&'))
+  end
+
+  # Create request object.
+  # ++http_method++: GET/POST/PUT/DELETE.
+  # ++path++: Relative path to connection's URL.
+  # ++query++: Optional query parameters.
+  # ++opts++: Optional options. Ex. opts[:body] is used for PUT/POST request.
+  def compile_request_params(http_method, path, query = nil, opts = nil)
+    query ||= {}
+    opts ||= {}
+    headers = opts.delete(:headers) || {}
+    opts[:body] = opts[:body].to_json unless opts[:body].nil?
+    {
+      :method        => http_method,
+      :url           => "#{@url}#{path}",
+      :query         => query
+    }.merge(opts).reject { |_, v| v.nil? }
+  end
+
+  # Create full URL with query parameters.
+  # ++url++: Base URL.
+  # ++query++: Hash of query parameters.
+  def build_url(url, query)
+    url = URI.escape(url)
+    if query.size > 0
+      url += '?' + query_params(query)
+    end
+    url
+  end
+
+  # Send a request to the server and parse response.
+  # ++http_method++: GET/POST/PUT/DELETE.
+  # ++path++: Relative path to connection's URL.
+  # ++query++: Optional query parameters.
+  # ++opts++: Optional options. Ex. opts[:body] is used for PUT/POST request.
+  def request(*args)
+    request = compile_request_params(*args)
+    url = build_url(request[:url], request[:query])
+    response = self.class.send(request[:method], url, request)
+    if response.success?
+      response.parsed_response
+    else
+      raise Marathon::Error.from_response(response)
+    end
+  rescue MarathonError => e
+    raise e
+  rescue SocketError => e
+    raise IOError, "HTTP call failed: #{e.message}"
+  rescue SystemCallError => e
+    if e.class.name.start_with?('Errno::')
+      raise IOError, "HTTP call failed: #{e.message}"
+    else
+      raise e
+    end
+  end
+
+end

data/lib/marathon/deployment.rb

@@ -0,0 +1,60 @@
+# This class represents a Marathon Deployment.
+# See https://mesosphere.github.io/marathon/docs/rest-api.html#deployments for full list of API's methods.
+class Marathon::Deployment
+
+  attr_reader :info
+
+  # Create a new deployment object.
+  # ++hash++: Hash including all attributes.
+  #           See https://mesosphere.github.io/marathon/docs/rest-api.html#get-/v2/deployments for full details.
+  def initialize(hash = {})
+    @info = hash
+  end
+
+  # Shortcuts for reaching attributes
+  %w[ id affectedApps steps currentActions version currentStep totalSteps ].each do |method|
+    define_method(method) { |*args, &block| info[method] }
+  end
+
+  # Cancel the deployment.
+  # ++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(force = false)
+    self.class.delete(id, force)
+  end
+  alias :cancel :delete
+
+  def to_s
+    "Marathon::Deployment { " \
+      + ":id => #{id} :affectedApps => #{affectedApps} :currentStep => #{currentStep} :totalSteps => #{totalSteps} }"
+  end
+
+  # Return deployment as JSON formatted string.
+  def to_json
+    info.to_json
+  end
+
+  class << self
+
+    # List running deployments.
+    def list
+      json = Marathon.connection.get('/v2/deployments')
+      json.map { |j| 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 = Marathon.connection.delete("/v2/deployments/#{id}")
+      # TODO parse deploymentId + version
+    end
+    alias :cancel :delete
+    alias :remove :delete
+  end
+end

data/lib/marathon/error.rb

@@ -0,0 +1,62 @@
+# This module holds the Errors for the gem.
+module Marathon::Error
+  # The default error. It's never actually raised, but can be used to catch all
+  # gem-specific errors that are thrown as they all subclass from this.
+  class MarathonError < StandardError; end
+
+  # Raised when invalid arguments are passed to a method.
+  class ArgumentError < MarathonError; end
+
+  # Raised when a request returns a 400.
+  class ClientError < MarathonError; end
+
+  # Raised when a request returns a 404.
+  class NotFoundError < MarathonError; end
+
+  # Raised when there is an unexpected response code / body.
+  class UnexpectedResponseError < MarathonError; end
+
+  # Raised when a request times out.
+  class TimeoutError < MarathonError; end
+
+  # Raised when login fails.
+  class AuthenticationError < MarathonError; end
+
+  # Raised when an IO action fails.
+  class IOError < MarathonError; end
+
+  # Raise error specific to http response.
+  # ++response++: HTTParty response object.
+  def from_response(response)
+    error_class(response).new(error_message(response))
+  end
+
+  private
+
+  # Get reponse code specific error class.
+  # ++response++: HTTParty response object.
+  def error_class(response)
+    case response.code
+    when 400
+      ClientError
+    when 404
+      NotFoundError
+    else
+      UnexpectedResponseError
+    end
+  end
+
+  # Get response code from http response.
+  # ++response++: HTTParty response object.
+  def error_message(response)
+    body = response.parsed_response
+    if body.is_a?(Hash)
+      body['message']
+    else
+      body
+    end
+  end
+
+  module_function :error_class, :error_message, :from_response
+
+end

data/lib/marathon/event_subscriptions.rb

@@ -0,0 +1,33 @@
+# This class represents a Marathon Event Subscriptions.
+# See https://mesosphere.github.io/marathon/docs/rest-api.html#event-subscriptions for full list of API's methods.
+class Marathon::EventSubscriptions
+
+  class << self
+    # List all event subscriber callback URLs.
+    # Returns a list of strings/URLs.
+    def list
+      json = Marathon.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 = Marathon.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 = Marathon.connection.delete('/v2/eventSubscriptions', query)
+      json
+    end
+  end
+end

data/lib/marathon/leader.rb

@@ -0,0 +1,19 @@
+# This class represents a Marathon Leader.
+# See https://mesosphere.github.io/marathon/docs/rest-api.html#get-/v2/leader for full list of API's methods.
+class Marathon::Leader
+
+  class << self
+    # Returns the current leader. If no leader exists, raises NotFoundError.
+    def get
+      json = Marathon.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 = Marathon.connection.delete('/v2/leader')
+      json['message']
+    end
+  end
+end

data/lib/marathon/queue.rb

@@ -0,0 +1,36 @@
+# This class represents a Marathon Queue element.
+# See https://mesosphere.github.io/marathon/docs/rest-api.html#queue for full list of API's methods.
+class Marathon::Queue
+
+  attr_reader :app
+  attr_reader :delay
+
+  # Create a new queue element object.
+  # ++hash++: Hash returned by API, including 'app' and 'delay'
+  def initialize(hash = {})
+    @app = Marathon::App.new(hash['app'], true)
+    @delay = hash['delay']
+  end
+
+  def to_s
+    "Marathon::Queue { :appId => #{app.id} :delay => #{delay} }"
+  end
+
+  # Return queue element as JSON formatted string.
+  def to_json
+    {
+      'app' => @app.info,
+      'delay' => @delay
+    }.to_json
+  end
+
+  class << self
+
+    # 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) }
+    end
+  end
+end

data/lib/marathon/task.rb

@@ -0,0 +1,85 @@
+# This class represents a Marathon Task.
+# See https://mesosphere.github.io/marathon/docs/rest-api.html#get-/v2/tasks for full list of API's methods.
+class Marathon::Task
+
+  attr_reader :info
+
+  # Create a new task object.
+  # ++hash++: Hash including all attributes
+  def initialize(hash = {})
+    @info = hash
+  end
+
+  # Shortcuts for reaching attributes
+  %w[ id appId host ports servicePorts version stagedAt startedAt ].each do |method|
+    define_method(method) { |*args, &block| info[method] }
+  end
+
+  # Kill the task that belongs to an application.
+  # ++scale++: Scale the app down (i.e. decrement its instances setting by the number of tasks killed)
+  #            after killing the specified tasks.
+  def delete!(scale = false)
+    new_task = self.class.delete(appId, id, scale)
+    @info = new_task.info
+  end
+  alias :kill! :delete!
+
+  def to_s
+    "Marathon::Task { :id => #{self.id} :appId => #{appId} :host => #{host} }"
+  end
+
+  # Return task as JSON formatted string.
+  def to_json
+    info.to_json
+  end
+
+  class << self
+
+    # 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 = Marathon.connection.get('/v2/tasks', query)['tasks']
+      json.map { |j| new(j) }
+    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) }
+    end
+
+    # Kill the task that belongs to the application appId.
+    # ++appId++: Application's id
+    # ++id++: Id of target task.
+    # ++scale++: Scale the app down (i.e. decrement its instances setting by the number of tasks killed)
+    #            after killing the specified tasks.
+    def delete(appId, id, scale = false)
+      query = {}
+      query[:scale] = true if scale
+      json = Marathon.connection.delete("/v2/apps/#{appId}/tasks/#{id}", query)
+      new(json)
+    end
+    alias :remove :delete
+    alias :kill :delete
+
+    # 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 = Marathon.connection.delete("/v2/apps/#{appId}/tasks", query)['tasks']
+      json.map { |j| new(j) }
+    end
+    alias :remove_all :delete_all
+    alias :kill_all :delete_all
+  end
+
+end

data/lib/marathon/util.rb

@@ -0,0 +1,35 @@
+# Some helper things.
+class Marathon::Util
+  class << self
+
+    # Checks if parameter is of allowed value.
+    # ++name++: parameter's name
+    # ++value++: parameter's value
+    # ++allowed++: array of allowd values
+    # ++nil_allowed++: allow nil values
+    def validate_choice(name, value, allowed, nil_allowed = true)
+      if value.nil?
+        unless nil_allowed
+          raise Marathon::Error::ArgumentError, "#{name} must not be nil"
+        end
+      else
+        # value is not nil
+        unless allowed.include?(value)
+          msg = nil_allowed ? "#{name} must be one of #{allowed}, or nil" : "#{name} must be one of #{allowed}"
+          raise Marathon::Error::ArgumentError, msg
+        end
+      end
+    end
+
+    # Check parameter and add it to hash if not nil.
+    # ++opts++: hash of parameters
+    # ++name++: parameter's name
+    # ++value++: parameter's value
+    # ++allowed++: array of allowd values
+    # ++nil_allowed++: allow nil values
+    def add_choice(opts, name, value, allowed, nil_allowed = true)
+      validate_choice(name, value, allowed, nil_allowed)
+      opts[name] = value if value
+    end
+  end
+end

data/lib/marathon/version.rb

@@ -0,0 +1,3 @@
+module Marathon
+  VERSION = '0.9.0'
+end

data/marathon-api.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/marathon/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "marathon-api"
+  gem.version       = Marathon::VERSION
+  gem.authors       = ["Felix Bechstein"]
+  gem.email         = %w{f@ub0r.de}
+  gem.description   = %q{A simple REST client for the Marathon Remote API}
+  gem.summary       = %q{A simple REST client for the Marathon Remote API}
+  gem.homepage      = 'https://github.com/felixb/marathon-api'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = %w{lib}
+
+  gem.add_dependency 'json'
+  gem.add_dependency "httparty", ">= 0.11"
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'rspec-its'
+  gem.add_development_dependency 'vcr', '>= 2.7.0'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'cane'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'codeclimate-test-reporter'
+end