yao 0.13.4 → 0.14.0

data/lib/yao/resources/metadata_available.rb

@@ -1,9 +1,14 @@
 module Yao::Resources
   module MetadataAvailable
+    # @param id [String]
+    # @return [Hash]
     def list_metadata(id)
       GET(metadata_path(id)).body["metadata"]
     end
 
+    # @param id [String]
+    # @param metadata [Hash]
+    # @return [Hash]
     def create_metadata(id, metadata)
       res = POST(metadata_path(id)) do |req|
         req.body = {"metadata" => metadata}.to_json
@@ -13,6 +18,9 @@ module Yao::Resources
     end
     alias append_metadata create_metadata
 
+    # @param id [String]
+    # @param metadata [Hash]
+    # @return [Hash]
     def update_metadata(id, metadata)
       res = PUT(metadata_path(id)) do |req|
         req.body = {"metadata" => metadata}.to_json
@@ -22,10 +30,17 @@ module Yao::Resources
     end
     alias replace_metadata update_metadata
 
+    # @param id [String]
+    # @param key [String]
+    # @return [Hash]
     def get_metadata(id, key)
       GET(metadata_key_path(id, key)).body["meta"]
     end
 
+    # @param id [String]
+    # @param key [String]
+    # @param value [String]
+    # @return [Hash]
     def set_metadata(id, key, value)
       res = PUT(metadata_key_path(id, key)) do |req|
         req.body = {"meta" => {key => value}}.to_json
@@ -34,15 +49,21 @@ module Yao::Resources
       res.body["meta"]
     end
 
+    # @param id [String]
+    # @param key [String]
     def delete_metadata(id, key)
       DELETE(metadata_key_path(id, key)).body
     end
 
     private
+    # @param id [String]
+    # @return [String]
     def metadata_path(id)
       ["servers", id, "metadata"].join("/")
     end
 
+    # @param id [String]
+    # @param key [String]
     def metadata_key_path(id, key)
       ["servers", id, "metadata", key].join("/")
     end

data/lib/yao/resources/meter.rb

@@ -5,14 +5,17 @@ module Yao::Resources
 
     friendly_attributes :meter_id, :name, :user_id, :resource_id, :source, :type, :unit
 
+    # @return [String]
     def id
       meter_id
     end
 
+    # @return [Yao::Resources::Resource]
     def resource
       @resource ||= Yao::Resource.get(resource_id)
     end
 
+    # @return [Yao::Resources::User]
     def user
       @user ||= Yao::User.get(user_id)
     end
@@ -23,12 +26,16 @@ module Yao::Resources
 
     class << self
       private
+
+      # override Yao::Resources::RestfullyAccessible.resource_from_json
+      # @param json [Hash]
+      # @return [Yao::Resources::Meter]
       def resource_from_json(json)
         new(json)
       end
 
       # override Yao::Resources::RestfullyAccessible.resources_from_json
-      # @param [Array]
+      # @param json [Array<Hash>]
       # @return [Array<Yao::Resources::Meter>]
       def resources_from_json(json)
         json.map{|d| new(d)}

data/lib/yao/resources/network.rb

@@ -13,6 +13,7 @@ module Yao::Resources
     self.resource_name  = "network"
     self.resources_name = "networks"
 
+    # @return [Array<Yao::Resources::Port>]
     def ports
       @ports ||= Yao::Port.list(network_id: id)
     end

data/lib/yao/resources/network_associationable.rb

@@ -6,6 +6,7 @@ module Yao
         base.friendly_attributes :network_id
       end
 
+      # @return [Yao::Resources::Network]
       def network
         @tenant ||= Yao::Network.find(network_id)
       end

data/lib/yao/resources/old_sample.rb

@@ -6,19 +6,23 @@ module Yao::Resources
                         :message_id, :resource_id, :timestamp, :resource_metadata, :user_id,
                         :source
 
+    # @return [Date]
     def recorded_at
       Time.parse(self["recorded_at"] || self["timestamp"])
     end
     alias timestamp recorded_at
 
