Merge pull request #34 from violetviolinist/special-characters-url

allow non-ascii characters in url generation

Author: imagekitio

imagekitio.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
 #  spec.add_dependency "rails", "~> 5.2.0", ">= 5.2.0"
   spec.add_dependency 'carrierwave', '>= 0.7', '< 2.2'
   spec.add_dependency 'rest-client', '~> 2.1', ">=2.1"
+  spec.add_dependency 'addressable', '~> 2.8'
 
   # spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "rails", "~> 5.2.0", ">= 5.2.0"

lib/imagekit/sdk/version.rb

@@ -1,5 +1,5 @@
 module Imagekit
   module Sdk
-    VERSION = '1.0.9'
+    VERSION = '1.0.10'
   end
 end

lib/imagekit/url.rb

@@ -3,6 +3,7 @@
 # Url holds url generation method
 
 require "cgi"
+require "addressable/uri"
 require "openssl"
 require_relative "./utils/formatter"
 require_relative "./constants/defaults"
@@ -46,16 +47,16 @@ def build_url(options)
     result_url_hash = {'host': "", 'path': "", 'query': ""}
     existing_query=nil
     if path != ""
-      parsed_url = URI.parse(path)
+      parsed_url = Addressable::URI.parse(path)
       existing_query=parsed_url.query
-      parsed_host = URI(url_endpoint)
+      parsed_host = Addressable::URI.parse(url_endpoint)
       result_url_hash[:scheme] = parsed_host.scheme
 
       # making sure single '/' at end
       result_url_hash[:host] = parsed_host.host.to_s.chomp("/") + parsed_host.path.chomp("/") + "/"
       result_url_hash[:path] = trim_slash(parsed_url.path)
     else
-      parsed_url = URI.parse(src)
+      parsed_url = Addressable::URI.parse(src)
       existing_query=parsed_url.query
       host = parsed_url.host
       result_url_hash[:userinfo] = parsed_url.userinfo if parsed_url.userinfo

test/imagekit/url_test.rb

@@ -43,6 +43,19 @@
 
     expect(url).to eq("https://imagekit.io/your-imgekit-id/tr:h-300,w-400/default-image.jpg?ik-sdk-version=ruby-#{Imagekit::Sdk::VERSION}")
   end
+
+  it "test_generate_url_with_path_with_special_characters" do
+    request_obj=ImageKitRequest.new(@private_key,@public_key,@url_endpoint)
+    url_obj = Url.new(request_obj)
+
+    options = {path: "/γειασας/Fjällräven_KnSJwp87u6q.png",
+      url_endpoint: @url_endpoint,
+      transformation: [{height: 300, width: 400}],
+    }
+    url = url_obj.generate_url(options)
+
+    expect(url).to eq("https://imagekit.io/your-imgekit-id/tr:h-300,w-400/γειασας/Fjällräven_KnSJwp87u6q.png?ik-sdk-version=ruby-#{Imagekit::Sdk::VERSION}")
+  end
 
   it "test_generate_url_without_slash" do
     request_obj=ImageKitRequest.new(@private_key,@public_key,@url_endpoint)
@@ -55,6 +68,19 @@
 
     expect(url).to eq("https://imagekit.io/your-imgekit-id/tr:h-300,w-400/default-image.jpg?ik-sdk-version=ruby-#{Imagekit::Sdk::VERSION}")
   end
+
+  it "test_generate_url_with_path_without_slash_with_special_characters" do
+    request_obj=ImageKitRequest.new(@private_key,@public_key,@url_endpoint)
+    url_obj = Url.new(request_obj)
+
+    options = {path: "γειασας/Fjällräven_KnSJwp87u6q.png",
+      url_endpoint: @url_endpoint,
+      transformation: [{height: 300, width: 400}],
+    }
+    url = url_obj.generate_url(options)
+
+    expect(url).to eq("https://imagekit.io/your-imgekit-id/tr:h-300,w-400/γειασας/Fjällräven_KnSJwp87u6q.png?ik-sdk-version=ruby-#{Imagekit::Sdk::VERSION}")
+  end
 
   it "test_generate_url_with_override_url_endpoint_without_slash" do
     request_obj=ImageKitRequest.new(@private_key,@public_key,@url_endpoint)
