misty 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5dc7dd3f594f1b57498eb00f5ec84950d93f1a7f
-  data.tar.gz: 55db4993251e461c1a0ff34c71b88b4cbc84d475
+  metadata.gz: ffe75b3968e66e94826272e86f37008a8f8588c5
+  data.tar.gz: 1d22179b70ec1d3f0defcad2eccd8f375ccd27bc
 SHA512:
-  metadata.gz: 25e78f721473b692864310a5adb8a0b59a46a92e704414532647495372711487397f75cedfa0020943624d185dad98985bb25a9be47aeb55e197ebbba1f758ba
-  data.tar.gz: a387e6ba5f95e5c284a1bf9f1b6259d8703ae2e6d019ed2643bf95a5746d9594d70ee6047964e0b279a12ac1c4a2e8465fa67680f0cef182595044a7764566ad
+  metadata.gz: 1a35311aff1b3149a027ecc54843791b350d0c67da4551e0f589c601c5d186721e02754a3b1bcf690964d546c57212f7c9e8cdd30548c142cad7ccd39c5e4274
+  data.tar.gz: d5f88faf9a3076df2ddd3f2569b01d9885425d866e2c572069497de6167d782d54af995256b221235eb87c8fdf439060cd02cbdc0d2b053fc0a05cd7d9682040

data/lib/misty/auth.rb

@@ -1,17 +1,9 @@
-require 'misty/http/net_http'
+require 'misty/auth/errors'
 require 'misty/auth/name'
+require 'misty/http/net_http'
 
 module Misty
-  class Auth
-    class AuthenticationError < StandardError; end
-    class CatalogError        < StandardError; end
-    class TokenError          < StandardError; end
-
-    class ExpiryError      < RuntimeError; end
-    class CredentialsError < RuntimeError; end
-    class InitError        < RuntimeError; end
-    class URLError         < RuntimeError; end
-
+  module Auth
     include Misty::HTTP::NetHTTP
 
     attr_reader :catalog, :token
@@ -41,7 +33,7 @@ module Misty
       Misty::HTTP::NetHTTP.http_request(
         @uri, ssl_verify_mode: @config.ssl_verify_mode, log: @config.log
       ) do |connection|
