ms_rest_azure 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1fd75e8ce7055d583a565b1ad63b22cb96e3322
-  data.tar.gz: 6ee48c9a1ef81a288efb1ed71043c1512d61bf8e
+  metadata.gz: 1f02aa4a5f0f8b2921a5e860162384b487efec77
+  data.tar.gz: 22e137ece42e719d79266148e10262fc84dc6a11
 SHA512:
-  metadata.gz: b8422b73a85b09725a67aeec31f1cacb520a45bf4e83e1247e1370544f272a78c4dcc4a91d7bc3bf383c8ce58bb2970fdb42f812c6e18b15c278c7aaa64ca6c2
-  data.tar.gz: 0a3ca8b657be867f3a8584fc073157c66648764a7bfbea20ae86530426769d4672d96560aa6a095177a2258d3cf5530b7463b6aaec15d13b25c2d2341a407a77
+  metadata.gz: b33afbd1c77c7c466befa4f5c7960e9fd1c0c4f5a3415f2e35739ed96ae18b4b2fce47ea22e16f456a5e9654cfca838ca4b9c6d098d6761da5a9e982b8968eb8
+  data.tar.gz: 7b6f2991cf5430cb0eca947aeacd648c7e0c2dcb18147a66c94e981d59b5e7f5761f29f0008624b0a71e755eab018d526b1afaf36aeb621068b7f703888d9a6e

data/{ChangeLog.md → CHANGELOG.md}

@@ -1,3 +1,9 @@
+##2016.09.15 ms_rest_azure version 0.5.0
+* Updating ms_rest dependecy to version 0.5.0
+* Adding known Azure Environments in ruby runtime for easy discovery
+* Default Azure active directory url is updated from `https://login.windows.net/` to `https://login.microsoftonline.com/` (Breaking Change)
+* Using bundled default ca-cert from ms_rest
+
 ##2016.08.10 ms_rest_azure version 0.4.0
 * Adding & inheriting serialization class from ms_rest generic serializer
 

data/README.md

@@ -38,7 +38,7 @@ To start working on the gem the only additional dev dependecy is required - rspe
 Reference it in the gemfile and also add this line to your client's gemspec file:
 
 ```ruby
-spec.add_runtime_dependency 'ms_rest_azure', '~> 0.4.0'
+spec.add_runtime_dependency 'ms_rest_azure', '~> 0.5.0'
 ```
 
 Don't forget to correct the version.

data/lib/ms_rest_azure.rb

@@ -3,21 +3,20 @@
 # Licensed under the MIT License. See License.txt in the project root for license information.
 
 require 'ms_rest'
-
-require 'ms_rest_azure/version'
-
+require 'ms_rest_azure/active_directory_service_settings.rb'
+require 'ms_rest_azure/async_operation_status.rb'
+require 'ms_rest_azure/azure_environment.rb'
+require 'ms_rest_azure/azure_operation_error.rb'
+require 'ms_rest_azure/azure_operation_response.rb'
+require 'ms_rest_azure/azure_service_client.rb'
+require 'ms_rest_azure/cloud_error_data.rb'
 require 'ms_rest_azure/credentials/application_token_provider.rb'
-
+require 'ms_rest_azure/polling_state.rb'
 require 'ms_rest_azure/resource.rb'
 require 'ms_rest_azure/serialization.rb'
 require 'ms_rest_azure/sub_resource.rb'
-require 'ms_rest_azure/cloud_error_data.rb'
-require 'ms_rest_azure/azure_operation_error.rb'
-require 'ms_rest_azure/azure_operation_response.rb'
-require 'ms_rest_azure/async_operation_status.rb'
-require 'ms_rest_azure/polling_state.rb'
-require 'ms_rest_azure/active_directory_service_settings.rb'
-require 'ms_rest_azure/azure_service_client.rb'
+require 'ms_rest_azure/version'
 
 module MsRestAzure end
 module MsRestAzure::Serialization end
