azure 0.6.0 → 0.6.1

data/lib/azure/storage_management/serialization.rb

@@ -1,50 +1,190 @@
-#-------------------------------------------------------------------------
-# Copyright 2013 Microsoft Open Technologies, Inc.
-#
-# 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 'base64'
-require 'azure/storage_management/storage_account'
-
-module Azure
-  module StorageManagement
-    module Serialization
-      def self.storage_services_to_xml(name, options={})
-        builder = Nokogiri::XML::Builder.new do |xml|
-          xml.CreateStorageServiceInput('xmlns'=>'http://schemas.microsoft.com/windowsazure') {
-            xml.ServiceName name
-            xml.Label Base64.encode64(name)
-            xml.Description options[:description] || 'Explicitly created storage service'
-            if !options[:affinity_group_name].nil?
-              xml.AffinityGroup options[:affinity_group_name]
-            else
-              xml.Location options[:location]
-            end
-          }
-        end
-        builder.doc.to_xml
-      end
-      
-      def self.storage_services_from_xml(storageXML)
-        storage_accounts = []
-        storage_servicesXML = storageXML.css('StorageServices StorageService')
-        storage_servicesXML.each do |storage_service_xml|
-          storage_account = StorageAccount.new
-          storage_account.name = xml_content(storage_service_xml, 'ServiceName')
-          storage_accounts << storage_account
-        end
-        storage_accounts.compact
-      end
-
-    end
-  end
-end
+#-------------------------------------------------------------------------
+# Copyright 2013 Microsoft Open Technologies, Inc.
+#
+# 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 'base64'
+require 'azure/storage_management/storage_account'
+
+module Azure
+  module StorageManagement
+    # Storage management serialization module is responsible for converting
+    # the objects to XML and vice versa.
+    module Serialization
+      def self.storage_services_to_xml(name, options = {})
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.CreateStorageServiceInput(
+            'xmlns' => 'http://schemas.microsoft.com/windowsazure'
+          ) do
+            xml.ServiceName(name)
+            label = options[:label] || name
+            xml.Label(Base64.encode64(label))
+            xml.Description options[:description]\
+              || 'Explicitly created storage service'
+            unless options[:affinity_group_name].nil?
+              xml.AffinityGroup options[:affinity_group_name]
+            else
+              xml.Location options[:location]
+            end
+            add_options_to_xml(xml, options)
+          end
+        end
+        builder.doc.to_xml
+      end
+
+      def self.storage_services_from_xml(storage_xml)
+        storage_accounts = []
+        storage_services_xml = storage_xml.css('StorageService')
+        storage_services_xml.each do |storage_service_xml|
+          storage_account = StorageAccount.new
+
+          storage_account.url = xml_content(storage_service_xml, 'Url')
+          storage_account.name = xml_content(
+            storage_service_xml, 'ServiceName'
+          )
+
+          storage_service_properties = storage_service_xml.css(
+            'StorageServiceProperties'
+          )
+
+          storage_account.description = xml_content(
+            storage_service_properties, 'Description'
+          )
+          storage_account.affinity_group = xml_content(
+            storage_service_properties, 'AffinityGroup'
+          )
+          storage_account.location = xml_content(
+            storage_service_properties, 'Location'
+          )
+          storage_account.label = Base64.decode64(
+            xml_content(storage_service_properties, 'Label')
+          )
+          storage_account.status = xml_content(
+            storage_service_properties, 'Status'
+          )
+          storage_account.endpoints = storage_service_properties.css(
+            'Endpoints Endpoint'
+          ).map { |endpoint| endpoint.content }
+          storage_account.geo_replication_enabled = xml_content(
+            storage_service_properties, 'GeoReplicationEnabled'
+          )
+          storage_account.geo_primary_region = xml_content(
+            storage_service_properties, 'GeoPrimaryRegion'
+          )
+          storage_account.status_of_primary = xml_content(
+            storage_service_properties, 'StatusOfPrimary'
+          )
+          storage_account.last_geo_failover_time = xml_content(
+            storage_service_properties, 'LastGeoFailoverTime'
+          )
+          storage_account.geo_secondary_region = xml_content(
+            storage_service_properties, 'GeoSecondaryRegion'
+          )
+          storage_account.status_of_secondary = xml_content(
+            storage_service_properties, 'StatusOfSecondary'
+          )
+          storage_account.creation_time = xml_content(
+            storage_service_properties, 'CreationTime'
+          )
+          storage_account.extended_properties = storage_service_xml.css(
+            'ExtendedProperties ExtendedProperty'
+          ).map do |prop|
+            {
+              name: xml_content(prop, 'Name'),
+              value: xml_content(prop, 'Value')
+            }
+          end
+
+          storage_accounts << storage_account
+        end
+
+        # returns the first storage account if only one found
+        # This will be the case when calling the get_storage_account_properties
+        # API or if only one storage account exists for the subscription
+        return storage_accounts.first if storage_accounts.size == 1
+
+        # returns all the storage accounts, if more than 1 found
+        storage_accounts.compact
+      end
+
+      def self.storage_update_to_xml(options)
+        # Cannot update if options is nil or empty
+        fail 'No options specified' if options.nil? || options.empty?
+
+        # Either one of Label, or Description is required.
+        if (options[:label].nil? || options[:label].empty?) &&
+           (options[:description].nil? || options[:description].empty?)
+          fail 'Either one of Label or Description'\
+                ' has to be provided. Both cannot be empty'
+        end
+
+        # The input param may not be nil or empty, but the values inside may
+        # be. Check if atleast one value exists before proceeding.
+        is_empty = true
+        options.each do |option, value|
+          case option
+          when :description, :label
+            is_empty = value.nil? || value.empty?
+          when :geo_replication_enabled
+            is_empty = !(value.kind_of?(TrueClass)\
+              || value.kind_of?(FalseClass))
+          when :extended_properties
+            value.each do |p, v|
+              is_empty = ((p.nil? || p.empty?) || (v.nil? || v.empty?))
+              break unless is_empty
+            end
+          end
+
+          break unless is_empty
+        end
+
+        # Raise a RuntimeError if no options were provided
+        fail 'No Options Specified' if is_empty
+
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.UpdateStorageServiceInput(
+            'xmlns' => 'http://schemas.microsoft.com/windowsazure'
+          ) do
+            # Check if label is nil. Use description only if label is nil
+            if options[:label].nil? || options[:label].empty?
+              desc = options[:description]
+              xml.Description(desc) unless desc.nil? || desc.empty?
+            else
+              label = Base64.encode64(options[:label])
+              xml.Label(label) unless label.nil? || label.empty?
+            end
+            add_options_to_xml(xml, options)
+          end
+        end
+        builder.to_xml
+      end
+
+      def self.add_options_to_xml(xml, options = {})
+        gre = options[:geo_replication_enabled]
+        xml.GeoReplicationEnabled(
+          gre
+        ) unless gre.nil?\
+          || !(gre.kind_of?(TrueClass) || gre.kind_of?(FalseClass))
+        xml.ExtendedProperties do
+          options[:extended_properties].each do |name, value|
+            xml.ExtendedProperty do
+              xml.Name name
+              xml.Value value
+            end unless (name.nil? || name.empty?)\
+              || (value.nil? || value.empty?)
+          end
+        end unless options[:extended_properties].nil?\
+          || options[:extended_properties].empty?
+      end
+    end
+  end
+end

