azure-armrest 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73beabef1814841487327de9d64c582c7dabd35a
-  data.tar.gz: 6cdc3b6d754f2974c41de3b8cb57c8bc6aa64a07
+  metadata.gz: 1924d7500a8f68134dca99b63ce6b541bf14a028
+  data.tar.gz: 41aec5ac6cdedc2c040f82f170b75da8d5960ad8
 SHA512:
-  metadata.gz: c3a3cf9f3f4b5d0b8fc38b4e46d79c6686259e3ec5a24a1263a4c0543dcf802ad0d0c17a82fb759b58f38a8a560b78089176bf9670ecf0927e9d4316291575d4
-  data.tar.gz: 7230dcf6df9ade9181e5d18f222578a75ff4b37fb7dbd56d04a096c013f99080f4280999e31700dff409949ce2269898bd06c0995a10a64b63360a8912ca66ab
+  metadata.gz: d849b4b4c4e55c61ad0766246cec6302307f071bef3ba821cd970f9ab2365cb9bf983e34b3af8c3d59702633da2f47630505d43b7638bd30a0c8bc043fc28c7d
+  data.tar.gz: 8f70bf2cee8c8d105846ebd83bef0deefb3f1ebb7563e21124893b1b2e302130761c32e327aacefd652e3cf0cd43490fa2bd9bfd7e2e60eaeb5135468f1f7a58

data/.rubocop.yml

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

data/CHANGES

@@ -1,3 +1,13 @@
+= 0.6.0 - 6-Jan-2017
+* Revamped the Role::AssignmentService and Role::DefinitionService which were
+  mostly broken. These are now each subclassed from a RoleService base class
+  that implements various scope-based methods.
+* The Insights::MetricsService class was updated to add the list_metrics and
+  list_definitions methods. These use the newer API from Azure that is easier
+  to use, but returns fewer definitions.
+* Added the ResourceProviderService#registered? method.
+* Some rubocop updates.
+
 = 0.5.2 - 22-Dec-2016
 * The Configuration#hash method, which is used internally to cache auth
   tokens, was modified to include the environment name. This prevents

data/lib/azure/armrest.rb

@@ -45,6 +45,7 @@ require 'azure/armrest/network/route_table_service'
 require 'azure/armrest/network/route_service'
 require 'azure/armrest/network/virtual_network_service'
 require 'azure/armrest/network/subnet_service'
+require 'azure/armrest/role'
 require 'azure/armrest/role/assignment_service'
 require 'azure/armrest/role/definition_service'
 require 'azure/armrest/sql/sql_server_service'

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

@@ -5,13 +5,15 @@ module Azure
         # Creates and returns a new MetricsService object.
         #
         def initialize(armrest_configuration, options = {})
-          options['api_version'] = '2014-04-01' # Must hard code for now
-          super(armrest_configuration, 'metricDefinitions', 'Microsoft.Insights', options)
+          super(armrest_configuration, 'metrics', 'Microsoft.Insights', options)
         end
 
         # Return the metric definitions for the given +provider+, +resource_type+,
         # and +resource_name+ for +resource_group+. You may pass a :filter option as well.
         #
+        # NOTE: This uses the older REST API. If you want the newer API, use the
+        # list_definitions method below.
+        #
         # Example:
         #
         #   metrics = Azure::Armrest::Insights::MetricsService.new(conf)
@@ -28,11 +30,90 @@ module Azure
 
           response = rest_get(url)
 
