aviator 0.0.5 → 0.0.6

data/lib/aviator/core/response.rb

@@ -1,39 +1,31 @@
 module Aviator
 
   class Response
+    extend Forwardable
     
-
-    def body
-      @body ||= if response.body.length > 0
-                  JSON.parse(response.body).with_indifferent_access
-                else
-                  {}
-                end
-                
-      @body.dup
-    end
+    def_delegators :@response, :headers, :status
     
+    attr_reader :request
     
-    def method_missing(name, *args)
-      case name
-      when :headers, :status
-        response.send(name)
-      when :request
-        request
+    def initialize(response, request)
+      @response = response
+      @request  = request
+    end
+
+
+    def body
+      if raw_body.length > 0
+        JSON.parse(raw_body).with_indifferent_access
       else
-        super(name, *args)
+        {}
       end
     end
     
     
     private
     
-    attr_reader :response,
-                :request
-    
-    def initialize(response, request)
-      @response = response
-      @request  = request
+    def raw_body
+      @response.body
     end
     
   end

data/lib/aviator/core/service.rb

@@ -35,7 +35,24 @@ module Aviator
     end
 
 
-    class Logger < Faraday::Response::Logger      
+    class MissingServiceEndpointError < StandardError
+      def initialize(service_name, request_name)
+        request_name = request_name.to_s.split('::').last.underscore
+        super "The session's service catalog does not have an entry for the #{ service_name } "\
+              "service. Therefore, I don't know to which base URL the request should be sent. "\
+              "This may be because you are using a default or unscoped token. If this is not your "\
+              "intention, please authenticate with a scoped token. If using a default token is your "\
+              "intention, make sure to provide a base url when you call the request. For example: \n\n"\
+              "session.#{ service_name }_service.request :#{ request_name }, base_url: 'http://myenv.com:9999/v2.0' do |params|\n"\
+              "  params[:example1] = 'example1'\n"\
+              "  params[:example2] = 'example2'\n"\
+              "end\n\n"
+      end
+    end
+
+
+
+    class Logger < Faraday::Response::Logger
       def initialize(app, logger=nil)
         super(app)
         @logger = logger || begin
@@ -50,7 +67,7 @@ module Aviator
 
     attr_reader :service,
                 :provider
-                
+
 
     def initialize(opts={})
       @provider = opts[:provider] || (raise ProviderNotDefinedError.new)
@@ -67,6 +84,10 @@ module Aviator
       session_data = options[:session_data] || default_session_data
 
       raise SessionDataNotProvidedError.new unless session_data
+      
+      [:base_url].each do |k|
+        session_data[k] = options[k] if options[k]
+      end
 
       request_class = find_request(request_name, session_data, options[:endpoint_type])
 
@@ -88,8 +109,8 @@ module Aviator
     def request_classes
       @request_classes
     end
-    
-    
+
+
     private
 
 
@@ -117,20 +138,20 @@ module Aviator
                        end
 
       namespace = Aviator.const_get(provider.camelize)
-                         .const_get(service.camelize)   
+                         .const_get(service.camelize)
+
+      version = infer_version(session_data, name).to_s.camelize
 
-      version = infer_version(session_data).to_s.camelize
-            
       return nil unless version && namespace.const_defined?(version)
 
-      namespace = namespace.const_get(version)
+      namespace = namespace.const_get(version, name)
 
       endpoint_types.each do |endpoint_type|
         name = name.to_s.camelize
-        
+
         next unless namespace.const_defined?(endpoint_type)
         next unless namespace.const_get(endpoint_type).const_defined?(name)
-        
+
         return namespace.const_get(endpoint_type).const_get(name)
       end
 
@@ -139,7 +160,7 @@ module Aviator
 
 
     # Candidate for extraction to aviator/openstack
-    def infer_version(session_data)
+    def infer_version(session_data, request_name='sample_request')
       if session_data.has_key?(:auth_service) && session_data[:auth_service][:api_version]
         session_data[:auth_service][:api_version].to_sym
 
@@ -147,8 +168,13 @@ module Aviator
         m = session_data[:auth_service][:host_uri].match(/(v\d+)\.?\d*/)
         return m[1].to_sym unless m.nil?
 
+      elsif session_data.has_key? :base_url
+        m = session_data[:base_url].match(/(v\d+)\.?\d*/)
+        return m[1].to_sym unless m.nil?
+
       elsif session_data.has_key? :access
         service_spec = session_data[:access][:serviceCatalog].find{|s| s[:type] == service }
