openstack-router 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0f75a1372ca48807478db771b5cef9e87dcf6692b1d996b83b79a46e1e5e094
-  data.tar.gz: 45c8b6994b400d5f00e812faa71100680dbabb0810284492f84fc77ea0a2d1cf
+  metadata.gz: 19e3a08c2546009535178e3a75d05256ebebaca1b143a58b6d8b6d20a01189b4
+  data.tar.gz: 56796bc95ea48cc1545dbfc451ddbffb8decddbe01553c50d2454d67916bdbd0
 SHA512:
-  metadata.gz: 8bf430ddb4daced99473fea95d448f9da4877810e3ac26d53a88bd6a30d873d1c8aee9220032831c3a1f1a02203b653973a150bb6e1d9a079a703830691901f9
-  data.tar.gz: a9e6948efba2df9bc0106c16cb50d1d2d3f7a4d56d2acb85fd1960fefbb27bb87e76fb6023cb04b6f19c4042e4770bbae6483b0ffc0f67c7b93801fafeedbacd
+  metadata.gz: 465a9722170a66d4c9da527b76f588ecf85f31ab580636ef0ea18e718ea879cb2219aafaf191b3e27cefead826ee5399b80e2d0290425dc23c81512d6e5fdc27
+  data.tar.gz: '0296b148ca61f0954c108f7834b6a4eb5c6b6ce3cbe57640851de9f44e6f07389f8ac0f111ed60130336fcbfe7677bb919d91d4f2c95f0a1f421c6835be917c3'

data/README.md

@@ -18,6 +18,13 @@ created in a roundrobin way, but you don't want instances roundrobin mix with
 volume ones for example, or maybe you need to create several kinds of instances
 with different roundrobin circuits (allowing small servers or big servers to be
 better splattered).
+We can automatically detect the available regions (by using endpoints sorting).
+
+## What we currently don't have
+
+We cannot manage 'admin' or 'internal' interfaces. We only work over 'public'.
+We certainly don't support multiple project users... This will probably fail on
+the catalog detection and stuffs.
 
 ## v1 goal
 

data/lib/openstack-router/catalog.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+module OpenStackRouter
+  # The class responsible to detect the allowed endpoints (= regions) for
+  # connection parameters.
+  #
+  # @since v0.2.0
+  # @author Roland Laurès
+  # @attr_reader [Parameter::Connection] connection_parameters
+  #   The connection parameters.
+  #
+  # @todo finish description of the next attribute.
+  # @attr_reader [Array<String>] endpoints The regions object used to
+  #   manage the by region stuffs.
+  class Catalog
+    attr_reader :connection_parameters
+    attr_reader :endpoints
+
+    def initialize(connection_parameters)
+      unless connection_parameters.class == Parameter::Connection
+        raise ArgumentError, 'Invalid connection parameters. Please use OpenStackRouter::Parameter::Connection'
+      end
+
+      @connection_parameters = connection_parameters
+      @token = Fog::OpenStack::Auth::Token.build(@connection_parameters.to_os_h, {})
+      @endpoints = {}
+      build_endpoints_hierarchy
+    end
+
+    def catalog
+      token.catalog.payload.dup
+    end
+
+    def region_ids(interface = 'public')
+      return [] unless @endpoints.key?(interface)
+
+      @endpoints[interface].keys
+    end
+
+    private
+
+    attr_reader :connection
+    attr_reader :token
+
+    # I want to be able to explore from ('interface') / region_id / service
+    # TODO: It should manage users that can manipulate several project...
+    # I have no instance of OpenStack to create such users. So maybe if someone can.
+    def build_endpoints_hierarchy
+      catalog.each do |service|
+        service_type = service['type']
+        service['endpoints'].each do |service_endpoint|
+          append_endpoint(service_endpoint, service_type)
+        end
+      end
+    end
+
+    def append_endpoint(service_endpoint, service_type)
+      interface = service_endpoint['interface']
+      region_id = service_endpoint['region_id']
+      endpoint_path(interface, region_id, service_type).append(service_endpoint)
+    end
+
+    # create or get and return corresponding endpoint path
+    def endpoint_path(interface, region_id, service_type)
+      ep_interface = @endpoints[interface]
+      if ep_interface.nil?
+        @endpoints[interface] = ep_interface = { region_id => { service_type => [] } }
+      elsif !@endpoints[interface].key?(region_id)
+        ep_interface[region_id] = { service_type => [] }
+      elsif !@endpoints[interface][region_id].key?(service_type)
+        ep_interface[region_id][service_type] = []
+      end
+      ep_interface[region_id][service_type]
+    end
+  end
+end

