azure-armrest 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12001d2bb2d38d314b1e9ea8833922a7dfb97882
-  data.tar.gz: b7a5853e8526cba1d68cf887b6d5451481e569e3
+  metadata.gz: 5bc812c499cfa7408aec0074256c17473d845988
+  data.tar.gz: d54a716667c8d7c50f28275d6652cf3c61998305
 SHA512:
-  metadata.gz: 6213f8ef74444dbc11624c66b2e32dfd8168ed10cc240e50ae7ff4e5119ca2898a498ce385503ba84581c88945ba056709ad3013f7911e3f65276be1bf732945
-  data.tar.gz: 0556e41d57f3d396621a080f9d7381267aa21ade4adaf92d1214ba4b02812350b452a9a61d37a769c52a3632776a0bd0fdf0e4fdd3f727738c6c03991f55b60e
+  metadata.gz: bc3934aab613328f0c07f3dfa0851b4e8c4ba2b86f10cc282171557dce558d4f9931359e7eb9214b07c8fc414885b985afea68249e004b660aeab133dfc3325b
+  data.tar.gz: eb767973f551518150186ed4ba42e38f4e6a752ed80f69319c0060e61a28f5e3834c029e1b93b5ee0bda7bd2f09db3d1f4c0ac6c5dbfd3842d76f1f976def50a

data/CHANGES

@@ -1,3 +1,14 @@
+= 0.2.6 - 9-May-2016
+* If no subscription is provided, the internal method for fetching a default
+  subscription ID will now skip over tenant/subscription mismatches.
+* Removed the hard-coded api-version string for both TemplateDeploymentService
+  and StorageAccountService.
+* Because there was an underlying REST API change for storage account keys for
+  api-version strings set at 2016-01-01 or later, the list_account_key_objects
+  and regenerate_account_key_objects methods were added. These return model
+  objects instead of plain hashes. The list_account_keys and regenerate_account_keys
+  methods still behave as before.
+
 = 0.2.5 - 11-Apr-2016
 * Fixed a bug in the custom exception handler where the error code and
   message were not set properly.

data/lib/azure/armrest/armrest_service.rb

@@ -171,25 +171,49 @@ module Azure
 
         url = File.join(Azure::Armrest::RESOURCE, "subscriptions?api-version=#{config.api_version}")
 
