misty 1.3.3 → 1.4.0

data/lib/misty/{auth/errors.rb → errors.rb}

@@ -5,8 +5,16 @@ module Misty
     class TokenError          < StandardError; end
 
     class ExpiryError      < RuntimeError; end
-    class CredentialsError < RuntimeError; end
     class InitError        < RuntimeError; end
     class URLError         < RuntimeError; end
   end
+
+  class Config
+    class CredentialsError < RuntimeError; end
+    class InvalidDataError < StandardError; end
+  end
+
+  module Microversion
+    class VersionError < RuntimeError; end
+  end
 end

data/lib/misty/http/direct.rb

@@ -1,7 +1,24 @@
 module Misty
   module HTTP
-    # Provides methods to submit the current service with a path and override @base_path if needed
+    # Allows to submit http request wwith provided path and override base_path if needed
     module Direct
+
+      # ==== Examples
+      #    auth = { ... }
+      #    cloud = Misty::Cloud.new(:auth => auth)
+      #
+      #    net = cloud.network.get('/v2.0/networks')
+      #    pp net.body
+      #
+      #    id = cloud.identity.get('/')
+      #    pp id.body
+      #
+      #    servers = cloud.compute.get('/servers')
+      #    pp servers.body
+      #
+      #    img = cloud.image.get('/v1')
+      #    pp img.body
+
       def base_set(base_path)
         base = base_path ? base_path : @base_path
       end

data/lib/misty/http/method_builder.rb

@@ -21,13 +21,6 @@ module Misty
       end
 
       def method_call(method, *args)
-        if args[-1].class == Misty::HTTP::Header
-          header = Misty::HTTP::Header.new(@headers.get.clone)
-          header.add(args.pop.get)
-        else
-          header = @headers
-        end
-
         base, path = prefixed_path(method[:path])
         size_path_parameters = count_path_params(path)
         path_params = args[0, size_path_parameters]
@@ -37,26 +30,26 @@ module Misty
 
         case method[:request]
         when :COPY
-          http_copy(final_path, header.get)
+          http_copy(final_path, @request_headers.get)
         when :DELETE
-          http_delete(final_path, header.get)
+          http_delete(final_path, @request_headers.get)
         when :GET
           final_path << query_param(args_left.shift) if args_left && args_left.size == 1
-          http_get(final_path, header.get)
+          http_get(final_path, @request_headers.get)
         when :HEAD
-          http_head(final_path, header.get)
+          http_head(final_path, @request_headers.get)
         when :POST
           final_path << query_param(args_left.shift) if args_left && args_left.size == 2
-          data = process_data(header, args_left)
-          http_post(final_path, header.get, data)
+          data = process_data(@request_headers, args_left)
+          http_post(final_path, @request_headers.get, data)
         when :PUT
           final_path << query_param(args_left.shift) if args_left && args_left.size == 2
-          data = process_data(header, args_left)
-          http_put(final_path, header.get, data)
+          data = process_data(@request_headers, args_left)
+          http_put(final_path, @request_headers.get, data)
         when :PATCH
           final_path << query_param(args_left.shift) if args_left && args_left.size == 2
-          data = process_data(header, args_left)
-          http_patch(final_path, header.get, data)
+          data = process_data(@request_headers, args_left)
+          http_patch(final_path, @request_headers.get, data)
         else
           raise SyntaxError, "Invalid HTTP request: #{method[:request]}"
         end

data/lib/misty/http/net_http.rb

@@ -1,6 +1,6 @@
 module Misty
   module HTTP
-    # This class implements the http request routine.
+    # This class wraps net/http request routine.
     module NetHTTP
       def self.http_request(uri, options = {})
         http_options = {}

data/lib/misty/http/request.rb

@@ -1,21 +1,32 @@
 module Misty
   module HTTP
     module Request
+
+      DECODE_TO_JSON = ["application/json", "application/octet-stream"].freeze
+
       def decode?(response)
         return false if response.body.nil? || response.body.empty?
