ms_rest2 0.7.6

data/lib/ms_rest/credentials/basic_authentication_credentials.rb

@@ -0,0 +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

data/lib/ms_rest/credentials/service_client_credentials.rb

@@ -0,0 +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

data/lib/ms_rest/credentials/string_token_provider.rb

@@ -0,0 +1,41 @@
+# 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 StringTokenProvider < TokenProvider
+
+    private
+
+    # @return [String] the access token.
+    attr_accessor :token
+
+    # @return [String] the token type.
+    attr_accessor :token_type
+
+    public
+
+    #
+    # Creates and initalizes a new instance of StringTokenProvider class.
+
+    # @param token [String] the access token.
+    # @param token_type [String] the token type.
+    #
+    def initialize(token, token_type = TokenCredentials::DEFAULT_SCHEME)
+      @token = token
+      @token_type = token_type
+    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
+      "#{token_type} #{token}"
+    end
+  end
+end

data/lib/ms_rest/credentials/token_credentials.rb

@@ -0,0 +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

data/lib/ms_rest/credentials/token_provider.rb

@@ -0,0 +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

data/lib/ms_rest/deserialization_error.rb

@@ -0,0 +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

data/lib/ms_rest/http_operation_error.rb

@@ -0,0 +1,72 @@
+# 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 meaning that either HTTP request or HTTP response was invalid.
+  #
+  class HttpOperationError < RestError
+
+    # @return [Hash] the HTTP request data (uri, body, headers).
+    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 HttpOperationException class.
+    # @param [Hash] the HTTP request data (uri, body, headers).
+    # @param [Faraday::Response] the HTTP response object.
+    # @param [String] body the HTTP response body.
+    # @param [String] error message.
+    #
+    def initialize(*args)
+      @msg = self.class.name
+      if args.size == 1
+        # When only message is provided.
+        @msg = args[0]
+        super(args[0])
+      elsif args.size == 2
+        # When only request and response provided, body is nil.
+        @request = args[0]
+        @response = args[1]
+        @body = nil
+        super()
+      elsif args.size == 3
+        # When request, response and body were provided.
+        @request = args[0]
+        @response = args[1]
+        @body = args[2]
+        super()
+      elsif args.size == 4
+        # When request, response, body and message were provided.
+        @request = args[0]
+        @response = args[1]
+        @body = args[2]
+        @msg = args[3]
+        super(args[3])
+      else
+        fail ArgumentError, 'Invalid number of arguments was provided, valid number: 1, 2, 3 or 4'
+      end
+    end
+    
+    def to_json(*a)
+      res_dict = response ? { body: response.body, headers: response.headers, status: response.status } : nil
+      {message: @msg, request: request, response: res_dict}.to_json(*a)
+    end
+    
+    def to_s
+      begin
+        JSON.pretty_generate(self)
+      rescue Exception => ex
+        "#{self.class.name} failed in \n\t#{backtrace.join("\n\t")}"
+      end
+    end
+  end
+
+end

data/lib/ms_rest/http_operation_request.rb

@@ -0,0 +1,135 @@
+# 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 HttpOperationRequest
+
+    # @return [Hash] path parameters to be ERB::Util.url_encode encoded
+    attr_accessor :path_params
+    
+    # @return [Hash] path parameters not to be ERB::Util.url_encode encoded
+    attr_accessor :skip_encoding_path_params
+    
+    # @return [Hash] query parameters to be ERB::Util.url_encode encoded
+    attr_accessor :query_params
+    
+    # @return [Hash] query parameters to be ERB::Util.url_encode encoded
+    attr_accessor :skip_encoding_query_params
+    
+    # @return [String] base uri of the request
+    attr_accessor :base_uri
+    
+    # @return [String] path template /{replace}/{url_param}
+    attr_accessor :path_template
+    
+    # @return [Hash] request headers
+    attr_accessor :headers
+    
+    # @return [String] http request method
+    attr_accessor :method
+
+    # @return [String] the HTTP response body.
+    attr_accessor :body
+    
+    # @return [Array] the list of middlewares to apply to the Request
+    attr_accessor :middlewares
+    
+    # @return [String] full - to log requests, responses and bodies, partial - just requests and responses without body
+    attr_accessor :log
+    
+    # @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 HttpOperationResponse class.
+    # @param [String|URI] base uri for requests
+    # @param [String] path template /{replace}/{url_param}
+    # @param [String] http method for the request
+    # @param [Hash] body the HTTP response body.
+    def initialize(base_uri, path_template, method, options = {})
+      fail 'path_template must not be nil' if path_template.nil?
+      fail 'method must not be nil' if method.nil?
+      
+      @base_uri = base_uri || ''
+      @path_template = path_template
+      @method = method
+      @headers = {}
+      @user_agent_extended = []
+      
+      options.each do |k,v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+    
+    # Creates a promise which will execute the request. Block will yield the request for customization.
+    # @return [URI] body the HTTP response body.
+    def run_promise(&block)
+      Concurrent::Promise.new do
+        @connection ||= Faraday.new(:url => base_uri, :ssl => MsRest.ssl_options) do |faraday|
+          middlewares.each{ |args| faraday.use(*args) } unless middlewares.nil?
+          faraday.adapter Faraday.default_adapter
+          logging = ENV['AZURE_HTTP_LOGGING'] || log
+          if logging
+            faraday.response :logger, nil, { :bodies => logging == 'full' }
+          end
+        end
+
+        loop do
+          @response = @connection.run_request(:"#{method}", build_path, body, {'User-Agent' => user_agent}.merge(headers)) do |req|
+            req.params = req.params.merge(query_params.reject{|_, v| v.nil?}) unless query_params.nil?
+            yield(req) if block_given?
+          end
+
+          break if ((@response.status != 429) || (@response.status == 429 && @response.headers['retry-after'].nil?))
+
+          if(@response.status == 429 && !@response.headers['retry-after'].nil?)
+            sleep(@response.headers['retry-after'].to_i)
+          end
+        end
+        @response
+      end
+    end
+    
+    # Creates a path from the path template and the path_params and skip_encoding_path_params
+    # @return [URI] body the HTTP response body.
+    def build_path
+      template = path_template.dup
+      path_params.each{ |key, value| template["{#{key}}"] = ERB::Util.url_encode(value) if template.include?("{#{key}}") } unless path_params.nil?
+      skip_encoding_path_params.each{ |key, value| template["{#{key}}"] = value } unless skip_encoding_path_params.nil?
+      path = URI.parse(template.gsub(/([^:]|\A)\/\//, '\1/'))
+      unless skip_encoding_query_params.nil?
+        path.query = [(path.query || ""), skip_encoding_query_params.reject{|_, v| v.nil?}.map{|k,v| "#{k}=#{v}"}].join('&')
+      end
+      path
+    end
+    
+    def full_uri
+      URI.join(base_uri || '', build_path)
+    end
+    
+    def user_agent
+      "Ruby/#{RUBY_VERSION} (#{RUBY_PLATFORM}) #{user_agent_extended.join(' ')}"
+    end
+    
+    def to_json(*a)
+      {
+        base_uri: base_uri,
+        path_template: path_template,
+        method: method, 
+        path_params: path_params,
+        skip_encoding_path_params: skip_encoding_path_params,
+        query_params: query_params,
+        skip_encoding_query_params: skip_encoding_query_params,
+        headers: headers,
+        body: body,
+        middlewares: middlewares,
+        log: log  
+      }.to_json(*a)
+    end
+    
+  end
+  
+end

data/lib/ms_rest/http_operation_response.rb

@@ -0,0 +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

data/lib/ms_rest/jsonable.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 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

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

data/lib/ms_rest/retry_policy_middleware.rb

@@ -0,0 +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