gitlab-fog-azure-rm 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff14f21c88b74f1fcebcd7b5b755fcfb0ce5e38878ea4bdc8742f3bd0bf9cfb6
-  data.tar.gz: 0e98eeae909840a4bb1370ac392a171f3d017832c623efb7c3e2ba345b0715ef
+  metadata.gz: 9cc556f2028cd1a063691e4556dc1421014476690f700eb31fea81bcac574b41
+  data.tar.gz: e6e7d3c355e63cf6a0501d2bc85cbfd994ae54349c950657f6619244fecc9d02
 SHA512:
-  metadata.gz: 6efb40c94a812fb275c8175972b8b41091c090bf05fbedd9cd57de61fd0baa2f98069006f8053af33a28b620a9cd1f2eb1de8fe3c8c02c1afd9a14c2f226886b
-  data.tar.gz: ed51ec358917aaca4e042e7cf298b5b45e9898829edd250067e71e4d2a6f55154d1a54f4ade1c152a50ec718a2b4899f5f00d65a5ad95c74e772e4d922d0ff43
+  metadata.gz: c1ffb76c0ba61d39f675c90612afdf3ae06f0b0835c8f6162a874b73a637e58e4c2c07c0b193ede34ef84601c040920e7a93c2ade997abcdd3c39a64f45d9ff9
+  data.tar.gz: bae99d6843a450a5072a9a8e5a2e94de43a6849565fa38c2b288d3c14fbeb70066be960b08c0172a5a9eb61314119d1e78dfb890f90fa4b4af7f7784b028fcdd

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Unreleased
 
+## 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

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_http_url.rb

@@ -13,14 +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,7 +13,7 @@ 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 = {
@@ -21,7 +21,8 @@ module Fog
             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/version.rb

@@ -1,5 +1,5 @@
 module Fog
   module AzureRM
-    VERSION = '1.1.1'.freeze
+    VERSION = '1.2.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,27 @@ 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

data/test/requests/storage/test_get_blob_https_url.rb

@@ -31,6 +31,29 @@ 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-fog-azure-rm
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Shaffan Chaudhry
@@ -15,10 +15,10 @@ authors:
 - Azeem Sajid
 - Maham Nazir
 - Abbas Sheikh
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-09 00:00:00.000000000 Z
+date: 2021-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
@@ -176,7 +176,7 @@ dependencies:
         version: 0.12.0
 description: This is a stripped-down fork of fog-azure-rm that enables Azure Blob
   Storage to be used with CarrierWave and Fog.
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -338,8 +338,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Module for the 'fog' gem to support Azure Blob Storage with CarrierWave and
   Fog.