-          JSON.parse(response)['value'].map { |hash| Azure::Armrest::Insights::Metric.new(hash) }
+          Azure::Armrest::ArmrestCollection.create_from_response(
+            response,
+            Azure::Armrest::Insights::MetricDefinition
+          )
+        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.
+        #
+        # If no filter expression is defined, the first metric defined
+        # for that resource will be returned using the primary aggregation
+        # type in the metric defintion over a time period of the last hour.
+        #
+        #   vms = Azure::Armrest::VirtualMachineService.new(conf)
+        #   mts = Azure::Armrest::Insights::MetricService.new(conf)
+        #
+        #   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"
+        #
+        #   definitions = mts.list_metrics(vm.id)
+        #
+        def list_metrics(resource, filter = nil)
+          resource_id = resource.respond_to?(:id) ? resource.id : resource
+
+          url = File.join(
+            configuration.environment.resource_url,
+            resource_id,
+            'providers/microsoft.insights/metrics'
+          )
+
+          url << "?api-version=#{api_version}"
+          url << "&$filter=#{filter}" if filter
+
+          response = rest_get(url)
+
+          Azure::Armrest::ArmrestCollection.create_from_response(response, Azure::Armrest::Insights::Metric)
+        end
+
+        # Get a list of metrics definitions 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.
+        #
+        # Note that the output for this method is different than the list
+        # method, which uses an older api-version.
+        #
+        # Example:
+        #
+        #   vms = Azure::Armrest::VirtualMachineService.new(conf)
+        #   mts = Azure::Armrest::Insights::MetricService.new(conf)
+        #
+        #   vm = vms.get('your_vm', 'your_resource_group')
+        #
+        #   # With or without filter
+        #   definitions = mts.list_definitions(vm.id)
+        #   definitions = mts.list_definitions(vm.id, "name.value eq 'Percentage CPU'")
+        #
+        def list_definitions(resource, filter = nil)
+          resource_id = resource.respond_to?(:id) ? resource.id : resource
+          version = configuration.provider_default_api_version(provider, 'metricDefinitions')
+
+          url = File.join(
+            configuration.environment.resource_url,
+            resource_id,
+            'providers/microsoft.insights/metricdefinitions'
+          )
+
+          url << "?api-version=#{version}"
+          url << "&$filter=#{filter}" if filter
+
+          response = rest_get(url)
+
+          Azure::Armrest::ArmrestCollection.create_from_response(
+            response,
+            Azure::Armrest::Insights::MetricDefinition
+          )
         end
 
         private
 
+        # Build a URL for the older version of the metrics definitions API.
+        #
         def build_url(provider, resource_type, resource_name, resource_group, options)
           url = File.join(
             base_url,
@@ -45,7 +126,7 @@ module Azure
             'metricDefinitions'
           )
 
-          url << "?api-version=#{@api_version}"
+          url << "?api-version=2014-04-01"
           url << "&$filter=#{options[:filter]}" if options[:filter]
 
           url

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

@@ -224,6 +224,7 @@ module Azure
       class Diagnostic < BaseModel; end
       class Event < BaseModel; end
       class Metric < BaseModel; end
+      class MetricDefinition < BaseModel; end
     end
 
     module Network

data/lib/azure/armrest/resource_provider_service.rb

@@ -123,6 +123,15 @@ module Azure
         nil
       end
 
+      # Returns whether or not the +namespace+ provider is registered. If
+      # the provider cannot be found, false is returned.
+      #
+      def registered?(namespace)
+        get(namespace).registration_state.casecmp("registered").zero?
+      rescue Azure::Armrest::NotFoundException
+        false
+      end
+
       private
 
       def build_url(namespace = nil, *args)

data/lib/azure/armrest/role.rb

