coreos-fleet-api 0.1.0

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.2
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    coreos-fleet-api (0.1.0)
+      addressable (~> 2.2)
+      cistern (~> 0.11)
+      faraday (~> 0.9)
+      faraday_middleware (~> 0.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    cistern (0.11.0)
+    diff-lcs (1.2.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.9.1)
+      faraday (>= 0.7.4, < 0.10)
+    multipart-post (2.0.0)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.0)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coreos-fleet-api!
+  rspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Ian Coffey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,7 @@
+coreos-fleet-api
+================
+
+A client for the fleet alpha api.
+
+## Alpha status
+As the API is alpha, changes are expected. This client will be updated to track those changes.

data/coreos-fleet-api.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fleet_api/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "coreos-fleet-api"
+  gem.version       = FleetAPI::VERSION
+  gem.authors       = ["Ian Coffey"]
+  gem.email         = ["ian.coffey@gmail.com"]
+  gem.description   = %q{CoreOS Fleet Alpha API Client}
+  gem.summary       = %q{Client library for communicating with the CoreOS Alpha API}
+  gem.homepage      = ""
+
+  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.require_paths = ["lib"]
+
+  gem.add_dependency "faraday", "~> 0.9"
+  gem.add_dependency "faraday_middleware", "~> 0.9"
+  gem.add_dependency "cistern", "~> 0.11"
+  gem.add_dependency "addressable", "~> 2.2"
+end

data/lib/fleet_api.rb

@@ -0,0 +1,22 @@
+require 'addressable/uri'
+require 'cistern'
+require 'json'
+require 'faraday'
+require 'faraday_middleware'
+require 'logger'
+require 'securerandom'
+
+require 'fleet_api/version'
+
+module FleetAPI
+  autoload :Client, 'fleet_api/client'
+  autoload :Collection, 'fleet_api/collection'
+  autoload :PaginatedCollection, 'fleet_api/paginated_collection'
+  autoload :Model, 'fleet_api/attributes'
+  autoload :Response, 'fleet_api/response'
+  autoload :Json, "fleet_api/json"
+  autoload :Mock, "fleet_api/mock"
+  autoload :Model, "fleet_api/model"
+
+# TODO: handle the weirdo paging
+end

data/lib/fleet_api/attributes.rb

@@ -0,0 +1,28 @@
+module FleetAPI::Attributes
+  def assoc_reader(name, options={})
+    assoc_key  = options[:key] || "#{name}_id"
+    collection = options[:collection] || "#{name}s"
+    define_method(name) do
+      if assoc_id = self.send(assoc_key)
+        self.connection.send(collection).get(assoc_id)
+      else self.instance_variable_get("@#{name}")
+      end
+    end
+  end
+
+  def assoc_writer(name, options={})
+    assoc_key = options[:key] || "#{name}_id"
+    define_method("#{name}=") do |assoc|
+      if assoc.is_a?(Cistern::Model)
+        self.send("#{assoc_key}=", assoc.identity)
+      else
+        self.instance_variable_set("@#{name}", assoc)
+      end
+    end
+  end
+
+  def assoc_accessor(name, options={})
+    assoc_reader(name, options)
+    assoc_writer(name, options)
+  end
+end

data/lib/fleet_api/client.rb