data/lib/azure/storage_management/storage_account.rb

@@ -1,29 +1,40 @@
-#-------------------------------------------------------------------------
-# Copyright 2013 Microsoft Open Technologies, Inc.
-#
-# 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 Azure
-  module StorageManagement
-    class StorageAccount
-
-      def initialize
-        yield self if block_given?
-      end
-
-      attr_accessor :name
-      attr_accessor :description
-      attr_accessor :location
-
-    end
-  end
-end
+#-------------------------------------------------------------------------
+# Copyright 2013 Microsoft Open Technologies, Inc.
+#
+# 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 Azure
+  module StorageManagement
+    # Represents a Windows Azure storage account
+    class StorageAccount
+      def initialize
+        yield self if block_given?
+      end
+      attr_accessor :url
+      attr_accessor :name
+      attr_accessor :description
+      attr_accessor :location
+      attr_accessor :affinity_group
+      attr_accessor :label
+      attr_accessor :status
+      attr_accessor :endpoints
+      attr_accessor :geo_replication_enabled
+      attr_accessor :geo_primary_region
+      attr_accessor :status_of_primary
+      attr_accessor :last_geo_failover_time
+      attr_accessor :geo_secondary_region
+      attr_accessor :status_of_secondary
+      attr_accessor :creation_time
+      attr_accessor :extended_properties
+    end
+  end
+end

