azure-armrest 0.8.4 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9addd4499d546f9fb5eb12b5e454046709164836
-  data.tar.gz: 3ccf69833fe525244581ed5e68b4e73503044bfd
+  metadata.gz: 271d67cb70166d8d00b30c234d1ecb6f26cfaaf5
+  data.tar.gz: adfdb6724dd8ca45b8314ba48537ff2ad229f469
 SHA512:
-  metadata.gz: 63a3a2109b5d66e4de0f381d03d283bfdeef576c35bdf5b367c1fb473a67ea1bd36a21e97ee1d195222c1d3eab0812038dc48797cebb800fc8163d20f137d632
-  data.tar.gz: 2e304ffabb9f08ca194fc5baed83a567acf007e2de0f2543e09a7886367b8e10b59abfe14519810d2c85def97675bb1fa55c4b022b15f6d252f7d59a684c8dc2
+  metadata.gz: ae90f2ed141868131b93df713ddae8e54b559ffd503da223fc3d6a9daad01cb3bf1b14d0c87e6ffc54156933407b93268d964dadf65b5a22cadfa1831a755ced
+  data.tar.gz: 4a0da229be85bd145421d215cfa064e7cebf745fe754b058f9d2a54fc2c0140ffff3492854877168e6b815b304dad0aa72c8588582e6dd990e98f7775e1981ff

data/.rubocop_local.yml

@@ -0,0 +1,3 @@
+Style/MethodCallWithArgsParentheses:
+  IgnoredMethods:
+    - attr_from_hash

data/CHANGES

@@ -1,3 +1,6 @@
+= 0.8.5 - 10-Oct-2017
+* Backported the light model changes from 0.9.0.
+
 = 0.8.4 - 2-Oct-2017
 * Logging bug fix in StorageAccount#all_blobs method.
 * Modified the StorageAccountService#list_all_private_image method. It now

data/lib/azure/armrest/armrest_collection.rb

@@ -16,9 +16,9 @@ module Azure
         # using +klass+ to generate the list elements. In addition, both the
         # response headers and continuation token are set.
         #
-        def create_from_response(response, klass = nil)
+        def create_from_response(response, klass = nil, skip_accessors_definition = false)
           json_response = JSON.parse(response)
-          array = new(json_response['value'].map { |hash| klass.new(hash) })
+          array = new(json_response['value'].map { |hash| klass.new(hash, skip_accessors_definition) })
 
           array.response_code = response.code
           array.response_headers = response.headers

data/lib/azure/armrest/armrest_service.rb

@@ -357,13 +357,13 @@ module Azure
       end
 
       # Make additional calls and concatenate the results if a continuation URL is found.
-      def get_all_results(response)
-        results  = Azure::Armrest::ArmrestCollection.create_from_response(response, model_class)
+      def get_all_results(response, skip_accessors_definition = false)
+        results  = Azure::Armrest::ArmrestCollection.create_from_response(response, model_class, skip_accessors_definition)
         nextlink = results.next_link
 
         while nextlink
           response = rest_get_without_encoding(nextlink)
-          more = Azure::Armrest::ArmrestCollection.create_from_response(response, model_class)
+          more = Azure::Armrest::ArmrestCollection.create_from_response(response, model_class, skip_accessors_definition)
           results.concat(more)
           nextlink = more.next_link
         end

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

@@ -23,6 +23,58 @@ module Azure
 
       attr_hash :tags
 