@@ -0,0 +1,123 @@
+class FleetAPI::Client < Cistern::Service
+  model_path "fleet_api/models"
+  request_path "fleet_api/requests"
+
+  model "unit"
+  request "get_unit"
+  request "get_units"
+  request "create_unit"
+  request "update_unit"
+  request "destroy_unit"
+  collection "units"
+
+  model "machine"
+  request "get_machines"
+  collection "machines"
+
+  recognizes :logger, :url
+
+  class Real
+    attr_reader :url, :path, :connection
+
+    def initialize(options={})
+      @url         = URI.parse(options[:url])
+      @logger      = Logger.new(nil)
+      adapter      = Faraday.default_adapter
+
+      @connection = Faraday.new(:url => url) do |faraday|
+        faraday.response :logger
+        faraday.response :json
+        faraday.request :multipart
+        faraday.request :json
+        faraday.adapter(*adapter)
+      end
+    end
+
+    def request(options={})
+      method  = (options[:method] || "get").to_s.downcase.to_sym
+      url     = Addressable::URI.parse(options[:url] || File.join(@url.to_s, options[:path] || "/"))
+      url.query_values = (url.query_values || {}).merge(options[:query] || {})
+      params  = options[:params] || {}
+      body    = options[:body]
+      headers = options[:headers] || {"Accept" => "application/json"}
+      headers.merge!("Content-Type" => "application/x-www-form-urlencoded") if !body && !params.empty?
+
+      response = @connection.send(method) do |req|
+        req.url(url.to_s)
+        req.headers.merge!(headers)
+        req.params.merge!(params)
+        req.body = body
+      end
+
+      FleetAPI::Response.new(
+        :status  => response.status,
+        :headers => response.headers,
+        :body    => response.body,
+        :request => {
+          :method  => method,
+          :url     => url,
+          :body    => body,
+          :headers => headers,
+        }
+      ).raise!
+    end
+  end
+
+  class Mock
+    def initialize(options={})
+      @url = options[:url] || "http://fleet-api.localhost"
+    end
+
+    def self.data
+      @data ||= {
+        :units => {},
+        :machines => {},
+       }
+    end
+
+    def self.reset!
+      @data = nil
+    end
+
+    def data
+      self.class.data
+    end
+
+    def response(options={})
+      url     = options[:url] || File.join(@url.to_s, options[:path] || "/")
+      method  = (options[:method] || :get).to_s.to_sym
+      status  = options[:status] || 200
+      body    = options[:body]
+      headers = {
+        "Content-Type" => "application/json; charset=utf-8"
+      }.merge(options[:headers] || {})
+
+      FleetAPI::Response.new(
+        :status  => status,
+        :headers => headers,
+        :body    => body,
+        :request => {
+          :method  => method,
+          :url     => url,
+          :body    => body,
+          :headers => headers,
+        }
+      ).raise!
+    end
+
+    def page(params, collection, object_root, options={})
+      resources   = options[:resources] || self.data[collection]
+      page_size   = (params["per_page"] || 20).to_i
+      page_index  = (params["page"] || 1).to_i
+      offset      = (page_index - 1) * page_size
+
+      resource_page = resources.values.reverse.slice(offset, page_size)
+
+      resource_page
+    end
+
+    def url_for_page(collection, token)
+      "<#{File.join(@url, collection.to_s)}??nextPageToken=#{token}"
+    end
+  end
+end

data/lib/fleet_api/collection.rb

@@ -0,0 +1,33 @@
+module FleetAPI::Collection
+  def self.included(klass)
+    klass.send(:extend, FleetAPI::Collection::Attributes)
+  end
+
+  module Attributes
+    def model_root(model_root)
+      @model_root = model_root
+    end
+
+    def model_request(model_request)
+      @model_request = model_request
+    end
+  end
+
+  def model_root
+    self.class.instance_variable_get(:@model_root)
+  end
+
+  def model_request
+    self.class.instance_variable_get(:@model_request)
+  end
+
+  def get(id)
+    if data = connection.send(self.model_request, {"name" => id}).body[self.model_root] # hax
+      new(data)
+    else
+      nil
+    end
+  rescue FleetAPI::Response::NotFound
+    nil
+  end
+end

data/lib/fleet_api/mock.rb

@@ -0,0 +1,23 @@
+module FleetAPI
+  class Mock
+    def self.uuid
+      SecureRandom.uuid
+    end
+
+    def self.random_id
+      existing_ids = []
+
+      while true do
+        id = SecureRandom.random_number(1000)
+        unless existing_ids.include?(id)
+          existing_ids << id
+          return id
+        end
+      end
+    end
+
+    def self.random_name
+      SecureRandom.hex(6)
+    end
+  end
+end

data/lib/fleet_api/model.rb

@@ -0,0 +1,7 @@
+class FleetAPI::Model < Cistern::Model
+  attr_accessor :errors
+
+  def save!
+    raise NotImplementedError
+  end
+end

data/lib/fleet_api/models/machine.rb

@@ -0,0 +1,6 @@
+class FleetAPI::Client::Machine < FleetAPI::Model
+  identity :name
+
+  attribute :id
+  attribute :primaryIP
+end

data/lib/fleet_api/models/machines.rb

@@ -0,0 +1,11 @@
+class FleetAPI::Client::Machines < Cistern::Collection
+  include FleetAPI::Collection
+  include FleetAPI::PaginatedCollection
+
+  model FleetAPI::Client::Machine
+
+  model_root "machine"
+  model_request :get_machine
+  collection_root "machines"
+  collection_request :get_machines
+end

data/lib/fleet_api/models/unit.rb

@@ -0,0 +1,24 @@
+class FleetAPI::Client::Unit < FleetAPI::Model
+  identity :name
+
+  attribute :machineID
+  attribute :currentState
+  attribute :desiredState
+  attribute :options
+
+  def save
+    requires :name
+    params = {
+      "desiredState" => self.desiredState,
+      "options" => self.options,
+      "name" => self.name
+    }
+
+    unless self.machineID # hax
+      request_attributes = connection.create_unit(params).body
+    else
+      params["name"] = self.name
+      self.connection.update_unit(params)
+    end
+  end
+end

data/lib/fleet_api/models/units.rb

