misty 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fc46c4aaf3aee675da268aee2d6273123e21665
-  data.tar.gz: 6ab6bc0feafea0a3199ba619965a56b3ac5889b0
+  metadata.gz: 83575874d30a942a02efcc8c425c0b866a5785c0
+  data.tar.gz: 0f1e48ace0eb01ddce6b877fe6ffb8b1b7ab27dd
 SHA512:
-  metadata.gz: cef0feba471926528c0ebe9280d8069dbae5b713679174292f90a98fc67bef1aa14453d516ab8f4c3be28c30af59237d4c6143896980ac0bc603ae0564007790
-  data.tar.gz: e524b9883eb92d26f9467046c75ead9db06d8dabcfd32f3bb093d79c3e7cf536ccc38fd5f979405f0ab4042ee4e7241a69fb802c490093889520e3a9cb4701e9
+  metadata.gz: 62ba32820ad2cb2614041f8fb7db9dc024ec85bd3508cb8eb3d6796efeb02f8f7d4e5a8235a625bb9ea10368327514c63a5ec904f7318e95a328f5907219f531
+  data.tar.gz: 8af6446a5b734974dbda856e54c629594e2192585e139e1aad9ce92fa64b70724fe19934245bf135bcbf7dc40a338b2858b7af1e0b0f2aed83ea8f87aded20f8

data/README.md

@@ -119,7 +119,7 @@ openstack.compute.requests
 
 ## Setup
 
-### Authentication
+### Authentication information parameter
 The URL and credentials details are necessary to authenticate with the identity server (Keystone).
 
 To provide a Keystone V3, which is the default recommended version:
@@ -142,14 +142,7 @@ auth = {
   :tenant   => "admin",
 }
 ```
-
-### Global options
-Besides the authentication details, the following options which apply for the whole cloud
-
-* :content_type  
-  Format of the body of the successful HTTP responses to be JSON or Ruby structures.  
-  Value is symbol. Allowed value is `:json`.  
-  By default response body are converted to Ruby structures.
+### Logging parameters
 * :log_file  
   File name and path for log file.  
   Value is file path or IO object - Default is `./misty.log`.  
@@ -161,8 +154,28 @@ Besides the authentication details, the following options which apply for the wh
 openstack = Misty::Cloud.new(:auth => auth, :content_type => :ruby, :log_file => STDOUT)
 ```
 
+#### Global parameters
+The following options are applied to each service unless specifically provided for a service.
+
+* :region_id  
+  Type: String  
+  Default: "regionOne"  
+* :interface  
+  Type: String  
+  Allowed values: "public", "internal", "admin"  
+  Default: "public"  
+* :ssl_verify_mode  
+  When using SSL mode (defined by URI scheme => "https://")  
+  Type: Boolean  
+  Default: `true`  
+* :content_type  
+  Format of the body of the successful HTTP responses to be JSON or Ruby structures.  
+  Type: Symbol  
+  Allowed values: `:json`, `:ruby`  
+  Default: `:ruby`
+
 ### Services Options
-Each service can get options specifically:
+Each service can get parameters to be specified.
 
 ```ruby
 openstack = Misty::Cloud.new(:auth => auth, :identity => {}, :compute => {})
@@ -170,30 +183,33 @@ openstack = Misty::Cloud.new(:auth => auth, :identity => {}, :compute => {})
 
 The following options are available:
 * :api_version  
-  The latest supported version is used by default. See Misty.services to use another version.  
-  Value is a STRING  
+  Type: String  
+  Default: The latest supported version - See Misty.services for other versions.  
 * :base_path  
   Allows to force the base path for every URL requests.  
-  Value is a STRING
+  Type: String  
 * :base_url  
   Allows to force the base URL for every requests.  
-  Value is a STRING
+  Type: String  
 * :interface  
   Allows to provide an alternate interface. Allowed values are "public", "internal" or "admin"  
-  Value is a STRING - Default = "public"
+  Type: String  
+  Default: Determined from global value  
 * :region_id  
-  Value is a STRING  
-  Default "regionOne"
+  Type: String  
+  Default: Determined from global value  
 * :service_names  
-  Value is a STRING - Default is defined by Misty.services  
-  Allows to use a difference name for the service. For instance "identity3" for the identity service.
+  Allows to use a difference name for the service. For instance "identity3" for the identity service.  
+  Type: String  
+  Default: Determined from Misty.services  
 * :ssl_verify_mode  
-  Used in SSL mode (detected from the URI)  
-  Value is a BOOLEAN - Default is `true`
+  Type: Boolean  
+  Default: Determined from global value  
 * :version  
   Version to be used when microversion is supported by the service.  
-  Value is a STRING - Default is `"CURRENT"`  
-  Allowed values are "CURRENT", "LATEST", "SUPPORTED", or a version number such as "2.0" or "3"
+  Type: String  
+  Allowed values: "CURRENT", "LATEST", "SUPPORTED", or a version number such as "2.0" or "3"  
+  Default: `"CURRENT"`  
 
 Example:
 ```ruby