+module MsRestAzure::AzureEnvironments end

data/lib/ms_rest_azure/active_directory_service_settings.rb

@@ -19,10 +19,7 @@ module MsRestAzure
     #
     # @return [ActiveDirectoryServiceSettings] settings required for authentication.
     def self.get_azure_settings
-      settings = ActiveDirectoryServiceSettings.new
-      settings.authentication_endpoint = 'https://login.windows.net/'
-      settings.token_audience = 'https://management.core.windows.net/'
-      settings
+      get_settings(MsRestAzure::AzureEnvironments::Azure)
     end
 
     #
@@ -30,9 +27,36 @@ module MsRestAzure
     #
     # @return [ActiveDirectoryServiceSettings] settings required for authentication.
     def self.get_azure_china_settings
+      get_settings(MsRestAzure::AzureEnvironments::AzureChina)
+    end
+
+    #
+    # Returns a set of properties required to login into Azure German Cloud.
+    #
+    # @return [ActiveDirectoryServiceSettings] settings required for authentication.
+    def self.get_azure_german_settings
+      get_settings(MsRestAzure::AzureEnvironments::AzureGermanCloud)
+    end
+
+    #
+    # Returns a set of properties required to login into Azure US Government.
+    #
+    # @return [ActiveDirectoryServiceSettings] settings required for authentication.
+    def self.get_azure_us_government_settings
+      get_settings(MsRestAzure::AzureEnvironments::AzureUSGovernment)
+    end
+
+    private
+
+    #
+    # Returns a set of properties required to login into Azure Cloud.
+    #
+    # @param azure_environment [AzureEnvironment] An instance of AzureEnvironment.
+    # @return [ActiveDirectoryServiceSettings] settings required for authentication.
+    def self.get_settings(azure_environment = MsRestAzure::AzureEnvironments::Azure)
       settings = ActiveDirectoryServiceSettings.new
-      settings.authentication_endpoint = 'https://login.chinacloudapi.cn/'
-      settings.token_audience = 'https://management.core.chinacloudapi.cn/'
+      settings.authentication_endpoint = azure_environment.active_directory_endpoint_url
+      settings.token_audience = azure_environment.active_directory_resource_id
       settings
     end
   end

data/lib/ms_rest_azure/azure_environment.rb

