azure-armrest 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 172b9e9bbaf79e6ce3b794516c9d03871b1bbefd
-  data.tar.gz: 22f969732daa71dd7f072485ac5f491cd7649ff7
+  metadata.gz: b525251ef80821ff56d3acea755a8861afda77fa
+  data.tar.gz: 7b349ae37b233c3c0f120c7dfbbcc7572cab8ec3
 SHA512:
-  metadata.gz: 389e975c413a315045b02edc52920f623df4df1fa576d9bc788b8653d342e2cbcab7008ff3a14828248df436f759df3181458c963c0a39b61c19c7ab4a3f7f26
-  data.tar.gz: a888720f50eefa4ab1ce91b23ae19beecd82cc2e6f670133af0d86d44d4f7f9daa00c7567a6b06458518d683c6551afa5b2ee696e507e88a8da60a53011082df
+  metadata.gz: 9ff548c71449012c821ee00355ab71dd2d58b47594d76257c0fe3237da3a8fad55233b1fee8e17769655cb18633af1923c6225083c6f4ef056a30300e6ae5613
+  data.tar.gz: 202570079f1463b424937e400352c46f5ad7bf36889e57d261eced1908aee1b9a9a26ae96b230edc0d4b9277f2ebf46aa7dee42ef28fd20aee22436499d83d04

data/CHANGES

@@ -1,3 +1,10 @@
+= 0.5.0 - 20-Dec-2016
+* Added the Azure::Armrest::Environment class. The Configuration#environment
+  option now takes an Environment instance. There are two predefined instances
+  that you can use - Public or USGovernment. The default is Public.
+* Fixed bugs caused by altering the base_url. This affected the tags and
+  tenants methods, as well as the VirtualMachineService#series method.
+
 = 0.4.2 - 19-Dec-2016
 * Added the delete_by_id method, so you can now delete by ID string.
 * Added the TemplateDeploymentService#delete_associated_resources method. 

data/lib/azure/armrest.rb

@@ -7,29 +7,15 @@ require 'cache_method'
 
 # The Azure module serves as a namespace.
 module Azure
-
   # The Armrest module mostly serves as a namespace, but also contains any
   # common constants shared by subclasses.
   module Armrest
-    # The default (public) Azure resource
-    RESOURCE = "https://management.azure.com/"
-
-    # The resource for US Government clients
-    USGOV_RESOURCE = "https://management.core.usgovcloudapi.net/"
-
-    # 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
 
 require 'azure/armrest/version'
 require 'azure/armrest/configuration'
+require 'azure/armrest/environment'
 require 'azure/armrest/exception'
 require 'azure/armrest/armrest_collection'
 require 'azure/armrest/armrest_service'

data/lib/azure/armrest/armrest_service.rb

@@ -46,7 +46,11 @@ module Azure
         end
 
         # Base URL used for REST calls. Modify within method calls as needed.
-        @base_url = File.join(configuration.resource_url, 'subscriptions', configuration.subscription_id)
+        @base_url = File.join(
+          configuration.environment.resource_url,
+          'subscriptions',
+          configuration.subscription_id
+        )
 
         set_service_api_version(options, service_name)
       end
@@ -135,13 +139,7 @@ module Azure
       # Returns a list of tags for the current subscription.
       #
       def tags
-        url = url_with_api_version(
-          configuration.api_version,
-          @base_url,
-          'subscriptions',
-          configuration.subscription_id,
-          'tagNames'
-        )
+        url = url_with_api_version(configuration.api_version, base_url, 'tagNames')
         resp = rest_get(url)
         JSON.parse(resp.body)["value"].map{ |hash| Azure::Armrest::Tag.new(hash) }
       end
@@ -149,7 +147,7 @@ module Azure
       # Returns a list of tenants that can be accessed.
       #
       def tenants
-        url = url_with_api_version(configuration.api_version, @base_url, 'tenants')
+        url = url_with_api_version(configuration.api_version, configuration.resource_url, 'tenants')
         resp = rest_get(url)
         JSON.parse(resp.body)['value'].map{ |hash| Azure::Armrest::Tenant.new(hash) }
       end

data/lib/azure/armrest/configuration.rb

@@ -64,14 +64,9 @@ 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
+      # The environment object which determines various endpoint URL's. The
+      # default is Azure::Armrest::Environment::Public.
+      attr_accessor :environment
 
       # Yields a new Azure::Armrest::Configuration objects. Note that you must
       # specify a client_id, client_key, tenant_id. The subscription_id is optional
@@ -106,8 +101,7 @@ module Azure
           :proxy         => ENV['http_proxy'],
           :ssl_version   => 'TLSv1',
           :max_threads   => 10,
