Class: Service::Client

Inherits:

Object

• Object
• Service::Client

Defined in:

lib/opennebula/oneflow_client.rb

Overview

Interface to OneFlow REST API through a Ruby client

Instance Method Summary

• #delete(path, body = nil) ⇒ Object
• #get(path) ⇒ Object
• #initialize(opts = {}) ⇒ Client constructor

  The options are read from ENV and FS if not passed.

• #login ⇒ Object
• #logout ⇒ Object
• #post(path, body) ⇒ Object
• #put(path, body) ⇒ Object

Constructor Details

#initialize(opts = {}) ⇒ Client

The options are read from ENV and FS if not passed

Parameters:

• opts (Hash) (defaults to: {}) —

  Required configuration to interact with OneFlow

Options Hash (opts):

• :url (String) —

  Endpoint where OneFlow is running. Defaults to ‘localhost:2474’

• :username (String) —

  OpenNebula user

• :password (String) —

  OpenNebula user password

• :user_agent (String) —

  Defaults to Ruby. Oneflow will behave accordingly.

# File 'lib/opennebula/oneflow_client.rb', line 342

def initialize(opts = {})
    endpoint  = '/.one/oneflow_endpoint'
    @username = opts[:username] || ENV['ONEFLOW_USER']
    @password = opts[:password] || ENV['ONEFLOW_PASSWORD']

    # By default oneflow uses JSON as content type
    @content_type = opts[:content_type] || 'application/json'

    if opts[:url]
        url = opts[:url]
    elsif ENV['ONEFLOW_URL']
        url = ENV['ONEFLOW_URL']
    elsif ENV['HOME'] && File.exist?(ENV['HOME'] + endpoint)
        url = File.read(ENV['HOME'] + endpoint).strip
    elsif File.exist?('/var/lib/one/.one/oneflow_endpoint')
        url = File.read('/var/lib/one/.one/oneflow_endpoint').strip
    else
        url = 'http://localhost:2474'
    end

    if @username.nil? && @password.nil?
        if ENV['ONE_AUTH'] and !ENV['ONE_AUTH'].empty? and File.file?(ENV['ONE_AUTH'])
            one_auth = File.read(ENV['ONE_AUTH'])
        elsif ENV['HOME'] and File.file?(ENV['HOME']+'/.one/one_auth')
            one_auth = File.read(ENV['HOME']+'/.one/one_auth')
        elsif File.file?('/var/lib/one/.one/one_auth')
            one_auth = File.read('/var/lib/one/.one/one_auth')
        else
            raise 'ONE_AUTH file not present'
        end

        one_auth = one_auth.rstrip

        @username, @password = one_auth.split(':')
    end

    @uri = URI.parse(url)

    @user_agent = "OpenNebula #{CloudClient::VERSION} " <<
        "(#{opts[:user_agent]||'Ruby'})"

    @host = nil
    @port = nil

    return unless ENV['http_proxy']

    uri_proxy = URI.parse(ENV['http_proxy'])
    flag = false

    #  Check if we need to bypass the proxy
    if ENV['no_proxy']
        ENV['no_proxy'].split(',').each do |item|
            item = item.strip

            if (IPAddress @uri.host rescue nil).nil?
                if (IPAddress(item) rescue nil).nil?
                    flag |= (item == @uri.host)
                end
            else
                unless (IPAddress item rescue nil).nil?
                    flag |= IPAddress(item).include? IPAddress(@uri.host)
                end
            end
        end
    end

    return if flag

    @host = uri_proxy.host
    @port = uri_proxy.port
end

Instance Method Details

#delete(path, body = nil) ⇒ Object

# File 'lib/opennebula/oneflow_client.rb', line 420

def delete(path, body = nil)
    req = Net::HTTP::Proxy(@host, @port)::Delete.new(path)

    if body
        req.body = body
        req.content_type = @content_type
    end

    do_request(req)
end

#get(path) ⇒ Object

# File 'lib/opennebula/oneflow_client.rb', line 414

def get(path)
    req = Net::HTTP::Proxy(@host, @port)::Get.new(path)

    do_request(req)
end

#login ⇒ Object

# File 'lib/opennebula/oneflow_client.rb', line 447

def login
    req = Net::HTTP::Proxy(@host, @port)::Post.new('/login')

    do_request(req)
end

#logout ⇒ Object

# File 'lib/opennebula/oneflow_client.rb', line 453

def logout
    req = Net::HTTP::Proxy(@host, @port)::Post.new('/logout')

    do_request(req)
end

#post(path, body) ⇒ Object

# File 'lib/opennebula/oneflow_client.rb', line 431

def post(path, body)
    req = Net::HTTP::Proxy(@host, @port)::Post.new(path)
    req.body = body
    req.content_type = @content_type

    do_request(req)
end

#put(path, body) ⇒ Object

# File 'lib/opennebula/oneflow_client.rb', line 439

def put(path, body)
    req = Net::HTTP::Proxy(@host, @port)::Put.new(path)
    req.body = body
    req.content_type = @content_type

    do_request(req)
end