data/lib/openstack-router/parameter/connection.rb

@@ -8,28 +8,30 @@ module OpenStackRouter
     #
     # @author Roland Laurès
     # @attr_reader [String] auth_url The OpenStack url of the auth system
-    # @attr_reader [String] username The username to use to connect to OpenStack
-    # @attr_reader [String] api_key The api key that you have been given to connect
+    # @attr_reader [String | NilClass] username The username to use to connect to OpenStack
+    #   @note You can have username or userid set as you prefere, but need at least one of them set.
+    # @attr_reader [String | NilClass] userid The user_id that you have been given to connect
     #   to the OpenStack services
-    # @attr_reader [String] tenant The tenant that you have been given to connect
+    #   @note You can have username or userid set as you prefere, but need at least one of them set.
+    # @attr_reader [String] api_key The api key that you have been given to connect
     #   to the OpenStack services
-    # @attr_reader [String] project_id The Project ID that you want to limit your
-    #   actions on the OpenStack services
     # @attr_reader [String | NilClass] region The region on which to connect.
+    # @attr_reader [String | NilClass] project_id The Project ID that you want to limit your
+    #   actions on the OpenStack services
     class Connection
       attr_reader :auth_url
-      attr_reader :username
       attr_reader :api_key
-      attr_reader :tenant
-      attr_reader :tenant_id
+      attr_reader :username
+      attr_reader :userid
       attr_reader :region
+      attr_reader :project_id
 
       # The mandatory options needed to be pass in argument at initialization of that class.
-      MANDATORY_OPTIONS = %i[auth_url username api_key].freeze
+      MANDATORY_OPTIONS = %i[auth_url api_key].freeze
       # Paired mandatory options (means that one of one pair must me present, not the other).
-      PAIRED_MANDATORY_OPTIONS = [%i[tenant tenant_id]].freeze
+      PAIRED_MANDATORY_OPTIONS = [%i[username userid]].freeze
       # The options that are not mandatory for this object.
-      OTHER_OPTIONS = %i[region].freeze
+      OTHER_OPTIONS = %i[region project_id].freeze
       # Constant containing all the available options.
       ALL_OPTIONS = (MANDATORY_OPTIONS + PAIRED_MANDATORY_OPTIONS.flatten + OTHER_OPTIONS).freeze
 
@@ -41,7 +43,7 @@ module OpenStackRouter
 
       # get the corresponding connection parameter hash with openstack_ prefix.
       def to_os_h
-        to_h.map { |key, value| ["openstack_#{key}", value] }.to_h
+        to_h.map { |key, value| ["openstack_#{key}".to_sym, value] }.reject { |a| a.last.nil? }.to_h
       end
 
       # convert the connection parameters to hash
@@ -68,11 +70,11 @@ module OpenStackRouter
       private
 
       attr_writer :auth_url
-      attr_writer :username
       attr_writer :api_key
-      attr_writer :tenant
-      attr_writer :tenant_id
+      attr_writer :username
+      attr_writer :userid
       attr_writer :region
+      attr_writer :project_id
 
       def mandatory_options(cfg)
         missing_keys = []

data/lib/openstack-router/router.rb

@@ -7,6 +7,9 @@ module OpenStackRouter
   # It aims to be the uniq entry point to access all the OpenStack services
   # and all the regions.
   #
+  # @note For now we are using the default endpoint type only: 'public'. We have
+  #   to make the router able to managed parametirized endpoint type ('admin' or so).
+  #
   # @author Roland Laurès
   # @attr_reader [Parameter::Connection] connection_parameters
   #   The connection parameters.
