azure-armrest 0.9.15 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80afc2002d933a6dcb326ccac2d00089cabb7e4a7b6682035aaf230fd39331e7
-  data.tar.gz: faf1d1200944bff09a16d42245cb3e09cb3c0c7d77c6f1fa205da31f8b30eeb2
+  metadata.gz: 48ccdc0fcdca3b16cff714ed97ed330999bbd87e67ba6d590b365e034af41fdb
+  data.tar.gz: 6094b9d354b14574ac3b5ab3a2f3b123460ba9120662392b29a664b424f69640
 SHA512:
-  metadata.gz: 41f18c5fd46a8de71bdbe70e5dbcbdf7488a6b17ea50a9d8340380220b4a6372cc6d3466acd880700808114c84fa929c7dae404fd789c4eb403d85af3643c3be
-  data.tar.gz: 608c0b7d4661ea5f3b6071715c37ea3fe039fa818de14d16e02b4e960c80a10da85abc9b76a4fcc634ff3400175d4a9c12f3101eee3c4a4b6de99cc031af6133
+  metadata.gz: af11539b8761a9fd6edf642e336e0250a8b9c1bf24488da7bf0fa0647094bbbf9ac2772428e98b2bd77f316973f969bf857ff6d678f798ac0d5ce0f6c8b0ad85
+  data.tar.gz: d86a2243bf853a6a3a9bf44cf2bd0900c70001c9fb71f7967e8d54c1ebe77f256cf5900e3427bfc44b71612772ed19ba82c8c1a0167d3418dd59f0d31655dc3d

data/.codeclimate.yml

@@ -0,0 +1,16 @@
+prepare:
+  fetch:
+  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/.rubocop_base.yml
+    path: ".rubocop_base.yml"
+  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/.rubocop_cc_base.yml
+    path: ".rubocop_cc_base.yml"
+  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/styles/base.yml
+    path: styles/base.yml
+  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/styles/cc_base.yml
+    path: styles/cc_base.yml
+plugins:
+  rubocop:
+    enabled: true
+    config: ".rubocop_cc.yml"
+    channel: rubocop-0-82
+version: '2'

data/.rubocop.yml

@@ -1,4 +1,4 @@
+inherit_gem:
+  manageiq-style: ".rubocop_base.yml"
 inherit_from:
-- https://raw.githubusercontent.com/ManageIQ/guides/master/.rubocop_base.yml
-# put all local rubocop config into .rubocop_local.yml as it will be loaded by .rubocop_cc.yml as well
-- .rubocop_local.yml
+- ".rubocop_local.yml"

data/.rubocop_cc.yml

@@ -0,0 +1,4 @@
+inherit_from:
+- ".rubocop_base.yml"
+- ".rubocop_cc_base.yml"
+- ".rubocop_local.yml"

data/.travis.yml

@@ -1,10 +1,8 @@
 language: ruby
-sudo: false
 cache: bundler
 rvm:
-- "2.3.5"
-- "2.4.2"
-- "2.5.3"
+- "2.5.7"
+- "2.6.5"
 - ruby-head
 - jruby-head
 matrix:
@@ -12,4 +10,9 @@ matrix:
   - rvm: ruby-head
   - rvm: jruby-head
   fast_finish: true
-after_script: bundle exec codeclimate-test-reporter
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGES

@@ -1,3 +1,18 @@
+= 0.11.0 - 20-Apr-2021
+* Modify the VirtualMachineService#get method to include instance view
+  information
+* Update default ssl_version to TLSv1_2
+* Fix tenants method
+* Handle application/xml exception content-types
+
+= 0.10.0 - 14-May-2020
+* Updated the rest-client dependency to 2.1.0.
+* Updated the azure-signature dependency to 0.3.0.
+* Updated the MetricsService#list_metrics method to use the current API, which
+  had apparently undergone some serious revision since we first implemented it.
+  It now accepts a hash of options, though you may still pass a string for the
+  sake of backwards compatibility. 
+
 = 0.9.15 - 23-Jan-2020
 * The VirtualMachineService#delete_associated_resources now supports deleting
   attached data disks.

data/README.md

