aviator 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50c59bcfabe57baf9c0e21fcab0370bc31855e4a
-  data.tar.gz: 41e8ce7fed1ed7ddee839142d005d66c02a6665f
+  metadata.gz: a9501d71ef567ef9bfe2a511a7122a23f8faca48
+  data.tar.gz: 9ae86b5df08bbceafb3481b6a4693ab2783996c1
 SHA512:
-  metadata.gz: 7fafc12e4cea11cb1e7fff20f13bfdb953614729f74865f1d16e5ca9273abb3c686c79578500232860394169b45283e90a6892abeaff38496e41071231aec36e
-  data.tar.gz: a9645737bdc80f20516b8b5f499ae15fe8cae7e189268925e207696c55ad0dba1b44125415e74b34316d9f3d0e136b89790533232696792ddd19c0a99bb868e9
+  metadata.gz: aed3dc71e256f15c8e314f4d781e369d23b6648fa7406c2e84a34f3326457e5c93fc1c2d2b073a0f71904947081da6191412e346d76ff8a5806184ffed1fd9af
+  data.tar.gz: 435d8acd62fcbf0fc8ed08f2ee9fabd6baf87f17b8258eea76f7fae30faaee19b3b36f6e74239bab1914b3603a2f10ca3cf474ca22a19e69c70edde26f0b72d1

data/.gitignore

@@ -21,3 +21,5 @@ test/environment.yml
 vcr.log
 .ruby-gemset
 .ruby-version
+*.swp
+*.swo

data/aviator.gemspec

@@ -21,10 +21,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'faraday', '0.8.8'
-  spec.add_dependency 'thor', '~> 0.18.1'
+  # Runtime dependencies
+  spec.add_dependency 'faraday', '>= 0.8.8'
+  spec.add_dependency 'thor', '>= 0.18.1'
   spec.add_dependency 'terminal-table', '>= 1.4.5'
 
+  # Development dependencies. See Gemfile for more development deps.
   spec.add_development_dependency "bundler", ">= 1.0"
   spec.add_development_dependency 'rb-fsevent', '~> 0.9.0'
   spec.add_development_dependency 'guard', '~> 1.8.0'

data/bin/aviator

@@ -8,7 +8,7 @@ module Aviator
 module CLI
 
   class Main < Thor
-    
+
     desc 'describe [PROVIDER] [SERVICE] [API_VERSION ENDPOINT_TYPE REQUEST_NAME]', 'Describes various parts of Aviator.'
     def describe(provider=nil, service=nil, api_version=nil, endpoint_type=nil, request=nil)
       if request
@@ -20,6 +20,8 @@ module CLI
       else
         puts Aviator::Describer.describe_aviator
       end
+    rescue Aviator::Describer::InvalidProviderNameError => e
+      puts e.message
     end
 
   end
@@ -27,4 +29,4 @@ module CLI
 end
 end
 
-Aviator::CLI::Main.start(ARGV)
+Aviator::CLI::Main.start(ARGV)

data/lib/aviator/core/cli/describer.rb

@@ -2,6 +2,13 @@ module Aviator
 
   class Describer
 
+    class InvalidProviderNameError < StandardError
+      def initialize(name)
+        super "Provider '#{ name }' does not exist."
+      end
+    end
+
+
     def self.describe_aviator
       str = "Available providers:\n"
 
@@ -104,13 +111,19 @@ module Aviator
 
 
     def self.describe_service(provider_name, service_name)
-      str = "Available requests for #{ provider_name } #{ service_name }_service:\n"
+      requests = request_classes(provider_name, service_name)
 
-      request_classes(provider_name, service_name).each do |klass|
-        str << "  #{ klass.api_version } #{ klass.endpoint_type } #{ klass.name.split('::').last.underscore }\n"
-      end
+      if requests.empty?
+        str = "No requests found for #{ provider_name } #{ service_name }_service."
+      else
+        str = "Available requests for #{ provider_name } #{ service_name }_service:\n"
 
-      str
+        requests.each do |klass|
+          str << "  #{ klass.api_version } #{ klass.endpoint_type } #{ klass.name.split('::').last.underscore }\n"
+        end
+
+        str
+      end
     end
 
 
@@ -132,12 +145,14 @@ module Aviator
       end
 
 
