opennebula-oca 3.9.0.beta → 3.9.90.rc

data/lib/opennebula/document.rb

@@ -1,259 +0,0 @@
-# -------------------------------------------------------------------------- #
-# Copyright 2002-2012, OpenNebula Project Leads (OpenNebula.org)             #
-#                                                                            #
-# Licensed under the Apache License, Version 2.0 (the "License"); you may    #
-# not use this file except in compliance with the License. You may obtain    #
-# a copy of the License at                                                   #
-#                                                                            #
-# http://www.apache.org/licenses/LICENSE-2.0                                 #
-#                                                                            #
-# Unless required by applicable law or agreed to in writing, software        #
-# distributed under the License is distributed on an "AS IS" BASIS,          #
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
-# See the License for the specific language governing permissions and        #
-# limitations under the License.                                             #
-#--------------------------------------------------------------------------- #
-
-require 'opennebula/pool_element'
-
-module OpenNebula
-
-    # All subclasses must define the DOCUMENT_TYPE constant.
-    #
-    # @example
-    #   require 'opennebula/document'
-    #
-    #   module OpenNebula
-    #       class CustomObject < Document
-    #
-    #           DOCUMENT_TYPE = 400
-    #
-    #       end
-    #   end
-    class Document < PoolElement
-
-        #######################################################################
-        # Constants and Class Methods
-        #######################################################################
-
-        DOCUMENT_METHODS = {
-            :allocate   => "document.allocate",
-            :delete     => "document.delete",
-            :info       => "document.info",
-            :update     => "document.update",
-            :chown      => "document.chown",
-            :chmod      => "document.chmod",
-            :clone      => "document.clone",
-            :rename     => "document.rename"
-        }
-
-        # Creates a Document Object description with just its identifier
-        # this method should be used to create plain Document objects.
-        # @param [Integer] pe_id the id of the object
-        #
-        # @return [Nokogiri::XML::Node, REXML::Element] the empty xml
-        def Document.build_xml(pe_id=nil)
-            if pe_id
-                obj_xml = "<DOCUMENT><ID>#{pe_id}</ID></DOCUMENT>"
-            else
-                obj_xml = "<DOCUMENT></DOCUMENT>"
-            end
-
-            XMLElement.build_xml(obj_xml,'DOCUMENT')
-        end
-
-        # Class constructor
-        #
-        # @param [Nokogiri::XML::Node, REXML::Element] xml string
-        #   created by the build_xml() method
-        # @param [OpenNebula::Client] client the xml-rpc client
-        #
-        # @return [Document] the new object
-        #
-        # @example
-        #   doc = Document.new(Document.build_xml(3),rpc_client)
-        def initialize(xml, client)
-            super(xml,client)
-        end
-
-        #######################################################################
-        # XML-RPC Methods for the Document Object
-        #######################################################################
-
-        # Retrieves the information of the given Document.
-        #
-        # @return [nil, OpenNebula::Error] nil in case of success, Error
-        #   otherwise
-        def info()
-            rc = super(DOCUMENT_METHODS[:info], 'DOCUMENT')
-
-            if !OpenNebula.is_error?(rc) && self['TYPE'].to_i != document_type
-                return OpenNebula::Error.new("[DocumentInfo] Error getting document [#{@pe_id}].")
-            end
-
-            return rc
-        end
-
-        # Allocates a new Document in OpenNebula
-        #
-        # @param description [String] The contents of the Document.
-        #
-        # @return [nil, OpenNebula::Error] nil in case of success, Error
-        #   otherwise
-        def allocate(description)
-            super(DOCUMENT_METHODS[:allocate], description, document_type)
-        end
-
-        # Deletes the Document
-        #
-        # @return [nil, OpenNebula::Error] nil in case of success, Error
-        #   otherwise
-        def delete()
-            rc = check_type()
-            return rc if OpenNebula.is_error?(rc)
-
-            return call(DOCUMENT_METHODS[:delete], @pe_id)
-        end
-
-        # Replaces the template contents
-        #
-        # @param [String] new_template new template contents
-        #
-        # @return [nil, OpenNebula::Error] nil in case of success, Error
-        #   otherwise
-        def update(new_template)
-            rc = check_type()
-            return rc if OpenNebula.is_error?(rc)
-
-            super(DOCUMENT_METHODS[:update], new_template)
-        end
-
-        # Changes the owner/group
-        #
-        # @param [Integer] uid the new owner id. Set to -1 to leave the current one
-        # @param [Integer] gid the new group id. Set to -1 to leave the current one
-        #
-        # @return [nil, OpenNebula::Error] nil in case of success, Error
-        #   otherwise
-        def chown(uid, gid)
-            rc = check_type()
-            return rc if OpenNebula.is_error?(rc)
-
-            super(DOCUMENT_METHODS[:chown], uid, gid)
-        end
-
-        # Changes the Document permissions.
-        #
-        # @param octet [String] Permissions octed , e.g. 640
-        #
-        # @return [nil, OpenNebula::Error] nil in case of success, Error
-        #   otherwise
-        def chmod_octet(octet)
-            rc = check_type()
-            return rc if OpenNebula.is_error?(rc)
-
-            super(DOCUMENT_METHODS[:chmod], octet)
-        end
-
-        # Changes the Document permissions.
-        # Each [Integer] argument must be 1 to allow, 0 deny, -1 do not change
-        #
-        # @return [nil, OpenNebula::Error] nil in case of success, Error
-        #   otherwise
-        def chmod(owner_u, owner_m, owner_a, group_u, group_m, group_a, other_u,
-                other_m, other_a)
-            rc = check_type()
-            return rc if OpenNebula.is_error?(rc)
-
-            super(DOCUMENT_METHODS[:chmod], owner_u, owner_m, owner_a, group_u,
-                group_m, group_a, other_u, other_m, other_a)
-        end
-
-        # Clones this Document into a new one
-        #
-        # @param name [String] Name for the new Document.
-        #
-        # @return [Integer, OpenNebula::Error] The new Document ID in case
-        #   of success, Error otherwise
-        def clone(name)
-            rc = check_type()
-            return rc if OpenNebula.is_error?(rc)
-
-            return Error.new('ID not defined') if !@pe_id
-
-            rc = @client.call(DOCUMENT_METHODS[:clone], @pe_id, name)
-
-            return rc
-        end
-
-        # Renames this Document
-        #
-        # @param name [String] New name for the Document.
-        #
-        # @return [nil, OpenNebula::Error] nil in case of success, Error
-        #   otherwise
-        def rename(name)
-            return call(DOCUMENT_METHODS[:rename], @pe_id, name)
-        end
-
-        #######################################################################
-        # Helpers to get Document information
-        #######################################################################
-
-        # Returns the group identifier
-        # @return [Integer] the element's group ID
-        def gid
-            self['GID'].to_i
-        end
-
-        # Returns the owner user ID
-        # @return [Integer] the element's owner user ID
-        def owner_id
-            self['UID'].to_i
-        end
-
-        # Returns true if the GROUP_U permission bit is set
-        # @return [true, false] true if the GROUP_U permission bit is set
-        def public?
-            if self['PERMISSIONS/GROUP_U'] == "1" || self['PERMISSIONS/OTHER_U'] == "1"
-                true
-            else
-                false
-            end
-        end
-
-        def document_type
-            self.class::DOCUMENT_TYPE
-        end
-
-    private
-
-        def set_publish(published)
-            group_u = published ? 1 : 0
-
-            chmod(-1, -1, -1, group_u, -1, -1, -1, -1, -1)
-        end
-
-        def check_type()
-            type = self['TYPE']
-
-            if type.nil? && @pe_id
-                rc = @client.call(DOCUMENT_METHODS[:info], @pe_id)
-
-                return rc if OpenNebula.is_error?(rc)
-
-                xmldoc = XMLElement.new
-                xmldoc.initialize_xml(rc, 'DOCUMENT')
-
-                type = xmldoc['TYPE']
-            end
-
-            if !type.nil? && type.to_i != document_type
-                return OpenNebula::Error.new(
-                    "[DocumentInfo] Error getting document [#{@pe_id}].")
-            end
-
-            return nil
-        end
-    end
-end