+    # @return [String]
     def id
       message_id
     end
 
+    # @return [Yao::Resources::Resource]
     def resource
       @resource ||= Yao::Resource.get(resource_id)
     end
 
+    # @return [Yao::Resources::User]
     def user
       @user ||= Yao::User.get(user_id)
     end

data/lib/yao/resources/port.rb

@@ -9,10 +9,12 @@ module Yao::Resources
                         :admin_state_up
     map_attribute_to_attribute "binding:host_id" => :host_id
 
+    # @return [String]
     def primary_ip
       fixed_ips.first["ip_address"]
     end
 
+    # @return [Yao::Resources::Subnet]
     def primary_subnet
       @subnet ||= Yao::Subnet.find fixed_ips.first["subnet_id"]
     end

data/lib/yao/resources/port_associationable.rb

@@ -6,6 +6,7 @@ module Yao
         base.friendly_attributes :port_id
       end
 
+      # @return [Yao::Resources::Port]
       def port
         @port ||= Yao::Port.find(port_id)
       end

data/lib/yao/resources/project.rb

@@ -1,5 +1,7 @@
 module Yao::Resources
   class Project < Base
+    include ServerUsageAssociationable
+
     friendly_attributes :id, :name, :description, :enabled, :parent_id, :domain_id
     alias :enabled? :enabled
 
@@ -8,19 +10,23 @@ module Yao::Resources
     self.resources_name = "projects"
     self.admin          = true
 
+    # @return [Bool]
     def domain?
       @data["is_domain"]
     end
 
+    # @return [Array<Yao::Resources::Server>]
     def servers
       @servers ||= Yao::Server.list(all_tenants: 1, project_id: id)
     end
 
+    # @return [Yao::Resources::Port]
     def ports
       @ports ||= Yao::Port.list(tenant_id: id)
     end
 
     class << self
+
       def accessible
         as_member { self.list }
       end

data/lib/yao/resources/resource.rb

@@ -8,28 +8,34 @@ module Yao::Resources
                         :metadata,
                         :links
 
+    # @return [String]
     def id
       resource_id
     end
 
+    # @return [Yao::User]
     def user
       @user ||= Yao::User.get(user_id)
     end
 
+    # @return [Date]
     def last_sampled_at
       Time.parse last_sample_timestamp
     end
 
+    # @return [Date]
     def first_sampled_at
       Time.parse first_sample_timestamp
     end
 
+    # @return [Array<Yao::Sample>]
     def get_meter(name)
       if link = links.find{|l| l["rel"] == name }
         Yao::Sample.list(link["href"])
       end
     end
 
+    # @return [Hash]
     def meters
       links.map{|l| l["rel"] }.delete_if{|n| n == 'self' }
     end
@@ -42,14 +48,14 @@ module Yao::Resources
       private
 
       # override Yao::Resources::RestfullyAccessible.resource_from_json
-      # @param [Hash]
+      # @param json [Hash]
       # @return [Yao::Resources::Resource]
       def resource_from_json(json)
         new(json)
       end
 
       # override Yao::Resources::RestfullyAccessible.resources_from_json
-      # @param [Hash]
+      # @param json [Hash]
       # @return [Yao::Resources::Resource]
       def resources_from_json(json)
         new(json)

data/lib/yao/resources/restfully_accessible.rb

@@ -15,41 +15,55 @@ module Yao::Resources
       end
     end
 
+    # @param name [String]
+    # @return
     def service=(name)
       @service = name
     end
     attr_reader :service
 
+    # @return [String]
     def api_version
       @api_version || ''
     end
 
+    # @param v [String]
+    # @return [String]
     def api_version=(v)
       raise("Set api_version after service is declared") unless service
       @api_version = v
       api_version
     end
 
+    # @param bool [Boolean]
+    # @return [Boolean]
     def admin=(bool)
       @admin = bool
     end
 
+    # @return [Boolean]
     def return_single_on_querying
       @return_single_on_querying
     end
 