+      # Defines attr_reader methods for the given set of attributes and
+      # expected hash key.  Used to define methods that can be used internally
+      # that avoid needing to use methods defined from
+      # `add_accessor_methods`/`__setobj__`
+      #
+      # Example:
+      #   class Vm < Azure::ArmRest::BaseModel
+      #     attr_from_hash :name => :Name
+      #   end
+      #
+      #   json_string = {'name' => 'Deathstar'}
+      #
+      #   vm = Vm.new(json_string)
+      #   vm.name_from_hash
+      #   #=> "Deathstar"
+      #
+      #   # If the attr_from_hash can also support multiple attrs in a single
+      #   # call, and nested params
+      #
+      #   class Host < Azure::ArmRest::BaseModel
+      #     attr_from_hash :name => :Name,
+      #                    :address => [:Properties, :ipAddress],
+      #   end
+      #
+      #   json_string = {'name' => 'Hoth', :Properties => {:ipAddress => '123.123.123.123'}}
+      #
+      #   host = Host.new(json_string)
+      #   host.name_from_hash
+      #   #=> "Hoth"
+      #   host.address_from_hash
+      #   #=> "123.123.123.123"
+      #
+      def self.attr_from_hash(attrs = {})
+        file, line, _ = caller.first.split(":")
+        attrs.each do |attr_name, keys|
+          keys      = Array(keys)
+          first_key = keys.shift
+          method_def = [
+            "def #{attr_name}_from_hash",
+            "  return @#{attr_name}_from_hash if defined?(@#{attr_name}_from_hash)",
+            "  @#{attr_name}_from_hash = __getobj__[:#{first_key}] || __getobj__[\"#{first_key}\"]",
+            "end"
+          ]
+          keys.each do |hash_key|
+            method_def.insert(-2, "  @#{attr_name}_from_hash = @#{attr_name}_from_hash[:#{hash_key}] || @#{attr_name}_from_hash[\"#{hash_key}\"]")
+          end
+          class_eval(method_def.join("; "), file, line.to_i)
+        end
+      end
+
+      private_class_method :attr_from_hash
+
       attr_accessor :response_headers
       attr_accessor :response_code
 
@@ -48,7 +100,7 @@ module Azure
       #   # Or you can get back the original JSON if necessary.
       #   person.to_json # => Returns original JSON
       #
-      def initialize(json)
+      def initialize(json, skip_accessors_definition = false)
         # Find the exclusion list for the model of next level (@embed_model)
         # '#' is the separator between levels. Remove attributes
         # before the first separator.
@@ -63,15 +115,24 @@ module Azure
           @json = json
         end
 
-        __setobj__(@hash.dup)
+        @hashobj = @hash.dup
+        __setobj__ unless skip_accessors_definition
       end
 
       def resource_group
-        @resource_group ||= id[/resourcegroups\/(.*?[^\/]+)?/i, 1] rescue nil
+        @resource_group ||= begin
+                              id_from_hash[/resourcegroups\/(.*?[^\/]+)?/i, 1]
+                            rescue
+                              nil
+                            end
       end
 
       def subscription_id
-        @subscription_id ||= id[/subscriptions\/(.*?[^\/]+)?/i, 1] rescue nil
+        @subscription_id ||= begin
+                               id_from_hash[/subscriptions\/(.*?[^\/]+)?/i, 1]
+                             rescue
+                               nil
+                             end
       end
 
       attr_writer :resource_group
@@ -148,21 +209,29 @@ module Azure
         @hashobj
       end
 
+      # Do not use this method directly.
+      #
+      # Will only attempt to fetch the id from the @hashobj once, so even it it
+      # is nil, it will cache that value, and return that on subsequent calls.
+      def id_from_hash
+        return @id_from_hash if defined?(@id_from_hash)
+        @id_from_hash = __getobj__[:id] || __getobj__["id"]
+      end
+
       # Create snake_case accessor methods for all hash attributes
       # Use _alias if an accessor conflicts with existing methods
-      def __setobj__(obj)
-        @hashobj = obj
+      def __setobj__
         excl_list = self.class.send(:excl_list)
-        obj.each do |key, value|
+        @hashobj.each do |key, value|
           snake = key.to_s.tr(' ', '_').underscore
           snake.tr!('.', '_')
 
           unless excl_list.include?(snake) # Must deal with nested models
             if value.kind_of?(Array)
               newval = value.map { |elem| elem.kind_of?(Hash) ? nested_object(snake.camelize.singularize, elem) : elem }
