azure-armrest 0.3.13 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b520aacacd8fdef3e6e2ac80c456d2abcb283bd
-  data.tar.gz: 0a566e5530a3f87f153775905767cdab27eb1644
+  metadata.gz: 27744a66e69a816479bb6dc1d7a2bb5070d42717
+  data.tar.gz: b1ded209d9ff4e9c8bde0981e55c5b95586a4511
 SHA512:
-  metadata.gz: 89e70a7bc4e5e822fe239260a5cc0f17b5e6bb06dec78373c64ab6f0a84b44f5a95295e257429fd29c64b5dbe3fe43675bc9fb86b6e26d7d7e83f459ff8f0260
-  data.tar.gz: d1dd5813b5681bfea7ffdb2a92e3d5265e49a3a451a5142a534e341c8e2d9d7d59bbcaf83ccfcd2dc6b3183c89cca2b32372d6c0f0e7cd4b0a3dd0ce369d4b44
+  metadata.gz: 6aaa5ae7fd87a32a0727e0965e84ece73ae426159ce9f49c54c6cd90e23ddc6f4939df8eda1f45ee5a8543f0fce7399dd5870fbddf87f556aa38ea3ec93fe5d3
+  data.tar.gz: 8dc378aa589e06f5d45c387356d83f23ed489796bab3289c9443344514d3726d467b6085047c37260235bee908857280739f3efa9bae59f0e340d141cda7199b

data/CHANGES

@@ -1,3 +1,12 @@
+= 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
+  classes. The verification now happens later, within the Service constructor.
+* Added the SubscriptionService class. This does not require a subscription ID
+  in advance, so you can get a list of subscriptions for a tenant.
+* The Configuration#subscription_id= and Configuration#proxy= writer methods
+  now have custom implementations.
+
 = 0.3.13 - 30-Nov-2016
 * Fixed the Billing::Usage model class name.
 * Updated the Billing::Usage#list method so that it returns an ArmrestCollection

data/lib/azure/armrest.rb

@@ -27,6 +27,7 @@ require 'azure/armrest/configuration'
 require 'azure/armrest/exception'
 require 'azure/armrest/armrest_collection'
 require 'azure/armrest/armrest_service'
+require 'azure/armrest/subscription_service'
 require 'azure/armrest/resource_group_based_service'
 require 'azure/armrest/resource_group_based_subservice'
 require 'azure/armrest/storage_account_service'

data/lib/azure/armrest/armrest_service.rb

@@ -41,6 +41,10 @@ module Azure
         @service_name = service_name
         @provider = options[:provider] || default_provider
 
+        if configuration.subscription_id.nil?
+          raise ArgumentError, 'subscription_id must be specified for this Service class'
+        end
+
         # Base URL used for REST calls. Modify within method calls as needed.
         @base_url = Azure::Armrest::RESOURCE
 
@@ -84,12 +88,9 @@ module Azure
         list.collect { |rp| rp.resource_types.map(&:locations) }.flatten.uniq.sort
       end
 
-      # Returns a list of Subscription objects for the tenant.
-      #
+      # Returns a list of subscriptions for the current tenant.
       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) }
+        Azure::Armrest::SubscriptionService.new(configuration).list
       end
 
       alias subscriptions list_subscriptions
@@ -100,15 +101,8 @@ module Azure
       # specified.
       #
       def get_subscription(subscription_id = configuration.subscription_id)
-        url = url_with_api_version(
-          configuration.api_version,
-          @base_url,
-          'subscriptions',
-          subscription_id
-        )
-
-        response = rest_get(url)
-        Azure::Armrest::Subscription.new(response.body)
+        subs = Azure::Armrest::SubscriptionService.new(configuration)
+        subs.get(subscription_id)
       end
 
       alias subscription_info get_subscription

data/lib/azure/armrest/configuration.rb

@@ -35,7 +35,7 @@ module Azure
       attr_accessor :tenant_id
 
       # The subscription ID used for each http request.
-      attr_accessor :subscription_id
+      attr_reader :subscription_id
 
       # The resource group used for http requests.
       attr_accessor :resource_group
@@ -50,7 +50,7 @@ module Azure
       attr_accessor :accept
 
       # Proxy to be used for all http requests.
-      attr_accessor :proxy
+      attr_reader :proxy
 
       # SSL version to be used for all http requests.
       attr_accessor :ssl_version
@@ -65,8 +65,8 @@ module Azure
       attr_accessor :max_threads
 
       # Yields a new Azure::Armrest::Configuration objects. Note that you must
-      # specify a client_id, client_key, tenant_id and subscription_id. All other
-      # parameters are optional.
+      # 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.
       #
       # Example:
       #
@@ -84,9 +84,8 @@ module Azure
       # Although you can specify an :api_version, it is typically overridden
       # by individual service classes.
       #
-      # Note that while the constructor will fail if invalid credentials are
-      # supplied, it does not validate your subscription ID. If you want to
-      # validate your subscription ID as well, use the validate_subscription! method.
+      # The constructor will also validate that the subscription ID is valid
+      # if present.
       #
       def initialize(args)
         # Use defaults, and override with provided arguments
@@ -106,31 +105,46 @@ module Azure
         user_token = options.delete(:token)
         user_token_expiration = options.delete(:token_expiration)
 