@@ -0,0 +1,104 @@
+module Azure
+  module Armrest
+    # Abstract base class for use by role related service classes.
+    class RoleService < ArmrestService
+      # Most methods accept any one the following options, and their possible
+      # values, that defines the scope for that operation:
+      #
+      # :subscription   => Set to true for subscription level scope
+      # :resource_group => Name of resource group
+      # :resource       => A resource.id string
+      #
+      # The options you define determine the scope of the request:
+      #
+      # :subscription   => /subscriptions/{subscription-id}
+      # :resource_group => /subscriptions/{subscription-id}/resourceGroups/some_group
+      # :resource       => /subscriptions/{subscription-id}/resourceGroups/some_group/providers/Microsoft.Web/sites/mysite1
+      #
+      # Lastly, you can supply a :filter in order to filter results.
+      #
+      # Various list methods have been provided for convenience as well, such
+      # as the list_all method, which lists all roles at the subscription level.
+
+      # Gets information for the role assignment by name, where the "name"
+      # is really just the last portion (GUID) of an ID string.
+      #
+      def get_by_name(role_name, options = {})
+        url = build_url(options.merge(:subscription => true), role_name)
+        response = rest_get(url)
+        model_class.new(response.body)
+      end
+
+      alias get get_by_name
+
+      # Gets information for the role assignment via a resource string ID.
+      #
+      def get_by_id(role_id, options = {})
+        url = build_url(options.merge(:resource => role_id))
+        response = rest_get(url)
+        model_class.new(response.body)
+      end
+
+      alias get_by_resource get_by_id
+
+      # List all role assignments for the current subscription.
+      #
+      def list_all(options = {})
+        url = build_url(options.merge(:subscription => true))
+        response = rest_get(url)
+        Azure::Armrest::ArmrestCollection.create_from_response(response, model_class)
+      end
+
+      alias list_for_subscription list_all
+
+      # List all role assignments for the given +resource_group+.
+      #
+      def list(resource_group, options = {})
+        url = build_url(options.merge(:resource_group => resource_group))
+        response = rest_get(url)
+        Azure::Armrest::ArmrestCollection.create_from_response(response, model_class)
+      end
+
+      alias list_for_resource_group list
+
+      # List all role assignments for the given +resource+.
+      #
+      # Example:
+      #
+      #   vms = Azure::Armrest::VirtualMachineService.new(conf)
+      #   ads = Azure::Armrest::Role::AssignmentService.new(conf)
+      #
+      #   vm = vms.get('some_vm', 'some_group')
+      #   ads.list_for_resource(vm.id)
+      #
+      def list_for_resource(resource, options = {})
+        url = build_url(options.merge(:resource => resource))
+        response = rest_get(url)
+        Azure::Armrest::ArmrestCollection.create_from_response(response, model_class)
+      end
+
+      private
+
+      def build_url(options = {}, property = nil)
+        resource = options.delete(:resource)
+        resource_group = options.delete(:resource_group)
+        subscription = options.delete(:subscription)
+
+        if subscription
+          url = File.join(base_url, 'providers', provider, service_name)
+        elsif resource_group
+          url = File.join(base_url, 'resourceGroups', resource_group, 'providers', provider, service_name)
+        else # resource
+          url = File.join(configuration.environment.resource_url, resource, 'providers', provider, service_name)
+        end
+
+        url = File.join(url, property) if property 
+        url = "#{url}?api-version=#{api_version}"
+
+        options.each { |key, value| url << "&$#{key}=#{value}" }
+
+        url
+      end
+    end #RoleService 
+  end
+end

data/lib/azure/armrest/role/assignment_service.rb

@@ -5,13 +5,13 @@ module Azure
     # Role namespace
     module Role
       # Base class for managing Role Assignments
-      class AssignmentService < ResourceGroupBasedService
+      class AssignmentService < RoleService
         # Create and return a new AssignmentService instance.
         #
         def initialize(armrest_configuration, options = {})
           super(armrest_configuration, 'roleAssignments', 'Microsoft.Authorization', options)
         end
-      end # AssignmentService
-    end # Role
-  end # Armrest
-end # Azure
+      end
+    end
+  end
+end

data/lib/azure/armrest/role/definition_service.rb

@@ -5,13 +5,13 @@ module Azure
     # Role namespace
     module Role
       # Base class for managing Role Definitions
-      class DefinitionService < ResourceGroupBasedService
+      class DefinitionService < RoleService
         # Create and return a new DefinitionService instance.
         #
         def initialize(armrest_configuration, options = {})
           super(armrest_configuration, 'roleDefinitions', 'Microsoft.Authorization', options)
         end
-      end # DefinitionService
-    end # Role
-  end # Armrest
-end # Azure
+      end
+    end
+  end
+end

data/lib/azure/armrest/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: azure-armrest
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-22 00:00:00.000000000 Z
+date: 2017-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -224,6 +224,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_local.yml"
 - ".travis.yml"
 - CHANGES
 - Gemfile
@@ -261,6 +263,7 @@ files:
 - lib/azure/armrest/resource_group_service.rb
 - lib/azure/armrest/resource_provider_service.rb
 - lib/azure/armrest/resource_service.rb
+- lib/azure/armrest/role.rb
 - lib/azure/armrest/role/assignment_service.rb
 - lib/azure/armrest/role/definition_service.rb
 - lib/azure/armrest/sql/sql_database_service.rb