Module: MsRest2

Defined in:
lib/ms_rest2/version.rb,
lib/ms_rest2.rb,
lib/ms_rest2/jsonable.rb,
lib/ms_rest2/rest_error.rb,
lib/ms_rest2/serialization.rb,
lib/ms_rest2/service_client.rb,
lib/ms_rest2/validation_error.rb,
lib/ms_rest2/http_operation_error.rb,
lib/ms_rest2/deserialization_error.rb,
lib/ms_rest2/http_operation_request.rb,
lib/ms_rest2/http_operation_response.rb,
lib/ms_rest2/retry_policy_middleware.rb,
lib/ms_rest2/credentials/token_provider.rb,
lib/ms_rest2/credentials/token_credentials.rb,
lib/ms_rest2/credentials/string_token_provider.rb,
lib/ms_rest2/credentials/service_client_credentials.rb,
lib/ms_rest2/credentials/basic_authentication_credentials.rb

Overview

Copyright © Microsoft Corporation. All rights reserved. Licensed under the MIT License. See License.txt in the project root for license information.

Defined Under Namespace

Modules: JSONable, Serialization Classes: BasicAuthenticationCredentials, DeserializationError, HttpOperationError, HttpOperationRequest, HttpOperationResponse, RestError, RetryPolicyMiddleware, ServiceClient, ServiceClientCredentials, StringTokenProvider, TokenCredentials, TokenProvider, ValidationError

Constant Summary collapse

VERSION = 
'1.0.1'
@@ssl_options =

Hash of SSL options for Faraday connection. Default is nil.

{}

Class Method Summary collapse

Class Method Details

.ssl_options ⇒ Hash

Returns Hash of SSL options to be used for Faraday connection.

Returns:

  • (Hash) —

    Hash of SSL options to be used for Faraday connection.



112
113
114
 
# File 'lib/ms_rest2/service_client.rb', line 112

def self.ssl_options
  @@ssl_options
end

.use_ssl_cert(ssl_options = nil) ⇒ Object

Stores the SSL options to be used for Faraday connections.

Examples

MsRest2.use_ssl_cert                                  # => Uses bundled certificate for all the connections
MsRest2.use_ssl_cert({:ca_file => "path_to_ca_file"}) # => Uses supplied certificate for all the connections

Parameters:

  • ssl_options (Hash) (defaults to: nil) —

    Hash of SSL options for Faraday connection. It defaults to the bundled certificate.



101
102
103
104
105
106
107
 
# File 'lib/ms_rest2/service_client.rb', line 101

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