-      def service_names(provider_name)
-        Pathname.new(__FILE__) \
-          .join('..', '..', '..', provider_name) \
-          .children \
-          .select{|c| c.directory? } \
-          .map{|c| c.basename.to_s }
+      def service_names(name)
+        provider = Pathname.new(__FILE__).join('..', '..', '..', name)
+
+        raise InvalidProviderNameError.new(name) unless provider.exist?
+
+        provider.children \
+                .select{|c| c.directory? } \
+                .map{|c| c.basename.to_s }
       end
     end
 

data/lib/aviator/core/service.rb

@@ -21,9 +21,17 @@ module Aviator
     end
 
     class SessionDataNotProvidedError < StandardError
-      def initialize
-        super "default_session_data is not initialized and no session data was "\
-              "provided in the method call."
+      def initialize(service_name, request_name)
+        super "\n\nERROR: default_session_data is not initialized and no session data was provided in\n"\
+              "the method call. You have two ways to fix this:\n\n"\
+              "   1) Call Session#authenticate before calling Session##{service_name}_service, or\n\n"\
+              "   2) If you're really sure you don't want to authenticate beforehand,\n"\
+              "      construct the method call this way:\n\n"\
+              "          service = session.#{service_name}_service\n"\
+              "          service.request :#{request_name}, :api_version => :v2, :session_data => sessiondatavar\n\n"\
+              "      Replace :v2 with whatever available version you want to use and make sure sessiondatavar\n"\
+              "      is a hash that contains, at least, the :base_url key. Other keys, such as :service_token may\n"\
+              "      be needed depending on what the request class you are calling requires.\n\n"
       end
     end
 
@@ -75,7 +83,7 @@ module Aviator
 
       session_data = options[:session_data] || default_session_data
 
-      raise SessionDataNotProvidedError.new unless session_data
+      raise SessionDataNotProvidedError.new(@service, request_name) unless session_data
 
       [:base_url].each do |k|
         session_data[k] = options[k] if options[k]

data/lib/aviator/core/session.rb

@@ -76,6 +76,7 @@ module Aviator
       else
         raise AuthenticationError.new(response.body)
       end
+      self
     end
 
 
@@ -152,8 +153,6 @@ module Aviator
 
 
     def get_service_obj(service_name)
-      raise NotAuthenticatedError.new unless self.authenticated?
-
       @services ||= {}
 
       if @services[service_name].nil?

data/lib/aviator/openstack/common/requests/v0/public/base.rb

@@ -12,6 +12,12 @@ module Aviator
         if self.anonymous?
           # do nothing
 
+        elsif session_data.has_key? :service_token
+          # service_token is the token that one would bootstrap OpenStack
+          # with during the installation process. This token can be used
+          # directly and does not require authentication beforehand.
+          h['X-Auth-Token'] = session_data[:service_token]
+
         elsif keystone_v2_style_session_data?
           h['X-Auth-Token'] = session_data[:body][:access][:token][:id]
 

data/lib/aviator/openstack/compute/requests/v2/admin/list_hypervisors.rb

@@ -0,0 +1,27 @@
+module Aviator
+
+  define_request :list_hypervisors, :inherit => [:openstack, :common, :v2, :admin, :base] do
+
+    meta :service, :compute
+
+    link 'documentation',
+         'http://api.openstack.org/api-ref-compute-v2-ext.html#ext-os-hypervisors'
+
+    def headers
+      super
+    end
+
+
+    def http_method
+      :get
+    end
+
+
+    def url
+      "#{ base_url }/os-hypervisors"
+    end
+
+  end
+
+end
+

data/lib/aviator/openstack/compute/requests/v2/public/add_floating_ip.rb

@@ -0,0 +1,38 @@
+module Aviator
+
+  define_request :add_floating_ip, :inherit => [:openstack, :common, :v2, :public, :base] do
+
+    meta :service, :compute
+
+    link 'documentation',
+         'http://docs.openstack.org/api/openstack-compute/2/content/POST_os-floating-ips-v2_AddFloatingIP__v2__tenant_id__servers__server_id__action_ext-os-floating-ips.html#POST_os-floating-ips-v2_AddFloatingIP__v2__tenant_id__servers__server_id__action_ext-os-floating-ips-Request'
+
+    param :server_id, :required => true
+    param :address,   :required => true
+
+    def body
+      {
+        :addFloatingIp => {
+          :address => params[:address]
+        }
+      }
+    end
+
+
+    def headers
+      super
+    end
+
+
+    def http_method
+      :post
+    end
+
+
+    def url
+      "#{ base_url }/servers/#{ params[:server_id] }/action"
+    end
+
+  end
+
+end

data/lib/aviator/openstack/compute/requests/v2/public/allocate_floating_ip.rb

@@ -0,0 +1,35 @@
+module Aviator
+
+  define_request :allocate_floating_ip, :inherit => [:openstack, :common, :v2, :public, :base] do
+
+    meta :service, :compute
+
+    link 'documentation',
+         'http://docs.openstack.org/api/openstack-compute/2/content/POST_os-floating-ips-v2_AllocateFloatingIP__v2__tenant_id__os-floating-ips_ext-os-floating-ips.html'
+
+    param :pool, :required => false
+
+    def body
+      {
+        :pool => params[:pool]
+      }
+    end
+
+
+    def headers
+      super
+    end
+
+
+    def http_method
+      :post
+    end
+
+
+    def url
+      "#{ base_url }/os-floating-ips"
+    end
+
+  end
+
+end

data/lib/aviator/openstack/compute/requests/v2/public/create_keypair.rb

@@ -0,0 +1,39 @@
+module Aviator
+
+  define_request :create_keypair, :inherit => [:openstack, :common, :v2, :public, :base] do
+
+    meta :service, :compute
+
+    link 'documentation',
+         'http://docs.openstack.org/api/openstack-compute/2/content/POST_os-keypairs-v2_createKeypair__v2__tenant_id__os-keypairs_ext-os-keypairs.html'
+
+    param :name,        :required => true
+    param :public_key,  :required => false
+
+    def body
+      {
+        :keypair => {
+          :name       => params[:name],
+          :public_key => params[:public_key],
+        }
+      }
+    end
+
+
+    def headers
+      super
+    end
+
+
+    def http_method
+      :post
+    end
+
+
+    def url
+      "#{ base_url }/os-keypairs"
+    end
+
+  end
+
+end

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

@@ -12,6 +12,7 @@ module Aviator
     param :adminPass,   :required => false, :alias => :admin_pass
     param :imageRef,    :required => true,  :alias => :image_ref
     param :flavorRef,   :required => true,  :alias => :flavor_ref
+    param :key_name,    :required => false
     param :metadata,    :required => false
     param :name,        :required => true
     param :networks,    :required => false
@@ -27,7 +28,7 @@ module Aviator
         }
       }
 
-      [:adminPass, :metadata, :personality, :networks, :accessIPv4, :accessIPv6].each do |key|
+      [:adminPass, :metadata, :personality, :networks, :accessIPv4, :accessIPv6, :key_name].each do |key|
         p[:server][key] = params[key] if params[key]
       end
 

data/lib/aviator/openstack/compute/requests/v2/public/list_floating_ips.rb

@@ -0,0 +1,26 @@
+module Aviator
+
+  define_request :list_floating_ips, :inherit => [:openstack, :common, :v2, :public, :base] do
+
+    meta :service, :compute
+
+    link 'documentation',
+         'http://docs.openstack.org/api/openstack-compute/2/content/GET_os-floating-ips-v2_ListFloatingIPs__v2__tenant_id__os-floating-ips_ext-os-floating-ips.html'
+
+    def headers
+      super
+    end
+
+
+    def http_method
+      :get
+    end
+
+
+    def url
+      str  = "#{ base_url }/os-floating-ips"
+    end
+
+  end
+
+end

data/lib/aviator/openstack/compute/requests/v2/public/list_keypairs.rb

@@ -0,0 +1,26 @@
+module Aviator
+  
+  define_request :list_keypairs, :inherit => [:openstack, :common, :v2, :public, :base] do
+
+    meta :service, :compute
+
+    link 'documentation',
+         'http://docs.openstack.org/api/openstack-compute/2/content/GET_os-keypairs-v2_getKeypair__v2__tenant_id__os-keypairs_ext-os-keypairs.html'
+
+    def headers
+      super
+    end
+
+
+    def http_method
+      :get
+    end
+
+
+    def url
+      str  = "#{ base_url }/os-keypairs"
+    end
+
+  end
+
+end

data/lib/aviator/openstack/identity/requests/v2/admin/get_user.rb

@@ -0,0 +1,33 @@
+require 'cgi'
+
+module Aviator
+
+  define_request :get_user, :inherit => [:openstack, :common, :v2, :public, :base] 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_getUserByName_v2.0_users__User_Operations.html'
+
+    param :name, :required => true
+
+    def headers
+      super
+    end
+
+
+    def http_method
+      :get
+    end
+
+
+    def url
+      "#{ base_url }/users?name=#{ CGI::escape(params.name) }"
+    end
+
+  end
+
+end

