fleet-api 0.0.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bcab7f3762c80b4d843b7398603462486b6adc3
-  data.tar.gz: fd587b58a42bbe1fcaf4ec29e88fedc16dcb3fd0
+  metadata.gz: ded5145e7361d7b0e441c91f3811a783a11ec94e
+  data.tar.gz: b544579b3f35b5764b4a863618d0b96b38c68442
 SHA512:
-  metadata.gz: d4fbd90db07fa039256d3798acd6cbd780536b5649a912ef28c5ebe8ee99ce6a4ed11a845d50a503c4a55d3b135a8302663918e217e541c8de591c5b30a68860
-  data.tar.gz: c429704b2f41f073d7a55d798d289b2abbe36c1d04e5124478e66b1653181df6c143b6b5b0b125cd8ed15c08a818cd021a6b30394dd82a93489983745c0a9f6c
+  metadata.gz: b748b4fc6014400b8228415d432045d379ba191469a80e08c534bf16180126ee4a37f1d6b074043d2d86aa9e82eaac4fcd12a5a907fb94256028a87562d6cf08
+  data.tar.gz: 512d2230352cfa529fbeb4a7c412fab72bde79b68660f6047d1fe5f81a76a25464b85ee3d3939c60b5d56357927a86d1c3e8a5a8fc83547f6e80c1a2cae39dce

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fleet-api (0.0.1)
+    fleet-api (0.5.0)
       faraday (= 0.8.9)
       faraday_middleware (= 0.9.0)
 
@@ -44,5 +44,5 @@ DEPENDENCIES
   fleet-api!
   rake
   rspec (~> 3.0)
-  simplecov
-  simplecov-rcov
+  simplecov (~> 0.9.0)
+  simplecov-rcov (~> 0.2.3)

data/LICENSE

@@ -186,7 +186,7 @@ Apache License
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright {yyyy} {name of copyright owner}
+   Copyright 2014 CenturyLink
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -1,2 +1,115 @@
 fleet-api
 =========