-        response = connection.post(self.class.path, @credentials.to_json,
+        response = connection.post(path, @credentials.to_json,
           { 'Content-Type' => 'application/json', 'Accept' => 'application/json' })
         unless response.code =~ /200|201/
           raise AuthenticationError, "Response code=#{response.code}, Msg=#{response.msg}"
@@ -76,7 +68,7 @@ module Misty
     def find_url(service, region_id, interface)
       if service['endpoints']
         service['endpoints'].each do |endpoint|
-          if (url = self.class.get_url(endpoint, region_id, interface))
+          if (url = endpoint_url(endpoint, region_id, interface))
             return url
           end
         end

data/lib/misty/auth/auth_v2.rb

@@ -1,21 +1,15 @@
 require 'misty/auth'
 
 module Misty
-  class AuthV2 < Misty::Auth
-    def self.path
-      '/v2.0/tokens'
-    end
-
-    def self.get_url(endpoint, region_id, interface)
-      return endpoint["#{interface}URL"] if endpoint['region'] == region_id && endpoint["#{interface}URL"]
-    end
+  class AuthV2
+    include Misty::Auth
 
     def credentials
       if @token
         identity = { 'token': { 'id': @token } }
       else
-        raise Misty::Auth::CredentialsError, "#{self.class}: User name is required" if @user.name.nil?
-        raise Misty::Auth::CredentialsError, "#{self.class}: User password is required" if @user.password.nil?
+        raise CredentialsError, "#{self.class}: User name is required" if @user.name.nil?
+        raise CredentialsError, "#{self.class}: User password is required" if @user.password.nil?
         identity = { 'passwordCredentials': user_credentials }
       end
 
@@ -24,12 +18,20 @@ module Misty
       elsif @tenant.name
         identity.merge!('tenantName': @tenant.name)
       else
-        raise Misty::Auth::CredentialsError, "#{self.class}: No tenant available"
+        raise CredentialsError, "#{self.class}: No tenant available"
       end
 
       { 'auth': identity }
     end
 
+    def endpoint_url(endpoint, region_id, interface)
+      return endpoint["#{interface}URL"] if endpoint['region'] == region_id && endpoint["#{interface}URL"]
+    end
+
+    def path
+      '/v2.0/tokens'
+    end
+
     def user_credentials
       {
         'username': @user.name,

data/lib/misty/auth/auth_v3.rb

@@ -1,14 +1,8 @@
 require 'misty/auth'
 
 module Misty
-  class AuthV3 < Misty::Auth
-    def self.path
-      '/v3/auth/tokens'
-    end
-
-    def self.get_url(endpoint, region_id, interface)
-      return endpoint['url'] if endpoint['region_id'] == region_id && endpoint['interface'] == interface
-    end
+  class AuthV3
+    include Misty::Auth
 
     def credentials
       if @token
@@ -30,10 +24,18 @@ module Misty
       }
     end
 
+    def endpoint_url(endpoint, region_id, interface)
+      return endpoint['url'] if endpoint['region_id'] == region_id && endpoint['interface'] == interface
+    end
+
+    def path
+      '/v3/auth/tokens'
+    end
+
     def scope
       return @project.identity if @project
       return @domain.identity if @domain
-      raise Misty::Auth::CredentialsError, "#{self.class}: No scope available"
+      raise CredentialsError, "#{self.class}: No scope available"
     end
 
     def set(response)

data/lib/misty/auth/errors.rb

@@ -0,0 +1,12 @@
+module Misty
+  module Auth
+    class AuthenticationError < StandardError; end
+    class CatalogError        < StandardError; end
+    class TokenError          < StandardError; end
+
+    class ExpiryError      < RuntimeError; end
+    class CredentialsError < RuntimeError; end
+    class InitError        < RuntimeError; end
+    class URLError         < RuntimeError; end
+  end
+end

data/lib/misty/auth/name.rb

@@ -1,5 +1,5 @@
 module Misty
-  class Auth
+  module Auth
     module Domain
       attr_accessor :domain
 
@@ -11,7 +11,7 @@ module Misty
           data.merge!(to_h(:name))
           data.merge!({ :domain => @domain.identity })
         else
-          raise Misty::Auth::CredentialsError, "#{self.class}: An Id, or a name with its domain, must be provided"
+          raise CredentialsError, "#{self.class}: An Id, or a name with its domain, must be provided"
         end
         data
       end
@@ -21,7 +21,7 @@ module Misty
       def identity
         return to_h(:id) unless id.nil?
         return to_h(:name) unless name.nil?
-        raise Misty::Auth::CredentialsError, "#{self.class}: No available id or name"
+        raise CredentialsError, "#{self.class}: No available id or name"
       end
 
       def to_h(var)
@@ -50,7 +50,7 @@ module Misty
 
       def identity
         data = super
-        raise Misty::Auth::CredentialsError, "#{self.class}: No password available" if password.nil?
+        raise CredentialsError, "#{self.class}: No password available" if password.nil?
         data.merge!(to_h(:password))
         { :user => data }
       end

data/lib/misty/client.rb

@@ -0,0 +1,105 @@
+module Misty
+  module Client
+    class Options
+      attr_accessor :base_path, :base_url, :headers, :interface, :region_id,
+                    :service_names, :ssl_verify_mode, :version
+    end
+
+    class InvalidDataError < StandardError; end
+
+    INTERFACES = %w{admin public internal}
+
+    attr_reader :headers, :microversion
+
+    # Options - Values shown are the default
+    #   Base path can be forced (Not recommended, mainly used for test purposes)
+    #    :base_path => nil
+    #   URL can be forced (Helps when setup is broken)
+    #    :base_url => nil
+    #   Optional headers
+    #    :headers => {}
+    #   Endpoint type (admin, public or internal)
+    #    :interface => "public"
+    #   Region ID
+    #    :region_id => "regionOne"
+    #   Service name
+    #    The Service names are pre defined but more can be added using this option.
+    #    :service_name
+    #   SSL Verify Mode
+    #    :ssl_verify_mode => true
+    #   (micro)version: Can be numbered (3.1) or by state (CURRENT, LATEST or SUPPORTED)
+    #     :version => "CURRENT"
+    def initialize(auth, config, options = {})
+      @auth = auth
+      @config = config
+      @options = setup(options)
+      @uri = URI.parse(@auth.get_url(@options.service_names, @options.region_id, @options.interface))
+      @base_path = @options.base_path ? @options.base_path : @uri.path
+      @base_path = @base_path.chomp('/')
+      @version = nil
+      @microversion = false
+      @headers = Misty::HTTP::Header.new(@config.headers.get.clone)
+      @headers.add('X-Auth-Token' => @auth.get_token.to_s)
+      @headers.add(microversion_header) if microversion
+      @headers.add(@options.headers) unless @options.headers.empty?
+    end
+
+    # Mixing classes to override
+    # When a catalog provides a base path and the Service API definition containts the generic equivalent as prefix
+    # then the preifx is redundant and must be removed from the path.
+    # For example:
+    # Catalog provides 'http://192.0.2.21:8004/v1/48985e6b8da145699d411f12a3459fca'
+    # and Service API has '/v1/{tenant_id}/stacks'
+    # then the path prefix is ignored and path is only '/stacks'
+    def prefix_path_to_ignore
+      ''
+    end
+
+    def requests
+      requests_api + requests_custom
+    end
+
+    private
+
+    def baseclass
+      self.class.to_s.split('::')[-1]
+    end
+
+    def requests_api
+      @requests_api_list ||= begin
+        list = []
+        api.each do |_path, verbs|
+          verbs.each do |_verb, requests|
+            list << requests
+          end
+        end
+        list.flatten!
+      end
+    end
+
+    def requests_custom
+      []
+    end
+
+    def setup(params)
+      options = Options.new()
+      options.base_path           = params[:base_path]       ? params[:base_path] : nil
+      options.base_url            = params[:base_url]        ? params[:base_url] : nil
+      options.headers             = params[:headers]         ? params[:headers] : {}
+      options.interface           = params[:interface]       ? params[:interface] : @config.interface
+      options.region_id           = params[:region_id]       ? params[:region_id] : @config.region_id
+      options.service_names       = params[:service_name]    ? service_names << params[:service_name] : service_names
+      options.ssl_verify_mode     = params[:ssl_verify_mode].nil? ? @config.ssl_verify_mode : params[:ssl_verify_mode]
+      options.version             = params[:version]         ? params[:version] : 'CURRENT'
+
+      unless INTERFACES.include?(options.interface)
+        raise InvalidDataError, "Options ':interface' must be one of #{INTERFACES}"
+      end
+
+      unless options.ssl_verify_mode == !!options.ssl_verify_mode
+        raise InvalidDataError, "Options ':ssl_verify_mode' must be a boolean"
+      end
+      options
+    end
+  end
+end

data/lib/misty/client_pack.rb

@@ -0,0 +1,16 @@
+require 'misty/client'
+require 'misty/http/net_http'
+require 'misty/http/method_builder'
+require 'misty/http/request'
+require 'misty/http/direct'
+require 'misty/http/header'
+
+module Misty
+  module ClientPack
+    include Misty::Client
+    include Misty::HTTP::NetHTTP
+    include Misty::HTTP::MethodBuilder
+    include Misty::HTTP::Request
+    include Misty::HTTP::Direct
+  end
+end

data/lib/misty/http/method_builder.rb

@@ -11,9 +11,22 @@ module Misty
 
       private
 
+      def process_data(header, args)
+        if args.size == 1 && Misty.json_encode?(args[0])
+          header.add('Content-Type' => 'application/json')
+          return Misty.to_json(args[0])
+        elsif args.size == 1
+          return args[0]
+        end
+      end
+
       def method_call(method, *args)
-        header = @headers.get.clone
-        header.merge!(args.pop.get) if args[-1].class == Misty::HTTP::Header
+        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)
@@ -24,23 +37,26 @@ module Misty
 
         case method[:request]
         when :COPY
