yao 0.7.0 → 0.8.0

data/lib/yao/resources/project.rb

@@ -0,0 +1,16 @@
+module Yao::Resources
+  class Project < Base
+    friendly_attributes :id, :name, :description, :enabled, :parent_id, :domain_id
+    alias :enabled? :enabled
+
+    self.service        = "identity"
+    self.resource_name  = "project"
+    self.resources_name = "projects"
+    self.admin          = true
+
+    def domain?
+      @data["is_domain"]
+    end
+
+  end
+end

data/lib/yao/resources/resource.rb

@@ -1,7 +1,9 @@
 require 'time'
 module Yao::Resources
   class Resource < Base
-    friendly_attributes :user_id, :resource_id, :project_id,
+    include TenantAssociationable
+
+    friendly_attributes :user_id, :resource_id,
                         :last_sample_timestamp, :first_sample_timestamp,
                         :metadata,
                         :links
@@ -10,10 +12,6 @@ module Yao::Resources
       resource_id
     end
 
-    def tenant
-      @tenant ||= Yao::User.get(project_id)
-    end
-
     def user
       @user ||= Yao::User.get(user_id)
     end
@@ -42,12 +40,19 @@ module Yao::Resources
 
     class << self
       private
+
+      # override Yao::Resources::RestfullyAccessible.resource_from_json
+      # @param [Hash]
+      # @return [Yao::Resources::Resource]
       def resource_from_json(json)
-        json
+        new(json)
       end
 
+      # override Yao::Resources::RestfullyAccessible.resources_from_json
+      # @param [Hash]
+      # @return [Yao::Resources::Resource]
       def resources_from_json(json)
-        json
+        new(json)
       end
     end
   end

data/lib/yao/resources/restfully_accessible.rb

@@ -5,7 +5,7 @@ module Yao::Resources
     def self.extended(base)
       base.class_eval do
         class << self
-          attr_accessor :resource_name, :resources_name
+          attr_accessor :resource_name, :resources_name, :resources_detail_available
 
           extend Forwardable
           %w(get post put delete).each do |method_name|
@@ -34,6 +34,10 @@ module Yao::Resources
       @admin = bool
     end
 
+    def return_single_on_querying
+      @return_single_on_querying
+    end
+
     def return_single_on_querying=(bool)
       @return_single_on_querying = bool
     end
@@ -65,35 +69,49 @@ module Yao::Resources
       end
     end
 
-    def with_resources_path(path, &blk)
-      original = @resources_path
-      @resources_path = path
-      result = yield
-      @resources_path = original
+    # @param query [Hash]
+    # @return [Yao::Resources::*]
+    # @return [Array<Yao::Resources::*]
+    def list(query={})
 
-      result
-    end
+      url = if resources_detail_available
+        # If the resource has 'detail', #list tries to GET /${resourece}/detail
+        # For example.
+        #
+        #   GET /servers/detail
+        #   GET /flavors/detail
+        #
+        create_url('detail')
+      else
+        create_url
+      end
 
-    # restful methods
-    def list(query={})
-      json = GET(create_url([api_version, resources_path]), query).body
-      if @return_single_on_querying && !query.empty?
-        return_resource(resource_from_json(json))
+      json = GET(url, query).body
+      if return_single_on_querying && !query.empty?
+        # returns Yao::Resources::*
+        resource_from_json(json)
       else
-        return_resources(resources_from_json(json))
+        # returns Array of Yao::Resources::*
+        resources_from_json(json)
       end
     end
 
+    # @note .list is defined to keep backward compatibility and will be deprecated
+    alias :list_detail :list
+
+    # @param id_or_name_or_permalink [Stirng]
+    # @param query [Hash]
+    # @return [Yao::Resources::*]
     def get(id_or_name_or_permalink, query={})
       res = if id_or_name_or_permalink.start_with?("http://", "https://")
               GET(id_or_name_or_permalink, query)
             elsif uuid?(id_or_name_or_permalink)
-              GET(create_url([api_version, resources_path, id_or_name_or_permalink]), query)
+              GET(create_url(id_or_name_or_permalink), query)
             else
               get_by_name(id_or_name_or_permalink, query)
             end
 
-      return_resource(resource_from_json(res.body))
+      resource_from_json(res.body)
     end
     alias find get
 
@@ -101,74 +119,93 @@ module Yao::Resources
       list(query.merge({"name" => name}))
     end
 
+    # @param resource_params [Hash]
+    # @return [Yao::Resources::*]
     def create(resource_params)
       params = {
         resource_name_in_json => resource_params
       }
-      res = POST(create_url([api_version, resources_path])) do |req|
+      res = POST(create_url) do |req|
         req.body = params.to_json
         req.headers['Content-Type'] = 'application/json'
       end
-      return_resource(resource_from_json(res.body))
+      resource_from_json(res.body)
     end
 
