azure-armrest 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27744a66e69a816479bb6dc1d7a2bb5070d42717
-  data.tar.gz: b1ded209d9ff4e9c8bde0981e55c5b95586a4511
+  metadata.gz: 0a888f86dfd49210ca1ce4232968d2449f8ee1a2
+  data.tar.gz: 8a19fb58fe560e115b0153e843f0eaaf8329c61d
 SHA512:
-  metadata.gz: 6aaa5ae7fd87a32a0727e0965e84ece73ae426159ce9f49c54c6cd90e23ddc6f4939df8eda1f45ee5a8543f0fce7399dd5870fbddf87f556aa38ea3ec93fe5d3
-  data.tar.gz: 8dc378aa589e06f5d45c387356d83f23ed489796bab3289c9443344514d3726d467b6085047c37260235bee908857280739f3efa9bae59f0e340d141cda7199b
+  metadata.gz: cc6c79041f6c46dcad609fd72e2e5c719c2b84cea7e0fc2cf10fd3da4bc789f92bfcdcddf69748fbfe1e9e837fc001ab607c1d6bc38d2ce0752639284f7acbb7
+  data.tar.gz: 55fd98f1b9af93b7e84b6eaef6b98d5814a31531518ceb00c5c617e2242c547d74ab40c3f4d073bab98d2feb0ca5e09cf1292f45a982bf49532f60817426cc90

data/CHANGES

@@ -1,3 +1,25 @@
+= 0.4.1 - 16-Dec-2016
+* The Configuration#environment accessor was added. As of this release you
+  can specify 'usgov' as an option to the constructor, and the appropriate
+  resource and authority endpoints will be used instead of the public ones.
+* Added the #authority_url and #resource_url accessors to the Configuration
+  class. Use wisely.
+* The Armrest::COMMON constant was removed because the resource isn't actually
+  constant. Instead use the authority_url or resource_url methods. This was
+  really only meant for internal use anyway.
+* Added the Armrest::USGOV_RESOURCE and Armrest::USGOV_AUTHORITY constants.
+* Fixed a bug in the VirtualMachineService#delete_associated_resources where
+  the method would fail if you requested network security group deletion but
+  there was no associated network security group.
+* Fixed an issue in the ArmrestService#poll method where a 202 response might
+  not actually have a body. In that case, it is treated as success.
+* Fixed a logic bug in the ArmrestService#wait method, and added the option
+  to specify 0 (infinity) for the wait time.
+* Added the ArmrestService#log method, and the Configuration.log= method now
+  automatically converts the argument to a Logger instance if it's not already.
+* The ArmrestService#base_url method was altered to include subscription
+  information.
+
 = 0.4.0 - 8-Dec-2016
 * The Configuration constructor no longer requires a subscription ID. However,
   the presence of a subscription ID is still required for almost all Service

data/README.md

@@ -43,9 +43,13 @@ end
 
 ## Subscriptions
 
-As of version 0.3.0 you must provide a subscription ID. In previous versions,
-if you did not provide a subscription ID in your configuration object, then the
-first subscription ID returned from a REST call would be used.
+As of version 0.4.0 you a subscription ID is not longer strictly necessary in
+the Configuration constructor, but almost all service classes require it in
+their own constructor. Only the SubscriptionService class does not.
+
+In version 0.3.x the subscription ID was mandatory. Prior to 0.3.x, if you did
+not provide a subscription ID in your configuration object, then the first
+subscription ID returned from a REST call would be used.
 
 ## Notes
 

data/lib/azure/armrest.rb

@@ -11,14 +11,20 @@ module Azure
   # The Armrest module mostly serves as a namespace, but also contains any
   # common constants shared by subclasses.
   module Armrest
-    # The default Azure resource
+    # The default (public) Azure resource
     RESOURCE = "https://management.azure.com/"
 
-    # The default authority resource
-    AUTHORITY = "https://login.windows.net/"
+    # The resource for US Government clients
+    USGOV_RESOURCE = "https://management.core.usgovcloudapi.net/"
 
