ms_rest_azure 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc34817f4903d18cc696dfd20e3d19045f9e592b
+  data.tar.gz: ee3c46de975b8a35bfc125cdfd25da680f5b14f0
+SHA512:
+  metadata.gz: c246b542c2e5bab01d8b30c571d9f302ac64f1428dbf1d108467eb776a27917976a2c9c2456b109dea600eff3ccdca6611294d623b4c93b8bb27a93a379c0732
+  data.tar.gz: de19f73216952f9487dc3e2762a1cb4406aa5cb54ba70b3cd29a45a0c53d599c180e95a8634b733a637b48bcd95803ff9c896c8f9584cead30a813b7361732e4

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,16 @@
+# 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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Microsoft Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# Intro
+
+MsRestAzure is a library which supports the Azure clients (SDKs) generated with Autorest tool. It contains core logic and helper classes for error handling and authentication. Also it includes azure specific logic like long polling functionality and Azure application authentication. Usually it is not supposed to be used as a standalone gem but only as a dependency for generated client gems.
+
+# Supported Ruby Versions
+
+* Ruby 1.9.3
+* Ruby 2.0
+* Ruby 2.1
+* Ruby 2.2
+
+Note: x64 Ruby for Windows is known to have some compatibility issues.
+
+# Installation
+
+install the appropriate gem:
+
+```
+gem install ms_rest_azure
+```
+
+and reference it in your code:
+
+```Ruby
+require 'ms_rest_azure'
+```
+
+# Running tests
+
+MsRestAzure has only unit tests which doesn't require any preparation, just run 'rspec' command from the gem directory.
+
+# Contribution
+
+To start working on the gem the only additional dev dependecy is required - rspec. After you've added a new feature and all specs pass - you're good to go with PR. But before starting any bug/feature - please make sure you've thoroughly discussed it with repository maintainers. This gem already powers a few SDKs and backward compatibility should taken in account.
+
+# Adding gem to you generated SDK
+
+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.1.0'
+```
+
+Don't forget to correct the version.
+
+# Provide feedback
+
+Send email to the azsdkteam@microsoft.com or file new issue in this repository.

data/Rakefile

@@ -0,0 +1,5 @@
+# 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/lib/ms_rest_azure.rb

@@ -0,0 +1,21 @@
+# 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 'ms_rest'
+
+require 'ms_rest_azure/version'
+
+require 'ms_rest_azure/credentials/application_token_provider.rb'
+
+require 'ms_rest_azure/resource.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'
+
+module MsRestAzure; end

data/lib/ms_rest_azure/active_directory_service_settings.rb

@@ -0,0 +1,39 @@
+# 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
+  #
+  # Class which represents an settings for Azure AD authentication.
+  #
+  class ActiveDirectoryServiceSettings
+
+    # @return [String] auth token.
+    attr_accessor :authentication_endpoint
+
+    # @return [String] auth token.
+    attr_accessor :token_audience
+
+    #
+    # Returns a set of properties required to login into regular Azure.
+    #
+    # @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
+    end
+
+    #
+    # Returns a set of properties required to login into Azure China.
+    #
+    # @return [ActiveDirectoryServiceSettings] settings required for authentication.
+    def self.get_azure_china_settings
+      settings = ActiveDirectoryServiceSettings.new
+      settings.authentication_endpoint = 'https://login.chinacloudapi.cn/'
+      settings.token_audience = 'https://management.core.chinacloudapi.cn/'
+      settings
+    end
+  end
+end

data/lib/ms_rest_azure/async_operation_status.rb

@@ -0,0 +1,77 @@
+# 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
+  #
+  # Defines values for AsyncOperationStatus enum.
+  #
+  class AsyncOperationStatus
+    IN_PROGRESS_STATUS = "InProgress"
+    SUCCESS_STATUS = "Succeeded"
+    FAILED_STATUS = "Failed"
+    CANCELED_STATUS = "Canceled"
+
+    ALL_STATUSES = [FAILED_STATUS, CANCELED_STATUS, SUCCESS_STATUS, IN_PROGRESS_STATUS]
+    FAILED_STATUSES = [FAILED_STATUS, CANCELED_STATUS]
+    TERMINAL_STATUSES = [FAILED_STATUS, CANCELED_STATUS, SUCCESS_STATUS]
+
+    DEFAULT_DELAY = 30
+
+    # @return [Integer] delay in seconds which should be used for polling for result of async operation.
+    attr_accessor :retry_after
+
+    # @return [MsRestAzure::CloudErrorData] error information about async operation.
+    attr_accessor :error
+
+    # @return [Stirng] status of polling.
+    attr_accessor :status
+
+    #
+    # Checks if given status is terminal one.
+    # @param status [String] status to verify
+    #
+    # @return [Boolean] True if given status is terminal one, false otherwise.
+    def self.is_terminal_status(status)
+      TERMINAL_STATUSES.any? { |st| st == status }
+    end
+
+    #
+    # Checks if given status is failed one.
+    # @param status [String] status to verify
+    #
+    # @return [Boolean] True if given status is failed one, false otherwise.
+    def self.is_failed_status(status)
+      FAILED_STATUSES.any? { |st| st == status }
+    end
+
+    #
+    # Checks if given status is successful one.
+    # @param status [String] status to verify
+    #
+    # @return [Boolean] True if given status is successful one, false otherwise.
+    def self.is_successful_status(status)
+      return status == SUCCESS_STATUS
+    end
+
+    #
+    # Deserializes given hash into AsyncOperationStatus object.
+    # @param object [Hash] object to deserialize.
+    #
+    # @return [AsyncOperationStatus] deserialized object.
+    def self.deserialize_object(object)
+      return if object.nil?
+      output_object = AsyncOperationStatus.new
+
+      fail AzureOperationError, 'Invalid status was recieved during polling' unless ALL_STATUSES.include?(object['status'])
+      output_object.status = object['status']
+
+      output_object.error = CloudErrorData.deserialize_object(object['error'])
+
+      output_object.retry_after = Integer(object['retryAfter']) unless object['retryAfter'].nil?
+
+      output_object
+    end
+  end
+
+end

data/lib/ms_rest_azure/azure_operation_error.rb

@@ -0,0 +1,11 @@
+# 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
+  #
+  # Class which represents an Azure error.
+  #
+  class AzureOperationError < MsRest::HttpOperationError
+  end
+end

data/lib/ms_rest_azure/azure_operation_response.rb

@@ -0,0 +1,14 @@
+# 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
+  #
+  # Class which represents the data received and deserialized from Azure service.
+  #
+  class AzureOperationResponse < MsRest::HttpOperationResponse
+
+    # @return [String] identificator of the request.
+    attr_accessor :request_id
+  end
+end

data/lib/ms_rest_azure/azure_service_client.rb

@@ -0,0 +1,326 @@
+# 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
+  #
+  # Class which represents a point of access to the REST API.
+  #
+  class AzureServiceClient < MsRest::ServiceClient
+
+    # @return [Integer] execution interval for long running operations.
+    attr_accessor :long_running_operation_retry_timeout
+
+    # @return [String] api version of the Azure in string format.
+    attr_accessor :api_version
+
+    #
+    # Retrieves the result of 'PUT' operation. Perfroms polling of required.
+    # @param azure_response [MsRestAzure::AzureOperationResponse] response from Azure service.
+    # @param custom_headers [Hash] custom HTTP headers to apply to HTTP requests.
+    # @param custom_deserialization_block [Proc] custom logic for response deserialization.
+    #
+    # @return [MsRest::HttpOperationResponse] the response.
+    def get_put_operation_result(azure_response, custom_headers, custom_deserialization_block)
+      fail MsRest::ValidationError, 'Azure response cannot be nil' if azure_response.nil?
+
+      status_code = azure_response.response.status
+
+      if (status_code != 200 && status_code != 201 && status_code != 202)
+        fail AzureOperationError, "Unexpected polling status code from long running operation #{status_code}"
+      end
+
+      polling_state = PollingState.new(azure_response, @long_running_operation_retry_timeout)
+      operation_url = azure_response.request.url_prefix.to_s
+
+      if (!AsyncOperationStatus.is_terminal_status(polling_state.status))
+        task = Concurrent::TimerTask.new do
+          begin
+            if !polling_state.azure_async_operation_header_link.nil?
+              update_state_from_azure_async_operation_header(polling_state, custom_headers)
+            elsif !polling_state.location_header_link.nil?
+              update_state_from_location_header_on_put(polling_state, custom_headers, custom_deserialization_block)
+            else
+              update_state_from_get_resource_operation(operation_url, polling_state, custom_headers, custom_deserialization_block)
+            end
+
+            if (AsyncOperationStatus.is_terminal_status(polling_state.status))
+              task.shutdown
+            end
+          rescue Exception => e
+            task.shutdown
+            e
+          end
+        end
+
+        polling_delay = polling_state.get_delay
+        polling_delay = 0.1 if polling_delay.nil? || polling_delay == 0
+
+        task.execution_interval = polling_delay
+        task.execute
+        task.wait_for_termination
+
+        polling_error = task.value
+        fail polling_error if polling_error.is_a?(Exception)
+      end
+
+      if (AsyncOperationStatus.is_successful_status(polling_state.status) && polling_state.resource.nil?)
+        update_state_from_get_resource_operation(operation_url, polling_state, custom_headers, custom_deserialization_block)
+      end
+
+      if (AsyncOperationStatus.is_failed_status(polling_state.status))
+        fail polling_state.get_operation_error
+      end
+
+      return polling_state.get_operation_response
+    end
+
+    #
+    # Retrieves the result of 'POST' or 'DELETE' operations. Perfroms polling of required.
+    # @param azure_response [MsRestAzure::AzureOperationResponse] response from Azure service.
+    # @param custom_headers [Proc] custom method for polling.
+    # @param custom_deserialization_block [Proc] custom logic for response deserialization.
+    #
+    # @return [MsRest::HttpOperationResponse] the response.
+    def get_post_or_delete_operation_result(azure_response, custom_headers, custom_deserialization_block)
+      fail MsRest::ValidationError, 'Azure response cannot be nil' if azure_response.nil?
+      fail MsRest::ValidationError, 'Azure response cannot have empty response object' if azure_response.response.nil?
+
+      status_code = azure_response.response.status
+
+      if (status_code != 200 && status_code != 202 && status_code != 204)
+        fail AzureOperationError, "Unexpected polling status code from long running operation #{status_code}"
+      end
+
+      polling_state = PollingState.new(azure_response, @long_running_operation_retry_timeout)
+
+      if (!AsyncOperationStatus.is_terminal_status(polling_state.status))
+        task = Concurrent::TimerTask.new do
+          begin
+            if !polling_state.azure_async_operation_header_link.nil?
+              update_state_from_azure_async_operation_header(polling_state, custom_headers)
+            elsif !polling_state.location_header_link.nil?
+              update_state_from_location_header_on_post_or_delete(polling_state, custom_headers, custom_deserialization_block)
+            else
+              task.shutdown
+              fail AzureOperationError, 'Location header is missing from long running operation'
+            end
+
+            if (AsyncOperationStatus.is_terminal_status(polling_state.status))
+              task.shutdown
+            end
+          rescue Exception => e
+            task.shutdown
+            e
+          end
+        end
+
+        polling_delay = polling_state.get_delay
+        polling_delay = 0.1 if polling_delay.nil? || polling_delay == 0
+
+        task.execution_interval = polling_delay
+        task.execute
+        task.wait_for_termination
+
+        polling_error = task.value
+        fail polling_error if polling_error.is_a?(Exception)
+      end
+
+      if (AsyncOperationStatus.is_failed_status(polling_state.status))
+        fail polling_state.get_operation_error
+      end
+
+      return polling_state.get_operation_response
+    end
+
+    #
+    # Updates polling state based on location header for PUT HTTP requests.
+    # @param operation_url [String] The url retrieve data from.
+    # @param polling_state [MsRestAzure::PollingState] polling state to update.
+    # @param custom_headers [Hash] custom headers to apply to HTTP request.
+    # @param custom_deserialization_block [Proc] custom deserialization method for parsing response.
+    #
+    def update_state_from_get_resource_operation(operation_url, polling_state, custom_headers, custom_deserialization_block)
+      result = get_async_with_custom_deserialization(operation_url, custom_headers, custom_deserialization_block)
+
+      fail AzureOperationError, 'The response from long running operation does not contain a body' if result.response.body.nil? || result.response.body.empty?
+
+      if (result.body.respond_to?(:properties) && result.body.properties.respond_to?(:provisioning_state) && !result.body.properties.provisioning_state.nil?)
+        polling_state.status = result.body.properties.provisioning_state
+      else
+        polling_state.status = AsyncOperationStatus::SUCCESS_STATUS
+      end
+
+      error_data = CloudErrorData.new
+      error_data.code = polling_state.status
+      error_data.message = "Long running operation failed with status #{polling_state.status}"
+
+      polling_state.error_data = error_data
+      polling_state.update_response(result.response)
+      polling_state.request = result.request
+      polling_state.resource = result.body
+    end
+
+    #
+    # Updates polling state based on location header for PUT HTTP requests.
+    # @param polling_state [MsRestAzure::PollingState] polling state to update.
+    # @param custom_headers [Hash] custom headers to apply to HTTP request.
+    # @param custom_deserialization_block [Proc] custom deserialization method for parsing response.
+    def update_state_from_location_header_on_put(polling_state, custom_headers, custom_deserialization_block)
+      result = get_async_with_custom_deserialization(polling_state.location_header_link, custom_headers, custom_deserialization_block)
+
+      polling_state.update_response(result.response)
+      polling_state.request = result.response
+
+      status_code = result.response.status
+
+      if (status_code == 202)
+        polling_state.status = AsyncOperationStatus::IN_PROGRESS_STATUS
+      elsif (status_code == 200 || status_code == 201)
+        fail AzureOperationError, 'The response from long running operation does not contain a body' if result.body.nil?
+
+        # In 202 pattern on PUT ProvisioningState may not be present in
+        # the response. In that case the assumption is the status is Succeeded.
+        if (result.body.respond_to?(:properties) && result.body.properties.respond_to?(:provisioning_state) && !result.body.properties.provisioning_state.nil?)
+          polling_state.status = result.body.properties.provisioning_state
+        else
+          polling_state.status = AsyncOperationStatus::SUCCESS_STATUS
+        end
+
+        error_data = CloudErrorData.new
+        error_data.code = polling_state.status
+        error_data.message = "Long running operation failed with status #{polling_state.status}"
+
+        polling_state.error_data = error_data
+        polling_state.resource = result.body
+      end
+    end
+
+    #
+    # Updates polling state from Azure async operation header.
+    # @param polling_state [MsRestAzure::PollingState] polling state.
+    # @param custom_headers [Hash] custom headers to apply to HTTP request.
+    def update_state_from_azure_async_operation_header(polling_state, custom_headers)
+      result = get_async_with_async_operation_deserialization(polling_state.azure_async_operation_header_link, custom_headers)
+
+      fail AzureOperationError, 'The response from long running operation does not contain a body' if result.body.nil? || result.body.status.nil?
+
+      polling_state.status = result.body.status
+      polling_state.error_data = result.body.error
+      polling_state.response = result.response
+      polling_state.request = result.request
+      polling_state.resource = nil
+    end
+
+    #
+    # Updates polling state based on location header for POST and DELETE HTTP requests.
+    # @param polling_state [MsRestAzure::PollingState] [description]
+    # @param custom_headers [Hash] custom headers to apply to HTTP requests.
+    # @param custom_deserialization_block [Proc] custom deserialization method for parsing response.
+    def update_state_from_location_header_on_post_or_delete(polling_state, custom_headers, custom_deserialization_block)
+      result = get_async_with_custom_deserialization(polling_state.location_header_link, custom_headers, custom_deserialization_block)
+
+      polling_state.update_response(result.response)
+      polling_state.request = result.request
+      status_code = result.response.status
+
+      if (status_code == 202)
+        polling_state.status = AsyncOperationStatus::IN_PROGRESS_STATUS
+      elsif (status_code == 200 || status_code == 201 || status_code == 204)
+        polling_state.status = AsyncOperationStatus::SUCCESS_STATUS
+        polling_state.resource = result.body
+      end
+    end
+
+    #
+    # Retrives data by given URL.
+    # @param operation_url [String] the URL.
+    # @param custom_headers [String] headers to apply to the HTTP request.
+    # @param custom_deserialization_block [Proc] function to perform deserialization of the HTTP response.
+    #
+    # @return [MsRest::HttpOperationResponse] the response.
+    def get_async_with_custom_deserialization(operation_url, custom_headers, custom_deserialization_block)
+      result = get_async_common(operation_url, custom_headers)
+
+      if (!result.body.nil? && !custom_deserialization_block.nil?)
+        begin
+          result.body = custom_deserialization_block.call(result.body)
+        rescue Exception => e
+          fail MsRest::DeserializationError.new("Error occured in deserializing the response", e.message, e.backtrace, http_response.body)
+        end
+      end
+
+      result
+    end
+
+    #
+    # Retrives data by given URL.
+    # @param operation_url [String] the URL.
+    # @param custom_headers [String] headers to apply to the HTTP request.
+    #
+    # @return [MsRest::HttpOperationResponse] the response.
+    def get_async_with_async_operation_deserialization(operation_url, custom_headers)
+      result = get_async_common(operation_url, custom_headers)
+
+      result.body = AsyncOperationStatus.deserialize_object(result.body)
+      result
+    end
+
+    #
+    # Retrives data by given URL.
+    # @param operation_url [String] the URL.
+    # @param custom_headers [String] headers to apply to the HTTP request.
+    #
+    # @return [MsRest::HttpOperationResponse] the response.
+    def get_async_common(operation_url, custom_headers)
+      fail ValidationError, 'Operation url cannot be nil' if operation_url.nil?
+
+      url = URI(operation_url.gsub(' ', '%20'))
+
+      fail URI::Error unless url.to_s =~ /\A#{URI::regexp}\z/
+
+      # Create HTTP transport object
+      connection = Faraday.new(:url => url) do |faraday|
+        faraday.use MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02
+        faraday.use :cookie_jar
+        faraday.adapter Faraday.default_adapter
+      end
+
+      request_headers = Hash.new
+      request_headers['x-ms-client-request-id'] = SecureRandom.uuid
+      request_headers['Content-Type'] = 'application/json'
+
+      unless custom_headers.nil?
+        custom_headers.each do |key, value|
+          request_headers[key] = value
+        end
+      end
+
+      # Send Request
+      http_response = connection.get do |request|
+        request.headers = request_headers
+        @credentials.sign_request(request) unless @credentials.nil?
+      end
+
+      status_code = http_response.status
+
+      if (status_code != 200 && status_code != 201 && status_code != 202 && status_code != 204)
+        json_error_data = JSON.load(http_response.body)
+        error_data = CloudErrorData.deserialize_object(json_error_data)
+
+        fail AzureOperationError.new connection, http_response, error_data, "Long running operation failed with status #{status_code}"
+      end
+
+      result = MsRest::HttpOperationResponse.new(connection, http_response, http_response.body)
+
+      begin
+        result.body = JSON.load(http_response.body) unless http_response.body.to_s.empty?
+      rescue Exception => e
+        fail MsRest::DeserializationError.new("Error occured in deserializing the response", e.message, e.backtrace, http_response.body)
+      end
+
+      result
+    end
+  end
+
+end

data/lib/ms_rest_azure/cloud_error_data.rb

@@ -0,0 +1,33 @@
+# 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
+  #
+  # Class which represents keeps aux data about Azure invalid response.
+  #
+  class CloudErrorData
+
+    # @return [String] the error code parsed from the body of the http error response.
+    attr_accessor :code
+
+    # @return [String] the error message parsed from the body of the http error response.
+    attr_accessor :message
+
+    #
+    # Deserializes given hash into CloudErrorData object.
+    # @param object [Hash] object to deserialize.
+    #
+    # @return [CloudErrorData] deserialized object.
+    def self.deserialize_object(object)
+      return if object.nil?
+      output_object = CloudErrorData.new
+
+      output_object.code = object['code']
+
+      output_object.message = object['message']
+
+      output_object
+    end
+  end
+end

data/lib/ms_rest_azure/credentials/application_token_provider.rb

@@ -0,0 +1,118 @@
+# 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
+  #
+  # Class that provides access to authentication token.
+  #
+  class ApplicationTokenProvider < MsRest::TokenProvider
+
+    private
+
+    TOKEN_ACQUIRE_URL = '{authentication_endpoint}{tenant_id}/oauth2/token'
+    REQUEST_BODY_PATTERN = 'resource={resource_uri}&client_id={client_id}&client_secret={client_secret}&grant_type=client_credentials'
+    DEFAULT_SCHEME = 'Bearer'
+
+    # @return [ActiveDirectoryServiceSettings] settings.
+    attr_accessor :settings
+
+    # @return [String] tenant id (also known as domain).
+    attr_accessor :tenant_id
+
+    # @return [String] application id.
+    attr_accessor :client_id
+
+    # @return [String] application secret key.
+    attr_accessor :client_secret
+
+    # @return [String] auth token.
+    attr_accessor :token
+
+    # @return [Time] the date when the current token expires.
+    attr_accessor :token_expires_on
+
+    # @return [Integer] the amount of time we refresh token before it expires.
+    attr_reader :expiration_threshold
+
+    # @return [String] the type of token.
+    attr_reader :token_type
+
+    public
+
+    #
+    # Creates and initialize new instance of the ApplicationTokenProvider class.
+    # @param tenant_id [String] tenant id (also known as domain).
+    # @param client_id [String] client id.
+    # @param client_secret [String] client secret.
+    # @param settings [ActiveDirectoryServiceSettings] client secret.
+    def initialize(tenant_id, client_id, client_secret, settings = ActiveDirectoryServiceSettings.get_azure_settings)
+      fail ArgumentError, 'Tenant id cannot be nil' if tenant_id.nil?
+      fail ArgumentError, 'Client id cannot be nil' if client_id.nil?
+      fail ArgumentError, 'Client secret key cannot be nil' if client_secret.nil?
+      fail ArgumentError, 'Azure AD settings cannot be nil' if settings.nil?
+
+      @tenant_id = tenant_id
+      @client_id = client_id
+      @client_secret = client_secret
+      @settings = settings
+
+      @expiration_threshold = 5 * 60
+    end
+
+    #
+    # Returns the string value which needs to be attached
+    # to HTTP request header in order to be authorized.
+    #
+    # @return [String] authentication headers.
+    def get_authentication_header
+      acquire_token if token_expired
+      "#{token_type} #{token}"
+    end
+
+    private
+
+    #
+    # Checks whether token is about to expire.
+    #
+    # @return [Bool] True if token is about to expire, false otherwise.
+    def token_expired
+      @token.nil? || Time.now >= @token_expires_on + expiration_threshold
+    end
+
+    #
+    # Retrieves a new authenticaion token.
+    #
+    # @return [String] new authentication token.
+    def acquire_token
+      token_acquire_url = TOKEN_ACQUIRE_URL.dup
+      token_acquire_url['{authentication_endpoint}'] = @settings.authentication_endpoint
+      token_acquire_url['{tenant_id}'] = @tenant_id
+
+      url = URI.parse(token_acquire_url)
+
+      connection = Faraday.new(:url => url) do |builder|
+        builder.adapter Faraday.default_adapter
+      end
+
+      request_body = REQUEST_BODY_PATTERN.dup
+      request_body['{resource_uri}'] = ERB::Util.url_encode(@settings.token_audience)
+      request_body['{client_id}'] = ERB::Util.url_encode(@client_id)
+      request_body['{client_secret}'] = ERB::Util.url_encode(@client_secret)
+
+      response = connection.get do |request|
+        request.headers['content-type'] = 'application/x-www-form-urlencoded'
+        request.body = request_body
+      end
+
+      fail AzureOperationError,
+        'Couldn\'t login to Azure, please verify your tenant id, client id and client secret' unless response.status == 200
+
+      response_body = JSON.load(response.body)
+      @token = response_body['access_token']
+      @token_expires_on = Time.at(Integer(response_body['expires_on']))
+      @token_type = response_body['token_type']
+    end
+  end
+
+end

data/lib/ms_rest_azure/polling_state.rb

@@ -0,0 +1,101 @@
+# 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
+  #
+  # Class which represents a state of Azure long running operation.
+  #
+  class PollingState
+
+    # @return [Net::HTTPRequest] the HTTP request.
+  	attr_accessor :request
+
+    # @return the resource
+  	attr_accessor :resource
+
+    # @return [Net::HTTPResponse] the HTTP response.
+    attr_accessor :response
+
+    # @return [AzureOperationError] the azure error data.
+    attr_accessor :error_data
+
+    # @return [String] the latest value captured from Azure-AsyncOperation header.
+    attr_accessor :azure_async_operation_header_link
+
+    # @return [String] the latest value captured from Location header.
+    attr_accessor :location_header_link
+
+    # @return [String] status of the long running operation.
+    attr_accessor :status
+
+    def initialize(azure_response, retry_timeout)
+      @retry_timeout = retry_timeout
+      @request = azure_response.request
+      update_response(azure_response.response)
+      @resource = azure_response.body
+
+      if (!@resource.nil? && @resource.respond_to?(:properties) && @resource.properties.respond_to?(:provisioning_state) && !@resource.properties.provisioning_state.nil?)
+        @status = @resource.properties.provisioning_state
+      else
+        case @response.status
+          when 202
+            @status = AsyncOperationStatus::IN_PROGRESS_STATUS
+          when 200, 201, 204
+            @status = AsyncOperationStatus::SUCCESS_STATUS
+          else
+            @status = AsyncOperationStatus::FAILED_STATUS
+          end
+      end
+    end
+
+    #
+    # Returns the amount of time in seconds for long running operation polling delay.
+    #
+    # @return [Integer] Amount of time in seconds for long running operation polling delay.
+    def get_delay
+      return @retry_timeout unless @retry_timeout.nil?
+
+      if (!response.nil? && !response.headers['Retry-After'].nil?)
+        return response.headers['Retry-After'].to_i
+      end
+
+      return AsyncOperationStatus::DEFAULT_DELAY
+    end
+
+    #
+    # Updates the polling state from the fields of given response object.
+    # @param response [Net::HTTPResponse] the HTTP response.
+    def update_response(response)
+      @response = response
+
+      if (!response.nil?)
+        @azure_async_operation_header_link = response.headers['Azure-AsyncOperation'] unless response.headers['Azure-AsyncOperation'].nil?
+        @location_header_link = response.headers['Location'] unless response.headers['Location'].nil?
+      end
+    end
+
+    #
+    # returns the Azure's response.
+    #
+    # @return [MsRestAzure::AzureOperationResponse] Azure's response.
+    def get_operation_response
+      azure_response = AzureOperationResponse.new(@request, @response, @resource)
+      azure_response
+    end
+
+    #
+    # Composes and returns cloud error.
+    #
+    # @return [AzureOperationError] the cloud error.
+    def get_operation_error
+      AzureOperationError.new @request, @response, @error_data, "Long running operation failed with status #{@status}"
+    end
+
+    private
+
+    # @return [Integer] retry timeout.
+    attr_accessor :retry_timeout
+  end
+
+end

data/lib/ms_rest_azure/resource.rb

@@ -0,0 +1,89 @@
+# 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
+  #
+  # Class which represents any Azure resource.
+  #
+  class Resource
+
+    # @return [String] the id of the resource.
+    attr_accessor :id
+
+    # @return [String] the name of the resource.
+    attr_accessor :name
+
+    # @return [String] the type of the resource.
+    attr_accessor :type
+
+    # @return [String] the location of the resource (required).
+    attr_accessor :location
+
+    # @return [Hash{String => String}] the tags attached to resources (optional).
+    attr_accessor :tags
+
+    #
+    # Serializes given resource object into hash.
+    # @param object [Resource] resource object to serialize.
+    #
+    # @return [Hash] hash representation of resource.
+    def self.serialize_object(object)
+      object.validate
+      output_object = {}
+
+      serialized_property = object.id
+      output_object['id'] = serialized_property unless serialized_property.nil?
+
+      serialized_property = object.name
+      output_object['name'] = serialized_property unless serialized_property.nil?
+
+      serialized_property = object.type
+      output_object['type'] = serialized_property unless serialized_property.nil?
+
+      serialized_property = object.location
+      output_object['location'] = serialized_property unless serialized_property.nil?
+
+      serialized_property = object.tags
+      output_object['tags'] = serialized_property unless serialized_property.nil?
+
+      output_object
+    end
+
+    #
+    # Deserializes given hash object into resource.
+    # @param object [Hash] resource in hash representation to deserialize.
+    #
+    # @return [Resource] deserialized resource.
+    def self.deserialize_object(object)
+      return if object.nil?
+      output_object = Resource.new
+
+      deserialized_property = object['id']
+      output_object.id = deserialized_property
+
+      deserialized_property = object['name']
+      output_object.name = deserialized_property
+
+      deserialized_property = object['type']
+      output_object.type = deserialized_property
+
+      deserialized_property = object['location']
+      output_object.location = deserialized_property
+
+      deserialized_property = object['tags']
+      output_object.tags = deserialized_property
+
+      output_object.validate
+      output_object
+    end
+
+    #
+    # Validates the resource. Throws error if there is any property is incorrect.
+    #
+    def validate
+      fail MsRest::ValidationError, 'Location cannot be nil in the Resource object' if @location.nil?
+    end
+
+  end
+end

data/lib/ms_rest_azure/sub_resource.rb

@@ -0,0 +1,51 @@
+# 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
+  #
+  # Class which represents any Azure subresource.
+  #
+  class SubResource
+
+    # @return [String] the id of the subresource.
+    attr_accessor :id
+
+    #
+    # Serializes given subresource object into hash.
+    # @param object [SubResource] subresource object to serialize.
+    #
+    # @return [Hash] hash representation of subresource.
+    def self.serialize_object(object)
+      object.validate
+      output_object = {}
+
+      serialized_property = object.id
+      output_object['id'] = serialized_property unless serialized_property.nil?
+
+      output_object
+    end
+
+    #
+    # Deserializes given hash object into subresource.
+    # @param object [Hash] subresource in hash representation to deserialize.
+    #
+    # @return [SubResource] deserialized subresource.
+    def self.deserialize_object(object)
+      return if object.nil?
+      output_object = SubResource.new
+
+      deserialized_property = object['id']
+      output_object.id = deserialized_property
+
+      output_object.validate
+      output_object
+    end
+
+    #
+    # Validates the subresource. Throws error if there is any property is incorrect.
+    #
+    def validate
+    end
+  end
+end

data/lib/ms_rest_azure/version.rb

@@ -0,0 +1,7 @@
+# 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
+  VERSION = '0.1.1'
+end

data/ms_rest_azure.gemspec

@@ -0,0 +1,36 @@
+# 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://rubygems.org/gems/azure'
+  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.0'
+
+  spec.add_runtime_dependency 'json', '~> 1.8.3'
+  spec.add_runtime_dependency 'concurrent-ruby', ['>= 1.0.0.pre1', '<2']
+  spec.add_runtime_dependency 'faraday', '~> 0.9.1'
+  spec.add_runtime_dependency 'faraday-cookie_jar', '~> 0.0.6'
+  spec.add_runtime_dependency 'ms_rest', '~> 0.1.0'
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: ms_rest_azure
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Microsoft Corporation
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: faraday-cookie_jar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: ms_rest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: Azure Client Library for Ruby.
+email: azsdkteam@microsoft.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- 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_operation_error.rb
+- lib/ms_rest_azure/azure_operation_response.rb
+- lib/ms_rest_azure/azure_service_client.rb
+- lib/ms_rest_azure/cloud_error_data.rb
+- lib/ms_rest_azure/credentials/application_token_provider.rb
+- lib/ms_rest_azure/polling_state.rb
+- lib/ms_rest_azure/resource.rb
+- lib/ms_rest_azure/sub_resource.rb
+- lib/ms_rest_azure/version.rb
+- ms_rest_azure.gemspec
+homepage: https://rubygems.org/gems/azure
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Azure Client Library for Ruby.
+test_files: []