@@ -0,0 +1,11 @@
+class FleetAPI::Client::Units < Cistern::Collection
+  include FleetAPI::Collection
+  include FleetAPI::PaginatedCollection
+
+  model FleetAPI::Client::Unit
+
+  model_root "unit"
+  model_request :get_unit
+  collection_root "units"
+  collection_request :get_units
+end

data/lib/fleet_api/paginated_collection.rb

@@ -0,0 +1,36 @@
+module FleetAPI::PaginatedCollection
+  def self.included(klass)
+    klass.attribute :nextPageToken
+    klass.send(:extend, FleetAPI::PaginatedCollection::Attributes)
+  end
+
+  module FleetAPI::PaginatedCollection::Attributes
+    def collection_root(collection_root)
+      @collection_root = collection_root
+    end
+
+    def collection_request(collection_request)
+      @collection_request = collection_request
+    end
+  end
+
+  def collection_root
+    self.class.instance_variable_get(:@collection_root)
+  end
+
+  def collection_request
+    self.class.instance_variable_get(:@collection_request)
+  end
+
+  def next_page
+    all("url" => self.next_link) if self.next_link
+  end
+
+  def all(params={})
+    response = connection.send(self.collection_request, params)
+
+    collection = self.clone.load(response.body[self.collection_root])
+
+    collection
+  end
+end

data/lib/fleet_api/requests/create_unit.rb

@@ -0,0 +1,26 @@
+class FleetAPI::Client
+  class Real
+    def create_unit(params={})
+      name = params["name"]
+
+      request(
+        :body   => params,
+        :method => 'PUT',
+        :path => "v1-alpha/units/#{name}",
+      )
+    end
+  end
+
+  class Mock
+    def create_unit(params={})
+      params['machineID'] = FleetAPI::Mock.random_id
+
+      self.data[:units][params['name']] = params
+
+      response(
+        :body   => {"unit" => self.data[:units][params['name']]},
+        :status => 200,
+      )
+    end
+  end
+end

data/lib/fleet_api/requests/destroy_unit.rb

@@ -0,0 +1,12 @@
+class FleetAPI::Client
+  class Real
+    def destroy_unit(params={})
+      name = params["name"]
+
+      request(
+        :path => "v1-alpha/units/#{name}",
+        :method   => 'DELETE',
+      )
+    end
+  end
+end # TODO: need some mock action

data/lib/fleet_api/requests/get_machines.rb

@@ -0,0 +1,26 @@
+class FleetAPI::Client
+  class Real
+    def get_machines(params={})
+      request(
+        :query  => query,
+        :method => 'GET',
+        :path   => "v1-alpha/machines",
+      )
+    end
+  end
+
+  class Mock
+    def get_machines(params={})
+      units = self.data['machines']
+
+      response(
+        :body    => {"machines" => machines},
+        :status  => 200,
+        :headers => {
+          "Content-Type" => "application/json; charset=utf8",
+        }
+      )
+    end
+  end
+end
+

data/lib/fleet_api/requests/get_unit.rb

@@ -0,0 +1,31 @@
+class FleetAPI::Client
+  class Real
+    def get_unit(params={})
+      name  = params["name"]
+      url = params["url"]
+
+      request(
+        :path => "v1-alpha/units/#{name}",
+        :url  => url,
+      )
+    end
+  end
+
+  class Mock
+    def get_unit(params={})
+      name = params['name']
+
+      if unit = self.data[:units][name]
+        response(
+          :body   => {'unit' => unit},
+          :status => 200,
+        )
+      else
+        response(
+          :body   => {"error" => "Couldn't find unit with name #{name}"},
+          :status => 404,
+        )
+      end
+    end
+  end
+end

data/lib/fleet_api/requests/get_units.rb

@@ -0,0 +1,25 @@
+class FleetAPI::Client
+  class Real
+    def get_units(params={})
+      request(
+        :method => 'GET',
+        :path   => "v1-alpha/units",
+      )
+    end
+  end
+
+  class Mock
+    def get_units(params={})
+      units = page(params, :units, "unit")
+
+      response(
+        :body    => {"units" => units},
+        :status  => 200,
+        :headers => {
+          "Content-Type" => "application/json; charset=utf8",
+        }
+      )
+    end
+  end
+end
+

data/lib/fleet_api/requests/update_unit.rb