-              obj[key] = newval
+              @hashobj[key] = newval
             elsif value.kind_of?(Hash)
-              obj[key] = nested_object(snake.camelize, value)
+              @hashobj[key] = nested_object(snake.camelize, value)
             end
           end
 
@@ -212,8 +281,11 @@ module Azure
 
     class StorageAccount < BaseModel; end
     class StorageAccountKey < StorageAccount
-      def key1; key_name == 'key1' ? value : nil; end
-      def key2; key_name == 'key2' ? value : nil; end
+      attr_from_hash :key_name => :keyName,
+                     :value    => :value
+
+      def key1; key_name_from_hash == 'key1' ? value_from_hash : nil; end
+      def key2; key_name_from_hash == 'key2' ? value_from_hash : nil; end
       def key; key1 || key2; end
     end
 

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

@@ -5,10 +5,18 @@ require 'nokogiri'
 module Azure
   module Armrest
     class StorageAccount < BaseModel
+      attr_from_hash :name          => :name,
+                     :blob_endpoint => [:properties, :primaryEndpoints, :blob]
+
       # Classes used to wrap container and blob information.
-      class Container < BaseModel; end
+      class Container < BaseModel
+        attr_from_hash :name => :Name
+      end
       class ContainerProperty < BaseModel; end
-      class Blob < BaseModel; end
+      class Blob < BaseModel
+        attr_from_hash :name        => :Name,
+                       :lease_state => [:Properties, :LeaseState]
+      end
       class BlobProperty < BaseModel; end
       class PrivateImage < BlobProperty; end
       class BlobServiceProperty < BaseModel; end
@@ -34,7 +42,7 @@ module Azure
       # The parent configuration object
       attr_accessor :configuration
 
-      def initialize(json)
+      def initialize(json, skip_accessors_definition = false)
         super
         @storage_api_version = '2016-05-31'
       end
@@ -424,14 +432,20 @@ module Azure
         raise ArgumentError, "No access key specified" unless key
 
         query = "comp=list"
-        options.each { |okey, ovalue| query += "&#{okey}=#{[ovalue].flatten.join(',')}" }
+        skip_defs = options[:skip_accessors_definition]
+
+        options.each do |okey, ovalue|
+          unless okey == :skip_accessors_definition
+            query += "&#{okey}=#{[ovalue].flatten.join(',')}"
+          end
+        end
 
         response = blob_response(key, query)
 
         doc = Nokogiri::XML(response.body)
 
         results = doc.xpath('//Containers/Container').collect do |element|
-          Container.new(Hash.from_xml(element.to_s)['Container'])
+          Container.new(Hash.from_xml(element.to_s)['Container'], skip_defs)
         end
 
         results.concat(next_marker_results(doc, :containers, key, options))
@@ -468,7 +482,7 @@ module Azure
       def blob_properties(container, blob, key = access_key, options = {})
         raise ArgumentError, "No access key specified" unless key
 
-        url = File.join(properties.primary_endpoints.blob, container, blob)
+        url = File.join(blob_endpoint_from_hash, container, blob)
         url += "?snapshot=" + options[:date] if options[:date]
 
         headers = build_headers(url, key, :blob, :verb => 'HEAD')
@@ -482,7 +496,7 @@ module Azure
           :ssl_verify  => configuration.ssl_verify
         )
 
-        BlobProperty.new(response.headers.merge(:container => container, :name => blob))
+        BlobProperty.new(response.headers.merge(:container => container, :name => blob), options[:skip_accessors_definition])
       end
 
       # Update the given +blob+ in +container+ with the provided options. The
@@ -559,7 +573,13 @@ module Azure
         raise ArgumentError, "No access key specified" unless key
 
         query = "restype=container&comp=list"
-        options.each { |okey, ovalue| query += "&#{okey}=#{[ovalue].flatten.join(',')}" }
+        skip_defs = options[:skip_accessors_definition]
+
+        options.each do |okey, ovalue|
+          unless okey == :skip_accessors_definition
+            query += "&#{okey}=#{[ovalue].flatten.join(',')}"
+          end
+        end
 
         response = blob_response(key, query, container)
 