@@ -16,18 +19,19 @@ module OpenStackRouter
     attr_reader :connection_parameters
     attr_reader :regions
 
-    def initialize(connection_parameters, region_names)
+    def initialize(connection_parameters, region_ids = [])
       unless connection_parameters.class == Parameter::Connection
         raise ArgumentError, 'Invalid connection parameters. Please use OpenStackRouter::Parameter::Connection'
       end
 
       @connection_parameters = connection_parameters
-      @regions = region_names.map { |region_name| Region.new(region_name, @connection_parameters) }
       @rr_circuits = {}
+      @catalog = Catalog.new(connection_parameters)
+      @regions = setup_regions(region_ids)
     end
 
     # @return [Array<String>] the region names
-    def region_names
+    def region_ids
       @regions.map(&:name)
     end
 
@@ -42,14 +46,14 @@ module OpenStackRouter
     #   as is.
     #   @see https://github.com/fog/fog-openstack For more information on available services and requests name
     #
-    # @return [Hash] The result of each region, the key being the region_name and the value of the
+    # @return [Hash] The result of each region, the key being the region_id and the value of the
     #   result of Region#request with the given argument.
     #
-    # @yield [region_name, answer] Block called for each region that answers
-    # @yieldparam [String] region_name The name of the region for that answer
+    # @yield [region_id, answer] Block called for each region that answers
+    # @yieldparam [String] region_id The name of the region for that answer
     # @yieldparam [Excon::Response] answer The answer to the request.
     # @yieldreturn ['a] the return of the block is stored in the hash as a value
-    #   to the key that will be the region_name.
+    #   to the key that will be the region_id.
     def request_each(service, request, *request_args)
       # TODO: make the requests to be parallele to no do them sequentialy...
       Hash[@regions.map do |region|
@@ -97,15 +101,15 @@ module OpenStackRouter
     # @return ['a] The result of the selected region, the value of the
     #   result of Region#request with the given argument.
     #
-    # @yield [region_name, answer] Block called over the result of the request.
-    # @yieldparam [String] region_name The name of the region that has been elected to run the request
+    # @yield [region_id, answer] Block called over the result of the request.
+    # @yieldparam [String] region_id The name of the region that has been elected to run the request
     # @yieldparam [Excon::Response] answer The answer to the request.
     # @yieldreturn ['a] the result value of the block is returned by the method itself.
     def rr_request(rr_uuid, service, request, *request_args)
       raise ArgumentError, 'Invalid UUID given' unless @rr_circuits.key?(rr_uuid)
 
       region = rr_next_region(rr_uuid)
-      region.request(service, request, *region.my_args(request_args, region_names)) do |answer|
+      region.request(service, request, *region.my_args(request_args, region_ids)) do |answer|
         next answer unless block_given?
 
         yield(region.name, answer)
@@ -114,6 +118,17 @@ module OpenStackRouter
 
     private
 
+    def setup_regions(region_ids)
+      if region_ids.empty?
+        @catalog.region_ids.map { |region_id| Region.new(region_id, @connection_parameters) }
+      else
+        region_ids.map do |region_id|
+          @catalog.region_ids.include?(region_id) ? Region.new(region_id, @connection_parameters) : nil
+        end
+                  .reject(&:nil?)
+      end
+    end
+
     def rr_next_region(rr_uuid)
       last_idx = @rr_circuits[rr_uuid]
       n_regions = @regions.length

data/lib/openstack-router/version.rb

@@ -2,5 +2,5 @@
 
 module OpenStackRouter
   # The version number of this library
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'
 end

data/lib/openstack_router.rb

@@ -9,4 +9,5 @@ end
 require_relative 'openstack-router/version'
 require_relative 'openstack-router/parameter/connection'
 require_relative 'openstack-router/region'
+require_relative 'openstack-router/catalog'
 require_relative 'openstack-router/router'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstack-router
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Roland Laurès
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-15 00:00:00.000000000 Z
+date: 2019-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-openstack
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -144,6 +158,7 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- lib/openstack-router/catalog.rb
 - lib/openstack-router/parameter/connection.rb
 - lib/openstack-router/region.rb
 - lib/openstack-router/router.rb