deltacloud-client-vm 1.1.4.2 → 1.1.4.3

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

@@ -0,0 +1,56 @@
+# 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 Blob < Base
+
+    include DeltacloudVM::Client::Methods::Blob
+    include DeltacloudVM::Client::Methods::Bucket
+
+    # Inherited attributes: :_id, :name, :description
+
+    # Custom attributes:
+    #
+    attr_reader :bucket_id
+    attr_reader :content_length
+    attr_reader :content_type
+    attr_reader :last_modified
+    attr_reader :user_metadata
+
+    # Blob model methods
+    #
+
+    def bucket
+      super(bucket_id)
+    end
+
+    # Parse the Blob entity from XML body
+    #
+    # - xml_body -> DeltacloudVM API XML representation of the blob
+    #
+    def self.parse(xml_body)
+      {
+        :bucket_id => xml_body.text_at(:bucket_id) || xml_body.text_at(:bucket), # FIXME: DC bug
+        :content_length => xml_body.text_at(:content_length),
+        :content_type => xml_body.text_at(:content_type),
+        :last_modified => xml_body.text_at(:last_modified),
+        :user_metadata => xml_body.xpath('user_metadata/entry').inject({}) { |r,e|
+          r[e['key']] = e.text.strip
+          r
+        }
+      }
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# 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 Bucket < Base
+
+    include DeltacloudVM::Client::Methods::Bucket
+    include DeltacloudVM::Client::Methods::Blob
+
+    # Inherited attributes: :_id, :name, :description
+
+    # Custom attributes:
+    #
+    attr_reader :size
+    attr_reader :blob_ids
+
+    # Bucket model methods
+    #
+    #
+
+    # All blobs associated with the current bucket
+    # The 'bucket_id' should not be set in this case.
+    #
+    def blobs(bucket_id=nil)
+      super(_id)
+    end
+
+    # Add a new blob to the bucket.
+    # See: methods/blob.rb +create_blob+
+    #
+    def add_blob(blob_name, blob_data, blob_create_opts={})
+      create_blob(_id, blob_name, blob_data, create_opts)
+    end
+
+    # Remove a blob from the bucket
+    # See: methods/blob.rb +destroy_blob+
+    #
+    def remove_blob(blob_id)
+      destroy_blob(_id, blob_id)
+    end
+
+    # Parse the Bucket entity from XML body
+    #
+    # - xml_body -> DeltacloudVM API XML representation of the bucket
+    #
+    def self.parse(xml_body)
+      {
+        :size => xml_body.text_at(:size),
+        :blob_ids => xml_body.xpath('blob').map { |b| b['id'] }
+      }
+    end
+  end
+end

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