data/lib/azure/storage_management/storage_management_service.rb

@@ -1,99 +1,166 @@
-#-------------------------------------------------------------------------
-# Copyright 2013 Microsoft Open Technologies, Inc.
-#
-# 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 'azure/storage_management/serialization'
-
-module Azure
-  module StorageManagement
-    class StorageManagementService < BaseManagementService
-
-      def initialize
-        super()
-      end
-      
-      # Public: Gets a list of storage accounts available under the current subscription.
-      #
-      # Returns an array of Azure::StorageManagement::StorageAccount objects
-      def list_storage_accounts
-        request_path = "/services/storageservices"
-        request = ManagementHttpRequest.new(:get, request_path, nil)
-        response = request.call
-        Serialization.storage_services_from_xml(response)
-      end
-
-      # Public: Checks to see if the specified storage account is available
-      #
-      # ==== Attributes
-      #
-      # * +name+       - String. Storage account name.
-      #
-      # Returns: A boolean value indicating whether the storage account exists.
-      # If true, the storage account exists. If false, the storage account does not exist.
-      def get_storage_account(name)
-        return false if name.nil?
-        flag = false
-        storage_accounts = Azure::StorageManagementService.new.list_storage_accounts
-        storage_accounts.each do |storage|
-          if storage.name == name
-            flag = true
-            break
-          end
-        end
-        flag
-      end
-
-      # Public: Create a new storage account in Windows Azure.
-      #
-      # ==== Attributes
-      #
-      # * +name+          - String. The name of the storage service.
-      # * +options+       - Hash. Optional parameters.
-      #
-      # ==== Options
-      #
-      # Accepted key/value pairs in options parameter are:
-      # * +:location+            - String. The location where the storage service will be created.(optional)
-      # * +:description+         - String. A description for the storage service. (optional)
-      #
-      # Returns None
-      def create_storage_account(name, options={})
-        if get_storage_account(name)
-          Loggerx.warn "Storage Account #{name} already exists. Skipped..."
-        else
-          Loggerx.info "Creating Storage Account #{name}."
-          body = Serialization.storage_services_to_xml(name, options)
-          request_path = "/services/storageservices"
-          request = ManagementHttpRequest.new(:post, request_path, body)
-          request.call
-        end
-      end
-
-      # Public: Deletes the specified storage account of given subscription id from Windows Azure.
-      #
-      # ==== Attributes
-      #
-      # * +name+       - String. Storage account name.
-      #
-      # Returns:  None
-      def delete_storage_account(name)
-        Loggerx.info "Deleting Storage Account #{name}."
-        request_path = "/services/storageservices/#{name}"
-        request = ManagementHttpRequest.new(:delete, request_path)
-        request.call
-      rescue Exception => e
-        e.message
-      end
-    end
-  end
-end
+#-------------------------------------------------------------------------
+# Copyright 2013 Microsoft Open Technologies, Inc.
+#
+# 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 'azure/storage_management/serialization'
+
+module Azure
+  module StorageManagement
+    # Provides Storage Management API
+    class StorageManagementService < BaseManagementService
+      def initialize
+        super()
+      end
+      # Public: Gets a list of storage accounts available under the
+      # current subscription.
+      #
+      # Returns an array of Azure::StorageManagement::StorageAccount objects
+      def list_storage_accounts
+        request_path = '/services/storageservices'
+        request = ManagementHttpRequest.new(:get, request_path, nil)
+        response = request.call
+        Serialization.storage_services_from_xml(response)
+      end
+
+      # Public: Checks to see if the specified storage account is available
+      #
+      # ==== Attributes
+      #
+      # * +name+       - String. Storage account name.
+      #
+      # Returns: A boolean value indicating whether the storage account exists.
+      # If true, the storage account exists. If false, the storage account
+      # does not exist.
+      def get_storage_account(name)
+        return false if name.nil?
+        flag = false
+        storage_accounts = list_storage_accounts
+        storage_accounts.each do |storage|
+          if storage.name == name
+            flag = true
+            break
+          end
+        end
+        flag
+      end
+
+      # Public: Gets the properties of the storage account specified.
+      # 
+      # ==== Attributes
+      #
+      # * +name+  - String. The name of the storage account. Required.
+      #
+      # See http://msdn.microsoft.com/en-us/library/windowsazure/ee460802.aspx
+      # 
+      # Returns the storage account
+      def get_storage_account_properties(name)
+        request_path = "/services/storageservices/#{name}"
+        request = ManagementHttpRequest.new(:get, request_path, nil)
+        response = request.call
+        Serialization.storage_services_from_xml(response)
+      end
+
+      # Public: Create a new storage account in Windows Azure.
+      #
+      # ==== Attributes
+      #
+      # * +name+          - String. The name of the storage service.
+      # * +options+       - Hash. Optional parameters.
+      #
+      # ==== Options
+      #
+      # Accepted key/value pairs in options parameter are:
+      # * +:label+  - String. The label for this storage account. The name will
+      # be used as label if none specified. (optional)
+      # * +:location+  - String. The location where the storage
+      # service will be created. Reqruied if no affinity_group_name specified.
+      # * +:description+         - String. A description for the storage
+      # service. (optional)
+      # * +:affinity_group_name+  - String. The name of an existing affinity group
+      # in the specified subscription. Required if no location specified.
+      # * +:geo_replication_enabled+ - String. A flag indicating wheter to
+      # turn Geo replication on or off. Values other than 'true'/'false'
+      # will result in an error from the REST API. (optional)
+      # * +:extended_properties+      - Hash. Key/Value pairs of extended
+      # properties to add to the storage account. The key is used as the
+      # property name and the value as its value. (optional)
+      #
+      # Returns None
+      def create_storage_account(name, options = {})
+        raise 'Name not specified' if !name || name.class != String || name.empty?
+        if get_storage_account(name)
+          Loggerx.warn "Storage Account #{name} already exists. Skipped..."
+        else
+          Loggerx.info "Creating Storage Account #{name}."
+          body = Serialization.storage_services_to_xml(name, options)
+          request_path = '/services/storageservices'
+          request = ManagementHttpRequest.new(:post, request_path, body)
+          request.call
+        end
+      end
+
+      # Public: Updates an existing storage account in Windows Azure
+      #
+      # ==== Attributes
+      #
+      # * +name+          - String. The name of the storage service.
+      # * +options+       - Hash. Optional parameters.
+      #
+      # ==== Options
+      #
+      # Accepted key/value pairs in options parameter are:
+      # * +:label+ - String. A label for the storage service. Required if no
+      # description is provided. If both label and description are
+      # provided, only the label will get updated.
+      # * +:description+ - String. A description for the storage service.
+      # Required if no label is provided. If both label and description are
+      # provided, only the label will get updated.
+      # * +:geo_replication_enabled+ - Boolean (TrueClass/FalseClass). Boolean
+      # flag indicating wheter to turn Geo replication on or off. (optional)
+      # * +:extended_properties+      - Hash. Key/Value pairs of extended
+      # properties to add to the storage account. The key is used as the
+      # property name and the value as its value. (optional)
+      #
+      # Returns None
+      # Fails with RuntimeError if invalid options specified
+      def update_storage_account(name, options = {})
+        if get_storage_account name
+          Loggerx.info "Account '#{name}' exists, updating..."
+          body = Serialization.storage_update_to_xml options
+          request_path = "/services/storageservices/#{name}"
+          request = ManagementHttpRequest.new(:put, request_path, body)
+          request.call
+        else
+          Loggerx.warn "Storage Account '#{name}' does not exist. Skipped..."
+        end
+      end
+
+      # Public: Deletes the specified storage account of given subscription id
+      # from Windows Azure.
+      #
+      # ==== Attributes
+      #
+      # * +name+       - String. Storage account name.
+      #
+      # Returns:  None
+      def delete_storage_account(name)
+        Loggerx.info "Deleting Storage Account #{name}."
+        request_path = "/services/storageservices/#{name}"
+        request = ManagementHttpRequest.new(:delete, request_path)
+        request.call
+      rescue Exception => e
+        e.message
+      end
+    end
+  end
+end