azure-storage-file 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b5e6e5e6a79df45e30ec4813dc7f19c511311a2
+  data.tar.gz: be5abc0d0649ebe815fbd18ee1b4ee68f2176646
+SHA512:
+  metadata.gz: 658bbf8a037b31b1af0cef6e23e9e59ed3d9e586fd66a99d86573434df08541f8c47fbad92c0a3ed0362fced3149829f3871e112ca75d1e9a6b24ed821e39c5d
+  data.tar.gz: a54038b764f95c94a8ce8892bbbac281148edc52e2a6cadccf8686b30e036b94fdaf5d1bca410c5816695b6823c62b29c2a049fa3f2eb24613845b564343d2cb

data/file/lib/azure/storage/file.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+#-------------------------------------------------------------------------
+# # Copyright (c) Microsoft and contributors. All rights reserved.
+#
+# The MIT License(MIT)
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files(the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions :
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#--------------------------------------------------------------------------
+require "azure/storage/file/autoload"

data/file/lib/azure/storage/file/autoload.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+#-------------------------------------------------------------------------
+# # Copyright (c) Microsoft and contributors. All rights reserved.
+#
+# The MIT License(MIT)
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files(the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions :
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#--------------------------------------------------------------------------
+
+require "rubygems"
+require "nokogiri"
+require "base64"
+
+require "azure/storage/common"
+
+module Azure
+  module Storage
+    module File
+      autoload :Default,                  "azure/storage/file/default"
+      autoload :Version,                  "azure/storage/file/version"
+      autoload :FileService,              "azure/storage/file/file_service"
+      autoload :Share,                    "azure/storage/file/share"
+      autoload :Directory,                "azure/storage/file/directory"
+      autoload :File,                     "azure/storage/file/file"
+      autoload :Serialization,            "azure/storage/file/serialization"
+    end
+  end
+end

data/file/lib/azure/storage/file/default.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+#-------------------------------------------------------------------------
+# # Copyright (c) Microsoft and contributors. All rights reserved.
+#
+# The MIT License(MIT)
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files(the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions :
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#--------------------------------------------------------------------------
+
+require "rbconfig"
+require "azure/storage/file/version"
+
+module Azure::Storage::File
+  module Default
+    # Default REST service (STG) version number
+    STG_VERSION = "2016-05-31"
+
+    # The number of default concurrent requests for parallel operation.
+    DEFAULT_PARALLEL_OPERATION_THREAD_COUNT = 1
+
+    # Constant representing a kilobyte (Non-SI version).
+    KB = 1024
+    # Constant representing a megabyte (Non-SI version).
+    MB = 1024 * 1024
+    # Constant representing a gigabyte (Non-SI version).
+    GB = 1024 * 1024 * 1024
+
+    # Specifies HTTP.
+    HTTP = "http"
+    # Specifies HTTPS.
+    HTTPS = "https"
+    # Default HTTP port.
+    DEFAULT_HTTP_PORT = 80
+    # Default HTTPS port.
+    DEFAULT_HTTPS_PORT = 443
+
+    # Marker for atom metadata.
+    XML_METADATA_MARKER = "$"
+    # Marker for atom value.
+    XML_VALUE_MARKER = "_"
+
+    # Default value for Content-Type if request has body.
+    CONTENT_TYPE_VALUE = "application/octet-stream"
+
+    # Default User Agent header string
+    USER_AGENT = "Azure-Storage/#{Azure::Storage::File::Version.to_uas}-#{Azure::Storage::Common::Version.to_uas} (Ruby #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}; #{Azure::Storage::Common::Default.os})".freeze
+  end
+
+  # Defines constants for use with file operations.
+  module FileConstants
+    # The default write size, in bytes, used by file streams.
+    DEFAULT_WRITE_SIZE_IN_BYTES = 4 * 1024 * 1024
+
+    # The maximum range size when requesting for a contentMD5.
+    MAX_RANGE_GET_SIZE_WITH_MD5 = 4 * 1024 * 1024
+
+    # The maximum range size for a file update operation.
+    MAX_UPDATE_FILE_SIZE = 4 * 1024 * 1024
+
+    # The default minimum size, in bytes, of a file when it must be separated into ranges.
+    DEFAULT_SINGLE_FILE_GET_THRESHOLD_IN_BYTES = 32 * 1024 * 1024
+
+    # The minimum write file size, in bytes, used by file streams.
+    MIN_WRITE_FILE_SIZE_IN_BYTES = 2 * 1024 * 1024
+
+    # Put range write options
+    module RangeWriteOptions
+      UPDATE = "update"
+      CLEAR = "clear"
+    end
+
+    # Resource types.
+    module ResourceTypes
+      SHARE = "s"
+      FILE = "f"
+    end
+  end
+
+  module FileErrorCodeStrings
+    SHARE_ALREADY_EXISTS = "ShareAlreadyExists"
+    SHARE_NOT_FOUND = "ShareNotFound"
+    FILE_NOT_FOUND = "FileNotFound"
+  end
+end

data/file/lib/azure/storage/file/directory.rb

@@ -0,0 +1,284 @@
+# frozen_string_literal: true
+
+#-------------------------------------------------------------------------
+# # Copyright (c) Microsoft and contributors. All rights reserved.
+#
+# The MIT License(MIT)
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files(the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions :
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#--------------------------------------------------------------------------
+require "azure/storage/file/serialization"
+
+module Azure::Storage::File
+  StorageService = Azure::Storage::Common::Service::StorageService
+  module Directory
+    include Azure::Storage::Common::Service
+
+    class Directory
+      def initialize
+        @properties = {}
+        @metadata = {}
+        yield self if block_given?
+      end
+
+      attr_accessor :name
+      attr_accessor :properties
+      attr_accessor :metadata
+    end
+  end
+
+  # Public: Get a list of files or directories under the specified share or directory.
+  #         It lists the contents only for a single level of the directory hierarchy.
+  #
+  # ==== Attributes
+  #
+  # * +share+                     - String. The name of the file share.
+  # * +directory_path+            - String. The path to the directory.
+  # * +options+                   - Hash. Optional parameters.
+  #
+  # ==== Options
+  #
+  # Accepted key/value pairs in options parameter are:
+  #
+  # * +:prefix+                  - String. Filters the results to return only directories and files
+  #                                whose name begins with the specified prefix. (optional)
+  # * +:marker+                  - String. An identifier the specifies the portion of the
+  #                                list to be returned. This value comes from the property
+  #                                Azure::Storage::Common::EnumerationResults.continuation_token when there
+  #                                are more shares available than were returned. The
+  #                                marker value may then be used here to request the next set
+  #                                of list items. (optional)
+  #
+  # * +:max_results+             - Integer. Specifies the maximum number of shares to return.
+  #                                If max_results is not specified, or is a value greater than
+  #                                5,000, the server will return up to 5,000 items. If it is set
+  #                                to a value less than or equal to zero, the server will return
+  #                                status code 400 (Bad Request). (optional)
+  #
+  # * +:timeout+                 - Integer. A timeout in seconds.
+  #
+  # * +:request_id+              - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded
+  #                                in the analytics logs when storage analytics logging is enabled.
+  #
+  # * +:location_mode+           - LocationMode. Specifies the location mode used to decide 
+  #                                which location the request should be sent to.
+  #
+  # See: https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/list-directories-and-files
+  #
+  # Returns an Azure::Storage::Common::EnumerationResults
+  #
+  def list_directories_and_files(share, directory_path, options = {})
+    query = { "comp" => "list" }
+    unless options.nil?
+      StorageService.with_query query, "marker", options[:marker]
+      StorageService.with_query query, "maxresults", options[:max_results].to_s if options[:max_results]
+      StorageService.with_query query, "timeout", options[:timeout].to_s if options[:timeout]
+      StorageService.with_query query, "prefix", options[:prefix].to_s if options[:prefix]
+    end
+
+    options[:request_location_mode] = Azure::Storage::Common::RequestLocationMode::PRIMARY_OR_SECONDARY
+    uri = directory_uri(share, directory_path, query, options)
+    response = call(:get, uri, nil, {}, options)
+
+    # Result
+    if response.success?
+      Serialization.directories_and_files_enumeration_results_from_xml(response.body)
+    else
+      response.exception
+    end
+  end
+
+  # Public: Create a new directory
+  #
+  # ==== Attributes
+  #
+  # * +share+                     - String. The name of the file share.
+  # * +directory_path+            - String. The path to the directory.
+  # * +options+                   - Hash. Optional parameters.
+  #
+  # ==== Options
+  #
+  # Accepted key/value pairs in options parameter are:
+  # * +:metadata+                 - Hash. User defined metadata for the share (optional).
+  # * +:timeout+                  - Integer. A timeout in seconds.
+  # * +:request_id+               - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded
+  #                                 in the analytics logs when storage analytics logging is enabled.
+  #
+  # See https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/create-directory
+  #
+  # Returns a Directory
+  def create_directory(share, directory_path, options = {})
+    # Query
+    query = {}
+    query["timeout"] = options[:timeout].to_s if options[:timeout]
+
+    # Scheme + path
+    uri = directory_uri(share, directory_path, query)
+
+    # Headers
+    headers = {}
+    StorageService.add_metadata_to_headers(options[:metadata], headers) if options[:metadata]
+
+    # Call
+    response = call(:put, uri, nil, headers, options)
+
+    # result
+    directory = Serialization.directory_from_headers(response.headers)
+    directory.name = directory_path
+    directory.metadata = options[:metadata] if options[:metadata]
+    directory
+  end
+
+  # Public: Returns all system properties for the specified directory,
+  #         and can also be used to check the existence of a directory.
+  #         The data returned does not include the files in the directory or any subdirectories.
+  #
+  # ==== Attributes
+  #
+  # * +share+                     - String. The name of the file share.
+  # * +directory_path+            - String. The path to the directory.
+  # * +options+                   - Hash. Optional parameters.
+  #
+  # ==== Options
+  #
+  # Accepted key/value pairs in options parameter are:
+  # * +:timeout+                  - Integer. A timeout in seconds.
+  # * +:request_id+               - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded
+  #                                 in the analytics logs when storage analytics logging is enabled.
+  # * +:location_mode+            - LocationMode. Specifies the location mode used to decide 
+  #                                 which location the request should be sent to.
+  #
+  # See https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/get-directory-properties
+  #
+  # Returns a Directory
+  def get_directory_properties(share, directory_path, options = {})
+    # Query
+    query = {}
+    query["timeout"] = options[:timeout].to_s if options[:timeout]
+
+    # Call
+    options[:request_location_mode] = Azure::Storage::Common::RequestLocationMode::PRIMARY_OR_SECONDARY
+    response = call(:get, directory_uri(share, directory_path, query, options), nil, {}, options)
+
+    # result
+    directory = Serialization.directory_from_headers(response.headers)
+    directory.name = directory_path
+    directory
+  end
+
+  # Public: Deletes a directory.
+  #
+  # ==== Attributes
+  #
+  # * +share+                     - String. The name of the file share.
+  # * +directory_path+            - String. The path to the directory.
+  # * +options+                   - Hash. Optional parameters.
+  #
+  # ==== Options
+  #
+  # Accepted key/value pairs in options parameter are:
+  # * +:timeout+                  - Integer. A timeout in seconds.
+  # * +:request_id+               - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded
+  #                                 in the analytics logs when storage analytics logging is enabled.
+  #
+  # See https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/delete-directory
+  #
+  # Returns nil on success
+  def delete_directory(share, directory_path, options = {})
+    # Query
+    query = {}
+    query["timeout"] = options[:timeout].to_s if options[:timeout]
+
+    # Call
+    call(:delete, directory_uri(share, directory_path, query), nil, {}, options)
+
+    # result
+    nil
+  end
+
+  # Public: Returns only user-defined metadata for the specified directory.
+  #
+  # ==== Attributes
+  #
+  # * +share+                     - String. The name of the file share.
+  # * +directory_path+            - String. The path to the directory.
+  # * +options+                   - Hash. Optional parameters.
+  #
+  # ==== Options
+  #
+  # Accepted key/value pairs in options parameter are:
+  # * +:timeout+                  - Integer. A timeout in seconds.
+  # * +:request_id+               - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded
+  #                                 in the analytics logs when storage analytics logging is enabled.
+  # * +:location_mode+            - LocationMode. Specifies the location mode used to decide 
+  #                                 which location the request should be sent to.
+  #
+  # See https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/get-directory-metadata
+  #
+  # Returns a Directory
+  def get_directory_metadata(share, directory_path, options = {})
+    # Query
+    query = { "comp" => "metadata" }
+    query["timeout"] = options[:timeout].to_s if options[:timeout]
+
+    # Call
+    options[:request_location_mode] = Azure::Storage::Common::RequestLocationMode::PRIMARY_OR_SECONDARY
+    response = call(:get, directory_uri(share, directory_path, query, options), nil, {}, options)
+
+    # result
+    directory = Serialization.directory_from_headers(response.headers)
+    directory.name = directory_path
+    directory
+  end
+
+  # Public: Sets custom metadata for the directory.
+  #
+  # ==== Attributes
+  #
+  # * +share+                     - String. The name of the file share.
+  # * +directory_path+            - String. The path to the directory.
+  # * +metadata+                  - Hash. A Hash of the metadata values.
+  # * +options+                   - Hash. Optional parameters.
+  #
+  # ==== Options
+  #
+  # Accepted key/value pairs in options parameter are:
+  # * +:timeout+                  - Integer. A timeout in seconds.
+  # * +:request_id+               - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded
+  #                                 in the analytics logs when storage analytics logging is enabled.
+  #
+  # See https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/set-directory-metadata
+  #
+  # Returns nil on success
+  def set_directory_metadata(share, directory_path, metadata, options = {})
+    # Query
+    query = { "comp" => "metadata" }
+    query["timeout"] = options[:timeout].to_s if options[:timeout]
+
+    # Headers
+    headers = {}
+    StorageService.add_metadata_to_headers(metadata, headers) if metadata
+
+    # Call
+    call(:put, directory_uri(share, directory_path, query), nil, headers, options)
+
+    # Result
+    nil
+  end
+end