-    # A common URI for all subclasses
-    COMMON_URI = RESOURCE + "subscriptions/"
+    # The default (public) authority resource
+    AUTHORITY = "https://login.microsoftonline.com/"
+
+    # The authority for US Government clients
+    USGOV_AUTHORITY = "https://login-us.microsoftonline.com/"
+
+    # Environment string used to indicate US Government
+    USGOV_ENVIRONMENT = 'usgov'
   end
 end
 

data/lib/azure/armrest/armrest_service.rb

@@ -12,7 +12,7 @@ module Azure
 
       alias configuration armrest_configuration
 
-      # Base url used for REST calls.
+      # Base url with subscription information used for most REST calls.
       attr_accessor :base_url
 
       # Provider for service specific API calls
@@ -46,7 +46,7 @@ module Azure
         end
 
         # Base URL used for REST calls. Modify within method calls as needed.
-        @base_url = Azure::Armrest::RESOURCE
+        @base_url = File.join(configuration.resource_url, 'subscriptions', configuration.subscription_id)
 
         set_service_api_version(options, service_name)
       end
@@ -165,7 +165,11 @@ module Azure
       def poll(response)
         return 'Succeeded' if [200, 201].include?(response.response_code)
         url = response.try(:azure_asyncoperation) || response.try(:location)
-        JSON.parse(rest_get(url))['status']
+        response = rest_get(url).body
+        unless response.blank?
+          status = JSON.parse(response)['status']
+        end
+        status || 'Succeeded' # assume succeeded otherwise the wait method may hang
       end
 
       # Wait for the given +response+ to return a status of 'Succeeded', up
@@ -175,7 +179,7 @@ module Azure
       #
       # Internally this will poll the response header every :retry_after
       # seconds (or 10 seconds if that header isn't found), up to a maximum of
-      # 60 seconds by default.
+      # 60 seconds by default. There is no timeout limit if +max_time+ is 0.
       #
       # For most resources the +max_time+ argument should be more than sufficient.
       # Certain resources, such as virtual machines, could take longer.
@@ -184,9 +188,9 @@ module Azure
         sleep_time = response.respond_to?(:retry_after) ? response.retry_after.to_i : 10
         total_time = 0
 
-        while (status = poll(response)).casecmp('Succeeded') != 0
+        until (status = poll(response)) =~ /^succe/i # success or succeeded
           total_time += sleep_time
-          break if total_time >= max_time
+          break if max_time > 0 && total_time >= max_time
           sleep sleep_time
         end
 
@@ -353,6 +357,10 @@ module Azure
       def model_class
         @model_class ||= Object.const_get(self.class.to_s.sub(/Service$/, ''))
       end
+
+      def log(level = "info", msg)
+        RestClient.log.try(level, msg)
+      end
     end # ArmrestService
   end # Armrest
 end # Azure

data/lib/azure/armrest/billing/usage_service.rb

@@ -59,14 +59,7 @@ module Azure
         private
 
         def build_url(options = {})
-          url = File.join(
-            Azure::Armrest::COMMON_URI,
-            configuration.subscription_id,
-            'providers',
-            @provider,
-            'UsageAggregates'
-          )
-
+          url = File.join(base_url, 'providers', @provider, 'UsageAggregates')
           url << "?api-version=#{@api_version}"
 
           options.each do |key, value|

data/lib/azure/armrest/configuration.rb

@@ -64,6 +64,15 @@ module Azure
       # Maximum number of threads to use within methods that use Parallel for thread pooling.
       attr_accessor :max_threads
 
+      # The environment in which to acquire your token.
+      attr_reader :environment
+
+      # The authority URL used to acquire a valid token.
+      attr_accessor :resource_url
+
+      # The resource URL used to acquire a valid token.
+      attr_accessor :authority_url
+
       # Yields a new Azure::Armrest::Configuration objects. Note that you must
       # specify a client_id, client_key, tenant_id. The subscription_id is optional
       # but should be specified in most cases. All other parameters are optional.
