ms_rest 0.7.5 → 0.7.6

data/lib/ms_rest/http_operation_response.rb

@@ -1,37 +1,37 @@
-# 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 MsRest
-  #
-  # Class which represents the data received and deserialized from server.
-  #
-  class HttpOperationResponse
-
-    # @param [MsRest::HttpOperationRequest] the HTTP request data.
-    attr_accessor :request
-
-    # @return [Faraday::Response] the HTTP response object.
-    attr_accessor :response
-
-    # @return [String] the HTTP response body.
-    attr_accessor :body
-
-    #
-    # Creates and initialize new instance of the HttpOperationResponse class.
-    # @param [MsRest::HttpOperationRequest] request the HTTP request object.
-    # @param [Faraday::Response] response the HTTP response object.
-    # @param [String] body the HTTP response body.
-    def initialize(request, response, body = nil)
-      @request = request
-      @response = response
-      @body = body
-    end
-    
-    def to_json(*a)
-      res_dict = response ? { body: response.body, headers: response.headers, status: response.status } : nil
-      {response: res_dict, request: request}.to_json(*a)
-    end
-
-  end
-end
+# 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 MsRest
+  #
+  # Class which represents the data received and deserialized from server.
+  #
+  class HttpOperationResponse
+
+    # @param [MsRest::HttpOperationRequest] the HTTP request data.
+    attr_accessor :request
+
+    # @return [Faraday::Response] the HTTP response object.
+    attr_accessor :response
+
+    # @return [String] the HTTP response body.
+    attr_accessor :body
+
+    #
+    # Creates and initialize new instance of the HttpOperationResponse class.
+    # @param [MsRest::HttpOperationRequest] request the HTTP request object.
+    # @param [Faraday::Response] response the HTTP response object.
+    # @param [String] body the HTTP response body.
+    def initialize(request, response, body = nil)
+      @request = request
+      @response = response
+      @body = body
+    end
+    
+    def to_json(*a)
+      res_dict = response ? { body: response.body, headers: response.headers, status: response.status } : nil
+      {response: res_dict, request: request}.to_json(*a)
+    end
+
+  end
+end

data/lib/ms_rest/jsonable.rb

@@ -1,39 +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 MsRest
-  # Mixin to provide simple serialization / deserialization in AutoRest generated model classes
-  module JSONable
-    include MsRest::Serialization
-
-    #
-    # Serialize the object to JSON
-    # @param options [Hash] hash map contains options to convert to json.
-    # @return [String] JSON serialized version of the object
-    #
-    def to_json(options = nil)
-      mapper = (options.nil? || !options.key?(:mapper))? self.class.mapper: options[:mapper]
-      object = (options.nil? || !options.key?(:object))? self: options[:object]
-      serialize(mapper, object)
-    end
-
-    #
-    # Deserialize the object from JSON
-    # @param json [String] JSON string representation of the object
-    # @return [JSONable] object built from json input
-    #
-    def from_json(json, mapper = nil)
-      mapper = self.class.mapper if mapper.nil?
-      deserialize(mapper, json)
-    end
-
-    #
-    # String representation of the object
-    # @return [String]
-    #
-    def to_s
-      "#{super} #{to_json.to_s}"
-    end
-  end
-end
+# 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 MsRest
+  # Mixin to provide simple serialization / deserialization in AutoRest generated model classes
+  module JSONable
+    include MsRest::Serialization
+
+    #
+    # Serialize the object to JSON
+    # @param options [Hash] hash map contains options to convert to json.
+    # @return [String] JSON serialized version of the object
+    #
+    def to_json(options = nil)
+      mapper = (options.nil? || !options.key?(:mapper))? self.class.mapper: options[:mapper]
+      object = (options.nil? || !options.key?(:object))? self: options[:object]
+      serialize(mapper, object)
+    end
+
+    #
+    # Deserialize the object from JSON
+    # @param json [String] JSON string representation of the object
+    # @return [JSONable] object built from json input
+    #
+    def from_json(json, mapper = nil)
+      mapper = self.class.mapper if mapper.nil?
+      deserialize(mapper, json)
+    end
+
+    #
+    # String representation of the object
+    # @return [String]
+    #
+    def to_s
+      "#{super} #{to_json.to_s}"
+    end
+  end
+end

data/lib/ms_rest/rest_error.rb

@@ -1,11 +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 MsRest
-  #
-  # Class which represents an general exception for REST client.
-  #
-  class RestError < StandardError
-  end
-end
+# 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 MsRest
+  #
+  # Class which represents an general exception for REST client.
+  #
+  class RestError < StandardError
+  end
+end

data/lib/ms_rest/retry_policy_middleware.rb