+    # @param bool [Boolean]
+    # @return [Boolean]
     def return_single_on_querying=(bool)
       @return_single_on_querying = bool
     end
 
+    # @return [String]
     def resources_path
       @resources_path || resources_name
     end
 
+    # @param path [String]
+    # @return [String]
     def resources_path=(path)
       @resources_path = path.sub(%r!^\/!, "")
     end
 
+    # @return [Faraday::Connection]
     def client
       if @admin
         Yao.default_client.admin_pool[service]
@@ -58,6 +72,7 @@ module Yao::Resources
       end or raise "You do not have #{@admin ? 'admin' : 'public'} access to the #{service} service"
     end
 
+    # @param blk [Proc]
     def as_member(&blk)
       if @admin
         @admin = false

data/lib/yao/resources/role.rb

@@ -47,8 +47,8 @@ module Yao::Resources
       end
 
       # @param role_name [String]
-      # @param to: [String]
-      # @param on: [String]
+      # @param to [String]
+      # @param on [String]
       # @return [Faraday::Response]
       def grant(role_name, to:, on:)
         role   = Yao::Role.get(role_name)
@@ -64,8 +64,8 @@ module Yao::Resources
       end
 
       # @param role_name [String]
-      # @param from: [String]
-      # @param on: [String]
+      # @param from [String]
+      # @param on [String]
       # @return [Faraday::Response]
       def revoke(role_name, from:, on:)
         role   = Yao::Role.get(role_name)
@@ -88,6 +88,8 @@ module Yao::Resources
         client.url_prefix.to_s =~ /v2\.0/
       end
 
+      # @param tenant [String]
+      # @param user [String]
       def path_for_role_resource(tenant, user, role = nil)
         if api_version_v2?
           paths = ["tenants", tenant.id, "users", user.id, "roles"]

data/lib/yao/resources/role_assignment.rb

@@ -8,6 +8,7 @@ module Yao::Resources
     self.api_version    = "v3"
     self.client.url_prefix = Yao.config.auth_url.gsub(/v2.0|v3/, '')
 
+    # @return [Yao::Resources::Tenant]
     def project
       @project ||= Yao::Tenant.get(scope["project"]["id"])
     end

data/lib/yao/resources/router.rb

@@ -10,19 +10,28 @@ module Yao::Resources
     self.resource_name  = 'router'
     self.resources_name = 'routers'
 
+    # @return [Array<Yao::Resources::Port>]
     def interfaces
       Yao::Port.list(device_id: id)
     end
 
     class << self
+      # @param id [String]
+      # @param param [Hash]
+      # @return [Hash]
       def add_interface(id, param)
         PUT(['routers', id, 'add_router_interface.json'].join('/'), param.to_json)
       end
 
+      # @param id [String]
+      # @param param [Hash]
+      # @return [Hash]
       def remove_interface(id, param)
         PUT(['routers', id, 'remove_router_interface.json'].join('/'), param.to_json)
       end
 
+      # @param name [String]
+      # @return [Array<Yao::Resources::Router>]
       def get_by_name(name)
         self.list(name: name)
       end

data/lib/yao/resources/sample.rb

@@ -4,18 +4,22 @@ module Yao::Resources
                         :source, :type, :unit, :volume,
                         :resource_id, :user_id
 
+    # @return [Date]
     def recorded_at
       Time.parse(self["recorded_at"])
     end
 
+    # @return [Date]
     def timestamp
       Time.parse(self["timestamp"])
     end
 
+    # @return [Yao::Resources::Resource]
     def resource
       @resource ||= Yao::Resource.get(resource_id)
     end
 
+    # @return [Yao::Resources::User]
     def user
       @user ||= Yao::User.get(user_id)
     end

data/lib/yao/resources/security_group.rb

@@ -5,6 +5,7 @@ module Yao::Resources
 
     friendly_attributes :name, :description
 
