Don't normalize unicode in templates (fixed #557 + GCS issues)

CHANGELOG.md

@@ -1,6 +1,9 @@
 # 0.11.0
 * *Breaking Change* - Fix handling of large numbers during code generation. Previously the
   uint64/int64 formats were passed through as strings. They are now coerced to/from Fixnum/Bignum types
+* *Breaking Change* - No longer normalize unicode strings in URI templates. Mostly affects
+  Cloud Storage, but other APIs with unicode strings in paths may be affected. Old behavior
+  can be restored using the `normalize_unicode` request option.
 * Remove Hurley as dependency. May cause minor breaking changes if directly accessing the underlying
   client connection.
 * Drop compatibility with Rails 3.x since that is no longer supported by the Rails community.

MIGRATING.md

@@ -1,4 +1,4 @@
-# Migrating from version `0.8.x` to `0.9`
+# Migrating from version `0.8.x` to `0.9` and above
 
 Many changes and improvements have been made to the `google-api-ruby-client`
 library to bring it to `0.9`. If you are starting a new project or haven't used

google-api-client.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'representable', '~> 3.0'
   spec.add_runtime_dependency 'retriable', '>= 2.0', '< 4.0'
-  spec.add_runtime_dependency 'addressable', '~> 2.3'
+  spec.add_runtime_dependency 'addressable', '>= 2.5.1'
   spec.add_runtime_dependency 'mime-types', '>= 3.0'
   spec.add_runtime_dependency 'googleauth', '~> 0.5'
   spec.add_runtime_dependency 'httpclient', '>= 2.8.1', '< 3.0'

lib/google/apis/core/http_command.rb

@@ -139,8 +139,12 @@ module Google
         # @private
         # @return [void]
         def prepare!
-          header.update(options.header) if options && options.header
+          normalize_unicode = true
-          self.url = url.expand(params) if url.is_a?(Addressable::Template)
+          if options
+            header.update(options.header) if options.header
+            normalize_unicode = options.normalize_unicode
+          end
+          self.url = url.expand(params, nil, normalize_unicode) if url.is_a?(Addressable::Template)
           url.query_values = query.merge(url.query_values || {})
 
           if allow_form_encoding?

lib/google/apis/options.rb

@@ -26,7 +26,8 @@ module Google
       :retries,
       :header,
       :timeout_sec,
-      :open_timeout_sec)
+      :open_timeout_sec,
+      :normalize_unicode)
 
     # General client options
     class ClientOptions
@@ -56,6 +57,8 @@ module Google
       #   @return [Fixnum] How long, in seconds, before failed connections time out
       # @!attribute [rw] header
       #   @return [Hash<String,String] Additional HTTP headers to include in requests
+      # @!attribute [rw] normalize_unicode
+      #   @return [Boolean] True if unicode strings should be normalized in path parameters
 
       # Get the default options
       # @return [Google::Apis::RequestOptions]
@@ -78,8 +81,8 @@ module Google
     ClientOptions.default.use_net_http = false
     ClientOptions.default.application_name = 'unknown'
     ClientOptions.default.application_version = '0.0.0'
-
     RequestOptions.default.retries = 0
     RequestOptions.default.open_timeout_sec = 20
+    RequestOptions.default.normalize_unicode = false
   end
 end

spec/google/apis/core/http_command_spec.rb

@@ -306,4 +306,24 @@ RSpec.describe Google::Apis::Core::HttpCommand do
     command.options.retries = 0
     expect { command.execute(client) }.to raise_error(Google::Apis::RateLimitError)
   end
+
+  it 'should not normalize unicode values by default' do
+    stub_request(:get, 'https://www.googleapis.com/Cafe%CC%81').to_return(status: [200, ''])
+    template = Addressable::Template.new('https://www.googleapis.com/{path}')
+    command = Google::Apis::Core::HttpCommand.new(:get, template)
+    command.params[:path] = "Cafe\u0301"
+    command.options.retries = 0
+    command.execute(client)
+  end
+
+  it 'should normalize unicode values when requested' do
+    stub_request(:get, 'https://www.googleapis.com/Caf%C3%A9').to_return(status: [200, ''])
+    template = Addressable::Template.new('https://www.googleapis.com/{path}')
+    command = Google::Apis::Core::HttpCommand.new(:get, template)
+    command.params[:path] = "Cafe\u0301"
+    command.options.retries = 0
+    command.options.normalize_unicode = true
+    command.execute(client)
+  end
+
 end