aviator 0.0.3 → 0.0.4

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzI1YmNkNTM4YzhkNGUyMzczZTZiNGY4MzI4NTg3YzcyOTdkZjc3Nw==
+  data.tar.gz: !binary |-
+    M2Q4OTRjZWQwNDAwYjI5YzI2NjM3YzQzNjQ5ZGE3ZjYxYzUxYzBjMQ==
+SHA512:
+  metadata.gz: !binary |-
+    ZTY1ZTYxNzZjOWRlMzk2NThjYmMzZjFkZjg1ZmZhYWM3MDk2YWQ3NTUxNjJl
+    MDg4ZWM2ZTFkMTNiYzM1ZDUzODE0YTQ0YjgyMmUzOGM3NjQ0MmMwM2E5NGIx
+    NGYyNjJkZjdjNDc1NGY3NTA5ZTgxYWY0MmZkZDgyYzFkMjA2ODg=
+  data.tar.gz: !binary |-
+    NGUxNTE0MjY1ZjBjMzA1Mjg3ZDIyMjAwYzc4ODBmZTQ2N2ZlM2IwZmQ3ODFl
+    ZmI2NjVhZTQzMjU4M2JlZWExZGViYTllNGI5YjQxMzY3Mjk2NjZkYjFlMmYw
+    NWMxMGIyMjE2ZmMxMmM4NDAwYzViYTU2NjJiMjhhZTI3ZTRhNjc=

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 rvm:
   - 1.9.3
+  - 2.0.0
 branches:
   only:
     - master

data/README.md

@@ -1,9 +1,10 @@
 # Aviator
 