@@ -567,7 +587,7 @@ module Azure
 
         results = doc.xpath('//Blobs/Blob').collect do |node|
           hash = Hash.from_xml(node.to_s)['Blob'].merge(:container => container)
-          hash.key?('Snapshot') ? BlobSnapshot.new(hash) : Blob.new(hash)
+          hash.key?('Snapshot') ? BlobSnapshot.new(hash, skip_defs) : Blob.new(hash, skip_defs)
         end
 
         results.concat(next_marker_results(doc, :blobs, container, key, options))
@@ -582,10 +602,13 @@ module Azure
 
         array = []
         mutex = Mutex.new
+        opts = {
+          :skip_accessors_definition => options[:skip_accessors_definition]
+        }
 
-        Parallel.each(containers(key), :in_threads => max_threads) do |container|
+        Parallel.each(containers(key, opts), :in_threads => max_threads) do |container|
           begin
-            mutex.synchronize { array.concat(blobs(container.name, key, options)) }
+            mutex.synchronize { array.concat(blobs(container.name_from_hash, key, options)) }
           rescue Errno::ECONNREFUSED, Azure::Armrest::TimeoutException => err
             msg = "Unable to gather blob information for #{container.name}: #{err}"
             Azure::Armrest::Configuration.log.try(:log, Logger::WARN, msg)
@@ -938,7 +961,7 @@ module Azure
       # the url and submit an http request.
       #
       def blob_response(key, query, *args)
