deltacloud-client-vm 1.1.4.2 → 1.1.4.3

data/lib/deltacloud_vm/client/methods/metric.rb

@@ -0,0 +1,54 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you 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 DeltacloudVM::Client
+  module Methods
+    module Metric
+
+      # Retrieve list of all metric entities
+      #
+      # Filter options:
+      #
+      # - :id -> Filter entities using 'id' attribute
+      #
+      def metrics(filter_opts={})
+        from_collection :metrics,
+        connection.get(api_uri('metrics'), filter_opts)
+      end
+
+      # Retrieve the single metric entity
+      #
+      # - metric_id -> Metric entity to retrieve
+      #
+      def metric(metric_id)
+        from_resource :metric,
+          connection.get(api_uri("metrics/#{metric_id}"))
+      end
+
+      # Create a new metric
+      #
+      # - create_opts
+      #
+      # def create_metric(create_opts={})
+      #   must_support! :metrics
+      #    response = connection.post(api_uri('metrics')) do |request|
+      #     request.params = create_opts
+      #   end
+      #   model(:metric).convert(self, response.body)
+      # end
+
+    end
+  end
+end

data/lib/deltacloud_vm/client/methods/realm.rb

@@ -0,0 +1,42 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you 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 DeltacloudVM::Client
+  module Methods
+    module Realm
+
+      # Retrieve list of all realms
+      #
+      # - filter_opts:
+      #   - :id -> Filter realms using their 'id'
+      #   - :state -> Filter realms  by their 'state'
+      #
+      def realms(filter_opts={})
+        from_collection :realms,
+          connection.get(api_uri("realms"), filter_opts)
+      end
+
+      # Retrieve the given realm
+      #
+      # - realm_id -> Instance to retrieve
+      #
+      def realm(realm_id)
+        from_resource :realm,
+          connection.get(api_uri("realms/#{realm_id}"))
+      end
+
+    end
+  end
+end

data/lib/deltacloud_vm/client/methods/storage_snapshot.rb

@@ -0,0 +1,61 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you 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 DeltacloudVM::Client
+  module Methods
+    module StorageSnapshot
+
+      # Retrieve list of all storage_snapshot entities
+      #
+      # - filter_options:
+      #   - :id -> Filter entities using 'id' attribute
+      #
+      def storage_snapshots(filter_opts={})
+        from_collection :storage_snapshots,
+          connection.get(api_uri('storage_snapshots'), filter_opts)
+      end
+
+      # Retrieve the single storage_snapshot entity
+      #
+      # - storage_snapshot_id -> StorageSnapshot entity to retrieve
+      #
+      def storage_snapshot(storage_snapshot_id)
+        from_resource :storage_snapshot,
+          connection.get(api_uri("storage_snapshots/#{storage_snapshot_id}"))
+      end
+
+      # Create a new StorageSnapshot based on +volume_id+
+      #
+      # - volume_id -> ID of the +StorageVolume+ to create snapshot from
+      # - create_opts ->
+      #   - :name -> Name of the StorageSnapshot
+      #   - :description -> Description of the StorageSnapshot
+      #
+      def create_storage_snapshot(volume_id, create_opts={})
+        create_resource :storage_snapshot, create_opts.merge(:volume_id => volume_id)
+      end
+
+      # Destroy the current +StorageSnapshot+
+      # Returns 'true' if the response was 204 No Content
+      #
+      # - snapshot_id -> The 'id' of the snapshot to destroy
+      #
+      def destroy_storage_snapshot(snapshot_id)
+        destroy_resource :storage_snapshot, snapshot_id
+      end
+
+    end
+  end
+end

data/lib/deltacloud_vm/client/methods/storage_volume.rb

