fleet-ruby 0.1.0

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/circle.yml

@@ -0,0 +1,13 @@
+dependencies:
+  override:
+    - 'rvm-exec 1.9.3 bundle install'
+    - 'rvm-exec 2.0.0 bundle install'
+    - 'rvm-exec 2.1.5 bundle install'
+    - 'rvm-exec 2.2.0 bundle install'
+
+test:
+  override:
+    - 'rvm-exec 1.9.3 bundle exec rake'
+    - 'rvm-exec 2.0.0 bundle exec rake'
+    - 'rvm-exec 2.1.5 bundle exec rake'
+    - 'rvm-exec 2.2.0 bundle exec rake'

data/fleet-ruby.gemspec

@@ -0,0 +1,23 @@
+require File.expand_path('../lib/fleet/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = 'Barry Martin'
+  gem.email         = 'nyxcharon@gmail.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/nyxcharon/fleet-ruby.git'
+  gem.license       = 'Apache 2'
+  gem.platform      = Gem::Platform::RUBY
+  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-ruby'
+  gem.require_paths = %w(lib)
+  gem.version       = '0.1.0'
+  gem.required_ruby_version = '>= 1.9.3'
+  gem.add_dependency 'excon', '>= 0.27.4'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'simplecov', '~> 0.9.0'
+  gem.add_development_dependency 'simplecov-rcov', '~> 0.2.3'
+end

data/lib/fleet.rb

@@ -0,0 +1,15 @@
+require 'fleet/configuration'
+require 'fleet/client'
+
+module Fleet
+  extend Configuration
+
+  def self.new(options={})
+    Fleet::Client.new(options)
+  end
+
+  def self.configure
+    yield self
+    true
+  end
+end

data/lib/fleet/client.rb

@@ -0,0 +1,119 @@
+require 'fleet/connection'
+require 'fleet/error'
+require 'fleet/request'
+require 'fleet/service_definition'
+require 'fleet/client/machines'
+require 'fleet/client/unit'
+require 'fleet/client/state'
+
+module Fleet
+  class Client
+
+    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::Machines
+    include Fleet::Client::Unit
+    include Fleet::Client::State
+
+    def list
+      machines = list_machines['machines'] || []
+      machine_ips = machines.each_with_object({}) do |machine, h|
+        h[machine['id']] = machine['primaryIP']
+      end
+
+      states = list_states['states'] || []
+      states.map do |service|
+        {
+          name: service['name'],
+          load_state: service['systemdLoadState'],
+          active_state: service['systemdActiveState'],
+          sub_state: service['systemdSubState'],
+          machine_id: service['machineID'],
+          machine_ip: machine_ips[service['machineID']]
+        }
+      end
+    end
+
+    def list_unit_states
+      list_states['states'] || []
+    end
+
+    def list_fleet_machines
+      list_machines['machines'] || []
+    end
+
+    def submit(name, service_def)
+      unless name =~ /\A[a-zA-Z0-9:_.@-]+\Z/
+        raise ArgumentError, 'name may only contain [a-zA-Z0-9:_.@-]'
+      end
+
+      unless service_def.is_a?(ServiceDefinition)
+        service_def = ServiceDefinition.new(service_def)
+      end
+
+      begin
+        create_unit(name, service_def.to_unit(name))
+      rescue Fleet::PreconditionFailed
+      end
+    end
+
+    def load(name, service_def=nil)
+
+      if service_def
+        submit(name, service_def)
+      end
+
+      opts = { 'desiredState' => 'loaded', 'name' => name }
+      update_unit(name, opts)
+    end
+
+    def start(name)
+      opts = { 'desiredState' => 'launched', 'name' => name }
+      update_unit(name, opts)
+    end
+
+    def stop(name)
+      opts = { 'desiredState' => 'loaded', 'name' => name }
+      update_unit(name, opts)
+    end
+
+    def unload(name)
+      opts = { 'desiredState' => 'inactive', 'name' => name }
+      update_unit(name, opts)
+    end
+
+    def destroy(name)
+      delete_unit(name)
+    end
+
+    def status(name)
+      get_unit(name)["currentState"].to_sym
+    end
+
+    def get_unit_state(name)
+      options = { unitName: name }
+      states = list_states(options)
+      if states["states"]
+        states["states"].first
+      else
+        fail NotFound, "Unit '#{name}' not found"
+      end
+    end
+
+    protected
+
+    def resource_path(resource, *parts)
+      parts.unshift('fleet', fleet_api_version, resource).join('/')
+    end
+  end
+end

data/lib/fleet/client/machines.rb

@@ -0,0 +1,18 @@
+module Fleet
+  class Client
+    module Machines
+      MACHINES_RESOURCE = 'machines'.freeze
+
+      def list_machines
+        opts = { consistent: true, recursive: true, sorted: true }
+        get(machines_path, opts)
+      end
+
+      private
+
+      def machines_path(*parts)
+        resource_path(MACHINES_RESOURCE, *parts)
+      end
+    end
+  end
+end

data/lib/fleet/client/state.rb

@@ -0,0 +1,18 @@
+module Fleet
+  class Client
+    module State
+      STATE_RESOURCE = 'state'.freeze
+
+      def list_states
+        opts = { consistent: true, recursive: true, sorted: true }
+        get(state_path, 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,33 @@
+module Fleet
+  class Client
+    module Unit
+      UNITS_RESOURCE = 'units'.freeze
+
+      def list_units
+        get(units_path)
+      end
+
+      def get_unit(name)
+        get(units_path(name))
+      end
+
+      alias_method :get_unit_file, :get_unit
+
+      def create_unit(name, unit)
+        put(units_path(name), unit)
+      end
+
+      alias_method :update_unit, :create_unit
+
+      def delete_unit(name)
+        delete(units_path(name))
+      end
+
+      private
+
+      def units_path(*parts)
+        resource_path(UNITS_RESOURCE, *parts)
+      end
+    end
+  end
+end

data/lib/fleet/configuration.rb

@@ -0,0 +1,39 @@
+require 'logger'
+
+module Fleet
+  module Configuration
+
+    VALID_OPTIONS_KEYS = [
+      :fleet_api_url,
+      :fleet_api_version,
+      :open_timeout,
+      :read_timeout,
+      :logger
+    ]
+
+    DEFAULT_FLEET_API_URL = ENV['FLEETCTL_ENDPOINT'] || 'unix:///var/run/fleet.sock'
+    DEFAULT_FLEET_API_VERSION = 'v1'
+    DEFAULT_OPEN_TIMEOUT = 2
+    DEFAULT_READ_TIMEOUT = 5
+    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.fleet_api_url = DEFAULT_FLEET_API_URL
+      self.fleet_api_version = DEFAULT_FLEET_API_VERSION
+      self.open_timeout = DEFAULT_OPEN_TIMEOUT
+      self.read_timeout = DEFAULT_READ_TIMEOUT
+      self.logger = DEFAULT_LOGGER
+    end
+  end
+end

data/lib/fleet/connection.rb

@@ -0,0 +1,33 @@
+require 'excon'
+
+module Fleet
+  module Connection
+
+    def connection
+      options = {
+        read_timeout: read_timeout,
+        connect_timeout: open_timeout,
+        headers: { 'User-Agent' => user_agent, 'Accept' => 'application/json' }
+      }
+
+      uri = URI.parse(fleet_api_url)
+      if uri.scheme == 'unix'
+        uri, options = 'unix:///', { socket: uri.path }.merge(options)
+      else
+        uri = fleet_api_url
+      end
+
+      Excon.new(uri, options)
+    end
+
+    private
+
+    def user_agent
+      ua_chunks = []
+      ua_chunks << "fleet/#{Fleet::VERSION}"
+      ua_chunks << "(#{RUBY_ENGINE}; #{RUBY_VERSION}p#{RUBY_PATCHLEVEL}; #{RUBY_PLATFORM})"
+      ua_chunks << "excon/#{Excon::VERSION}"
+      ua_chunks.join(' ')
+    end
+  end
+end

data/lib/fleet/error.rb

@@ -0,0 +1,41 @@
+module Fleet
+
+  class Error < StandardError
+    attr_reader :error_code
+    attr_reader :cause
+
+    def initialize(msg, error_code=nil)
+      super(msg)
+      @error_code = error_code
+    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

data/lib/fleet/request.rb

@@ -0,0 +1,73 @@
+require 'json'
+require 'fleet/version'
+
+module Fleet
+  module Request
+
+    private
+
+    [:get, :put, :delete].each do |method|
+      define_method(method) do |path, options={}|
+        request(connection, method, path, options)
+      end
+    end
+
+    def request(connection, method, path, options)
+      response = perform_request(connection, method, path, options)
+      return response if method != :get
+
+      next_page_token = response.delete('nextPageToken')
+      while next_page_token
+        next_options = options.merge('nextPageToken' => next_page_token)
+        next_response = perform_request(connection, method, path, next_options)
+        next_page_token = next_response.delete('nextPageToken')
+        next_response.each { |k, v| response[k] += v }
+      end
+      response
+    end
+
+    private
+
+    def perform_request(connection, method, path, options)
+      req = {
+        path: escape_path(path),
+      }
+
+      case method
+      when :get
+        req[:query] = options
+      when :put
+        req[:headers] = { 'Content-Type' => 'application/json' }
+        req[:body] = ::JSON.dump(options)
+      end
+
+      resp = connection.send(method, req)
+
+      if (400..600).include?(resp.status)
+        raise_error(resp)
+      end
+
+      case method
+      when :get
+        ::JSON.parse(resp.body)
+      else
+        true
+      end
+    rescue Excon::Errors::SocketError => ex
+      raise Fleet::ConnectionError, ex.message
+    end
+
+    def escape_path(path)
+      URI.escape(path).gsub(/@/, '%40')
+    end
+
+    def raise_error(resp)
+      error = JSON.parse(resp.body)['error']
+      class_name = Fleet::Error::HTTP_CODE_MAP.fetch(resp.status, 'Error')
+
+      fail Fleet.const_get(class_name).new(
+        error['message'],
+        error['code'])
+    end
+  end
+end