+        raise MissingServiceEndpointError.new(service.to_s, request_name) unless service_spec
         version = service_spec[:endpoints][0][:publicURL].match(/(v\d+)\.?\d*/)
         version ? version[1].to_sym : :v1
       end
@@ -169,21 +195,21 @@ module Aviator
                            )
 
       request_file_paths.each{ |path| require path }
-      
+
       constant_parts = request_file_paths
                         .map{|rf| rf.to_s.match(/#{provider}\/#{service}\/([\w\/]+)\.rb$/) }
                         .map{|rf| rf[1].split('/').map{|c| c.camelize }.join('::') }
-      
-      @request_classes = constant_parts.map do |cp| 
+
+      @request_classes = constant_parts.map do |cp|
         "Aviator::#{provider.camelize}::#{service.camelize}::#{cp}".constantize
       end
     end
-    
-    
+
+
     def log_file
       @log_file
     end
-    
+
   end
 
 end

data/lib/aviator/core.rb

@@ -1,3 +1,4 @@
+require 'yaml'
 require 'json'
 require 'active_support/inflector'
 require 'active_support/core_ext/hash/indifferent_access'

data/lib/aviator/openstack/common/v2/admin/base.rb

@@ -0,0 +1,9 @@
+module Aviator
+
+  define_request :base, inherit: [:openstack, :common, :v2, :public, :base] do
+
+    meta :endpoint_type, :admin
+
+  end
+
+end

data/lib/aviator/openstack/common/v2/public/base.rb

@@ -0,0 +1,43 @@
+module Aviator
+
+  define_request :base do
+
+    meta :provider,      :openstack
+    meta :service,       :common
+    meta :api_version,   :v2
+    meta :endpoint_type, :public
+
+    def headers
+      {}.tap do |h|
+        h['X-Auth-Token'] = session_data[:access][:token][:id] unless self.anonymous?
+      end
+    end
+
+
+    private
+
+
+    def base_url
+      if session_data[:base_url]
+        session_data[:base_url]
+      else
+        service_spec = session_data[:access][:serviceCatalog].find { |s| s[:type] == service.to_s }
+        raise Aviator::Service::MissingServiceEndpointError.new(service.to_s, self.class) unless service_spec
+        service_spec[:endpoints][0]["#{ endpoint_type }URL".to_sym]
+      end
+    end
+
+
+    def params_to_querystring(param_names)
+      filters = []
+
+      param_names.each do |param_name|
+        filters << "#{ param_name }=#{ params[param_name] }" if params[param_name]
+      end
+
+      filters.empty? ? "" : "?#{ filters.join('&') }"
+    end
+
+  end
+
+end

data/lib/aviator/openstack/compute/v2/admin/confirm_server_resize.rb

@@ -1,11 +1,8 @@
 module Aviator
 
-  define_request :confirm_server_resize do
+  define_request :confirm_server_resize, inherit: [:openstack, :common, :v2, :admin, :base] do
 
-    meta :provider,      :openstack
-    meta :service,       :compute
-    meta :api_version,   :v2
-    meta :endpoint_type, :admin
+    meta :service, :compute
 
     link 'documentation',
          'http://docs.openstack.org/api/openstack-compute/2/content/Confirm_Resized_Server-d1e3868.html'
@@ -21,13 +18,7 @@ module Aviator
 
 
     def headers
-      h = {}
-
-      unless self.anonymous?
-        h['X-Auth-Token'] = session_data[:access][:token][:id]
-      end
-
-      h
+      super
     end
 
 
@@ -37,8 +28,7 @@ module Aviator
 
 
     def url
-      service_spec = session_data[:access][:serviceCatalog].find{|s| s[:type] == service.to_s }
-      "#{ service_spec[:endpoints][0][:adminURL] }/servers/#{ params[:id] }/action"
+      "#{ base_url }/servers/#{ params[:id] }/action"
     end
 
   end

data/lib/aviator/openstack/compute/v2/admin/create_network.rb

@@ -0,0 +1,56 @@
+module Aviator
+
+  define_request :create_network, inherit: [:openstack, :common, :v2, :admin, :base] do
+
+    meta :service, :compute
+
+    link 'documentation',
+         'http://api.openstack.org/api-ref-compute.html#ext-os-networks'
+
+
+    param :label,             required: true
+    param :bridge,            required: false
+    param :bridge_interface,  required: false
+    param :cidr,              required: false
+    param :cidr_v6,           required: false
+    param :dns1,              required: false
+    param :dns2,              required: false
+    param :gateway,           required: false
+    param :gateway_v6,        required: false
+    param :multi_host,        required: false
+    param :project_id,        required: false
+    param :vlan,              required: false
+
+
+    def body
+      p = {
+        network: {
+          label: params[:label]
+        }
+      }
+
+      optional_params.each do |key|
+        p[:network][key] = params[key] if params[key]
+      end
+
+      p
+    end
+
+
+    def headers
+      super
+    end
+
+
+    def http_method
+      :post
+    end
+
+
+    def url
+      "#{ base_url }/os-networks"
+    end
+
+  end
+
+end

data/lib/aviator/openstack/compute/v2/admin/get_host_details.rb

@@ -1,11 +1,8 @@
 module Aviator
 
-  define_request :get_host_details do
+  define_request :get_host_details, inherit: [:openstack, :common, :v2, :admin, :base] do
 
-    meta :provider,      :openstack
-    meta :service,       :compute
-    meta :api_version,   :v2
-    meta :endpoint_type, :admin
+    meta :service, :compute
 
     link 'documentation',
       'http://api.openstack.org/api-ref.html#ext-os-hosts'
@@ -14,13 +11,7 @@ module Aviator
 
 
     def headers
-      h = {}
-
-      unless self.anonymous?
-        h['X-Auth-Token'] = session_data[:access][:token][:id]
-      end
-
-      h
+      super
     end
 
 
@@ -30,9 +21,7 @@ module Aviator
 
 
     def url
-      service_spec = session_data[:access][:serviceCatalog].find { |s| s[:type] == service.to_s }
-
-      "#{ service_spec[:endpoints][0][:adminURL] }/os-hosts/#{ params[:host_name] }"
+      "#{ base_url }/os-hosts/#{ params[:host_name] }"
     end
 
   end

data/lib/aviator/openstack/compute/v2/admin/list_hosts.rb

@@ -1,14 +1,11 @@
 module Aviator
 
-  define_request :list_hosts do
+  define_request :list_hosts, inherit: [:openstack, :common, :v2, :admin, :base] do
 
-    meta :provider,      :openstack
-    meta :service,       :compute
-    meta :api_version,   :v2
-    meta :endpoint_type, :admin
+    meta :service, :compute
 
     link 'documentation',
-      'http://api.openstack.org/api-ref.html#ext-os-hosts'
+         'http://api.openstack.org/api-ref.html#ext-os-hosts'
 
     link 'documentation bug',
          'https://bugs.launchpad.net/nova/+bug/1224763'
@@ -18,13 +15,7 @@ module Aviator
 
 
     def headers
-      h = {}
-
-      unless self.anonymous?
-        h['X-Auth-Token'] = session_data[:access][:token][:id]
-      end
-
-      h
+      super
     end
 
 
@@ -34,9 +25,7 @@ module Aviator
 
 
     def url
-      service_spec = session_data[:access][:serviceCatalog].find { |s| s[:type] == service.to_s }
-
-      url = "#{ service_spec[:endpoints][0][:adminURL] }/os-hosts"
+      url = "#{ base_url }/os-hosts"
 
       filters = []
 

data/lib/aviator/openstack/compute/v2/admin/lock_server.rb

@@ -0,0 +1,34 @@
+module Aviator
+
+  define_request :lock_server, inherit: [:openstack, :common, :v2, :admin, :base] do
+
+    meta :service, :compute
+
+    link 'documentation',
+         'http://docs.openstack.org/api/openstack-compute/2/content/POST_lock_v2__tenant_id__servers__server_id__action_ext-os-admin-actions.html'
+
+    param :id, required: true
+
+
+    def body
+      { lock: nil }
+    end
+
+
+    def headers
+      super
+    end
+
+
+    def http_method
+      :post
+    end
+
+
+    def url
+      "#{ base_url }/servers/#{ params[:id] }/action"
+    end
+
+  end
+
+end

data/lib/aviator/openstack/compute/v2/admin/migrate_server.rb

@@ -0,0 +1,34 @@
+module Aviator
+
+  define_request :migrate_server, inherit: [:openstack, :common, :v2, :admin, :base] do
+
+    meta :service, :compute
+
+    link 'documentation',
+         'http://docs.openstack.org/api/openstack-compute/2/content/POST_migrate_v2__tenant_id__servers__server_id__action_ext-os-admin-actions.html'
+
+    param :id,   required: true
+
+
+    def body
+      { migrate: nil }
+    end
+
+
+    def headers
+      super
+    end
+
+
+    def http_method
+      :post
+    end
+
+
+    def url
+      "#{ base_url }/servers/#{ params[:id] }/action"
+    end
+
+  end
+
+end

data/lib/aviator/openstack/compute/v2/admin/reset_server.rb

@@ -0,0 +1,39 @@
+module Aviator
+
+  define_request :reset_server, inherit: [:openstack, :common, :v2, :admin, :base] do
+
+    meta :service, :compute
+
+    link 'documentation',
+         'http://docs.openstack.org/api/openstack-compute/2/content/POST_os-resetState_v2__tenant_id__servers__server_id__action_ext-os-admin-actions.html'
+
+    param :id,    required: true
+    param :state, required: true
+
+
+    def body
+      {
+        'os-resetState' => {
+          'state' => params[:state]
+        }
+      }
+    end
+
+
+    def headers
+      super
+    end
+
+
+    def http_method
+      :post
+    end
+
+
+    def url
+      "#{ base_url }/servers/#{ params[:id] }/action"
+    end
+
+  end
+
+end

data/lib/aviator/openstack/compute/v2/admin/resize_server.rb

@@ -1,18 +1,15 @@
 module Aviator
 
-  define_request :resize_server do
+  define_request :resize_server, inherit: [:openstack, :common, :v2, :admin, :base] do
 
-    meta :provider,      :openstack
-    meta :service,       :compute
-    meta :api_version,   :v2
-    meta :endpoint_type, :admin
+    meta :service, :compute
 
     link 'documentation',
          'http://docs.openstack.org/api/openstack-compute/2/content/Resize_Server-d1e3707.html'
 
     param :id,        required: true
     param :name,      required: true
-    param :flavorRef, required: true
+    param :flavorRef, required: true, alias: :flavor_ref
 
 
     def body
@@ -26,13 +23,7 @@ module Aviator
 
 
     def headers
-      h = {}
-
-      unless self.anonymous?
-        h['X-Auth-Token'] = session_data[:access][:token][:id]
-      end
-
-      h
+      super
     end
 
 
@@ -42,8 +33,7 @@ module Aviator
 
 
     def url
-      service_spec = session_data[:access][:serviceCatalog].find{|s| s[:type] == service.to_s }
-      "#{ service_spec[:endpoints][0][:adminURL] }/servers/#{ params[:id] }/action"
+      "#{ base_url }/servers/#{ params[:id] }/action"
     end
 
   end

data/lib/aviator/openstack/compute/v2/admin/unlock_server.rb

@@ -0,0 +1,34 @@
+module Aviator
+
+  define_request :unlock_server, inherit: [:openstack, :common, :v2, :admin, :base] do
+
+    meta :service, :compute
+
+    link 'documentation',
+         'http://docs.openstack.org/api/openstack-compute/2/content/POST_unlock_v2__tenant_id__servers__server_id__action_ext-os-admin-actions.html'
+
+    param :id, required: true
+
+
+    def body
+      { unlock: nil }
+    end
+
+
+    def headers
+      super
+    end
+
+
+    def http_method
+      :post
+    end
+
+
+    def url
+      "#{ base_url }/servers/#{ params[:id] }/action"
+    end
+
+  end
+
+end

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

@@ -1,22 +1,19 @@
 module Aviator
 
-  define_request :change_admin_password do
+  define_request :change_admin_password, inherit: [:openstack, :common, :v2, :public, :base] do
 
-    meta :provider,      :openstack
-    meta :service,       :compute
-    meta :api_version,   :v2
-    meta :endpoint_type, :public
+    meta :service, :compute
 
     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 :adminPass, required: true, alias: :admin_pass
     param :id,        required: true
-    
-    
+
+
     def body
       p = {
         changePassword: {
@@ -26,27 +23,20 @@ module Aviator
 
       p
     end
-    
-    
+
+
     def headers
-      h = {}
-    
-      unless self.anonymous?
-        h['X-Auth-Token'] = session_data[:access][:token][:id]
-      end
-    
-      h
+      super
     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"
+      "#{ base_url }/servers/#{ params[:id] }/action"
     end
 
   end