-        if @config.content_type != :json && response.code =~ /2??/ && !response.is_a?(Net::HTTPNoContent) \
-          && !response.is_a?(Net::HTTPResetContent) && response.header['content-type'] \
-          && response.header['content-type'].include?('application/json')
+        if @request_content_type != :json && response.code =~ /2??/ \
+          && !response.is_a?(Net::HTTPNoContent) \
+          && !response.is_a?(Net::HTTPResetContent) \
+          && response.header['content-type'] && decode_to_json?(response.header['content-type'])
           return true
         end
         false
       end
 
+      def decode_to_json?(content_type)
+        DECODE_TO_JSON.each do |type|
+          return true if content_type.include?(type)
+        end
+        false
+      end
+
       def http(request)
         request['X-Auth-Token'] = @auth.get_token
 
         Misty::HTTP::NetHTTP.http_request(
-          @uri, ssl_verify_mode: @options.ssl_verify_mode, log: @config.log
+          @uri, ssl_verify_mode: @ssl_verify_mode, log: @log
         ) do |connection|
           response = connection.request(request)
           response.body = JSON.parse(response.body) if decode?(response)
@@ -24,59 +35,60 @@ module Misty
       end
 
       def http_delete(path, headers)
-        @config.log.info(http_to_s(path, headers))
+        @log.info(http_to_s('DELETE', path, headers))
         request = Net::HTTP::Delete.new(path, headers)
         http(request)
       end
 
       def http_copy(path, headers)
-        @config.log.info(http_to_s(path, headers))
+        @log.info(http_to_s('COPY', path, headers))
         request = Net::HTTP::Copy.new(path, headers)
         http(request)
       end
 
       def http_get(path, headers)
-        @config.log.info(http_to_s(path, headers))
+        @log.info(http_to_s('GET', path, headers))
         request = Net::HTTP::Get.new(path, headers)
         http(request)
       end
 
       def http_head(path, headers)
-        @config.log.info(http_to_s(path, headers))
+        @log.info(http_to_s('HEAD', path, headers))
         request = Net::HTTP::Head.new(path, headers)
         http(request)
       end
 
       def http_options(path, headers)
-        @config.log.info(http_to_s(path, headers))
+        @log.info(http_to_s('OPTIONS', path, headers))
         request = Net::HTTP::Options.new(path, headers)
         http(request)
       end
 
       def http_patch(path, headers, data)
-        @config.log.info(http_to_s(path, headers, data))
+        @log.info(http_to_s('PATCH', path, headers, data))
         request = Net::HTTP::Patch.new(path, headers)
         request.body = data
         http(request)
       end
 
       def http_post(path, headers, data)
-        @config.log.info(http_to_s(path, headers, data))
+        @log.info(http_to_s('POST', path, headers, data))
         request = Net::HTTP::Post.new(path, headers)
         request.body = data
         http(request)
       end
 
       def http_put(path, headers, data)
-        @config.log.info(http_to_s(path, headers, data))
+        @log.info(http_to_s('PUT', path, headers, data))
         request = Net::HTTP::Put.new(path, headers)
         request.body = data
         http(request)
       end
 
-      def http_to_s(path, headers, data = nil)
-        log = "base_url='#{@uri.host}:#{@uri.port}', path='#{path}', header=#{headers}"
+      def http_to_s(verb, path, headers, data = nil)
+        log = "HTTP #{verb} base_url='#{@uri.host}:#{@uri.port}', path='#{path}', header=#{headers}"
         log << ", data='#{data}'" if data
+        log
       end
     end
   end

data/lib/misty/microversion.rb

@@ -1,54 +1,28 @@
 module Misty
+  # Handles OpenStack Services supporting Microversion feature
   module Microversion
-    class VersionError < RuntimeError; end
-
-    VERSION_STATES = %w{CURRENT LATEST SUPPORTED}
-
-    def initialize(auth, cloud, options)
-      super
-      @microversion = true
-      @version = version_get(@options.version)
-    end
-
-    def microversion_header
-      {'X-Openstack-API-Version' => "#{baseclass.downcase} #{@version}" }
-    end
-
-    def version_get(version_option)
-      if VERSION_STATES.include?(version_option)
-        return version_by_state(version_option)
+    def set_version(version)
+      case version
+      when nil || ''
+        # TODO:
+        # version_discovery
+      when 'latest'
+        'latest'
+      when /^([1-9]+\d*)\.([1-9]+\d*)$/
+        version if version_match(version)
       else
-        return version_by_number(version_option)
+        raise VersionError, ":version must be '<number.number>' or 'latest'"
       end
     end
 
-    def versions
-      @versions ||= versions_fetch
+    def microversion_header(version)
+      {'X-Openstack-API-Version' => "#{service_names[0]} #{version}" }
     end
 
     private
 
-    def version_by_number(number)
-      versions.each do |version|
-        return number if version['min_version'] <= number && version['version'] >= number
-      end
-      raise VersionError, "Version #{number} is out of range of available versions #{versions}"
-    end
-
-    def version_by_state(state)
-      version_details = nil
-      versions.each do |version|
-        if version['status'] == state
-          version_details = version
-          break
-        end
-      end
-      raise VersionError, "Version #{state} is not available among #{versions}" if version_details.nil?
-      if version_details['version'].empty?
-        @microversion = false
-        return ''
-      end
-      version_details['version']
+    def versions
+      @versions ||= versions_fetch
     end
 
     def versions_fetch
@@ -59,5 +33,12 @@ module Misty
       raise VersionError, 'Missing version data' unless list
       list
     end
+
+    def version_match(number)
+      versions.each do |version|
+        return number if version['min_version'] <= number && version['version'] >= number
+      end
+      raise VersionError, "Version #{number} is out of range of available versions: #{versions}"
+    end
   end
 end

data/lib/misty/misty.rb

@@ -1,19 +1,23 @@
 require 'misty/services'
+require 'logger'
+
+# Misty is a HTTP client for OpenStack APIs, aiming to be fast, flexible and exhaustive.
+# Misty acts as a conduit to OpenStack APIs by handling requests as transparently as possible.
 
 module Misty
   SERVICES = [
     { name: :application_catalog,                 project: :murano,      versions: ['v1']},
     { name: :alarming,                            project: :aodh,        versions: ['v2']},
     { name: :backup,                              project: :freezer,     versions: ['v1']},
-    { name: :baremetal,                           project: :ironic,      microversion: 'v1'},
-    { name: :block_storage,                       project: :cinder,      microversion: 'v3', versions: ['v2', 'v1']},
+    { name: :baremetal,                           project: :ironic,      versions: ['v1'],             microversion: 'v1'},
+    { name: :block_storage,                       project: :cinder,      versions: ['v3', 'v2', 'v1'], microversion: 'v3'},
     { name: :clustering,                          project: :senlin,      versions: ['v1']},
-    { name: :compute,                             project: :nova,        microversion: 'v2.1'},
-    { name: :container_infrastructure_management, project: :magnum,      microversion: 'v1'},
+    { name: :compute,                             project: :nova,        versions: ['v2.1'],           microversion: 'v2.1'},
+    { name: :container_infrastructure_management, project: :magnum,      versions: ['v1'],             microversion: 'v1'},
     { name: :data_processing,                     project: :sahara,      versions: ['v1.1']},
     { name: :data_protection_orchestration,       project: :karbor,      versions: ['v1']},
     { name: :database,                            project: :trove,       versions: ['v1.0']},
-    { name: :domain_name_server,                  project: :designate,   versions: ['v2']},
+    { name: :dns               ,                  project: :designate,   versions: ['v2']},
     { name: :identity,                            project: :keystone,    versions: ['v3', 'v2.0']},
     { name: :image,                               project: :glance,      versions: ['v2', 'v1']},
     { name: :load_balancer,                       project: :octavia,     versions: ['v2.0']},
@@ -24,30 +28,12 @@ module Misty
     { name: :object_storage,                      project: :swift,       versions: ['v1']},
     { name: :orchestration,                       project: :heat,        versions: ['v1']},
     { name: :search,                              project: :searchlight, versions: ['v1']},
-    { name: :shared_file_systems,                 project: :manila,      microversion: 'v2'}
+    { name: :shared_file_systems,                 project: :manila,      versions: ['v2'],             microversion: 'v2'}
   ]
 