data/lib/opennebula/document_json.rb

@@ -1,129 +0,0 @@
-# -------------------------------------------------------------------------- #
-# Copyright 2002-2012, OpenNebula Project Leads (OpenNebula.org)             #
-#                                                                            #
-# Licensed under the Apache License, Version 2.0 (the "License"); you may    #
-# not use this file except in compliance with the License. You may obtain    #
-# a copy of the License at                                                   #
-#                                                                            #
-# http://www.apache.org/licenses/LICENSE-2.0                                 #
-#                                                                            #
-# Unless required by applicable law or agreed to in writing, software        #
-# distributed under the License is distributed on an "AS IS" BASIS,          #
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
-# See the License for the specific language governing permissions and        #
-# limitations under the License.                                             #
-#--------------------------------------------------------------------------- #
-
-require 'json'
-
-module OpenNebula
-    class DocumentJSON < Document
-
-        TEMPLATE_TAG = "BODY"
-
-        # Allocate a new Document containing the json inside the TEMPLATE
-        #
-        # @param [String] template_json json to be inserted in the TEMPLATE
-        #   of the new resource
-        # @param [String, nil] name name of the object, this value will be
-        #   processed by the OpenNebula core
-        # @return [nil, OpenNebula::Error] nil in case of success, Error
-        #   otherwise
-        #
-        def allocate(template_json, name=nil)
-            text = build_template_xml(template_json, name)
-
-            super(text)
-        end
-
-        # Retrieves the information of the Service and all its Nodes.
-        #
-        # @return [nil, OpenNebula::Error] nil in case of success, Error
-        #   otherwise
-        #
-        def info
-            rc = super
-            if OpenNebula.is_error?(rc)
-                return rc
-            end
-
-            load_body
-        end
-
-        # Updates the current state of this Service in the OpenNebula DB
-        #
-        # @params [String, nil] template_json string to be inserted in the
-        #   template. If nil @body will be used instead
-        # @return [nil, OpenNebula::Error] nil in case of success, Error
-        #   otherwise
-        #
-        def update(template_json=nil)
-            template_json ||= @body.to_json
-
-            text = build_template_xml(template_json)
-
-            super(text)
-        end
-
-        # Generates a json representing the object
-        #
-        # @param [true, false] pretty_generate
-        # @return [String] json representing the object
-        #
-        def to_json(pretty_generate=true)
-            hash = self.to_hash
-
-            body = hash['DOCUMENT']['TEMPLATE']["#{TEMPLATE_TAG}"]
-            if body
-                body_hash = JSON.parse(body)
-                hash['DOCUMENT']['TEMPLATE']["#{TEMPLATE_TAG}"] = body_hash
-            end
-
-            if pretty_generate
-                JSON.pretty_generate hash
-            else
-                hash.to_json
-            end
-        end
-
-
-        # Fill the @body hash with the values of the template
-        def load_body
-            body_str = self["TEMPLATE/#{TEMPLATE_TAG}"]
-
-            if body_str
-                begin
-                    @body = JSON.parse(body_str)
-                rescue JSON::JSONError
-                    return OpenNebula::Error.new($!)
-                end
-            end
-
-            return nil
-        end
-
-        private
-
-        # Build an xml string incluiding the provided json
-        #
-        # @param [String] template_json The template to be inserted
-        # @param [String, nil] name The string to be inserted as name
-        # @return [String] The xml containing the json
-        #
-        def build_template_xml(template_json, name=nil)
-            template_json ||= ""
-
-            text = "<TEMPLATE>"
-
-            text << "<NAME>#{name}</NAME>" if name
-
-            text << "<#{TEMPLATE_TAG}>"
-            text << "<![CDATA[#{template_json}]]>"
-            text << "</#{TEMPLATE_TAG}>"
-
-            text << "</TEMPLATE>"
-
-            text
-        end
-    end
-end

