deltacloud-client 1.1.2 → 1.1.3

data/lib/deltacloud/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/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 Deltacloud::Client
+  class Address < Base
+    include Deltacloud::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 -> Deltacloud 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/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 Deltacloud::Client
+
+  class Base
+
+    extend Helpers::XmlHelper
+
+    include Deltacloud::Client::Helpers::Model
+    include Deltacloud::Client::Methods::Api
+
+    # These attributes are common for all models
+    #
+    # - obj_id -> The :id of Deltacloud 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 Deltacloud::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 Deltacloud 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 Deltacloud 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 Deltacloud API
+      # to +Hash+. Result is then used to create an instance of Deltacloud 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 Deltacloud 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

data/lib/deltacloud/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 Deltacloud::Client
+  class Blob < Base
+
+    include Deltacloud::Client::Methods::Blob
+    include Deltacloud::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 -> Deltacloud 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/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 Deltacloud::Client
+  class Bucket < Base
+
+    include Deltacloud::Client::Methods::Bucket
+    include Deltacloud::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 -> Deltacloud 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/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 Deltacloud::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