misty 1.4.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec633eb5c336342f8a86380b8c9b624520ac1e2b
-  data.tar.gz: 51a3e89f79256a33c926ed55800135084ab1e0e3
+  metadata.gz: 0c484478917eb09469e637f0b6c4f3ebe46c977b
+  data.tar.gz: c1200a007c58cc7cced9a07fb1e0b4e51e60cc5e
 SHA512:
-  metadata.gz: 0bcb3e7a8b98d4b599700e65d59d89ff83d44fe86c3badee004f6579e4cd3939950c397f042d9c629c92d25ffde06b690a782d4cee803e0886a2861146e2361e
-  data.tar.gz: 5360efb6444ee46248d0f4d7467f90d33bf930985044082b7519e1e57935512feb90dd4039ce3ecc6aed4dffa33c60ed28cc82f826ace38082f0f1948a219dda
+  metadata.gz: e56315c7dcc72fe5d17e616ce48f0363962344d55e0859fb950f3f0641bb3c8cc5a3673fbd6ced7f835fe51bdce76a9c9a3a43ff35e1ced8218147faae87d147
+  data.tar.gz: 34be9722e4a6d4993c749184e0fa7e923ab878ad34a7678612dccba3ca7dc66fd23f0435d658821dbfd47b43292de20f33808bfb299d3dd7a69b7c167ea32058

data/README.md

@@ -1,7 +1,7 @@
 # Introduction
 Misty is a HTTP client for OpenStack APIs, aiming to be slick and dynamic.
 
-Misty handles OpenStack APIs requests as Transparently as possible by:
+Misty handles OpenStack APIs requests as transparently as possible by:
 * Directly submitting request to Openstack Service endpoints
 * Or by using APIs Schema defined functions which are dynamically extracted from OpenStackAPI reference.
 
@@ -13,18 +13,44 @@ Misty handles OpenStack APIs requests as Transparently as possible by:
 * Custom HTTP Methods for special needs
 * And also: Lazy service loading, Low gem dependency (use only Net/HTTP and JSON), Persistent HTTP connections (default since HTTP 1.1 anyway)
 
-### Current Microversion support
-* Cinder
-  v3.44
-* Ironic
-  v1.32
-* Magnum
-  v1.4
-* Manilla
-  v2.40
-* Nova
-  v2.60
+## OpenStack Services
 
+The current list of Openstack services supported, can be obtained from `Misty.services` is:  
+```ruby
+application_catalog: murano, versions: ["v1"]
+alarming: aodh, versions: ["v2"]
+backup: freezer, versions: ["v1"]
+baremetal: ironic, versions: ["v1"], microversion: 1.32
+block_storage: cinder, versions: ["v3", "v2", "v1"], microversion: 3.44
+clustering: senlin, versions: ["v1"]
+compute: nova, versions: ["v2.1"], microversion: 2.60
+container_infrastructure_management: magnum, versions: ["v1"], microversion: 1.4
+container_service: zun, versions: ["v1"]
+data_processing: sahara, versions: ["v1.1"]
+data_protection_orchestration: karbor, versions: ["v1"]
+database: trove, versions: ["v1.0"]
+dns: designate, versions: ["v2"]
+event: panko, versions: ["v2"]
+identity: keystone, versions: ["v3", "v2.0"]
+image: glance, versions: ["v2", "v1"]
+instance_ha: masakari, versions: ["v1.0"]
+key_manager: barbican, versions: ["v1"]
+load_balancer: octavia, versions: ["v2.0"]
+metric: gnocchi, versions: ["v1"]
+messaging: zaqar, versions: ["v2"]
+metering: ceilometer, versions: ["v2"]
+monitoring: monasca, versions: ["v2.0"]
+network: neutron, versions: ["v2.0"]
+nfv_orchestration: tacker, versions: ["v1.0"]
+object_storage: swift, versions: ["v1"]
+orchestration: heat, versions: ["v1"]
+placement: placement, versions: ["v2.1"], microversion: 2.60
+reservation: blazar, versions: ["v1"]
+resource_optimization: watcher, versions: ["v1"]
+search: searchlight, versions: ["v1"]
+shared_file_systems: manila, versions: ["v2"], microversion: 2.40
+workflow: mistral, versions: ["v2"]
+```
 
 # How To
 Fetch and install
