ms_rest_azure 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3bc35b29a1cb68a457f14527a362b628b2974677
-  data.tar.gz: 2a05929f18773754540929f509aab0d18d80d650
+  metadata.gz: 97a38496ee61b6d8aae2c6014a39ea693cd14c5a
+  data.tar.gz: 0df39d7496a44bd6602792d88e2ddd066dad5409
 SHA512:
-  metadata.gz: 57237e0f415c933903b374234a61549443fc74f56c459fa7735686ccbec25ce9cf7e7c9a79c679e27301c9b128e3db1cf597883a827abd277c55bfd871f58418
-  data.tar.gz: 4ba53a1a08501303f8b6dfe35c447ee750910690d3b8d9a4ee85a05418eb1346b679b25dbc26f74eddb006087954e0ebd46619d10f373ade3d10bf523a2cd3df
+  metadata.gz: 8613403ac1c8b3057992513a0b640f088525b70a8d3a1ffb9c907ef89d5571966316b4232902633b27f27eaa73666e7480a7b535d2c5961ab06a7f5f634dde2c
+  data.tar.gz: 0349cec779491afc9bec38e9769a90014c439a59d041a86ef89b55fa9ce38165df8613b3f39878ca2fd726d4d9dd044899a34164c43f8962980f652fe1d076f1

data/ChangeLog.md

@@ -0,0 +1,5 @@
+##2016.07.14 ms_rest_azure version 0.3.0
+* Embracing latest ms_rest version [0.3.0](https://rubygems.org/gems/ms_rest)
+
+##2016.05.19 ms_rest_azure version 0.2.3
+* Support patch for long running operations. See [#1011](https://github.com/Azure/autorest/pull/1011), [#1056](https://github.com/Azure/autorest/pull/1056)

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.1.0'
+spec.add_runtime_dependency 'ms_rest_azure', '~> 0.3.0'
 ```
 
 Don't forget to correct the version.

data/lib/ms_rest_azure/async_operation_status.rb

@@ -7,13 +7,14 @@ module MsRestAzure
   # Defines values for AsyncOperationStatus enum.
   #
   class AsyncOperationStatus
+    ACCEPTED = 'Accepted'
     IN_PROGRESS_STATUS = 'InProgress'
     RUNNING = 'Running'
     SUCCESS_STATUS = 'Succeeded'
     FAILED_STATUS = 'Failed'
     CANCELED_STATUS = 'Canceled'
 
-    ALL_STATUSES = [FAILED_STATUS, CANCELED_STATUS, SUCCESS_STATUS, IN_PROGRESS_STATUS, RUNNING]
+    ALL_STATUSES = [ACCEPTED, FAILED_STATUS, CANCELED_STATUS, SUCCESS_STATUS, IN_PROGRESS_STATUS, RUNNING]
     FAILED_STATUSES = [FAILED_STATUS, CANCELED_STATUS]
     TERMINAL_STATUSES = [FAILED_STATUS, CANCELED_STATUS, SUCCESS_STATUS]
 

data/lib/ms_rest_azure/azure_service_client.rb

@@ -20,6 +20,7 @@ module MsRestAzure
     # @param custom_deserialization_block [Proc] custom logic for response deserialization.
     #
     # @return [MsRest::HttpOperationResponse] the response.
+    #
     def get_long_running_operation_result(azure_response, custom_deserialization_block)
       check_for_status_code_failure(azure_response)
 
@@ -36,7 +37,7 @@ module MsRestAzure
             elsif !polling_state.location_header_link.nil?
               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)
+              get_request = MsRest::HttpOperationRequest.new(request.base_uri, request.build_path.to_s, :get, {query_params: request.query_params, headers: request.headers})
               update_state_from_get_resource_operation(get_request, polling_state, custom_deserialization_block)
             else
               task.shutdown
@@ -64,7 +65,7 @@ module MsRestAzure
       end
 
       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)
+        get_request = MsRest::HttpOperationRequest.new(request.base_uri, request.build_path.to_s, :get, {query_params: request.query_params, headers: request.headers})
         update_state_from_get_resource_operation(get_request, polling_state, custom_deserialization_block)
       end
 
@@ -75,29 +76,10 @@ module MsRestAzure
       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. 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?
@@ -122,8 +104,12 @@ module MsRestAzure
 
       fail AzureOperationError, 'The response from long running operation does not contain a body' if result.response.body.nil? || result.response.body.empty?
 
+      # On non flattened resource, we should find provisioning_state inside 'properties'
       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
+      # On flattened resource, we should find provisioning_state at the top level
+      elsif result.body.respond_to?(:provisioning_state) && !result.body.provisioning_state.nil?
+        polling_state.status = result.body.provisioning_state
       else
         polling_state.status = AsyncOperationStatus::SUCCESS_STATUS
       end
@@ -143,6 +129,7 @@ module MsRestAzure
     # @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(request, polling_state, custom_deserialization_block)
       result = get_async_with_custom_deserialization(request, custom_deserialization_block)
 
@@ -171,6 +158,7 @@ module MsRestAzure
     #
     # Updates polling state from Azure async operation header.
     # @param polling_state [MsRestAzure::PollingState] polling state.
+    #
     def update_state_from_azure_async_operation_header(request, polling_state)
       result = get_async_with_async_operation_deserialization(request)
 
@@ -181,6 +169,8 @@ module MsRestAzure
       polling_state.response = result.response
       polling_state.request = result.request
       polling_state.resource = nil
+
+      polling_state
     end
 
     #
@@ -189,6 +179,7 @@ module MsRestAzure
     # @param custom_deserialization_block [Proc] function to perform deserialization of the HTTP response.
     #
     # @return [MsRest::HttpOperationResponse] the response.
+    #
     def get_async_with_custom_deserialization(request, custom_deserialization_block)
       result = get_async_common(request)
 
@@ -208,10 +199,12 @@ module MsRestAzure
     # @param request [MsRest::HttpOperationRequest] the URL.
     #
     # @return [MsRest::HttpOperationResponse] the response.
+    #
     def get_async_with_async_operation_deserialization(request)
       result = get_async_common(request)
 
       result.body = AsyncOperationStatus.deserialize_object(result.body)
+
       result
     end
 
@@ -220,11 +213,13 @@ module MsRestAzure
     # @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'})
+      request.headers.merge!({'x-ms-client-request-id' => SecureRandom.uuid}) unless request.headers.key?('x-ms-client-request-id')
+      request.headers.merge!({'Content-Type' => 'application/json'}) unless request.headers.key?('Content-Type')
 
       # Send Request
       http_response = request.run_promise do |req|

data/lib/ms_rest_azure/polling_state.rb

@@ -35,8 +35,12 @@ module MsRestAzure
       update_response(azure_response.response)
       @resource = azure_response.body
 
+      # On non flattened resource, we should find provisioning_state inside 'properties'
       if (!@resource.nil? && @resource.respond_to?(:properties) && @resource.properties.respond_to?(:provisioning_state) && !@resource.properties.provisioning_state.nil?)
         @status = @resource.properties.provisioning_state
+      # On flattened resource, we should find provisioning_state at the top level
+      elsif !@resource.nil? && @resource.respond_to?(:provisioning_state) && !@resource.provisioning_state.nil?
+        @status = @resource.provisioning_state
       else
         case @response.status
           when 202
@@ -56,7 +60,7 @@ module MsRestAzure
     def get_delay
       return @retry_timeout unless @retry_timeout.nil?
 
-      if (!response.nil? && !response.headers['Retry-After'].nil?)
+      if !response.nil? && !response.headers['Retry-After'].nil?
         return response.headers['Retry-After'].to_i
       end
 
@@ -69,7 +73,7 @@ module MsRestAzure
     def update_response(response)
       @response = response
 
-      if (!response.nil?)
+      unless 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
@@ -94,6 +98,7 @@ module MsRestAzure
     
     def get_request(options = {})
       link = @azure_async_operation_header_link || @location_header_link
+      options[:connection] = create_connection(options[:base_uri])
       MsRest::HttpOperationRequest.new(nil, link, :get, options)
     end
 
@@ -101,6 +106,20 @@ module MsRestAzure
 
     # @return [Integer] retry timeout.
     attr_accessor :retry_timeout
+
+    attr_accessor :connection
+
+    def create_connection(base_url)
+      @connection ||= Faraday.new(:url => base_url) 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
+        logging = ENV['AZURE_HTTP_LOGGING'] || request.log
+        if logging
+          faraday.response :logger, nil, { :bodies => logging == 'full' }
+        end
+      end
+    end
   end
 
 end

data/lib/ms_rest_azure/resource.rb

@@ -23,67 +23,61 @@ module MsRestAzure
     # @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
+    def self.mapper
+      {
+        required: false,
+        serialized_name: 'Resource',
+        type: {
+          name: 'Composite',
+          class_name: 'Resource',
+          model_properties: {
+              id: {
+                required: false,
+                serialized_name: 'id',
+                type: {
+                  name: 'String'
+                }
+              },
+              name: {
+                required: false,
+                read_only: true,
+                serialized_name: 'name',
+                type: {
+                  name: 'String'
+                }
+              },
+              type: {
+                required: false,
+                read_only: true,
+                serialized_name: 'type',
+                type: {
+                  name: 'String'
+                }
+              },
+              location: {
+                required: false,
+                serialized_name: 'location',
+                type: {
+                  name: 'String'
+                }
+              },
+              tags: {
+                required: false,
+                serialized_name: 'tags',
+                type: {
+                  name: 'Dictionary',
+                  value: {
+                      required: false,
+                      serialized_name: 'StringElementType',
+                      type: {
+                        name: 'String'
+                      }
+                  }
+                }
+              }
+          }
+        }
+      }
     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

@@ -11,41 +11,24 @@ module MsRestAzure
     # @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
+    def self.mapper
+      {
+        required: false,
+        serialized_name: 'SubResource',
+        type: {
+          name: 'Composite',
+          class_name: 'SubResource',
+          model_properties: {
+            id: {
+              required: false,
+              serialized_name: 'id',
+              type: {
+                name: 'String'
+              }
+            }
+          }
+        }
+      }
     end
   end
 end

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.3'
+  VERSION = '0.3.0'
 end

data/ms_rest_azure.gemspec

@@ -32,5 +32,5 @@ Gem::Specification.new do |spec|
   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.2.1'
+  spec.add_runtime_dependency 'ms_rest', '~> 0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ms_rest_azure
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Microsoft Corporation
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-19 00:00:00.000000000 Z
+date: 2016-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.3.0
 description: Azure Client Library for Ruby.
 email: azsdkteam@microsoft.com
 executables: []
@@ -130,6 +130,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- ChangeLog.md
 - Gemfile
 - LICENSE.txt
 - README.md