-        url = File.join(properties.primary_endpoints.blob, *args) + "?#{query}"
+        url = File.join(blob_endpoint_from_hash, *args) + "?#{query}"
         headers = build_headers(url, key, 'blob')
 
         ArmrestService.send(

data/lib/azure/armrest/resource_group_based_service.rb

@@ -97,8 +97,9 @@ module Azure
         url = build_url
         url = yield(url) || url if block_given?
 
+        skip_accessors_definition = filter.delete(:skip_accessors_definition) || false
         response = rest_get(url)
-        results  = get_all_results(response)
+        results  = get_all_results(response, skip_accessors_definition)
 
         if filter.empty?
           results
@@ -106,7 +107,11 @@ module Azure
           results.select do |obj|
             filter.all? do |method_name, value|
               if value.kind_of?(String)
-                obj.public_send(method_name).casecmp(value).zero?
+                if skip_accessors_definition
+                  obj[method_name.to_s].casecmp(value).zero?
+                else
+                  obj.public_send(method_name).casecmp(value).zero?
+                end
               else
                 obj.public_send(method_name) == value
               end

data/lib/azure/armrest/storage_account_service.rb

@@ -104,7 +104,7 @@ module Azure
       #
       # If you want a plain hash, use the list_account_keys method instead.
       #
-      def list_account_key_objects(account_name, group = configuration.resource_group)
+      def list_account_key_objects(account_name, group = configuration.resource_group, skip_accessors_definition = false)
         validate_resource_group(group)
 
         unless recent_api_version?
@@ -113,7 +113,7 @@ module Azure
 
         url = build_url(group, account_name, 'listKeys')
         response = rest_post(url)
-        JSON.parse(response.body)['keys'].map { |hash| StorageAccountKey.new(hash) }
+        JSON.parse(response.body)['keys'].map { |hash| StorageAccountKey.new(hash, skip_accessors_definition) }
       end
 
       alias list_storage_account_key_objects list_account_key_objects
@@ -172,7 +172,7 @@ module Azure
       # Note that for string values the comparison is caseless.
       #
       def list_all_private_images(filter = {})
-        storage_accounts = list_all(filter)
+        storage_accounts = list_all(filter.merge(:skip_accessors_definition => true))
         get_private_images(storage_accounts)
       end
 
@@ -187,7 +187,7 @@ module Azure
       #   sas.list_private_images(your_resource_group)
       #
       def list_private_images(group = configuration.resource_group)
-        storage_accounts = list(group)
+        storage_accounts = list(group, true)
         get_private_images(storage_accounts)
       end
 
@@ -273,30 +273,36 @@ module Azure
 
         Parallel.each(storage_accounts, :in_threads => configuration.max_threads) do |storage_account|
           begin
-            key = get_account_key(storage_account)
+            key = get_account_key(storage_account, true)
           rescue Azure::Armrest::ApiException
             next # Most likely due to incomplete or failed provisioning.
           else
             storage_account.access_key = key
           end
 
-          storage_account.containers.each do |container|
-            next if container.name =~ /^bootdiagnostics/i
-            storage_account.blobs(container.name).each do |blob|
-              next unless File.extname(blob.name).casecmp('.vhd').zero?
-              next unless blob.properties.lease_state.casecmp('available').zero?
+          init_opts = { :skip_accessors_definition => true }
+          storage_account.containers(storage_account.access_key, init_opts).each do |container|
+            next if container.name_from_hash =~ /^bootdiagnostics/i
+            storage_account.blobs(container.name_from_hash, storage_account.access_key, init_opts).each do |blob|
+              next unless File.extname(blob.name_from_hash).casecmp('.vhd').zero?
+              next unless blob.lease_state_from_hash.casecmp('available').zero?
 
               # In rare cases the endpoint will be unreachable. Warn and move on.
               begin
-                blob_properties = storage_account.blob_properties(blob.container, blob.name)
+                blob_properties = storage_account.blob_properties(
+                  blob[:container],
+                  blob.name_from_hash,
+                  storage_account.access_key,
+                  :skip_accessors_definition => true
+                )
               rescue Errno::ECONNREFUSED, Azure::Armrest::TimeoutException => err
                 msg = "Unable to collect blob properties for #{blob.name}/#{blob.container}: #{err}"
                 log('warn', msg)
                 next
               end
 
-              next unless blob_properties.respond_to?(:x_ms_meta_microsoftazurecompute_osstate)
-              next unless blob_properties.x_ms_meta_microsoftazurecompute_osstate.casecmp('generalized').zero?
+              next unless blob_properties[:x_ms_meta_microsoftazurecompute_osstate]
+              next unless blob_properties[:x_ms_meta_microsoftazurecompute_osstate].casecmp('generalized').zero?
 
               mutex.synchronize do
                 results << blob_to_private_image_object(storage_account, blob, blob_properties)
@@ -315,11 +321,11 @@ module Azure
         hash = blob.to_h.merge(
           :storage_account  => storage_account.to_h,
           :blob_properties  => blob_properties.to_h,
-          :operating_system => blob_properties.try(:x_ms_meta_microsoftazurecompute_ostype),
+          :operating_system => blob_properties[:x_ms_meta_microsoftazurecompute_ostype],
           :uri              => File.join(
-            storage_account.properties.primary_endpoints.blob,
-            blob.container,
-            blob.name
+            storage_account.blob_endpoint_from_hash,
+            blob[:container],
+            blob.name_from_hash
           )
         )
 
@@ -329,11 +335,11 @@ module Azure
       # Get the key for the given +storage_acct+ using the appropriate method
       # depending on the api-version.
       #
-      def get_account_key(storage_acct)
+      def get_account_key(storage_acct, skip_accessors_definition = false)
         if recent_api_version?
-          list_account_key_objects(storage_acct.name, storage_acct.resource_group).first.key
+          list_account_key_objects(storage_acct.name_from_hash, storage_acct.resource_group, skip_accessors_definition).first.key
         else
-          list_account_keys(storage_acct.name, storage_acct.resource_group).fetch('key1')
+          list_account_keys(storage_acct.name_from_hash, storage_acct.resource_group).fetch('key1')
         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.8.4'.freeze
+    VERSION = '0.8.5'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: azure-armrest
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.8.5
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-02 00:00:00.000000000 Z
+date: 2017-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -302,7 +302,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: An interface for ARM/JSON Azure REST API