marathon-api 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43d4d0f2016049fc44bde4ee4ffe6789de4631c0
+  data.tar.gz: 03579636a8d4577d7e8dc2ba1098eeb67b099ad2
+SHA512:
+  metadata.gz: fe8feb603efd0ebe26e33ccd4cc3a406906a3dcef67e15e8f4b14393a239a8a01995de5e2d77fc89cc980d900319e1ee011b77caca1c7894bd03850be697a484
+  data.tar.gz: c0f7768067d89be77eb44e179636e40e9533722697555bc65fbe84c090d7307e0980016f0dcd52533bc965e4599af4cbcd9ade1b7ebb389933dc8358ddabe08b

data/.cane

@@ -0,0 +1,3 @@
+--style-measure 120
+--color
+--parallel

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle
+.DS_Store
+*.swp
+*.gem
+Gemfile.lock
+vendor
+coverage/

data/.simplecov

@@ -0,0 +1,5 @@
+SimpleCov.start do
+  add_group 'Library', 'lib'
+  add_group 'Specs', 'spec'
+  add_filter '/vendor/'
+end

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.5
+  - 2.2.0
+env:
+  global:
+    - CODECLIMATE_REPO_TOKEN=8e7c316d892f832fa3de24bc2e88bf0d243e09947ea95319afcafcdb10f5eb3c
+script: bundle exec rake

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Swipely, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,91 @@
+marathon-api
+============
+
+[![travis-ci](https://travis-ci.org/felixb/marathon-api.png?branch=master)](https://travis-ci.org/felixb/marathon-api) [![Code Climate](https://codeclimate.com/github/felixb/marathon-api/badges/gpa.svg)](https://codeclimate.com/github/felixb/marathon-api) [![Test Coverage](https://codeclimate.com/github/felixb/marathon-api/badges/coverage.svg)](https://codeclimate.com/github/felixb/marathon-api)
+
+This gem provides an object oriented interface to the [Marathon Remote API][1]. At the time if this writing, marathon-api is meant to interface with Marathon version 0.8.0.
+
+Installation
+------------
+
+Add this line to your application's Gemfile=>
+
+```ruby
+gem 'docker-api',  =>require => 'docker',  =>git => 'https=>//github.com/felixb/marathon-api.git'
+```
+
+And then run=>
+
+```shell
+$ bundle install
+```
+
+Finally,  just add `require 'marathon'` to the top of the file using this gem.
+
+Usage
+-----
+
+marathon-api is designed to be very lightweight. Only little state is cached to ensure that each method call's information is up to date. As such,  just about every external method represents an API call.
+
+If you're running Marathon locally on port 8080,  there is no setup to do in Ruby. If you're not or change the path or port,  you'll have to point the gem to your socket or local/remote port. For example=>
+
+```ruby
+Marathon.url = 'http=>//example.com=>8080'
+```
+
+It's possible to use `ENV` variables to configure the endpoint as well=>
+
+```shell
+$ MARATHON_URL=http=>//remote.marathon.example.com=>8080 irb
+irb(main)=>001=>0> require 'marathon'
+=> true
+irb(main)=>002=>0> Marathon.url
+=> "http=>//remote.marathon.example.com=>8080"
+```
+
+## Global calls
+
+```ruby
+require 'marathon'
+# => true
+
+Marathon.info
+# => {"name"=>"marathon", "http_config"=>{"assets_path"=>null, "http_port"=>8080, "https_port"=>8443}, "frameworkId"=>"20150228-110436-16842879-5050-2169-0001", "leader"=>null, "event_subscriber"=>null, "marathon_config"=>{"local_port_max"=>20000, "local_port_min"=>10000, "hostname"=>"mesos", "master"=>"zk=>//localhost=>2181/mesos", "reconciliation_interval"=>300000, "mesos_role"=>null, "task_launch_timeout"=>300000, "reconciliation_initial_delay"=>15000, "ha"=>true, "failover_timeout"=>604800, "checkpoint"=>true, "executor"=>"//cmd", "marathon_store_timeout"=>2000, "mesos_user"=>"root"}, "version"=>"0.8.0", "zookeeper_config"=>{"zk_path"=>"/marathon", "zk"=>null, "zk_timeout"=>10, "zk_hosts"=>"localhost=>2181", "zk_future_timeout"=>{"duration"=>10}}, "elected"=>false}
+
+Docker.ping
+# => 'pong'
+
+```
+
+## Applications
+
+You can list, change, delete apps like this:
+
+```ruby
+require 'marathon'
+
+# fetch a list of applications
+apps = Marathon::App.list
+
+# scale the first app to 2 instances
+apps.first.scale!(2)
+
+# delete the last app
+apps.last.delete!
+```
+
+The other Marathon endpoints are available in the same way.
+
+Credits
+-------
+
+This gem is inspired by mesosphere's abondend [marathon_client][2] and swipelies [docker-api][3].
+
+License
+-------
+
+This program is licensed under the MIT license. See LICENSE for details.
+
+[1]: https://mesosphere.github.io/marathon/docs/rest-api.html
+[2]: https://github.com/mesosphere/marathon_client
+[3]: https://github.com/swipely/docker-api

data/Rakefile

@@ -0,0 +1,34 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'rake'
+require 'json'
+require 'marathon'
+require 'rspec/core/rake_task'
+require 'vcr'
+require 'cane/rake_task'
+
+task :default => [:spec, :quality]
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+Cane::RakeTask.new(:quality) do |cane|
+  cane.canefile = '.cane'
+end
+
+dir = File.expand_path(File.dirname(__FILE__))
+namespace :vcr do
+  desc 'Run spec tests and record VCR cassettes'
+  task :record do
+    FileUtils.remove_dir("#{dir}/fixtures/vcr", true)
+    json = JSON.parse(File.read("#{dir}/fixtures/marathon_docker_sample.json"))
+    Marathon::App.new(json).start!
+    json = JSON.parse(File.read("#{dir}/fixtures/marathon_docker_sample_2.json"))
+    Marathon::App.new(json).start!
+
+    # finally run spec tests
+    Rake::Task["spec"].invoke
+  end
+
+end

data/TESTING.md

@@ -0,0 +1,49 @@
+# Prerequisites
+To develop on this gem, you must the following installed:
+* a sane Ruby 1.9+ environment with `bundler`
+```shell
+$ gem install bundler
+```
+* Local Marathon v0.8.0 or greater running on Port 8080. Use [Vagrant][1] or [docker][2] to prevent local installation.
+
+
+
+# Getting Started
+1. Clone the git repository from Github:
+```shell
+$ git clone git@github.com:felixb/marathon-api.git
+```
+2. Install the dependencies using Bundler
+```shell
+$ bundle install
+```
+3. Create a branch for your changes
+```shell
+$ git checkout -b my_bug_fix
+```
+4. Make any changes
+5. Write tests to support those changes.
+6. Run the tests:
+  * `bundle exec rake vcr:test`
+7. Assuming the tests pass, open a Pull Request on Github.
+
+# Using Rakefile Commands
+This repository comes with five Rake commands to assist in your testing of the code.
+
+## `rake spec`
+This command will run Rspec tests normally on your local system. Be careful that VCR will behave "weirdly" if you currently have the Docker daemon running.
+
+## `rake quality`
+This command runs a code quality threshold checker to hinder bad code.
+
+## `rake vcr`
+This gem uses [VCR](https://relishapp.com/vcr/vcr) to record and replay HTTP requests made to the Docker API. The `vcr` namespace is used to record and replay spec tests inside of a Docker container. This will allow each developer to run and rerecord VCR cassettes in a consistent environment.
+
+### `rake vcr:record`
+This is the command you will use to record a new set of VCR cassettes. This command runs the following procedures:
+1. Delete the existing `fixtures/vcr` directory.
+2. Launch some tasks on local Marathon instance
+3. Record new VCR cassettes by running the Rspec test suite against the local Marathon instance.
+
+[1]: https://github.com/everpeace/vagrant-mesos
+[2]: https://registry.hub.docker.com/u/mesosphere/marathon/

data/fixtures/marathon_docker_sample.json

@@ -0,0 +1,14 @@
+{
+  "container": {
+    "type": "DOCKER",
+    "docker": {
+      "image": "libmesos/ubuntu"
+    }
+  },
+  "id": "/ubuntu",
+  "instances": 1,
+  "cpus": 0.1,
+  "mem": 64,
+  "uris": [],
+  "cmd": "while sleep 10; do date -u +%T; done"
+}

data/fixtures/marathon_docker_sample_2.json

@@ -0,0 +1,14 @@
+{
+  "container": {
+    "type": "DOCKER",
+    "docker": {
+      "image": "libmesos/ubuntu"
+    }
+  },
+  "id": "/ubuntu2",
+  "instances": 1,
+  "cpus": 0.1,
+  "mem": 64,
+  "uris": [],
+  "cmd": "while sleep 10; do date -u +%T; done"
+}

data/fixtures/vcr/Marathon/_info/returns_the_info_hash.yml

@@ -0,0 +1,30 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:8080/v2/info
+    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: '{"name":"marathon","http_config":{"assets_path":null,"http_port":8080,"https_port":8443},"frameworkId":"20150228-110436-16842879-5050-2169-0001","leader":null,"event_subscriber":null,"marathon_config":{"local_port_max":20000,"local_port_min":10000,"hostname":"mesos","master":"zk://localhost:2181/mesos","reconciliation_interval":300000,"mesos_role":null,"task_launch_timeout":300000,"reconciliation_initial_delay":15000,"ha":true,"failover_timeout":604800,"checkpoint":true,"executor":"//cmd","marathon_store_timeout":2000,"mesos_user":"root"},"version":"0.8.0","zookeeper_config":{"zk_path":"/marathon","zk":null,"zk_timeout":10,"zk_hosts":"localhost:2181","zk_future_timeout":{"duration":10}},"elected":false}'
+    http_version: 
+  recorded_at: Mon, 02 Mar 2015 10:49:28 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr/Marathon/_ping/ping/.yml

@@ -0,0 +1,35 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:8080/ping
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - must-revalidate,no-cache,no-store
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Content-Type:
+      - text/plain;charset=ISO-8859-1
+      Content-Length:
+      - '5'
+      Server:
+      - Jetty(8.y.z-SNAPSHOT)
+    body:
+      encoding: UTF-8
+      string: |
+        pong
+    http_version: 
+  recorded_at: Mon, 02 Mar 2015 10:49:28 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr/Marathon_App/_changes/changes_the_app.yml

@@ -0,0 +1,57 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: http://localhost:8080/v2/apps//ubuntu2
+    body:
+      encoding: UTF-8
+      string: '{"instances":2}'
+    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: '{"version":"2015-03-03T18:08:29.872Z","deploymentId":"577a4136-d861-4f41-b400-1f73314c9ffd"}'
+    http_version: 
+  recorded_at: Tue, 03 Mar 2015 18:08:29 GMT
+- request:
+    method: put
+    uri: http://localhost:8080/v2/apps//ubuntu2?force=true
+    body:
+      encoding: UTF-8
+      string: '{"instances":1}'
+    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: '{"version":"2015-03-03T18:08:30.012Z","deploymentId":"b1457aac-c4af-426f-bc2b-c2d67afed429"}'
+    http_version: 
+  recorded_at: Tue, 03 Mar 2015 18:08:30 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr/Marathon_App/_changes/fails_with_stange_attributes.yml

@@ -0,0 +1,32 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: http://localhost:8080/v2/apps//ubuntu2
+    body:
+      encoding: UTF-8
+      string: '{"instances":"foo"}'
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      User-Agent:
+      - ub0r/Marathon-API 0.8.0
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(8.y.z-SNAPSHOT)
+    body:
+      encoding: UTF-8
+      string: '{"message":"Invalid JSON: JsResultException(errors:List((/instances,List(ValidationError(error.expected.jsnumber,WrappedArray())))))"}'
+    http_version: 
+  recorded_at: Wed, 04 Mar 2015 16:38:10 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr/Marathon_App/_delete/deletes_the_app.yml

@@ -0,0 +1,30 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: http://localhost:8080/v2/apps//ubuntu
+    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: '{"version":"2015-03-03T18:08:29.568Z","deploymentId":"475735d1-4c08-439d-8687-d13626e512a1"}'
+    http_version: 
+  recorded_at: Tue, 03 Mar 2015 18:08:29 GMT
+recorded_with: VCR 2.9.3