ms_rest_azure 0.11.1 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 940195f4f289af37bd4eb5197f744c5a16a8952b
-  data.tar.gz: cdbd0bb5b90cc4e707d674cf88fd2968b342b68e
+SHA256:
+  metadata.gz: ef2cf1db2beb396b143bf3ddec0c4df1ca7f8dfe38af73c13c4c81d6f039e0b2
+  data.tar.gz: f2461d024ada41c6e5ef4991928d376c82cdf8bef9be47fb40fb783a64155293
 SHA512:
-  metadata.gz: 05c9ce3e57ebf64212e416c882b92634ad2e85adb2995c92fb230559663d843f53e81bf989bdd4e6dc302f86adb63634ae54f2e1209bca05d96267d8fb013524
-  data.tar.gz: e53e091eac5c26ee1b864d82e6720e862a6d2a285ef65472b59f0d2717bbfd83b67fe5738d3526871c47739baa8a1385d64b4bcd22ca0895baa8d2e6f80b1a27
+  metadata.gz: ff3bf9e1d8ce8e7aee10f9ad5b0fe7648b770a3ebfc22fbc7dacc4f828a6afaf5a8c0ac5e0a1b77b0d8431dece3bb0d948c3a21ce4c94087159f11725279ec60
+  data.tar.gz: 41154e27f1f815e40a2ed1ab4ed0b31e6a9e28d7d52dedef4aca0473d219db3ef6ad4c756ba7df68295078529375978678ee13fa9ad8e7666b431b5029a51ccd

data/README.md

@@ -37,7 +37,7 @@ To start working on the gem the only additional dev dependecy is required - rspe
 Reference it in the gemfile and also add this line to your client's gemspec file:
 
 ```ruby
-spec.add_runtime_dependency 'ms_rest_azure', '~> 0.11.0'
+spec.add_runtime_dependency 'ms_rest_azure', '~> 0.11.1'
 ```
 Don't forget to correct the version.
 

data/lib/ms_rest_azure.rb

@@ -15,6 +15,8 @@ require 'ms_rest_azure/credentials/application_token_provider.rb'
 require 'ms_rest_azure/credentials/cognitive_services_credentials.rb'
 require 'ms_rest_azure/credentials/topic_credentials.rb'
 require 'ms_rest_azure/credentials/msi_token_provider.rb'
+require 'ms_rest_azure/credentials/azure_cli_token_provider.rb'
+require 'ms_rest_azure/azure_cli_error.rb'
 require 'ms_rest_azure/polling_state.rb'
 require 'ms_rest_azure/serialization.rb'
 require 'ms_rest_azure/typed_error_info.rb' 

data/lib/ms_rest_azure/azure_cli_error.rb

@@ -0,0 +1,12 @@
+# 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 MsRestAzure
+  #
+  # Class which represents an error with the Azure CLI.
+  #
+  class AzureCliError < StandardError
+
+  end
+end

data/lib/ms_rest_azure/credentials/application_token_provider.rb

@@ -27,18 +27,24 @@ module MsRestAzure
     attr_accessor :client_secret
 
     # @return [String] auth token.
-    attr_accessor :token
+    attr_writer :token
 
     # @return [Time] the date when the current token expires.
-    attr_accessor :token_expires_on
+    attr_writer :token_expires_on
 
     # @return [Integer] the amount of time we refresh token before it expires.
     attr_reader :expiration_threshold
 
+    public
+
+    # @return [Time] the date when the current token expires.
+    attr_reader :token_expires_on
+
     # @return [String] the type of token.
     attr_reader :token_type
 
-    public
+    # @return [String] auth token.
+    attr_reader :token
 
     #
     # Creates and initialize new instance of the ApplicationTokenProvider class.

data/lib/ms_rest_azure/credentials/azure_cli_token_provider.rb