@@ -1,44 +1,44 @@
-# 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 MsRest
-  #
-  # Class which handles retry policy.
-  #
-  class RetryPolicyMiddleware < Faraday::Response::Middleware
-    #
-    # Initializes a new instance of the RetryPolicyMiddleware class.
-    #
-    def initialize(app, options = {})
-      @times = options[:times] || 5
-      @delay = options[:delay] || 0.01
-
-      super(app)
-    end
-
-    #
-    # Performs request and response processing.
-    #
-    def call(request_env)
-      request_body = request_env[:body]
-
-      begin
-        request_env[:body] = request_body
-
-        @app.call(request_env).on_complete do |response_env|
-          status_code = response_env.status
-
-          if @times > 0 && (status_code == 408 || (status_code >= 500 && status_code != 501 && status_code != 505))
-            sleep @delay
-            fail 'faraday_retry'
-          end
-        end
-      rescue Exception => e
-        raise e if e.message != 'faraday_retry'
-        @times = @times - 1
-        retry
-      end
-    end
-  end
-end
+# 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 MsRest
+  #
+  # Class which handles retry policy.
+  #
+  class RetryPolicyMiddleware < Faraday::Response::Middleware
+    #
+    # Initializes a new instance of the RetryPolicyMiddleware class.
+    #
+    def initialize(app, options = {})
+      @times = options[:times] || 5
+      @delay = options[:delay] || 0.01
+
+      super(app)
+    end
+
+    #
+    # Performs request and response processing.
+    #
+    def call(request_env)
+      request_body = request_env[:body]
+
+      begin
+        request_env[:body] = request_body
+
+        @app.call(request_env).on_complete do |response_env|
+          status_code = response_env.status
+
+          if @times > 0 && (status_code == 408 || (status_code >= 500 && status_code != 501 && status_code != 505))
+            sleep @delay
+            fail 'faraday_retry'
+          end
+        end
+      rescue Exception => e
+        raise e if e.message != 'faraday_retry'
+        @times = @times - 1
+        retry
+      end
+    end
+  end
+end

data/lib/ms_rest/service_client.rb

