azure-armrest 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66ad3b28db9c9e766b9478976f5ce8cee9fbd7ca
-  data.tar.gz: 93138a489336f2fce48586f747070bfde8ffad1a
+  metadata.gz: 46e8ae9e1b26fc145c1e030083f6a37ec0873e68
+  data.tar.gz: 23c5fbe41693e3e7d9ba42d91c3fa9da85692e0d
 SHA512:
-  metadata.gz: 0846c292bcc14278a94d945bd722f09ba77ae985b166ef8934508184cbcca94740136cb7d506694a6588b9e7d3608d5074b415dd9840b6f299fb77e4e5855d83
-  data.tar.gz: 662536278f9302dfad6d2649e56e50fab0383f440df210eadaffd7c0005f0ee7bfd2050b11320fccf14d7825ce17e0938ab3540ae67874d997916aa956f3a0ee
+  metadata.gz: c4211477e10c08afe35c587f1f7d6d95505f58ac1f3bcb56b44582459f75cecd2dae7456bb5e78ceca2e2beaa1f21617f4ae530049faa909a50ff7b29d7e2f82
+  data.tar.gz: c2550408054f12e2ecf56204f5413892d2de5c1501b69ce819cc8c28930cc72b27508f9e617f48ec68f039ddfcc91fa0b14d5a659940b6e411c9e73143461162

data/CHANGES

@@ -1,3 +1,13 @@
+= 0.2.3 - 29-Mar-2016
+* Fixed the VirtualMachineImageService class.
+* Added an Insights::MetricsService class and support models.
+* Added a singleton method to clear some internal class variable caches that
+  we use. This is primarily meant for testing.
+* Added a customs collection class that will eventually be used for better
+  handling of skip tokens (paging).
+* Updated the Insights::Event class, modifying the list method's prototype,
+  and now it returns our custom collection class.
+
 = 0.2.2 - 16-Mar-2016
 * Fixed a potential name collision issue for nested objects.
 

data/lib/azure/armrest/armrest_collection.rb

@@ -0,0 +1,9 @@
+# Custom array class we use in order to track extra attributes
+# on a collection of results.
+module Azure
+  module Armrest
+    class ArmrestCollection < Array
+      attr_accessor :skip_token
+    end
+  end
+end

data/lib/azure/armrest/armrest_service.rb

@@ -84,11 +84,14 @@ module Azure
       # The SSL version used for each request. The default is TLSv1.
       attr_accessor :ssl_version
 
-      @@providers_hash = {} # Set in constructor
-
-      @@tokens = {} # token caches
+      # Clear class level caches.
+      def self.clear_caches
+        @@providers_hash = {} # Set in constructor
+        @@tokens         = {} # token caches
+        @@subscriptions  = {} # subscription caches
+      end
 
-      @@subscriptions = {} # subscription caches
+      clear_caches
 
       # Create a configuration object based on input options.
       # This object can be used to create service objects.
@@ -498,6 +501,12 @@ module Azure
             configuration.api_version
           end
       end
+
+      # Parse the skip token value out of the nextLink attribute from a response.
+      def parse_skip_token(json)
+        return nil unless json['nextLink']
+        json['nextLink'][/.*?skipToken=(.*?)$/i, 1]
+      end
     end # ArmrestService
   end # Armrest
 end # Azure

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

@@ -14,6 +14,7 @@ module Azure
         end
 
         # Returns a list of management events for the current subscription.
+        #
         # The +filter+ option can be used to filter the result set. Additionally,
         # you may restrict the results to only return certain fields using
         # the +select+ option. The possible fields for both filtering and selection
@@ -24,6 +25,17 @@ module Azure
         # operationName, properties, resourceGroupName, resourceProviderName,
         # resourceUri, status, submissionTimestamp, subStatus and subscriptionId.
         #
+        # The +skip_token+ option can be used to grab the next batch of events
+        # when the first call reaches the maximum number of events that the API
+        # can return in one batch (API default 200). You may also set the :all
+        # option to true, in which case all batches will automatically be
+        # collected for you.
+        #
+        # In practice you should always set a filter for eventTimestamp because
+        # you are restricted to 90 days worth of events. If you do not set the
+        # filter and/or you try to retrieve more than 90 days worth of events
+        # then you will get an error. This is a limitation of the Azure API.
+        #
         # Example:
         #
         #   ies = Azure::Armrest::Insights::EventService.new(conf)
@@ -32,19 +44,34 @@ module Azure
         #   filter = "eventTimestamp ge #{date} and eventChannels eq 'Admin, Operation'"
         #   select = "resourceGroupName, operationName"
         #
-        #   ies.list(filter, select).each{ |event|
+        #   ies.list(:filter => filter, :select => select, :all => true).events.each{ |event|
         #     p event
         #   }
         #