@@ -0,0 +1,94 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you 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 DeltacloudVM::Client
+  module Methods
+    module StorageVolume
+
+      # Retrieve list of all storage_volumes
+      #
+      # - filter_opts:
+      #   - :id -> Filter storage_volumes using their 'id'
+      #   - :state -> Filter storage_volumes  by their 'state'
+      #
+      def storage_volumes(filter_opts={})
+        from_collection :storage_volumes,
+          connection.get(api_uri("storage_volumes"), filter_opts)
+      end
+
+      # Retrieve the given storage_volume
+      #
+      # - storage_volume_id -> Instance to retrieve
+      #
+      def storage_volume(storage_volume_id)
+        from_resource :storage_volume,
+          connection.get(api_uri("storage_volumes/#{storage_volume_id}"))
+      end
+
+      # Create new storage volume
+      #
+      # - :snapshot_id -> Snapshot to use for creating a new volume
+      # - :capacity    -> Initial Volume capacity
+      # - :realm_id    -> Create volume in this realm
+      # - :name        -> Volume name
+      # - :description -> Volume description
+      #
+      # NOTE: Some create options might not be supported by backend cloud
+      #
+      def create_storage_volume(create_opts={})
+        create_resource :storage_volume, create_opts
+      end
+
+      # Destroy the current +StorageVolume+
+      # Returns 'true' if the response was 204 No Content
+      #
+      # - volume_id -> The 'id' of the volume to destroy
+      #
+      def destroy_storage_volume(volume_id)
+        destroy_resource :storage_volume, volume_id
+      end
+
+      # Attach the Storage Volume to the Instance
+      # The +device+ parameter could be used if supported.
+      #
+      # - volume_id -> Volume ID (eg. 'vol1')
+      # - instance_id -> Target Instance ID (eg. 'inst1')
+      # - device -> Target device in Instance (eg. '/dev/sda2')
+      #
+      def attach_storage_volume(volume_id, instance_id, device=nil)
+        must_support! :storage_volumes
+        result = connection.post(api_uri("/storage_volumes/#{volume_id}/attach")) do |r|
+          r.params = { :instance_id => instance_id, :device => device }
+        end
+        if result.status.is_ok?
+          from_resource(:storage_volume, result)
+        end
+      end
+
+      # Detach the Storage Volume from the Instance
+      #
+      # -volume_id -> Volume to detach
+      #
+      def detach_storage_volume(volume_id)
+        must_support! :storage_volumes
+        result = connection.post(api_uri("/storage_volumes/#{volume_id}/detach"))
+        if result.status.is_ok?
+          from_resource(:storage_volume, result)
+        end
+      end
+
+    end
+  end
+end

data/lib/deltacloud_vm/client/models.rb

@@ -0,0 +1,32 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you 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_relative './models/base'
+require_relative './models/address'
+require_relative './models/blob'
+require_relative './models/bucket'
+require_relative './models/driver'
+require_relative './models/firewall'
+require_relative './models/hardware_profile'
+require_relative './models/image'
+require_relative './models/instance_address'
+require_relative './models/instance'
+require_relative './models/instance_state'
+require_relative './models/key'
+require_relative './models/realm'
+require_relative './models/storage_volume'
+require_relative './models/storage_snapshot'
+require_relative './models/load_balancer'
+require_relative './models/metric'

data/lib/deltacloud_vm/client/models/address.rb

@@ -0,0 +1,57 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you 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 DeltacloudVM::Client
+  class Address < Base
+    include DeltacloudVM::Client::Methods::Address
+
+    # Inherited attributes: :_id, :name, :description
+
+    # Custom attributes:
+    #
+    attr_reader :ip
+    attr_reader :instance_id
+
+    # Address model methods
+    #
+
+    # Associate the IP address to the +Instance+
+    #
+    def associate(instance_id)
+      associate_address(_id, instance_id)
+    end
+
+    # Disassociate the IP address from +Instance+
+    #
+    def disassociate
+      disassociate_address(_id)
+    end
+
+    def destroy!
+      destroy_address(_id)
+    end
+
+    # Parse the Address entity from XML body
+    #
+    # - xml_body -> DeltacloudVM API XML representation of the address
+    #
+    def self.parse(xml_body)
+      {
+        :ip => xml_body.text_at(:ip),
+        :instance_id => xml_body.attr_at('instance', :id)
+      }
+    end
+  end
+end

data/lib/deltacloud_vm/client/models/base.rb