-          :authority_url => Azure::Armrest::AUTHORITY,
-          :resource_url  => Azure::Armrest::RESOURCE
+          :environment   => Azure::Armrest::Environment::Public
         }.merge(args.symbolize_keys)
 
         # Avoid thread safety issues for VCR testing.
@@ -218,28 +212,6 @@ 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.
       #
@@ -307,7 +279,7 @@ module Azure
       end
 
       def fetch_token
-        token_url = File.join(authority_url, tenant_id, 'oauth2/token')
+        token_url = File.join(environment.authority_url, tenant_id, 'oauth2', 'token')
 
         response = JSON.parse(
           ArmrestService.send(
@@ -320,7 +292,7 @@ module Azure
               :grant_type    => grant_type,
               :client_id     => client_id,
               :client_secret => client_key,
-              :resource      => resource_url
+              :resource      => environment.resource_url
             }
           )
         )

data/lib/azure/armrest/environment.rb

@@ -0,0 +1,124 @@
+module Azure
+  module Armrest
+    class Environment
+      # A list of valid keys that can be passed to the constructor
+      VALID_KEYS = [ 
+        :name,
+        :active_directory_authority,
+        :active_directory_resource_id,
+        :gallery_url,
+        :graph_url,
+        :graph_api_version,
+        :key_vault_dns_suffix,
+        :key_vault_service_resource_id,
+        :publish_settings_file_url,
+        :resource_manager_url,
+        :service_management_url,
+        :sql_database_dns_suffix,
+        :storage_suffix,
+        :traffic_manager_dns_suffix
+      ]
+
+      # The Environment name
+      attr_reader :name
+
+      # The authority used to acquire an AD token
+      attr_reader :active_directory_authority
+
+      # The resource ID used to obtain an AD token
+      attr_reader :active_directory_resource_id
+
+      # The template gallery endpoint
+      attr_reader :gallery_url
+
+      # The Active Directory resource ID
+      attr_reader :graph_url
+
+      # The api-version for Active Directory
+      attr_reader :graph_api_version
+
+      # The KeyValut service DNS suffix
+      attr_reader :key_vault_dns_suffix
+
+      # The KeyVault service resource ID
+      attr_reader :key_vault_service_resource_id
+
+      # The publish settings file URL
+      attr_reader :publish_settings_file_url
+
+      # The resource management endpoint
+      attr_reader :resource_manager_url
+
+      # The service management URL
+      attr_reader :service_management_url
+
+      # The DNS suffix for SQL Server instances
+      attr_reader :sql_database_dns_suffix
+
+      # The endpoint suffix for storage accounts
+      attr_reader :storage_suffix
+
+      # The DNS suffix for TrafficManager
+      attr_reader :traffic_manager_dns_suffix
+
+      # Creates a new Azure::Armrest::Environment object. At a minimum, the
+      # options hash must include the :name, :active_directory_authority and
+      # :active_directory_resource_id.
+      #
+      # Note that there are pre-generated environments already for Public
+      # and US Government environments.
+      #
+      def initialize(options)
+        options.symbolize_keys.each do |key, value|
+          raise ArgumentError, "Invalid key '#{key}'" unless VALID_KEYS.include?(key)
+          instance_variable_set("@#{key}", value)
+        end
+
+        [:name, :active_directory_authority, :resource_manager_url].each do |key|
+          unless instance_variable_get("@#{key}")
+            raise ArgumentError, "Mandatory argument '#{key}' not set"
+          end
+        end
+      end
+
+      alias authority_url active_directory_authority
+      alias resource_url resource_manager_url
+
+      # Pre-generated environments
+
+      Public = self.new(
+        :name                          => 'Public',
+        :active_directory_authority    => 'https://login.microsoftonline.com/',
+        :active_directory_resource_id  => 'https://management.core.windows.net/',
+        :gallery_url                   => 'https://gallery.azure.com/',
+        :graph_url                     => 'https://graph.windows.net/',
+        :graph_api_version             => '1.6',
+        :key_vault_dns_suffix          => 'vault.azure.net',
+        :key_vault_service_resource_id => 'https://vault.azure.net',
+        :publish_settings_file_url     => 'https://manage.windowsazure.com/publishsettings/index',
+        :resource_manager_url          => 'https://management.azure.com/',
+        :service_management_url        => 'https://management.core.windows.net/',
+        :sql_database_dns_suffix       => 'database.windows.net',
+        :storage_suffix                => 'core.windows.net',
+        :traffic_manager_dns_suffix    => 'trafficmanager.net',
+      )
+
+      USGovernment = self.new(
+        :name                          => 'US Government',
+        :active_directory_authority    => 'https://login-us.microsoftonline.com/',
+        :active_directory_resource_id  => 'https://management.core.usgovcloudapi.net/',
+        :gallery_url                   => 'https://gallery.usgovcloudapi.net/',
+        :graph_url                     => 'https://graph.windows.net/',
+        :graph_api_version             => '1.6',
+        :key_vault_dns_suffix          => 'vault.usgovcloudapi.net',
+        :key_vault_service_resource_id => 'https://vault.usgovcloudapi.net',
+        :publish_settings_file_url     => 'https://manage.windowsazure.us/publishsettings/index',
+        :resource_manager_url          => 'https://management.usgovcloudapi.net/',
+        :service_management_url        => 'https://management.core.usgovcloudapi.net/',
+        :sql_database_dns_suffix       => 'database.usgovcloudapi.net',
+        :storage_suffix                => 'core.usgovcloudapi.net',
+        :traffic_manager_dns_suffix    => 'usgovtrafficmanager.net',
+      )
+    end
+  end
+end

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

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

