fleet-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5bcab7f3762c80b4d843b7398603462486b6adc3
+  data.tar.gz: fd587b58a42bbe1fcaf4ec29e88fedc16dcb3fd0
+SHA512:
+  metadata.gz: d4fbd90db07fa039256d3798acd6cbd780536b5649a912ef28c5ebe8ee99ce6a4ed11a845d50a503c4a55d3b135a8302663918e217e541c8de591c5b30a68860
+  data.tar.gz: c429704b2f41f073d7a55d798d289b2abbe36c1d04e5124478e66b1653181df6c143b6b5b0b125cd8ed15c08a818cd021a6b30394dd82a93489983745c0a9f6c

data/.gitignore

@@ -0,0 +1,2 @@
+coverage/
+pkg/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    fleet-api (0.0.1)
+      faraday (= 0.8.9)
+      faraday_middleware (= 0.9.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.8.9)
+      multipart-post (~> 1.2.0)
+    faraday_middleware (0.9.0)
+      faraday (>= 0.7.4, < 0.9)
+    multi_json (1.10.1)
+    multipart-post (1.2.0)
+    rake (10.3.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+    simplecov (0.9.0)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    simplecov-rcov (0.2.3)
+      simplecov (>= 0.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fleet-api!
+  rake
+  rspec (~> 3.0)
+  simplecov
+  simplecov-rcov

data/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,2 @@
+fleet-api
+=========

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/fleet-api.gemspec

@@ -0,0 +1,22 @@
+require File.expand_path('../lib/fleet/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = %w(CenturyLink)
+  gem.email         = %w(clt-labs-futuretech@centurylink.com)
+  gem.description   = 'A simple REST client for the CoreOS Fleet API'
+  gem.summary       = 'A simple REST client for the CoreOS Fleet API'
+  gem.homepage      = 'https://github.com/centurylinklabs/fleet-api'
+  gem.license       = 'Apache 2'
+  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.name          = 'fleet-api'
+  gem.require_paths = %w(lib)
+  gem.version       = Fleet::VERSION
+  gem.add_dependency 'faraday', '= 0.8.9'
+  gem.add_dependency 'faraday_middleware', '= 0.9.0'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'simplecov-rcov'
+end

data/lib/fleet/client/job.rb

@@ -0,0 +1,44 @@
+module Fleet
+  class Client
+    module Job
+
+      JOB_RESOURCE = 'job'
+
+      def list_jobs
+        opts = { consistent: true, recursive: true, sorted: true }
+        get(job_path, opts)
+      end
+
+      def get_job(service_name)
+        opts = { consistent: true, recursive: true, sorted: false }
+        get(job_path(service_name, :object), opts)
+      end
+
+      def create_job(service_name, job)
+        opts = {
+          querystring: { 'prevExist' => false },
+          body: { value: job.to_json }
+        }
+        put(job_path(service_name, :object), opts)
+      end
+
+      def delete_job(service_name)
+        opts = { dir: false, recursive: true }
+        delete(job_path(service_name), opts)
+      end
+
+      # Valid values for state - :loaded, :launched, :inactive
+      def update_job_target_state(service_name, state)
+        opts = { value: state }
+        put(job_path(service_name, 'target-state'), opts)
+      end
+
+      private
+
+      def job_path(*parts)
+        resource_path(JOB_RESOURCE, *parts)
+      end
+
+    end
+  end
+end

data/lib/fleet/client/state.rb

@@ -0,0 +1,25 @@
+module Fleet
+  class Client
+    module State
+
+      STATE_RESOURCE = 'state'
+
+      def list_states
+        opts = { consistent: true, recursive: true, sorted: false }
+        get(state_path, opts)
+      end
+
+      def get_state(service_name)
+        opts = { consistent: true, recursive: true, sorted: false }
+        get(state_path(service_name), opts)
+      end
+
+      private
+
+      def state_path(*parts)
+        resource_path(STATE_RESOURCE, *parts)
+      end
+
+    end
+  end
+end

data/lib/fleet/client/unit.rb

@@ -0,0 +1,32 @@
+module Fleet
+  class Client
+    module Unit
+
+      UNIT_RESOURCE = 'unit'
+
+      def list_units()
+        get(unit_path)
+      end
+
+      def create_unit(unit_sha1, unit_def)
+        opts = {
+          querystring: { 'prevExist' => false },
+          body: { value: unit_def.to_json }
+        }
+        put(unit_path(unit_sha1), opts)
+      end
+
+      def delete_unit(unit_sha1)
+        opts = { dir: false, recursive: false }
+        delete(unit_path(unit_sha1), opts)
+      end
+
+      private
+
+      def unit_path(*parts)
+        resource_path(UNIT_RESOURCE, *parts)
+      end
+
+    end
+  end
+end

data/lib/fleet/client.rb

@@ -0,0 +1,116 @@
+require 'json'
+require 'fleet/connection'
+require 'fleet/error'
+require 'fleet/request'
+require 'fleet/service_definition'
+require 'fleet/client/job'
+require 'fleet/client/state'
+require 'fleet/client/unit'
+
+module Fleet
+  class Client
+
+    FLEET_PATH = 'v2/keys/_coreos.com/fleet'
+    MAX_RETRIES = 10
+    SLEEP_TIME = (1.0 / 10.0)
+
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
+
+    def initialize(options={})
+      options = Fleet.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    include Fleet::Connection
+    include Fleet::Request
+
+    include Fleet::Client::Job
+    include Fleet::Client::State
+    include Fleet::Client::Unit
+
+    def load(name, service_def={})
+
+      unless service_def.is_a?(ServiceDefinition)
+        service_def = ServiceDefinition.new(name, service_def)
+      end
+
+      begin
+        create_unit(service_def.sha1, service_def.to_unit)
+      rescue Fleet::PreconditionFailed
+      end
+
+      begin
+        create_job(service_def.name, service_def.to_job)
+      rescue Fleet::PreconditionFailed
+      end
+
+      update_job_target_state(service_def.name, :loaded)
+      wait_for_load_state(service_def.name, 'loaded')
+    end
+
+    def start(service_name)
+      update_job_target_state(service_name, :launched)
+    end
+
+    def stop(service_name)
+      update_job_target_state(service_name, :loaded)
+      wait_for_load_state(service_name, 'loaded')
+    end
+
+    def unload(service_name)
+      update_job_target_state(service_name, :inactive)
+      wait_for_load_state(service_name, 'not-found')
+    end
+
+    def destroy(service_name)
+      delete_job(service_name)
+      wait_for_load_state(service_name, :no_state)
+    end
+
+    def states(service_name)
+      fleet_state = get_state(service_name)
+      service_states = JSON.parse(fleet_state['node']['value'])
+      service_states.each_with_object({}) do |(k, v), hash|
+        hash[underscore(k).to_sym] = v
+      end
+    end
+
+    protected
+
+    def resource_path(resource, *parts)
+      parts.unshift(resource).unshift(FLEET_PATH).join('/')
+    end
+
+    def wait_for_load_state(service_name, target_state='loaded')
+      result = MAX_RETRIES.times do
+        begin
+          break target_state if states(service_name)[:load_state] == target_state
+        rescue Fleet::NotFound
+          # :no_state is a special case of target state that indicates we
+          # expect the state to not be found at all (useful when waiting for
+          # a delete job call)
+          break target_state if target_state == :no_state
+        end
+
+        sleep(SLEEP_TIME)
+      end
+
+      if result == target_state
+        true
+      else
+        fail Fleet::Error,
+          "Job state '#{target_state}' could not be achieved"
+      end
+    end
+
+    def underscore(camel_cased_word)
+      return camel_cased_word unless camel_cased_word =~ /[A-Z-]|::/
+      word = camel_cased_word.gsub(/([a-z\d])([A-Z])/,'\1_\2')
+      word.tr!("-", "_")
+      word.downcase!
+      word
+    end
+  end
+end

data/lib/fleet/configuration.rb

@@ -0,0 +1,44 @@
+require 'faraday'
+require 'logger'
+
+module Fleet
+  module Configuration
+
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :fleet_api_url,
+      :open_timeout,
+      :read_timeout,
+      :ssl_options,
+      :proxy,
+      :logger
+    ]
+
+    DEFAULT_ADAPTER = Faraday.default_adapter
+    DEFAULT_ETCD_API_URL = ENV['FLEETCTL_ENDPOINT']
+    DEFAULT_OPEN_TIMEOUT = 2
+    DEFAULT_READ_TIMEOUT = 5
+    DEFAULT_SSL_OPTIONS = { verify: false }
+    DEFAULT_LOGGER = ::Logger.new(STDOUT)
+
+    attr_accessor(*VALID_OPTIONS_KEYS)
+
+    def self.extended(base)
+      base.reset
+    end
+
+    # Return a has of all the current config options
+    def options
+      VALID_OPTIONS_KEYS.each_with_object({}) { |k, o| o[k] = send(k) }
+    end
+
+    def reset
+      self.adapter = DEFAULT_ADAPTER
+      self.fleet_api_url = DEFAULT_ETCD_API_URL
+      self.open_timeout = DEFAULT_OPEN_TIMEOUT
+      self.read_timeout = DEFAULT_READ_TIMEOUT
+      self.ssl_options = DEFAULT_SSL_OPTIONS
+      self.logger = DEFAULT_LOGGER
+    end
+  end
+end

data/lib/fleet/connection.rb

@@ -0,0 +1,23 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'middleware/response/raise_error'
+
+module Fleet
+  module Connection
+
+    def connection
+      options = {
+        url: fleet_api_url,
+        ssl: ssl_options,
+        proxy: proxy
+      }
+
+      Faraday.new(options) do |faraday|
+        faraday.request :url_encoded
+        faraday.response :json
+        faraday.response :raise_error
+        faraday.adapter adapter
+      end
+    end
+  end
+end

data/lib/fleet/error.rb

@@ -0,0 +1,42 @@
+module Fleet
+
+  class Error < StandardError
+    attr_reader :error_code
+    attr_reader :cause
+
+    def initialize(msg, error_code=nil, cause=nil)
+      super(msg)
+      @error_code = error_code
+      @cause = cause
+    end
+
+    HTTP_CODE_MAP = {
+      400 => 'BadRequest',
+      401 => 'Unauthorized',
+      403 => 'Forbidden',
+      404 => 'NotFound',
+      405 => 'MethodNotAllowed',
+      406 => 'NotAcceptable',
+      408 => 'RequestTimeout',
+      409 => 'Conflict',
+      412 => 'PreconditionFailed',
+      413 => 'RequestEntityTooLarge',
+      414 => 'RequestUriTooLong',
+      415 => 'UnsupportedMediaType',
+      416 => 'RequestRangeNotSatisfiable',
+      417 => 'ExpectationFailed',
+      500 => 'InternalServerError',
+      501 => 'NotImplemented',
+      502 => 'BadGateway',
+      503 => 'ServiceUnavailable',
+      504 => 'GatewayTimeout'
+    }
+  end
+
+  # Define a new error class for all of the HTTP codes in the HTTP_CODE_MAP
+  Error::HTTP_CODE_MAP.each do |code, class_name|
+    Fleet.const_set(class_name, Class.new(Error)).const_set('HTTP_CODE', code)
+  end
+
+  class ConnectionError < Error; end
+end