data/lib/opennebula/document_pool.rb

@@ -1,97 +0,0 @@
-# -------------------------------------------------------------------------- #
-# Copyright 2002-2012, OpenNebula Project Leads (OpenNebula.org)             #
-#                                                                            #
-# Licensed under the Apache License, Version 2.0 (the "License"); you may    #
-# not use this file except in compliance with the License. You may obtain    #
-# a copy of the License at                                                   #
-#                                                                            #
-# http://www.apache.org/licenses/LICENSE-2.0                                 #
-#                                                                            #
-# Unless required by applicable law or agreed to in writing, software        #
-# distributed under the License is distributed on an "AS IS" BASIS,          #
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
-# See the License for the specific language governing permissions and        #
-# limitations under the License.                                             #
-#--------------------------------------------------------------------------- #
-
-require 'opennebula/pool'
-
-module OpenNebula
-
-    # All subclasses must define the DOCUMENT_TYPE constant
-    # and the factory method.
-    #
-    # @example
-    #   require 'opennebuña/document_pool'
-    #
-    #   module OpenNebula
-    #       class CustomObjectPool < DocumentPool
-    #
-    #           DOCUMENT_TYPE = 400
-    #
-    #           def factory(element_xml)
-    #               OpenNebula::CustomObject.new(element_xml, @client)
-    #           end
-    #       end
-    #   end
-    class DocumentPool < Pool
-
-        #######################################################################
-        # Constants and Class attribute accessors
-        #######################################################################
-
-        DOCUMENT_POOL_METHODS = {
-            :info => "documentpool.info"
-        }
-
-        #######################################################################
-        # Class constructor & Pool Methods
-        #######################################################################
-
-        # Class constructor
-        #
-        # @param [OpenNebula::Client] client the xml-rpc client
-        # @param [Integer] user_id the filter flag, see
-        #   http://opennebula.org/documentation:rel3.6:api
-        #
-        # @return [DocumentPool] the new object
-        def initialize(client, user_id=-1)
-            super('DOCUMENT_POOL','DOCUMENT',client)
-
-            @user_id  = user_id
-        end
-
-        #######################################################################
-        # XML-RPC Methods for the Document Object
-        #######################################################################
-
-        # Retrieves all or part of the Documents in the pool.
-        #
-        # @return [nil, OpenNebula::Error] nil in case of success, Error
-        #   otherwise
-        def info(*args)
-            case args.size
-                when 0
-                    info_filter(DOCUMENT_POOL_METHODS[:info],@user_id,-1,-1, document_type)
-                when 3
-                    info_filter(DOCUMENT_POOL_METHODS[:info],args[0],args[1],args[2], document_type)
-            end
-        end
-
-        def info_all()
-            return super(DOCUMENT_POOL_METHODS[:info], document_type)
-        end
-
-        def info_mine()
-            return super(DOCUMENT_POOL_METHODS[:info], document_type)
-        end
-
-        def info_group()
-            return super(DOCUMENT_POOL_METHODS[:info], document_type)
-        end
-
-        def document_type
-            self.class::DOCUMENT_TYPE
-        end
-    end
-end

