aviator 0.0.2 → 0.0.3

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

@@ -0,0 +1,58 @@
+module Aviator
+  
+  define_request :list_servers 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_Servers-d1e2078.html'
+
+    param :details,        required: false
+    param :flavor,         required: false
+    param :image,          required: false
+    param :limit,          required: false
+    param :marker,         required: false
+    param :server,         required: false
+    param :status,         required: false
+    param 'changes-since', 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 }
+
+      str  = "#{ service_spec[:endpoints][0][:publicURL] }/servers"
+      str += "/detail" if params[:details]
+    
+      filters = []
+    
+      (optional_params + required_params - [:details]).each do |param_name|
+        filters << "#{ param_name }=#{ params[param_name] }" if params[param_name]
+      end
+    
+      str += "?#{ filters.join('&') }" unless filters.empty?
+    
+      str
+    end
+
+  end
+
+end

data/lib/aviator/openstack/identity/v2/admin/create_tenant.rb

@@ -1,42 +1,53 @@
-define_request :create_tenant do
+module Aviator
 
-  endpoint_type :admin
-  api_version   :v2
-  http_method   :post
+  define_request :create_tenant do
 
-  link_to 'documentation',
-          'http://docs.openstack.org/api/openstack-identity-service/2.0/content/POST_addTenant_v2.0_tenants_.html'
+    meta :provider,      :openstack
+    meta :service,       :identity
+    meta :api_version,   :v2
+    meta :endpoint_type, :admin
 
-  required_param :name
-  required_param :description
-  required_param :enabled
+    link 'documentation',
+         'http://docs.openstack.org/api/openstack-identity-service/2.0/content/'
 
 
-  def url
-    service_spec = session_data[:access][:serviceCatalog].find{|s| s[:type] == 'identity' }
-    "#{ service_spec[:endpoints][0][:adminURL] }/tenants"
-  end
+    param :name,        required: true
+    param :description, required: true
+    param :enabled,     required: true
 
-  
-  def headers
-    h = {}
-    
-    unless self.anonymous?
-      h['X-Auth-Token'] = session_data[:access][:token][:id]
-    end
 
-    h
-  end
-  
-
-  def body
-    {
-      tenant: {
-        name:        params[:name],
-        description: params[:description],
-        enabled:     params[:enabled]
+    def body
+      {
+        tenant: {
+          name:        params[:name],
+          description: params[:description],
+          enabled:     params[:enabled]
+        }
       }
-    }
+    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] == 'identity' }
+      "#{ service_spec[:endpoints][0][:adminURL] }/tenants"
+    end
+
   end
 
-end
+end

data/lib/aviator/openstack/identity/v2/admin/list_tenants.rb

@@ -1,43 +1,54 @@
-define_request :list_tenants do
-
-  endpoint_type :admin
-  api_version   :v2
-  http_method   :get
-
-  link_to 'documentation',
-          'http://docs.openstack.org/api/openstack-identity-service/2.0/content/GET_listTenants_v2.0_tenants_Tenant_Operations.html'
-          
-  link_to 'documentation bug',
-          'https://bugs.launchpad.net/keystone/+bug/1218601'
-
-  optional_param :marker
-  optional_param :limit
-
-
-  def url
-    service_spec = session_data[:access][:serviceCatalog].find{|s| s[:type] == 'identity' }
-    str = "#{ service_spec[:endpoints][0][:adminURL] }/tenants"
-    
-    filters = []
-    
-    (optional_params + required_params).each do |param_name|
-      filters << "#{ param_name }=#{ params[param_name] }" if params[param_name]
+module Aviator
+
+  define_request :list_tenants do
+
+    meta :provider,      :openstack
+    meta :service,       :identity
+    meta :api_version,   :v2
+    meta :endpoint_type, :admin
+
+    link 'documentation',
+         'http://docs.openstack.org/api/openstack-identity-service/2.0/content/GET_listTenants_v2.0_tenants_Tenant_Operations.html'
+
+    link 'documentation bug',
+         'https://bugs.launchpad.net/keystone/+bug/1218601'
+
+
+    param :marker, required: false
+    param :limit,  required: false
+
+
+    def headers
+      h = {}
+
+      unless self.anonymous?
+        h['X-Auth-Token'] = session_data[:access][:token][:id]
+      end
+
+      h
     end
-    
-    str += "?#{ filters.join('&') }" unless filters.empty?
-    
-    str
-  end
 
-  
-  def headers
-    h = {}
-    
-    unless self.anonymous?
-      h['X-Auth-Token'] = session_data[:access][:token][:id]
+
+    def http_method
+      :get
+    end
+
+
+    def url
+      service_spec = session_data[:access][:serviceCatalog].find{|s| s[:type] == 'identity' }
+      str = "#{ service_spec[:endpoints][0][:adminURL] }/tenants"
+
+      filters = []
+
+      (optional_params + required_params).each do |param_name|
+        filters << "#{ param_name }=#{ params[param_name] }" if params[param_name]
+      end
+
+      str += "?#{ filters.join('&') }" unless filters.empty?
+
+      str
     end
 
-    h
   end
-  
-end
+
+end

data/lib/aviator/openstack/identity/v2/public/create_token.rb

@@ -1,61 +1,67 @@
-define_request :create_token do
+module Aviator
 
-  anonymous
+  define_request :create_token do
 
-  endpoint_type :public
-  api_version   :v2
-  http_method   :post
+    meta :anonymous,     true
+    meta :provider,      :openstack
+    meta :service,       :identity
+    meta :api_version,   :v2
+    meta :endpoint_type, :public
 
-  link_to 'documentation',
-          'http://docs.openstack.org/api/openstack-identity-service/2.0/content/POST_authenticate_v2.0_tokens_.html'
-          
-  link_to 'documentation bug',
-          'https://bugs.launchpad.net/keystone/+bug/1208607'
+    link 'documentation',
+         'http://docs.openstack.org/api/openstack-identity-service/2.0/content/POST_authenticate_v2.0_tokens_.html'
 
+    link 'documentation bug',
+         'https://bugs.launchpad.net/keystone/+bug/1208607'
 
-  optional_param :username
-  optional_param :password
-  optional_param :tokenId
-  
-  optional_param :tenantName
-  optional_param :tenantId
 
-
-  # TODO: Add logic for when session_data is actually an OpenStack
-  # authentication response body and not auth bootstrap information
-  def url
-    url  = session_data[:auth_service][:host_uri]
-    url += '/v2.0' if (URI(url).path =~ /^\/?\w+/).nil?
-    url += "/tokens"
-    
-    url
-  end
+    param :username,   required: false
+    param :password,   required: false
+    param :tokenId,    required: false
+    param :tenantName, required: false
+    param :tenantId,   required: false
 
 
-  def body
-    p = if params[:tokenId]
-          {
-            auth: {
-              token: {
-                id: params[:tokenId]
+    def body
+      p = if params[:tokenId]
+            {
+              auth: {
+                token: {
+                  id: params[:tokenId]
+                }
               }
             }
-          }
-        else
-          {
-            auth: {
-              passwordCredentials: {
-                username: params[:username],
-                password: params[:password]
+          else
+            {
+              auth: {
+                passwordCredentials: {
+                  username: params[:username],
+                  password: params[:password]
+                }
               }
             }
-          }
-        end
-    
-    p[:auth][:tenantName] = params[:tenantName] if params[:tenantName]
-    p[:auth][:tenantId]   = params[:tenantId]   if params[:tenantId]
-    
-    p
+          end
+
+      p[:auth][:tenantName] = params[:tenantName] if params[:tenantName]
+      p[:auth][:tenantId]   = params[:tenantId]   if params[:tenantId]
+
+      p
+    end
+
+
+    def http_method
+      :post
+    end
+
+
+    def url
+      url  = session_data[:auth_service][:host_uri]
+      url += '/v2.0' if (URI(url).path =~ /^\/?\w+/).nil?
+      url += "/tokens"
+
+      url
+    end
+
   end
 
-end
+end

data/lib/aviator/openstack/identity/v2/public/list_tenants.rb

@@ -1,44 +1,54 @@
-define_request :list_tenants do
-
-  endpoint_type :public
-  api_version   :v2
-  http_method   :get
+module Aviator
+  
+  define_request :list_tenants do
 
-  link_to 'documentation',
-          'http://docs.openstack.org/api/openstack-identity-service/2.0/content/GET_listTenants_v2.0_tokens_tenants_.html'
+    meta :provider,      :openstack
+    meta :service,       :identity
+    meta :api_version,   :v2
+    meta :endpoint_type, :public
+  
+    link 'documentation',
+         'http://docs.openstack.org/api/openstack-identity-service/2.0/content/GET_listTenants_v2.0_tokens_tenants_.html'
 
-  link_to 'documentation bug',
-          'https://bugs.launchpad.net/keystone/+bug/1218601'
+    link 'documentation bug',
+         'https://bugs.launchpad.net/keystone/+bug/1218601'
 
 
-  optional_param :marker
-  optional_param :limit
+    param :marker, required: false
+    param :limit,  required: false
 
 
-  def url
-    service_spec = session_data[:access][:serviceCatalog].find{|s| s[:type] == 'identity' }
-    str = "#{ service_spec[:endpoints][0][:publicURL] }/tenants"
+    def url
+      service_spec = session_data[:access][:serviceCatalog].find{|s| s[:type] == 'identity' }
+      str = "#{ service_spec[:endpoints][0][:publicURL] }/tenants"
     
-    filters = []
+      filters = []
     
-    (optional_params + required_params).each do |param_name|
-      filters << "#{ param_name }=#{ params[param_name] }" if params[param_name]
-    end
+      (optional_params + required_params).each do |param_name|
+        filters << "#{ param_name }=#{ params[param_name] }" if params[param_name]
+      end
     
-    str += "?#{ filters.join('&') }" unless filters.empty?
+      str += "?#{ filters.join('&') }" unless filters.empty?
     
-    str
-  end
+      str
+    end
 
   
-  def headers
-    h = {}
+    def headers
+      h = {}
     
-    unless self.anonymous?
-      h['X-Auth-Token'] = session_data[:access][:token][:id]
+      unless self.anonymous?
+        h['X-Auth-Token'] = session_data[:access][:token][:id]
+      end
+
+      h
+    end
+  
+  
+    def http_method
+      :get
     end
 
-    h
   end
   
 end

data/lib/aviator/version.rb

@@ -1,3 +1,3 @@
 module Aviator
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/aviator.rb

@@ -0,0 +1 @@
+require 'aviator/core'

data/test/aviator/core/cli/describer_test.rb

@@ -0,0 +1,140 @@
+require 'test_helper'
+
+class Aviator::Test
+  
+  describe 'aviator/core/cli/describer' do
+    
+    def get_provider_names
+      Pathname.new(__FILE__)
+        .join('..', '..', '..', '..', '..', 'lib', 'aviator')
+        .children
+        .select{|c| c.directory? && c.basename.to_s != 'core' }
+        .map{|c| c.basename.to_s }
+    end
+    
+    
+    def get_random_entry(array)
+      array[rand(array.length)]
+    end
+
+
+    def get_request_classes(provider_name, service_name)
+      service = Aviator::Service.new(provider: provider_name, service: service_name)
+      service.request_classes
+    end
+    
+    
+    def get_service_names(provider_name)
+      Pathname.new(__FILE__)
+        .join('..', '..', '..', '..', '..', 'lib', 'aviator', provider_name)
+        .children
+        .select{|c| c.directory? }
+        .map{|c| c.basename.to_s }
+    end
+    
+
+    describe '::describe_aviator' do
+      
+      it 'describes the aviator gem' do
+        provider_names = get_provider_names
+        
+        display = "Available providers:\n"
+      
+        provider_names.each do |provider_name|
+          display << "  #{ provider_name }\n"
+        end
+
+        Aviator::Describer.describe_aviator.must_equal display
+      end
+      
+    end # describe '::describe_aviator'
+    
+    
+    describe '::describe_provider' do
+      
+      it 'describes the given provider' do
+        provider_name = get_random_entry(get_provider_names)
+        service_names = get_service_names(provider_name)
+        
+        display = "Available services for #{ provider_name }:\n"
+      
+        service_names.each do |service_name|
+          display << "  #{ service_name }\n"
+        end
+
+        Aviator::Describer.describe_provider('openstack').must_equal display
+      end
+      
+    end # describe '::describe_provider'
+    
+    
+    describe '::describe_service' do
+      
+      it 'describes a given service for a given provider' do
+        provider_name   = get_random_entry(get_provider_names)
+        service_name    = get_random_entry(get_service_names(provider_name))
+        request_classes = get_request_classes(provider_name, service_name)
+                
+        display = "Available requests for #{ provider_name } #{ service_name }_service:\n"
+
+        request_classes.each do |klass|
+          display << "  #{ klass.api_version } #{ klass.endpoint_type } #{ klass.name.split('::').last.underscore }\n"
+        end
+      
+        Aviator::Describer.describe_service(provider_name, service_name).must_equal display
+      end
+      
+    end # describe '::describe_service'    
+    
+    
+    describe '::describe_request' do
+      
+      it 'describes a given request' do
+        provider_name = get_random_entry(get_provider_names)
+        service_name  = get_random_entry(get_service_names(provider_name))
+        request_class = get_random_entry(get_request_classes(provider_name, service_name))
+        request_name  = request_class.name.split('::').last.underscore
+        
+        display  = "Request: #{ request_name }\n\n"
+        
+        display << "Parameters:\n"
+
+        params = request_class.optional_params.map{|p| [p, :optional]} + 
+                 request_class.required_params.map{|p| [p, :required]}
+        
+        params.sort{|a,b| a[0].to_s <=> b[0].to_s }.each do |param|
+          display << "  (#{ param[1].to_s }) #{ param[0] }\n"
+        end
+        
+        display << "\nSample Code:\n"
+
+        display << "  session.#{ service_name }_service.request(:#{ request_name }, endpoint_type: '#{ request_class.endpoint_type }')"
+        if params
+          display << " do |params|\n"
+          params.each do |pair|
+            display << "     params['#{ pair[0] }'] = value\n"
+          end
+          display << "  end\n"
+        end
+        
+        if request_class.links
+          display << "\nLinks:\n"
+          
+          request_class.links.each do |link|
+            display << "  #{ link[:rel] }:\n"
+            display << "    #{ link[:href] }\n"
+          end
+        end
+              
+        Aviator::Describer.describe_request(
+          provider_name, service_name, request_class.api_version.to_s, 
+          request_class.endpoint_type.to_s, request_name
+        ).must_equal display
+      end
+      
+    end # describe '::describe_request'    
+    
+    
+  end # describe 'aviator/core/cli/describe'
+  
+end # class Aviator::Test