@@ -8,7 +8,6 @@ A Ruby interface for Azure using the new REST API.
 [![Build Status](https://travis-ci.org/ManageIQ/azure-armrest.svg)](https://travis-ci.org/ManageIQ/azure-armrest)
 [![Code Climate](https://codeclimate.com/github/ManageIQ/azure-armrest/badges/gpa.svg)](https://codeclimate.com/github/ManageIQ/azure-armrest)
 [![Test Coverage](https://codeclimate.com/github/ManageIQ/azure-armrest/badges/coverage.svg)](https://codeclimate.com/github/ManageIQ/azure-armrest/coverage)
-[![Dependency Status](https://gemnasium.com/ManageIQ/azure-armrest.svg)](https://gemnasium.com/ManageIQ/azure-armrest)
 [![Security](https://hakiri.io/github/ManageIQ/azure-armrest/master.svg)](https://hakiri.io/github/ManageIQ/azure-armrest/master)
 
 ## Synopsis

data/azure-armrest.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.email    = ['dberger@redhat.com', 'bsorota@redhat.com', 'gblomqui@redhat.com', 'billwei@redhat.com']
   spec.summary  = 'An interface for ARM/JSON Azure REST API'
   spec.homepage = 'http://github.com/ManageIQ/azure-armrest'
-  spec.license  = 'Apache 2.0'
+  spec.license  = 'Apache-2.0'
   spec.files    = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
 
   spec.description = <<-EOF
@@ -17,18 +17,18 @@ different than the current azure gem, which uses the older (XML) interface
 behind the scenes.
   EOF
 
+  spec.add_dependency 'activesupport', '>= 4.2.2'
+  spec.add_dependency 'addressable', '~> 2.8'
+  spec.add_dependency 'azure-signature', '~> 0.3.0'
   spec.add_dependency 'json', '~> 2'
-  spec.add_dependency 'rest-client', '~> 2.0.0'
   spec.add_dependency 'memoist', '~> 0.15'
-  spec.add_dependency 'azure-signature', '~> 0.2.3'
-  spec.add_dependency 'activesupport', '>= 4.2.2'
-  spec.add_dependency 'addressable', '~> 2.5.0'
   spec.add_dependency 'parallel', '~> 1.12.0'
+  spec.add_dependency 'rest-client', '~> 2.1.0'
 
   spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'manageiq-style'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0.0'
   spec.add_development_dependency 'timecop', '~> 0.7'
 end

data/lib/azure/armrest.rb

@@ -1,6 +1,5 @@
 require 'rest-client'
 require 'json'
-require 'thread'
 require 'addressable'
 require 'parallel'
 require 'memoist'

data/lib/azure/armrest/armrest_service.rb

@@ -1,5 +1,6 @@
 require 'time'
 require 'active_support/core_ext/hash/conversions'
+require 'active_support/core_ext/hash/keys'
 require_relative 'model/base_model'
 
 module Azure
@@ -154,7 +155,7 @@ module Azure
       # Returns a list of tenants that can be accessed.
       #
       def tenants
-        url = url_with_api_version(configuration.api_version, configuration.resource_url, 'tenants')
+        url = url_with_api_version(configuration.api_version, configuration.environment.resource_url, 'tenants')
         resp = rest_get(url)
         JSON.parse(resp.body)['value'].map{ |hash| Azure::Armrest::Tenant.new(hash) }
       end
@@ -253,11 +254,22 @@ module Azure
 
         def raise_api_exception(err)
           begin
-            response = JSON.parse(err.http_body)
-            code     = response['error']['code']
-            message  = response['error']['message']
+            content_type_header = err.response.headers[:content_type]
+
+            response = case content_type_header.match(%r{(application/\w+)})[1]
+                       when "application/json"
+                         JSON.parse(err.http_body)
+                       when "application/xml"
+                         # The XML document that is returned has Error, Code, and Message
+                         # so we need to downcase the keys to stay consistent with the
+                         # parsed-json hash.
+                         Hash.from_xml(err.http_body).deep_transform_keys(&:downcase)
+                       end
+
+            code    = response['error']['code']
+            message = response['error']['message']
           rescue
-            code = err.try(:http_code) || err.try(:code)
+            code    = err.try(:http_code) || err.try(:code)
             message = err.try(:http_body) || err.try(:message)
           end
 

data/lib/azure/armrest/configuration.rb

@@ -107,7 +107,7 @@ module Azure
           :content_type  => 'application/json',
           :grant_type    => 'client_credentials',
           :proxy         => ENV['http_proxy'],
-          :ssl_version   => 'TLSv1',
+          :ssl_version   => 'TLSv1_2',
           :timeout       => 60,
           :max_threads   => 10,
           :max_retries   => 3,

data/lib/azure/armrest/insights/metrics_service.rb

@@ -36,9 +36,21 @@ module Azure
           )
         end
 
-        # Returns a list metrics for +resource_id+, which can be
-        # either a resource object or a plain resource string. You
-        # may also provide a +filter+ to limit the results.
+        # Returns a list metrics for +resource_id+, which can be either a
+        # resource object or a plain resource string. You may also provide
+        # hash of filtering +options+ to limit the results. The possible
+        # options are:
+        #
+        #   * :timespan        => The timespan of the query in "start/end" format.
+        #   * :interval        => The interval (timegrain) of the query.
+        #   * :metricnames     => A comma separated list of metrics to retrieve.
+        #   * :aggregation     => A comma separated list of aggregration types to retrieve.
+        #   * :segment         => The name of the dimension to segment the metric values by.
+        #   * :top             => The maximum number of records to retrieve. Defaults to 10.
+        #   * :orderby         => The aggregation to use for sorting.
+        #   * :filter          => An expression used to filter the results.
+        #   * :resultType      => Reduces the set of data collected. Syntax is dependent on operation.
+        #   * :metricnamespace => Metric namespace to query metric definitions for.
         #
         # If no filter expression is defined, the first metric defined
         # for that resource will be returned using the primary aggregation
@@ -49,13 +61,18 @@ module Azure
         #
         #   vm = vms.get('your_vm', 'your_resource_group')
         #
-        #   filter = "name.value eq 'Percentage CPU' and startTime "
-        #   filter << "eq 2017-01-03 and endTime eq 2017-01-04"
+        #   options = {
+        #     :metricnames => "'Percentage CPU'"
+        #     :timespan    => "2020-02-13T02:20:00Z/2020-02-14T04:20:00Z"
+        #     :aggregation => "Average",
+        #     :interval    => "PT1M"
+        #   }
         #
-        #   definitions = mts.list_metrics(vm.id)
+        #   definitions = mts.list_metrics(vm.id, options)
         #
-        def list_metrics(resource, filter = nil)
+        def list_metrics(resource, options = {})
           resource_id = resource.respond_to?(:id) ? resource.id : resource
+          options[:filter] = options if options.is_a?(String) # For backwards compatibility
 
           url = File.join(
             configuration.environment.resource_url,
@@ -64,7 +81,12 @@ module Azure
           )
 
           url << "?api-version=#{api_version}"
-          url << "&$filter=#{filter}" if filter
+
+          # The :filter option requires a leading '$'
+          options.each do |key, value|
+            key.to_s == 'filter' ? url << "&$" : url << "&"
+            url << "#{key}=#{value}"
+          end
 
           response = rest_get(url)
 

data/lib/azure/armrest/model/storage_account.rb

@@ -288,7 +288,7 @@ module Azure
         url = File.join(properties.primary_endpoints.file, share, file)
         url += "?timeout=#{timeout}" if timeout
 
-        hash = options.transform_keys.each { |okey| 'x-ms-' + okey.to_s.tr('_', '-') }
+        hash = options.transform_keys { |okey| 'x-ms-' + okey.to_s.tr('_', '-') }
 
         hash['verb'] = 'PUT'
 
@@ -380,7 +380,7 @@ module Azure
         url = File.join(properties.primary_endpoints.file, share, file) + "?comp=range"
         url += "&timeout=#{timeout}" if timeout
 
-        hash = options.transform_keys.each { |okey| 'x-ms-' + okey.to_s.tr('_', '-') }
+        hash = options.transform_keys { |okey| 'x-ms-' + okey.to_s.tr('_', '-') }
 
         hash['verb'] = 'PUT'
         hash['x-ms-write'] ||= 'update'

data/lib/azure/armrest/resource_group_based_service.rb

@@ -232,7 +232,7 @@ module Azure
           api_version = configuration.provider_default_api_version(provider_name, full_service_name)
         end
         api_version ||= configuration.provider_default_api_version(provider_name, service_name)
-        api_version ||= configuration.api_version
+        api_version || configuration.api_version
       end
 
       def delete_by_url(url, resource_name = '')
@@ -260,7 +260,7 @@ module Azure
       # arguments provided, and appends it with the api_version.
       #
       def build_url(resource_group = nil, *args)
-        url = File.join(configuration.environment.resource_url, build_id_string(resource_group, *args))
+        File.join(configuration.environment.resource_url, build_id_string(resource_group, *args))
       end
 
       def build_id_string(resource_group = nil, *args)
@@ -279,6 +279,8 @@ module Azure
                 query << "&$top=#{value}"
               elsif key.casecmp('filter').zero?
                 query << "&$filter=#{value}" # Allow raw filter
+              elsif key.casecmp('expand').zero?
+                query << "&$expand=#{value}"
               else
                 if query.include?("$filter")
                   query << " and #{key} eq '#{value}'"

data/lib/azure/armrest/resource_provider_service.rb

@@ -142,7 +142,6 @@ module Azure
       private
 
       def build_url(namespace = nil, *args)
-        id = configuration.subscription_id
         url = File.join(base_url, 'providers')
         url = File.join(url, namespace) if namespace
         url = File.join(url, *args) unless args.empty?

data/lib/azure/armrest/storage/managed_storage_helper.rb

@@ -86,7 +86,7 @@ module Azure::Armrest::Storage::ManagedStorageHelper
     rescue Azure::Armrest::ForbiddenException => err
       log('warn', "ManagedStorageHelper.read: #{err}")
       raise err
-    rescue RestClient::Exception, Azure::Armrest::ForbiddenException => err
+    rescue RestClient::Exception, Azure::Armrest::Exception => err
       raise err unless retries < max_retries
       log('warn', "ManagedStorageHelper.read: #{err} - retry number #{retries}")
       retries += 1

data/lib/azure/armrest/version.rb

@@ -1,6 +1,6 @@
 module Azure
   module Armrest
     # The version of the azure-armrest library.
-    VERSION = '0.9.15'.freeze
+    VERSION = '0.12.0'.freeze
   end
 end

data/lib/azure/armrest/virtual_machine_service.rb

@@ -71,23 +71,48 @@ module Azure
       # Retrieves the settings of the VM named +vmname+ in resource group
       # +group+, which will default to the same as the name of the VM.
       #
-      # By default this method will retrieve the model view. If the +model_view+
-      # parameter is false, it will retrieve an instance view. The difference is
-      # in the details of the information retrieved.
+      # You can also specify any query options. At this time only the
+      # :expand => 'instanceView' option is supported, but others could
+      # be added over time.
       #
-      def get(vmname, group = configuration.resource_group, model_view = true)
-        model_view ? super(vmname, group) : get_instance_view(vmname, group)
+      # For backwards compatibility, the third argument may also be a boolean
+      # which will retrieve the model view by default. Set to false if you only
+      # want the instance view.
+      #
+      # Examples:
+      #
+      #   vms = VirtualMachineService.new(credentials)
+      #
+      #   # Standard call, get just the model view
+      #   vms.get('some_name', 'some_group')
+      #   vms.get('some_name', 'some_group', true) # same
+      #
+      #   # Get the instance view only
+      #   vms.get('some_name', 'some_group', false)
+      #
+      #   # Get the instance view merged with the model view
+      #   vms.get('some_name', 'some_group', :expand => 'instanceView')
+      #
+      def get(vmname, group = configuration.resource_group, options = {})
+        if options.kind_of?(Hash)
+          url = build_url(group, vmname, options)
+          response = rest_get(url)
+          VirtualMachineInstance.new(response)
+        else
+          options ? super(vmname, group) : get_instance_view(vmname, group)
+        end
       end
 
       # Convenient wrapper around the get method that retrieves the model view
-      # for +vmname+ in resource_group +group+.
+      # for +vmname+ in resource_group +group+ without the instance view
+      # information.
       #
       def get_model_view(vmname, group = configuration.resource_group)
-        get(vmname, group, true)
+        get(vmname, group)
       end
 
-      # Convenient wrapper around the get method that retrieves the instance view
-      # for +vmname+ in resource_group +group+.
+      # Convenient wrapper around the get method that retrieves only the
+      # instance view for +vmname+ in resource_group +group+.
       #
       def get_instance_view(vmname, group = configuration.resource_group)
         raise ArgumentError, "must specify resource group" unless group
@@ -333,7 +358,7 @@ module Azure
         raise ArgumentError, "must specify name of the vm" unless vmname
 
         url = build_url(group, vmname, action)
-        response = rest_post(url)
+        response = rest_post(url, options.to_json)
 
         Azure::Armrest::ResponseHeaders.new(response.headers).tap do |headers|
           headers.response_code = response.code

metadata

@@ -1,116 +1,116 @@
 --- !ruby/object:Gem::Specification
 name: azure-armrest
 version: !ruby/object:Gem::Version
-  version: 0.9.15
+  version: 0.12.0
 platform: ruby
 authors:
 - Daniel J. Berger
 - Bronagh Sorota
 - Greg Blomquist
 - Bill Wei
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-23 00:00:00.000000000 Z
+date: 2021-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 4.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 4.2.2
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.8'
 - !ruby/object:Gem::Dependency
-  name: memoist
+  name: azure-signature
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
-  name: azure-signature
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: memoist
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.2
+        version: '0.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.2
+        version: '0.15'
 - !ruby/object:Gem::Dependency
-  name: addressable
+  name: parallel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 1.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 1.12.0
 - !ruby/object:Gem::Dependency
-  name: parallel
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -125,6 +125,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: manageiq-style
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -167,20 +181,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -208,9 +208,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_cc.yml"
 - ".rubocop_local.yml"
 - ".travis.yml"
 - CHANGES
@@ -273,9 +275,9 @@ files:
 - lib/azure/armrest/virtual_machine_service.rb
 homepage: http://github.com/ManageIQ/azure-armrest
 licenses:
-- Apache 2.0
+- Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -290,8 +292,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.5
+signing_key:
 specification_version: 4
 summary: An interface for ARM/JSON Azure REST API
 test_files: []