data/lib/misty/cloud.rb

@@ -3,7 +3,7 @@ require 'misty/auth/auth_v3'
 
 module Misty
   class Cloud
-    Setup   = Struct.new(:auth, :content_type, :log)
+    Setup   = Struct.new(:auth, :content_type, :log, :interface, :region_id, :ssl_verify_mode)
 
     Options = Struct.new(:alarming, :baremetal, :block_storage, :clustering, :compute, :container, :data_processing,
       :database, :data_protection, :dns, :identity, :image, :messaging, :metering, :network, :object_storage,
@@ -11,27 +11,32 @@ module Misty
 
     attr_reader :services
 
-    def initialize(options = {:auth => {}})
-      @cloud = Setup.new
-      @cloud.auth = Misty::Auth.factory(options[:auth])
-      @cloud.content_type = options[:content_type] ? options[:content_type] : nil
-      @cloud.log = Logger.new(options[:log_file] ? options[:log_file] : Misty::LOG_FILE)
-      @cloud.log.level = options[:log_level] ? options[:log_level] : Misty::LOG_LEVEL
-
+    def initialize(params = {:auth => {}})
+      @setup = self.class.setup(params)
       @options = Options.new
-      Misty.services.each do |service|
-        @options.send("#{service.name}=".to_sym, options[service.name] ? options[service.name] : {})
-      end
+      @services = setup_services(params)
+    end
 
-      @services = setup_services(@options)
+    def self.setup(params)
+      setup = Setup.new
+      setup.auth = Misty::Auth.factory(params[:auth])
+      setup.content_type = params[:content_type] ? params[:content_type] : Misty::CONTENT_TYPE
+      setup.interface = params[:interface] ? params[:interface] : Misty::INTERFACE
+      setup.log = Logger.new(params[:log_file] ? params[:log_file] : Misty::LOG_FILE)
+      setup.log.level = params[:log_level] ? params[:log_level] : Misty::LOG_LEVEL
+      setup.region_id = params[:region_id] ? params[:region_id] : Misty::REGION_ID
+      setup.ssl_verify_mode = params[:ssl_verify_mode] ? params[:ssl_verify_mode] : Misty::SSL_VERIFY_MODE
+      setup
     end
 
-    def setup_services(options)
+    def setup_services(params)
       services = {}
       Misty.services.each do |service|
-        if options[service.name] && options[service.name][:api_version] \
-          && service.versions.include?(options[service.name][:api_version])
-          services.merge!(service.name => {service.project => options[service.name][:api_version]})
+        @options.send("#{service.name}=".to_sym, params[service.name] ? params[service.name] : {})
+
+        if params[service.name] && params[service.name][:api_version] \
+          && service.versions.include?(params[service.name][:api_version])
+          services.merge!(service.name => {service.project => params[service.name][:api_version]})
         else
           # Highest version is used by default!
           services.merge!(service.name => {service.project => service.versions.sort[-1]})
@@ -45,7 +50,7 @@ module Misty
       version = @services[service_name].fetch(project)
       version = self.class.dot_to_underscore(version)
       klass = Object.const_get("Misty::Openstack::#{project.capitalize}::#{version.capitalize}")
-      klass.new(@cloud, @options[service_name])
+      klass.new(@setup, @options[service_name])
     end
 
     def self.dot_to_underscore(val)

data/lib/misty/http/client.rb

@@ -43,10 +43,10 @@ module Misty
       #     :ssl_verify_mode => true
       #   (micro)version: Can be numbered (3.1) or by state (CURRENT, LATEST or SUPPORTED)
       #     :version => "CURRENT"
-      def initialize(cloud, options)
-        @cloud = cloud
+      def initialize(setup, options)
+        @setup = setup
         @options = setup(options)
-        @uri = URI.parse(@cloud.auth.get_endpoint(@options.service_names, @options.region_id, @options.interface))
+        @uri = URI.parse(@setup.auth.get_endpoint(@options.service_names, @options.region_id, @options.interface))
         @base_path = @options.base_path ? @options.base_path : @uri.path
         @base_path = @base_path.chomp("/")
         @http = net_http(@uri)
@@ -70,7 +70,7 @@ module Misty
       end
 
       def headers
-        h = headers_default.merge("X-Auth-Token" => "#{@cloud.auth.get_token}")
+        h = headers_default.merge("X-Auth-Token" => "#{@setup.auth.get_token}")
         h.merge!(microversion_header) if microversion
         h
       end
@@ -83,7 +83,7 @@ module Misty
 
       def net_http(uri)
         http = Net::HTTP.new(uri.host, uri.port)
-        http.set_debug_output($stdout) if @cloud.log.level == Logger::DEBUG
+        http.set_debug_output($stdout) if @setup.log.level == Logger::DEBUG
         if uri.scheme == "https"
           http.use_ssl = true
           http.verify_mode = OpenSSL::SSL::VERIFY_NONE unless @options[:ssl_verify_mode]
@@ -95,14 +95,14 @@ module Misty
         options = Options.new()
         options.base_path       = params[:base_path]       ? params[:base_path] : nil
         options.base_url        = params[:base_url]        ? params[:base_url] : nil
-        options.interface       = params[:interface]       ? params[:interface] : "public"
-        options.region_id       = params[:region_id]       ? params[:region_id] : "regionOne"
+        options.interface       = params[:interface]       ? params[:interface] : @setup.interface
+        options.region_id       = params[:region_id]       ? params[:region_id] : @setup.region_id
         options.service_names   = params[:service_name]    ? self.class.service_names << params[:service_name] : self.class.service_names
-        options.ssl_verify_mode = params[:ssl_verify_mode] ? params[:ssl_verify_mode] : true
+        options.ssl_verify_mode = params[:ssl_verify_mode] ? params[:ssl_verify_mode] : @setup.ssl_verify_mode
         options.version         = params[:version]         ? params[:version] : "CURRENT"
 
         unless INTERFACES.include?(options.interface)
-          raise InvalidDataError, "Options ':interface'must be one of #{INTERFACES}"
+          raise InvalidDataError, "Options ':interface' must be one of #{INTERFACES}"
         end
 
         unless options.ssl_verify_mode == !!options.ssl_verify_mode

data/lib/misty/http/request.rb

@@ -2,7 +2,7 @@ module Misty
   module HTTP
     module Request
       def decode?(response)
-        if @cloud.content_type != :json && response.code =~ /2??/  && !response.is_a?(Net::HTTPNoContent) \
+        if @setup.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")
           true
@@ -16,51 +16,51 @@ module Misty
       end
 
       def http_delete(path, headers)
-        @cloud.log.info(http_to_s(path, headers))
+        @setup.log.info(http_to_s(path, headers))
         request = Net::HTTP::Delete.new(path, headers)
         http(request)
       end
 
       def http_copy(path, headers)
-        @cloud.log.info(http_to_s(path, headers))
+        @setup.log.info(http_to_s(path, headers))
         request = Net::HTTP::Copy.new(path, headers)
         http(request)
       end
 
       def http_get(path, headers)
-        @cloud.log.info(http_to_s(path, headers))
+        @setup.log.info(http_to_s(path, headers))
         request = Net::HTTP::Get.new(path, headers)
         http(request)
       end
 
       def http_head(path, headers)
-        @cloud.log.info(http_to_s(path, headers))
+        @setup.log.info(http_to_s(path, headers))
         request = Net::HTTP::Head.new(path, headers)
         http(request)
       end
 
       def http_options(path, headers)
-        @cloud.log.info(http_to_s(path, headers))
+        @setup.log.info(http_to_s(path, headers))
         request = Net::HTTP::Options.new(path, headers)
         http(request)
       end
 
       def http_patch(path, headers, data)
-        @cloud.log.info(http_to_s(path, headers, data))
+        @setup.log.info(http_to_s(path, headers, data))
         request = Net::HTTP::Patch.new(path, headers)
         request.body = Misty.to_json(data)
         http(request)
       end
 
       def http_post(path, headers, data)
-        @cloud.log.info(http_to_s(path, headers, data))
+        @setup.log.info(http_to_s(path, headers, data))
         request = Net::HTTP::Post.new(path, headers)
         request.body = Misty.to_json(data)
         http(request)
       end
 
       def http_put(path, headers, data)
-        @cloud.log.info(http_to_s(path, headers, data))
+        @setup.log.info(http_to_s(path, headers, data))
         request = Net::HTTP::Put.new(path, headers)
         request.body = Misty.to_json(data)
         http(request)

data/lib/misty/misty.rb

@@ -9,6 +9,20 @@ module Misty
   # Default log level. Use :log_level option to override
   LOG_LEVEL = Logger::INFO
 
+  # Default content type for REST responses
+  # JSON format: :json
+  # Ruby structures: :ruby
+  CONTENT_TYPE = :ruby
+
+  # Default Interface
+  INTERFACE = "public"
+
+  # Default Region ID
+  REGION_ID = "regionOne"
+
+  # Default mode when SSL is used (uri.scheme == "https")
+  SSL_VERIFY_MODE = true
+
   Service = Struct.new(:name, :project, :versions) do
     def to_s
       "#{name}: #{project} => #{versions}"

data/lib/misty/version.rb

@@ -1,3 +1,3 @@
 module Misty
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/test/unit/cloud_test.rb

@@ -51,6 +51,20 @@ describe Misty::Cloud do
     end
   end
 
+  describe "#setup" do
+    it "sets up default values" do
+      Misty::Auth.stub :factory, nil do
+        setup = Misty::Cloud.setup({})
+        setup.must_be_kind_of Struct
+        setup.content_type.must_equal Misty::CONTENT_TYPE
+        setup.log.must_be_kind_of Logger
+        setup.interface.must_equal Misty::INTERFACE
+        setup.region_id.must_equal Misty::REGION_ID
+        setup.ssl_verify_mode.must_equal Misty::SSL_VERIFY_MODE
+      end
+    end
+  end
+
   describe "#new" do
     describe "fails" do
       it "when no credentials" do

data/test/unit/openstack/microversion_test.rb

@@ -31,13 +31,13 @@ describe Misty::HTTP::Microversion do
       "token_id"
     end
 
-    cloud = Misty::Cloud::Setup.new(auth, :ruby, Logger.new('/dev/null'))
+    setup = Misty::Cloud::Setup.new(auth, :ruby, Logger.new('/dev/null'), Misty::INTERFACE, Misty::REGION_ID, Misty::SSL_VERIFY_MODE)
 
     stub_request(:get, "http://localhost/").
       with(:headers => {'Accept'=>'application/json', 'Content-Type'=>'application/json'}).
       to_return(:status => 200, :body => JSON.dump(versions_data), :headers => {})
 
-    Misty::Openstack::Nova::V2_1.new(cloud, {})
+    Misty::Openstack::Nova::V2_1.new(setup, {})
   end
 
   describe "#version_get" do

data/test/unit/service_helper.rb

@@ -15,7 +15,7 @@ def service(content_type = :ruby)
     "token_id"
   end
 
-  setup = Misty::Cloud::Setup.new(auth, content_type, Logger.new('/dev/null'))
+  setup = Misty::Cloud::Setup.new(auth, content_type, Logger.new('/dev/null'), Misty::INTERFACE, Misty::REGION_ID, Misty::SSL_VERIFY_MODE)
 
   stub_request(:get, "http://localhost/").
     with(:headers => request_header).

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: misty
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Gilles Dubreuil
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-08 00:00:00.000000000 Z
+date: 2017-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json