@@ -51,10 +77,10 @@ cloud = Misty::Cloud.new(
 
 ```
   servers = cloud.compute.list_servers.body
-  networks = cloud.networking.list_networks
+  networks = cloud.network.list_networks
   first_network_id = networks.body['networks'][0]['id']
-  first_network = cloud.networking.show_network_details(first_network_id)
-  network = Misty.to_json(:network => {:name => 'misty-example'})
+  first_network = cloud.network.show_network_details(first_network_id)
+  network = Misty::Helper.to_json(:network => {:name => 'misty-example'})
   cloud.network.create_network(network)
   v1 = cloud.baremetal.show_v1_api
 ```
@@ -93,7 +119,10 @@ cloud.compute.list_servers
 ```
 
 ### Authentication
-Openstack Identity service Keystone version 3 is the default, version 2.0, although deprecated, is available.
+Openstack Identity service Keystone version 3 is the default, version 2.0, although deprecated, is also available.
+Keystone v3 can handle v2.0 and v3 for authentications and services.
+V3 relies on the concept of domains and projects while V2 credentials use tenant. Authentication are assumed against v3
+unless a tenant is used in the credentials.
 
 #### Parameters
 The following parameters can be used:
@@ -117,11 +146,6 @@ To authenticate with credentials details:
 * `:user_domain` - User domain name
 
 ##### Keystone v3
-Version 3 relies on the concept of domain name or id to authenticates
-
-`Misty::AuthV3` is used by default unless authentication credentials contains a tenant name or id in wich case it
-will use on `Misty::AuthV2`.
-
 The credentials are a combination of "id" and "name" used to uniquely identify projects, users and their domains.
 When using only the name, a domain must be specified to guarantee a unique record from the Identity service.
 
@@ -183,98 +207,73 @@ cloud.identity(:api_version => 'v2.0')
 
 ### Global configuration options
 The configuration parameters used to initialize `Misty::Cloud` are global. They are optionals and Misty::Config
-defaults are applied if needed.
+defaults are applied if not specified.
 
 * `:auth` - Authentication credentials hash containing 'auth_url' and user context. See `Misty::Auth`.
-* `:content_type` - HTTP responses body format. :json or :hash structures. Default is `Misty::Config::CONTENT_TYPE`.
+* `:content_type` - HTTP responses body format. :json or :hash structures. Default is `Misty::Config::CONTENT_TYPE` (`:hash`).
 * `:headers` - Hash of extra HTTP headers to be applied to all services
 * `:interface` - Endpoint interface, allowed values are: "public", "internal", "admin".
 * `:log_file` - Log destination, Value is either file path (./misty.log) or IO object (SDOUT). Default is '/dev/null'
 * `:log_level` - Value is Fixnum - Default is 1 (Logger::INFO) - See Logger from Ruby standard Library
-* `:region_id` - Alternative Region identifier. Default is `Misty::Config::REGION_ID`
-   Default is `Misty::Config::INTERFACE`
-* `:ssl_verify_mode` - Boolean flag for SSL client verification. SSL is defined when URI scheme => "https://".
-   Default is `Misty::Config::SSL_VERIFY_MODE`
+* `:region` - Alternative Region name. Default is `Misty::Config::REGION` (`'regionOne'`)
+   Default is `Misty::Config::INTERFACE` (`'public'`)
+* `:ssl_verify_mode` - Boolean flag for SSL client verification. Applies when URI scheme is SSL ("https://").
+   Default is `Misty::Config::SSL_VERIFY_MODE` (`true`)
    See `Misty::Config` for more details
 
+### Service and Request levels configuration parameters
+The following parameters which are global defined can also be changed at the service level.
+* `:content_type` - Overridden
+* `:headers` - Cumulative
+* `:interface` - Overridden
+* `:region` - Overridden
+
+The following parameters are specific to the service level:
+* `:api_version` - String for specifying Openstack API service version to use. Default is latest supported version.
+* `:base_path` - Allows to force the base path for every URL requests. Default is endpoint's path.
+* `:endpoint` - Overrides service endpoint discovery by providing url.
+* `:service_name` - Provides alternative service name for endpoint discovery.
+  Allowed values: `'latest'`, or a version number such as '2.10'
+
+The following parameters can be changed at a service's request level.
+* `:content_type` - Overridden
+* `:headers` - Cumulative
+* `:version` - Version to be used when microversion is supported by the service. Default: none
+
 ### Headers
-Headers are cumulative, applied from Cloud top level, then at Service level and finally at request level.
+Headers are cumulative when applied at any level, Cloud level, Service level and/or finally at service's request
+level.
 
 HTTP headers can effectively be optionally added to any request.
 An Header object must be created and passed as the last parameter of a request.
 
-For example for an already initialized cloud:
 ```ruby
-header = Misty::HTTP::Header.new(
+container_header = {
   'x-container-meta-web-listings' => false,
   'x-container-meta-quota-count'  => "",
   'x-container-meta-quota-bytes'  => nil,
   'x-versions-location'           => "",
   'x-container-meta-web-index'    => ""
-)
-openstack.object_storage.create_update_or_delete_container_metadata(container_name, header)
-```
-
-### Service and Request levels configuration parameters
-The same parameters used at the global configuration variables can be applied at Service level or at a Request level.
- The global values passed from `Misty::Cloud` level are then overridden at the Service level.
-
-The following parameters can be also used:
-* `:api_version` - String for specifying Openstack API service version to use. Default is latest supported version.
-  Applies only at service level as it's needed for service creation.
-* `:base_path` - Allows to force the base path for every URL requests Default nil.
-* `:base_url` - Allows to force the base URL for every requests. Default nil.
-* `:version` - Version to be used when microversion is supported by the service. Default: `nil`
-  Allowed values: `'latest'`, or a version number such as '2.10'
+}
 
-#### Examples
-Initialize cloud
-```ruby
-cloud = Misty::Cloud.new(:auth => { ... }, region_id => 'regionOne', :log_level => 0)
+cloud = Misty::Cloud.new{:auth { ... }}
+cloud.object_storage.create_update_or_delete_container_metadata(container_name, container_header)
 ```
 
-Then use different options, for example, the identify service, therefore overriding respective global defaults or
-specified values
+### Examples
+Initialize cloud with different options, and for the identify service, override respective global values
 ```ruby
- cloud.identity => {:region_id => 'regionTwo', :interface => 'admin'}
-Provide service specific option
- cloud.compute  => {:version => '2.27'})
-```
-
-## Services
-The latest list of supported service can be obtain from `Misty.services`:
-```
-require 'misty'
-puts Misty.services
-=>
-application_catalog: murano, versions: ["v1"]
-alarming: aodh, versions: ["v2"]
-backup: freezer, versions: ["v1"]
-baremetal: ironic, versions: ["v1"], microversion: v1
-block_storage: cinder, versions: ["v3", "v2", "v1"], microversion: v3
-clustering: senlin, versions: ["v1"]
-compute: nova, versions: ["v2.1"], microversion: v2.1
-container_infrastructure_management: magnum, versions: ["v1"], microversion: v1
-data_processing: sahara, versions: ["v1.1"]
-data_protection_orchestration: karbor, versions: ["v1"]
-database: trove, versions: ["v1.0"]
-dns: designate, versions: ["v2"]
-identity: keystone, versions: ["v3", "v2.0"]
-image: glance, versions: ["v2", "v1"]
-load_balancer: octavia, versions: ["v2.0"]
-messaging: zaqar, versions: ["v2"]
-metering: ceilometer, versions: ["v2"]
-networking: neutron, versions: ["v2.0"]
-nfv_orchestration: tacker, versions: ["v1.0"]
-object_storage: swift, versions: ["v1"]
-orchestration: heat, versions: ["v1"]
-search: searchlight, versions: ["v1"]
-shared_file_systems: manila, versions: ["v2"], microversion: v2
+cloud = Misty::Cloud.new(:auth => { ... }, region_id => 'regionOne', :log_level => 0, {identity => {region_id => 'regionTwo', :interface => 'admin'})
 ```
+ 
+At Request level, provide specific options like the microversion
+ ```ruby
+ cloud.compute(:version => '2.27', :content_type => :json).list_servers
+ ```
 
 ### Service Prefix
 A shorter name can be used to call a service only if it's unique among all services.
-For instance `net` or `network` can be used instead of `networking` because it's not ambiguous.
+For instance `net` or `network` can be used instead of `network` because it's not ambiguous.
 Meanwhile `data` doesn't work because it's ambiguous between `data_processing` and `data_protection_orchestration`
 
 ### Aliases  
@@ -354,7 +353,7 @@ heat_template = {
 require 'misty'
 require 'pp'
 cloud = Misty::Cloud.new(:auth => { ... })
-data_heat_template = Misty.to_json(heat_template)
+data_heat_template = Misty::Helper.to_json(heat_template)
 response = cloud.orchestration.create_stack(data_heat_template)
 id = response.body['stack']['id']
 stack = cloud.orchestration.show_stack_details('test_stack', id)
@@ -381,7 +380,7 @@ pp cloud.compute.versions
 
 ```ruby
 cloud.compute(:version => '2.25')
-data_keypair = Misty.to_json('keypair': {'name': 'admin-keypair'})
+data_keypair = Misty::Helper.to_json('keypair': {'name': 'admin-keypair'})
 admin_keypair = cloud.compute.create_or_import_keypair(data_keypair)
 user_id = admin_keypair.body['keypair']['user_id']
 keypairs = cloud.compute.list_keypairs

data/lib/misty.rb

@@ -3,6 +3,120 @@ require 'net/http'
 require 'time'
 require 'uri'
 require 'misty/misty'
-require 'misty/autoload'
+
+module Misty
+  module Auth
+    module Token
+      autoload :V2, 'misty/auth/token/v2'
+      autoload :V3, 'misty/auth/token/v3'
+    end
+
+    module Catalog
+      autoload :V2, 'misty/auth/catalog/v2'
+      autoload :V3, 'misty/auth/catalog/v3'
+    end
+  end
+
+  module Openstack
+    module API
+      module Aodh
+        autoload :V2, 'misty/openstack/api/aodh/v2'
+      end
+
+      module Ceilometer
+        autoload :V2, 'misty/openstack/api/ceilometer/v2'
+      end
+
+      module Cinder
+        autoload :V1, 'misty/openstack/api/cinder/v1'
+        autoload :V2, 'misty/openstack/api/cinder/v2'
+        autoload :V3, 'misty/openstack/api/cinder/v3'
+      end
+
+      module Designate
+        autoload :V2, 'misty/openstack/api/designate/v2'
+      end
+
+      module Freezer
+        autoload :V1, 'misty/openstack/api/freezer/v1'
+      end
+
+      module Glance
+        autoload :V1, 'misty/openstack/api/glance/v1'
+        autoload :V2, 'misty/openstack/api/glance/v2'
+      end
+
+      module Heat
+        autoload :V1, 'misty/openstack/api/heat/v1'
+      end
+
+      module Ironic
+        autoload :V1, 'misty/openstack/api/ironic/v1'
+      end
+
+      module Karbor
+        autoload :V1, 'misty/openstack/api/karbor/v1'
+      end
+
+      module Keystone
+        autoload :V3,   'misty/openstack/api/keystone/v3'
+        autoload :V2_0, 'misty/openstack/api/keystone/v2_0'
+      end
+
+      module Magnum
+        autoload :V1, 'misty/openstack/api/magnum/v1'
+      end
+
+      module Manila
+        autoload :V2, 'misty/openstack/api/manila/v2'
+      end
+
+      module Murano
+        autoload :V1, 'misty/openstack/api/murano/v1'
+      end
+
+      module Neutron
+        autoload :V2_0, 'misty/openstack/api/neutron/v2_0'
+      end
+
+      module Nova
+        autoload :V2_1, 'misty/openstack/api/nova/v2_1'
+      end
+
+      module Octavia
+        autoload :V2_0, 'misty/openstack/api/octavia/v2_0'
+      end
+
+      module Sahara
+        autoload :V1_1, 'misty/openstack/api/sahara/v1_1'
+      end
+
+      module Searchlight
+        autoload :V1, 'misty/openstack/api/searchlight/v1'
+      end
+
+      module Senlin
+        autoload :V1, 'misty/openstack/api/senlin/v1'
+      end
+
+      module Swift
+        autoload :V1, 'misty/openstack/api/swift/v1'
+      end
+
+      module Tacker
+        autoload :V1_0, 'misty/openstack/api/tacker/v1_0'
+      end
+
+      module Trove
+        autoload :V1_0, 'misty/openstack/api/trove/v1_0'
+      end
+
+      module Zaqar
+        autoload :V2, 'misty/openstack/api/zaqar/v2'
+      end
+    end
+  end
+end
+
 require 'misty/cloud'
 require 'misty/errors'

data/lib/misty/auth/catalog.rb

@@ -0,0 +1,38 @@
+module Misty
+  module Auth
+    module Catalog
+      attr_reader :payload
+
+      def initialize(payload)
+        @payload = payload
+      end
+
+      def get_endpoint_url(names, region, interface)
+        entry = get_service(names)
+        raise ServiceTypeError, 'Endpoint discovery: No service type match' unless entry
+        find_url(entry, region, interface)
+      end
+
+      private
+
+      def get_service(names)
+        @payload.each do |entry|
+          return entry if names.include?(entry['type'])
+        end
+        nil
+      end
+
+      def find_url(service, region, interface)
+        if service['endpoints']
+          service['endpoints'].each do |endpoint|
+            if (url = endpoint_url(endpoint, region, interface))
+              return url
+            end
+          end
+        end
+        raise EndpointError, "No endpoint found: service '#{service['type']}', region '#{region}',
+          interface '#{interface}'"
+      end
+    end
+  end
+end

data/lib/misty/auth/catalog/v2.rb

@@ -0,0 +1,15 @@
+require 'misty/auth/catalog'
+
+module Misty
+  module Auth
+    module Catalog
+      class V2
+        include Misty::Auth::Catalog
+
+        def endpoint_url(endpoint, region, interface)
+          endpoint["#{interface}URL"] if endpoint['region'] == region && endpoint["#{interface}URL"]
+        end
+      end
+    end
+  end
+end

data/lib/misty/auth/catalog/v3.rb

@@ -0,0 +1,15 @@
+require 'misty/auth/catalog'
+
+module Misty
+  module Auth
+    module Catalog
+      class V3
+        include Misty::Auth::Catalog
+
+        def endpoint_url(endpoint, region, interface)
+          endpoint['url'] if endpoint['region'] == region && endpoint['interface'] == interface
+        end
+      end
+    end
+  end
+end