@@ -1,115 +1,115 @@
-# 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 MsRest
-  #
-  # Class which represents a point of access to the REST API.
-  #
-  class ServiceClient
-
-    # @return [MsRest::ServiceClientCredentials] the credentials object.
-    attr_accessor :credentials
-
-    # @return [Hash{String=>String}] default middlewares configuration for requests.
-    attr_accessor :middlewares
-
-    # @return [Hash{String=>String}] default request headers for requests.
-    attr_accessor :request_headers
-
-    # @return [Array] strings to be appended to the user agent in the request
-    attr_accessor :user_agent_extended
-
-    #
-    # Creates and initialize new instance of the ServiceClient class.
-    #
-    # @param credentials [MsRest::ServiceClientCredentials] credentials to authorize
-    # HTTP requests made by the service client.
-    # @param options additional parameters for the HTTP request (not implemented yet).
-    #
-    def initialize(credentials = nil, options = nil)
-      @credentials = credentials
-      @request_headers = {}
-      @middlewares = {middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]]}
-      @user_agent_extended = []
-      @user_agent_extended.push("ms_rest/#{MsRest::VERSION}")
-    end
-
-    #
-    # @param base_url [String] the base url for the request.
-    # @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete.
-    # @param path [String] the path, relative to {base_url}.
-    # @param options [Hash{String=>String}] specifying any request options like :credentials, :body, etc.
-    # @return [Concurrent::Promise] Promise object which holds the HTTP response.
-    #
-    def make_request_async(base_url, method, path, options = {})
-      options = @middlewares.merge(options)
-      options[:credentials] = options[:credentials] || @credentials
-      options[:user_agent_extended] = @user_agent_extended
-      request  = MsRest::HttpOperationRequest.new(base_url, path, method, options)
-      promise = request.run_promise do |req|
-        options[:credentials].sign_request(req) unless options[:credentials].nil?
-      end
-      promise = promise.then do |http_response|
-        response_content = http_response.body.to_s.empty? ? nil : http_response.body
-        # Create response
-        create_response(request, http_response, response_content)
-      end
-      promise.execute
-    end
-
-    #
-    # Add additional information into User-Agent header.
-    # @param [String] additional_user_agent_information additional product information for user agent string.
-    #
-    # Example:
-    #  recommended format is Product/[version]
-    #  please refer https://github.com/Azure/azure-sdk-for-ruby/issues/517 for more information.
-    #
-    #  add_user_agent_information('fog-azure-rm/0.2.0')
-    #
-    def add_user_agent_information(additional_user_agent_information)
-      @user_agent_extended.push(additional_user_agent_information)
-    end
-
-    private
-      #
-      # Retrieves a new instance of the HttpOperationResponse class.
-      # @param [MsRest::HttpOperationRequest] request the HTTP request object.
-      # @param [Faraday::Response] response the HTTP response object.
-      # @param [String] body the HTTP response body.
-      # @return [MsRest::HttpOperationResponse] the operation response.
-      #
-      def create_response(request, http_response, body = nil)
-        HttpOperationResponse.new(request, http_response, body)
-      end
-  end
-
-  #
-  # Hash of SSL options for Faraday connection. Default is nil.
-  #
-  @@ssl_options = {}
-
-  #
-  # Stores the SSL options to be used for Faraday connections.
-  # ==== Examples
-  #   MsRest.use_ssl_cert                                  # => Uses bundled certificate for all the connections
-  #   MsRest.use_ssl_cert({:ca_file => "path_to_ca_file"}) # => Uses supplied certificate for all the connections
-  #
-  # @param ssl_options [Hash] Hash of SSL options for Faraday connection. It defaults to the bundled certificate.
-  #
-  def self.use_ssl_cert(ssl_options = nil)
-    if ssl_options.nil?
-      @@ssl_options = {:ca_file => File.expand_path(File.join(File.dirname(__FILE__), '../..', 'ca-cert.pem')) }
-    else
-      @@ssl_options = ssl_options
-    end
-  end
-
-  #
-  # @return [Hash] Hash of SSL options to be used for Faraday connection.
-  #
-  def self.ssl_options
-    @@ssl_options
-  end
-end
+# 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 MsRest
+  #
+  # Class which represents a point of access to the REST API.
+  #
+  class ServiceClient
+
+    # @return [MsRest::ServiceClientCredentials] the credentials object.
+    attr_accessor :credentials
+
+    # @return [Hash{String=>String}] default middlewares configuration for requests.
+    attr_accessor :middlewares
+
+    # @return [Hash{String=>String}] default request headers for requests.
+    attr_accessor :request_headers
+
+    # @return [Array] strings to be appended to the user agent in the request
+    attr_accessor :user_agent_extended
+
+    #
+    # Creates and initialize new instance of the ServiceClient class.
+    #
+    # @param credentials [MsRest::ServiceClientCredentials] credentials to authorize
+    # HTTP requests made by the service client.
+    # @param options additional parameters for the HTTP request (not implemented yet).
+    #
+    def initialize(credentials = nil, options = nil)
+      @credentials = credentials
+      @request_headers = {}
+      @middlewares = {middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]]}
+      @user_agent_extended = []
+      @user_agent_extended.push("ms_rest/#{MsRest::VERSION}")
+    end
+
+    #
+    # @param base_url [String] the base url for the request.
+    # @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete.
+    # @param path [String] the path, relative to {base_url}.
+    # @param options [Hash{String=>String}] specifying any request options like :credentials, :body, etc.
+    # @return [Concurrent::Promise] Promise object which holds the HTTP response.
+    #
+    def make_request_async(base_url, method, path, options = {})
+      options = @middlewares.merge(options)
+      options[:credentials] = options[:credentials] || @credentials
+      options[:user_agent_extended] = @user_agent_extended
+      request  = MsRest::HttpOperationRequest.new(base_url, path, method, options)
+      promise = request.run_promise do |req|
+        options[:credentials].sign_request(req) unless options[:credentials].nil?
+      end
+      promise = promise.then do |http_response|
+        response_content = http_response.body.to_s.empty? ? nil : http_response.body
+        # Create response
+        create_response(request, http_response, response_content)
+      end
+      promise.execute
+    end
+
+    #
+    # Add additional information into User-Agent header.
+    # @param [String] additional_user_agent_information additional product information for user agent string.
+    #
+    # Example:
+    #  recommended format is Product/[version]
+    #  please refer https://github.com/Azure/azure-sdk-for-ruby/issues/517 for more information.
+    #
+    #  add_user_agent_information('fog-azure-rm/0.2.0')
+    #
+    def add_user_agent_information(additional_user_agent_information)
+      @user_agent_extended.push(additional_user_agent_information)
+    end
+
+    private
+      #
+      # Retrieves a new instance of the HttpOperationResponse class.
+      # @param [MsRest::HttpOperationRequest] request the HTTP request object.
+      # @param [Faraday::Response] response the HTTP response object.
+      # @param [String] body the HTTP response body.
+      # @return [MsRest::HttpOperationResponse] the operation response.
+      #
+      def create_response(request, http_response, body = nil)
+        HttpOperationResponse.new(request, http_response, body)
+      end
+  end
+
+  #
+  # Hash of SSL options for Faraday connection. Default is nil.
+  #
+  @@ssl_options = {}
+
+  #
+  # Stores the SSL options to be used for Faraday connections.
+  # ==== Examples
+  #   MsRest.use_ssl_cert                                  # => Uses bundled certificate for all the connections
+  #   MsRest.use_ssl_cert({:ca_file => "path_to_ca_file"}) # => Uses supplied certificate for all the connections
+  #
+  # @param ssl_options [Hash] Hash of SSL options for Faraday connection. It defaults to the bundled certificate.
+  #
+  def self.use_ssl_cert(ssl_options = nil)
+    if ssl_options.nil?
+      @@ssl_options = {:ca_file => File.expand_path(File.join(File.dirname(__FILE__), '../..', 'ca-cert.pem')) }
+    else
+      @@ssl_options = ssl_options
+    end
+  end
+
+  #
+  # @return [Hash] Hash of SSL options to be used for Faraday connection.
+  #
+  def self.ssl_options
+    @@ssl_options
+  end
+end