data/lib/azure/armrest/resource_group_based_service.rb

@@ -107,7 +107,7 @@ module Azure
                                          info['subservice_name'])
         service_name = info['subservice_name'] || info['service_name'] || 'resourceGroups'
 
-        url = File.join(configuration.resource_url, id_string) + "?api-version=#{api_version}"
+        url = File.join(configuration.environment.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"
@@ -120,10 +120,8 @@ module Azure
 
       def delete_by_id(id_string)
         info = parse_id_string(id_string)
-        api_version = api_version_lookup(info['provider'],
-                                         info['service_name'],
-                                         info['subservice_name'])
-        url = File.join(configuration.resource_url, id_string) + "?api-version=#{api_version}"
+        api_version = api_version_lookup(info['provider'], info['service_name'], info['subservice_name'])
+        url = File.join(configuration.environment.resource_url, id_string) + "?api-version=#{api_version}"
 
         delete_by_url(url, id_string)
       end
@@ -217,7 +215,7 @@ module Azure
       # arguments provided, and appends it with the api_version.
       #
       def build_url(resource_group = nil, *args)
-        url = File.join(configuration.resource_url, build_id_string(resource_group, *args))
+        url = File.join(configuration.environment.resource_url, build_id_string(resource_group, *args))
         url << "?api-version=#{@api_version}"
       end
 

data/lib/azure/armrest/resource_provider_service.rb

@@ -61,7 +61,7 @@ module Azure
       end
 
       def _list_all
-        url = File.join(configuration.resource_url, 'providers')
+        url = File.join(configuration.environment.resource_url, 'providers')
         url << "?api-version=#{@api_version}"
         response = rest_get(url)
         JSON.parse(response)['value']

data/lib/azure/armrest/resource_service.rb

@@ -56,7 +56,7 @@ module Azure
       #
       def move(source_group, source_subscription = configuration.subscription_id)
         url = File.join(
-          configuration.resource_url,
+          configuration.environment.resource_url,
           'subscriptions',
           source_subscription,
           'resourcegroups',
@@ -78,7 +78,7 @@ module Azure
       #
       def check_resource(resource_name, resource_type)
         body = JSON.dump(:Name => resource_name, :Type => resource_type)
-        url = File.join(Azure::Armrest::RESOURCE, 'providers', provider, 'checkresourcename')
+        url = File.join(configuration.environment.resource_url, 'providers', provider, 'checkresourcename')
         url << "?api-version=#{@api_version}"
 
         response = rest_post(url, body)

data/lib/azure/armrest/subscription_service.rb

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

data/lib/azure/armrest/version.rb

@@ -1,6 +1,6 @@
 module Azure
   module Armrest
     # The version of the azure-armrest library.
-    VERSION = '0.4.2'.freeze
+    VERSION = '0.5.0'.freeze
   end
 end

data/lib/azure/armrest/virtual_machine_service.rb

@@ -28,8 +28,7 @@ module Azure
         end
 
         url = url_with_api_version(
-          version, @base_url, 'subscriptions', configuration.subscription_id,
-          'providers', provider, 'locations', location, 'vmSizes'
+          version, base_url, 'providers', provider, 'locations', location, 'vmSizes'
         )
 
         JSON.parse(rest_get(url))['value'].map{ |hash| VirtualMachineSize.new(hash) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: azure-armrest
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-19 00:00:00.000000000 Z
+date: 2016-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -238,6 +238,7 @@ files:
 - lib/azure/armrest/availability_set_service.rb
 - lib/azure/armrest/billing/usage_service.rb
 - lib/azure/armrest/configuration.rb
+- lib/azure/armrest/environment.rb
 - lib/azure/armrest/exception.rb
 - lib/azure/armrest/insights/alert_service.rb
 - lib/azure/armrest/insights/diagnostic_service.rb