-        options.each { |key, value| send("#{key}=", value) }
+        # We need to ensure these are set before subscription_id=
+        @tenant_id = options.delete(:tenant_id)
+        @client_id = options.delete(:client_id)
+        @client_key = options.delete(:client_key)
 
-        unless client_id && client_key && tenant_id && subscription_id
-          raise ArgumentError, "client_id, client_key, tenant_id and subscription_id must all be specified"
+        unless client_id && client_key && tenant_id
+          raise ArgumentError, "client_id, client_key, and tenant_id must all be specified"
         end
 
-        # Allows for URI objects or Strings.
-        @proxy = @proxy.to_s if @proxy
-
-        validate_subscription
+        # Then set the remaining options automatically
+        options.each { |key, value| send("#{key}=", value) }
 
         if user_token && user_token_expiration
           set_token(user_token, user_token_expiration)
         elsif user_token || user_token_expiration
           raise ArgumentError, "token and token_expiration must be both specified"
         end
-
-        @providers = fetch_providers
-        set_provider_api_versions
       end
 
       def hash
         [tenant_id, client_id, client_key].join('_').hash
       end
 
+      # Allow for strings or URI objects when assigning a proxy.
+      #
+      def proxy=(value)
+        @proxy = value ? value.to_s : value
+      end
+
+      # Set the subscription ID, and validate the value. This also sets
+      # provider information.
+      #
+      def subscription_id=(value)
+        @subscription_id = value
+        validate_subscription
+        @providers = fetch_providers
+        set_provider_api_versions
+        value
+      end
+
       def eql?(other)
         return true if equal?(other)
         return false unless self.class == other.class
@@ -186,9 +200,16 @@ module Azure
         RestClient.log = output
       end
 
+      # Returns a list of subscriptions for the current configuration object.
+      #
+      def subscriptions
+        Azure::Armrest::SubscriptionService.new(self).list
+      end
+
       private
 
-      # Validate the subscription ID for the given credentials.
+      # Validate the subscription ID for the given credentials. Returns the
+      # subscription ID if valid.
       #
       # If the subscription ID that was provided in the constructor cannot
       # be found within the list of valid subscriptions, then an error is
@@ -198,36 +219,15 @@ module Azure
       # then a warning will be issued, but no error will be raised.
       #
       def validate_subscription
-        url = File.join(Azure::Armrest::RESOURCE, 'subscriptions') + "?api-version=#{api_version}"
-
-        options = {
-          :url         => url,
-          :proxy       => proxy,
-          :ssl_version => ssl_version,
-          :ssl_verify  => ssl_verify,
-          :headers     => {
-            :accept        => accept,
-            :content_type  => content_type,
-            :authorization => token
-          }
-        }
-
-        response = Azure::Armrest::ArmrestService.send(:rest_get, options)
-        json = JSON.parse(response.body)['value']
-
-        subscriptions = json.map { |hash| [hash['subscriptionId'], hash['state']] }
-
-        found = subscriptions.find { |array| array.first == subscription_id }
+        found = subscriptions.find { |sub| sub.subscription_id == subscription_id }
 
         unless found
           raise ArgumentError, "Subscription ID '#{subscription_id}' not found"
         end
 
-        if found.last.casecmp("enabled") != 0
-          warn "Subscription '#{found.first}' found but not enabled."
+        if found.state.casecmp('enabled') != 0
+          warn "Subscription '#{found.subscription_id}' found but not enabled."
         end
-
-        true
       end
 
       def ensure_token

data/lib/azure/armrest/subscription_service.rb

@@ -0,0 +1,35 @@
+module Azure
+  module Armrest
+    class SubscriptionService < ArmrestService
+      # This overrides the typical constructor for an ArmrestService subclass
+      # because it does not have a service name or a provider.
+      def initialize(configuration, options = {})
+        @armrest_configuration = configuration
+        @api_version = options[:api_version] || '2016-06-01'
+      end
+
+      # Returns a list of Subscription objects for the current tenant, one for
+      # each subscription ID.
+      #
+      def list
+        url = subscriptions_url + "?api-version=#{api_version}"
+        response = rest_get(url)
+        Azure::Armrest::ArmrestCollection.create_from_response(response, Azure::Armrest::Subscription)
+      end
+
+      # Returns a Subscription object for the given +subscription_id+.
+      #
+      def get(subscription_id)
+        url = File.join(subscriptions_url, subscription_id) + "?api-version=#{api_version}"
+        response = rest_get(url)
+        Azure::Armrest::Subscription.new(response)
+      end
+
+      private
+
+      def subscriptions_url
+        File.join(Azure::Armrest::RESOURCE, 'subscriptions')
+      end
+    end
+  end
+end

data/lib/azure/armrest/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: azure-armrest
 version: !ruby/object:Gem::Version
-  version: 0.3.13
+  version: 0.4.0
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-30 00:00:00.000000000 Z
+date: 2016-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -265,6 +265,7 @@ files:
 - lib/azure/armrest/sql/sql_database_service.rb
 - lib/azure/armrest/sql/sql_server_service.rb
 - lib/azure/armrest/storage_account_service.rb
+- lib/azure/armrest/subscription_service.rb
 - lib/azure/armrest/template_deployment_service.rb
 - lib/azure/armrest/version.rb
 - lib/azure/armrest/virtual_machine_extension_service.rb
@@ -290,7 +291,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: An interface for ARM/JSON Azure REST API