@@ -67,6 +93,18 @@
 
     expect(url).to eq("https://ik.imagekit.io/your_override_imagekit_id/tr:h-300,w-400/default-image.jpg?ik-sdk-version=ruby-#{Imagekit::Sdk::VERSION}")
   end
+
+  it "test_generate_url_with_override_url_endpoint_without_slash_with_special_characters" do
+    request_obj=ImageKitRequest.new(@private_key,@public_key,@url_endpoint)
+    url_obj = Url.new(request_obj)
+    options = {path: "/γειασας/Fjällräven_KnSJwp87u6q.png",
+      url_endpoint: "https://ik.imagekit.io/your_override_imagekit_id",
+      transformation: [{height: 300, width: 400}],
+    }
+    url = url_obj.generate_url(options)
+
+    expect(url).to eq("https://ik.imagekit.io/your_override_imagekit_id/tr:h-300,w-400/γειασας/Fjällräven_KnSJwp87u6q.png?ik-sdk-version=ruby-#{Imagekit::Sdk::VERSION}")
+  end
 
   it "test_generate_url_with_override_url_endpoint_with_slash" do
     request_obj=ImageKitRequest.new(@private_key,@public_key,@url_endpoint)
@@ -81,6 +119,30 @@
     expect(url).to eq("https://ik.imagekit.io/your_override_imagekit_id/tr:h-300,w-400/default-image.jpg?ik-sdk-version=ruby-#{Imagekit::Sdk::VERSION}")
   end
 
+  it "test_generate_url_with_override_url_endpoint_with_slash_with_special_characters" do
+    request_obj=ImageKitRequest.new(@private_key,@public_key,@url_endpoint)
+    url_obj = Url.new(request_obj)
+    options = {path: "/γειασας/Fjällräven_KnSJwp87u6q.png",
+      url_endpoint: "https://ik.imagekit.io/your_override_imagekit_id/",
+      transformation: [{height: 300, width: 400}],
+    }
+    url = url_obj.generate_url(options)
+
+    expect(url).to eq("https://ik.imagekit.io/your_override_imagekit_id/tr:h-300,w-400/γειασας/Fjällräven_KnSJwp87u6q.png?ik-sdk-version=ruby-#{Imagekit::Sdk::VERSION}")
+  end
+
+  it "test_generate_url_with_override_url_endpoint_with_special_characters" do
+    request_obj=ImageKitRequest.new(@private_key,@public_key,@url_endpoint)
+    url_obj = Url.new(request_obj)
+    options = {path: "/γειασας/Fjällräven_KnSJwp87u6q.png",
+      url_endpoint: "https://www.Fjällräven.com/your_override_imagekit_id/",
+      transformation: [{height: 300, width: 400}],
+    }
+    url = url_obj.generate_url(options)
+
+    expect(url).to eq("https://www.Fjällräven.com/your_override_imagekit_id/tr:h-300,w-400/γειασας/Fjällräven_KnSJwp87u6q.png?ik-sdk-version=ruby-#{Imagekit::Sdk::VERSION}")
+  end
+
   it "test_generate_url_with_new_transformation_parameters" do
     request_obj=ImageKitRequest.new(@private_key,@public_key,@url_endpoint)
     url_obj = Url.new(request_obj)
@@ -195,6 +257,20 @@
 
     expect(url).to eq("https://imagekit.io/your-imgekit-id/default-image.jpg?ik-sdk-version=ruby-#{Imagekit::Sdk::VERSION}&tr=h-300,w-400")
   end
+
+  it "test_generate_url_with_special_characters_transformation_parameters_setted_to_query" do
+    request_obj=ImageKitRequest.new(@private_key,@public_key,@url_endpoint)
+    url_obj = Url.new(request_obj)
+
+    options = {path: "/γειασας/Fjällräven_KnSJwp87u6q.png",
+      url_endpoint: @url_endpoint,
+      transformation: [{height: 300, width: 400}],
+      transformation_position: "query",
+     }
+    url = url_obj.generate_url(options)
+
+    expect(url).to eq("https://imagekit.io/your-imgekit-id/γειασας/Fjällräven_KnSJwp87u6q.png?ik-sdk-version=ruby-#{Imagekit::Sdk::VERSION}&tr=h-300,w-400")
+  end
 
   it "test_generate_url_with_query_parameters" do
     request_obj=ImageKitRequest.new(@private_key,@public_key,@url_endpoint)
