ms_rest 0.7.4 → 0.7.5

data/lib/ms_rest.rb

@@ -1,29 +1,29 @@
-# 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 'base64'
-require 'openssl'
-require 'faraday'
-require 'timeliness'
-require 'ms_rest/version'
-
-require 'ms_rest/credentials/token_provider'
-require 'ms_rest/credentials/string_token_provider'
-require 'ms_rest/credentials/service_client_credentials'
-require 'ms_rest/credentials/basic_authentication_credentials'
-require 'ms_rest/credentials/token_credentials'
-
-require 'ms_rest/rest_error.rb'
-require 'ms_rest/deserialization_error.rb'
-require 'ms_rest/validation_error.rb'
-require 'ms_rest/serialization.rb'
-require 'ms_rest/http_operation_response'
-require 'ms_rest/http_operation_request'
-require 'ms_rest/http_operation_error'
-require 'ms_rest/retry_policy_middleware'
-require 'ms_rest/service_client'
-require 'ms_rest/jsonable'
-
-module MsRest end
-module MsRest::Serialization 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.
+
+require 'base64'
+require 'openssl'
+require 'faraday'
+require 'timeliness'
+require 'ms_rest/version'
+
+require 'ms_rest/credentials/token_provider'
+require 'ms_rest/credentials/string_token_provider'
+require 'ms_rest/credentials/service_client_credentials'
+require 'ms_rest/credentials/basic_authentication_credentials'
+require 'ms_rest/credentials/token_credentials'
+
+require 'ms_rest/rest_error.rb'
+require 'ms_rest/deserialization_error.rb'
+require 'ms_rest/validation_error.rb'
+require 'ms_rest/serialization.rb'
+require 'ms_rest/http_operation_response'
+require 'ms_rest/http_operation_request'
+require 'ms_rest/http_operation_error'
+require 'ms_rest/retry_policy_middleware'
+require 'ms_rest/service_client'
+require 'ms_rest/jsonable'
+
+module MsRest end
+module MsRest::Serialization end

data/lib/ms_rest/credentials/basic_authentication_credentials.rb

@@ -1,62 +1,62 @@
-# 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 keeps functionality and data for performing HTTP basic authentication.
-
-  #
-  class BasicAuthenticationCredentials < ServiceClientCredentials
-
-    private
-
-    DEFAULT_SCHEME = 'Basic'
-
-    # @return [String] the scheme for composing credentials.
-    attr_accessor :scheme
-
-    # @return [String] the username for authentication.
-    attr_accessor :user_name
-
-    # @return [String] password for authentication.
-    attr_accessor :password
-
-    public
-
-    #
-    # Creates and initialize new instance of the BasicAuthenticationCredentials class.
-    # @param user_name [String] the username for authentication.
-    # @param password [String] the password for authentication.
-    # @param scheme = DEFAULT_SCHEME [String] the scheme for composing credentials.
-    def initialize(user_name, password, scheme = DEFAULT_SCHEME)
-      fail ArgumentError, 'user_name cannot be nil' if user_name.nil?
-      fail ArgumentError, 'password cannot be nil' if password.nil?
-      fail ArgumentError, 'scheme cannot be nil' if scheme.nil?
-
-      @user_name = user_name
-      @password = password
-      @scheme = scheme
-    end
-
-    #
-    # Attaches basic authentication header to the given HTTP request.
-    # @param request [Net::HTTPRequest] the request authentication header needs to be attached to.
-    #
-    # @return [Net::HTTPRequest] request with attached authentication header.
-    def sign_request(request)
-      super(request)
-      encodeCredentials = Base64.strict_encode64("#{user_name}:#{password}")
-      credentials = "#{scheme} #{encodeCredentials}"
-
-      if (request.respond_to?(:request_headers))
-        request.request_headers[AUTHORIZATION] = credentials
-      elsif request.respond_to?(:headers)
-        request.headers[AUTHORIZATION] = credentials
-      else
-        fail ArgumentError, 'Incorrect request object was provided'
-      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 keeps functionality and data for performing HTTP basic authentication.
+
+  #
+  class BasicAuthenticationCredentials < ServiceClientCredentials
+
+    private
+
+    DEFAULT_SCHEME = 'Basic'
+
+    # @return [String] the scheme for composing credentials.
+    attr_accessor :scheme
+
+    # @return [String] the username for authentication.
+    attr_accessor :user_name
+
+    # @return [String] password for authentication.
+    attr_accessor :password
+
+    public
+
+    #
+    # Creates and initialize new instance of the BasicAuthenticationCredentials class.
+    # @param user_name [String] the username for authentication.
+    # @param password [String] the password for authentication.
+    # @param scheme = DEFAULT_SCHEME [String] the scheme for composing credentials.
+    def initialize(user_name, password, scheme = DEFAULT_SCHEME)
+      fail ArgumentError, 'user_name cannot be nil' if user_name.nil?
+      fail ArgumentError, 'password cannot be nil' if password.nil?
+      fail ArgumentError, 'scheme cannot be nil' if scheme.nil?
+
+      @user_name = user_name
+      @password = password
+      @scheme = scheme
+    end
+
+    #
+    # Attaches basic authentication header to the given HTTP request.
+    # @param request [Net::HTTPRequest] the request authentication header needs to be attached to.
+    #
+    # @return [Net::HTTPRequest] request with attached authentication header.
+    def sign_request(request)
+      super(request)
+      encodeCredentials = Base64.strict_encode64("#{user_name}:#{password}")
+      credentials = "#{scheme} #{encodeCredentials}"
+
+      if (request.respond_to?(:request_headers))
+        request.request_headers[AUTHORIZATION] = credentials
+      elsif request.respond_to?(:headers)
+        request.headers[AUTHORIZATION] = credentials
+      else
+        fail ArgumentError, 'Incorrect request object was provided'
+      end
+    end
+
+  end
+end

data/lib/ms_rest/credentials/service_client_credentials.rb

@@ -1,22 +1,22 @@
-# 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 that serves as a base for all authentications classes.
-  #
-  class ServiceClientCredentials
-
-    AUTHORIZATION = 'authorization'
-
-    #
-    # Base method for performing authentication of HTTP requests.
-    # @param request [Net::HTTPRequest] HTTP request to authenticate
-    #
-    # @return [Net::HTTPRequest] authenticated HTTP request
-    def sign_request(request)
-      fail ArgumentError, 'request is nil.' if request.nil?
-    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 that serves as a base for all authentications classes.
+  #
+  class ServiceClientCredentials
+
+    AUTHORIZATION = 'authorization'
+
+    #
+    # Base method for performing authentication of HTTP requests.
+    # @param request [Net::HTTPRequest] HTTP request to authenticate
+    #
+    # @return [Net::HTTPRequest] authenticated HTTP request
+    def sign_request(request)
+      fail ArgumentError, 'request is nil.' if request.nil?
+    end
+  end
+end

data/lib/ms_rest/credentials/token_credentials.rb

@@ -1,61 +1,61 @@
-# 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 keeps functionality and date for performing OAuth (token based) authentication.
-  #
-  class TokenCredentials < ServiceClientCredentials
-
-    private
-
-    DEFAULT_SCHEME = 'Bearer'
-
-    # @return [String] the scheme for arranging token in the HTTP header.
-    attr_accessor :token_provider
-
-    public
-
-    #
-    # Creates and initialize new instance of the TokenCredentials class.
-    # @param token_provider [TokenProvider] the token provider.
-    # @param token [String] the token.
-    def initialize(*args)
-      if (args.size == 1)
-        if args[0].respond_to? :get_authentication_header
-          @token_provider = args[0]
-        elsif args[0].is_a? String
-          @token_provider = StringTokenProvider.new args[0], DEFAULT_SCHEME
-        else
-          fail ArgumentError, 'Invalid argument was passed, is can be either TokenProvider or token'
-        end
-      elsif (args.size == 2)
-        token = args[0]
-        token_type = args[1]
-        @token_provider = StringTokenProvider.new token, token_type
-      else
-        fail ArgumentError, 'Invalid number of parameters was passed to TokenCredentials constructor, valid number is 1 or 2'
-      end
-    end
-
-    #
-    # Attaches OAuth authentication header to the given HTTP request.
-    # @param request [Net::HTTPRequest] the request authentication header needs to be attached to.
-    #
-    # @return [Net::HTTPRequest] request with attached authentication header
-    def sign_request(request)
-      super(request)
-      header = @token_provider.get_authentication_header
-
-      if (request.respond_to?(:request_headers))
-        request.request_headers[AUTHORIZATION] = header
-      elsif request.respond_to?(:headers)
-        request.headers[AUTHORIZATION] = header
-      else
-        fail ArgumentError, 'Incorrect request object was provided'
-      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 keeps functionality and date for performing OAuth (token based) authentication.
+  #
+  class TokenCredentials < ServiceClientCredentials
+
+    private
+
+    DEFAULT_SCHEME = 'Bearer'
+
+    # @return [String] the scheme for arranging token in the HTTP header.
+    attr_accessor :token_provider
+
+    public
+
+    #
+    # Creates and initialize new instance of the TokenCredentials class.
+    # @param token_provider [TokenProvider] the token provider.
+    # @param token [String] the token.
+    def initialize(*args)
+      if (args.size == 1)
+        if args[0].respond_to? :get_authentication_header
+          @token_provider = args[0]
+        elsif args[0].is_a? String
+          @token_provider = StringTokenProvider.new args[0], DEFAULT_SCHEME
+        else
+          fail ArgumentError, 'Invalid argument was passed, is can be either TokenProvider or token'
+        end
+      elsif (args.size == 2)
+        token = args[0]
+        token_type = args[1]
+        @token_provider = StringTokenProvider.new token, token_type
+      else
+        fail ArgumentError, 'Invalid number of parameters was passed to TokenCredentials constructor, valid number is 1 or 2'
+      end
+    end
+
+    #
+    # Attaches OAuth authentication header to the given HTTP request.
+    # @param request [Net::HTTPRequest] the request authentication header needs to be attached to.
+    #
+    # @return [Net::HTTPRequest] request with attached authentication header
+    def sign_request(request)
+      super(request)
+      header = @token_provider.get_authentication_header
+
+      if (request.respond_to?(:request_headers))
+        request.request_headers[AUTHORIZATION] = header
+      elsif request.respond_to?(:headers)
+        request.headers[AUTHORIZATION] = header
+      else
+        fail ArgumentError, 'Incorrect request object was provided'
+      end
+    end
+
+  end
+end

data/lib/ms_rest/credentials/token_provider.rb

@@ -1,19 +1,19 @@
-# 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 that provides access to authentication token.
-  #
-  class TokenProvider
-
-    #
-    # 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
-    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 that provides access to authentication token.
+  #
+  class TokenProvider
+
+    #
+    # 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
+    end
+  end
+end

data/lib/ms_rest/deserialization_error.rb

@@ -1,43 +1,43 @@
-# 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 'json'
-
-module MsRest
-  #
-  # Class which represents an error happening during deserialization of server response.
-  #
-  class DeserializationError < RestError
-
-    # @return [String] the inner exception message.
-    attr_accessor :exception_message
-
-    # @return [String] the inner exception stacktrace.
-    attr_accessor :exception_stacktrace
-
-    # @return [MsRest::HttpOperationResponse] server response which client was unable to parse.
-    attr_accessor :result
-
-    #
-    # Creates and initialize new instance of the DeserializationError class.
-    # @param [String] message message the human readable description of error.
-    # @param [String] exception_message the inner exception stacktrace.
-    # @param [String] exception_stacktrace the inner exception stacktrace.
-    # @param [MsRest::HttpOperationResponse] the request and response
-    def initialize(msg, exception_message, exception_stacktrace, result)
-      @msg = msg || self.class.name
-      @exception_message = exception_message
-      @exception_stacktrace = exception_stacktrace
-      @result = result
-    end
-    
-    def to_json(*a)
-      {exception_message: exception_message, message: @msg,  stacktrace: exception_stacktrace, result: result}.to_json(*a)
-    end
-    
-    def to_s
-      JSON.pretty_generate(self)
-    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.
+require 'json'
+
+module MsRest
+  #
+  # Class which represents an error happening during deserialization of server response.
+  #
+  class DeserializationError < RestError
+
+    # @return [String] the inner exception message.
+    attr_accessor :exception_message
+
+    # @return [String] the inner exception stacktrace.
+    attr_accessor :exception_stacktrace
+
+    # @return [MsRest::HttpOperationResponse] server response which client was unable to parse.
+    attr_accessor :result
+
+    #
+    # Creates and initialize new instance of the DeserializationError class.
+    # @param [String] message message the human readable description of error.
+    # @param [String] exception_message the inner exception stacktrace.
+    # @param [String] exception_stacktrace the inner exception stacktrace.
+    # @param [MsRest::HttpOperationResponse] the request and response
+    def initialize(msg, exception_message, exception_stacktrace, result)
+      @msg = msg || self.class.name
+      @exception_message = exception_message
+      @exception_stacktrace = exception_stacktrace
+      @result = result
+    end
+    
+    def to_json(*a)
+      {exception_message: exception_message, message: @msg,  stacktrace: exception_stacktrace, result: result}.to_json(*a)
+    end
+    
+    def to_s
+      JSON.pretty_generate(self)
+    end
+
+  end
+end