data/lib/opennebula/document_pool_json.rb

@@ -1,58 +0,0 @@
-# -------------------------------------------------------------------------- #
-# Copyright 2002-2012, OpenNebula Project Leads (OpenNebula.org)             #
-#                                                                            #
-# Licensed under the Apache License, Version 2.0 (the "License"); you may    #
-# not use this file except in compliance with the License. You may obtain    #
-# a copy of the License at                                                   #
-#                                                                            #
-# http://www.apache.org/licenses/LICENSE-2.0                                 #
-#                                                                            #
-# Unless required by applicable law or agreed to in writing, software        #
-# distributed under the License is distributed on an "AS IS" BASIS,          #
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
-# See the License for the specific language governing permissions and        #
-# limitations under the License.                                             #
-#--------------------------------------------------------------------------- #
-
-module OpenNebula
-    class DocumentPoolJSON < DocumentPool
-
-        TEMPLATE_TAG = "BODY"
-
-        def factory(element_xml)
-            doc = OpenNebula::DocumentJSON.new(element_xml, @client)
-            doc.load_body
-            doc
-        end
-
-        # Generates a json representing the object
-        #
-        # @param [true, false] pretty_generate
-        # @return [String] json representing the object
-        #
-        def to_json(pretty_generate=true)
-            hash = self.to_hash
-
-            if hash['DOCUMENT_POOL'] && hash['DOCUMENT_POOL']['DOCUMENT']
-                if !hash['DOCUMENT_POOL']['DOCUMENT'].instance_of?(Array)
-                    array = [hash['DOCUMENT_POOL']['DOCUMENT']]
-                    hash['DOCUMENT_POOL']['DOCUMENT'] = array.compact
-                end
-
-                hash['DOCUMENT_POOL']['DOCUMENT'].each { |doc|
-                    body = doc['TEMPLATE']["#{TEMPLATE_TAG}"]
-                    if body
-                        b_hash = JSON.parse(body)
-                        doc['TEMPLATE']["#{TEMPLATE_TAG}"] = b_hash
-                    end
-                }
-            end
-
-            if pretty_generate
-                JSON.pretty_generate hash
-            else
-                hash.to_json
-            end
-        end
-    end
-end

data/lib/opennebula/error.rb

@@ -1,52 +0,0 @@
-# -------------------------------------------------------------------------- #
-# Copyright 2002-2012, OpenNebula Project Leads (OpenNebula.org)             #
-#                                                                            #
-# Licensed under the Apache License, Version 2.0 (the "License"); you may    #
-# not use this file except in compliance with the License. You may obtain    #
-# a copy of the License at                                                   #
-#                                                                            #
-# http://www.apache.org/licenses/LICENSE-2.0                                 #
-#                                                                            #
-# Unless required by applicable law or agreed to in writing, software        #
-# distributed under the License is distributed on an "AS IS" BASIS,          #
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
-# See the License for the specific language governing permissions and        #
-# limitations under the License.                                             #
-#--------------------------------------------------------------------------- #
-
-
-module OpenNebula
-    # The Error Class represents a generic error in the OpenNebula
-    # library. It contains a readable representation of the error.
-    # Any function in the OpenNebula module will return an Error
-    # object in case of error.
-    class Error
-        ESUCCESS        = 0x0000
-        EAUTHENTICATION = 0x0100
-        EAUTHORIZATION  = 0x0200
-        ENO_EXISTS      = 0x0400
-        EACTION         = 0x0800
-        EXML_RPC_API    = 0x1000
-        EINTERNAL       = 0x2000
-        ENOTDEFINED     = 0x1111
-
-        attr_reader :message, :errno
-
-        # +message+ Description of the error
-        # +errno+   OpenNebula code error
-        def initialize(message=nil, errno=0x1111)
-            @message = message
-            @errno   = errno
-        end
-
-        def to_str()
-            @message
-        end
-    end
-
-    # Returns true if the object returned by a method of the OpenNebula
-    # library is an Error
-    def self.is_error?(value)
-        value.class==OpenNebula::Error
-    end
-end