nephophobia 0.3.0 → 0.3.6

data/lib/nephophobia/resource/project.rb

@@ -0,0 +1,132 @@
+##
+# __Must__ execute as a user with the +admin+ role.
+
+module Nephophobia
+  module Resource
+    class Project
+      def initialize client
+        @client = client
+      end
+
+      ##
+      # Adds the given 'user_name' to the specified 'project_name'.
+      # Returns a response to the state change.
+      #
+      # +user_name+: A String representing a nova user_name.
+      # +project_name+: A String representing a nova project_name name.
+
+      def add_member user_name, project_name
+        modify_membership user_name, "add", project_name
+      end
+
+      ##
+      # Returns information about all projects, or all projects the given
+      # 'user_name' is in.
+      #
+      # +user_name+: An optional String representing a nova user_name.
+
+      def all user_name = nil
+        response = @client.action "DescribeProjects", {}
+
+        item     = response.body['DescribeProjectsResponse']['projectSet']['item']
+        projects = Nephophobia::Util.coerce(item).collect do |data|
+          Response::Project.new data
+        end
+
+        return projects unless user_name
+        projects.map { |project| project if @client.project.member? user_name, project.name }.compact
+      end
+
+      ##
+      # Creates the given 'project_name' and adds the specified 'user_name' as the manager.
+      # Returns a response to the state change.
+      #
+      # +project_name+: A String representing a nova project name.
+      # +user_name+: A String representing a nova user_name.
+
+      def create project_name, user_name
+        params = {
+          "Name"        => project_name,
+          "ManagerUser" => user_name
+        }
+
+        response = @client.action "RegisterProject", params
+
+        Response::Project.new response.body['RegisterProjectResponse']
+      end
+
+      ##
+      # Removes the given 'project_name'.
+      # Returns a response to the state change.
+      #
+      # +project_name+: A String representing a nova project name.
+
+      def destroy project_name
+        response = @client.action "DeregisterProject", "Name" => project_name
+
+        Response::Return.new response.body['DeregisterProjectResponse']
+      end
+
+      ##
+      # Returns information about the given 'project_name'.
+      #
+      # +project_name+: A String representing a nova project name.
+
+      def find project_name
+        response = @client.action "DescribeProject", "Name" => project_name
+
+        Response::Project.new response.body['DescribeProjectResponse']
+      rescue Hugs::Errors::BadRequest
+      end
+
+      ##
+      # Returns information about all members of the given 'project_name'.
+      #
+      # +project_name+: A String representing a nova project name.
+
+      def members project_name
+        response = @client.action "DescribeProjectMembers", "Name" => project_name
+
+        item = response.body['DescribeProjectMembersResponse']['members']['item']
+        Nephophobia::Util.coerce(item).collect do |data|
+          Response::Member.new data
+        end
+      rescue Hugs::Errors::BadRequest
+      end
+
+      ##
+      # Return a Boolean if the given 'user_name' is a member of the specified 'project_name'.
+      #
+      # +user_name+: A String representing a nova user_name.
+      # +project_name+: A String representing a nova project_name name.
+
+      def member? user_name, project_name
+        members(project_name).any? { |f| f.member == user_name }
+      end
+
+      ##
+      # Removes the given 'user_name' from the specified 'project_name'.
+      # Returns a response to the state change.
+      #
+      # +user_name+: A String representing a nova user_name.
+      # +project_name+: A String representing a nova project_name name.
+
+      def remove_member user_name, project_name
+        modify_membership user_name, "remove", project_name
+      end
+
+    private
+      def modify_membership user_name, operation, project_name
+        params = {
+          "User"      => user_name,
+          "Project"   => project_name,
+          "Operation" => operation
+        }
+
+        response = @client.action "ModifyProjectMember", params
+
+        Response::Return.new response.body['ModifyProjectMemberResponse']
+      end
+    end
+  end
+end

data/lib/nephophobia/resource/role.rb

