Merge pull request #15 from KhushbooMer/update-read-me

updated PR for change og

Author: imagekitio

README.md

@@ -119,27 +119,27 @@ This document presents a list of changes that break the existing functionality o
 
 Changes from 1.0.3 -> 2.0.0 are listed below
 
-1. Result raw object and getMap() properties:
+1. Result `raw` object and `getMap()` properties:
 
 **What changed**
-- raw and getMap() has been deprecated.
+- `raw` and `getMap()` has been deprecated.
 
 **Who is affected?**
-- This affects any development that uses the raw or getMap() from the response object of APIs and Result object.
+- This affects any development that uses the `raw` or `getMap()` from the response object of APIs and Result object.
 
 **How should I update my code?**
-- If you still need to use raw and getMap(), do this `result.getResponseMetaData().getRaw()`.
+- If you still need to use `raw` and `getMap()`, do this `result.getResponseMetaData().getRaw()`.
 
-2. Result object message and isSuccessful boolean properties:
+2. Result object `message` and `isSuccessful` boolean properties:
 
 **What changed**
-- message and isSuccessful have been replaced with custom exceptions according to response code.
+- `message` and `isSuccessful` have been replaced with custom exceptions according to response code.
 
 **Who is affected?**
-- This affects any development that uses the message or isSuccessful from response object of APIs that is Result object.
+- This affects any development that uses the `message` or `isSuccessful` from response object of APIs that is Result object.
 
 **How should I update my code?**
-- If you still need to use message it will be there in the custom exception and could be raised isSuccessful properties in your own code from status code that is coming in the response or custom exception.
+- If you still need to use `message` it will be there in the custom exception and could be raised `isSuccessful` properties in your own code from status code with `httpStatusCode` that is coming in the responseMetaData with `getResponseMetaData()` of response object or custom exception.
 
 
 ## URL generation
@@ -356,7 +356,7 @@ If you want to generate transformations in your application and add them to the
 The SDK provides a simple interface using the `.upload()` method to upload files to the ImageKit Media library. It
 accepts an object of the `FileCreateRequest` class that contains all the parameters supported by the [ImageKit Upload API](https://docs.imagekit.io/api-reference/upload-file-api/server-side-file-upload).
 
-The constructor `FileCreateRequest` class requires `file` as (URL/Base64/Byte Array) and `file_name`. If `file` is byte array then it's require another parameter named `mediaType` to upload a file. The method returns object of `Result` class. It contains method `isSuccessful()` (return boolean), `getMessage()` for error message and other file parameter responsed by server.
+The constructor `FileCreateRequest` class requires `file` as (URL/Base64/Byte Array) and `file_name`. The method returns object of `Result` in case of successful, or it will throw custom exception in case of failure.
 
 Sample usage
 
@@ -406,9 +406,9 @@ System.out.println("Map Response:");
 System.out.println(result.getResponseMetaData().getMap());
 ```
 
-If the upload is successful, `getMessage()` will be `None`, and the result will be an object of `Result` class that contains the same all the parameters received from ImageKit's servers, and `isSuccessful()` will return true.
+If the upload is successful, result will be there as an object of `Result` class that contains the same all the parameters received from ImageKit's servers.
 
-If the upload fails, `getMessage()` will contain the same error message received from ImageKit's servers, and `isSuccessful()` will return false.
+If the upload fails, custom exception getting thrown and by doinf`getMessage()` will contain the same error message received from ImageKit's servers.
 
 
 ## File Management

imagekit-sdk/src/test/java/io/imagekit/sdk/GetUrlTest.java

@@ -199,7 +199,7 @@ public void getUrl_with_transformation_parameters() {
 
 		String url = SUT.getUrl(options);
 		assertThat(
-				"https://ik.imagekit.io/your_imagekit_id/tr:cm-extract,ofo-top,n-any_name,md-true,ow-20,e-contrast-1,fo-left,bl-10,ar-4-3,oit-false,e-usm-,oa-,obg-00AAFF55,ots-18,t-5,oh-20,cp-true,r-20,ox-20,ot-Image%20Text,oy-10,otc-00FFFF,di-folder@@file.jpg,h-600,b-5-A94D34,orig-true,rt-90,dpr-3,f-png,raw-w-200,h-200,lo-true,e-grayscale-,q-40,ott-b,bg-A94D34,w-400,pr-true,e-sharpen,oi-folder@@file.jpg,c-force,otf-Open%20Sans/default-image.jpg",
+				"https://ik.imagekit.io/your_imagekit_id/tr:cm-extract,ofo-top,n-any_name,md-true,ow-20,e-contrast-1,oiar-oiar,fo-left,bl-10,ar-4-3,oit-oit,e-usm-,oidpr-oidpr,oa-,obg-00AAFF55,ots-18,t-5,oh-20,oic-oic,cp-true,r-20,ox-20,ot-Image%20Text,oy-10,otc-00FFFF,di-folder@@file.jpg,h-600,b-5-A94D34,orig-true,rt-90,dpr-3,f-png,raw-w-200,h-200,lo-true,e-grayscale-,oibg-oibg,q-40,ott-b,oib-oib,oiq-oiq,bg-A94D34,w-400,pr-true,e-sharpen,oi-oi,oifo-oifo,c-force,otf-Open%20Sans/default-image.jpg",
 				is(url));
 	}
 
@@ -453,7 +453,7 @@ public void getUrl_with_signature() {
 
 		String url = SUT.getUrl(options);
 
-		assertSignedUrl("https://ik.imagekit.io/zv3rkhsym/tr:w-100/test-signed-url.png", url);
+		assertSignedUrl("https://ik.imagekit.io/imagekit_id/tr:w-100/test-signed-url.png", url);
 	}
 
 	@Test

imagekit-sdk/src/test/java/io/imagekit/sdk/ImageKitTest.java

@@ -48,7 +48,7 @@ public void withTokenAndExpire_getAuthenticationParameters_successExpected() {
 		assertNotNull(auth);
 		assertEquals("your_token", auth.get("token"));
 		assertEquals("1582269249", auth.get("expire"));
-		assertEquals("98598e12a8eec9fedc883df4ae598618aaf24d87", auth.get("signature"));
+		assertEquals("e71bcd6031016b060d349d212e23e85c791decdd", auth.get("signature"));
 	}
 
 	@Test

imagekit-sdk/src/test/resources/config.properties

@@ -1,6 +1,6 @@
 # Copy this sample file add rename it to "config.properties"
 # Put essential values of keys [UrlEndpoint, PrivateKey, PublicKey]
 
-UrlEndpoint=https://ik.imagekit.io/zv3rkhsym
-PrivateKey=private_kwTU4AR9Ei5hBoTIuxCW63Dg2jM=
-PublicKey=public_SSvmi6RknpNXj9x1cQnra1sYpJg=
+UrlEndpoint=https://ik.imagekit.io/imagekit_id
+PrivateKey=private_key_test
+PublicKey=public_key_test