yao 0.13.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6d9322e2d2c8af453bddcb207b1dcdb50c252745712f3d3f1e6f7f416f25da7
-  data.tar.gz: 11831fa1c4752f26306b72a1416767c56dc4eb238d16b9f593d4e9aa62736570
+  metadata.gz: 55df2a0420c42a9448a180f6b0378d82bd8c6fb2d9efac004c152675d357ee3a
+  data.tar.gz: ff5477041bca286e2283ef8130c3659cd4762a8b415dbc374df73ff077dae51a
 SHA512:
-  metadata.gz: 45d0473120a677f5b322dfa9746ce9ba63599f214372f1f7b163c15ad9c73670983ee6cd03cb8d5298c3a426a913fcaa0f616e41b7b2d7d9ed3ba90f3c8a8d9c
-  data.tar.gz: e7773888bb3c9ca1e0baaecc4ca8b58f003a00e254c554fd4a6bc745803a19fc7eeae8c4ea6a03b058a793d8f1289c06a3f867374015a0fabec79996b3d7377e
+  metadata.gz: 75274af855b318f6be285de56b21260f350e5dd892a291b4ef128db9683b9559e06a6284024f555e4123c879530a2b903b3abea29cc08be0c76fe54417638d38
+  data.tar.gz: 66ee630a29f13cd94eb4639fcabc711da46d71f1ff8ff779777b7833a052cf6899b5076f9bac7c25669449fb28a87d4c1d6a63857e5bbeae22bd27280834d84f

data/.github/workflows/rubocop.yml

@@ -0,0 +1,19 @@
+name: rubocop
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Ruby
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 3.0
+    - name: Install dependencies
+      run: |
+        gem install bundler --no-document
+        bundle install
+    - name: Run rubocop
+      run: bundle exec rubocop

data/.github/workflows/ubuntu-rvm.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [ 'ruby-2.7.0' ]
+        ruby: [ 'ruby-3.0.3' ]
     steps:
     - uses: actions/checkout@master
     - name: Set up RVM

data/.github/workflows/ubuntu.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [ '2.6.x', '2.5.x', '2.4.x' ]
+        ruby: [3.0, 2.7, 2.6]
     steps:
     - uses: actions/checkout@master
     - name: Set up Ruby

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  SuggestExtensions: false
+  TargetRubyVersion: 3.0
   DisplayCopNames: true
   DisabledByDefault: true
   Exclude:
@@ -11,7 +12,7 @@ Style/HashSyntax:
 Layout/EmptyLines:
   Enabled: true
 
-Layout/TrailingBlankLines:
+Layout/TrailingEmptyLines:
   Enabled: true
 
 Layout/TrailingWhitespace:
@@ -52,7 +53,3 @@ Style/NumericLiteralPrefix:
 Style/StabbyLambdaParentheses:
   EnforcedStyle: require_parentheses
   Enabled: true
-
-Rails/ActionFilter:
-  EnforcedStyle: action
-  Enabled: true

data/README.md

@@ -34,7 +34,8 @@ Yao.configure do
   # timeout is optional
   timeout     300
 
-  # If your endpoint requires cert & key
+  # If your endpoint requires cacert,cert and key
+  ca_cert "/path/to/my.ca"
   client_cert "/path/to/my.pem"
   client_key "/path/to/my.key"
 

data/lib/yao/auth.rb

@@ -5,19 +5,29 @@ require 'yao/token'
 require 'yao/tokenv3'
 
 module Yao
-  %i(tenant_name username password timeout client_cert client_key region_name
+  %i(tenant_name username password timeout ca_cert client_cert client_key region_name
      identity_api_version user_domain_id user_domain_name project_domain_id project_domain_name).each do |name|
     Yao.config.param name, nil
   end
 
   module Auth
     class << self
+      # @return [Yao::Auth]
       def try_new
         if Yao.config.tenant_name && Yao.config.username && Yao.config.password && Yao.default_client
           Yao::Auth.new
         end
       end
 
+      # @param tenant_name [String]
+      # @param username [String]
+      # @param password [String]
+      # @param default_domain [String]
+      # @param user_domain_id [String]
+      # @param user_domain_name [String]
+      # @param project_domain_id [String]
+      # @param project_domain_name [String]
+      # @return [Hash]
       def build_authv3_info(tenant_name, username, password,
                             default_domain,
                             user_domain_id, user_domain_name,
@@ -55,6 +65,10 @@ module Yao
           }
       end
 
+      # @param tenant_name [String]
+      # @param username [String]
+      # @param password [String]
+      # @return [Hash]
       def build_auth_info(tenant_name, username, password)
           auth_info = {
             auth: {
@@ -68,6 +82,10 @@ module Yao
           auth_info
       end
 
+      # if identity_api_version == "3"
+      # @return [TokenV3]
+      # else
+      # @return [Token]
       def new(
           tenant_name: Yao.config.tenant_name,
           username: Yao.config.username,

data/lib/yao/client.rb

@@ -104,7 +104,7 @@ module Yao
         end
       end
 
-      # @param [String]
+      # @param new_endpoint [String]
       def reset_client(new_endpoint=nil)
         set = ClientSet.new
         endpoint = {
@@ -124,13 +124,17 @@ module Yao
         end
 
         # Client Certificate Authentication
-        if Yao.config.client_cert && Yao.config.client_key
-          cert = OpenSSL::X509::Certificate.new(File.read(Yao.config.client_cert))
-          key  = OpenSSL::PKey.read(File.read(Yao.config.client_key))
-          opt.merge!(ssl: {
-            client_cert: cert,
-            client_key:  key,
-          })
+        if (Yao.config.client_cert && Yao.config.client_key) || Yao.config.ca_cert
+          h = {}
+          if Yao.config.client_cert && Yao.config.client_key
+            cert = OpenSSL::X509::Certificate.new(File.read(Yao.config.client_cert))
+            key  = OpenSSL::PKey.read(File.read(Yao.config.client_key))
+            h[:client_cert] = cert
+            h[:client_key] = key
+          end
+
+          h[:ca_file] = Yao.config.ca_cert if Yao.config.ca_cert
+          opt.merge!(ssl: h)
         end
         opt
       end

data/lib/yao/config.rb

@@ -1,22 +1,30 @@
 module Yao
   class Config
+
+    # @return [Hash]
     def _configuration_defaults
       @_configuration_defaults ||= {}
     end
 
+    # @return [Hash]
     def _configuration_hooks
       @_configuration_hooks ||= {}
     end
 
+    # @return [Array]
     def _configuration_hooks_queue
       @_configuration_hooks_queue ||= []
     end
 
+    # @return [Hash]
     def configuration
       @configuration ||= {}
     end
 
     HOOK_RENEW_CLIENT_KEYS = %i(tenant_name username password auth_url debug debug_record_response)
+
+    # @param v [Boolean]
+    # @return [Array]
     def delay_hook=(v)
       @delay_hook = v
       if !v and !_configuration_hooks_queue.empty?
@@ -33,10 +41,14 @@ module Yao
       end
     end
 
+    # @return [Boolean]
     def delay_hook?
       @delay_hook
     end
 
+    # @param name [String]
+    # @param default [String]
+    # @param hook [Proc]
     def param(name, default, &hook)
       raise("Duplicate definition of #{name}") if self.respond_to?(name)
 
@@ -55,6 +67,9 @@ module Yao
       end
     end
 
+    # @param name [String]
+    # @param value [String]
+    # @return [String]
     def set(name, value)
       raise("Undefined config key #{name}") unless self.respond_to?(name)
       configuration[name.to_sym] = value
@@ -67,6 +82,8 @@ module Yao
     end
   end
 
+  # @param blk [Proc]
+  # @return [Yao::Config]
   def self.config(&blk)
     @__config ||= Config.new
     if blk
@@ -77,6 +94,8 @@ module Yao
     @__config
   end
 
+  # @param blk [Proc]
+  # @return [Yao::Config]
   def self.configure(&blk)
     config(&blk)
   end

data/lib/yao/faraday_middlewares.rb

@@ -64,21 +64,38 @@ class Faraday::Request::ReadOnly
 end
 Faraday::Request.register_middleware read_only: -> { Faraday::Request::ReadOnly }
 
+class Faraday::Request::UserAgent
+  def initialize(app, user_agent=nil)
+    @app = app
+    @user_agent = user_agent || "Yao/#{Yao::VERSION} Faraday/#{Faraday::VERSION}"
+  end
+
+  def call(env)
+    env[:request_headers]['User-Agent'] = @user_agent
+    @app.call(env)
+  end
+end
+Faraday::Request.register_middleware user_agent: -> { Faraday::Request::UserAgent }
+
 class Faraday::Response::OSDumper < Faraday::Response::Middleware
   def on_complete(env)
     require 'pp'
 
-    body = if env.response_headers["content-type"] == "application/json"
+    body = if env.response_headers["content-type"].start_with?("application/json")
              JSON.parse(env.body)
            else
              env.body
            end
+    body = conseal_token_in_body(body)
+
+    request_headers = conseal_token_in_request_headers(env.request_headers.dup)
+    response_headers= conseal_token_in_response_headers(env.response_headers.dup)
 
     params = [
       env.url.to_s,
       body,
-      env.request_headers,
-      env.response_headers,
+      request_headers,
+      response_headers,
       env.method,
       env.status
     ].map(&:pretty_inspect)
@@ -101,6 +118,36 @@ Status Code: %s
 
     FMT
   end
+
+  private
+  def conseal_token_in_body(body)
+    # for keystone v2.0
+    if body.is_a?(Hash) && token = body.dig("access", "token", "id")
+      body["access"]["token"]["id"] = hashed_token(token)
+    end
+    body
+  end
+
+  def conseal_token_in_request_headers(headers)
+    if token = headers["X-Auth-Token"]
+      headers["X-Auth-Token"] = hashed_token(token)
+    end
+    headers
+  end
+
+  def conseal_token_in_response_headers(headers)
+    if token = headers["x-subject-token"]
+      headers["x-subject-token"] = hashed_token(token)
+    end
+    headers
+  end
+
+  def hashed_token(token)
+    require 'openssl'
+
+    # This format was based on openstack client.
+    "{SHA256}" + OpenSSL::Digest::SHA256.hexdigest(token)
+  end
 end
 Faraday::Response.register_middleware os_dumper: -> { Faraday::Response::OSDumper }
 

data/lib/yao/mode.rb

@@ -1,5 +1,7 @@
 module Yao
   module Mode
+    # @param blk [Proc]
+    # @return [String]
     def read_only!(&blk)
       raise unless block_given?
 
@@ -16,6 +18,8 @@ module Yao
       end
     end
 
+    # @param blk [Proc]
+    # @return [String]
     def read_only(&blk)
       raise unless block_given?
 

data/lib/yao/plugins/default_client_generator.rb

@@ -8,6 +8,7 @@ module Yao::Plugins
     def call(f, token)
       f.request :accept, 'application/json'
       f.request :url_encoded
+      f.request :user_agent
 
       if token
         f.request :os_token, token
@@ -19,7 +20,6 @@ module Yao::Plugins
       f.response :json, content_type: /\bjson$/
 
       if Yao.config.debug
-        f.response :logger
         f.response :os_dumper
       end
 

data/lib/yao/plugins/registry.rb

@@ -6,11 +6,12 @@ module Yao::Plugins
   class Registry
     include Singleton
 
+    # @return [Hash]
     def initialize
       @types = {}
     end
 
-    # @type type [Symbol]
+    # @param type [Symbol]
     # @return [Object]
     def [](type)
       @types[type]

data/lib/yao/resources/action.rb

@@ -1,5 +1,9 @@
 module Yao::Resources
   module Action
+
+    # @param id [String]
+    # @param query [Hash]
+    # @return [Hash]
     def action(id, query)
       res = POST(action_path(id)) do |req|
         req.body = query.to_json
@@ -9,6 +13,9 @@ module Yao::Resources
     end
 
     private
+
+    # @param id [String]
+    # @return [String]
     def action_path(id)
       [resources_name, id, "action"].join("/")
     end

data/lib/yao/resources/aggregates.rb

@@ -4,6 +4,7 @@ module Yao::Resources
   class Aggregates < Base
     friendly_attributes :availability_zone, :deleted, :hosts, :metadata, :name
 
+    # @return [Date]
     def deleted_at
       Date.parse(self["deleted_at"]) if self["deleted_at"]
     end

data/lib/yao/resources/base.rb

@@ -3,17 +3,21 @@ require 'time'
 
 module Yao::Resources
   class Base
+
+    # @param name [Array]
     def self.friendly_attributes(*names)
       names.map(&:to_s).each do |name|
         define_method(name) do
           if !@data.key?(name) && id
-            @data = self.class.get(id)
+            @data = self.class.get(id).to_hash
           end
           self[name]
         end
       end
     end
 
+    # @param k_and_v [Hash]
+    # @return [Symbol]
     def self.map_attribute_to_attribute(k_and_v)
       as_json, as_method = *k_and_v.to_a.first.map(&:to_s)
       define_method(as_method) do
@@ -21,14 +25,20 @@ module Yao::Resources
       end
     end
 
+    # @param k_and_v [Hash]
+    # @return [Symbol]
     def self.map_attribute_to_resource(k_and_v)
       _name, klass = *k_and_v.to_a.first
       name = _name.to_s
       define_method(name) do
-        self[[name, klass].join("__")] ||= klass.new(self[name])
+        unless self[name].empty?
+          self[[name, klass].join("__")] ||= klass.new(self[name])
+        end
       end
     end
 
+    # @param k_and_v [Hash]
+    # @return [Symbol]
     def self.map_attribute_to_resources(k_and_v)
       _name, klass = *k_and_v.to_a.first
       name = _name.to_s
@@ -39,28 +49,43 @@ module Yao::Resources
       end
     end
 
+    # @param data_via_json [Hash]
+    # @return [Hash]
     def initialize(data_via_json)
       @data = data_via_json
     end
 
+    # @param name [String]
+    # @return [String]
     def [](name)
       @data[name]
     end
 
+    # @param name [String]
+    # @param value [String]
+    # @return [String]
     def []=(name, value)
       @data[name] = value
     end
 
+    # @return [Hash]
+    def to_hash
+      @data
+    end
+
+    # @return [String]
     def id
       self["id"]
     end
 
+    # @return [Date]
     def created
       if date = self["created"] || self["created_at"]
         Time.parse(date)
       end
     end
 
+    # @return [Date]
     def updated
       if date = self["updated"] || self["updated_at"]
         Time.parse(date)

data/lib/yao/resources/compute_services.rb

@@ -19,6 +19,9 @@ module Yao::Resources
     end
 
     class << self
+      # @param host [String]
+      # @param binary [String]
+      # @return [Yao::Resources::ComputeServices]
       def enable(host, binary)
         params = {
           "host" => host,
@@ -27,6 +30,10 @@ module Yao::Resources
         put("enable", params)
       end
 
+      # @param host [String]
+      # @param binary [String]
+      # @param resason [String]
+      # @return [Yao::Resources::ComputeServices]
       def disable(host, binary, reason = nil)
         params = {
           "host" => host,
@@ -55,4 +62,4 @@ module Yao::Resources
     end
 
   end
-end
+end

data/lib/yao/resources/flavor.rb

@@ -4,6 +4,8 @@ module Yao::Resources
     map_attribute_to_attribute "os-flavor-access:is_public" => :public?
     map_attribute_to_attribute "OS-FLV-DISABLED:disabled"   => :disabled?
 
+    # @param unit [String]
+    # @return [Integer]
     def ram(unit='M')
       case unit
       when 'M'

data/lib/yao/resources/floating_ip.rb

@@ -14,10 +14,12 @@ module Yao::Resources
     self.resource_name  = "floatingip"
     self.resources_name = "floatingips"
 
+    # @return [Yao::Resources::Router]
     def router
       @router ||= Yao::Router.get(router_id)
     end
 
+    # @return [Yao::Resources::Tenant]
     def project
       @project ||= Yao::Tenant.get(project_id)
     end

data/lib/yao/resources/hypervisor.rb

@@ -22,7 +22,7 @@ module Yao::Resources
       self['status'] == 'disabled'
     end
 
-    # @return [Yao::ComputeServices]
+    # @return [Yao::Resources::ComputeServices]
     def service
       Yao::ComputeServices.new(self['service'])
     end

data/lib/yao/resources/image.rb

@@ -5,6 +5,8 @@ module Yao::Resources
     map_attribute_to_attribute minDisk: :min_disk
     map_attribute_to_attribute minRam: :min_ram
 
+    # @param unit [String]
+    # @return [Integer]
     def size(unit=nil)
       size = self["OS-EXT-IMG-SIZE:size"]
       case unit

data/lib/yao/resources/loadbalancer.rb

@@ -6,6 +6,7 @@ module Yao::Resources
     map_attribute_to_resources listeners: LoadBalancerListener
     map_attribute_to_resources pools: LoadBalancerPool
 
+    # @return [Yao::Resources::Tenant]
     def project
       if project_id = self["project_id"]
         Yao::Tenant.find project_id
@@ -13,18 +14,21 @@ module Yao::Resources
     end
     alias :tenant :project
 
+    # @return [Yao::Resources::Network]
     def vip_network
       if vip_network_id = self["vip_network_id"]
         Yao::Network.find vip_network_id
       end
     end
 
+    # @return [Yao::Resources::Port]
     def vip_port
       if vip_port_id = self["vip_port_id"]
         Yao::Port.find vip_port_id
       end
     end
 
+    # @return [Yao::Resources::Subnet]
     def vip_subnet
       if vip_subnet_id = self["vip_subnet_id"]
         Yao::Subnet.find vip_subnet_id

data/lib/yao/resources/loadbalancer_healthmonitor.rb

@@ -7,14 +7,17 @@ module Yao::Resources
 
     map_attribute_to_resources pools: LoadBalancerListener
 
+    # @return [Date]
     def created_at
       Date.parse(self["created_at"])
     end
 
+    # @return [Date]
     def updated_at
       Date.parse(self["updated_at"])
     end
 
+    # @return [Date]
     def project
       if project_id = self["project_id"]
         Yao::Tenant.find project_id

data/lib/yao/resources/loadbalancer_listener.rb

@@ -8,6 +8,7 @@ module Yao::Resources
 
     map_attribute_to_resources loadbalancers: LoadBalancer
 
+    # @return [Yao::Resources::Tenant]
     def project
       if project_id = self["project_id"]
         Yao::Tenant.find project_id
@@ -15,6 +16,7 @@ module Yao::Resources
     end
     alias :tenant :project
 
+    # @return [Yao::Resources::LoadBalancerPool]
     def default_pool
       if default_pool_id = self["default_pool_id"]
         Yao::LoadBalancerPool.find default_pool_id

data/lib/yao/resources/loadbalancer_pool.rb

@@ -7,20 +7,24 @@ module Yao::Resources
     map_attribute_to_resources loadbalancers: LoadBalancer
     map_attribute_to_resources listeners: LoadBalancerListener
 
+    # @return [Date]
     def created_at
       Date.parse(self["created_at"])
     end
 
+    # @return [Date]
     def updated_at
       Date.parse(self["updated_at"])
     end
 
+    # @return [Yao::Resources::LoadBalancerListener]
     def listeners
       self["listeners"].map do |listener|
         Yao::LoadBalancerListener.find listener["id"]
       end
     end
 
+    # @return [Yao::Resources::Tenant]
     def project
       if project_id = self["project_id"]
         Yao::Tenant.find project_id
@@ -28,12 +32,14 @@ module Yao::Resources
     end
     alias :tenant :project
 
+    # @return [Yao::Resources::LoadBalancerListener]
     def members
       self["members"].map do |member|
         Yao::LoadBalancerPoolMember.find(self,member["id"])
       end
     end
 
+    # @return [Yao::Resources::LoadBalancerHealthMonitor]
     def healthmonitor
       if healthmonitor_id = self["healthmonitor_id"]
         Yao::LoadBalancerHealthMonitor.find healthmonitor_id