-[![Build Status](https://travis-ci.org/relaxdiego/aviator.png?branch=master)](https://travis-ci.org/relaxdiego/aviator)
-[![Coverage Status](https://coveralls.io/repos/relaxdiego/aviator/badge.png?branch=master)](https://coveralls.io/r/relaxdiego/aviator?branch=master)
-[![Code Climate](https://codeclimate.com/github/relaxdiego/aviator.png)](https://codeclimate.com/github/relaxdiego/aviator)
-
+[![Build Status](https://travis-ci.org/aviator/aviator.png?branch=master)](https://travis-ci.org/aviator/aviator)
+[![Coverage Status](https://coveralls.io/repos/aviator/aviator/badge.png?branch=master)](https://coveralls.io/r/aviator/aviator?branch=master)
+[![Code Climate](https://codeclimate.com/github/aviator/aviator.png)](https://codeclimate.com/github/aviator/aviator)
+[![Gem Version](https://badge.fury.io/rb/aviator.png)](http://badge.fury.io/rb/aviator)
+[![Dependency Status](https://gemnasium.com/aviator/aviator.png)](https://gemnasium.com/aviator/aviator)
 
 A lightweight library for communicating with the OpenStack API.
 
@@ -14,6 +15,10 @@ Add this line to your application's Gemfile:
 
     gem 'aviator'
 
+Or if you want to live on the edge:
+
+    gem 'aviator', :git => 'git@github.com:aviator/aviator.git', :branch => 'develop'
+
 And then execute:
 
     $ bundle
@@ -25,7 +30,7 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-require 'aviator/core'
+require 'aviator'
 
 # Create a new session. See 'Configuration' below for the config file format.
 session = Aviator::Session.new(
@@ -52,7 +57,7 @@ session.authenticate do |credentials|
 end
 
 # Serialize the session information for caching. The output is in plaintext JSON which
-# contains sensitive information and you are responsible for securing this data.
+# contains sensitive information. You are responsible for securing that.
 str = session.dump
 
 # Create a new Session object from a session dump. This DOES NOT create a new token. 
@@ -67,7 +72,7 @@ session = Aviator::Session.load(str)
 # a brand new session object.
 session.load(other_session_dump)
 
-# Depending on how old the loaded session dump is, the auth_info may already be expired. 
+# Depending on how old the loaded session dump is, its session data may already be expired. 
 # Check if it's still current by calling Session#validate and reauthenticate as needed.
 #
 # IMPORTANT: The validator must be defined in the config file and it must refer to the
@@ -104,7 +109,7 @@ response = keystone.request(:list_tenants, endpoint_type: 'admin')
 
 ## Configuration
 
-The configuration file is a simple YAML file with one or more environment definitions.
+The configuration file is a simple YAML file that can have one or more environment definitions.
 
 ```
 production:
@@ -176,6 +181,28 @@ Describe Keystone's create_tenant request
 ```bash
 $ aviator describe openstack identity v2 admin create_tenant
 ```
+
+The last command above will display:
+
+```bash
+Request: create_tenant
+
+Parameters:
+  (required) description
+  (required) enabled
+  (required) name
+
+Sample Code:
+  session.identity_service.request(:create_tenant, endpoint_type: 'admin') do |params|
+     params['name'] = value
+     params['description'] = value
+     params['enabled'] = value
+  end
+
+Links:
+  documentation:
+    http://docs.openstack.org/api/openstack-identity-service/2.0/content/
+```
   
 ## Contributing
 

data/README.md.orig

@@ -0,0 +1,217 @@
+# Aviator
+
+[![Build Status](https://travis-ci.org/aviator/aviator.png?branch=master)](https://travis-ci.org/aviator/aviator)
+[![Coverage Status](https://coveralls.io/repos/aviator/aviator/badge.png?branch=master)](https://coveralls.io/r/aviator/aviator?branch=master)
+[![Code Climate](https://codeclimate.com/github/aviator/aviator.png)](https://codeclimate.com/github/aviator/aviator)
+[![Gem Version](https://badge.fury.io/rb/aviator.png)](http://badge.fury.io/rb/aviator)
+[![Dependency Status](https://gemnasium.com/aviator/aviator.png)](https://gemnasium.com/aviator/aviator)
+<<<<<<< HEAD
+
+=======
+>>>>>>> develop
+
+A lightweight library for communicating with the OpenStack API.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'aviator'
+
+Or if you want to live on the edge:
+
+    gem 'aviator', :git => 'git@github.com:aviator/aviator.git', :branch => 'develop'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aviator
+
+## Usage
+
+```ruby
+require 'aviator'
+
+# Create a new session. See 'Configuration' below for the config file format.
+session = Aviator::Session.new(
+            config_file: 'path/to/aviator.yml',
+            environment: :production,
+            log_file:    'path/to/aviator.log'
+          )
+
+# Authenticate against the auth service specified in :config_file. If no 
+# credentials are available in the config file, this line will throw an error.
+session.authenticate
+
+# You can re-authenticate anytime. Note that this creates a new token in the 
+# underlying environment while the old token is discarded by the Session object.
+# Be aware of this fact as it might unnecessarily generate too many tokens.
+#
+# Notice how you can override the credentials in the config file. Also note that
+# the keys used below (:username, :password, :tenantName) match the name as 
+# indicated in the official OpenStack documentation.
+session.authenticate do |credentials|
+  credentials[:username]   = myusername
+  credentials[:password]   = mypassword
+  credentials[:tenantName] = tenantName
+end
+
+# Serialize the session information for caching. The output is in plaintext JSON which
+# contains sensitive information. You are responsible for securing that.
+str = session.dump
+
+# Create a new Session object from a session dump. This DOES NOT create a new token. 
+# If you employed any form of encryption on the string, make sure to decrypt it first!
+session = Aviator::Session.load(str)
+
+# In some instances, Session::load is inefficient because it creates a new session object
+# each time. In a web app environment, for instance, having to destroy and recreate the
+# session object can take its toll on performance. In such a scenario, use Session#load
+# (instance method, as opposed to class method). This will 'infect' an already existing
+# session object with the supplied session dump and return itself instead of creating
+# a brand new session object.
+session.load(other_session_dump)
+
+# Depending on how old the loaded session dump is, its session data may already be expired. 
+# Check if it's still current by calling Session#validate and reauthenticate as needed.
+#
+# IMPORTANT: The validator must be defined in the config file and it must refer to the
+# name of a request that is known to Aviator. See 'Configuration' below for examples
+session.authenticate unless session.validate
+
+# If you want the newly created session to log its output, make sure to indicate it on load
+session = Aviator::Session.load(str, log_file: 'path/to/aviator.log')
+
+# Get a handle to the Identity Service.
+keystone = 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 can only be expressed as strings. E.g. params['changes-since']
+
+
+# Be explicit about the endpoint type. Useful in those rare instances when
+# the same request name means differently depending on the endpoint type.
+# For example, in OpenStack, :list_tenants will return only the tenants the
+# user is a member of in the public endpoint whereas the admin endpoint will
+# return all tenants in the system.
+response = keystone.request(:list_tenants, endpoint_type: 'admin')
+```
+
+## Configuration
+
+The configuration file is a simple YAML file that can have one or more environment definitions.
+
+```
+production:
+  provider: openstack
+  auth_service:
+    name:        identity
+    host_uri:    http://my.openstackenv.org:5000
+    request:     create_token
+    validator:   list_tenants   # Request to make for validating the session
+    api_version: v2             # Optional if version is indicated in host_uri
+  auth_credentials:
+    username:   admin
+    password:   mypassword
+    tenantName: myproject
+
+development_1:
+  provider: openstack
+  auth_service:
+    name:      identity
+    host_uri:  http://devstack:5000/v2.0
+    request:   create_token
+    validator: list_tenants
+  auth_credentials:
+    tokenId:    2c963f5512d067b24fdc312707c80c7a6d3d261b
+    tenantName: admin
+
+development_2:
+  provider: openstack
+  auth_service:
+    name:      identity
+    host_uri:  http://devstack:5000/v2.0
+    request:   create_token
+    validator: list_tenants
+  auth_credentials:
+    username: admin
+    password: mypassword
+    tenantName: myproject
+```
+
+A note on the validator: it can be any request as long as
+
+1. It is defined in Aviator
+1. Does not require any parameters
+1. It returns an HTTP status 200 or 203 to indicate auth info validity.
+1. It returns any other HTTP status to indicate that the auth info is invalid.
+
+## CLI tools
+
+List available providers. Includes only OpenStack for now.
+
+```bash
+$ aviator describe
+```
+
+List available services for OpenStack.
+
+```bash
+$ aviator describe openstack
+```
+
+List available requests for Keystone
+
+```bash
+$ aviator describe openstack identity
+```
+
+Describe Keystone's create_tenant request
+
+```bash
+$ aviator describe openstack identity v2 admin create_tenant
+```
+
+The last command above will display:
+
+```bash
+Request: create_tenant
+
+Parameters:
+  (required) description
+  (required) enabled
+  (required) name
+
+Sample Code:
+  session.identity_service.request(:create_tenant, endpoint_type: 'admin') do |params|
+     params['name'] = value
+     params['description'] = value
+     params['enabled'] = value
+  end
+
+Links:
+  documentation:
+    http://docs.openstack.org/api/openstack-identity-service/2.0/content/
+```
+  
+## 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

data/aviator.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = Aviator::VERSION
   spec.authors       = ["Mark Maglana"]
   spec.email         = ["mmaglana@gmail.com"]
-  spec.description   = %q{ Lightweight Ruby bindings for the OpenStack API }
-  spec.summary       = %q{ Lightweight Ruby bindings for the OpenStack API }
-  spec.homepage      = "https://github.com/relaxdiego/aviator"
+  spec.description   = %q{ A lightweight Ruby library for the OpenStack API }
+  spec.summary       = %q{ A lightweight Ruby library for the OpenStack API }
+  spec.homepage      = "https://github.com/aviator/aviator"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/aviator/openstack/compute/v2/public/change_admin_password.rb

@@ -0,0 +1,54 @@
+module Aviator
+
+  define_request :change_admin_password do
+
+    meta :provider,      :openstack
+    meta :service,       :compute
+    meta :api_version,   :v2
+    meta :endpoint_type, :public
+
+    link 'documentation',
+         'http://docs.openstack.org/api/openstack-compute/2/content/Change_Password-d1e3234.html'
+         
+    link 'additional spec',
+         'https://answers.launchpad.net/nova/+question/228462'
+
+    param :adminPass, required: true
+    param :id,        required: true
+    
+    
+    def body
+      p = {
+        changePassword: {
+          adminPass: params[:adminPass]
+        }
+      }
+
+      p
+    end
+    
+    
+    def headers
+      h = {}
+    
+      unless self.anonymous?
+        h['X-Auth-Token'] = session_data[:access][:token][:id]
+      end
+    
+      h
+    end
+    
+    
+    def http_method
+      :post
+    end
+    
+    
+    def url
+      service_spec = session_data[:access][:serviceCatalog].find{|s| s[:type] == service.to_s }
+      "#{ service_spec[:endpoints][0][:publicURL] }/servers/#{ params[:id] }/action"
+    end
+
+  end
+
+end

data/lib/aviator/openstack/compute/v2/public/create_image.rb

@@ -0,0 +1,56 @@
+module Aviator
+
+  define_request :create_image do
+
+    meta :provider,      :openstack
+    meta :service,       :compute
+    meta :api_version,   :v2
+    meta :endpoint_type, :public
+
+    link 'documentation',
+         'http://docs.openstack.org/api/openstack-compute/2/content/Create_Image-d1e4655.html'
+
+    param :id,       required: true
+    param :metadata, required: false
+    param :name,     required: true
+
+
+    def body
+      p = {
+        createImage: {
+          name: params[:name]
+        }
+      }
+      
+      [:metadata].each do |key|
+        p[:createImage][key] = params[key] if params[key]
+      end
+
+      p
+    end
+
+
+    def headers
+      h = {}
+
+      unless self.anonymous?
+        h['X-Auth-Token'] = session_data[:access][:token][:id]
+      end
+
+      h
+    end
+
+
+    def http_method
+      :post
+    end
+
+
+    def url
+      service_spec = session_data[:access][:serviceCatalog].find{|s| s[:type] == service.to_s }
+      "#{ service_spec[:endpoints][0][:publicURL] }/servers/#{ params[:id] }/action"
+    end
+
+  end
+
+end

data/lib/aviator/openstack/compute/v2/public/create_server.rb

@@ -0,0 +1,64 @@
+module Aviator
+
+  define_request :create_server do
+
+    meta :provider,      :openstack
+    meta :service,       :compute
+    meta :api_version,   :v2
+    meta :endpoint_type, :public
+
+    link 'documentation',
+         'http://docs.openstack.org/api/openstack-compute/2/content/CreateServers.html'
+
+    param :accessIPv4,  required: false
+    param :accessIPv6,  required: false
+    param :adminPass,   required: false
+    param :imageRef,    required: true
+    param :flavorRef,   required: true
+    param :metadata,    required: false
+    param :name,        required: true
+    param :networks,    required: false
+    param :personality, required: false
+
+
+    def body
+      p = {
+        server: {
+          flavorRef: params[:flavorRef],
+          imageRef:  params[:imageRef],
+          name:      params[:name]
+        }
+      }
+
+      [:adminPass, :metadata, :personality, :networks, :accessIPv4, :accessIPv6].each do |key|
+        p[:server][key] = params[key] if params[key]
+      end
+
+      p
+    end
+
+
+    def headers
+      h = {}
+
+      unless self.anonymous?
+        h['X-Auth-Token'] = session_data[:access][:token][:id]
+      end
+
+      h
+    end
+
+
+    def http_method
+      :post
+    end
+
+
+    def url
+      service_spec = session_data[:access][:serviceCatalog].find{|s| s[:type] == service.to_s }
+      "#{ service_spec[:endpoints][0][:publicURL] }/servers"
+    end
+
+  end
+
+end

data/lib/aviator/openstack/compute/v2/public/delete_server.rb

@@ -0,0 +1,39 @@
+module Aviator
+
+  define_request :delete_server do
+
+    meta :provider,      :openstack
+    meta :service,       :compute
+    meta :api_version,   :v2
+    meta :endpoint_type, :public
+
+    link 'documentation',
+         'http://docs.openstack.org/api/openstack-compute/2/content/Delete_Server-d1e2883.html'
+
+    param :id, required: true
+
+
+    def headers
+      h = {}
+
+      unless self.anonymous?
+        h['X-Auth-Token'] = session_data[:access][:token][:id]
+      end
+
+      h
+    end
+
+
+    def http_method
+      :delete
+    end
+
+
+    def url
+      service_spec = session_data[:access][:serviceCatalog].find{|s| s[:type] == service.to_s }
+      "#{ service_spec[:endpoints][0][:publicURL] }/servers/#{ params[:id] }"
+    end
+
+  end
+
+end

data/lib/aviator/openstack/compute/v2/public/get_server.rb

@@ -0,0 +1,39 @@
+module Aviator
+  
+  define_request :get_server do
+
+    meta :provider,      :openstack
+    meta :service,       :compute
+    meta :api_version,   :v2
+    meta :endpoint_type, :public
+
+    link 'documentation',
+         'http://docs.openstack.org/api/openstack-compute/2/content/Get_Server_Details-d1e2623.html'
+
+    param :id, required: true
+
+    def headers
+      h = {}
+  
+      unless self.anonymous?
+        h['X-Auth-Token'] = session_data[:access][:token][:id]
+      end
+  
+      h
+    end
+  
+  
+    def http_method
+      :get
+    end
+  
+  
+    def url
+      service_spec = session_data[:access][:serviceCatalog].find{|s| s[:type] == service.to_s }
+
+      "#{ service_spec[:endpoints][0][:publicURL] }/servers/#{ params[:id] }"
+    end
+
+  end
+
+end

data/lib/aviator/openstack/compute/v2/public/list_addresses.rb

@@ -0,0 +1,48 @@
+module Aviator
+
+  define_request :list_addresses do
+
+    meta :provider,      :openstack
+    meta :service,       :compute
+    meta :api_version,   :v2
+    meta :endpoint_type, :public
+
+    link 'documentation',
+         'http://docs.openstack.org/api/openstack-compute/2/content/List_Addresses-d1e3014.html'
+
+    link 'documentation',
+         'http://docs.openstack.org/api/openstack-compute/2/content/List_Addresses_by_Network-d1e3118.html'
+
+
+    param :id,        required: true
+    param :networkID, required: false
+
+
+    def headers
+      h = {}
+
+      unless self.anonymous?
+        h['X-Auth-Token'] = session_data[:access][:token][:id]
+      end
+
+      h
+    end
+
+
+    def http_method
+      :get
+    end
+
+
+    def url
+      service_spec = session_data[:access][:serviceCatalog].find{|s| s[:type] == service.to_s }
+
+      url = "#{ service_spec[:endpoints][0][:publicURL] }/servers/#{ params[:id] }/ips"
+      url += "/#{ params[:networkID] }" if params[:networkID]
+
+      url
+    end
+
+  end
+
+end