@@ -90,13 +99,15 @@ module Azure
       def initialize(args)
         # Use defaults, and override with provided arguments
         options = {
-          :api_version  => '2015-01-01',
-          :accept       => 'application/json',
-          :content_type => 'application/json',
-          :grant_type   => 'client_credentials',
-          :proxy        => ENV['http_proxy'],
-          :ssl_version  => 'TLSv1',
-          :max_threads  => 10
+          :api_version   => '2015-01-01',
+          :accept        => 'application/json',
+          :content_type  => 'application/json',
+          :grant_type    => 'client_credentials',
+          :proxy         => ENV['http_proxy'],
+          :ssl_version   => 'TLSv1',
+          :max_threads   => 10,
+          :authority_url => Azure::Armrest::AUTHORITY,
+          :resource_url  => Azure::Armrest::RESOURCE
         }.merge(args.symbolize_keys)
 
         # Avoid thread safety issues for VCR testing.
@@ -184,19 +195,18 @@ module Azure
         end
       end
 
-      # The name of the file or handle used to log http requests.
-      #--
-      # We have to do a little extra work here to convert a possible
-      # file handle to a file name.
+      # Returns the logger instance. It might be initially set through a log
+      # file path, file handler, or already a logger instance.
       #
       def self.log
-        file = RestClient.log.instance_variable_get("@target_file")
-        file || RestClient.log
+        RestClient.log
       end
 
-      # Sets the log to +output+, which can be a file or a handle.
+      # Sets the log to +output+, which can be a file, a file handle, or
+      # a logger instance
       #
       def self.log=(output)
+        output = Logger.new(output) unless output.kind_of?(Logger)
         RestClient.log = output
       end
 
@@ -208,6 +218,28 @@ module Azure
 
       private
 
+      # Sets the environment to authenticate against. The environment
+      # must support ActiveDirectory.
+      #
+      def environment=(env)
+        return if env == environment
+        set_auth_and_resource_urls(env)
+        @environment = env
+      end
+
+      # Sets the authority_url and resource_url accessors depending on the
+      # environment.
+      #--
+      # Only two supported at the moment, but more likely to be added.
+      #
+      def set_auth_and_resource_urls(env)
+        case env.to_s.downcase
+          when Azure::Armrest::USGOV_ENVIRONMENT
+            @authority_url = Azure::Armrest::USGOV_AUTHORITY
+            @resource_url = Azure::Armrest::USGOV_RESOURCE
+        end
+      end
+
       # Validate the subscription ID for the given credentials. Returns the
       # subscription ID if valid.
       #
@@ -275,7 +307,7 @@ module Azure
       end
 
       def fetch_token
-        token_url = File.join(Azure::Armrest::AUTHORITY, tenant_id, 'oauth2/token')
+        token_url = File.join(authority_url, tenant_id, 'oauth2/token')
 
         response = JSON.parse(
           ArmrestService.send(
@@ -288,7 +320,7 @@ module Azure
               :grant_type    => grant_type,
               :client_id     => client_id,
               :client_secret => client_key,
-              :resource      => Azure::Armrest::RESOURCE
+              :resource      => resource_url
             }
           )
         )

data/lib/azure/armrest/insights/diagnostic_service.rb

