fleet-api 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68e27564af5b67b5721f95aa609aedeb84f1fadd
-  data.tar.gz: 40f0c7cec0121c38fd9a560bd6445b96977f7108
+  metadata.gz: 40cafdb1518899f8d9da9e7621e01bb0b77b2282
+  data.tar.gz: 29fdaa40bb4ff55aa9af252a2f75658d9b5d1c61
 SHA512:
-  metadata.gz: 3c0a1bc9e12034e59186ee1abdc87a025475a027e038b564d3c8e1fb90c1873a0da79a1afb1534be69f301758261fbf53bf25fe81bbea8e2d5795b53caeb2752
-  data.tar.gz: 69d67b8d08c127b5771e5727ebb593ea03d3f184df22924cee95c5b88a642819ccb37f0162d545dde689fdb2a4527c1446075a8b3b38c948885646d7f8c35649
+  metadata.gz: 892ebd1582a5b7a84e7460e08573962dd66cf0cd446b111403f2e4f80623ad812cf6756e84df60dc48a53060bfcdba06f3b9172010530b2cda1e32fec51c0df2
+  data.tar.gz: 6748da6745a7a3dac060f9fbd56797cd01a91d5849da9e149bdd382373c778bd5977d8c4287c2802801f390aeee17c12cc8fd971e02efea1cb4503b02cf114d1

data/.travis.yml

@@ -2,5 +2,4 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.5
-  - 2.2.0
+  - 2.1.1

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+1.0.0 - 2015-02-17
+------------------
+
+### Added
+- Support for official Fleet API (no longer reading/writing directly from/to etcd)
+- New get_unit_state and get_unit_file methods
+
+### Fixed
+- Proper encoding of @ symbol when submitting unit templates
+
 0.9.0 - 2015-01-14
 ------------------
 

data/Gemfile.lock

@@ -1,21 +1,16 @@
 PATH
   remote: .
   specs:
-    fleet-api (0.8.0)
-      faraday (= 0.8.9)
-      faraday_middleware (= 0.9.0)
+    fleet-api (0.6.0)
+      excon (>= 0.27.4)
 
 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)
+    excon (0.41.0)
     multi_json (1.10.1)
-    multipart-post (1.2.0)
     rake (10.3.2)
     rspec (3.0.0)
       rspec-core (~> 3.0.0)

data/README.md

@@ -2,20 +2,12 @@ fleet-api
 =========
 
 [![Gem Version](https://badge.fury.io/rb/fleet-api.svg)](http://badge.fury.io/rb/fleet-api)
-[![Build Status](https://api.shippable.com/projects/540e7b283479c5ea8f9ebd66/badge?branchName=master)](https://www.shippable.com/projects/53f3a91a5491229d0207e4d9)
+[![Build Status](https://api.shippable.com/projects/540e7b283479c5ea8f9ebd66/badge?branchName=master)](https://app.shippable.com/projects/540e7b283479c5ea8f9ebd66/builds/latest)
 
 Provides a Ruby wrapper around the CoreOS Fleet API.
 
 The client allows programmatic access to most of the *fleetctl* commands including the ability to load, start, stop, unload and destroy unit files.
 
-At this point, there is no official Fleet API (though one is [in the works](https://github.com/coreos/fleet/blob/master/Documentation/api-v1-alpha.md)) so this library mimcs the behavior of the *fleetctl* command line tool and simply writes data to the [etcd]() key-value-store. The Fleet daemon reads data out of specific keys in etcd and processes it as appropiate.
-
-As work on the actual Fleet API progresses, this library will be refactored to use the real API. An initial pass at implementing a client for the official Fleet API can be found on the [feature/official-api](https://github.com/CenturyLinkLabs/fleet-api/tree/feature/official-api) branch.
-
-An alternative implementation is available in the [cloudspace/ruby-fleetctl](https://github.com/cloudspace/ruby-fleetctl) gem. The *ruby-fleetctl* gem takes a different approach and uses SSH to interact directly with the *fleetctl* binary to send commands. Our approach of writing directly to etcd cuts out the *fleetctl* middleman but is in more danger of being broken by future releases since we're effectively using a "private API".
-
-The current version of the *fleet-api* gem is known to work with version 0.8.0 of Fleet.
-
 ### Installation
 
 Install the gem directly:
@@ -29,17 +21,16 @@ Alternatively, add this line to your application's Gemfile:
 
 ### Usage
 
-Configure the URL for the etcd API:
+Configure the URL for the Fleet API:
 
     require 'fleet'
 
     Fleet.configure do |fleet|
-      fleet.fleet_api_url = 'http://10.1.42.1:4001'
+      fleet.fleet_api_url = 'http://10.1.42.1:49153'
     end
 
-If you don't provide an explicit value for the `.fleet_api_url` attribute, it will default to using the value of the `FLEETCTL_ENDPOINT` environment variable.
+If you don't provide an explicit value for the `.fleet_api_url` attribute, it will default to using the value of the `FLEETCTL_ENDPOINT` environment variable (if present) or the socket at `unix:///var/run/fleet.sock`.
 
-**Note: since this Fleet API is not yet available in the stable version of CoreOS, the URL value provided must be the endpoint for the etcd API.**
 
 #### Service Definitions
 
@@ -63,18 +54,18 @@ This unit file would be represented as the following Ruby hash.
 	    'ExecStart' => "/bin/bash -c \"while true; do sleep 1; done\""
 	  }
 	}
-	
-If you need mutiple values for a single statement (like multiple `ExecStart` instructions) you can use an array of strings:
 
-	{
-	  'Unit' => {
-	    'Description' => 'Useless infinite loop'
-	  },
-	  'Service' => {
-	    'ExecStart' => ["/bin/bash -c \"while true; do sleep 1; done\"", "some other command"]
-	  }
-	}
+If you need mutiple values for a single statement (like multiple `ExecStart` instructions) you can use an array of strings:
 
+    {
+      'Unit' => {
+        'Description' => 'Useless infinite loop'
+      },
+      'Service' => {
+        'ExecStart' => ["/bin/bash -c \"while true; do sleep 1; done\"", "some other command"]
+      }
+    }
+	
 #### Loading a Unit File
 
 Equivalent of `fleetctl load`:
@@ -121,16 +112,23 @@ Equivalent of `fleetctl destroy`:
     client = Fleet.new
     client.destroy('forever.service')
     
+#### Listing Services
+
+Equivalent of `fleetctl list-units`:
+
+    client = Fleet.new
+    client.list
+
 #### Retrieving Service Status
 
 Equivalent of `fleetctl status`:
 
     client = Fleet.new
-    client.status('forever.service')
+    client.get_unit_state('forever.service')
 
-#### Listing Services
+#### Retrieving a Unit File
 
-Equivalent of `fleetctl list-units`:
+Retrieves contents and current state of a unit file:
 
     client = Fleet.new
-    client.list
+    client.get_unit_file('foo.service')

data/fleet-api.gemspec

@@ -15,8 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = %w(lib)
   gem.version       = Fleet::VERSION
   gem.required_ruby_version = '>= 1.9.3'
-  gem.add_dependency 'faraday', '= 0.8.9'
-  gem.add_dependency 'faraday_middleware', '= 0.9.0'
+  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'

data/lib/fleet/client/machines.rb

@@ -5,8 +5,7 @@ module Fleet
       MACHINES_RESOURCE = 'machines'
 
       def list_machines
-        opts = { consistent: true, recursive: true, sorted: true }
-        get(machines_path, opts)
+        get(machines_path, nil)
       end
 
       private

data/lib/fleet/client/state.rb

@@ -4,14 +4,8 @@ module Fleet
 
       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)
+      def list_states(options={})
+        get(state_path, options)
       end
 
       private
@@ -23,3 +17,4 @@ module Fleet
     end
   end
 end
+

data/lib/fleet/client/unit.rb

@@ -2,29 +2,32 @@ module Fleet
   class Client
     module Unit
 
-      UNIT_RESOURCE = 'unit'
+      UNITS_RESOURCE = 'units'
 
       def list_units()
-        get(unit_path)
+        get(units_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)
+      def get_unit(name)
+        get(units_path(name))
       end
 
-      def delete_unit(unit_sha1)
-        opts = { dir: false, recursive: false }
-        delete(unit_path(unit_sha1), opts)
+      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 unit_path(*parts)
-        resource_path(UNIT_RESOURCE, *parts)
+      def units_path(*parts)
+        resource_path(UNITS_RESOURCE, *parts)
       end
 
     end

data/lib/fleet/client.rb

@@ -1,20 +1,14 @@
-require 'json'
 require 'fleet/connection'
 require 'fleet/error'
 require 'fleet/request'
 require 'fleet/service_definition'
-require 'fleet/client/job'
 require 'fleet/client/machines'
-require 'fleet/client/state'
 require 'fleet/client/unit'
+require 'fleet/client/state'
 
 module Fleet
   class Client
 
-    FLEET_PATH = 'v2/keys/_coreos.com/fleet'
-    MAX_RETRIES = 20
-    SLEEP_TIME = (10.0 / MAX_RETRIES.to_f)
-
     attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
 
     def initialize(options={})
@@ -27,35 +21,30 @@ module Fleet
     include Fleet::Connection
     include Fleet::Request
 
-    include Fleet::Client::Job
     include Fleet::Client::Machines
-    include Fleet::Client::State
     include Fleet::Client::Unit
+    include Fleet::Client::State
 
     def list
-      machines = list_machines['node']['nodes'] || []
+      machines = list_machines['machines'] || []
       machine_ips = machines.each_with_object({}) do |machine, h|
-        m = JSON.parse(machine['nodes'].first['value'])
-        h[m['ID']] = m['PublicIP']
+        h[machine['id']] = machine['primaryIP']
       end
 
-      states = list_states['node']['nodes'] || []
+      states = list_states['states'] || []
       states.map do |service|
-        s = JSON.parse(service['value'])
-        machine_id = s['machineState']['ID']
-
         {
-          name: service['key'].split('/').last,
-          load_state: s['loadState'],
-          active_state: s['activeState'],
-          sub_state: s['subState'],
-          machine_id: machine_id,
-          machine_ip: machine_ips[machine_id]
+          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 load(name, service_def=nil, sync=false)
+    def load(name, service_def=nil)
 
       unless name =~ /\A[a-zA-Z0-9:_.@-]+\Z/
         raise ArgumentError, 'name may only contain [a-zA-Z0-9:_.@-]'
@@ -63,85 +52,56 @@ module Fleet
 
       if service_def
         unless service_def.is_a?(ServiceDefinition)
-          service_def = ServiceDefinition.new(name, service_def)
+          service_def = ServiceDefinition.new(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)
+          create_unit(name, service_def.to_unit(name))
         rescue Fleet::PreconditionFailed
         end
+      else
+        opts = { 'desiredState' => 'loaded', 'name' => name }
+        update_unit(name, opts)
       end
+    end
 
-      update_job_target_state(name, :loaded)
-      wait_for_load_state(name, 'loaded') if sync
+    def start(name)
+      opts = { 'desiredState' => 'launched', 'name' => name }
+      update_unit(name, opts)
     end
 
-    def start(service_name)
-      update_job_target_state(service_name, :launched)
+    def stop(name)
+      opts = { 'desiredState' => 'loaded', 'name' => name }
+      update_unit(name, opts)
     end
 
-    def stop(service_name, sync=false)
-      update_job_target_state(service_name, :loaded)
-      wait_for_load_state(service_name, 'loaded') if sync
+    def unload(name)
+      opts = { 'desiredState' => 'inactive', 'name' => name }
+      update_unit(name, opts)
     end
 
-    def unload(service_name, sync=false)
-      update_job_target_state(service_name, :inactive)
-      wait_for_load_state(service_name, :no_state) if sync
+    def destroy(name)
+      delete_unit(name)
     end
 
-    def destroy(service_name, sync=false)
-      delete_job(service_name)
-      wait_for_load_state(service_name, :no_state) if sync
+    def status(name)
+      get_unit(name)["currentState"].to_sym
     end
 
-    def status(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
+    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(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 status(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
+      parts.unshift('fleet', fleet_api_version, resource).join('/')
     end
   end
 end

data/lib/fleet/configuration.rb

@@ -1,24 +1,20 @@
-require 'faraday'
 require 'logger'
 
 module Fleet
   module Configuration
 
     VALID_OPTIONS_KEYS = [
-      :adapter,
       :fleet_api_url,
+      :fleet_api_version,
       :open_timeout,
       :read_timeout,
-      :ssl_options,
-      :proxy,
       :logger
     ]
 
-    DEFAULT_ADAPTER = Faraday.default_adapter
-    DEFAULT_ETCD_API_URL = ENV['FLEETCTL_ENDPOINT']
+    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_SSL_OPTIONS = { verify: false }
     DEFAULT_LOGGER = ::Logger.new(STDOUT)
 
     attr_accessor(*VALID_OPTIONS_KEYS)
@@ -33,11 +29,10 @@ module Fleet
     end
 
     def reset
-      self.adapter = DEFAULT_ADAPTER
-      self.fleet_api_url = DEFAULT_ETCD_API_URL
+      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.ssl_options = DEFAULT_SSL_OPTIONS
       self.logger = DEFAULT_LOGGER
     end
   end

data/lib/fleet/connection.rb

@@ -1,24 +1,33 @@
-require 'faraday'
-require 'faraday_middleware'
-require 'fleet/middleware/response/raise_error'
+require 'excon'
 
 module Fleet
   module Connection
 
     def connection
       options = {
-        url: fleet_api_url,
-        ssl: ssl_options,
-        proxy: proxy
+        read_timeout: read_timeout,
+        connect_timeout: open_timeout,
+        headers: { 'User-Agent' => user_agent, 'Accept' => 'application/json' }
       }
 
-      Faraday.new(options) do |faraday|
-        faraday.request :url_encoded
-        faraday.response :json
-        faraday.response :raise_fleet_error
-        faraday.response :follow_redirects
-        faraday.adapter adapter
+      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

@@ -4,10 +4,9 @@ module Fleet
     attr_reader :error_code
     attr_reader :cause
 
-    def initialize(msg, error_code=nil, cause=nil)
+    def initialize(msg, error_code=nil)
       super(msg)
       @error_code = error_code
-      @cause = cause
     end
 
     HTTP_CODE_MAP = {

data/lib/fleet/request.rb

@@ -1,3 +1,4 @@
+require 'json'
 require 'fleet/version'
 
 module Fleet
@@ -5,52 +6,54 @@ module Fleet
 
     private
 
-    [:get, :head, :put, :post, :delete].each do |method|
-      define_method(method) do |path, options={}, headers={}|
-        request(connection, method, path, options, headers)
+    [: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, headers)
-      options ||= {}
-
-      response = connection.send(method) do |request|
-        request.options[:open_timeout] = open_timeout
-        request.options[:timeout] = read_timeout
-        request.headers = {
-          user_agent: user_agent,
-          accept: 'application/json'
-        }.merge(headers)
-
-        request.path = URI.escape(path)
-
-        case method
-        when :delete, :get, :head
-          request.params = options unless options.empty?
-        when :post, :put
-          if options.key?(:querystring)
-            request.params = options[:querystring]
-            request.body = options[:body]
-          else
-            request.body = options unless options.empty?
-          end
-        end
+    def 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
 
-      response.body
-    rescue Faraday::Error::ConnectionFailed => ex
+      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
 
     private
 
-    def user_agent
-      ua_chunks = []
-      ua_chunks << "fleet/#{Fleet::VERSION}"
-      ua_chunks << "(#{RUBY_ENGINE}; #{RUBY_VERSION}p#{RUBY_PATCHLEVEL}; #{RUBY_PLATFORM})"
-      ua_chunks << "faraday/#{Faraday::VERSION}"
-      ua_chunks << "(#{adapter})"
-      ua_chunks.join(' ')
+    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