@@ -0,0 +1,87 @@
+# 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 Driver < Base
+
+    attr_reader :providers
+
+    # Syntax sugar for returning provider from Driver
+    # instance:
+    #
+    # client.driver(:ec2)['us-west-1'] # => List of endpoints
+    #
+    # - provider_id -> Provider ID, like 'us-west-1'
+    #
+    def [](provider_id)
+      @providers ||= []
+      prov = @providers.find { |p| p.name == provider_id }
+      prov.instance_variable_set('@client', @client)
+      prov
+    end
+
+    def self.parse(xml_body)
+      {
+        :providers => xml_body.xpath('provider').map { |p| Provider.parse(p) }
+      }
+    end
+
+    class Provider
+
+      attr_reader :name
+      attr_reader :entrypoints
+
+      def initialize(name, entrypoints=[])
+        @name = name
+        @entrypoints = entrypoints
+      end
+
+      # Syntax sugar for retrieving list of endpoints available for the
+      # provider
+      #
+      # - entrypoint_id -> Entrypoint ID, like 's3'
+      #
+      def [](entrypoint_id)
+        @entrypoints ||= []
+        ent_point = @entrypoints.find { |name, _| name == entrypoint_id }
+        ent_point ? ent_point.last : nil
+      end
+
+      # Method to check if given credentials can be used to authorize
+      # connection to current provider:
+      #
+      # client.driver(:ec2)['us-west-1'].valid_credentials? 'user', 'password'
+      #
+      # - api_user -> API key
+      # - api_password -> API secret
+      #
+      def valid_credentials?(api_user, api_password)
+        unless @client
+          raise error.new('Please use driver("ec2")[API_PROVIDER].valid_credentials?')
+        end
+        @client.use(@client.current_driver, api_user, api_password, @name).valid_credentials?
+      end
+
+      def self.parse(p)
+        new(
+          p['id'],
+          p.xpath('entrypoint').inject({}) { |r, e| r[e['kind']] = e.text.strip; r }
+        )
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,64 @@
+# 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 Firewall < Base
+
+    include DeltacloudVM::Client::Methods::Common
+    include DeltacloudVM::Client::Methods::Firewall
+
+    # Inherited attributes: :_id, :name, :description
+
+    # Custom attributes:
+    #
+    attr_reader :owner_id
+    attr_reader :rules
+
+    # Parse the Firewall entity from XML body
+    #
+    # - xml_body -> DeltacloudVM API XML representation of the firewall
+    #
+    def self.parse(xml_body)
+      {
+        :owner_id => xml_body.text_at(:owner_id),
+        :rules => xml_body.xpath('rules/rule').map { |rule|
+          Rule.convert(self, rule)
+        }
+      }
+    end
+
+    class Rule < DeltacloudVM::Client::Base
+
+      attr_reader :allow_protocol
+      attr_reader :port_from
+      attr_reader :port_to
+      attr_reader :direction
+      attr_reader :sources
+
+     def self.parse(xml_body)
+       {
+        :allow_protocol => xml_body.text_at(:allow_protocol),
+        :port_from => xml_body.text_at(:port_from),
+        :port_to => xml_body.text_at(:port_to),
+        :direction => xml_body.text_at(:direction),
+        :sources => xml_body.xpath('sources/source').map { |s|
+          { :name => s['name'], :owner => s['owner'], :type => s['type'] }
+        }
+       }
+     end
+
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# 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 HardwareProfile < Base
+
+    include DeltacloudVM::Client::Helpers
+
+    attr_reader :properties
+
+    def self.parse(hwp)
+      {
+        :properties => hwp.xpath('property').map { |p|
+          property_klass(p['kind']).parse(p)
+        }
+      }
+    end
+
+    def cpu
+      property :cpu
+    end
+
+    def memory
+      property :memory
+    end
+
+    def architecture
+      property :architecture
+    end
+
+    def storage
+      property :storage
+    end
+
+    def opaque?
+      @properties.empty? && @name == 'opaque'
+    end
+
+    private
+
+    def property(name)
+      @properties.find { |p| p.name == name.to_s }
+    end
+
+    def self.property_klass(kind)
+      case kind
+        when 'enum'   then Property::Enum
+        when 'range'  then Property::Range
+        when 'fixed'  then Property::Fixed
+        when 'opaque' then Property::Property
+        else raise error.new("Unknown HWP property: #{kind}")
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,60 @@
+# 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 Image < Base
+
+    attr_reader :owner_id, :architecture, :state
+    attr_reader :creation_time, :root_type, :hardware_profile_ids
+
+    def hardware_profiles
+      @client.hardware_profiles.select { |hwp| @hardware_profile_ids.include?(hwp._id) }
+    end
+
+    def is_compatible?(hardware_profile_id)
+      hardware_profile_ids.include? hardware_profile_id
+    end
+
+    # Launch the image using +Instance+#+create_instance+ method.
+    # This method is more strict in checking +HardwareProfile+
+    # and in case you use incompatible HWP it raise an error.
+    #
+    # - create_instance_opts -> +create_instance+ options
+    #
+    def launch(create_instance_opts={})
+
+      if hwp_id = create_instance_opts[:hwp_id]
+        raise error(:incompatible_hardware_profile).new(
+          "Profile '#{hwp_id}' is not compatible with this image."
+        ) unless is_compatible?(hwp_id)
+      end
+
+      @client.create_instance(self._id, create_instance_opts)
+    end
+
+    def self.parse(xml_body)
+      {
+        :owner_id =>        xml_body.text_at(:owner_id),
+        :architecture =>    xml_body.text_at(:architecture),
+        :state =>           xml_body.text_at(:state),
+        :creation_time =>   xml_body.text_at('creation_time'),
+        :root_type =>       xml_body.text_at('root_type'),
+        :hardware_profile_ids => xml_body.xpath('hardware_profiles/hardware_profile').map { |h|
+          h['id']
+        }
+      }
+    end
+  end
+end

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