@@ -0,0 +1,163 @@
+# encoding: utf-8
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+
+module MsRestAzure
+  module AzureEnvironments
+    #
+    # An instance of this class describes an environment in Azure
+    #
+    class AzureEnvironment
+
+      # @return [String] the Environment name
+      attr_reader :name
+
+      # @return [String] the management portal URL
+      attr_reader :portal_url
+
+      # @return [String] the publish settings file URL
+      attr_reader :publishing_profile_url
+
+      # @return [String] the management service endpoint
+      attr_reader :management_endpoint_url
+
+      # @return [String] the resource management endpoint
+      attr_reader :resource_manager_endpoint_url
+
+      # @return [String] the sql server management endpoint for mobile commands
+      attr_reader :sql_management_endpoint_url
+
+      # @return [String] the dns suffix for sql servers
+      attr_reader :sql_server_hostname_suffix
+
+      # @return [String] the template gallery endpoint
+      attr_reader :gallery_endpoint_url
+
+      # @return [String] the Active Directory login endpoint
+      attr_reader :active_directory_endpoint_url
+
+      # @return [String] the resource ID to obtain AD tokens for
+      attr_reader :active_directory_resource_id
+
+      # @return [String] the Active Directory resource ID
+      attr_reader :active_directory_graph_resource_id
+
+      # @return [String] the Active Directory resource ID
+      attr_reader :active_directory_graph_api_version
+
+      # @return [String] the endpoint suffix for storage accounts
+      attr_reader :storage_endpoint_suffix
+
+      # @return [String] the KeyVault service dns suffix
+      attr_reader :key_vault_dns_suffix
+
+      # @return [String] the data lake store filesystem service dns suffix
+      attr_reader :datalake_store_filesystem_endpoint_suffix
+
+      # @return [String] the data lake analytics job and catalog service dns suffix
+      attr_reader :datalake_analytics_catalog_and_job_endpoint_suffix
+
+      # @return [Boolean] determines whether the authentication endpoint should be validated with Azure AD. Default value is true.
+      attr_reader :validate_authority
+
+      def initialize(options)
+        required_properties = [:name, :portal_url, :management_endpoint_url, :resource_manager_endpoint_url, :active_directory_endpoint_url, :active_directory_resource_id]
+
+        required_supplied_properties = required_properties & options.keys
+
+        if required_supplied_properties.nil? || required_supplied_properties.empty? || (required_supplied_properties & required_properties) != required_properties
+          raise ArgumentError.new("#{required_properties.to_s} are the required properties but provided properties are #{options.to_s}")
+        end
+
+        required_supplied_properties.each do |prop|
+          if options[prop].nil? || !options[prop].is_a?(String) || options[prop].empty?
+            raise ArgumentError.new("Value of the '#{prop}' property must be of type String and non empty.")
+          end
+        end
+
+        # Setting default to true
+        @validate_authority = true
+
+        options.each do |k, v|
+          instance_variable_set("@#{k}", v) unless v.nil?
+        end
+      end
+    end
+
+    Azure = AzureEnvironments::AzureEnvironment.new({
+                                                        :name => 'Azure',
+                                                        :portal_url => 'http://go.microsoft.com/fwlink/?LinkId=254433',
+                                                        :publishing_profile_url => 'http://go.microsoft.com/fwlink/?LinkId=254432',
+                                                        :management_endpoint_url => 'https://management.core.windows.net',
+                                                        :resource_manager_endpoint_url => 'https://management.azure.com/',
+                                                        :sql_management_endpoint_url => 'https://management.core.windows.net:8443/',
+                                                        :sql_server_hostname_suffix => '.database.windows.net',
+                                                        :gallery_endpoint_url => 'https://gallery.azure.com/',
+                                                        :active_directory_endpoint_url => 'https://login.microsoftonline.com/',
+                                                        :active_directory_resource_id => 'https://management.core.windows.net/',
+                                                        :active_directory_graph_resource_id => 'https://graph.windows.net/',
+                                                        :active_directory_graph_api_version => '2013-04-05',
+                                                        :storage_endpoing_suffix => '.core.windows.net',
+                                                        :key_vault_dns_suffix => '.vault.azure.net',
+                                                        :datalake_store_filesystem_endpoint_suffix => 'azuredatalakestore.net',
+                                                        :datalake_analytics_catalog_and_job_endpoint_suffix => 'azuredatalakeanalytics.net'
+                                                    })
+    AzureChina = AzureEnvironments::AzureEnvironment.new({
+                                                             :name => 'AzureChina',
+                                                             :portal_url => 'http://go.microsoft.com/fwlink/?LinkId=301902',
+                                                             :publishing_profile_url => 'http://go.microsoft.com/fwlink/?LinkID=301774',
+                                                             :management_endpoint_url => 'https://management.core.chinacloudapi.cn',
+                                                             :resource_manager_endpoint_url => 'https://management.chinacloudapi.cn',
+                                                             :sql_management_endpoint_url => 'https://management.core.chinacloudapi.cn:8443/',
+                                                             :sql_server_hostname_suffix => '.database.chinacloudapi.cn',
+                                                             :gallery_endpoint_url => 'https://gallery.chinacloudapi.cn/',
+                                                             :active_directory_endpoint_url => 'https://login.chinacloudapi.cn/',
+                                                             :active_directory_resource_id => 'https://management.core.chinacloudapi.cn/',
+                                                             :active_directory_graph_resource_id => 'https://graph.chinacloudapi.cn/',
+                                                             :active_directory_graph_api_version => '2013-04-05',
+                                                             :storage_endpoing_suffix => '.core.chinacloudapi.cn',
+                                                             :key_vault_dns_suffix => '.vault.azure.cn',
+                                                             # TODO: add dns suffixes for the china cloud for datalake store and datalake analytics once they are defined.
+                                                             :datalake_store_filesystem_endpoint_suffix => 'N/A',
+                                                             :datalake_analytics_catalog_and_job_endpoint_suffix => 'N/A'
+                                                         })
+    AzureUSGovernment = AzureEnvironments::AzureEnvironment.new({
+                                                                    :name => 'AzureUSGovernment',
+                                                                    :portal_url => 'https://manage.windowsazure.us',
+                                                                    :publishing_profile_url => 'https://manage.windowsazure.us/publishsettings/index',
+                                                                    :management_endpoint_url => 'https://management.core.usgovcloudapi.net',
+                                                                    :resource_manager_endpoint_url => 'https://management.usgovcloudapi.net',
+                                                                    :sql_management_endpoint_url => 'https://management.core.usgovcloudapi.net:8443/',
+                                                                    :sql_server_hostname_suffix => '.database.usgovcloudapi.net',
+                                                                    :gallery_endpoint_url => 'https://gallery.usgovcloudapi.net/',
+                                                                    :active_directory_endpoint_url => 'https://login.microsoftonline.com/',
+                                                                    :active_directory_resource_id => 'https://management.core.usgovcloudapi.net/',
+                                                                    :active_directory_graph_resource_id => 'https://graph.windows.net/',
+                                                                    :active_directory_graph_api_version => '2013-04-05',
+                                                                    :storage_endpoing_suffix => '.core.usgovcloudapi.net',
+                                                                    :key_vault_dns_suffix => '.vault.usgovcloudapi.net',
+                                                                    # TODO: add dns suffixes for the US government for datalake store and datalake analytics once they are defined.
+                                                                    :datalake_store_filesystem_endpoint_suffix => 'N/A',
+                                                                    :datalake_analytics_catalog_and_job_endpoint_suffix => 'N/A'
+                                                                })
+    AzureGermanCloud = AzureEnvironments::AzureEnvironment.new({
+                                                                   :name => 'AzureGermanCloud',
+                                                                   :portal_url => 'http://portal.microsoftazure.de/',
+                                                                   :publishing_profile_url => 'https://manage.microsoftazure.de/publishsettings/index',
+                                                                   :management_endpoint_url => 'https://management.core.cloudapi.de',
+                                                                   :resource_manager_endpoint_url => 'https://management.microsoftazure.de',
+                                                                   :sql_management_endpoint_url => 'https://management.core.cloudapi.de:8443/',
+                                                                   :sql_server_hostname_suffix => '.database.cloudapi.de',
+                                                                   :gallery_endpoint_url => 'https://gallery.cloudapi.de/',
+                                                                   :active_directory_endpoint_url => 'https://login.microsoftonline.de/',
+                                                                   :active_directory_resource_id => 'https://management.core.cloudapi.de/',
+                                                                   :active_directory_graph_resource_id => 'https://graph.cloudapi.de/',
+                                                                   :active_directory_graph_api_version => '2013-04-05',
+                                                                   :storage_endpoing_suffix => '.core.cloudapi.de',
+                                                                   :key_vault_dns_suffix => '.vault.microsoftazure.de',
+                                                                   # TODO: add dns suffixes for the US government for datalake store and datalake analytics once they are defined.
+                                                                   :datalake_store_filesystem_endpoint_suffix => 'N/A',
+                                                                   :datalake_analytics_catalog_and_job_endpoint_suffix => 'N/A'
+                                                               })
+  end
+end

