fleet-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab037a7d8ce635a4fc2e165ef082a8bfaab9eff0
+  data.tar.gz: 195f6845b15e9f081f2bd0a1d052b41aab89ba52
+SHA512:
+  metadata.gz: dbcea8aabc10e10fa23f9bc63b211ea7b093b33191544b3b3b9ddfd224f75bb8da232c1d15cf23ec1f2b91d9ce22128dab56279c6216888ca0963296595df6bc
+  data.tar.gz: 82d37ca20d66b4c533f1e407d83fa39770545941b6b20334bd15d71bf170f9283e9dc05ee829833f90e75ce73cb5b4d71a58b2034f5ee9bbdc08b33d5fb5ffb7

data/.gitignore

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

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,67 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+1.2.0 - 2015-08-13
+------------------
+
+### Added
+- Support for paginated responses (robholland)
+
+1.1.0 - 2015-02-19
+------------------
+
+### Added
+- New submit method for submitting units without loading them
+
+### Fixed
+- Error where units are not loaded when submitted via the load method
+- Out-dated Gemfile.lock
+
+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
+------------------
+
+### Added
+- Support for listing all loaded units
+
+0.8.0 - 2014-11-07
+------------------
+
+### Added
+- Support for mutl-value options in unit file
+- Enforcement of Fleet service naming conventions
+
+0.6.1 - 2014-09-20
+------------------
+
+### Fixed
+- Default to async operations to address performance issues
+
+0.6.0 - 2014-09-05
+------------------
+
+### Added
+- Compatibility for Fleet 0.6.x (not backward compatible with older versions of Fleet)
+
+0.5.3 - 2014-08-26
+------------------
+
+### Added
+- Support for listing machines in CoreOS cluster
+
+### Fixed
+- Will follow etcd redirects when communicating with non-master endpoints
+
+0.5.2 - 2014-08-20
+------------------
+
+Initial release

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    fleet-api (1.1.0)
+      excon (>= 0.27.4)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    excon (0.44.2)
+    multi_json (1.10.1)
+    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 (~> 0.9.0)
+  simplecov-rcov (~> 0.2.3)

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 2014 CenturyLink
+
+   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,151 @@
+fleet-api
+=========
+
+[![Gem Version](https://badge.fury.io/rb/fleet-api.svg)](http://badge.fury.io/rb/fleet-api)
+[![Circle CI](https://circleci.com/gh/CenturyLinkLabs/fleet-api.svg?style=svg)](https://circleci.com/gh/CenturyLinkLabs/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.
+
+**Important Note:** As of version 1.0.0, this gem is now using the official Fleet REST API. Previous versions of this gem communicated with Fleet by reading/writing directly from/to the etcd key-value store. While this approach was functional, it was extremely brittle due to the fact that we were essentially using a private API. Now that the Fleet API has hit version 1.0 and is presumably stable it makes more sense to leverage the official API.
+
+Users migrating from an older version of the Gem will simply need to make sure they configure it with the Fleet API endpoint instead of the etcd API endpoint.
+
+### 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 Fleet API:
+
+    require 'fleet'
+
+    Fleet.configure do |fleet|
+      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 present) or the socket at `unix:///var/run/fleet.sock`.
+
+
+#### 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\""
+	  }
+	}
+
+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"]
+      }
+    }
+	
+#### Submitting a Unit File
+
+Equivalent of `fleetctl submit`:
+
+	service = {
+	  'Unit' => {
+	    'Description' => 'Useless infinite loop'
+	  },
+	  'Service' => {
+	    'ExecStart' => "/bin/bash -c \"while true; do sleep 1; done\""
+	  }
+	}
+	
+	client = Fleet.new
+	client.submit('forever.service', service)
+	
+Note that the name you pass-in as the first parameter to the `.submit` method should end in ".service"
+
+#### Loading a Unit File
+
+Equivalent of `fleetctl load`:
+
+	client = Fleet.new
+	client.load('forever.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')
+    
+#### Listing Services
+
+Equivalent of `fleetctl list-units`:
+
+    client = Fleet.new
+    client.list
+
+#### Retrieving Service Status
+
+Equivalent of `fleetctl status`:
+
+    client = Fleet.new
+    client.get_unit_state('forever.service')
+
+Retrieves current status of a unit file:
+
+    client = Fleet.new
+    client.status('forever.service')
+
+#### Retrieving a Unit File
+
+Retrieves contents and current state of a unit file:
+
+    client = Fleet.new
+    client.get_unit_file('foo.service')
+