deltacloud-client-vm 1.1.4.2 → 1.1.4.3

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

@@ -0,0 +1,67 @@
+# 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 Address
+
+      # Retrieve list of all address entities
+      #
+      # filter_opts:
+      # - :id -> Filter entities using 'id' attribute
+      #
+      def addresses(filter_opts={})
+        from_collection :addresses,
+        connection.get(api_uri('addresses'), filter_opts)
+      end
+
+      # Retrieve the single address entity
+      #
+      # - address_id -> Address entity to retrieve
+      #
+      def address(address_id)
+        from_resource :address,
+          connection.get(api_uri("addresses/#{address_id}"))
+      end
+
+      # Create a new address
+      #
+      def create_address
+        create_resource :address, {}
+      end
+
+      def destroy_address(address_id)
+        destroy_resource :address, address_id
+      end
+
+      def associate_address(address_id, instance_id)
+        result = connection.post(
+          api_uri("/addresses/#{address_id}/associate")
+        ) do |request|
+          request.params = { :instance_id => instance_id }
+        end
+        result.status == 202
+      end
+
+      def disassociate_address(address_id)
+        result = connection.post(
+          api_uri("/addresses/#{address_id}/disassociate")
+        )
+        result.status == 202
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+# 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 Api
+
+      def path
+        connection.url_prefix.path
+      end
+
+      def api_uri(uri)
+        URI.parse([path, uri.gsub(/^(\/+)/,'')].join('/'))
+      end
+
+      # The current version of DeltacloudVM API
+      #
+      def version
+        entrypoint.to_xml.root['version']
+      end
+
+      alias_method :api_version, :version
+
+      # The current driver the @connection is using
+      #
+      def current_driver
+        entrypoint.to_xml.root['driver']
+      end
+
+      alias_method :api_driver,   :current_driver
+      alias_method :driver_name,  :current_driver
+
+      # The current provider the @connection is using
+      #
+      def current_provider
+        entrypoint.to_xml.root['provider']
+      end
+
+      # List of the currently supported collections by @connection
+      #
+      def supported_collections
+        entrypoint.to_xml.root.xpath('link').map { |l| l['rel'] }
+      end
+
+      alias_method :entrypoints, :supported_collections
+
+      # Syntax sugar for +supported_collections+
+      # Return 'true' if the collection is supported by current API entrypoint
+      #
+      def support?(collection)
+        supported_collections.include? collection.to_s
+      end
+
+      # Syntax sugar for Method modules, where you can 'require' the support
+      # for the given collection before you execute API call
+      #
+      # Raise +NotSupported+ exception if the given +collection+ is not
+      # supported
+      #
+      def must_support!(collection)
+        unless support?(collection)
+          raise error(:not_supported).new("Collection '#{collection}' not supported by current API endpoint.")
+        end
+      end
+
+      # +Hash+ of all features supported by current connection
+      #
+      def features
+        entrypoint.to_xml.root.xpath('link/feature').inject(Hash.new(Array.new)) do |result, feature|
+          result[feature.parent['rel']] += [feature['name']]
+          result
+        end
+      end
+
+      # Check if the current collection support given feature for given
+      # collection
+      #
+      def feature?(collection_name, feature_name)
+        features[collection_name.to_s].include?(feature_name.to_s)
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# 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 BackwardCompatibility
+
+      # Backward compatibility methods provides fallback for the
+      # old deltacloud-client gem.
+      #
+      #
+      def api_host
+        connection.url_prefix.host
+      end
+
+      def api_port
+        connection.url_prefix.port
+      end
+
+      def connect(&block)
+        yield self.clone
+      end
+
+      def with_config(opts, &block)
+        yield inst = use(
+          opts[:driver],
+          opts[:username],
+          opts[:password],
+          opts[:provider]
+        ) if block_given?
+        inst
+      end
+
+      def use_driver(new_driver, opts={})
+        with_config(opts.merge(:driver => new_driver))
+      end
+
+      alias_method :"use_config!", :use_driver
+
+      def discovered?
+        true unless entrypoint.nil?
+      end
+
+      module ClassMethods
+
+        def valid_credentials?(api_user, api_password, api_url, opts={})
+          args = {
+            :api_user => api_user,
+            :api_password => api_password,
+            :url => api_url
+          }
+          args.merge!(:providers => opts[:provider]) if opts[:provider]
+          DeltacloudVM::Client::Connection.new(args).valid_credentials?
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+# 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 Blob
+
+      # Retrieve a list of all blob entities from given bucket
+      #
+      def blobs(bucket_id=nil)
+        raise error.new("The :bucket_id cannot be nil.") if bucket_id.nil?
+        bucket(bucket_id).blob_ids.map { |blob_id| blob(bucket_id, blob_id) }
+      end
+
+      # Retrieve the single blob entity
+      #
+      # - blob_id -> Blob entity to retrieve
+      #
+      def blob(bucket_id, blob_id)
+        model(:blob).convert(
+          self,
+          connection.get(api_uri("buckets/#{bucket_id}/#{blob_id}"))
+        )
+      end
+
+      # Create a new blob
+      #
+      # - bucket_id -> A bucket ID that new blob should belong to
+      # - blob_name -> A name for new blob
+      # - blob_data -> Data stored in this blob
+      # - create_opts
+      #   - :user_metadata -> A Ruby +Hash+ with key => value metadata
+      #
+      def create_blob(bucket_id, blob_name, blob_data, create_opts={})
+        must_support! :buckets
+        create_opts.merge!(convert_meta_params(create_opts.delete(:user_metadata)))
+        response = connection.post(api_uri("buckets/#{bucket_id}")) do |request|
+          request.params = create_opts.merge(
+            :blob_id => blob_name,
+            :blob_data => blob_data
+        )
+        end
+        model(:blob).convert(self, response.body)
+      end
+
+      # Destroy given bucket blob
+      #
+      def destroy_blob(bucket_id, blob_id)
+        must_support! :buckets
+        r = connection.delete(api_uri("buckets/#{bucket_id}/#{blob_id}"))
+        r.status == 204
+      end
+
+      private
+
+      # Convert the user_metadata into POST params compatible with
+      # blob creation
+      #
+      # - params -> Simple Ruby +Hash+
+      #
+      # @return { :meta_params => COUNTER, :meta_name1 => '', :meta_value1 => ''}
+      #
+      def convert_meta_params(params)
+        meta_params = {}
+        counter = 0
+        (params || {}).each do |key, value|
+          counter += 1
+          meta_params["meta_name#{counter}"] = key
+          meta_params["meta_value#{counter}"] = value
+        end
+        if counter >= 1
+          meta_params.merge!(:meta_params => counter.to_s)
+        end
+        meta_params
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# 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 Bucket
+
+      # Retrieve list of all bucket entities
+      #
+      # - filter_opts:
+      #   - :id -> Filter entities using 'id' attribute
+      #
+      def buckets(filter_opts={})
+        from_collection :buckets,
+          connection.get(api_uri('buckets'), filter_opts)
+      end
+
+      # Retrieve the single bucket entity
+      #
+      # - bucket_id -> Bucket entity to retrieve
+      #
+      def bucket(bucket_id)
+        from_resource :bucket,
+          connection.get(api_uri("buckets/#{bucket_id}"))
+      end
+
+      # Create a new bucket
+      #
+      # - name: Bucket name
+      #
+      def create_bucket(name)
+        create_resource :bucket, :name => name
+      end
+
+      # Destroy given bucket
+      #
+      def destroy_bucket(bucket_id)
+        destroy_resource :bucket, bucket_id
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# 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 Common
+
+      # A generic method for creating a new resources
+      #
+      # - resource_name -> A resource name to create (eg. :image)
+      # - create_opts -> HTTP options to pass into the create operation
+      #
+      def create_resource(resource_name, create_opts={})
+        no_convert_model = create_opts.delete(:no_convert_model)
+        must_support! resource_name.to_s.pluralize
+        response = connection.post(api_uri(resource_name.to_s.pluralize)) do |request|
+          request.params = create_opts
+        end
+        no_convert_model ? response : model(resource_name).convert(self, response.body)
+      end
+
+      # A generic method for destroying resources
+      #
+      def destroy_resource(resource_name, resource_id)
+        must_support! resource_name.to_s.pluralize
+        result = connection.delete(
+          api_uri([resource_name.to_s.pluralize, resource_id].join('/'))
+        )
+        result.status.is_no_content?
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# 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 Driver
+
+      # Retrieve list of all drivers
+      #
+      # - filter_opt:
+      #   - :id -> Filter drivers using their 'id'
+      #   - :state -> Filter drivers  by their 'state'
+      #
+      def drivers(filter_opts={})
+        from_collection(
+          :drivers,
+          connection.get(api_uri('drivers'), filter_opts)
+        )
+      end
+
+      # Retrieve the given driver
+      #
+      # - driver_id -> Driver to retrieve
+      #
+      def driver(driver_id)
+        from_resource(
+          :driver,
+          connection.get(api_uri("drivers/#{driver_id}"))
+        )
+      end
+
+      # List of the current driver providers
+      #
+      def providers
+        driver(current_driver).providers
+      end
+
+    end
+
+  end
+end