data/lib/ms_rest_azure/credentials/application_token_provider.rb

@@ -91,7 +91,7 @@ module MsRestAzure
 
       url = URI.parse(token_acquire_url)
 
-      connection = Faraday.new(:url => url) do |builder|
+      connection = Faraday.new(:url => url, :ssl => MsRest.ssl_options) do |builder|
         builder.adapter Faraday.default_adapter
       end
 

data/lib/ms_rest_azure/polling_state.rb

@@ -110,7 +110,7 @@ module MsRestAzure
     attr_accessor :connection
 
     def create_connection(base_url)
-      @connection ||= Faraday.new(:url => base_url) do |faraday|
+      @connection ||= Faraday.new(:url => base_url, :ssl => MsRest.ssl_options) do |faraday|
         [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]].each{ |args| faraday.use(*args) }
         faraday.adapter Faraday.default_adapter
         faraday.headers = request.headers

data/lib/ms_rest_azure/version.rb

@@ -3,5 +3,5 @@
 # Licensed under the MIT License. See License.txt in the project root for license information.
 
 module MsRestAzure
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ms_rest_azure
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Microsoft Corporation
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-10 00:00:00.000000000 Z
+date: 2016-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,30 +114,27 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
 description: Azure Client Library for Ruby.
 email: azsdkteam@microsoft.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- ChangeLog.md
