ms_rest_azure 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7203d54f4f4ae83bb46c11e9cc10a2add963878
-  data.tar.gz: 722bf9172b7dc18abb6c7df979abfa07e11fefb2
+  metadata.gz: 3bc35b29a1cb68a457f14527a362b628b2974677
+  data.tar.gz: 2a05929f18773754540929f509aab0d18d80d650
 SHA512:
-  metadata.gz: ed36ae9615edf1964910abffae804573486d033f4e691a1cb5b72201e2aa37e9c243eb6df7e0c1f28c9ffe23991d440a40d890bc67c6e8875b4ce8ce6c35b432
-  data.tar.gz: 631883016525fbd8de0a4c78f2db3d4849e948fddf2a2258249b79ed833ed03729191e76f502d8708a8801f429dedd1666293050ff4607d9ba8a4ef4b0b17805
+  metadata.gz: 57237e0f415c933903b374234a61549443fc74f56c459fa7735686ccbec25ce9cf7e7c9a79c679e27301c9b128e3db1cf597883a827abd277c55bfd871f58418
+  data.tar.gz: 4ba53a1a08501303f8b6dfe35c447ee750910690d3b8d9a4ee85a05418eb1346b679b25dbc26f74eddb006087954e0ebd46619d10f373ade3d10bf523a2cd3df

data/lib/ms_rest_azure/azure_service_client.rb

@@ -15,36 +15,35 @@ module MsRestAzure
     attr_accessor :api_version
 
     #
-    # Retrieves the result of 'PUT' operation. Perfroms polling of required.
+    # Retrieves the result of 'POST','DELETE','PUT' or 'PATCH' operation. Performs polling of required.
     # @param azure_response [MsRestAzure::AzureOperationResponse] response from Azure service.
     # @param custom_deserialization_block [Proc] custom logic for response deserialization.
     #
     # @return [MsRest::HttpOperationResponse] the response.
-    def get_put_operation_result(azure_response, custom_deserialization_block)
-      fail MsRest::ValidationError, 'Azure response cannot be nil' if azure_response.nil?
+    def get_long_running_operation_result(azure_response, custom_deserialization_block)
+      check_for_status_code_failure(azure_response)
 
-      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
+      http_method = azure_response.request.method
 
       polling_state = PollingState.new(azure_response, @long_running_operation_retry_timeout)
       request = azure_response.request
 
-      if (!AsyncOperationStatus.is_terminal_status(polling_state.status))
+      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.get_request(headers: request.headers, base_uri: request.base_uri), polling_state)
             elsif !polling_state.location_header_link.nil?
-              update_state_from_location_header_on_put(polling_state.get_request(headers: request.headers, base_uri: request.base_uri), polling_state, custom_deserialization_block)
-            else
-              get_request = MsRest::HttpOperationRequest.new(request.base_uri, request.build_path.to_s, 'get', query_params: request.query_params)
+              update_state_from_location_header(polling_state.get_request(headers: request.headers, base_uri: request.base_uri), polling_state, custom_deserialization_block)
+            elsif http_method === :put
+              get_request = MsRest::HttpOperationRequest.new(request.base_uri, request.build_path.to_s, :get, query_params: request.query_params)
               update_state_from_get_resource_operation(get_request, polling_state, 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))
+            if AsyncOperationStatus.is_terminal_status(polling_state.status)
               task.shutdown
             end
           rescue Exception => e
@@ -64,74 +63,52 @@ module MsRestAzure
         fail polling_error if polling_error.is_a?(Exception)
       end
 
-      if (AsyncOperationStatus.is_successful_status(polling_state.status) && polling_state.resource.nil?)
-        get_request = MsRest::HttpOperationRequest.new(request.base_uri, request.build_path.to_s, 'get', query_params: request.query_params)
+      if (http_method === :put || http_method === :patch) && AsyncOperationStatus.is_successful_status(polling_state.status) && polling_state.resource.nil?
+        get_request = MsRest::HttpOperationRequest.new(request.base_uri, request.build_path.to_s, :get, query_params: request.query_params)
         update_state_from_get_resource_operation(get_request, polling_state, custom_deserialization_block)
       end
 
-      if (AsyncOperationStatus.is_failed_status(polling_state.status))
+      if AsyncOperationStatus.is_failed_status(polling_state.status)
         fail polling_state.get_operation_error
       end
 
-      return polling_state.get_operation_response
+      polling_state.get_operation_response
+    end
+
+    # @TODO Update name of the method to get_put_or_patch_operation_result when introducing breaking change / updating major version of gem
+    # Retrieves the result of 'PUT' or 'PATCH' operation. Performs polling of required.
+    # @param azure_response [MsRestAzure::AzureOperationResponse] response from Azure service.
+    # @param custom_deserialization_block [Proc] custom logic for response deserialization.
+    #
+    # @return [MsRest::HttpOperationResponse] the response.
+    def get_put_operation_result(azure_response, custom_deserialization_block)
+      get_long_running_operation_result(azure_response, custom_deserialization_block)
     end
 
     #
-    # Retrieves the result of 'POST' or 'DELETE' operations. Perfroms polling of required.
+    # Retrieves the result of 'POST' or 'DELETE' operations. Performs polling of required.
     # @param azure_response [MsRestAzure::AzureOperationResponse] response from Azure service.
     # @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_deserialization_block)