-  # Default REST content type. Use :json or :ruby
-  CONTENT_TYPE = :ruby
-
   # Default Domain ID
   DOMAIN_ID = 'default'
 
-  # Default Interface
-  INTERFACE = 'public'
-
-  # Default log file. Use :log_file option to override
-  LOG_FILE = 'misty.log'
-
-  # Default log level. Use :log_level option to override
-  LOG_LEVEL = Logger::INFO
-
-  # Default Region ID
-  REGION_ID = 'regionOne'
-
-  # Default when uri.scheme is https
-  SSL_VERIFY_MODE = true
-
   def self.json_encode?(data)
     return true if data.is_a?(Array) || data.is_a?(Hash)
     if data.is_a?(String)
@@ -62,6 +48,10 @@ module Misty
     return false
   end
 
+  # Provides list of supported services
+  # ==== Example
+  #     pp Misty.services
+
   def self.services
     services = Misty::Services.new
     SERVICES.each do |service|

data/lib/misty/openstack/cinder/v3.rb

@@ -10,6 +10,14 @@ module Misty
         include Misty::ClientPack
         include Misty::Microversion
 
+        def microversion
+          '3.44'
+        end
+
+        def microversion_header(version)
+          {'X-Openstack-Cinder-API-Version' => "#{version}"}
+        end
+
         def prefix_path_to_ignore
           '/v3/{tenant_id}'
         end

data/lib/misty/openstack/ironic/v1.rb

@@ -10,6 +10,14 @@ module Misty
         include Misty::ClientPack
         include Misty::Microversion
 
+        def microversion
+          '1.32'
+        end
+
+        def microversion_header(version)
+          {'X-Openstack-Ironic-API-Version' => "#{version}"}
+        end
+
         def service_names
           %w{baremetal}
         end

data/lib/misty/openstack/magnum/v1.rb

@@ -10,8 +10,12 @@ module Misty
         include Misty::ClientPack
         include Misty::HTTP::Microversion
 
+        def microversion
+          '1.4'
+        end
+
         def service_names
-          %w{container}
+          %w{container-infrastructure-management container-infrastructure}
         end
       end
     end

data/lib/misty/openstack/manila/v2.rb

@@ -10,6 +10,14 @@ module Misty
         include Misty::ClientPack
         include Misty::Microversion
 
+        def microversion
+          '2.40'
+        end
+
+        def microversion_header(version)
+          {'X-Openstack-Manila-API-Version' => "#{version}"}
+        end
+
         def service_names
           %w{shared-file-systems shared}
         end

data/lib/misty/openstack/nova/v2_1.rb

@@ -20,16 +20,21 @@ module Misty
           http_get("/#{version}", headers)
         end
 
-        def service_names
-            %w{compute}
+        def microversion
+          '2.60'
+        end
+
+        def microversion_header(version)
+          # Use default 'OpenStack-API-Version' or older 'X-Openstack-Nova-API-Version'
+          if @version >= '2.27'
+            super
+          else
+            {'X-Openstack-Nova-API-Version' => "#{version}"}
+          end
         end
 
-        def microversion_header
-          # Versions 2.27+ use default OpenStack-API-Version
-          header = super
-          # For prior vesions then remove once depcrecated
-          header.merge!('X-Openstack-Nova-API-Version' => "#{@version}",)
-          header
+        def service_names
+          %w{compute}
         end
       end
     end