@@ -0,0 +1,97 @@
+# 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 'time'
+
+module MsRestAzure
+  #
+  # Class that provides access to access tokens generated by the azure cli.
+  #
+  class AzureCliTokenProvider < MsRest::TokenProvider
+    private
+
+    # @return [String] the type of token.
+    attr_reader :cli_path
+
+    # @return [ActiveDirectoryServiceSettings] settings.
+    attr_accessor :settings
+
+    # @return [String] auth token.
+    attr_accessor :token
+    
+    # @return [Time] the date when the current token expires.
+    attr_accessor :token_expires_on
+    
+    # @return [Integer] the amount of time we refresh token before it expires.
+    attr_reader :expiration_threshold
+    
+    # @return [String] the type of token.
+    attr_reader :token_type
+
+    public
+
+    #
+    # Creates and initialize new instance of the AzureCliTokenProvider class.
+    # @param settings [ActiveDirectoryServiceSettings] active directory setting.
+    def initialize(settings = ActiveDirectoryServiceSettings.get_azure_settings)
+      fail ArgumentError, 'Azure AD settings cannot be nil' if settings.nil?
+      raise AzureCliError, 'Azure CLI is not installed' unless locate_azure_cli
+
+      @settings = settings
+
+      @expiration_threshold = 5 * 60
+    end
+    
+    #
+    # Gets an authentication header string using an access token from the Azure cli
+    # @param settings [ActiveDirectoryServiceSettings] active directory settings.
+    #
+    # @return [String] The authenticaiton header string
+    def get_authentication_header
+      acquire_token if token_expired?
+      "#{token_type} #{token}"
+    end
+    
+    private
+    
+    #
+    # Checks whether token is about to expire.
+    #
+    # @return [Bool] True if token is about to expire, false otherwise.
+    def token_expired?
+      @token.nil? || Time.now >= @token_expires_on + expiration_threshold
+    end
+
+    #
+    # Checks if the Azure CLI is installed
+    #
+    # @return [Boolean] Does the az command exist on the path
+    def locate_azure_cli
+      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each do |ext|
+          executable = File.join(path, "az#{ext}")
+          return @cli_path = executable if File.executable?(executable) && !File.directory?(executable)
+        end
+      end
+
+      return nil
+    end
+    
+    #
+    # Acquires a new access token from teh azure CLI
+    #
+    # @return [String] The access token to the desired resource
+    def acquire_token()
+      response_body = JSON.load(`#{cli_path} account get-access-token -o json --resource #{@settings.token_audience}`)
+      
+      @token_expires_on = Time.parse(response_body['expiresOn'])
+      @token_type = response_body['tokenType']
+      @token = response_body['accessToken']
+    rescue
+      raise AzureCliError, 'Error acquiring token from the Azure CLI'
+    end
+  end
+
+end

data/lib/ms_rest_azure/credentials/msi_token_provider.rb

@@ -32,18 +32,24 @@ module MsRestAzure
     attr_accessor :msi_res_id
 
     # @return [String] auth token.
-    attr_accessor :token
+    attr_writer :token
 
     # @return [Time] the date when the current token expires.
-    attr_accessor :token_expires_on
+    attr_writer :token_expires_on
 
     # @return [Integer] the amount of time we refresh token before it expires.
     attr_reader :expiration_threshold
 
+    public
+
+    # @return [Time] the date when the current token expires.
+    attr_reader :token_expires_on
+
     # @return [String] the type of token.
     attr_reader :token_type
 
-    public
+    # @return [String] auth token.
+    attr_reader :token
 
     #
     # Creates and initialize new instance of the MSITokenProvider class.

data/lib/ms_rest_azure/version.rb

@@ -3,5 +3,5 @@
 # Licensed under the MIT License. See License.txt in the project root for license information.
 
 module MsRestAzure
-  VERSION = '0.11.1'
+  VERSION = '0.11.2'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ms_rest_azure
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.11.2
 platform: ruby
 authors:
 - Microsoft Corporation
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-15 00:00:00.000000000 Z
+date: 2020-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +84,22 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: faraday-cookie_jar
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +120,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.4
+        version: 0.7.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.4
+        version: 0.7.6
 description: Azure Client Library for Ruby.
 email: azsdkteam@microsoft.com
 executables: []
@@ -134,6 +140,7 @@ files:
 - lib/ms_rest_azure.rb
 - lib/ms_rest_azure/active_directory_service_settings.rb
 - lib/ms_rest_azure/async_operation_status.rb
+- lib/ms_rest_azure/azure_cli_error.rb
 - lib/ms_rest_azure/azure_environment.rb
 - lib/ms_rest_azure/azure_operation_error.rb
 - lib/ms_rest_azure/azure_operation_response.rb
@@ -142,6 +149,7 @@ files:
 - lib/ms_rest_azure/common/configurable.rb
 - lib/ms_rest_azure/common/default.rb
 - lib/ms_rest_azure/credentials/application_token_provider.rb
+- lib/ms_rest_azure/credentials/azure_cli_token_provider.rb
 - lib/ms_rest_azure/credentials/cognitive_services_credentials.rb
 - lib/ms_rest_azure/credentials/msi_token_provider.rb
 - lib/ms_rest_azure/credentials/topic_credentials.rb
@@ -158,7 +166,7 @@ metadata:
   changelog_uri: https://github.com/Azure/azure-sdk-for-ruby/blob/master/runtime/ms_rest_azure/CHANGELOG.md
   documentation_uri: https://azure.microsoft.com/en-us/develop/ruby/
   homepage_uri: https://aka.ms/azure-sdk-for-ruby
-  source_code_uri: https://github.com/Azure/azure-sdk-for-ruby/tree/ms_rest_azure-v0.11.1
+  source_code_uri: https://github.com/Azure/azure-sdk-for-ruby/tree/ms_rest_azure-v0.11.2
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -175,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Azure Client Library for Ruby.