@@ -0,0 +1,153 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you 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 DeltacloudVM::Client
+
+  class Base
+
+    extend Helpers::XmlHelper
+
+    include DeltacloudVM::Client::Helpers::Model
+    include DeltacloudVM::Client::Methods::Api
+
+    # These attributes are common for all models
+    #
+    # - obj_id -> The :id of DeltacloudVM API model (eg. instance ID)
+    #
+    attr_reader :obj_id
+    attr_reader :url
+    attr_reader :name
+    attr_reader :description
+
+    # The Base class that other models should inherit from
+    # To initialize, you need to supply these mandatory params:
+    #
+    # - :_client -> Reference to Client instance
+    # - :_id     -> The 'id' of resource. The '_' is there to avoid conflicts
+    #
+    def initialize(opts={})
+      @options = opts
+      @obj_id = @options.delete(:_id)
+      # Do not allow to modify the object#base_id
+      @obj_id.freeze
+      @client = @options.delete(:_client)
+      @original_body = @options.delete(:original_body)
+      update_instance_variables!(@options)
+    end
+
+    alias_method :_id, :obj_id
+
+    # Populate instance variables in model
+    # This method could also be used to update the variables for already
+    # initialized models. Look at +Instance#reload!+ method.
+    #
+    def update_instance_variables!(opts={})
+      @options.merge!(opts)
+      @options.each { |key, val| self.instance_variable_set("@#{key}", val) unless val.nil? }
+      self
+    end
+
+    # Eye-candy representation of model, without ugly @client representation
+    #
+    def to_s
+      "#<#{self.class.name}> #{@options.merge(:_id => @obj_id).inspect}"
+    end
+
+    # An internal reference to the current DeltacloudVM::Client::Connection
+    # instance. Used for implementing the model methods
+    #
+    def client
+      @client
+    end
+
+    # Shorthand for +client+.connection
+    #
+    # Return Faraday connection object.
+    #
+    def connection
+      client.connection
+    end
+
+    # Return the cached version of DeltacloudVM API entrypoint
+    #
+    def entrypoint
+      client.entrypoint
+    end
+
+    # Return the original XML body model was constructed from
+    # This might help debugging broken XML
+    #
+    def original_body
+      @original_body
+    end
+
+    # The model#id is the old way for getting the DeltacloudVM API resource
+    # 'id'. However this collide with the Ruby Object#id.
+    #
+    def id
+      warn '[DEPRECATION] `id` is deprecated because of a possible conflict with Object#id. Use `_id` instead.'
+      _id
+    end
+
+    class << self
+
+      # Parse the XML response body from DeltacloudVM API
+      # to +Hash+. Result is then used to create an instance of DeltacloudVM model
+      #
+      # NOTE: Children classes **must** implement this class method
+      #
+      def parse(client_ref, inst)
+        warn "The self#parse method **must** be defined in #{self.class.name}"
+        {}
+      end
+
+      # Convert the parsed +Hash+ from +parse+ method to instance of DeltacloudVM model
+      #
+      # - client_ref -> Reference to the Client instance
+      # - obj -> Might be a Nokogiri::Element or Response
+      #
+      def convert(client_ref, obj)
+        body = extract_xml_body(obj).to_xml.root
+        attrs = parse(body)
+        attrs.merge!({
+          :_id => body['id'],
+          :url => body['href'],
+          :_client => client_ref,
+          :name => body.text_at(:name),
+          :description => body.text_at(:description)
+        })
+        validate_attrs!(attrs)
+        new(attrs.merge(:original_body => obj))
+      end
+
+      # Convert response for the collection responses.
+      #
+      def from_collection(client_ref, response)
+        response.body.to_xml.xpath('/*/*').map do |entity|
+          convert(client_ref, entity)
+        end
+      end
+
+      # The :_id and :_client attributes are mandotory
+      # to construct a Base model object.
+      #
+      def validate_attrs!(attrs)
+        raise error.new('The :_id must not be nil.') if attrs[:_id].nil?
+        raise error.new('The :_client reference is missing.') if attrs[:_client].nil?
+      end
+
+    end
+  end
+end