gitlab-fog-azure-rm 1.0.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a0941da3e69509575eca6b720890940f33e8617e32bbb37121e19c9e1087e33
-  data.tar.gz: '09b4913d90bcbba439e9501df86dcc5e4d3d012a57941e2bc7033e4ac7d97806'
+  metadata.gz: fc0e6fc125b778bb49c22a6fbfeb0ab779d99bfffaca5496df1834d2a0f69a86
+  data.tar.gz: 5f9ce8aa7d939260edc6047636e6fdfbebaeae6cd7fd611921aa7cc2a3c36056
 SHA512:
-  metadata.gz: 6df48a1e91089a7c7af40addf64716b712daee65ea431edc4cffc98f1912c85538c5547eddced2bf512bdee1fbcca1cdd43eb2eb76022055a837f07bdad54d8c
-  data.tar.gz: b4696c93d25c11b5344410a09cd8142eae252350030000c3f6d041b85f69273f2196fa1715e1428ce9105471d150f1d3b036834140813d148b5ff54883481c24
+  metadata.gz: 1578489ca552ed032d47387738f1b8807f467bac75b1d2446fe0ea547ed8b96b81d44c9af7c3134d50da7bb86158e757f8bb18ce4e3e998a9badfb5ce76a55e4
+  data.tar.gz: ff5993b7140d6e3dd0de19d776dd2666980f65a1cb0baeee5abc28ed98eb29a71386108763530f591cb768116493994fbdec1bd877a2c8939c31c6cb85535385

data/.gitlab-ci.yml

@@ -1,4 +1,5 @@
-image: "ruby:2.7"
+default:
+  image: "ruby:${RUBY_VERSION}"
 
 cache:
   paths:
@@ -11,7 +12,12 @@ before_script:
 test:
   script:
     - bundle exec rake test
+  parallel:
+    matrix:
+      - RUBY_VERSION: [ "2.7", "3.0", "3.1" ]
 
 rubocop:
   script:
     - bundle exec rubocop
+  variables:
+    RUBY_VERSION: "2.7"

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 ## Unreleased
 
+## 1.3.0
+
+- Fix Ruby 3.0 compatibility !27
+
+## 1.2.0
+
+- Support setting returned Content-Disposition in GetBlob requests !25
+
+## 1.1.1
+
+- Remove trailing periods per path segment when retrieving blob URLs !23
+
+## 1.1.0
+
+- Yanked
+
 ## 1.0.1
 
 - Fix URL generation for files with UTF-8 characters !21

data/lib/fog/azurerm/models/storage/file.rb

@@ -240,11 +240,19 @@ module Fog
         #
         def url(expires, options = {})
           requires :key
-          collection.get_url(key, expires, options)
+          collection.get_url(key, expires, normalize_options(options))
         end
 
         private
 
+        def normalize_options(options)
+          # AWS S3 and Google Cloud Storage pass response-content-disposition
+          # as a query string, while Azure needs the content_disposition parameter
+          # to generate a SAS token.
+          options[:content_disposition] ||= options.dig(:query, 'response-content-disposition')
+          options
+        end
+
         # Upload blob
         def save_blob(options)
           if options[:blob_type].nil? || options[:blob_type] == 'BlockBlob'

data/lib/fog/azurerm/models/storage/files.rb

@@ -123,10 +123,10 @@ module Fog
         #
         # @return [String] A http URL.
         #
-        def get_http_url(key, expires, _options = {})
+        def get_http_url(key, expires, options = {})
           requires :directory
 
-          service.get_blob_http_url(directory.key, key, expires)
+          service.get_blob_http_url(directory.key, key, expires, options)
         end
 
         # Get the https URL of the file(blob) with the given name.
@@ -139,10 +139,10 @@ module Fog
         #
         # @return [String] A https URL.
         #
-        def get_https_url(key, expires, _options = {})
+        def get_https_url(key, expires, options = {})
           requires :directory
 
-          service.get_blob_https_url(directory.key, key, expires)
+          service.get_blob_https_url(directory.key, key, expires, options)
         end
 
         # Get the file(blob) without content with the given name.

data/lib/fog/azurerm/requests/storage/get_blob.rb

@@ -5,7 +5,7 @@ module Fog
       class Real
         BLOCK_SIZE = 32 * 1024 * 1024 # 32 MB
 
-        def get_blob_with_block_given(container_name, blob_name, options, &_block)
+        def get_blob_with_block_given(container_name, blob_name, options, &block)
           options[:request_id] = SecureRandom.uuid
           msg = "get_blob_with_block_given: blob #{blob_name} in the container #{container_name}. options: #{options}"
           Fog::Logger.debug msg
@@ -19,7 +19,7 @@ module Fog
 
           content_length = blob.properties[:content_length]
           if content_length.zero?
-            Proc.new.call('', 0, 0)
+            block.call('', 0, 0)
             return [blob, '']
           end
 
@@ -30,7 +30,7 @@ module Fog
           raise ArgumentError.new(':end_range MUST be greater than :start_range') if start_range > end_range
 
           if start_range == end_range