-        def list(filter = nil, select = nil)
-          url = build_url(filter, select)
+        def list(options = {})
+          url = build_url(options)
           response = rest_get(url)
-          JSON.parse(response.body)['value'].map{ |e| Azure::Armrest::Insights::Event.new(e) }
+          json_response = JSON.parse(response.body)
+
+          events = ArmrestCollection.new(
+            json_response['value'].map do |hash|
+              Azure::Armrest::Insights::Event.new(hash)
+            end
+          )
+
+          events.skip_token = parse_skip_token(json_response)
+
+          if options[:all] && events.skip_token
+            events.push(*list(options.merge(:skip_token => events.skip_token)))
+            events.skip_token = nil # Clear when finished
+          end
+
+          events
         end
 
         private
 
-        def build_url(filter = nil, select = nil)
+        def build_url(options = {})
           sub_id = armrest_configuration.subscription_id
 
           url =
@@ -59,8 +86,9 @@ module Azure
             )
 
           url << "?api-version=#{@api_version}"
-          url << "&$filter=#{filter}" if filter
-          url << "&$select=#{select}" if select
+          url << "&$filter=#{options[:filter]}" if options[:filter]
+          url << "&$select=#{options[:select]}" if options[:select]
+          url << "&$skipToken=#{options[:skip_token]}" if options[:skip_token]
 
           url
         end

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

@@ -0,0 +1,59 @@
+module Azure
+  module Armrest
+    module Insights
+      class MetricsService < ArmrestService
+        # 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)
+        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.
+        #
+        # Example:
+        #
+        #   metrics = Azure::Armrest::Insights::MetricsService.new(conf)
+        #
+        #   metrics.list('Microsoft.SQL', 'servers', 'myServer/databases/myDB', 'mygroup')
+        #   metrics.list('Microsoft.Compute', 'virtualMachines', 'myVm', 'mygroup')
+        #
+        def list(provider, resource_type, resource_name, resource_group = nil, options = {})
+          resource_group ||= configuration.resource_group
+
+          raise ArgumentError, "no resource group provided" unless resource_group
+
+          url = build_url(provider, resource_type, resource_name, resource_group, options)
+
+          response = rest_get(url)
+
+          JSON.parse(response)['value'].map { |hash| Azure::Armrest::Insights::Metric.new(hash) }
+        end
+
+        private
+
+        def build_url(provider, resource_type, resource_name, resource_group, options)
+          sub_id = configuration.subscription_id
+
+          url = File.join(
+            Azure::Armrest::COMMON_URI,
+            sub_id,
+            'resourceGroups',
+            resource_group,
+            'providers',
+            provider,
+            resource_type,
+            resource_name,
+            'metricDefinitions'
+          )
+
+          url << "?api-version=#{@api_version}"
+          url << "&$filter=#{options[:filter]}" if options[:filter]
+
+          url
+        end
+      end # MetricsService
+    end # Insights
+  end # Armrest
+end # Azure

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

@@ -167,9 +167,13 @@ module Azure
 
     class AvailabilitySet < BaseModel; end
     class Event < BaseModel; end
+    class ImageVersion < BaseModel; end
+    class Offer < BaseModel; end
+    class Publisher < BaseModel; end
     class Resource < BaseModel; end
     class ResourceGroup < BaseModel; end
     class ResourceProvider < BaseModel; end
+    class Sku < BaseModel; end
     class StorageAccount < BaseModel; end
     class Subscription < BaseModel; end
     class Tag < BaseModel; end
@@ -188,6 +192,7 @@ module Azure
     module Insights
       class Alert < BaseModel; end
       class Event < BaseModel; end
+      class Metric < BaseModel; end
     end
 
     module Network

data/lib/azure/armrest/version.rb

@@ -1,5 +1,5 @@
 module Azure
   module Armrest
-    VERSION = '0.2.2'
+    VERSION = '0.2.3'
   end
 end

data/lib/azure/armrest/virtual_machine_image_service.rb

@@ -10,26 +10,23 @@ module Azure
       # The publisher used in requests when gathering VM image information.
       attr_accessor :publisher
 
-      # Create and return a new VirtualMachineImageService (VMIM) instance.
+      # Create and return a new VirtualMachineImageService instance.
       #
       # This subclass accepts the additional :location, :provider, and
-      # :publisher options as well. The default provider is set to
-      # 'Microsoft.Compute'.
+      # :publisher options as well.
       #
       def initialize(configuration, options = {})
-        super(configuration, nil, 'Microsoft.Compute', options)
+        super(configuration, 'locations/publishers', 'Microsoft.Compute', options)
 
         @location  = options[:location]
         @publisher = options[:publisher]
-
-        set_service_api_version(options, 'locations/publishers')
       end
 
       # Return a list of VM image offers from the given +publisher+ and +location+.
       #
       # Example:
       #