data/lib/aviator/version.rb

@@ -1,3 +1,3 @@
 module Aviator
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/test/aviator/core/session_test.rb

@@ -261,13 +261,6 @@ class Aviator::Test
 
     describe '#xxx_service' do
 
-      it 'raises a NotAuthenticatedError if called without authenticating first' do
-        the_method = lambda { new_session.identity_service }
-
-        the_method.must_raise Aviator::Session::NotAuthenticatedError
-      end
-
-
       it 'returns an instance of the indicated service' do
         session = new_session
         session.authenticate
@@ -275,6 +268,12 @@ class Aviator::Test
         session.identity_service.wont_be_nil
       end
 
+      it 'returns an instance of the indicated service even if not authenticated' do
+        session = new_session
+        session.compute_service.wont_be_nil
+        session.authenticated?.must_equal false
+      end
+
     end
 
   end # describe 'aviator/core/service'

data/test/aviator/openstack/common/requests/v0/public/base_test.rb

@@ -66,6 +66,19 @@ class Aviator::Test
 
     describe '#headers' do
 
+      it 'must know to extract a service token if provided' do
+        session_data = {
+          :base_url => 'http://example.com',
+          :service_token => 'sometokenipickedupfromsomewhere'
+        }
+        headers = { 'X-Auth-Token' => session_data[:service_token] }
+
+        request = create_request(session_data)
+
+        request.headers.must_equal headers
+      end
+
+
       it 'must know to extract token from a Keystone v2 auth info' do
         session_data = get_session_data(:v2)
         headers = { 'X-Auth-Token' => session_data[:body][:access][:token][:id] }

data/test/aviator/openstack/compute/requests/v2/admin/list_hypervisors_test.rb

@@ -0,0 +1,112 @@
+require 'test_helper'
+
+class Aviator::Test
+
+  describe 'aviator/openstack/compute/requests/v2/admin/list_hypervisors' do
+
+    def create_request(session_data = get_session_data, &block)
+      klass.new(session_data, &block)
+    end
+
+
+    def get_session_data
+      session.send :auth_response
+    end
+
+
+    def helper
+      Aviator::Test::RequestHelper
+    end
+
+
+    def klass
+      @klass ||= helper.load_request('openstack', 'compute', 'v2', 'admin', 'list_hypervisors.rb')
+    end
+
+
+    def session
+      unless @session
+        @session = Aviator::Session.new(
+                     :config_file => Environment.path,
+                     :environment => 'openstack_admin'
+                   )
+        @session.authenticate
+      end
+
+      @session
+    end
+
+
+    validate_attr :anonymous? do
+      klass.anonymous?.must_equal false
+    end
+
+
+    validate_attr :api_version do
+      klass.api_version.must_equal :v2
+    end
+
+
+    validate_attr :body do
+      klass.body?.must_equal false
+      create_request.body?.must_equal false
+    end
+
+
+    validate_attr :endpoint_type do
+      klass.endpoint_type.must_equal :admin
+    end
+
+
+    validate_attr :headers do
+      session_data = get_session_data
+
+      headers = { 'X-Auth-Token' => session_data[:body][:access][:token][:id] }
+
+      request = create_request(session_data)
+
+      request.headers.must_equal headers
+    end
+
+
+    validate_attr :http_method do
+      create_request.http_method.must_equal :get
+    end
+
+
+    validate_attr :optional_params do
+      klass.optional_params.must_equal []
+    end
+
+
+    validate_attr :required_params do
+      klass.required_params.must_equal []
+    end
+
+
+    validate_attr :url do
+      session_data = get_session_data
+      service_spec = session_data[:body][:access][:serviceCatalog].find{|s| s[:type] == 'compute' }
+      url          = "#{ service_spec[:endpoints][0][:adminURL] }/os-hypervisors"
+      request      = klass.new(session_data)
+
+      request.url.must_equal url
+    end
+
+
+    validate_response 'no parameters are provided' do
+      service = session.compute_service
+
+      response = service.request :list_hypervisors, :api_version => :v2
+
+      response.status.must_equal 200
+      response.body.wont_be_nil
+      response.body[:hypervisors].must_be_kind_of Array
+      response.body[:hypervisors].length.wont_equal 0
+      response.headers.wont_be_nil
+    end
+
+  end
+
+end
+