-        response = rest_get(
+        options = {
           :url         => url,
           :proxy       => config.proxy,
           :ssl_version => config.ssl_version,
           :ssl_verify  => config.ssl_verify,
-          :headers => {
+          :headers     => {
             :content_type  => config.content_type,
             :authorization => config.token
           }
-        )
+        }
 
-        array = JSON.parse(response)["value"]
+        response = rest_get(options)
+        array = JSON.parse(response)['value']
 
         if array.nil? || array.empty?
           raise ArgumentError, "No associated subscription found"
         end
 
+        results = []
+
+        # Skip over any invalid subscriptions
+        array.each do |sub_hash|
+          sub_id = sub_hash['subscriptionId']
+
+          # Use tagNames as a test URL
+          test_url = File.join(
+            Azure::Armrest::RESOURCE, 'subscriptions', sub_id,
+            "tagNames?api-version=#{config.api_version}"
+          )
+
+          begin
+            options[:url] = test_url
+            rest_get(options)
+          rescue Azure::Armrest::UnauthorizedException, Azure::Armrest::BadRequestException
+            next
+          else
+            results << sub_hash
+            break if sub_hash['state'] == 'Enabled'
+          end
+        end
+
         # Look for the first enabled subscription, otherwise just take the first subscription found.
-        hash = array.find{ |h| h['state'] == 'Enabled' } || array.first
+        hash = results.find { |h| h['state'] == 'Enabled' } || results.first
 
         id = hash.fetch('subscriptionId')
 
@@ -412,6 +436,7 @@ module Azure
 
         raise exception_type.new(code, message, e)
       end
+
       private_class_method :raise_api_exception
 
       private

data/lib/azure/armrest/model/base_model.rb

@@ -173,7 +173,14 @@ module Azure
     class ResourceGroup < BaseModel; end
     class ResourceProvider < BaseModel; end
     class Sku < BaseModel; end
+
     class StorageAccount < BaseModel; end
+    class StorageAccountKey < StorageAccount
+      def key1; key_name == 'key1' ? value : nil; end
+      def key2; key_name == 'key2' ? value : nil; end
+      def key; key1 || key2; end
+    end
+
     class Subscription < BaseModel; end
     class Tag < BaseModel; end
     class TemplateDeployment < BaseModel

data/lib/azure/armrest/storage_account_service.rb

@@ -16,7 +16,6 @@ module Azure
       # Creates and returns a new StorageAccountService (SAS) instance.
       #
       def initialize(configuration, options = {})
-        options = {'api_version' => '2015-05-01-preview'}.merge(options) # Must hard code for now
         super(configuration, 'storageAccounts', 'Microsoft.Storage', options)
       end
 
@@ -108,33 +107,85 @@ module Azure
         acct
       end
 
-      # Returns the primary and secondary access keys for the given
-      # storage account as a hash.
+      # Returns the primary and secondary access keys for the given storage
+      # account. This method will return a hash with 'key1' and 'key2' as its
+      # keys.
+      #
+      # If you want a list of StorageAccountKey objects, then use the
+      # list_account_key_objects method instead.
       #
       def list_account_keys(account_name, group = configuration.resource_group)
         validate_resource_group(group)
 
         url = build_url(group, account_name, 'listKeys')
         response = rest_post(url)
-        JSON.parse(response)
+        hash = JSON.parse(response.body)
+
+        parse_account_keys_from_hash(hash)
+      end
+
+      alias list_storage_account_keys list_account_keys
+
+      # Returns a list of StorageAccountKey objects consisting of information
+      # the primary and secondary keys. This method requires an api-version
+      # string of 2016-01-01 or later, or an error is raised.
+      #
+      # If you want a plain hash, use the list_account_keys method instead.
+      #
+      def list_account_key_objects(account_name, group = configuration.resource_group)
+        validate_resource_group(group)
+
+        unless recent_api_version?
+          raise ArgumentError, "unsupported api-version string '#{api_version}'"
+        end
+
+        url = build_url(group, account_name, 'listKeys')
+        response = rest_post(url)
+        JSON.parse(response.body)['keys'].map { |hash| StorageAccountKey.new(hash) }
+      end
+
+      alias list_storage_account_key_objects list_account_key_objects
+
+      # Regenerates the primary or secondary access keys for the given storage
+      # account. The +key_name+ may be either 'key1' or 'key2'. If no key name
+      # is provided, then it defaults to 'key1'.
+      #
+      def regenerate_account_keys(account_name, group = configuration.resource_group, key_name = 'key1')
+        validate_resource_group(group)
+
+        options = {'keyName' => key_name}
+
+        url = build_url(group, account_name, 'regenerateKey')
+        response = rest_post(url, options.to_json)
+        hash = JSON.parse(response.body)
+
+        parse_account_keys_from_hash(hash)
       end
 
-      # Regenerates the primary and secondary access keys for the given
-      # storage account.
+      alias regenerate_storage_account_keys regenerate_account_keys
+
+      # Same as regenerate_account_keys, but returns an array of
+      # StorageAccountKey objects instead.
       #
-      # options have only one key with two possible values:
-      #   {
-      #     "keyName": "key1|key2"
-      #   }
+      # This method requires an api-version string of 2016-01-01 or later
+      # or an ArgumentError is raised.
       #
-      def regenerate_storage_account_keys(account_name, group = configuration.resource_group, options = {})
+      def regenerate_account_key_objects(account_name, group = configuration.resource_group, key_name = 'key1')
         validate_resource_group(group)
 
+        unless recent_api_version?
+          raise ArgumentError, "unsupported api-version string '#{api_version}'"
+        end
+
+        options = {'keyName' => key_name}
+
         url = build_url(group, account_name, 'regenerateKey')
         response = rest_post(url, options.to_json)
-        JSON.parse(response)
+        JSON.parse(response.body)['keys'].map { |hash| StorageAccountKey.new(hash) }
       end
 
+      alias regenerate_storage_account_key_objects regenerate_account_key_objects
+
       # Returns a list of images that are available for provisioning for all
       # storage accounts in the provided resource group. The custom keys
       # :uri and :operating_system have been added for convenience.
@@ -146,7 +197,11 @@ module Azure
 
         list(group).each do |lstorage_account|
           threads << Thread.new(lstorage_account) do |storage_account|
-            key = list_account_keys(storage_account.name, group).fetch('key1')
+            if recent_api_version?
+              key = list_account_key_objects(storage_account.name, group).first.key
+            else
+              key = list_account_keys(storage_account.name, group).fetch('key1')
+            end
 
             storage_account.all_blobs(key).each do |blob|
               next unless File.extname(blob.name).downcase == '.vhd'
@@ -212,6 +267,24 @@ module Azure
 
       private
 
+      # Check to see if the api-version string is 2016-01-01 or later.
+      def recent_api_version?
+        Time.parse(api_version).utc >= Time.parse('2016-01-01').utc
+      end
+
+      # As of api-version 2016-01-01, the format returned for listing and
+      # regenerating hash keys has changed.
+      #
+      def parse_account_keys_from_hash(hash)
+        if recent_api_version?
+          key1 = hash['keys'].find { |h| h['keyName'] == 'key1' }['value']
+          key2 = hash['keys'].find { |h| h['keyName'] == 'key2' }['value']
+          hash = {'key1' => key1, 'key2' => key2}
+        end
+
+        hash
+      end
+
       def validate_account_type(account_type)
         unless VALID_ACCOUNT_TYPES.include?(account_type)
           raise ArgumentError, "invalid account type '#{account_type}'"

data/lib/azure/armrest/template_deployment_service.rb

@@ -4,8 +4,6 @@ module Azure
     class TemplateDeploymentService < ResourceGroupBasedService
 
       def initialize(configuration, options = {})
-        # Has to be hard coded for now
-        options = {'api_version' => '2014-04-01-preview'}.merge(options)
         super(configuration, 'deployments', 'Microsoft.Resources', options)
       end
 

data/lib/azure/armrest/version.rb

@@ -1,5 +1,5 @@
 module Azure
   module Armrest
-    VERSION = '0.2.5'
+    VERSION = '0.2.6'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: azure-armrest
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-12 00:00:00.000000000 Z
+date: 2016-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -241,7 +241,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: An interface for ARM/JSON Azure REST API