@@ -0,0 +1,72 @@
+##
+# __Must__ execute as a user with the +admin+ role.
+
+module Nephophobia
+  module Resource
+    class Role
+      DEFAULT = "sysadmin"
+
+      def initialize client
+        @client = client
+      end
+
+      ##
+      # Returns global roles for the given 'user_name', or for the given 'project_name'.
+      #
+      # +user_name+: A String representing a nova user_name.
+      # +project_name+: An Optional String representing a nova project_name name.
+
+      def all user_name=nil, project_name = nil
+        params = {}
+        params.merge!("User" => user_name) if user_name
+        params.merge!("Project" => project_name) if project_name
+        action = ( user_name ? "DescribeUserRoles" : "DescribeRoles" )
+
+        response = @client.action action, params
+
+        roles = response.body["#{action}Response"]['roles']
+        roles && Nephophobia::Util.coerce(roles['item']).collect do |data|
+          Response::Role.new data
+        end
+      end
+
+      ##
+      # Adds the given 'user_name' to the global 'Role::DEFAULT', unless a
+      # 'role_name' is provided.
+      # Returns a response to the state change.
+      #
+      # +user_name+: A String representing a nova user_name.
+      # +project_name+: An Optional String representing a nova project_name name.
+      # +role_name+: An Optional String representing a nova role name.
+
+      def create user_name, project_name = nil, role_name = nil
+        modify_role user_name, "add", project_name, role_name
+      end
+
+      ##
+      # Removes the given 'user_name' from the global 'Role::DEFAULT', unless a
+      # 'role_name' is provided.
+      #
+      # +user_name+: A String representing a nova user_name.
+      # +project_name+: An Optional String representing a nova project_name name.
+      # +role_name+: An Optional String representing a nova role name.
+
+      def destroy user_name, project_name = nil, role_name = nil
+        modify_role user_name, "remove", project_name
+      end
+
+      def modify_role user_name, operation, project_name = nil, role_name = nil
+        params = {
+          "User"      => user_name,
+          "Role"      => role_name || DEFAULT,
+          "Operation" => operation
+        }
+        params.merge!("Project" => project_name) if project_name
+
+        response = @client.action "ModifyUserRole", params
+
+        Response::Return.new response.body['ModifyUserRoleResponse']
+      end
+    end
+  end
+end

data/lib/nephophobia/resource/user.rb

@@ -0,0 +1,83 @@
+##
+# __Must__ execute as a user with the +admin+ role.
+
+module Nephophobia
+  module Resource
+    class User
+      def initialize client
+        @client = client
+      end
+
+      ##
+      # Creates the given 'user_name'.
+      # Returns a response to the state change.
+      #
+      # +user_name+: A String representing a nova user_name.
+
+      def create user_name
+        response = @client.action "RegisterUser", "Name" => user_name
+
+        Response::User.new response.body['RegisterUserResponse']
+      end
+
+      ##
+      # Returns the credentials for a given 'user_name' for the specified 'project_name'.
+      #
+      # +user_name+: A String containing a nova user_name.
+      # +project_name+: A String containing a nova project_name name.
+
+      def credentials user_name, project_name
+        params = {
+          "Name"    => user_name,
+          "Project" => project_name
+        }
+
+        response = @client.action "GenerateX509ForUser", params
+
+        Base64.decode64 response.body['GenerateX509ForUserResponse']['file']
+      end
+
+      ##
+      # Removes the given 'user_name'.
+      # Returns a response to the state change.
+      #
+      # +user_name+: A String representing a nova user_name.
+
+      def destroy user_name
+        response = @client.action "DeregisterUser", "Name" => user_name
+
+        Response::Return.new response.body['DeregisterUserResponse']
+      end
+
+      ##
+      # Returns information about the given 'user_name'.
+      #
+      # +user_name+: A String representing the user_name.
+
+      def find user_name
+        response = @client.action "DescribeUser", "Name" => user_name
+
+        Response::User.new response.body['DescribeUserResponse']
+      rescue Hugs::Errors::BadRequest
+      end
+
+      ##
+      # Apply a set of global and per-project permissions to the given 'user_name'.
+      # Do the following if the 'user_name' is not a member of the 'project_name'.
+      #  - Add the 'user_name' with the default role (sysadmin) globally.
+      #  - Add the 'user_name' to the 'project_name', with the default role (sysadmin).
+      #  - Add the 'user_name' as a member to the 'project_name'
+      #
+      # +user_name+: A String representing a nova user_name.
+      # +project_name+: A String representing a nova project_name name.
+
+      def register user_name, project_name
+        unless @client.project.member? user_name, project_name
+          @client.role.create user_name
+          @client.role.create user_name, project_name
+          @client.project.add_member user_name, project_name
+        end
+      end
+    end
+  end
+end

data/lib/nephophobia/response/address.rb

