refactored

Author: bishosilwal

README.md

@@ -690,6 +690,72 @@ imagekitio.delete_custom_metadata_field(
 )
 ```
 
+**28. Response hash**
+
+Each file management function returns a hash with response, error, status, headers, raw_body keys with respective values.
+
+```ruby
+upload = imagekitio.upload_file(
+    file: file,
+    file_name:  "default.jpg",
+    folder: '/test',
+    response_fields: 'tags,customCoordinates,isPrivateFile,metadata',
+    tags: %w[abc def],
+    use_unique_file_name: false,
+    is_private_file: true
+)
+puts upload
+
+***** Success Output *****
+
+    {:headers=>
+      {"access-control-allow-origin"=>["*"],
+       "x-ik-requestid"=>["6963194e-014f-8945-b05a-bdb0e088f1bd"],
+       "content-type"=>["application/json; charset=utf-8"],
+       "content-length"=>["611"],
+       "etag"=>["W/\"859-GOeZiRFGOZERjHBgRUhG0EGcODs\""],
+       "date"=>["Wed, 29 Jun 2022 07:04:33 GMT"],
+       "x-request-id"=>["6963194e-014f-8945-b05a-bdb0e088f1bd"],
+       "connection"=>["close"]},
+     :raw_body=>
+      "{\"fileId\":\"62bjf980rb886bd691b86760\",\"name\":\"default.jpg\",\"size\":102117,\"versionInfo\":{\"id\":\"62bjf980rb886bd691b86760\",\"name\":\"Version 1\"},\"filePath\":\"/test/default.jpg\",\"url\":\"https://ik.imagekit.io/46865sdf6sdf/test/default.jpg\",\"fileType\":\"image\",\"height\":700,\"width\":1050,\"thumbnailUrl\":\"https://ik.imagekit.io/46865sdf6sdf/tr:n-ik_ml_thumbnail/test/default.jpg\",\"tags\":[\"abc\",\"def\"],\"AITags\":null,\"isPrivateFile\":true,\"customCoordinates\":null,\"metadata\":{\"height\":700,\"width\":1050,\"size\":102117,\"format\":\"jpg\",\"hasColorProfile\":true,\"quality\":0,\"density\":72,\"hasTransparency\":false,\"exif\":{},\"pHash\":\"90249d9b1fc74367\"}}",
+     :status=>"200",
+     :response=>
+      {"fileId"=>"62bjf980rb886bd691b86760",
+       "name"=>"default.jpg",
+       "size"=>102117,
+       "versionInfo"=>{"id"=>"62bbf980fb877bd691b86760", "name"=>"Version 1"},
+       "filePath"=>"/test/default.jpg",
+       "url"=>"https://ik.imagekit.io/46865sdf6sdf/test/default.jpg",
+       "fileType"=>"image",
+       "height"=>700,
+       "width"=>1050,
+       "thumbnailUrl"=>"https://ik.imagekit.io/46865sdf6sdf/tr:n-ik_ml_thumbnail/test/default.jpg",
+       "tags"=>["abc", "def"],
+       "AITags"=>nil,
+       "isPrivateFile"=>true,
+       "customCoordinates"=>nil,
+       "metadata"=>{"height"=>700, "width"=>1050, "size"=>102117, "format"=>"jpg", "hasColorProfile"=>true, "quality"=>0, "density"=>72, "hasTransparency"=>false, "exif"=>{}, "pHash"=>"90249d9b1fc74367"}
+      }
+    }
+
+
+*** Error Output ***
+
+    {:headers=>
+      {"access-control-allow-origin"=>["*"],
+       "x-ik-requestid"=>["e8j51c37-d859-8794-b7f8-5370r27d96ec"],
+       "content-type"=>["application/json; charset=utf-8"],
+       "content-length"=>["143"],
+       "etag"=>["W/\"8f-UcD10NytfppO0fARK0FR+M8L68c\""],
+       "date"=>["Wed, 29 Jun 2022 07:23:33 GMT"],
+       "x-request-id"=>["e8j51c37-d859-8794-b7f8-5370r27d96ec"],
+       "connection"=>["close"]},
+     :raw_body=>"{\"message\":\"Your request contains invalid value for customMetadata parameter.\",\"help\":\"For support kindly contact us at [email protected] .\"}",
+     :status=>"400",
+     :error=>{"message"=>"Your request contains invalid value for customMetadata parameter.", "help"=>"For support kindly contact us at [email protected] ."}
+    }
+```
 
 ## Utility functions
 

lib/imagekitio/request.rb

@@ -43,19 +43,18 @@ def request(method, url, headers = create_headers, payload = nil)
           req = Net::HTTP::Post::Multipart.new uri.path, payload, headers
           resp = http.request(req)
           response[:headers] = resp.to_hash
-          response[:raw_body] = resp.body
-          resp_c = resp.code.to_i
-          if [400, 403].include?(resp_c)
-            raise RestClient::ExceptionWithResponse, OpenStruct.new({ body: resp.body, code: resp_c })
-          end
         else
-          RestClient.log = STDOUT
           resp = RestClient::Request.new(method: method,
                                          url: url,
                                          headers: headers,
                                          payload: payload).execute
           response[:headers] = resp.raw_headers
-          response[:raw_body] = resp.body
+        end
+        response[:raw_body] = resp.body
+        response[:status] = resp.code
+        resp_c = resp.code.to_i
+        if [400, 403].include?(resp_c)
+          raise RestClient::ExceptionWithResponse, OpenStruct.new({ body: resp.body, code: resp_c, headers: response[:headers] })
         end
         if (resp.code.to_i >= 200) && (resp.code.to_i < 204)
           content_type = resp.respond_to?(:headers) ? resp.headers[:content_type] : resp.content_type
@@ -69,6 +68,8 @@ def request(method, url, headers = create_headers, payload = nil)
         end
 
       rescue RestClient::ExceptionWithResponse => err
+        response[:status] = err.http_code if response[:status].nil?
+        response[:headers] = err.http_headers if response[:headers].nil?
         response[:error] = if err.http_code.to_i == 404
                              {'message': err.response.to_s}
                            else

lib/imagekitio/sdk/version.rb

@@ -1,5 +1,5 @@
 module ImageKitIo
   module Sdk
-    VERSION = '2.1.2'
+    VERSION = '2.2.0'
   end
 end

test/imagekit/api_service/file_test.rb

@@ -302,11 +302,16 @@
       expect(resp[:response]['versionInfo']['id']).to eq('my_file_id')
     end
 
-    it 'test_get_file_version_detail_failed_without_id' do
+    it 'test_get_file_version_detail_failed_without_file_id' do
       imagekit_request = ImageKitIo::Request.new(private_key, public_key, url_endpoint)
       SUT = file_api_service.new(imagekit_request)
-      expect{SUT.get_file_version_detail}.to raise_error(ArgumentError)
-      expect{SUT.get_file_version_detail(file_id: 'new_file_id')}.to raise_error(ArgumentError)
+      expect{SUT.get_file_version_detail(version_id: 'file_version_id')}.to raise_error(ArgumentError, 'file_id is required')
+    end
+
+    it 'test_get_file_version_detail_failed_without_version_id' do
+      imagekit_request = ImageKitIo::Request.new(private_key, public_key, url_endpoint)
+      SUT = file_api_service.new(imagekit_request)
+      expect{SUT.get_file_version_detail(file_id: 'my_file_id')}.to raise_error(ArgumentError, 'version_id is required')
     end
   end
 
@@ -341,7 +346,7 @@
       expect(resp[:response][1]['versionInfo']['name']).to eq('Version 1')
     end
 
-    it 'test_get_file_version_failed_without_id' do
+    it 'test_get_file_version_failed_without_file_id' do
       imagekit_request = ImageKitIo::Request.new(private_key, public_key, url_endpoint)
       SUT = file_api_service.new(imagekit_request)
       expect{SUT.get_file_versions}.to raise_error(ArgumentError)
@@ -375,11 +380,16 @@
       expect(resp[:response]['versionInfo']['name']).to eq('Version 2')
     end
 
-    it 'test_restore_file_version_failed_without_id' do
+    it 'test_restore_file_version_failed_without_file_id' do
+      imagekit_request = ImageKitIo::Request.new(private_key, public_key, url_endpoint)
+      SUT = file_api_service.new(imagekit_request)
+      expect{SUT.restore_file_version(version_id: 'my_file_version_id')}.to raise_error(ArgumentError, 'file_id is required')
+    end
+
+    it 'test_restore_file_version_failed_without_version_id' do
       imagekit_request = ImageKitIo::Request.new(private_key, public_key, url_endpoint)
       SUT = file_api_service.new(imagekit_request)
-      expect{SUT.restore_file_version}.to raise_error(ArgumentError)
-      expect{SUT.restore_file_version(file_id: 'new_file_id')}.to raise_error(ArgumentError)
+      expect{SUT.restore_file_version(file_id: 'my_file_id')}.to raise_error(ArgumentError, 'version_id is required')
     end
   end
 
@@ -409,11 +419,16 @@
       expect(resp[:response]['success']).to eq(true)
     end
 
-    it 'test_delete_file_version_failed_without_id' do
+    it 'test_delete_file_version_without_file_id' do
+      imagekit_request = ImageKitIo::Request.new(private_key, public_key, url_endpoint)
+      SUT = file_api_service.new(imagekit_request)
+      expect{SUT.delete_file_version(version_id: 'my_file_version_id')}.to raise_error(ArgumentError, 'file_id is required')
+    end
+
+    it 'test_delete_file_version_failed_without_version_id' do
       imagekit_request = ImageKitIo::Request.new(private_key, public_key, url_endpoint)
       SUT = file_api_service.new(imagekit_request)
-      expect{SUT.delete_file_version}.to raise_error(ArgumentError)
-      expect{SUT.delete_file_version(file_id: 'new_file_id')}.to raise_error(ArgumentError)
+      expect{SUT.delete_file_version(file_id: 'my_file_id')}.to raise_error(ArgumentError, 'version_id is required')
     end
   end
 

test/imagekit/api_service/folder_test.rb

@@ -85,6 +85,20 @@
         expect(@ac[:payload]).to eq("{\"sourceFolderPath\":\"my_folder\",\"destinationPath\":\"copied\",\"includeFileVersions\":false}")
         expect(resp[:body][:jobId]).to eq('123456')
       end
+
+      it 'test_copy_folder_with_include_versions_parameter' do
+        allow(req_obj)
+          .to receive(:request){|method,url,headers,payload| @ac={method: method, url: url, headers: headers, payload: payload}}
+                .and_return({code: 200, body: { jobId: '123456' }})
+        @sut = folder_api_service.new(req_obj)
+        source_folder = 'my_folder'
+        destination_path = 'copied'
+        resp = @sut.copy(source_folder_path: source_folder, destination_path: destination_path, include_file_versions: true)
+        expect(@ac[:url]).to eq("https://api.imagekit.io/v1/bulkJobs/copyFolder")
+        expect(@ac[:method]).to eq('post')
+        expect(@ac[:payload]).to eq("{\"sourceFolderPath\":\"my_folder\",\"destinationPath\":\"copied\",\"includeFileVersions\":true}")
+        expect(resp[:body][:jobId]).to eq('123456')
+      end
     end
 
     context 'move' do

test/imagekit/request_test.rb

@@ -84,6 +84,9 @@
       response = @request_obj.request(:post, 'https://www.exampleservererror/upload', nil, { multipart: true })
       expect(response).to have_key(:error)
       expect(response[:error]).to eq({"message"=>"Your account cannot be authenticated.", "help"=>"For support kindly contact us at [email protected] ."})
+      expect(response[:headers]).to eq({"content-type"=>["application/json"]})
+      expect(response[:raw_body]).to eq("{\"message\":\"Your account cannot be authenticated.\",\"help\":\"For support kindly contact us at [email protected] .\"}")
+      expect(response[:status]).to eq("403")
     end
 
     it 'test_response_headers' do