-      #   vmim.offers('eastus', 'Canonical')
+      #   vmis.offers('eastus', 'Canonical')
       #
       def offers(location = @location, publisher = @publisher)
         raise ArgumentError, "No location specified" unless location
@@ -37,21 +34,21 @@ module Azure
 
         url = build_url(location, 'publishers', publisher, 'artifacttypes', 'vmimage', 'offers')
 
-        JSON.parse(rest_get(url)).map{ |element| element['name'] }
+        JSON.parse(rest_get(url)).map { |hash| Azure::Armrest::Offer.new(hash) }
       end
 
       # Return a list of VM image publishers for the given +location+.
       #
       # Example:
       #
-      #   vmim.publishers('eastus')
+      #   vmis.publishers('eastus')
       #
       def publishers(location = @location)
         raise ArgumentError, "No location specified" unless location
 
         url = build_url(location, 'publishers')
 
-        JSON.parse(rest_get(url)).map{ |element| element['name'] }
+        JSON.parse(rest_get(url)).map { |hash| Azure::Armrest::Publisher.new(hash) }
       end
 
       # Return a list of VM image skus for the given +offer+, +location+,
@@ -59,7 +56,7 @@ module Azure
       #
       # Example:
       #
-      #   vmim.skus('UbuntuServer', 'eastus', 'Canonical')
+      #   vmis.skus('UbuntuServer', 'eastus', 'Canonical')
       #
       def skus(offer, location = @location, publisher = @publisher)
         raise ArgumentError, "No location specified" unless location
@@ -70,7 +67,7 @@ module Azure
           'vmimage', 'offers', offer, 'skus'
         )
 
-        JSON.parse(rest_get(url)).map{ |element| element['name'] }
+        JSON.parse(rest_get(url)).map { |hash| Azure::Armrest::Sku.new(hash) }
       end
 
       # Return a list of VM image versions for the given +sku+, +offer+,
@@ -78,21 +75,21 @@ module Azure
       #
       # Example:
       #
-      #   vmim.versions('14.04.2', 'UbuntuServer', 'eastus', 'Canonical')
+      #   vmis.versions('15.10', 'UbuntuServer', 'eastus', 'Canonical').map(&:name)
       #
       #   # sample output
-      #   => ["14.04.201503090", "14.04.201505060", "14.04.201506100", "14.04.201507060"]
+      #   => ["15.10.201511111", "15.10.201511161", "15.10.201512030"]
       #
       def versions(sku, offer, location = @location, publisher = @publisher)
         raise ArgumentError, "No location specified" unless location
         raise ArgumentError, "No publisher specified" unless publisher
 
         url = build_url(
-          location, 'publishers', publisher, 'artifacttypes', 'vmimage',
-          'offers', offer, 'skus', sku, 'versions'
+          location, 'publishers', publisher, 'artifacttypes',
+          'vmimage', 'offers', offer, 'skus', sku, 'versions'
         )
 
-        JSON.parse(rest_get(url)).map{ |element| element['name'] }
+        JSON.parse(rest_get(url)).map { |hash| Azure::Armrest::ImageVersion.new(hash) }
       end
 
       private
@@ -113,7 +110,6 @@ module Azure
         url = File.join(url, *args) unless args.empty?
         url << "?api-version=#{@api_version}"
       end
-
     end # VirtualMachineImageService
   end # Armrest
 end # Azure

data/lib/azure/armrest.rb

@@ -22,6 +22,7 @@ end
 
 require 'azure/armrest/version'
 require 'azure/armrest/exception'
+require 'azure/armrest/armrest_collection'
 require 'azure/armrest/armrest_service'
 require 'azure/armrest/resource_group_based_service'
 require 'azure/armrest/resource_group_based_subservice'
@@ -36,6 +37,7 @@ require 'azure/armrest/resource_group_service'
 require 'azure/armrest/resource_provider_service'
 require 'azure/armrest/insights/alert_service'
 require 'azure/armrest/insights/event_service'
+require 'azure/armrest/insights/metrics_service'
 require 'azure/armrest/network/ip_address_service'
 require 'azure/armrest/network/network_interface_service'
 require 'azure/armrest/network/network_security_group_service'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: azure-armrest
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-16 00:00:00.000000000 Z
+date: 2016-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -191,11 +191,13 @@ files:
 - azure-armrest.gemspec
 - lib/azure-armrest.rb
 - lib/azure/armrest.rb
+- lib/azure/armrest/armrest_collection.rb
 - lib/azure/armrest/armrest_service.rb
 - lib/azure/armrest/availability_set_service.rb
 - lib/azure/armrest/exception.rb
 - lib/azure/armrest/insights/alert_service.rb
 - lib/azure/armrest/insights/event_service.rb
+- lib/azure/armrest/insights/metrics_service.rb
 - lib/azure/armrest/model/base_model.rb
 - lib/azure/armrest/model/storage_account.rb
 - lib/azure/armrest/network/ip_address_service.rb