@@ -0,0 +1,13 @@
+module Nephophobia
+  module Response
+    class Address
+      attr_reader :attributes, :floating_ip, :status, :instance_id
+
+      def initialize attributes
+        @floating_ip = attributes['publicIp']
+        @instance_id = attributes['instanceId']
+        @status      = attributes['item']
+      end
+    end
+  end
+end

data/lib/nephophobia/response/compute.rb

@@ -0,0 +1,34 @@
+module Nephophobia
+  module Response
+    class Compute
+      attr_reader :description, :dns_name, :image_id, :instance_id, :instance_type
+      attr_reader :key_name, :launch_time, :name, :owner_id, :placement
+      attr_reader :private_dns_name, :project_id, :public_dns_name, :state
+      attr_reader :ip_address, :private_ip_address
+
+      attr_accessor :attributes
+
+      def initialize attributes
+        @attributes = attributes
+
+        @project_id         = attributes['ownerId']
+        item                = attributes['instancesSet']['item']
+        item                = item.first if item.is_a?(Array)
+        @description        = item['displayDescription']
+        @name               = item['displayName']
+        @key_name           = item['keyName']
+        @instance_id        = item['instanceId']
+        @ip_address         = item['ipAddress']
+        @state              = item['instanceState']['name']
+        @public_dns_name    = item['publicDnsName']
+        @private_dns_name   = item['privateDnsName']
+        @private_ip_address = item['privateIpAddress']
+        @image_id           = item['imageId']
+        @dns_name           = item['dnsName']
+        @launch_time        = DateTime.parse(item['launchTime'])
+        @placement          = item['placement']['availabilityZone']
+        @instance_type      = item['instanceType']
+      end
+    end
+  end
+end

data/lib/nephophobia/response/credential.rb

@@ -0,0 +1,17 @@
+module Nephophobia
+  module Response
+    class Credential
+      attr_reader :fingerprint, :material, :name
+
+      attr_accessor :attributes
+
+      def initialize attributes
+        @attributes = attributes
+
+        @material    = attributes['keyMaterial']
+        @name        = attributes['keyName']
+        @fingerprint = attributes['keyFingerprint']
+      end
+    end
+  end
+end

data/lib/nephophobia/response/image.rb

@@ -0,0 +1,24 @@
+module Nephophobia
+  module Response
+    class Image
+      attr_reader :architecture, :image_id, :image_location, :image_owner_id
+      attr_reader :image_type, :kernel_id, :is_public, :state
+
+      attr_accessor :attributes
+
+      def initialize attributes
+        @attributes = attributes
+
+        @architecture   = attributes['architecture']
+        @id             = attributes['id']
+        @image_id       = attributes['imageId']
+        @image_location = attributes['imageLocation']
+        @image_owner_id = attributes['imageOwnerId']
+        @image_type     = attributes['imageType']
+        @is_public      = attributes['isPublic']
+        @kernel_id      = attributes['kernelId']
+        @state          = attributes['imageState']
+      end
+    end
+  end
+end

data/lib/nephophobia/response/member.rb

@@ -0,0 +1,15 @@
+module Nephophobia
+  module Response
+    class Member
+      attr_reader :member
+
+      attr_accessor :attributes
+
+      def initialize attributes
+        @attributes = attributes
+
+        @member = attributes['member']
+      end
+    end
+  end
+end

data/lib/nephophobia/response/project.rb

@@ -0,0 +1,18 @@
+module Nephophobia
+  module Response
+    class Project
+      attr_reader :name, :manager_id, :description
+
+      attr_accessor :attributes
+
+      def initialize attributes
+        @attributes = attributes
+
+        @name        = attributes['projectname']
+        @manager_id  = attributes['projectManagerId']
+        @description = attributes['description']
+        @member      = attributes['member']
+      end
+    end
+  end
+end

data/lib/nephophobia/response/return.rb

@@ -0,0 +1,16 @@
+module Nephophobia
+  module Response
+    class Return
+      attr_reader :return, :request_id
+
+      attr_accessor :attributes
+
+      def initialize attributes
+        @attributes = attributes
+
+        @request_id = attributes["requestId"]
+        @return     = attributes["return"] == "true"
+      end
+    end
+  end
+end

data/lib/nephophobia/response/role.rb

@@ -0,0 +1,15 @@
+module Nephophobia
+  module Response
+    class Role
+      attr_reader :name
+
+      attr_accessor :attributes
+
+      def initialize attributes
+        @attributes = attributes
+
+        @name = attributes['role']
+      end
+    end
+  end
+end