azure-armrest 0.2.10 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f25780e2f0499b060cbe8353a4eeb53f99272b14
-  data.tar.gz: c66aa4e9aa32d682b61469019bc146814b5cafc1
+  metadata.gz: d6e051e8b1aafc0e56dead25b4b049a1db77991d
+  data.tar.gz: 6cd67f1ba82fc44da524373ae20f68b6e0a29737
 SHA512:
-  metadata.gz: b4890375ae51f3cf07499f02b39c07966578a6aa7b1f6d3e5c26e97d8a6a239969032659625b9704ee6e2919961407cf0185852422f096fa497b2139d99d6199
-  data.tar.gz: 3938fb8f7187ee9a613feb36dfa22df415eb36300dad9e8fbc7cef441bdeb758403252e5ff3d545c6c04c4258e7eda60f326d823f85c6cc57380c82edbc684ff
+  metadata.gz: 2243372f9f4b26501539f91db5d91be939454c7608a6feee25d9addd8aae16239c986b76555286a1f19e384ce4fc7d77511701f30ae5104145b8da3003671bc2
+  data.tar.gz: c139739090ad6fa30c5e86e61197db7cf09c7695d79ad4ee6aa728281294653234728cb782542f7a0633b1deede6d10258107211d51588ff1afcc2964aa7ee03

data/.travis.yml

@@ -1,7 +1,8 @@
 language: ruby
 rvm:
-- "2.2.5"
-- "2.3.1"
+- "2.0"
+- "2.1"
+- "2.2"
 - ruby-head
 - jruby-head
 matrix:

data/CHANGES

@@ -1,15 +1,21 @@
-= 0.2.10 - 15-Sep-2016
-* Backported PR #213 (skip over storage accounts that don't have keys).
-
-= 0.2.9 - 25-Aug-2016
-* Backported PR #211 (exception class updates and specs).
-
-= 0.2.8 - 22-Jul-2016
-* Backported PR #188 (add list_all_private_images method).
-* Backported PR #194 (updated .travis.yml).
+= 0.3.0 - 28-Jun-2016
+* The configuration handling has been moved into its own class called
+  Azure::Armrest::Configuration. You can call this explicitly using :new,
+  or you can still use ArmrestService.configure.
+* The :subscription_id option for configuration is no longer optional.
+  The logic for automatically fetching the first active subscription ID
+  that could be found has been dropped.
+* Added the Billing::UsageService class.
+* Added a TooManyRequests exception.
+* Added support for pretty_print.
+* Added the addressable gem as a dependency, as it internally replaces
+  the uri standard library. Calls to rest-client are still encoded, but
+  now using Addressable::URI.
+* StorageAccountService no longer does account type validation.
+* Added the StorageAccountService#list_all_private_images method.
 
 = 0.2.7 - 20-Jun-2016
-* All internal calls to rest-client are now explicitly URI.encode'd.
+* All internal calls to rest-client are now explicitly URI.encoded.
 
 = 0.2.6 - 9-May-2016
 * If no subscription is provided, the internal method for fetching a default

data/README.md

@@ -18,7 +18,7 @@ require 'azure/armrest'
 #
 # A token will be retrieved based on the information you provided
 
-conf = Azure::Armrest::ArmrestService.configure(
+conf = Azure::Armrest::Configuration.new(
   :client_id       => 'XXXXX',
   :client_key      => 'YYYYY',
   :tenant_id       => 'ZZZZZ',
@@ -40,8 +40,9 @@ end
 
 ## Subscriptions
 
-If you do not provide a subscription ID in your configuration object, then the
-first subscription ID returned from a REST call will be used.
+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.
 
 ## Notes
 

data/azure-armrest.gemspec

@@ -25,6 +25,7 @@ behind the scenes.
   spec.add_dependency 'azure-signature', '~> 0.2.0'
   spec.add_dependency 'activesupport', '>= 1.2.0'
   spec.add_dependency 'nokogiri', '~> 1.6.0'
+  spec.add_dependency 'addressable', '~> 2.4.0'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

data/lib/azure/armrest.rb

@@ -1,7 +1,7 @@
 require 'rest-client'
 require 'json'
 require 'thread'
-require 'uri'
+require 'addressable'
 
 # The Azure module serves as a namespace.
 module Azure
@@ -21,6 +21,7 @@ module Azure
 end
 
 require 'azure/armrest/version'
+require 'azure/armrest/configuration'
 require 'azure/armrest/exception'
 require 'azure/armrest/armrest_collection'
 require 'azure/armrest/armrest_service'
@@ -48,6 +49,7 @@ require 'azure/armrest/role/assignment_service'
 require 'azure/armrest/role/definition_service'
 require 'azure/armrest/sql/sql_server_service'
 require 'azure/armrest/sql/sql_database_service'
+require 'azure/armrest/billing/usage_service'
 
 # JSON wrapper classes. The service classes should require their own
 # wrappers from this point on.

data/lib/azure/armrest/armrest_service.rb

@@ -5,61 +5,7 @@ module Azure
   module Armrest
     # Abstract base class for the other service classes.
     class ArmrestService
-      ArmrestConfiguration = Struct.new(
-        :client_id,
-        :client_key,
-        :tenant_id,
-        :subscription_id,
-        :resource_group,
-        :api_version,
-        :grant_type,
-        :content_type,
-        :accept,
-        :token,
-        :token_expiration, # token expiration local system date
-        :proxy,
-        :ssl_verify,
-        :ssl_version
-      ) do
-        @@tokens = Hash.new([])
-
-        def as_cache_key
-          "#{grant_type}_#{tenant_id}_#{client_id}_#{client_key}"
-        end
-
-        def token
-          self[:token], self[:token_expiration] = @@tokens[as_cache_key] if self[:token].nil?
-
-          if self[:token].nil? || Time.now > (self[:token_expiration] || Time.new(0))
-            self[:token], self[:token_expiration] = fetch_token
-          end
-          self[:token]
-        end
-
-        def fetch_token
-          token_url = Azure::Armrest::AUTHORITY + tenant_id + "/oauth2/token"
-
-          response = JSON.parse(
-            ArmrestService.rest_post(
-              :url         => token_url,
-              :proxy       => proxy,
-              :ssl_version => ssl_version,
-              :ssl_verify  => ssl_verify,
-              :payload => {
-                :grant_type    => grant_type,
-                :client_id     => client_id,
-                :client_secret => client_key,
-                :resource      => Azure::Armrest::RESOURCE
-              }
-            )
-          )
-
-          token = 'Bearer ' + response['access_token']
-          @@tokens[as_cache_key] = [token, Time.now + response['expires_in'].to_i]
-        end
-
-        private :fetch_token
-      end
+      extend Gem::Deprecate
 
       # Configuration to access azure APIs
       attr_accessor :armrest_configuration
@@ -69,161 +15,20 @@ module Azure
       # Base url used for REST calls.
       attr_accessor :base_url
 
-      # provider for service specific API calls
+      # Provider for service specific API calls
       attr_accessor :provider
 
-      # The api-version string used for each request.
+      # The api-version string for this particular service
       attr_accessor :api_version
 
-      # The http proxy used for each request. Uses ENV['http_proxy'] if set.
-      attr_accessor :proxy
-
-      # The SSL verification method used for each request. The default is VERIFY_PEER.
-      attr_accessor :ssl_verify
-
-      # The SSL version used for each request. The default is TLSv1.
-      attr_accessor :ssl_version
-
-      # Clear class level caches.
-      def self.clear_caches
-        @@providers_hash = {} # Set in constructor
-        @@tokens         = {} # token caches
-        @@subscriptions  = {} # subscription caches
-      end
-
-      clear_caches
-
-      # Create a configuration object based on input options.
-      # This object can be used to create service objects.
-      #
-      # Possible options are:
-      #
-      #   - client_id
-      #   - client_key
-      #   - tenant_id
-      #   - subscription_id
-      #   - resource_group
-      #   - api_version
-      #   - grant_type
-      #   - content_type
-      #   - accept
-      #   - token,
-      #   - token_expiration
-      #   - proxy
-      #   - ssl_verify
-      #   - ssl_version
-      #
-      # Of these, you should include a :client_id, :client_key and :tenant_id.
-      # The resource_group can be specified here, but many methods allow you
-      # to specify a resource group if you prefer flexibility.
-      #
-      # If no :subscription_id is provided then this method will attempt to find
-      # a list of associated subscriptions and use the first one it finds as
-      # the default. If no associated subscriptions are found, an ArgumentError
-      # is raised.
-      #
-      # The other options (:grant_type, :content_type, :accept, :token,
-      # :token_expiration and :api_version) should generally NOT be set by you
-      # except in specific circumstances. Setting them explicitly will likely
-      # cause breakage.
-      #
-      # The :token and :token_expiration options must be set in pair. The
-      # :token_expiration should be set in local system time.
+      # Returns a new Armrest::Configuration object.
       #
-      # The :api_version will typically be overridden on a per-provider/resource
-      # basis within subclasses anyway.
-      #
-      # You may need to associate your application with a subscription using
-      # the new portal or the New-AzureRoleAssignment powershell command.
+      # This method is deprecated, but is provided for backwards compatibility.
       #
       def self.configure(options)
-        configuration = ArmrestConfiguration.new
-
-        options.each do |k,v|
-          configuration[k] = v
-        end
-
-        unless configuration.client_id && configuration.client_key
-          raise ArgumentError, "client_id and client_key must be specified"
-        end
-
-        # Set default values for certain configuration items.
-        configuration.api_version  ||= '2015-01-01'
-        configuration.grant_type   ||= 'client_credentials'
-        configuration.content_type ||= 'application/json'
-        configuration.accept       ||= 'application/json'
-        configuration.proxy        ||= ENV['http_proxy']
-        configuration.ssl_version  ||= 'TLSv1'
-
-        # Allows for URI objects or Strings.
-        configuration.proxy = configuration.proxy.to_s if configuration.proxy
-
-        # After all other config options have been set, look for default subscription.
-        configuration.subscription_id ||= fetch_subscription_id(configuration)
-
-        configuration
-      end
-
-      # Find the first enabled subscription if one isn't provided or cached.
-      #
-      def self.fetch_subscription_id(config)
-        return @@subscriptions[config.as_cache_key] if @@subscriptions.has_key?(config.as_cache_key)
-
-        url = File.join(Azure::Armrest::RESOURCE, "subscriptions?api-version=#{config.api_version}")
-
-        options = {
-          :url         => url,
-          :proxy       => config.proxy,
-          :ssl_version => config.ssl_version,
-          :ssl_verify  => config.ssl_verify,
-          :headers     => {
-            :content_type  => config.content_type,
-            :authorization => config.token
-          }
-        }
-
-        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 = results.find { |h| h['state'] == 'Enabled' } || results.first
-
-        id = hash.fetch('subscriptionId')
-
-        warn "Warning: subscription #{id} is not enabled" unless hash['state'] == 'Enabled'
-
-        @@subscriptions[config.as_cache_key] = id
+        Azure::Armrest::Configuration.new(options)
       end
 
-      private_class_method :fetch_subscription_id
-
       # Do not instantiate directly. This is an abstract base class from which
       # all other service classes should subclass, and call super within their
       # own constructors.
@@ -239,23 +44,27 @@ module Azure
         set_service_api_version(options, service_name)
       end
 
-      # Returns a list of the available resource providers.
+      # Returns a list of the available resource providers. This is really
+      # just a wrapper for Azure::Armrest::Configuration#providers.
       #
-      def providers
-        url = url_with_api_version(configuration.api_version, @base_url, 'providers')
-        resp = rest_get(url)
-        JSON.parse(resp.body)["value"].map{ |hash| Azure::Armrest::ResourceProvider.new(hash) }
-      end
+      delegate :providers, :to => :configuration, :prefix => :list
+
+      alias providers list_providers
+      deprecate :providers, :list_providers, 2018, 1
+
+      # Need an "as_cache_key" method for the cache_method library interface.
+      delegate :hash, :to => :configuration
+      alias as_cache_key hash
 
       # Returns information about the specific provider +namespace+.
       #
-      def provider_info(provider)
-        url = url_with_api_version(configuration.api_version, @base_url, 'providers', provider)
-        response = rest_get(url)
-        Azure::Armrest::ResourceProvider.new(response)
+      def get_provider(provider)
+        configuration.providers.find { |rp| rp.namespace.casecmp(provider) == 0 }
       end
 
-      alias geo_locations provider_info
+      alias geo_locations get_provider
+      alias provider_info get_provider
+      deprecate :provider_info, :get_provider, 2018, 1
 
       # Returns a list of all locations for all resource types of the given
       # +provider+. If you do not specify a provider, then the locations for
@@ -266,26 +75,28 @@ module Azure
       #--
       #
       def locations(provider = nil)
-        hash = provider.nil? ? @@providers_hash : {provider => @@providers_hash[provider.downcase]}
+        list = configuration.providers
+        list = list.select { |rp| rp.namespace.casecmp(provider) == 0 } if provider
 
-        hash.collect do |_provider, provider_data|
-          provider_data.collect { |_resource, resource_data| resource_data['locations'] }
-        end.flatten.uniq
+        list.collect { |rp| rp.resource_types.map(&:locations) }.flatten.uniq.sort
       end
 
-      # Returns a list of subscriptions for the tenant.
+      # Returns a list of Subscription objects for the tenant.
       #
-      def subscriptions
+      def list_subscriptions
         url = url_with_api_version(configuration.api_version, @base_url, 'subscriptions')
         response = rest_get(url)
-        JSON.parse(response.body)["value"].map{ |hash| Azure::Armrest::Subscription.new(hash) }
+        JSON.parse(response.body)['value'].map { |hash| Azure::Armrest::Subscription.new(hash) }
       end
 
+      alias subscriptions list_subscriptions
+      deprecate :subscriptions, :list_subscriptions, 2018, 1
+
       # Return information for the specified subscription ID, or the
       # subscription ID that was provided in the constructor if none is
       # specified.
       #
-      def subscription_info(subscription_id = configuration.subscription_id)
+      def get_subscription(subscription_id = configuration.subscription_id)
         url = url_with_api_version(
           configuration.api_version,
           @base_url,
@@ -297,53 +108,33 @@ module Azure
         Azure::Armrest::Subscription.new(response.body)
       end
 
-      # Returns a list of resources for the current subscription. If a
+      alias subscription_info get_subscription
+      deprecate :subscription_info, :get_subscription, 2018, 1
+
+      # Returns an array of Resource objects for the current subscription. If a
       # +resource_group+ is provided, only list resources for that
       # resource group.
       #
-      def resources(resource_group = nil)
-        url_comps = [@base_url, 'subscriptions', configuration.subscription_id]
-        url_comps += ['resourcegroups', resource_group] if resource_group
-        url_comps << 'resources'
-
-        url = url_with_api_version(configuration.api_version, url_comps)
-        response = rest_get(url)
-
-        JSON.parse(response)["value"].map{ |hash| Azure::Armrest::Resource.new(hash) }
+      def list_resources(resource_group = nil)
+        if resource_group
+          Azure::Armrest::ResourceService.new(configuration).list(resource_group)
+        else
+          Azure::Armrest::ResourceService.new(configuration).list_all
+        end
       end
 
-      # Returns a list of resource groups for the current subscription.
-      #
-      def resource_groups
-        url = url_with_api_version(
-          configuration.api_version,
-          @base_url,
-          'subscriptions',
-          configuration.subscription_id,
-          'resourcegroups'
-        )
-        response = rest_get(url)
-        JSON.parse(response)["value"].map{ |hash| Azure::Armrest::ResourceGroup.new(hash) }
-      end
+      alias resources list_resources
+      deprecate :resources, :list_resources, 2018, 1
 
-      # Returns information on the specified +resource_group+ for the current
-      # subscription, or the resource group specified in the constructor if
-      # none is provided.
+      # Returns an array of ResourceGroup objects for the current subscription.
       #
-      def resource_group_info(resource_group = configuration.resource_group)
-        url = url_with_api_version(
-          configuration.api_version,
-          @base_url,
-          'subscriptions',
-          configuration.subscription_id,
-          'resourcegroups',
-          resource_group
-        )
-
-        response = rest_get(url)
-        Azure::Armrest::ResourceGroup.new(response.body)
+      def list_resource_groups
+        Azure::Armrest::ResourceGroupService.new(configuration).list
       end
 
+      alias resource_groups list_resource_groups
+      deprecate :resource_groups, :list_resource_groups, 2018, 1
+
       # Returns a list of tags for the current subscription.
       #
       def tags
@@ -366,84 +157,74 @@ module Azure
         JSON.parse(resp.body)['value'].map{ |hash| Azure::Armrest::Tenant.new(hash) }
       end
 
-      # The name of the file or handle used to log requests.
-      #
-      def self.log
-        file = RestClient.log.instance_variable_get("@target_file")
-        file || RestClient.log
-      end
+      class << self
+        private
 
-      # Sets the log to +output+, which can be a file or a handle.
-      #
-      def self.log=(output)
-        RestClient.log = output
-      end
-
-      def self.rest_execute(options, http_method = :get)
-        options = options.merge(
-          :method => http_method,
-          :url    => URI.escape(options[:url])
-        )
-
-        RestClient::Request.execute(options)
-      rescue RestClient::Exception => e
-        raise_api_exception(e)
-      end
+        def rest_execute(options, http_method = :get)
+          options = options.merge(
+            :method => http_method,
+            :url    => Addressable::URI.escape(options[:url])
+          )
+          RestClient::Request.execute(options)
+        rescue RestClient::Exception => e
+          raise_api_exception(e)
+        end
 
-      def self.rest_get(options)
-        rest_execute(options, :get)
-      end
+        def rest_get(options)
+          rest_execute(options, :get)
+        end
 
-      def self.rest_post(options)
-        rest_execute(options, :post)
-      end
+        def rest_post(options)
+          rest_execute(options, :post)
+        end
 
-      def self.rest_patch(options)
-        rest_execute(options, :patch)
-      end
+        def rest_patch(options)
+          rest_execute(options, :patch)
+        end
 
-      def self.rest_delete(options)
-        rest_execute(options, :delete)
-      end
+        def rest_delete(options)
+          rest_execute(options, :delete)
+        end
 
-      def self.rest_put(options)
-        rest_execute(options, :put)
-      end
+        def rest_put(options)
+          rest_execute(options, :put)
+        end
 
-      def self.rest_head(options)
-        rest_execute(options, :head)
-      end
+        def rest_head(options)
+          rest_execute(options, :head)
+        end
 
-      def self.raise_api_exception(e)
-        begin
-          response = JSON.parse(e.http_body)
-          code = response['error']['code']
-          message = response['error']['message']
-        rescue
-          message = e.http_body
+        def raise_api_exception(e)
+          begin
+            response = JSON.parse(e.http_body)
+            code = response['error']['code']
+            message = response['error']['message']
+          rescue
+            message = e.http_body
+          end
+          message = e.http_body unless message
+
+          exception_type = case e
+                           when RestClient::NotFound
+                             ResourceNotFoundException
+                           when RestClient::BadRequest
+                             BadRequestException
+                           when RestClient::GatewayTimeout
+                             GatewayTimeoutException
+                           when RestClient::BadGateway
+                             BadGatewayException
+                           when RestClient::Unauthorized, RestClient::Forbidden
+                             UnauthorizedException
+                           when RestClient::TooManyRequests
+                             TooManyRequestsException
+                           else
+                             ApiException
+                           end
+
+          raise exception_type.new(code, message, e)
         end
-        message = e.http_body unless message
-
-        exception_type = case e
-                         when RestClient::NotFound
-                           ResourceNotFoundException
-                         when RestClient::BadRequest
-                           BadRequestException
-                         when RestClient::GatewayTimeout
-                           GatewayTimeoutException
-                         when RestClient::BadGateway
-                           BadGatewayException
-                         when RestClient::Unauthorized, RestClient::Forbidden
-                           UnauthorizedException
-                         else
-                           ApiException
-                         end
-
-        raise exception_type.new(code, message, e)
       end
 
-      private_class_method :raise_api_exception
-
       private
 
       # REST verb methods
@@ -463,7 +244,7 @@ module Azure
 
         options[:payload] = body if body
 
-        self.class.rest_execute(options, http_method)
+        self.class.send(:rest_execute, options, http_method)
       end
 
       def rest_get(url)
@@ -495,35 +276,6 @@ module Azure
         File.join(*paths) << "?api-version=#{api_version}"
       end
 
-      # Build a one-time lookup table for each provider & resource. This
-      # lets subclasses set api-version strings properly for each method
-      # depending on whichever provider they're using.
-      #
-      # e.g. @@providers_hash['Microsoft.Compute']['virtualMachines']['api_version']
-      #
-      # Note that for methods that don't depend on a resource type should use
-      # armrest_configuration.api_version instead or set it explicitly as needed.
-      #
-      def set_providers_info
-        return unless @@providers_hash.empty?
-
-        providers.each do |info|
-          provider_info = {}
-          info.resource_types.each do |resource|
-            provider_info[resource.resource_type.downcase] = {
-              'api_version' => resource.api_versions.reject{ |version|
-                version =~ /preview/i || Time.parse(version) > Time.now
-              }.first,
-              'locations' => resource.locations - [''] # Ignore empty elements
-            }
-          end
-          # TODO: how does base model handle method naming collision?
-          # rename or access through hash?
-          # namespace is a method introduced by more_core_extensions
-          @@providers_hash[info['namespace'].downcase] = provider_info
-        end
-      end
-
       # Each Azure API call may require different api_version.
       # The api_version in armrest_configuration is used for common methods provided
       # by ArmrestService
@@ -532,20 +284,15 @@ module Azure
       #   api_version => version
       # This version will be used for the service specific API calls
       #
-      # Otherwise the service specific api_version is looked up from @@providers_hash
+      # Otherwise the service specific api_version is looked up from configuration.providers
       #
       # Finally api_version in armrest_configuration is used if service specific version
       # cannot be determined
       def set_service_api_version(options, service)
-        set_providers_info
         @api_version =
-          if options.has_key?('api_version')
-            options['api_version']
-          elsif @@providers_hash.has_key?(provider.downcase)
-            @@providers_hash[provider.downcase][service.downcase]['api_version']
-          else
-            configuration.api_version
-          end
+          options['api_version'] ||
+          configuration.provider_default_api_version(provider, service) ||
+          configuration.api_version
       end
 
       # Parse the skip token value out of the nextLink attribute from a response.