@@ -80,7 +80,7 @@ module Azure
 
         def build_url(resource_id)
           url = File.join(
-            Azure::Armrest::RESOURCE,
+            configuration.resource_url,
             resource_id,
             'providers',
             provider,

data/lib/azure/armrest/insights/event_service.rb

@@ -66,19 +66,7 @@ module Azure
         private
 
         def build_url(options = {})
-          sub_id = armrest_configuration.subscription_id
-
-          url =
-            File.join(
-              Azure::Armrest::COMMON_URI,
-              sub_id,
-              'providers',
-              provider,
-              'eventtypes',
-              'management',
-              'values'
-            )
-
+          url = File.join(base_url, 'providers', provider, 'eventtypes', 'management', 'values')
           url << "?api-version=#{@api_version}"
           url << "&$filter=#{options[:filter]}" if options[:filter]
           url << "&$select=#{options[:select]}" if options[:select]

data/lib/azure/armrest/insights/metrics_service.rb

@@ -34,11 +34,8 @@ module Azure
         private
 
         def build_url(provider, resource_type, resource_name, resource_group, options)
-          sub_id = configuration.subscription_id
-
           url = File.join(
-            Azure::Armrest::COMMON_URI,
-            sub_id,
+            base_url,
             'resourceGroups',
             resource_group,
             'providers',

data/lib/azure/armrest/resource_group_based_service.rb

@@ -114,7 +114,7 @@ module Azure
         api_version ||= configuration.api_version
         service_name = info['subservice_name'] || info['service_name']
 
-        url = File.join(Azure::Armrest::RESOURCE, id_string) + "?api-version=#{api_version}"
+        url = File.join(configuration.resource_url, id_string) + "?api-version=#{api_version}"
 
         model_class = SERVICE_NAME_MAP.fetch(service_name.downcase) do
           raise ArgumentError, "unable to map service name #{service_name} to model"
@@ -203,7 +203,7 @@ module Azure
       # arguments provided, and appends it with the api_version.
       #
       def build_url(resource_group = nil, *args)
-        url = File.join(Azure::Armrest::COMMON_URI, configuration.subscription_id)
+        url = base_url
         url = File.join(url, 'resourceGroups', resource_group) if resource_group
         url = File.join(url, 'providers', @provider, @service_name)
         url = File.join(url, *args) unless args.empty?

data/lib/azure/armrest/resource_group_service.rb

@@ -69,8 +69,7 @@ module Azure
       private
 
       def build_url(group = nil, *args)
-        id = configuration.subscription_id
-        url = File.join(Azure::Armrest::COMMON_URI, id, 'resourcegroups')
+        url = File.join(base_url, 'resourcegroups')
         url = File.join(url, group) if group
         url = File.join(url, *args) unless args.empty?
         url << "?api-version=#{@api_version}"

data/lib/azure/armrest/resource_provider_service.rb

@@ -61,7 +61,7 @@ module Azure
       end
 
       def _list_all
-        url = File.join(Azure::Armrest::RESOURCE, 'providers')
+        url = File.join(configuration.resource_url, 'providers')
         url << "?api-version=#{@api_version}"
         response = rest_get(url)
         JSON.parse(response)['value']
@@ -127,7 +127,7 @@ module Azure
 
       def build_url(namespace = nil, *args)
         id = configuration.subscription_id
-        url = File.join(Azure::Armrest::COMMON_URI, id, 'providers')
+        url = File.join(base_url, 'providers')
         url = File.join(url, namespace) if namespace
         url = File.join(url, *args) unless args.empty?
         url << "?api-version=#{@api_version}"

data/lib/azure/armrest/resource_service.rb

@@ -56,8 +56,12 @@ module Azure
       #
       def move(source_group, source_subscription = configuration.subscription_id)
         url = File.join(
-          Azure::Armrest::COMMON_URI, source_subscription,
-          'resourcegroups', source_group, 'moveresources'
+          configuration.resource_url,
+          'subscriptions',
+          source_subscription,
+          'resourcegroups',
+          source_group,
+          'moveresources'
         )
 
         url << "?api-version=#{@api_version}"
@@ -90,12 +94,10 @@ module Azure
       private
 
       def build_url(resource_group = nil, options = {})
-        url = File.join(Azure::Armrest::COMMON_URI, configuration.subscription_id)
-
         if resource_group
-          url = File.join(url, 'resourceGroups', resource_group, 'resources')
+          url = File.join(base_url, 'resourceGroups', resource_group, 'resources')
         else
-          url = File.join(url, 'resources')
+          url = File.join(base_url, 'resources')
         end
 
         url << "?api-version=#{@api_version}"

data/lib/azure/armrest/subscription_service.rb

@@ -28,7 +28,7 @@ module Azure
       private
 
       def subscriptions_url
-        File.join(Azure::Armrest::RESOURCE, 'subscriptions')
+        File.join(configuration.resource_url, 'subscriptions')
       end
     end
   end

data/lib/azure/armrest/version.rb

@@ -1,5 +1,5 @@
 module Azure
   module Armrest
-    VERSION = '0.4.0'.freeze
+    VERSION = '0.4.1'.freeze
   end
 end

data/lib/azure/armrest/virtual_machine_extension_service.rb

@@ -117,8 +117,7 @@ module Azure
       #
       def build_url(resource_group, vm, *args)
         url = File.join(
-          Azure::Armrest::COMMON_URI,
-          configuration.subscription_id,
+          base_url,
           'resourceGroups',
           resource_group,
           'providers',

data/lib/azure/armrest/virtual_machine_image_service.rb

@@ -98,15 +98,7 @@ module Azure
       # arguments provided, and appends it with the api_version.
       #
       def build_url(location, *args)
-        url = File.join(
-          Azure::Armrest::COMMON_URI,
-          configuration.subscription_id,
-          'providers',
-          provider,
-          'locations',
-          location
-        )
-
+        url = File.join(base_url, 'providers', provider, 'locations', location)
         url = File.join(url, *args) unless args.empty?
         url << "?api-version=#{@api_version}"
       end

data/lib/azure/armrest/virtual_machine_service.rb

@@ -200,9 +200,10 @@ module Azure
           end
 
           if options[:network_security_groups]
-            nic.properties.network_security_group
-            nsg = get_associated_resource(nic.properties.network_security_group.id)
-            delete_and_wait(nsgs, nsg.name, nsg.resource_group, options)
+            if nic.properties.respond_to?(:network_security_group)
+              nsg = get_associated_resource(nic.properties.network_security_group.id)
+              delete_and_wait(nsgs, nsg.name, nsg.resource_group, options)
+            end
           end
         end
       end
@@ -243,13 +244,13 @@ module Azure
 
             # In the unlikely event it did not unlock, just log and skip.
             if disk.x_ms_lease_status.casecmp('unlocked') != 0
-              log_message("Unable to delete disk #{disk.container}/#{disk.name}", 'warn')
+              log('warn', "Unable to delete disk #{disk.container}/#{disk.name}")
               return
             end
           end
 
           storage_account.delete_blob(disk.container, disk.name, key)
-          log_message("Deleted blob #{disk.container}/#{disk.name}") if options[:verbose]
+          log("Deleted blob #{disk.container}/#{disk.name}") if options[:verbose]
 
           begin
             status_file = File.basename(disk.name, '.vhd') + '.status'
@@ -257,7 +258,7 @@ module Azure
           rescue Azure::Armrest::NotFoundException
             # Ignore, does not always exist.
           else
-            log_message("Deleted blob #{disk.container}/#{status_file}") if options[:verbose]
+            log("Deleted blob #{disk.container}/#{status_file}") if options[:verbose]
           end
         end
       end
@@ -271,20 +272,15 @@ module Azure
       def delete_and_wait(service, name, group, options)
         resource_type = service.class.to_s.sub('Service', '').split('::').last
 
-        log_message("Deleting #{resource_type} #{name}/#{group}") if options[:verbose]
-
-        headers = service.delete(name, group)
+        log("Deleting #{resource_type} #{name}/#{group}") if options[:verbose]
 
-        loop do
-          status = wait(headers)
-          break if status.downcase.start_with?('succ') # Succeeded, Success, etc.
-        end
+        wait(service.delete(name, group), 0)
 
-        log_message("Deleted #{resource_type} #{name}/#{group}") if options[:verbose]
+        log("Deleted #{resource_type} #{name}/#{group}") if options[:verbose]
       rescue Azure::Armrest::BadRequestException, Azure::Armrest::PreconditionFailedException => err
         if options[:verbose]
           msg = "Unable to delete #{resource_type} #{name}/#{group}, skipping. Message: #{err.message}"
-          log_message(msg, 'warn')
+          log('warn', msg)
         end
       end
 
@@ -296,15 +292,6 @@ module Azure
         rest_post(url)
         nil
       end
-
-      # Simple log messager. Use the Configuration.log if defined.
-      def log_message(msg, level = 'info')
-        if Azure::Armrest::Configuration.log
-          Azure::Armrest::Configuration.log.send(level.to_sym, msg)
-        else
-          warn msg
-        end
-      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: azure-armrest
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-08 00:00:00.000000000 Z
+date: 2016-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json