@@ -209,6 +285,19 @@
     expect(url).to eq("https://imagekit.io/your-imgekit-id/tr:h-300,w-400/default-image.jpg?ik-sdk-version=ruby-#{Imagekit::Sdk::VERSION}&v=123&blank_parameter")
   end
 
+  it "test_generate_url_with_query_parameters_with_special_characters" do
+    request_obj=ImageKitRequest.new(@private_key,@public_key,@url_endpoint)
+    url_obj = Url.new(request_obj)
+
+    options = {path: "/default-image.jpg",
+      query_parameters: {"γειασας": "γειασας"},
+      transformation: [{height: 300, width: 400}]
+    }
+    url = url_obj.generate_url(options)
+    
+    expect(url).to eq("https://imagekit.io/your-imgekit-id/tr:h-300,w-400/default-image.jpg?ik-sdk-version=ruby-#{Imagekit::Sdk::VERSION}&γειασας=γειασας")
+  end
+
   it "test_generate_url_with_src_checking_query_param_added" do
     request_obj=ImageKitRequest.new(@private_key,@public_key,@url_endpoint)
     url_obj = Url.new(request_obj)
@@ -256,6 +345,27 @@
 
   end
 
+  it "test_generate_url_with_src_with_special_characters" do
+    # Test url generation with src param
+    request_obj=ImageKitRequest.new(@private_key,@public_key,@url_endpoint)
+    url_obj = Url.new(request_obj)
+
+    options = {src: "https://www.Fjällräve.com/γειασας/Fjällräven_KnSJwp87u6q.png",
+      transformation: [{height: "300",
+                        width: "400",
+                        format: "jpg",
+                        progressive: "true",
+                        effect_sharpen: "-",
+                        effect_contrast: "1",},
+                       {rotation: 90},],
+      transformation_position: "query"}
+
+    url = url_obj.generate_url(options)
+    
+    expect(url).to eq("https://www.Fjällräve.com/γειασας/Fjällräven_KnSJwp87u6q.png?ik-sdk-version=ruby-#{Imagekit::Sdk::VERSION}&tr=h-300,w-400,f-jpg,pr-true,e-sharpen,e-contrast-1:rt-90")
+
+  end
+
   it "test_generate_url_with_src_and_query_parameters_is_path" do
     request_obj=ImageKitRequest.new(@private_key,@public_key,@url_endpoint)
     url_obj = Url.new(request_obj)
@@ -289,6 +399,20 @@
     expect(url).to include("https://ik.imagekit.io/your_imagekit_id/endpoint/tr:h-300,w-400/default-image.jpg?ik-sdk-version=ruby-#{Imagekit::Sdk::VERSION}&ik-s=")
   end
 
+  it "test_generate_url_with_path_and_signed_with_special_characters" do
+    request_obj=ImageKitRequest.new(@private_key,@public_key,@url_endpoint)
+    url_obj = Url.new(request_obj)
+
+    options = {path: "/Fjällräven_KnSJwp87u6q.png",
+      url_endpoint: "https://ik.imagekit.io/your_imagekit_id/endpoint/",
+      transformation: [{height: "300", width: "400"}],
+      signed: true,}
+
+    url = url_obj.generate_url(options)
+
+    expect(url).to include("https://ik.imagekit.io/your_imagekit_id/endpoint/tr:h-300,w-400/Fjällräven_KnSJwp87u6q.png?ik-sdk-version=ruby-#{Imagekit::Sdk::VERSION}&ik-s=")
+  end
+
   it "test_url_with_invalid_args_returns_as_it_is" do
     request_obj=ImageKitRequest.new(@private_key,@public_key,@url_endpoint)
     url_obj = Url.new(request_obj)