@@ -0,0 +1,142 @@
+# 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 Instance < Base
+
+    include DeltacloudVM::Client::Methods::Common
+    include DeltacloudVM::Client::Methods::Instance
+    include DeltacloudVM::Client::Methods::Realm
+    include DeltacloudVM::Client::Methods::HardwareProfile
+    include DeltacloudVM::Client::Methods::Image
+    include DeltacloudVM::Client::Methods::LoadBalancer
+
+    attr_reader :realm_id
+    attr_reader :owner_id
+    attr_reader :image_id
+    attr_reader :hardware_profile_id
+    attr_reader :actions
+
+    attr_accessor :state
+    attr_accessor :public_addresses
+    attr_accessor :private_addresses
+
+    # Destroy the current Instance
+    #
+    def destroy!
+      destroy_instance(_id)
+    end
+
+    # Execute +stop_instance+ method on current Instance
+    #
+    def stop!
+      stop_instance(_id) && reload!
+    end
+
+    # Execute +start_instance+ method on current Instance
+    #
+    def start!
+      start_instance(_id) && reload!
+    end
+
+    # Execute +reboot_instance+ method on current Instance
+    #
+    def reboot!
+      reboot_instance(_id) && reload!
+    end
+
+    # Retrieve the +Realm+ associated with Instance
+    #
+    def realm
+      super(realm_id)
+    end
+
+    def hardware_profile
+      super(hardware_profile_id)
+    end
+
+    def image
+      super(image_id)
+    end
+
+    def method_missing(name, *args)
+      return self.state.downcase == $1 if name.to_s =~ /^is_(\w+)\?$/
+      super
+    end
+
+    def can_create_image?
+      actions.include? :create_image
+    end
+
+    def create_image(create_opts={})
+      return false unless can_create_image?
+      super(_id, create_opts)
+    end
+
+    def register_instance(load_balancer_id)
+      super(load_balancer_id, _id)
+    end
+
+    def unregister_instance(load_balancer_id)
+      super(load_balancer_id, _id)
+    end
+
+    # Helper for is_STATE?
+    #
+    # is_running?
+    # is_stopped?
+    #
+    def method_missing(name, *args)
+      if name =~ /^is_(\w+)\?$/
+        return state == $1.upcase
+      end
+      super
+    end
+
+    class << self
+
+      def parse(xml_body)
+        {
+          :state =>               xml_body.text_at('state'),
+          :owner_id =>            xml_body.text_at('owner_id'),
+          :realm_id =>            xml_body.attr_at('realm', :id),
+          :image_id =>            xml_body.attr_at('image', :id),
+          :hardware_profile_id => xml_body.attr_at('hardware_profile', :id),
+          :public_addresses => InstanceAddress.convert(
+            xml_body.xpath('public_addresses/address')
+          ),
+          :private_addresses => InstanceAddress.convert(
+            xml_body.xpath('private_addresses/address')
+          ),
+          :actions => xml_body.xpath('actions/link').map { |a| a['rel'].to_sym }
+        }
+      end
+
+    end
+
+    # Attempt to reload :public_addresses, :private_addresses and :state
+    # of the instance, after the instance is modified by calling method
+    #
+    def reload!
+      new_instance = instance(_id)
+      update_instance_variables!(
+        :public_addresses => new_instance.public_addresses,
+        :private_addresses => new_instance.private_addresses,
+        :state => new_instance.state
+      )
+    end
+
+  end
+end