ncc-api 1.0.0

data/lib/ncc/instance.rb

@@ -0,0 +1,213 @@
+#!ruby
+# /* Copyright 2013 Proofpoint, Inc. All rights reserved.
+#    Copyright 2014 Evernote Corporation. All rights reserved.
+#
+# 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.
+# */
+
+
+class Hash
+
+    def deep_soft_merge(other)
+        r = self.dup
+        other.each_pair do |key, value|
+            if r.has_key? key
+                if r[key].respond_to? :to_hash and
+                        other[key].respond_to? :to_hash
+                    r[key] =
+                        r[key].to_hash.deep_soft_merge(other[key].to_hash)
+                end
+            else
+                r[key] = value
+            end
+        end
+        r
+    end
+
+    def delete_nil_values
+        self.keys.each { |k| delete(k) if self[k].nil? }
+        self
+    end
+
+end
+
+class NCC
+
+end
+
+class NCC::Instance
+
+    @@valid_statuses = %w(active build terminated error hard-reboot
+                          reboot provider-operation shutting-down
+                          suspending suspend unknown needs-verify)
+
+    attr_accessor :name, :environment, :id, :ip_address, :host,
+                  :console_log
+    attr_reader :image, :size, :status
+
+    # Should be mixed in
+    def debug(msg=nil)
+        msg ||= yield
+        log 'debug', msg
+    end
+
+    def warn(msg)
+        log 'warn', msg
+    end
+
+    def log(level, msg)
+        @logger.send(level.intern, "#<#{me}>: #{msg}") if
+            @logger.respond_to? level.intern
+    end
+
+    def initialize(cfg, opt={})
+        @cfg = cfg
+        @logger = opt[:logger] if opt.has_key? :logger
+        self.id = opt['id']
+        self.name = opt['name']
+        self.size = opt['size']
+        self.image = opt['image']
+        self.environment = opt['environment']
+        self.role = opt['role']
+        self.host = opt['host']
+        self.ip_address = opt['ip_address']
+        self.console_log = opt['console_log']
+        self.extra = opt['extra']
+    end
+
+    def with_defaults(*defaults)
+        obj = self.dup
+        defaults.each do |d|
+            next if d.nil?
+            obj.name ||= d['name']
+            obj.size ||= d['size']
+            obj.image ||= d['image']
+            obj.environment ||= d['environment']
+            obj.role ||= d['role']
+            obj.extra = d['extra']
+        end
+        obj
+    end
+
+    def role
+        @role
+    end
+
+    def role=(value)
+        if value.nil?
+            @role = []
+        elsif value.respond_to? :join
+            @role = value
+        else
+            @role = value.split(/, */)
+        end
+    end
+
+    def set_without_validation(fields)
+        fields.each_pair do |field, value|
+            case field
+            when :id
+                @id = value
+            when :name
+                @name = value
+            when :size
+                @size = value
+            when :image
+                @image = value
+            when :environment
+                @environment = value
+            when :role
+                self.role = value
+            when :extra
+                @extra = value
+            when :status
+                self.status = value
+            when :ip_address
+                @ip_address = value
+            when :host
+                @host = value
+            when :console_log
+                @console_log = value
+            else
+                raise NCC::Error, "Invalid field #{field.inspect}"
+            end
+        end
+    end
+
+    def image=(newimage)
+        raise NCC::Error, "Invalid image #{newimage.inspect}" unless
+            newimage.nil? or @cfg[:images].has_key? newimage
+        @image = newimage
+    end
+
+    def size=(newsize)
+        raise NCC::Error, "Invalid size ${newsize.inspect}" unless
+            newsize.nil? or @cfg[:sizes].has_key? newsize
+        @size = newsize
+    end
+
+    def clear_extra
+        @extra = nil
+    end
+
+    def extra(param=nil)
+        if param.nil?
+            @extra
+        else
+            if !@extra.nil? and @extra.has_key? param
+                @extra[param]
+            else
+                { }
+            end
+        end
+    end
+
+    def extra=(newextra)
+        if !newextra.nil?
+            raise NCC::Error, "Invalid extra parameter of type " +
+                "#{newextra.class} (must be Hash)" unless
+                newextra.respond_to? :to_hash
+            if @extra.nil?
+                @extra = newextra.to_hash
+            else
+                @extra = @extra.deep_soft_merge(newextra.to_hash)
+            end
+        end
+    end
+
+    def status=(newstatus)
+        raise NCC::Error, "Invalid status #{newstatus.inspect}" unless
+            @@valid_statuses.include? newstatus
+        @status = newstatus
+    end
+
+    def to_hash
+        {
+            'name' => name,
+            'id' => id,
+            'extra' => extra,
+            'environment' => environment,
+            'role' => role,
+            'size' => size,
+            'image' => image,
+            'ip_address' => ip_address,
+            'host' => host,
+            'status' => status
+        }.delete_nil_values
+    end
+
+    def to_json
+        to_hash.to_json
+    end
+
+end

data/lib/ncc-api.rb

@@ -0,0 +1,218 @@
+#!ruby
+# /* Copyright 2013 Proofpoint, Inc. All rights reserved.
+#    Copyright 2014 Evernote Corporation. All rights reserved.
+#
+# 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.
+# */
+
+require 'rubygems'
+require 'ncc'
+require 'json'
+require 'sinatra'
+require 'fog'
+require 'rack/logger'
+
+
+configure :development do
+    set :logging, Logger::DEBUG
+end
+
+$ncc = NCC.new
+
+def error_message(status, err)
+    status_message = case status
+                     when 400
+                         "400 Bad Request"
+                     when 404
+                         "404 Not Found"
+                     when 500
+                         "500 Internal Server Error"
+                     when 503
+                         "503 Service Unavailable"
+                     end
+    status_message ||= status.to_s
+    data = { "status" => status_message, "message" => err.message }
+    if params.has_key? 'details'
+        data['details'] = err.backtrace
+        data['error'] = err.class
+    end
+    body = (params.has_key?('pretty') ? (JSON.pretty_generate(data) +
+            "\n") : data.to_json)
+    [status, { "content-type" => "application/json" }, body]
+end
+
+def respond(status, header={}, &block)
+    header.merge({ "content-type" => "application/json" })
+    begin
+        obj = yield
+        body = if header["content-type"] == "text/plain"
+                   obj
+               else
+                   params.has_key?('pretty') ? (JSON.pretty_generate(obj) + "\n") : obj.to_json
+               end
+        return [status, header, body]
+    rescue NCC::Error::NotFound => error
+        halt error_message(404, error)
+    rescue NCC::Error::Cloud => error
+        halt error_message(503, error)
+    rescue NCC::Error::Client => error
+        halt error_message(400, error)
+    rescue Exception => error
+        halt error_message(500, error)
+    end
+end
+
+get '/ncc_api' do
+    respond 200 do
+        $ncc.config['services'].to_hash.merge({ 'v2api' => $ncc.api_url })
+    end
+end
+
+get '/ncc_api/v2' do
+    respond 200 do
+        {
+            "clouds" => "/ncc_api/v2/clouds",
+            "images" => "/ncc_api/v2/images",
+            "sizes" => "/ncc_api/v2/sizes",
+        }
+    end
+end
+
+get '/ncc_api/v2/clouds' do
+    respond(200) { $ncc.clouds }
+end
+
+get '/ncc_api/v2/sizes' do
+    respond(200) { $ncc.sizes }
+end
+
+get '/ncc_api/v2/images' do
+    respond(200) { $ncc.images }
+end
+
+get '/ncc_api/v2/sizes/:size_id' do |size_id|
+    respond(200) { $ncc.sizes(size_id) }
+end
+
+get '/ncc_api/v2/images/:image_id' do |image_id|
+    respond(200) { $ncc.images(image_id) }
+end
+
+get '/ncc_api/v2/clouds/:cloud' do |cloud|
+    respond 200 do
+        {
+            'name' => cloud,
+            'status' => 'ok',
+            'provider' => $ncc.clouds(cloud).provider,
+            'service' => $ncc.clouds(cloud).fog.class.to_s
+        }
+    end
+end
+
+get '/ncc_api/v2/clouds/:cloud/sizes' do |cloud|
+    respond(200) { $ncc.clouds(cloud).sizes }
+end
+
+get '/ncc_api/v2/clouds/:cloud/sizes/:size_id' do |cloud, size_id|
+    respond(200) { $ncc.clouds(cloud).sizes(size_id) }
+end
+
+get '/ncc_api/v2/clouds/:cloud/images' do |cloud|
+    respond(200) { $ncc.clouds(cloud).images }
+end
+
+get '/ncc_api/v2/clouds/:cloud/images/:image_id' do |cloud, image_id|
+    respond(200) { $ncc.clouds(cloud).images(image_id) }
+end
+
+get '/ncc_api/v2/clouds/:cloud/instances' do |cloud|
+    respond(200) { $ncc.clouds(cloud).instances.map { |i| i.to_hash } }
+end
+
+
+get '/ncc_api/v2/clouds/:cloud/instances/:instance_id/console_log' do |cloud,
+    instance_id|
+    respond(200, 'content-type' => 'text/plain') do
+        # TODO influence last-modified with console log timestamp
+        $ncc.clouds(cloud).console_log(instance_id)['output']
+    end
+end
+
+post '/ncc_api/v2/clouds/:cloud/instances' do |cloud|
+    respond 201 do
+        begin
+            request.body.rewind
+            instance_spec = JSON.parse(request.body.read)
+            instance_req = instance_spec
+            $ncc.clouds(cloud).create_instance(instance_req)
+        rescue JSON::ParserError => e
+            raise NCC::Error::Client, "Error parsing request: #{e.message}"
+        end
+    end
+end
+
+get '/ncc_api/v2/clouds/:cloud/instances/:instance_id' do |cloud, instance_id|
+    respond(200) do
+        $ncc.clouds(cloud).instances(instance_id).to_hash
+    end
+end
+
+
+delete '/ncc_api/v2/clouds/:cloud/instances/:instance_id' do |cloud,
+    instance_id|
+    respond 204 do
+        $ncc.clouds(cloud).delete(instance_id)
+        nil
+    end
+end
+
+put '/ncc_api/v2/clouds/:cloud/instances/:instance_id' do |cloud, instance_id|
+    respond 202 do
+        instance = $ncc.clouds(cloud).instances(instance_id)
+        begin
+            request.body.rewind
+            update_spec = JSON.parse(request.body.read)
+        rescue JSON::ParserError => e
+            raise NCC::Error::Client, "Error parsing request #{e.message}"
+        end
+        actions = []
+        update_spec.each_pair do |key, value|
+            case key
+            when 'status'
+                if value == 'reboot'
+                    actions << lambda { instance.status = 'reboot' }
+                    $ncc.clouds(cloud).reboot(instance.id)
+                else
+                    raise NCC::Error::Client,
+                    "Cannot update to status #{value.inspect}"
+                end
+            else
+                raise NCC::Error::Client,
+                "Cannot update field #{key.inspect}"
+            end
+        end
+        actions.each { |action| action.call }
+        instance
+    end
+end
+
+# This is not doing the right thing, it's overwriting
+# the body when it gets invoked after a normal route
+# not_found do
+#     respond(404) do
+#         {
+#             "status" => "404 Not Found",
+#             "message" => "Not a supported resource type"
+#         }
+#     end
+# end

data/lib/ncc.rb

@@ -0,0 +1,102 @@
+#!ruby
+# /* Copyright 2013 Proofpoint, Inc. All rights reserved.
+#    Copyright 2014 Evernote Corporation. All rights reserved.
+#
+# 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.
+# */
+
+
+require 'ncc/config'
+require 'ncc/connection'
+require 'ncc/instance'
+require 'ncc/error'
+require 'cmdbclient'
+
+class NCC
+    attr_reader :config, :inventory
+
+    def initialize(config_path=nil, opt={})
+        @logger = opt[:logger] if opt.has_key? :logger
+        config_path ||= [
+            '/etc/ncc-api']
+        config_path = [config_path] unless config_path.respond_to? :unshift
+        config_path.unshift(File.join(ENV['NCCAPI_HOME'], 'etc')) if
+            ENV['NCCAPI_HOME']
+        @config = NCC::Config.new(config_path, :logger => @logger)
+        @inventory = CMDBclient.new(@config)
+        @clouds = { }
+    end
+
+    def debug(msg)
+        if @logger.respond_to? :debug
+            @logger.debug "#{me}: #{msg}"
+        end
+    end
+
+    def me
+        self.class
+    end
+
+    def connect(cloud, opt={})
+        if ! @config[:clouds].has_key? cloud
+            raise NCC::Error::NotFound, "Cloud #{cloud} not provided"
+        end
+        @clouds[cloud] ||= NCC::Connection.connect(self, cloud, opt)
+        if @clouds[cloud].nil? or ! @clouds[cloud].current?
+            @clouds[cloud] = NCC::Connection.connect(self, cloud, opt)
+        end
+        @clouds[cloud]
+    end
+
+    def clouds(cloud=nil, opt={})
+        if cloud.nil?
+            @config[:clouds].keys
+        else
+            connect(cloud, :logger => @logger)
+        end
+    end
+
+    def sizes(size=nil)
+        if size.nil?
+            @config[:sizes].to_array
+        else
+            if @config[:sizes].has_key? size
+                @config[:sizes][size].to_hash
+            else
+                raise NCC::Error::NotFound, "No such size #{size.inspect}"
+            end
+        end
+    end
+
+    def images(image=nil)
+        if image.nil?
+            @config[:images].to_array
+        else
+            if @config[:images].has_key? image
+                @config[:images][image].to_hash
+            else
+                raise NCC::Error::NotFound, "No such image #{image.inspect}"
+            end
+        end
+    end
+
+    def api_url
+        if @config['services'].has_key? 'v2api'
+            @config['services']['v2api']
+        else
+            'http://localhost/ncc_api/v2'
+        end
+    end
+
+end
+

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: ncc-api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jeremy Brinkley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The NOMS cloud controller API provides a ReSTful API abstracting and
+  aggregating a set of specific cloud computing providers (called "clouds").
+email: jbrinkley@evernote.com
+executables:
+- ncc-api
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ncc/config.rb
+- lib/ncc/connection/aws.rb
+- lib/ncc/connection/openstack.rb
+- lib/ncc/connection.rb
+- lib/ncc/error.rb
+- lib/ncc/instance.rb
+- lib/ncc-api.rb
+- lib/ncc.rb
+- bin/ncc-api
+homepage: https://github.com/evernote/ncc-api
+licenses:
+- Apache-2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: NOMS Cloud Controller API
+test_files: []