-            Proc.new.call('', 0, 0)
+            block.call('', 0, 0)
             return [blob, '']
           end
 
@@ -55,7 +55,7 @@ module Fog
               raise_azure_exception(ex, msg)
             end
 
-            Proc.new.call(content, end_range - buffer_end_range, total_bytes)
+            block.call(content, end_range - buffer_end_range, total_bytes)
             buffer_start_range += buffer_size
           end
           # No need to return content when block is given.
@@ -84,7 +84,7 @@ module Fog
 
       # This class provides the mock implementation for unit tests.
       class Mock
-        def get_blob(_container_name, _blob_name, _options = {}, &_block)
+        def get_blob(_container_name, _blob_name, _options = {}, &block)
           Fog::Logger.debug 'get_blob successfully.'
           unless block_given?
             return [
@@ -122,7 +122,7 @@ module Fog
           remaining = total_bytes = data.length
           while remaining > 0
             chunk = data.read([remaining, 2].min)
-            Proc.new.call(chunk, remaining, total_bytes)
+            block.call(chunk, remaining, total_bytes)
             remaining -= 2
           end
 

data/lib/fog/azurerm/requests/storage/get_blob_http_url.rb

@@ -13,13 +13,15 @@ module Fog
         #
         # @see https://msdn.microsoft.com/en-us/library/azure/mt584140.aspx
         #
-        def get_blob_http_url(container_name, blob_name, expires)
+        def get_blob_http_url(container_name, blob_name, expires, options = {})
           relative_path = "#{container_name}/#{blob_name}"
+          relative_path = remove_trailing_periods_from_path_segments(relative_path)
           params = {
             service: 'b',
             resource: 'b',
             permissions: 'r',
-            expiry: expires.utc.iso8601
+            expiry: expires.utc.iso8601,
+            content_disposition: options[:content_disposition]
           }
           token = @signature_client.generate_service_sas_token(relative_path, params)
           uri = @blob_client.generate_uri(relative_path, {}, { encode: true })

data/lib/fog/azurerm/requests/storage/get_blob_https_url.rb

@@ -13,14 +13,16 @@ module Fog
         #
         # @see https://msdn.microsoft.com/en-us/library/azure/mt584140.aspx
         #
-        def get_blob_https_url(container_name, blob_name, expires)
+        def get_blob_https_url(container_name, blob_name, expires, options = {})
           relative_path = "#{container_name}/#{blob_name}"
+          relative_path = remove_trailing_periods_from_path_segments(relative_path)
           params = {
             service: 'b',
             resource: 'b',
             permissions: 'r',
             expiry: expires.utc.iso8601,
-            protocol: 'https'
+            protocol: 'https',
+            content_disposition: options[:content_disposition]
           }
           token = @signature_client.generate_service_sas_token(relative_path, params)
           uri = @blob_client.generate_uri(relative_path, {}, { encode: true })

data/lib/fog/azurerm/requests/storage/get_object_url.rb

@@ -5,15 +5,15 @@ module Fog
       class Real
         # Get a public blob url from Azure blob storage
         # This is to make this library compatible with CarrierWave.
-        def get_object_url(container_name, blob_name, expires)
-          get_blob_https_url(container_name, blob_name, expires)
+        def get_object_url(container_name, blob_name, expires, options = {})
+          get_blob_https_url(container_name, blob_name, expires, options)
         end
       end
 
       # This class provides the mock implementation for unit tests.
       class Mock
-        def get_object_url(container_name, blob_name, expires)
-          get_blob_https_url(container_name, blob_name, expires)
+        def get_object_url(container_name, blob_name, expires, options = {})
+          get_blob_https_url(container_name, blob_name, expires, options)
         end
       end
     end

data/lib/fog/azurerm/utilities/general.rb

@@ -189,3 +189,7 @@ end
 def get_subscription_id(id)
   id.split('/')[2]
 end
+
+def remove_trailing_periods_from_path_segments(path)
+  path.split('/').map { |segment| segment.gsub(/\.*$/, '') }.join('/')
+end

data/lib/fog/azurerm/version.rb

@@ -1,5 +1,5 @@
 module Fog
   module AzureRM
-    VERSION = '1.0.1'.freeze
+    VERSION = '1.3.0'.freeze
   end
 end

data/test/models/storage/test_file.rb

@@ -1,7 +1,7 @@
 require File.expand_path '../../test_helper', __dir__
 
 # Test class for Storage Container Model
-class TestFile < Minitest::Test
+class TestFile < Minitest::Test # rubocop:disable Metrics/ClassLength
   def setup
     @service = Fog::Storage::AzureRM.new(storage_account_credentials)
     @directory = directory(@service)
@@ -283,6 +283,18 @@ class TestFile < Minitest::Test
     end
   end
 
+  def test_url_method_with_content_disposition
+    @file.collection.stub :get_url, @blob_https_url, { content_disposition: 'attachment' } do
+      assert @file.url(Time.now + 3600, content_disposition: 'attachment'), @blob_https_url
+    end
+  end
+
+  def test_url_method_with_response_content_disposition
+    @file.collection.stub :get_url, @blob_https_url, { content_disposition: 'attachment' } do
+      assert @file.url(Time.now + 3600, { query: { 'response-content-disposition' => 'attachment' } }), @blob_https_url
+    end
+  end
+
   def test_url_method_without_key_exception
     assert_raises(ArgumentError) do
       @file.attributes.delete(:key)

data/test/requests/storage/test_get_blob_http_url.rb

@@ -24,6 +24,43 @@ class TestGetBlobHttpUrl < Minitest::Test
     end
   end
 
+  def test_get_blob_http_url_with_content_disposition
+    mock_generate_uri = Minitest::Mock.new
+    mock_generate_service_token = Minitest::Mock.new
+    url_params = { content_disposition: 'attachment' }
+
+    mock_generate_uri.expect(:call, @url, ['test_container/test_blob', {}, { encode: true }])
+    mock_generate_service_token.expect(:call, @token) do |_relative_path, params|
+      params[:service] == 'b' &&
+        params[:resource] == 'b' &&
+        params[:permissions] == 'r' &&
+        params[:protocol].nil? &&
+        params[:content_disposition] == url_params[:content_disposition]
+    end
+
+    @blob_client.stub :generate_uri, mock_generate_uri do
+      @signature_client.stub :generate_service_sas_token, mock_generate_service_token do
+        assert_equal "#{@url}?#{@token}", @service.get_blob_http_url('test_container', 'test_blob', Time.now.utc + 3600, url_params)
+      end
+    end
+  end
+
+  def test_get_url_remove_trailing_periods_from_path_segments
+    mock_generate_uri = Minitest::Mock.new
+    mock_generate_service_token = Minitest::Mock.new
+
+    mock_generate_uri.expect(:call, @url, ['.test0/..test1/...test2', {}, { encode: true }])
+    mock_generate_service_token.expect(:call, @token) do |relative_path, _|
+      relative_path == '.test0/..test1/...test2'
+    end
+
+    @blob_client.stub :generate_uri, mock_generate_uri do
+      @signature_client.stub :generate_service_sas_token, mock_generate_service_token do
+        assert_equal "#{@url}?#{@token}", @service.get_blob_http_url('.test0.', '..test1../...test2...', Time.now.utc + 3600)
+      end
+    end
+  end
+
   def test_get_blob_http_url_mock
     assert_equal "#{@url}?#{@token}", @mock_service.get_blob_http_url('test_container', 'test_blob', Time.now.utc + 3600)
   end

data/test/requests/storage/test_get_blob_https_url.rb

@@ -31,6 +31,48 @@ class TestGetBlobHttpsUrl < Minitest::Test
     end
   end
 
+  def test_get_blob_https_url_with_content_disposition
+    mock_generate_uri = Minitest::Mock.new
+    mock_generate_service_token = Minitest::Mock.new
+    url_params = { content_disposition: 'attachment' }
+
+    2.times do
+      mock_generate_uri.expect(:call, @url, ['test_container/test_blob', {}, { encode: true }])
+      mock_generate_service_token.expect(:call, @token) do |_relative_path, params|
+        params[:service] == 'b' &&
+          params[:resource] == 'b' &&
+          params[:permissions] == 'r' &&
+          params[:content_disposition] == url_params[:content_disposition]
+      end
+    end
+
+    @blob_client.stub :generate_uri, mock_generate_uri do
+      @signature_client.stub :generate_service_sas_token, mock_generate_service_token do
+        assert_equal "#{@url}?#{@token}", @service.get_blob_https_url('test_container', 'test_blob', Time.now.utc + 3600, url_params)
+        assert_equal "#{@url}?#{@token}", @service.get_object_url('test_container', 'test_blob', Time.now.utc + 3600, url_params)
+      end
+    end
+  end
+
+  def test_get_url_remove_trailing_periods_from_path_segments
+    mock_generate_uri = Minitest::Mock.new
+    mock_generate_service_token = Minitest::Mock.new
+
+    2.times do
+      mock_generate_uri.expect(:call, @url, ['.test0/..test1/...test2', {}, { encode: true }])
+      mock_generate_service_token.expect(:call, @token) do |relative_path, _|
+        relative_path == '.test0/..test1/...test2'
+      end
+    end
+
+    @blob_client.stub :generate_uri, mock_generate_uri do
+      @signature_client.stub :generate_service_sas_token, mock_generate_service_token do
+        assert_equal "#{@url}?#{@token}", @service.get_blob_https_url('.test0.', '..test1../...test2...', Time.now.utc + 3600)
+        assert_equal "#{@url}?#{@token}", @service.get_object_url('.test0.', '..test1../...test2...', Time.now.utc + 3600)
+      end
+    end
+  end
+
   def test_get_blob_https_url_with_domain_success
     service = Fog::Storage::AzureRM.new(storage_account_credentials_with_domain)
     blob_client = service.instance_variable_get(:@blob_client)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-fog-azure-rm
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Shaffan Chaudhry
@@ -18,7 +18,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-22 00:00:00.000000000 Z
+date: 2022-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
@@ -338,7 +338,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Module for the 'fog' gem to support Azure Blob Storage with CarrierWave and