azure-armrest 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46e8ae9e1b26fc145c1e030083f6a37ec0873e68
-  data.tar.gz: 23c5fbe41693e3e7d9ba42d91c3fa9da85692e0d
+  metadata.gz: 8323690e6c42f0a6ce2ed910bf933d6f8eb6bc9a
+  data.tar.gz: e8603030d496cb30d6e99e813c4cd32d05e118e6
 SHA512:
-  metadata.gz: c4211477e10c08afe35c587f1f7d6d95505f58ac1f3bcb56b44582459f75cecd2dae7456bb5e78ceca2e2beaa1f21617f4ae530049faa909a50ff7b29d7e2f82
-  data.tar.gz: c2550408054f12e2ecf56204f5413892d2de5c1501b69ce819cc8c28930cc72b27508f9e617f48ec68f039ddfcc91fa0b14d5a659940b6e411c9e73143461162
+  metadata.gz: 90aee7872a99f54b922e8252517e603208f5df62b53c0707687872df69beda6f01867b5ff8d06ad80285ed14eaebb75a3b6ffbe9f1fc2ef6da27565a00e6a35a
+  data.tar.gz: 7c280d3c7c302b21ebf4a2975aa613ce0e65b4c7d2417cad77f04e01283e8badc89dbab5649322aa6b8b59dfefff0c6baf97a45e8400158601d41895589059ff

data/CHANGES

@@ -1,3 +1,14 @@
+= 0.2.4 - 4-Apr-2016
+* The ArmrestCollection#skip_token method was renamed to "continuation_token".
+* Added the ArmrestService.log and ArmrestService.log= methods. These are just
+  thin wrappers around RestClient.log and RestClient.log= methods.
+* Fixed the StorageAccount#table_data method, and added support for
+  continuation tokens.
+* Fixed a bug in the BaseModel's method generation code where an all-caps
+  key would create strange results. 
+* Dealt with a bug in the StorageAccountService#create method caused by
+  a potentially empty response.
+
 = 0.2.3 - 29-Mar-2016
 * Fixed the VirtualMachineImageService class.
 * Added an Insights::MetricsService class and support models.

data/lib/azure/armrest/armrest_collection.rb

@@ -3,7 +3,7 @@
 module Azure
   module Armrest
     class ArmrestCollection < Array
-      attr_accessor :skip_token
+      attr_accessor :continuation_token
     end
   end
 end

data/lib/azure/armrest/armrest_service.rb

@@ -113,21 +113,24 @@ module Azure
       #   - ssl_verify
       #   - ssl_version
       #
-      # Of these, you should include a client_id, client_key and tenant_id.
+      # Of these, you should include a :client_id, :client_key and :tenant_id.
       # The resource_group can be specified here, but many methods allow you
       # to specify a resource group if you prefer flexibility.
       #
-      # If no subscription_id is provided then this method will attempt to find
+      # If no :subscription_id is provided then this method will attempt to find
       # a list of associated subscriptions and use the first one it finds as
       # the default. If no associated subscriptions are found, an ArgumentError
       # is raised.
       #
-      # The other options (grant_type, content_type, accept, token,
-      # token_expirationand api_version) should generally NOT be set by you
-      # except in specific circumstances.  Setting them explicitly will likely
-      # cause breakage. Token and token_expiration must be set in pair.
-      # Token_expiration is of local system time.
-      # The api_version will typically be overridden on a per-provider/resource
+      # The other options (:grant_type, :content_type, :accept, :token,
+      # :token_expiration and :api_version) should generally NOT be set by you
+      # except in specific circumstances. Setting them explicitly will likely
+      # cause breakage.
+      #
+      # The :token and :token_expiration options must be set in pair. The
+      # :token_expiration should be set in local system time.
+      #
+      # The :api_version will typically be overridden on a per-provider/resource
       # basis within subclasses anyway.
       #
       # You may need to associate your application with a subscription using
@@ -339,6 +342,19 @@ module Azure
         JSON.parse(resp.body)['value'].map{ |hash| Azure::Armrest::Tenant.new(hash) }
       end
 
+      # The name of the file or handle used to log requests.
+      #
+      def self.log
+        file = RestClient.log.instance_variable_get("@target_file")
+        file || RestClient.log
+      end
+
+      # Sets the log to +output+, which can be a file or a handle.
+      #
+      def self.log=(output)
+        RestClient.log = output
+      end
+
       def self.rest_execute(options, http_method = :get)
         RestClient::Request.execute(options.merge(:method => http_method))
       rescue RestClient::Exception => e

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

@@ -59,11 +59,11 @@ module Azure
             end
           )
 
-          events.skip_token = parse_skip_token(json_response)
+          events.continuation_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
+          if options[:all] && events.continuation_token
+            events.push(*list(options.merge(:skip_token => events.continuation_token)))
+            events.continuation_token = nil # Clear when finished
           end
 
           events

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

@@ -1,3 +1,5 @@
+require 'active_support/core_ext/string/inflections'
+
 module Azure
   module Armrest
     # Base class for JSON wrapper classes. Each Service class should have
@@ -114,7 +116,7 @@ module Azure
         __getobj__[key] = val
 
         return if key_exists
-        add_accessor_methods(snake_case(key), key)
+        add_accessor_methods(key.to_s.underscore, key)
       end
 
       protected
@@ -130,7 +132,8 @@ module Azure
         @hashobj = obj
         excl_list = self.class.send(:excl_list)
         obj.each do |key, value|
-          snake = snake_case(key)
+          snake = key.to_s.underscore
+
           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 }
@@ -153,14 +156,10 @@ module Azure
       end
 
       def add_accessor_methods(method, key)
-        method.prepend('_') if methods.include?(method.to_sym)
+        method = "_#{method}" if methods.include?(method.to_sym)
         instance_eval { define_singleton_method(method) { __getobj__[key] } }
         instance_eval { define_singleton_method("#{method}=") { |val| __getobj__[key] = val } }
       end
-
-      def snake_case(name)
-        name.to_s.gsub(/(.)([A-Z])/, '\1_\2').downcase
-      end
     end
 
     # Initial class definitions. Reopen these classes as needed.

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

@@ -64,27 +64,55 @@ module Azure
       # account +key+. The exact nature of the TableData object depends on the
       # type of table that it is.
       #
+      # You may specify :filter, :select or :top as options to restrict your
+      # result set.
+      #
+      # By default you will receive a maximum of 1000 records. If you wish to
+      # receive more records, you will need to use the continuation token. You
+      # may also set the :all option to true if you want all records, though we
+      # recommend using a filter as well if you use that option as there can
+      # be thousands of results.
+      #
+      # You may also specify a :NextRowKey, :NextPartitionKey or :NextTableset
+      # explicitly for paging. Normally you would just pass the
+      # collection's continuation_token, however. See below for an example.
+      #
+      # When using continuation tokens, you should retain your original
+      # filtering as well, or you may get unexpected results.
+      #
+      # Examples:
+      #
+      #   # Get the first 10 rows of data from the last 3 days
+      #   date = (Time.now - (86400 * 3)).iso8601
+      #   my_filter = "timestamp ge datetime'#{date}'"
+      #   options = {:top => 10, :filter => my_filter}
+      #
+      #   results = storage_account.table_data(table, key, options)
+      #
+      #   # Now get the next 10 records
+      #   if results.continuation_token
+      #     options[:continuation_token] = results.continuation_token
+      #     more_results = storage_account.table_data(table, key, options)
+      #   end
+      #
       def table_data(name, key = nil, options = {})
         key ||= properties.key1
 
-        query = ""
+        query = build_query(options)
 
-        hash = {
-          "$filter=" => options[:filter],
-          "$select=" => options[:select],
-          "$top="    => options[:top]
-        }
+        response = table_response(key, query, name)
+        json_response = JSON.parse(response.body)
 
-        hash.each do |key, value|
-          if query.include?("$")
-            query << "&#{key}#{value}" if value
-          else
-            query << "#{key}#{value}" if value
-          end
+        data = ArmrestCollection.new(json_response['value'].map { |t| TableData.new(t) })
+        data.continuation_token = parse_continuation_tokens(response)
+
+        if options[:all] && data.continuation_token
+          options[:continuation_token] = data.continuation_token
+          data.push(*table_data(name, key, options))
+          data.continuation_token = nil # Clear when finished
         end
 
-        response = table_response(key, query, name)
-        JSON.parse(response.body)['value'].map{ |t| TableData.new(t) }
+        data
       end
 
       # Return a list of container names for the given storage account +key+.
@@ -415,6 +443,42 @@ module Azure
 
       private
 
+      # Build a query string from a hash of options.
+      #
+      def build_query(options)
+        array = []
+
+        options.each do |key, value|
+          next if key == :all
+          if [:filter, :select, :top].include?(key)
+            array << "$#{key}=#{value}" if value
+          elsif key == :continuation_token
+            value.each { |k, token| array << "#{k}=#{token}" if token }
+          else
+            array << "#{key}=#{value}" if value
+          end
+        end
+
+        array.join('&')
+      end
+
+      # Get the continuation tokens from the response headers for paging results.
+      #
+      def parse_continuation_tokens(response)
+        headers = response.headers
+
+        token = {
+          :NextPartitionKey => headers[:x_ms_continuation_nextpartitionkey],
+          :NextRowKey       => headers[:x_ms_continuation_nextrowkey],
+          :NextTableName    => headers[:x_ms_continuation_nexttablename]
+        }
+
+        # If there are no continuation values at all, then return nil
+        token = nil if token.all? { |_key, value| value.nil? }
+
+        token
+      end
+
       # Using the blob primary endpoint as a base, join any arguments to the
       # the url and submit an http request.
       #
@@ -439,7 +503,10 @@ module Azure
         headers = build_headers(url, key, 'table')
         headers['Accept'] = 'application/json;odata=fullmetadata'
 
-        url << "?#{query}" if query # Must happen after headers are built
+        # Must happen after headers are built
+        unless query.nil? || query.empty?
+          url << "?#{query}"
+        end
 
         ArmrestService.rest_get(
           :url         => url,

data/lib/azure/armrest/storage_account_service.rb

@@ -79,8 +79,8 @@ module Azure
       #   sas = Azure::Armrest::StorageAccountService(config)
       #
       #   sas.create(
-      #     "yourstorageaccount1",
-      #     "yourresourcegroup",
+      #     "your_storage_account",
+      #     "your_resource_group",
       #     {
       #       :location   => "West US",
       #       :properties => {:accountType => "Standard_ZRS"},
@@ -88,14 +88,24 @@ module Azure
       #     }
       #   )
       #
-      def create(account_name, rgroup = configuration.resource_group, options = {})
+      def create(account_name, rgroup = configuration.resource_group, options)
         validating = options.delete(:validating)
         validate_account_type(options[:properties][:accountType])
         validate_account_name(account_name)
 
-        super(account_name, rgroup, options) do |url|
+        acct = super(account_name, rgroup, options) do |url|
           url << "&validating=" << validating if validating
-        end.tap { |m| m.proxy = configuration.proxy }
+        end
+
+        # An initial create call will return nil because the response body is
+        # empty. In that case, make another call to get the object properties.
+        acct = get(account_name, rgroup) unless acct
+
+        acct.proxy       = configuration.proxy
+        acct.ssl_version = configuration.ssl_version
+        acct.ssl_verify  = configuration.ssl_verify
+
+        acct
       end
 
       # Returns the primary and secondary access keys for the given

data/lib/azure/armrest/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: azure-armrest
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-29 00:00:00.000000000 Z
+date: 2016-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json