+    # @param id [String]
+    # @return [Yao::Resources::*]
     def update(id, resource_params)
       params = {
         resource_name_in_json => resource_params
       }
-      res = PUT(create_url([api_version, resources_path, id])) do |req|
+      res = PUT(create_url(id)) do |req|
         req.body = params.to_json
         req.headers['Content-Type'] = 'application/json'
       end
-      return_resource(resource_from_json(res.body))
+      resource_from_json(res.body)
     end
 
+    # @param id [String]
+    # @return [String]
     def destroy(id)
-      res = DELETE(create_url([api_version, resources_path, id]))
+      res = DELETE(create_url(id))
       res.body
     end
 
     private
-    def create_url(paths)
+
+    # returns pathname of resource URL
+    # @param subpath [String]
+    # @return [String]
+    def create_url(subpath='')
+      paths = [ api_version, resources_path, subpath ]
       paths.select{|s| s != ''}.join('/')
     end
 
+    # @return [String]
     def resource_name_in_json
       @_resource_name_in_json ||= resource_name.sub(/^os-/, "").tr("-", "_")
     end
 
-    def resource_from_json(json)
-      json[resource_name_in_json]
-    end
-
-    def resources_from_json(json)
+    # @return [String]
+    def resources_name_in_json
       @resources_name_in_json ||= resources_name.sub(/^os-/, "").tr("-", "_")
-      json[@resources_name_in_json]
     end
 
-    def return_resource(d)
-      new(d)
+    # @param json [Hash]
+    # @return [Yao::Resources::*]
+    def resource_from_json(json)
+      attribute = json[resource_name_in_json]
+      new(attribute)
     end
 
-    def return_resources(arr)
-      arr.map{|d| return_resource(d) }
+    # @param json [Hash]
+    # @return [Array<Yao::Resources::*>]
+    def resources_from_json(json)
+      json[resources_name_in_json].map { |attribute|
+        new(attribute) # instance of Yao::Resources::*
+      }
     end
 
     def uuid?(str)
       /^[\da-f]{8}-([\da-f]{4}-){3}[\da-f]{12}$/ === str
     end
 
+    # At first, search by ID. If nothing is found, search by name.
+    # @param name [String]
+    # @param query [Hash]
+    # @return [Yao::Resources::*]
     def get_by_name(name, query={})
-      # At first, search by ID. If nothing is found, search by name.
+
       begin
-        GET(create_url([api_version, resources_path, name]), query)
+        GET(create_url(name), query)
       rescue => e
         raise e unless e.class == Yao::ItemNotFound || e.class == Yao::NotFound
         item = find_by_name(name)
         if item.size > 1
           raise Yao::TooManyItemFonud.new("More than one resource exists with the name '#{name}'")
         end
-        GET(create_url([api_version, resources_path, item.first.id]), query)
+        GET(create_url(item.first.id), query)
       end
     end
   end

data/lib/yao/resources/role.rb

@@ -5,43 +5,98 @@ module Yao::Resources
     self.service        = "identity"
     self.resource_name  = "role"
     self.resources_name = "roles"
-    self.resources_path = "/OS-KSADM/roles"
     self.admin          = true
 
     class << self
-      def get_by_name(name)
-        self.list.find {|role| role.name == name }
+
+      # override Yao::Resources::RestfullyAccessible#find_by_name
+      # This is workaround of keystone versioning v2.0/v3.
+      # @return [Array<Yao::Resources::Role>]
+      def find_by_name(name, query={})
+        if api_version_v2?
+          list.select{|r| r.name == name}
+        else
+          super
+        end
+      end
+
+      # override Yao::Resources::RestfullyAccessible#resources_path
+      # This is workaround of keystone versioning v2.0/v3.
+      # @return [String]
+      def resources_path
+        if api_version_v2?
+          "OS-KSADM/roles"
+        else
+          resources_name
+        end
       end
-      alias find_by_name get_by_name
 
+      # @param user_name [String]
+      # @param on [String]
+      # @return [Array<Yao::Resources::Role>]
       def list_for_user(user_name, on:)
-        user   = Yao::User.get_by_name(user_name)
-        tenant = Yao::Tenant.get_by_name(on)
-        path = ["tenants", tenant.id, "users", user.id, "roles"].join("/")
+        user   = Yao::User.get(user_name)
+        tenant = if api_version_v2?
+                   Yao::Tenant.find_by_name(on)
+                 else
+                   Yao::Project.get(on)
+                 end
 
-        with_resources_path(path) { self.list }
+        res = GET(path_for_role_resource(tenant, user))
+        resources_from_json(res.body)
       end
 
+      # @param role_name [String]
+      # @param to: [String]
+      # @param on: [String]
+      # @return [Faraday::Response]
       def grant(role_name, to:, on:)