+
+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 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.5.0 of Fleet which ships with the the current stable version of CoreOS (367.1.0)
+
+### Installation
+
+Install the gem directly:
+
+    gem install fleet-api
+
+Alternatively, add this line to your application's Gemfile:
+
+    gem 'fleet-api', require: 'fleet'
+
+
+### Usage
+
+Configure the URL for the etcd API:
+
+    require 'fleet'
+
+    Fleet.configure do |fleet|
+      fleet.fleet_api_url = 'http://10.1.42.1:4001'
+    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.
+
+**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
+
+When submitting a service definition to the `Fleet::Client` you must convert your [unit file](http://www.freedesktop.org/software/systemd/man/systemd.unit.html) into a Ruby hash. Each section in the unit file is represented as a key/value pair in the hash where the key is the name of the section and the value is another hash containing all the statements for that section.
+
+For example, look at the following unit file.
+
+	[Unit]
+	Description=Useless infinite loop
+	
+	[Service]
+	ExecStart=/bin/bash -c "while true; do sleep 1; done"
+
+This unit file would be represented as the following Ruby hash.
+	
+	{
+	  'Unit' => {
+	    'Description' => 'Useless infinite loop'
+	  },
+	  'Service' => {
+	    'ExecStart' => "/bin/bash -c \"while true; do sleep 1; done\""
+	  }
+	}
+	
+#### Loading a Unit File
+
+Equivalent of `fleetctl load`:
+
+	service = {
+	  'Unit' => {
+	    'Description' => 'Useless infinite loop'
+	  },
+	  'Service' => {
+	    'ExecStart' => "/bin/bash -c \"while true; do sleep 1; done\""
+	  }
+	}
+	
+	client = Fleet.new
+	client.load('forever.service', service)
+	
+Note that the name you pass-in as the first parameter to the `.load` method should end in ".service"
+
+#### Starting a Service
+
+Equivalent of `fleetctl start`:
+
+    client = Fleet.new
+    client.start('forever.service')
+    
+#### Stopping a Service
+
+Equivalent of `fleetctl stop`:
+
+    client = Fleet.new
+    client.stop('forever.service')
+
+#### Unloading a Unit File
+
+Equivalent of `fleetctl unload`:
+
+    client = Fleet.new
+    client.unload('forever.service')
+    
+#### Destroying a Service
+
+Equivalent of `fleetctl destroy`:
+
+    client = Fleet.new
+    client.destroy('forever.service')
+    
+#### Retrieving Service Status
+
+Equivalent of `fleetctl status`:
+
+    client = Fleet.new
+    client.status('forever.service')

data/fleet-api.gemspec

@@ -7,16 +7,18 @@ Gem::Specification.new do |gem|
   gem.summary       = 'A simple REST client for the CoreOS Fleet API'
   gem.homepage      = 'https://github.com/centurylinklabs/fleet-api'
   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-api'
   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_development_dependency 'rake'
   gem.add_development_dependency 'rspec', '~> 3.0'
-  gem.add_development_dependency 'simplecov'
-  gem.add_development_dependency 'simplecov-rcov'
+  gem.add_development_dependency 'simplecov', '~> 0.9.0'
+  gem.add_development_dependency 'simplecov-rcov', '~> 0.2.3'
 end

data/lib/fleet/client.rb

@@ -12,7 +12,7 @@ module Fleet
 
     FLEET_PATH = 'v2/keys/_coreos.com/fleet'
     MAX_RETRIES = 10
-    SLEEP_TIME = (1.0 / 10.0)
+    SLEEP_TIME = (4.0 / MAX_RETRIES.to_f)
 
     attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
 
@@ -30,24 +30,26 @@ module Fleet
     include Fleet::Client::State
     include Fleet::Client::Unit
 
-    def load(name, service_def={})
+    def load(name, service_def=nil)
 
-      unless service_def.is_a?(ServiceDefinition)
-        service_def = ServiceDefinition.new(name, service_def)
-      end
+      if 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_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
+        begin
+          create_job(service_def.name, service_def.to_job)
+        rescue Fleet::PreconditionFailed
+        end
       end
 
-      update_job_target_state(service_def.name, :loaded)
-      wait_for_load_state(service_def.name, 'loaded')
+      update_job_target_state(name, :loaded)
+      wait_for_load_state(name, 'loaded')
     end
 
     def start(service_name)
@@ -69,7 +71,7 @@ module Fleet
       wait_for_load_state(service_name, :no_state)
     end
 
-    def states(service_name)
+    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|
@@ -86,7 +88,7 @@ module Fleet
     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
+          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

data/lib/fleet/version.rb

@@ -1,3 +1,3 @@
 module Fleet
-  VERSION = '0.0.1'.freeze unless defined?(Fleet::VERSION)
+  VERSION = '0.5.1'.freeze unless defined?(Fleet::VERSION)
 end

data/spec/fleet/client_spec.rb

@@ -32,85 +32,117 @@ describe Fleet::Client do
       { 'node' => { 'value' => '{ "loadState": "loaded" }' } }
     end
 
-    before do
-      allow(subject).to receive(:create_unit).and_return(nil)
-      allow(subject).to receive(:create_job).and_return(nil)
-      allow(subject).to receive(:update_job_target_state).and_return(nil)
-      allow(subject).to receive(:get_state).and_return(fleet_state)
-      allow(Fleet::ServiceDefinition).to receive(:new).and_return(sd)
-    end
+    context 'when a service definition is provided' do
+      before do
+        allow(subject).to receive(:create_unit).and_return(nil)
+        allow(subject).to receive(:create_job).and_return(nil)
+        allow(subject).to receive(:update_job_target_state).and_return(nil)
+        allow(subject).to receive(:get_state).and_return(fleet_state)
+        allow(Fleet::ServiceDefinition).to receive(:new).and_return(sd)
+      end
 
-    it 'invokes #create_unit' do
-      expect(subject).to receive(:create_unit)
-        .with(sd.sha1, sd.to_unit)
+      it 'invokes #create_unit' do
+        expect(subject).to receive(:create_unit)
+          .with(sd.sha1, sd.to_unit)
 
-      subject.load(name, service_def)
-    end
+        subject.load(name, service_def)
+      end
 
-    it 'invokes #create_job' do
-      expect(subject).to receive(:create_job)
-        .with(sd.name, sd.to_job)
+      it 'invokes #create_job' do
+        expect(subject).to receive(:create_job)
+          .with(sd.name, sd.to_job)
 
-      subject.load(name, service_def)
-    end
+        subject.load(name, service_def)
+      end
 
-    it 'invokes #update_job_target_state' do
-      expect(subject).to receive(:update_job_target_state)
-        .with(sd.name, :loaded)
+      it 'invokes #update_job_target_state' do
+        expect(subject).to receive(:update_job_target_state)
+          .with(sd.name, :loaded)
 
-      subject.load(name, service_def)
-    end
+        subject.load(name, service_def)
+      end
 
-    it 'checks the job state' do
-      expect(subject).to receive(:get_state).with(sd.name)
-      subject.load(name, service_def)
-    end
+      it 'checks the job state' do
+        expect(subject).to receive(:get_state).with(sd.name)
+        subject.load(name, service_def)
+      end
 
-    context 'when #create_unit raises PreconditionFailed' do
+      context 'when #create_unit raises PreconditionFailed' do
 
-      before do
-        allow(subject).to receive(:create_unit)
-          .and_raise(Fleet::PreconditionFailed.new('boom'))
+        before do
+          allow(subject).to receive(:create_unit)
+            .and_raise(Fleet::PreconditionFailed.new('boom'))
+        end
+
+        it 'does not blow up' do
+          expect { subject.load(name, service_def) }.to_not raise_error
+        end
       end
 
-      it 'does not blow up' do
-        expect { subject.load(name, service_def) }.to_not raise_error
+      context 'when #create_unit raises something other than PreconditionFailed' do
+
+        before do
+          allow(subject).to receive(:create_unit)
+            .and_raise(Fleet::BadRequest.new('boom'))
+        end
+
+        it 'propagates the error' do
+          expect { subject.load(name, service_def) }.to(raise_error(Fleet::BadRequest))
+        end
       end
-    end
 
-    context 'when #create_unit raises something other than PreconditionFailed' do
+      context 'when #create_job raises PreconditionFailed' do
 
-      before do
-        allow(subject).to receive(:create_unit)
-          .and_raise(Fleet::BadRequest.new('boom'))
+        before do
+          allow(subject).to receive(:create_job)
+            .and_raise(Fleet::PreconditionFailed.new('boom'))
+        end
+
+        it 'does not blow up' do
+          expect { subject.load(name, service_def) }.to_not raise_error
+        end
       end
 
-      it 'propagates the error' do
-        expect { subject.load(name, service_def) }.to(raise_error(Fleet::BadRequest))
+      context 'when #create_job raises something other than PreconditionFailed' do
+
+        before do
+          allow(subject).to receive(:create_job)
+            .and_raise(Fleet::BadRequest.new('boom'))
+        end
+
+        it 'propagates the error' do
+          expect { subject.load(name, service_def) }.to(raise_error(Fleet::BadRequest))
+        end
       end
     end
 
-    context 'when #create_job raises PreconditionFailed' do
+    context 'when no service definition is provided' do
 
       before do
-        allow(subject).to receive(:create_job)
-          .and_raise(Fleet::PreconditionFailed.new('boom'))
+        allow(subject).to receive(:update_job_target_state).and_return(nil)
+        allow(subject).to receive(:get_state).and_return(fleet_state)
       end
 
-      it 'does not blow up' do
-        expect { subject.load(name, service_def) }.to_not raise_error
+      it 'does NOT invoke #create_unit' do
+        expect(subject).to_not receive(:create_unit)
+        subject.load(name)
       end
-    end
 
-    context 'when #create_job raises something other than PreconditionFailed' do
+      it 'does NOT invoke #create_job' do
+        expect(subject).to_not receive(:create_job)
+        subject.load(name)
+      end
 
-      before do
-        allow(subject).to receive(:create_job)
-          .and_raise(Fleet::BadRequest.new('boom'))
+      it 'invokes #update_job_target_state' do
+        expect(subject).to receive(:update_job_target_state)
+          .with(sd.name, :loaded)
+
+        subject.load(name)
       end
 
-      it 'propagates the error' do
-        expect { subject.load(name, service_def) }.to(raise_error(Fleet::BadRequest))
+      it 'checks the job state' do
+        expect(subject).to receive(:get_state).with(sd.name)
+        subject.load(name)
       end
     end
   end
@@ -223,7 +255,7 @@ describe Fleet::Client do
     end
   end
 
-  describe '#states' do
+  describe '#status' do
 
     let(:service_name) { 'foo.service' }
 
@@ -237,11 +269,11 @@ describe Fleet::Client do
 
     it 'retrieves service state from the fleet client' do
       expect(subject).to receive(:get_state).with(service_name)
-      subject.states(service_name)
+      subject.status(service_name)
     end
 
     it 'returns the state hash w/ normalized keys' do
-      expect(subject.states(service_name)).to eq(load: 'loaded', run: 'running')
+      expect(subject.status(service_name)).to eq(load: 'loaded', run: 'running')
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fleet-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.5.1
 platform: ruby
 authors:
 - CenturyLink
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-15 00:00:00.000000000 Z
+date: 2014-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -70,30 +70,30 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: simplecov-rcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.3
 description: A simple REST client for the CoreOS Fleet API
 email:
 - clt-labs-futuretech@centurylink.com
@@ -102,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -144,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -152,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: A simple REST client for the CoreOS Fleet API