@@ -0,0 +1,37 @@
+class FleetAPI::Client
+  class Real
+    def update_unit(params={})
+      name  = params["name"]
+      request(
+        :body   => params,
+        :method => 'PUT',
+        :path => "v1-alpha/units/#{name}",
+      )
+    end
+  end
+
+  class Mock
+    def update_unit(params={})
+      name = params['name']
+
+      unit = self.data[:units][name]
+      unless unit
+        response(
+          :body   => {"error" => "Couldn't find Unit with name #{name}"},
+          :status => 404,
+        )
+      end
+
+      update = params.delete("unit") || {}
+
+      updated_unit = unit.merge(update)
+
+      self.data[:units][unit['name']] = updated_unit
+
+      response(
+        :body   => {"unit" => updated_unit},
+        :status => 204,
+      )
+    end
+  end
+end

data/lib/fleet_api/response.rb

@@ -0,0 +1,35 @@
+class FleetAPI::Response
+  attr_reader :headers, :status, :body, :request
+
+  def initialize(options={})
+    @status  = options[:status]
+    @headers = options[:headers]
+    @body    = options[:body]
+    @request = options[:request]
+  end
+
+  def successful?
+    self.status.to_s =~ /(2\d\d|304)/
+  end
+
+  def raise!
+    if !successful?
+      raise((ClientError).new(self))
+    else self
+    end
+  end
+
+  class ClientError < StandardError
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+      super({
+          :body    => response.body,
+          :headers => response.headers,
+          :request => response.request,
+          :status  => response.status,
+        }.inspect)
+    end
+  end
+end

data/lib/fleet_api/version.rb

@@ -0,0 +1,3 @@
+module FleetAPI
+  VERSION = "0.1.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+Bundler.require(:test)
+Bundler.require(:darwin) if RUBY_PLATFORM.match(/darwin/)
+require File.expand_path("../../lib/fleet_api", __FILE__)
+Dir[File.expand_path("../{shared,support}/*.rb", __FILE__)].each{|f| require(f)}
+
+FleetAPI::Client.mock!
+
+FleetAPI::Client::Mock.timeout       = 0
+FleetAPI::Client::Mock.poll_interval = 0
+FleetAPI::Client::Real.timeout       = 10
+
+RSpec.configure do |config|
+  config.order = :random
+
+  config.before(:each) do
+    FleetAPI::Client.mocking? ? FleetAPI::Client.reset! : client.reset!
+  end
+end
+

data/spec/support/client.rb

@@ -0,0 +1,11 @@
+module ClientHelper
+  def create_client(attributes={})
+    attributes.merge!(logger: Logger.new(STDOUT)) if ENV['VERBOSE']
+
+    FleetAPI::Client.new(attributes)
+  end
+end
+
+RSpec.configure do |config|
+  config.include(ClientHelper)
+end

data/spec/support/unit.rb

@@ -0,0 +1,10 @@
+module UnitHelper
+  def create_unit(opts={})
+    opts['name'] ||= FleetAPI::Mock.random_name
+    client.units.create(opts)['unit']
+  end
+end
+
+RSpec.configure do |config|
+  config.include(UnitHelper)
+end

data/spec/units_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe 'units' do
+  let!(:client) { create_client }
+
+  it 'can create a new unit' do
+    unit = create_unit('name' => 'dude')
+    expect(unit).to be
+  end
+
+  it 'can GET a list of units' do
+    create_unit(
+      'name' => 'faux_1',
+    )
+    create_unit(
+      'name' => 'faux_2',
+    )
+
+    expect(client.units.all.count).to eq(2)
+  end
+
+  it "can show a unit" do
+    unit = create_unit('name' => 'fred')
+    name = unit['name']
+    expect(client.units.get(name)).to be
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: coreos-fleet-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ian Coffey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: cistern
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: CoreOS Fleet Alpha API Client
+email:
+- ian.coffey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- coreos-fleet-api.gemspec
+- lib/fleet_api.rb
+- lib/fleet_api/attributes.rb
+- lib/fleet_api/client.rb
+- lib/fleet_api/collection.rb
+- lib/fleet_api/mock.rb
+- lib/fleet_api/model.rb
+- lib/fleet_api/models/machine.rb
+- lib/fleet_api/models/machines.rb
+- lib/fleet_api/models/unit.rb
+- lib/fleet_api/models/units.rb
+- lib/fleet_api/paginated_collection.rb
+- lib/fleet_api/requests/create_unit.rb
+- lib/fleet_api/requests/destroy_unit.rb
+- lib/fleet_api/requests/get_machines.rb
+- lib/fleet_api/requests/get_unit.rb
+- lib/fleet_api/requests/get_units.rb
+- lib/fleet_api/requests/update_unit.rb
+- lib/fleet_api/response.rb
+- lib/fleet_api/version.rb
+- spec/spec_helper.rb
+- spec/support/client.rb
+- spec/support/unit.rb
+- spec/units_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Client library for communicating with the CoreOS Alpha API
+test_files:
+- spec/spec_helper.rb
+- spec/support/client.rb
+- spec/support/unit.rb
+- spec/units_spec.rb
+has_rdoc: