Aviator

A lightweight library for communicating with the OpenStack API.

Installation

Add this line to your application's Gemfile:

gem 'aviator'

And then execute:

$ bundle

Or install it yourself as:

$ gem install aviator

Usage

require 'aviator'

# Authenticate against openstack as specified in :config_file generating a new default
# token in the process.
session = Aviator::Session.new(
            config_file: 'path/to/aviator.yml',
            env:         :production,
            log_file:    'path/to/aviator.log'
          )

# Authenticate against openstack as specified in :config_file but log in as specified
# user, generating a new default token in the process
session = Aviator::Session.new(
            config_file: 'path/to/aviator.yml', 
            env:         :production,
            username:     username, 
            password:     password, 
            log_file:    'path/to/aviator.log'
          )

# In both methods above, Aviator::Session automatically tracks the session data
# (access/token data for OpenStack) in memory and is accessible via `Session#to_json`
# for caching.


# Loads a serialized session object
session = Aviator::Session.load(json_string)

# Return a new session object scoped to the default token
scoped_session = session.scope(:default)

# Return a new session object with a token scoped to :tenant_id. If scoped token does not
# exist, create one. If scoped token exists but is expired, create a new one. Otherwise,
# re-use existing one
scoped_session = session.scope(tenant_id: '...')

# Return a new session object with a token scoped to :tenant_name. If scoped token does
# not exist, create one. If scoped token exists but is expired, create a new one. Otherwise, 
# re-use existing one
scoped_session = session.scope(tenant_name: '...')

# Get connection to Keystone
keystone = scoped_session.identity_service

# Create a new tenant
response = keystone.request(:create_tenant) do |params|
  params[:name]        = 'Project'
  params[:description] = 'My Project'
  params[:enabled]     = true
end

# Aviator uses parameter names as defined in the official OpenStack API doc. You can 
# also access the params via dot notation (e.g. params.description) or by using a string
# for a hash key (e.g. params['description']). However, keep in mind that OpenStack
# parameters that have dashes and other characters that are not valid for method names
# and symbols must be expressed as strings. E.g. params['changes-since']


# You may also query Aviator for the parameters via the CLI. With the Aviator gem 
# installed, run the following commands:

# list available providers
$ aviator describe

# list available services for openstack
$ aviator describe openstack

# list available requests for the openstack identity service
$ aviator describe openstack identity

# describe the create_tenant request of the identity service
$ aviator describe openstack identity create_tenant


# Be explicit about the endpoint type to use. Useful in the rare instances when
# the same request name means differently depending on the endpoint type.

response = keystone.request(:list_tenants, endpoint_type: 'admin') do |params|
  params['tenantName'] = tenant_name
end

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request