class MsRestAzure::CognitiveServicesCredentials

Class that provides access to authentication token.

Attributes

subscription_key[R]

@return [String] the subscription key

Public Class Methods

new(subscription_key) click to toggle source

Creates and initialize new instance of the CognitiveServicesCredentials class. @param #subscription_key [String] subscription key

# File lib/ms_rest_azure/credentials/cognitive_services_credentials.rb, line 20
def initialize(subscription_key)
  fail ArgumentError, 'Subscription key cannot be nil' if subscription_key.nil?
  fail ArgumentError, 'Subscription key must be of type string' if subscription_key.class.to_s != 'String'
  @subscription_key = subscription_key
end

Public Instance Methods

sign_request(request) click to toggle source
Calls superclass method
# File lib/ms_rest_azure/credentials/cognitive_services_credentials.rb, line 26
def sign_request(request)
  super(request)

  if (request.respond_to?(:request_headers))
    request.request_headers['Ocp-Apim-Subscription-Key'] = @subscription_key
    request.request_headers['X-BingApis-SDK-Client'] = 'ruby-SDK'
  elsif request.respond_to?(:headers)
    request.headers['Ocp-Apim-Subscription-Key'] = @subscription_key
    request.headers['X-BingApis-SDK-Client'] = 'ruby-SDK'
  else
    fail ArgumentError, 'Incorrect request object was provided'
  end
end