-        role   = Yao::Role.get_by_name(role_name)
-        user   = Yao::User.get_by_name(to)
-        tenant = Yao::Tenant.get_by_name(on)
+        role   = Yao::Role.get(role_name)
+        user   = Yao::User.get(to)
+        tenant = if api_version_v2?
+                   Yao::Tenant.find_by_name(on)
+                 else
+                   Yao::Project.get(on)
+                 end
 
-        PUT path_for_grant_revoke(tenant, user, role)
+        # response is "204 Not Content"
+        PUT(path_for_role_resource(tenant, user, role))
       end
 
+      # @param role_name [String]
+      # @param from: [String]
+      # @param on: [String]
+      # @return [Faraday::Response]
       def revoke(role_name, from:, on:)
-        role   = Yao::Role.get_by_name(role_name)
-        user   = Yao::User.get_by_name(from)
-        tenant = Yao::Tenant.get_by_name(on)
+        role   = Yao::Role.get(role_name)
+        user   = Yao::User.get(from)
+        tenant = if api_version_v2?
+                   Yao::Tenant.find_by_name(on)
+                 else
+                   Yao::Project.get(on)
+                 end
 
-        DELETE path_for_grant_revoke(tenant, user, role)
+        # response is "204 Not Content"
+        DELETE(path_for_role_resource(tenant, user, role))
       end
 
       private
 
-      def path_for_grant_revoke(tenant, user, role)
-        ["tenants", tenant.id, "users", user.id, "roles", "OS-KSADM", role.id].join("/")
+      # workaround of keystone versioning v2.0/v3
+      # @return [Bool]
+      def api_version_v2?
+        client.url_prefix.to_s =~ /v2\.0/
+      end
+
+      def path_for_role_resource(tenant, user, role = nil)
+        if api_version_v2?
+          paths = ["tenants", tenant.id, "users", user.id, "roles"]
+          paths += ["OS-KSADM", role.id] if role
+        else
+          paths = ["projects", tenant.id, "users", user.id, "roles"]
+          paths << role.id if role
+        end
+        paths.join("/")
       end
     end
   end

data/lib/yao/resources/router.rb

@@ -1,6 +1,8 @@
 module Yao::Resources
   class Router < Base
-    friendly_attributes :tenant_id, :project_id, :name, :description, :admin_state_up, :status, :external_gateway_info,
+    include TenantAssociationable
+
+    friendly_attributes :name, :description, :admin_state_up, :status, :external_gateway_info,
                         :network_id, :enable_snat, :external_fixed_ips, :routes, :destination, :nexthop, :distributed,
                         :ha, :availability_zone_hints, :availability_zones
 

data/lib/yao/resources/sample.rb

@@ -2,7 +2,7 @@ module Yao::Resources
   class Sample < Base
     friendly_attributes :id, :metadata, :meter,
                         :source, :type, :unit, :volume,
-                        :resouce_id, :tenant_id, :user_id
+                        :resource_id, :user_id
 
     def recorded_at
       Time.parse(self["recorded_at"])
@@ -16,10 +16,6 @@ module Yao::Resources
       @resource ||= Yao::Resource.get(resource_id)
     end
 
-    def tenant
-      @tenant ||= Yao::Tenant.get(project_id)
-    end
-
     def user
       @user ||= Yao::User.get(user_id)
     end

data/lib/yao/resources/security_group.rb

@@ -1,7 +1,9 @@
 require 'yao/resources/security_group_rule'
 module Yao::Resources
   class SecurityGroup < Base
-    friendly_attributes :name, :description, :tenant_id
+    include TenantAssociationable
+
+    friendly_attributes :name, :description
 
     def rules
       self[["rules", SecurityGroupRule].join("__")] ||= (case self.class.service

data/lib/yao/resources/server.rb

@@ -2,8 +2,10 @@ require 'yao/resources/metadata_available'
 require 'yao/resources/action'
 module Yao::Resources
   class Server < Base
+    include TenantAssociationable
+
     friendly_attributes :addresses, :metadata, :name, :progress,
-                        :status, :tenant_id, :user_id, :key_name
+                        :status, :user_id, :key_name
     map_attribute_to_attribute hostId: :host_id
     map_attribute_to_resource  flavor: Flavor
     map_attribute_to_resource  image: Image
@@ -21,6 +23,7 @@ module Yao::Resources
     self.service        = "compute"
     self.resource_name  = "server"
     self.resources_name = "servers"
+    self.resources_detail_available = true
 
     def old_samples(counter_name: nil, query: {})
       Yao::OldSample.list(counter_name, query).select{|os| os.resource_metadata["instance_id"] == id}
@@ -52,14 +55,6 @@ module Yao::Resources
 
     class << self
       alias :stop :shutoff
-
-      def list_detail(query={})
-        return_resources(
-          resources_from_json(
-            GET([resources_path, "detail"].join("/"), query).body
-          )
-        )
-      end
     end
 
     extend MetadataAvailable