-          http_copy(final_path, header)
+          http_copy(final_path, header.get)
         when :DELETE
-          http_delete(final_path, header)
+          http_delete(final_path, header.get)
         when :GET
-          final_path << query_param(args_left[0]) if args_left && args_left.size == 1
-          http_get(final_path, header)
+          final_path << query_param(args_left.shift) if args_left && args_left.size == 1
+          http_get(final_path, header.get)
         when :HEAD
-          http_head(final_path, header)
+          http_head(final_path, header.get)
         when :POST
-          data = args_left[0] if args_left && args_left.size == 1
-          http_post(final_path, header, data)
+          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)
         when :PUT
-          data = args_left[0] if args_left && args_left.size == 1
-          http_put(final_path, header, data)
+          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)
         when :PATCH
-          data = args_left[0] if args_left && args_left.size == 1
-          http_patch(final_path, header, data)
+          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)
         else
           raise SyntaxError, "Invalid HTTP request: #{method[:request]}"
         end
@@ -58,10 +74,10 @@ module Misty
       end
 
       def get_method(name)
-        self.class.api.each do |path, requests|
-          requests.each do |request, methods_list|
-            if methods_list.include?(name)
-              return {:path => path, :request => request, :name => name}
+        api.each do |path, verbs_list|
+          verbs_list.each do |verb, methods|
+            if methods.include?(name)
+              return {:path => path, :request => verb, :name => name}
             end
           end
         end