+    # @return [Array<Yao::Resources::SecurityGroupRule>]
     def rules
       self[["rules", SecurityGroupRule].join("__")] ||= (case self.class.service
       when "compute"

data/lib/yao/resources/security_group_rule.rb

@@ -3,6 +3,8 @@ module Yao::Resources
   class SecurityGroupRule < Base
     friendly_attributes :ethertype
 
+    # @param _name [Symbol]
+    # @param _guard_name [Symbol]
     def self.define_attribute_with_guard(_name, _guard_name)
       name = _name.to_s
       guard_name = _guard_name.to_s
@@ -16,10 +18,15 @@ module Yao::Resources
     define_attribute_with_guard :protocol, :ip_protocol
     define_attribute_with_guard :security_group_id, :parent_group_id
 
+    # @return [Yao::Resources::SecurityGroup]
     def security_group
       SecurityGroup.find(security_group_id)
     end
 
+    # if port_range_max == port_range_min
+    # @return [Integer]
+    # else
+    # @return [Range]
     def port
       if port_range_max == port_range_min
         port_range_max
@@ -28,6 +35,7 @@ module Yao::Resources
       end
     end
 
+    # @return [String]
     def remote_ip_cidr
       if cidr = self["remote_ip_prefix"]
         cidr
@@ -36,10 +44,12 @@ module Yao::Resources
       end
     end
 
+    # @return [Range]
     def port_range
       port_range_max..port_range_min
     end
 
+    # @return [Yao::Resources::SecurityGroup]
     def remote_group
       return nil if self["remote_group_id"].nil? && (self["group"].nil? || self["group"].empty?)
 

data/lib/yao/resources/server.rb

@@ -25,34 +25,54 @@ module Yao::Resources
     self.resources_name = "servers"
     self.resources_detail_available = true
 
+    # @param counter_name [String]
+    # @param query [Hash]
+    # @return [Array<Yao::OldSample>]
     def old_samples(counter_name: nil, query: {})
       Yao::OldSample.list(counter_name, query).select{|os| os.resource_metadata["instance_id"] == id}
     end
 
+    # @param id [String]
+    # @return [Hash]
     def self.start(id)
       action(id, "os-start" => nil)
     end
 
+    # @param id [String]
+    # @return [Hash]
     def self.shutoff(id)
       action(id, "os-stop" => nil)
     end
 
+    # @param id [String]
+    # @return [Hash]
     def self.reboot(id)
       action(id,"reboot" => { "type" => "HARD" })
     end
 
+    # @param id [String]
+    # @param flavor_id [String]
+    # @return [Hash]
     def self.resize(id, flavor_id)
       action(id,"resize" => { "flavorRef" => flavor_id })
     end
 
+    # @param id [String]
+    # @param sg_name [String]
+    # @return [Hash]
     def self.add_security_group(id, sg_name)
       action(id, {"addSecurityGroup": {"name": sg_name}})
     end
 
+    # @param id [String]
+    # @param sg_name [String]
+    # @return [Hash]
     def self.remove_security_group(id, sg_name)
       action(id, {"removeSecurityGroup": {"name": sg_name}})
     end
 
+    # @param id [String]
+    # @return [Hash]
     def self.get_vnc_console(id)
       response = action(id, {"os-getVNCConsole": {"type": "novnc"}})
       response.dig("console", "url")

data/lib/yao/resources/server_group.rb

@@ -6,4 +6,4 @@ module Yao::Resources
     self.resource_name  = "server_group"
     self.resources_name = "os-server-groups"
   end
-end
+end

data/lib/yao/resources/server_usage_associationable.rb

@@ -0,0 +1,12 @@
+module Yao::Resources
+  module ServerUsageAssociationable
+    # @param opt [Hash]
+    # @return [Hash]
+    def server_usage(params = {})
+      path = "./os-simple-tenant-usage/#{id}"
+      client = Yao.default_client.pool['compute']
+      res = client.get(path, params, {"Accept" => "application/json"})
+      res.body["tenant_usage"]
+    end
+  end
+end

data/lib/yao/resources/subnet.rb

@@ -7,6 +7,7 @@ module Yao::Resources
     friendly_attributes :name, :cidr, :gateway_ip, :network_id, :ip_version,
                         :dns_nameservers, :host_routes, :enable_dhcp
 
+    # @return [Array<Range>]
     def allocation_pools
       self["allocation_pools"].map do |pool|
         pool["start"]..pool["end"]

data/lib/yao/resources/tenant.rb

@@ -1,5 +1,7 @@
 module Yao::Resources
   class Tenant < Base
+    include ServerUsageAssociationable
+
     friendly_attributes :id, :name, :description, :enabled
 
     self.service        = "identity"
@@ -8,18 +10,22 @@ module Yao::Resources
     self.admin          = true
     self.return_single_on_querying = true
 
+    # @return [Yao::Resources::Server]
     def servers
       @servers ||= Yao::Server.list(all_tenants: 1, project_id: id)
     end
 
+    # @return [Yao::Resources::Meter]
     def meters
       @meters ||= Yao::Meter.list({'q.field' => 'project_id', 'q.op' => 'eq', 'q.value' => id})
     end
 
+    # @return [Yao::Resources::Port]
     def ports
       @ports ||= Yao::Port.list(tenant_id: id)
     end
 
+    # @return [Array<Yao::Resources::Meter>]
     def meters_by_name(meter_name)
       meters.select{|m| m.name == meter_name}
     end

data/lib/yao/resources/tenant_associationable.rb

@@ -7,6 +7,7 @@ module Yao
         base.friendly_attributes :tenant_id
       end
 
+      # @return [Yao::Resources::Tenant]
       def tenant
         @tenant ||= Yao::Tenant.find(project_id || tenant_id)
       end

data/lib/yao/resources/user.rb

@@ -10,11 +10,13 @@ module Yao::Resources
     self.admin          = true
 
     class << self
+      # @return [Bool]
       def return_single_on_querying
         api_verion_v2?
       end
 
       private
+      # @return [Bool]
       def api_verion_v2?
         client.url_prefix.to_s.match?(/v2\.0/)
       end

data/lib/yao/resources.rb

@@ -4,6 +4,7 @@ module Yao
     require "yao/resources/tenant_associationable"
     require "yao/resources/port_associationable"
     require "yao/resources/network_associationable"
+    require "yao/resources/server_usage_associationable"
 
     autoload :Server,                    "yao/resources/server"
     autoload :ServerGroup,               "yao/resources/server_group"
@@ -42,6 +43,8 @@ module Yao
     autoload :Sample,                    "yao/resources/sample"
   end
 
+  # @param name [String]
+  # @return [object]
   def self.const_missing(name)
     new_klass = Yao::Resources.const_get(name)
     Yao.const_set(name, new_klass)

data/lib/yao/token.rb

@@ -2,6 +2,7 @@ require 'yao/client'
 
 module Yao
   class Token
+
     def self.issue(cli, auth_info)
       t = new(auth_info)
       t.refresh(cli)

data/lib/yao/version.rb

@@ -1,3 +1,3 @@
 module Yao
-  VERSION = "0.13.4"
+  VERSION = "0.14.0"
 end

data/test/yao/resources/test_base.rb

@@ -12,4 +12,15 @@ class TestResourceBase < TestYaoResource
     base.class.friendly_attributes(:name)
     assert_equal("bar", base.name)
   end
+
+  def test_map_attribute_to_resource
+    base = Yao::Resources::Base.new("string" => "hoge")
+    base.class.map_attribute_to_resource string: String
+    assert_equal("hoge", base.string)
+
+    base = Yao::Resources::Base.new({"empty" => ""})
+    base.class.map_attribute_to_resource empty: NilClass
+    assert_equal(nil, base.empty)
+  end
+
 end

data/test/yao/resources/test_image.rb

@@ -41,6 +41,11 @@ class TestImage < TestYaoResource
 
   end
 
+  def test_empty_image
+    image = Yao::Server.new("image"=>"").image
+    assert_equal(image, nil)
+  end
+
   def test_to_hash
     server = Yao::Resources::Server.new(
       "OS-DCF:diskConfig" => "AUTO",