-- Gemfile
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/ms_rest_azure.rb
 - lib/ms_rest_azure/active_directory_service_settings.rb
 - lib/ms_rest_azure/async_operation_status.rb
+- lib/ms_rest_azure/azure_environment.rb
 - lib/ms_rest_azure/azure_operation_error.rb
 - lib/ms_rest_azure/azure_operation_response.rb
 - lib/ms_rest_azure/azure_service_client.rb
@@ -148,7 +145,6 @@ files:
 - lib/ms_rest_azure/serialization.rb
 - lib/ms_rest_azure/sub_resource.rb
 - lib/ms_rest_azure/version.rb
-- ms_rest_azure.gemspec
 homepage: https://github.com/Azure/autorest
 licenses:
 - MIT
@@ -169,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Azure Client Library for Ruby.

data/.gitignore

@@ -1,10 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-.ruby-version

data/.travis.yml

@@ -1,3 +0,0 @@
-language: ruby
-rvm:
-  - 2.1.5

data/Gemfile

@@ -1,16 +0,0 @@
-# encoding: utf-8
-# Copyright (c) Microsoft Corporation. All rights reserved.
-# Licensed under the MIT License. See License.txt in the project root for license information.
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in ms_rest_azure.gemspec
-gemspec
-
-group :development do
-  gem 'ms_rest', path: '../ms-rest'
-end
-
-group :test do
-  gem 'rspec'
-end

data/Rakefile

@@ -1,5 +0,0 @@
-# encoding: utf-8
-# Copyright (c) Microsoft Corporation. All rights reserved.
-# Licensed under the MIT License. See License.txt in the project root for license information.
-
-require "bundler/gem_tasks"

data/ms_rest_azure.gemspec

@@ -1,36 +0,0 @@
-# Copyright (c) Microsoft Corporation. All rights reserved.
-# Licensed under the MIT License. See License.txt in the project root for license information.
-
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ms_rest_azure/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'ms_rest_azure'
-  spec.version       = MsRestAzure::VERSION
-  spec.authors       = 'Microsoft Corporation'
-  spec.email         = 'azsdkteam@microsoft.com'
-
-  spec.summary       = %q{Azure Client Library for Ruby.}
-  spec.description   = %q{Azure Client Library for Ruby.}
-  spec.homepage      = 'https://github.com/Azure/autorest'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = 'bin'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.required_ruby_version = '>= 1.9.3'
-
-  spec.add_development_dependency 'bundler', '~> 1.9'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.3'
-
-  spec.add_runtime_dependency 'json', '~> 1.7'
-  spec.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
-  spec.add_runtime_dependency 'faraday', '~> 0.9'
-  spec.add_runtime_dependency 'faraday-cookie_jar', '~> 0.0.6'
-  spec.add_runtime_dependency 'ms_rest', '~> 0.4.0'
-end