@@ -77,9 +93,9 @@ module Misty
       end
 
       def prefixed_path(path)
-        unless self.class.prefix_path_to_ignore.empty?
-          if path =~ %r{#{self.class.prefix_path_to_ignore}}
-            return true, path.gsub(self.class.prefix_path_to_ignore, '')
+        unless prefix_path_to_ignore.empty?
+          if path =~ %r{#{prefix_path_to_ignore}}
+            return true, path.gsub(prefix_path_to_ignore, '')
           else
             return false, path
           end

data/lib/misty/misty.rb

@@ -48,6 +48,20 @@ module Misty
   # 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)
+      begin
+        JSON.parse(data)
+      rescue JSON::ParserError
+        return false
+      else
+        return true
+      end
+    end
+    return false
+  end
+
   def self.services
     services = Misty::Services.new
     SERVICES.each do |service|

data/lib/misty/openstack/aodh/aodh_v2.rb

@@ -1,5 +1,5 @@
 module Misty::Openstack::AodhV2
-  def v2
+  def api
 {"/v2/capabilities"=>{:GET=>[:list_capabilities]},
  "/v2/alarms"=>{:GET=>[:list_alarms], :POST=>[:create_alarm]},
  "/v2/alarms/{alarm_id}"=>

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

@@ -1,17 +1,14 @@
-require 'misty/http/client'
 require 'misty/openstack/aodh/aodh_v2'
+require 'misty/client_pack'
 
 module Misty
   module Openstack
     module Aodh
-      class V2 < Misty::HTTP::Client
-        extend Misty::Openstack::AodhV2
+      class V2
+        include Misty::Openstack::AodhV2
+        include Misty::ClientPack
 
-        def self.api
-          v2
-        end
-
-        def self.service_names
+        def service_names
           %w{alarming}
         end
       end