+      get_long_running_operation_result(azure_response, custom_deserialization_block)
+    end
+
+    #
+    # Verifies for unexpected polling status code
+    # @param azure_response [MsRestAzure::AzureOperationResponse] response from Azure service.
+    def check_for_status_code_failure(azure_response)
       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?
+      fail MsRest::ValidationError, 'Azure response cannot have empty request object' if azure_response.request.nil?
 
       status_code = azure_response.response.status
+      http_method = azure_response.request.method
 
-      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)
-      request = azure_response.request
-      
-      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.get_request(headers: request.headers, base_uri: request.base_uri), polling_state)
-            elsif !polling_state.location_header_link.nil?
-              update_state_from_location_header_on_post_or_delete(polling_state.get_request(headers: request.headers, base_uri: request.base_uri), polling_state, 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
+      fail AzureOperationError, "Unexpected polling status code from long running operation #{status_code}" unless status_code === 200 || status_code === 202 ||
+          (status_code === 201 && http_method === :put) ||
+          (status_code === 204 && (http_method === :delete || http_method === :post))
     end
 
     #
@@ -145,7 +122,7 @@ module MsRestAzure
 
       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?)
+      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
@@ -162,30 +139,23 @@ module MsRestAzure
     end
 
     #
-    # Updates polling state based on location header for PUT HTTP requests.
+    # Updates polling state based on location header for HTTP requests.
     # @param request [MsRest::HttpOperationRequest] The url retrieve data from.
     # @param polling_state [MsRestAzure::PollingState] polling state to update.
     # @param custom_deserialization_block [Proc] custom deserialization method for parsing response.
-    def update_state_from_location_header_on_put(request, polling_state, custom_deserialization_block)
+    def update_state_from_location_header(request, polling_state, custom_deserialization_block)
       result = get_async_with_custom_deserialization(request, custom_deserialization_block)
 
       polling_state.update_response(result.response)
-      polling_state.request = result.response
-
+      polling_state.request = result.request
       status_code = result.response.status
+      http_method = request.method
 
-      if (status_code == 202)
+      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
+      elsif status_code === 200 || (status_code === 201 && http_method === :put) ||
+          (status_code === 204 && (http_method === :delete || http_method === :post || http_method === :get))
+        polling_state.status = AsyncOperationStatus::SUCCESS_STATUS
 
         error_data = CloudErrorData.new
         error_data.code = polling_state.status
@@ -193,6 +163,8 @@ module MsRestAzure
 
         polling_state.error_data = error_data
         polling_state.resource = result.body
+      else
+        fail AzureOperationError, "The response from long running operation does not have a valid status code. Method: #{http_method}, Status Code: #{status_code}"
       end
     end
 
@@ -212,26 +184,7 @@ module MsRestAzure
     end
 
     #
-    # Updates polling state based on location header for POST and DELETE HTTP requests.
-    # @param polling_state [MsRest::HttpOperationRequest] [description]
-    # @param custom_deserialization_block [Proc] custom deserialization method for parsing response.
-    def update_state_from_location_header_on_post_or_delete(request, polling_state, custom_deserialization_block)
-      result = get_async_with_custom_deserialization(request, 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.
+    # Retrieves data by given URL.
     # @param request [MsRest::HttpOperationRequest] the URL.
     # @param custom_deserialization_block [Proc] function to perform deserialization of the HTTP response.
     #
@@ -239,7 +192,7 @@ module MsRestAzure
     def get_async_with_custom_deserialization(request, custom_deserialization_block)
       result = get_async_common(request)
 
-      if (!result.body.nil? && !custom_deserialization_block.nil?)
+      if !result.body.nil? && !custom_deserialization_block.nil?
         begin
           result.body = custom_deserialization_block.call(result.body)
         rescue Exception => e
@@ -251,7 +204,7 @@ module MsRestAzure
     end
 
     #
-    # Retrives data by given URL.
+    # Retrieves data by given URL.
     # @param request [MsRest::HttpOperationRequest] the URL.
     #
     # @return [MsRest::HttpOperationResponse] the response.
@@ -263,13 +216,13 @@ module MsRestAzure
     end
 
     #
-    # Retrives data by given URL.
+    # Retrieves data by given URL.
     # @param request [MsRest::HttpOperationRequest] the URL.
     #
     # @return [MsRest::HttpOperationResponse] the response.
     def get_async_common(request)
       fail ValidationError, 'Request cannot be nil' if request.nil?
-      
+
       request.middlewares = [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]]
       request.headers.merge!({'x-ms-client-request-id' => SecureRandom.uuid, 'Content-Type' => 'application/json'})
 
@@ -277,10 +230,10 @@ module MsRestAzure
       http_response = request.run_promise do |req|
         @credentials.sign_request(req) unless @credentials.nil?
       end.execute.value!
-      
+
       status_code = http_response.status
 
-      if (status_code != 200 && status_code != 201 && status_code != 202 && status_code != 204)
+      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)
 

data/lib/ms_rest_azure/polling_state.rb

@@ -94,7 +94,7 @@ module MsRestAzure
     
     def get_request(options = {})
       link = @azure_async_operation_header_link || @location_header_link
-      MsRest::HttpOperationRequest.new(nil, link, 'get', options)
+      MsRest::HttpOperationRequest.new(nil, link, :get, options)
     end
 
     private

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.2.2'
+  VERSION = '0.2.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ms_rest_azure
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Microsoft Corporation
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-07 00:00:00.000000000 Z
+date: 2016-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler