azure-armrest 0.7.5 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5eafec5e5c9b51f1e01cd36f55872192579cf838
-  data.tar.gz: 80dfaca5f2bec22dcdea5567295248e3a12b254f
+  metadata.gz: 8132014956246e577b66ccaf5a59e002e1dc06d3
+  data.tar.gz: f15ad3108839654399c954bb0f4460499de319cd
 SHA512:
-  metadata.gz: 1f4dcb334ccb37db304d216ffeae044944724f1b517e317a1ea3d4393840203af5b665640806e07f8a5564fa723d66a0c4b3eb7bb802d66de1b6a85d2f0cefa8
-  data.tar.gz: d0d956239b40e8ca6e59cecfa47650c1334c3b79dae481bef71d8a0485d9e14ada0cce04dba882ad045ef9acc3ddbbc9e8e10d6f52d3b04bb9f6dd721431592d
+  metadata.gz: 4ca343728c62c77096e320d04ea0bfdeb0e6d9ce3aadbc0ea53935053335d1b20089004591915cf031fa380bd16009f89e7acdea0db4cb08b8098274d7dc3276
+  data.tar.gz: b0185801ee3a2c6cf1079f5f8040ca143402109659b991504b40d2a6e06fa294452163086c00094fdaddca1553738af3278ac0464115f502652894684901c6af

data/CHANGES

@@ -1,3 +1,15 @@
+= 0.8.0 - 20-Jul-2017
+* The StorageAccount#create_blob and StorageAccount#create_blob_snapshot methods
+  were heavily revamped and now return a ResponseHeaders object.
+* Added support for storage file services to the Storage model, so you can
+  now create, delete or query files or directories on storage accounts.
+* Added the list_all instance method to the VirtualMachineImageService class.
+  Thanks go to Tyler Gregory for the patch.
+* Added the ArmestService#list_locations method. This returns an array of
+  Location objects. The ArmrestService#locations method still returns just
+  an array of strings, but is now deprecated.
+* The StorageAccount#all_blobs method now accepts an options argument.
+
 = 0.7.5 - 27-Jun-2017
 * Added the ContainerService service class.
 * Added the StorageAccount#access_key accessor. If set, this is now used as

data/lib/azure/armrest/armrest_service.rb

@@ -77,17 +77,27 @@ module Azure
       # +provider+. If you do not specify a provider, then the locations for
       # all providers will be returned.
       #
-      # If you need individual details on a per-provider basis, use the
-      # provider_info method instead.
-      #--
+      # If you need individual details on a per-provider basis, use the methods
+      # of the ResourceProviderService instead.
+      #
+      # Deprecated.
       #
       def locations(provider = nil)
         list = configuration.providers
         list = list.select { |rp| rp.namespace.casecmp(provider) == 0 } if provider
-
         list.collect { |rp| rp.resource_types.map(&:locations) }.flatten.uniq.sort
       end
 
+      deprecate :locations, :list_locations, 2019, 1
+
+      # Returns a list of Location objects for the current subscription.
+      #
+      def list_locations
+        url = url_with_api_version(configuration.api_version, base_url, 'locations')
+        response = rest_get(url)
+        Azure::Armrest::ArmrestCollection.create_from_response(response, Location)
+      end
+
       # Returns a list of subscriptions for the current tenant.
       def list_subscriptions
         Azure::Armrest::SubscriptionService.new(configuration).list

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

@@ -191,6 +191,7 @@ module Azure
     class Container < BaseModel; end
     class Event < BaseModel; end
     class ImageVersion < BaseModel; end
+    class Location < BaseModel; end
     class Offer < BaseModel; end
     class Publisher < BaseModel; end
     class Resource < BaseModel; end

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

@@ -20,6 +20,10 @@ module Azure
       class Table < BaseModel; end
       class TableData < BaseModel; end
 
+      # Classes used to wrap file shares
+      class ShareDirectory < BaseModel; end
+      class ShareFile < BaseModel; end
+
       # The version string used in headers sent as part any internal http
       # request. The default is 2016-05-31.
       attr_accessor :storage_api_version
@@ -50,7 +54,7 @@ module Azure
       def tables(key = access_key)
         raise ArgumentError, "No access key specified" unless key
         response = table_response(key, nil, "Tables")
-        JSON.parse(response.body)['value'].map{ |t| Table.new(t) }
+        JSON.parse(response.body)['value'].map { |t| Table.new(t) }
       end
 
       # Return information about a single table for the given storage
@@ -119,6 +123,280 @@ module Azure
         data
       end
 
+      ### Files and Directories
+
+      # Create a new directory under the specified +share+ or parent directory.
+      #
+      # The only supported option at this time is a "timeout" option.
+      #
+      def create_directory(share, directory, key = access_key, options = {})
+        raise ArgumentError, "No access key specified" unless key
+
+        query = {:restype => 'directory'}.merge(options).to_query
+
+        response = file_response(key, query, 'put', '', File.join(share, directory))
+
+        Azure::Armrest::ResponseHeaders.new(response.headers).tap do |rh|
+          rh.response_code = response.code
+        end
+      end
+
+      # Delete the specified +share+ or parent directory.
+      #
+      # The only supported option at this time is a "timeout" option.
+      #
+      def delete_directory(share, directory, key = access_key, options = {})
+        raise ArgumentError, "No access key specified" unless key
+
+        query = {:restype => 'directory'}.merge(options).to_query
+
+        response = file_response(key, query, 'delete', '', File.join(share, directory))
+
+        Azure::Armrest::ResponseHeaders.new(response.headers).tap do |rh|
+          rh.response_code = response.code
+        end
+      end
+
+      # Get properties for the specified +share+ or parent directory.
+      #
+      # The only supported option at this time is a "timeout" option.
+      #
+      def directory_properties(share, directory, key = access_key, options = {})
+        raise ArgumentError, "No access key specified" unless key
+
+        query = {:restype => 'directory'}.merge(options).to_query
+
+        response = file_response(key, query, 'get', '', File.join(share, directory))
+
+        ShareDirectory.new(response.headers)
+      end
+
+      # Get metadata for the specified +share+ or parent directory.
+      #
+      # The only supported option at this time is a "timeout" option.
+      #
+      def directory_metadata(share, directory, key = access_key, options = {})
+        raise ArgumentError, "No access key specified" unless key
+
+        query = {:restype => 'directory', :comp => 'metadata'}.merge(options).to_query
+
+        response = file_response(key, query, 'head', '', File.join(share, directory))
+
+        ShareDirectory.new(response.headers)
+      end
+
+      # Returns a list of files for the specified file-share. You may also
+      # optionally specify a +directory+ in "share/directory" format.
+      #
+      # You may specify multiple +options+ to limit the result set. The
+      # possible options are:
+      #
+      # * prefix
+      # * marker
+      # * maxresults
+      # * timeout
+      #
+      def files(share, key = access_key, options = {})
+        raise ArgumentError, "No access key specified" unless key
+
+        query = {:restype => 'directory', :comp => 'list'}.merge(options).to_query
+
+        response = file_response(key, query, 'get', nil, share)
+
+        doc = Nokogiri::XML(response.body)
+        results = []
+
+        doc.xpath('//EnumerationResults/Entries').each do |element|
+          element.xpath('//Directory').each do |dir|
+            results << ShareDirectory.new(Hash.from_xml(dir.to_s)['Directory'])
+          end
+          element.xpath('//File').each do |file|
+            results << ShareFile.new(Hash.from_xml(file.to_s)['File'])
+          end
+        end
+
+        results.concat(next_marker_results(doc, :files, key, options))
+
+        results
+      end
+
+      # Returns the raw contents of the specified file.
+      #
+      # The only supported option at this time is a "timeout" option.
+      #
+      def file_content(share, file, key = access_key, options = {})
+        raise ArgumentError, "No access key specified" unless key
+
+        query = options.to_query
+
+        response = file_response(key, query, 'get', '', File.join(share, file))
+        response.body
+      end
+
+      # Returns the raw contents of the specified file.
+      #
+      # The only supported option at this time is a "timeout" option.
+      #
+      def file_properties(share, file, key = access_key, options = {})
+        raise ArgumentError, "No access key specified" unless key
+
+        query = options.to_query
+
+        response = file_response(key, query, 'head', '', File.join(share, file))
+
+        Azure::Armrest::ResponseHeaders.new(response.headers).tap do |rh|
+          rh.response_code = response.code
+        end
+      end
+
+      # Create the specified share file. You may specify any of the following
+      # options:
+      #
+      # * cache_control
+      # * content_disposition
+      # * content_length (default: 0)
+      # * content_encoding
+      # * content_language
+      # * content_md5
+      # * content_type (default: application/octet-stream)
+      # * meta_name
+      # * timeout
+      # * version
+      #
+      # Note that this does not set the content of the file, it only creates
+      # in the file share.
+      #
+      def create_file(share, file, key = access_key, options = {})
+        raise ArgumentError, "No access key specified" unless key
+
+        timeout = options.delete(:timeout) # Part of request
+
+        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['verb'] = 'PUT'
+
+        # Mandatory and/or sane defaults
+        hash['x-ms-type'] = 'file'
+        hash['x-ms-content-length'] ||= 0
+        hash['x-ms-content-type'] ||= 'application/octet-stream'
+
+        headers = build_headers(url, key, :file, hash)
+
+        response = ArmrestService.send(
+          :rest_put,
+          :url         => url,
+          :payload     => '',
+          :headers     => headers,
+          :proxy       => proxy,
+          :ssl_version => ssl_version,
+          :ssl_verify  => ssl_verify
+        )
+
+        Azure::Armrest::ResponseHeaders.new(response.headers).tap do |rh|
+          rh.response_code = response.code
+        end
+      end
+
+      # Delete the specified share file.
+      #
+      # The only supported option at this time is a "timeout" option.
+      #
+      def delete_file(share, file, key = access_key, options = {})
+        raise ArgumentError, "No access key specified" unless key
+
+        query = options.to_query
+
+        response = file_response(key, query, 'delete', '', File.join(share, file))
+
+        Azure::Armrest::ResponseHeaders.new(response.headers).tap do |rh|
+          rh.response_code = response.code
+        end
+      end
+
+      # Copy a +src_file+ to a destination +dst_file+ within the same storage account.
+      #
+      def copy_file(src_container, src_file, dst_container = src_container, dst_file = nil, key = access_key)
+        raise ArgumentError, "No access key specified" unless key
+
+        dst_file ||= File.basename(src_blob)
+
+        dst_url = File.join(properties.primary_endpoints.file, dst_container, dst_file)
+        src_url = File.join(properties.primary_endpoints.file, src_container, src_file)
+
+        options = {'x-ms-copy-source' => src_url, :verb => 'PUT'}
+
+        headers = build_headers(dst_url, key, :file, options)
+
+        response = ArmrestService.send(
+          :rest_put,
+          :url         => dst_url,
+          :payload     => '',
+          :headers     => headers,
+          :proxy       => proxy,
+          :ssl_version => ssl_version,
+          :ssl_verify  => ssl_verify
+        )
+
+        Azure::Armrest::ResponseHeaders.new(response.headers).tap do |rh|
+          rh.response_code = response.code
+        end
+      end
+
+      # Add content to +file+ on +share+. The +options+ hash supports
+      # three options, :content, :timeout and :write.
+      #
+      # The :content option is just a string, i.e. the content you want
+      # to add to the file. Azure allows you to add a maximum of 4mb worth
+      # of content per request.
+      #
+      # The :timeout option is nil by default. The :write option defaults to
+      # 'update'. If you want to clear a file, set it to 'clear'.
+      #
+      def add_file_content(share, file, key = access_key, options = {})
+        raise ArgumentError, "No access key specified" unless key
+
+        timeout = options.delete(:timeout)
+        content = options.delete(:content)
+
+        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['verb'] = 'PUT'
+        hash['x-ms-write'] ||= 'update'
+
+        if hash['x-ms-write'] == 'clear'
+          hash['content-length'] = 0
+          hash['x-ms-range'] = "bytes=0-"
+        else
+          range = 0..(content.size - 1)
+          hash['content-length'] = content.size
+          hash['x-ms-range'] = "bytes=#{range.min}-#{range.max}"
+        end
+
+        headers = build_headers(url, key, :file, hash)
+
+        response = ArmrestService.send(
+          :rest_put,
+          :url         => url,
+          :payload     => content,
+          :headers     => headers,
+          :proxy       => proxy,
+          :ssl_version => ssl_version,
+          :ssl_verify  => ssl_verify
+        )
+
+        Azure::Armrest::ResponseHeaders.new(response.headers).tap do |rh|
+          rh.response_code = response.code
+        end
+      end
+
+      ### Containers
+
       # Return a list of container names for the given storage account +key+.
       # If no key is provided, it is assumed that the StorageAccount object
       # includes the access_key property.
@@ -237,9 +515,7 @@ module Azure
 
         url = File.join(properties.primary_endpoints.blob, container, blob) + "?comp=properties"
 
-        hash = options.transform_keys do |okey|
-          "x-ms-blob-" + okey.to_s.tr('_', '-')
-        end
+        hash = options.transform_keys { |okey| "x-ms-blob-" + okey.to_s.tr('_', '-') }
 
         hash['verb'] = 'PUT'
 
@@ -306,9 +582,11 @@ module Azure
         results.concat(next_marker_results(doc, :blobs, container, key, options))
       end
 
-      # Returns an array of all blobs for all containers.
+      # Returns an array of all blobs for all containers. The +options+ hash
+      # may contain the same arguments that a call to StorageAccount#blobs
+      # would accept.
       #
-      def all_blobs(key = access_key, max_threads = 10)
+      def all_blobs(key = access_key, max_threads = 10, options = {})
         raise ArgumentError, "No access key specified" unless key
 
         array = []
@@ -316,7 +594,7 @@ module Azure
 
         Parallel.each(containers(key), :in_threads => max_threads) do |container|
           begin
-            mutex.synchronize { array.concat(blobs(container.name, key)) }
+            mutex.synchronize { array.concat(blobs(container.name, key, options)) }
           rescue Errno::ECONNREFUSED, Azure::Armrest::TimeoutException => err
             msg "Unable to gather blob information for #{container.name}: #{err}"
             log('warn', msg)
@@ -404,7 +682,8 @@ module Azure
         blob
       end
 
-      # Delete the given +blob+ found in +container+.
+      # Delete the given +blob+ found in +container+. Pass a :date option
+      # if you wish to delete a snapshot.
       #
       def delete_blob(container, blob, key = access_key, options = {})
         raise ArgumentError, "No access key specified" unless key
@@ -431,43 +710,113 @@ module Azure
 
       # Create new blob for a container.
       #
-      # The +data+ parameter is a hash that contains the blob's information:
+      # The options parameter is a hash that contains information used
+      # when creating the blob:
       #
-      # data['x-ms-blob-type']
-      # # - Required. Specifies the type of blob to create: block, page or append.
+      # * type - "BlockBlob", "PageBlob" or "AppendBlob". Mandatory.
       #
-      # data['x-ms-blob-content-encoding']
-      # # - Optional. Set the blob’s content encoding.
-      # ...
-      def create_blob(container, blob, data, key = access_key)
+      # * content_disposition
+      # * content_encoding
+      # * content_language
+      # * content_md5
+      # * content_type
+      # * cache_control
+      # * lease_id
+      # * payload (block blobs only)
+      # * sequence_number (page blobs only)
+      # * timeout (part of the request)
+      #
+      # Returns a ResponseHeaders object since this method is asynchronous.
+      #
+      def create_blob(container, blob, key = access_key, options = {})
         raise ArgumentError, "No access key specified" unless key
 
+        timeout = options.delete(:timeout)
+        payload = options.delete(:payload) || ''
+
         url = File.join(properties.primary_endpoints.blob, container, blob)
+        url += "&timeout=#{timeout}" if timeout
 
-        options = {:verb => 'PUT'}
-        options = options.merge(data)
-        headers = build_headers(url, key, :blob, options)
+        hash = options.transform_keys do |okey|
+          if okey.to_s =~ /^if/i
+            okey.to_s.tr('_', '-')
+          elsif %w[date meta_name lease_id version].include?(okey.to_s)
+            'x-ms-' + okey.to_s.tr('_', '-')
+          else
+            'x-ms-blob-' + okey.to_s.tr('_', '-')
+          end
+        end
+
+        unless hash['x-ms-blob-type']
+          raise ArgumentError, "The :type option must be specified"
+        end
+
+        hash['x-ms-date'] ||= Time.now.httpdate
+        hash['x-ms-version'] ||= @storage_api_version
+        hash['verb'] = 'PUT'
+
+        # Content length must be 0 (blank) for Page or Append blobs
+        if %w[pageblob appendblob].include?(hash['x-ms-blob-type'].downcase)
+          hash['content-length'] = ''
+        else
+          hash['content-length'] ||= hash['x-ms-blob-content-length']
+        end
+
+        # Override the default empty string
+        hash['content-type'] ||= hash['x-ms-blob-content-type'] || 'application/octet-stream'
+
+        headers = build_headers(url, key, :blob, hash)
 
         response = ArmrestService.send(
           :rest_put,
           :url         => url,
-          :payload     => '',
+          :payload     => payload,
           :headers     => headers,
           :proxy       => proxy,
           :ssl_version => ssl_version,
           :ssl_verify  => ssl_verify
         )
 
-        Blob.new(response.headers)
+        resp_headers = Azure::Armrest::ResponseHeaders.new(response.headers)
+        resp_headers.response_code = response.code
+
+        resp_headers
       end
 
-      def create_blob_snapshot(container, blob, key = access_key)
+      # Create a read-only snapshot of a blob.
+      #
+      # Possible options are:
+      #
+      # * meta_name
+      # * lease_id
+      # * client_request_id
+      # * if_modified_since
+      # * if_unmodified_since
+      # * if_match
+      # * if_none_match
+      # * timeout
+      #
+      # Returns a ResponseHeaders object since this is an asynchronous method.
+      #
+      def create_blob_snapshot(container, blob, key = access_key, options = {})
         raise ArgumentError, "No access key specified" unless key
 
-        url = File.join(properties.primary_endpoints.blob, container, blob)
-        url += "?comp=snapshot"
+        timeout = options.delete(:timeout) # Part of request
+
+        url = File.join(properties.primary_endpoints.blob, container, blob) + "?comp=snapshot"
+        url += "&timeout=#{timeout}" if timeout
+
+        hash = options.transform_keys do |okey|
+          if okey.to_s =~ /^if/i
+            okey.to_s.tr('_', '-')
+          else
+            'x-ms-blob-' + okey.to_s.tr('_', '-')
+          end
+        end
 
-        headers = build_headers(url, key, :blob, :verb => 'PUT')
+        hash['verb'] = 'PUT'
+
+        headers = build_headers(url, key, :blob, hash)
 
         response = ArmrestService.send(
           :rest_put,
@@ -479,11 +828,10 @@ module Azure
           :ssl_verify  => ssl_verify
         )
 
-        BlobSnapshot.new(
-          'name'          => blob,
-          'last_modified' => response.headers.fetch(:last_modified),
-          'snapshot'      => response.headers.fetch(:x_ms_snapshot)
-        )
+        headers = Azure::Armrest::ResponseHeaders.new(response.headers)
+        headers.response_code = response.code
+
+        headers
       end
 
       # Get the contents of the given +blob+ found in +container+ using the
@@ -612,6 +960,31 @@ module Azure
         )
       end
 
+      # Using the file primary endpoint as a base, join any arguments to the
+      # the url and submit an http request.
+      #
+      def file_response(key, query, request_type = 'get', payload = '', *args)
+        url = File.join(properties.primary_endpoints.file, *args)
+        url += "?#{query}" if query && !query.empty?
+        request_method = "rest_#{request_type}".to_sym
+
+        headers = build_headers(url, key, :file, :verb => request_type.to_s.upcase)
+
+        params = {
+          :url         => url,
+          :headers     => headers,
+          :proxy       => proxy,
+          :ssl_version => ssl_version,
+          :ssl_verify  => ssl_verify,
+        }
+
+        if %w[put post].include?(request_type.to_s.downcase)
+          params[:payload] = payload
+        end
+
+        ArmrestService.send(request_method, params)
+      end
+
       # Using the blob primary endpoint as a base, join any arguments to the
       # the url and submit an http request.
       def table_response(key, query = nil, *args)
@@ -644,8 +1017,10 @@ module Azure
         # RestClient will set the Content-Type to application/x-www-form-urlencoded.
         # We must override this setting or the request will fail in some cases.
 
+        content_type = additional_headers['content-type'] || ''
+
         headers = {
-          'content-type' => '',
+          'content-type' => content_type,
           'x-ms-date'    => Time.now.httpdate,
           'x-ms-version' => @storage_api_version,
           'auth_string'  => true

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

@@ -6,7 +6,7 @@ module Azure
     module Storage
       # Base class for managing images.
       class ImageService < ResourceGroupBasedService
-        # Create and return a new DiskService instance.
+        # Create and return a new ImageService instance.
         #
         def initialize(configuration, options = {})
           super(configuration, 'images', 'Microsoft.Compute', options)

data/lib/azure/armrest/version.rb

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

data/lib/azure/armrest/virtual_machine_image_service.rb

@@ -22,6 +22,35 @@ module Azure
         @publisher = options[:publisher]
       end
 
+      # Return a list of all VM image offers from the given +location+.
+      #
+      # Example:
+      #
+      #   vmis.list_all('eastus')
+      #
+      def list_all(location = @location)
+        raise ArgumentError, "No location specified" unless location
+
+        images = []
+        publishers(location).each do |publisher|
+          offers(location, publisher.name).each do |offer|
+            skus(offer.name, location, publisher.name).each do |sku|
+              versions(sku.name, offer.name, location, publisher.name).each do |version|
+                images << Azure::Armrest::VirtualMachineImage.new(
+                    :location  => version.location,
+                    :publisher => publisher.name,
+                    :offer     => offer.name,
+                    :sku       => sku.name,
+                    :version   => version.name,
+                    :id        => "#{publisher.name}:#{offer.name}:#{sku.name}:#{version.name}"
+                )
+              end
+            end
+          end
+        end
+        images
+      end
+
       # Return a list of VM image offers from the given +publisher+ and +location+.
       #
       # Example:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: azure-armrest
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.8.0
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-27 00:00:00.000000000 Z
+date: 2017-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -300,7 +300,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: An interface for ARM/JSON Azure REST API