Merge branch 'master' into feat-update-dart-flutter-test

Author: lohanidamodar

CONTRIBUTING.md

@@ -139,19 +139,21 @@ The following checklist aims to balance consistency among languages, and follow
     - [ ] Default Headers
         - [ ] 'appwrite-sdk-version' header
         - [ ] Add 'User-Agent' header with device/server name and version + platform name and version (ubuntu-20.04-php-7.0.1 / android-20.0-flutter-3.0)
+        - [ ] Add 'origin' header with the following syntax `<scheme>://<identifier>` where scheme is one of `http`, `https`, `appwrite-android`, `appwrite-ios`, `appwrite-macos`, `appwrite-windows`, `appwrite-linux` and identifier is the host name is case of web apps and the package name in case of ios, android and other platforms.
+        - [ ] All Global headers available in spec
     - [ ] Methods
         - [ ] addHeader(key, value)
         - [ ] call(method, path = '', headers = [], params = [])
             - [ ] Concat GET params to path
             - [ ] Parse request params by content type header
             - [ ] Parse response params by content type header
             - [ ] Throw error on bad response
+    - [ ] Handle errors and throw `AppwriteException` with proper information
 - [ ] Service Abstraction (optional)
     - [ ] Constructor receiving an instance of the client class 
 - [ ] Service Class (extends the service abstraction if exists)
     - [ ] Headers Support (Content Type)
     - [ ] Parameters Support
-        - [ ] Default Values Support
         - [ ] Required Values Support
         - [ ] String Support
         - [ ] Integer Support
@@ -183,6 +185,8 @@ After you finish initializing, make a series of HTTP calls using your new genera
 1. tests/languages/tests-for-php.js
 2. tests/languages/tests-for-node.js
 
+> Note: In your test files, make sure that you begin the test with the following string "\nTest Started\n". We use this string to filter output from the build tool you're using.
+
 Once done, add a Docker command that can execute your test file to the SDK test algorithm `$containers` array in this location: `./tests/SDKTest.php:17`. Make sure to add one command for each language version you wish to support.
 
 A good example is the PHP test for 5 different PHP versions:
@@ -200,5 +204,5 @@ protected $containers = [
 
 Finally, you can run the tests using
 ```sh
-docker run --rm -v $(pwd):/app:rw -w /app -v /var/run/docker.sock:/var/run/docker.sock  php:7.4-cli-alpine sh -c "apk add docker-cli && vendor/bin/phpunit tests/SDKTest.php"
+docker run --rm -v $(pwd):$(pwd):rw -w $(pwd) -v /var/run/docker.sock:/var/run/docker.sock  php:7.4-cli-alpine sh -c "apk add docker-cli && vendor/bin/phpunit tests/SDKTest.php"
 ```

composer.lock

@@ -12,13 +12,12 @@
 use Appwrite\SDK\Language\Ruby;
 use Appwrite\SDK\Language\Dart;
 use Appwrite\SDK\Language\Go;
-use Appwrite\SDK\Language\Java;
-use Appwrite\SDK\Language\Typescript;
 use Appwrite\SDK\Language\Deno;
 use Appwrite\SDK\Language\HTTP;
 use Appwrite\SDK\Language\Swift;
 use Appwrite\SDK\Language\DotNet;
 use Appwrite\SDK\Language\Flutter;
+use Appwrite\SDK\Language\Android;
 use Appwrite\SDK\Language\Kotlin;
 
 try {
@@ -38,7 +37,7 @@ function getSSLPage($url) {
     //$spec = getSSLPage('https://appwrite.io/v1/open-api-2.json?extensions=1');
     // $spec = getSSLPage('https://appwrite.io/v1/open-api-2.json?extensions=1'); // Enable only with Appwrite local server running on port 80
     // $spec = getSSLPage('https://appwrite.io/v1/open-api-2.json?extensions=1&platform=console'); // Enable only with Appwrite local server running on port 80
-    
+    // $spec = file_get_contents('https://appwrite.io/specs/swagger2?platform=client');
     $spec = file_get_contents('./specs/swagger-appwrite.0.8.0.json');
 
     if(empty($spec)) {
@@ -97,30 +96,6 @@ function getSSLPage($url) {
 
     $sdk->generate(__DIR__ . '/examples/web');
 
-    // TypeScript
-    $sdk  = new SDK(new Typescript(), new Swagger2($spec));
-
-    $sdk
-        ->setName('NAME')
-        ->setDescription('Repo description goes here')
-        ->setShortDescription('Repo short description goes here')
-        ->setVersion('0.0.0')
-        ->setURL('https://example.com')
-        ->setLogo('https://appwrite.io/v1/images/console.png')
-        ->setLicenseContent('test test test')
-        ->setWarning('**WORK IN PROGRESS - NOT READY FOR USAGE**')
-        ->setChangelog('**CHANGELOG**')
-        ->setGitUserName('repoowner')
-        ->setGitRepoName('reponame')
-        ->setTwitter('appwrite_io')
-        ->setDiscord('564160730845151244', 'https://appwrite.io/discord')
-        ->setDefaultHeaders([
-            'X-Appwrite-Response-Format' => '0.7.0',
-        ])
-    ;
-
-    $sdk->generate(__DIR__ . '/examples/typescript');
-
     // Deno
     $sdk  = new SDK(new Deno(), new Swagger2($spec));
 
@@ -293,31 +268,6 @@ function getSSLPage($url) {
 
     $sdk->generate(__DIR__ . '/examples/go');
 
-    // Java
-
-    $sdk  = new SDK(new Java(), new Swagger2($spec));
-
-    $sdk
-        ->setName('NAME')
-        ->setNamespace('io appwrite')
-        ->setDescription('Repo description goes here')
-        ->setShortDescription('Repo short description goes here')
-        ->setURL('https://example.com')
-        ->setGitUserName('appwrite')
-        ->setGitRepoName('java-sdk')
-        ->setLogo('https://appwrite.io/v1/images/console.png')
-        ->setLicenseContent('test test test')
-        ->setWarning('**WORK IN PROGRESS - NOT READY FOR USAGE**')
-        ->setChangelog('**CHANGELOG**')
-        ->setVersion('0.0.1')
-        ->setTwitter('appwrite_io')
-        ->setDiscord('564160730845151244', 'https://appwrite.io/discord')
-        ->setDefaultHeaders([
-            'X-Appwrite-Response-Format' => '0.7.0',
-        ])
-    ;
-
-    $sdk->generate(__DIR__ . '/examples/java');
 
     // Swift
     $sdk  = new SDK(new Swift(), new Swagger2($spec));
@@ -420,8 +370,32 @@ function getSSLPage($url) {
     ;
     $sdk->generate(__DIR__ . '/examples/CLI');
 
-    // Kotlin
+    // Android
 
+    $sdk = new SDK(new Android(), new Swagger2($spec));
+    
+    $sdk
+        ->setName('Android')
+        ->setNamespace('io appwrite')
+        ->setDescription('Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Flutter SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to https://appwrite.io/docs')
+        ->setShortDescription('Appwrite Android SDK')
+        ->setURL('https://example.com')
+        ->setGitUserName('appwrite')
+        ->setGitRepoName('sdk-for-android')
+        ->setLogo('https://appwrite.io/v1/images/console.png')
+        ->setLicenseContent('test test test')
+        ->setWarning('**This SDK is compatible with Appwrite server version 0.7.x. For older versions, please check previous releases.**')
+        ->setChangelog('**CHANGELOG**')
+        ->setVersion('0.0.0-SNAPSHOT')
+        ->setTwitter('appwrite_io')
+        ->setDiscord('564160730845151244', 'https://appwrite.io/discord')
+        ->setDefaultHeaders([
+            'x-appwrite-response-format' => '0.7.0',
+        ])
+    ;
+    $sdk->generate(__DIR__ . '/examples/android');
+
+    // Kotlin
     $sdk = new SDK(new Kotlin(), new Swagger2($spec));
 
     $sdk
@@ -435,95 +409,15 @@ function getSSLPage($url) {
         ->setLogo('https://appwrite.io/v1/images/console.png')
         ->setLicenseContent('test test test')
         ->setWarning('**This SDK is compatible with Appwrite server version 0.7.x. For older versions, please check previous releases.**')
-        ->setGettingStarted("
-### Add your Android Platform
-To init your SDK and start interacting with Appwrite services, you need to add a new Flutter platform to your project. To add a new platform, go to your Appwrite console, choose the project you created in the step before, and click the 'Add Platform' button.
-
-From the options, choose to add a new **Flutter** platform and add your app credentials, ignoring iOS.
-
-Add your app <u>name</u> and <u>package name</u>, Your package name is generally the applicationId in your app-level build.gradle file. By registering your new app platform, you are allowing your app to communicate with the Appwrite API.
-
-### OAuth
-In order to capture the Appwrite OAuth callback url, the following activity needs to be added to your [AndroidManifest.xml](https://github.com/appwrite/playground-for-flutter/blob/master/android/app/src/main/AndroidManifest.xml). Be sure to relpace the **[PROJECT_ID]** string with your actual Appwrite project ID. You can find your Appwrite project ID in you project settings screen in your Appwrite console.
-
-```xml
-<manifest>
-    <application>
-        <activity android:name=\"io.appwrite.views.CallbackActivity\" >
-            <intent-filter android:label=\"android_web_auth\">
-                <action android:name=\"android.intent.action.VIEW\" />
-                <category android:name=\"android.intent.category.DEFAULT\" />
-                <category android:name=\"android.intent.category.BROWSABLE\" />
-                <data android:scheme=\"appwrite-callback-[PROJECT_ID]\" />
-            </intent-filter>
-        </activity>
-    </application>
-</manifest>
-```
-
-### Init your SDK
-
-<p>Initialize your SDK code with your project ID, which can be found in your project settings page.
-
-```kotlin
-import io.appwrite.Client
-import io.appwrite.services.Account
-
-val client = Client(context)
-  .setEndpoint(\"https://[HOSTNAME_OR_IP]/v1\") // Your API Endpoint
-  .setProject(\"5df5acd0d48c2\") // Your project ID
-  .setSelfSigned(true) // Remove in production
-```
-
-Before starting to send any API calls to your new Appwrite instance, make sure your Android emulators has network access to the Appwrite server hostname or IP address.
-
-When trying to connect to Appwrite from an emulator or a mobile device, localhost is the hostname for the device or emulator and not your local Appwrite instance. You should replace localhost with your private IP as the Appwrite endpoint's hostname. You can also use a service like [ngrok](https://ngrok.com/) to proxy the Appwrite API.
-
-### Make Your First Request
-
-<p>Once your SDK object is set, access any of the Appwrite services and choose any request to send. Full documentation for any service method you would like to use can be found in your SDK documentation or in the API References section.
-
-```kotlin
-// Register User
-val accountService = Account(client)
-val user = accountService.create(
-    \"[email protected]\", 
-    \"password\"
-)
-```
-
-### Full Example
-
-```kotlin
-import io.appwrite.Client
-import io.appwrite.services.Account
-
-val client = Client(context)
-  .setEndpoint(\"https://[HOSTNAME_OR_IP]/v1\") // Your API Endpoint
-  .setProject(\"5df5acd0d48c2\") // Your project ID
-  .setSelfSigned(true) // Remove in production
-
-val accountService = Account(client)
-val user = accountService.create(
-    \"[email protected]\", 
-    \"password\"
-)
-```
-
-### Learn more
-You can use following resources to learn more and get help
-- 📜 [Appwrite Docs](https://appwrite.io/docs)
-- 💬 [Discord Community](https://appwrite.io/discord)
-        ")
         ->setChangelog('**CHANGELOG**')
-        ->setVersion('0.7.0')
+        ->setVersion('0.0.0-SNAPSHOT')
         ->setTwitter('appwrite_io')
         ->setDiscord('564160730845151244', 'https://appwrite.io/discord')
         ->setDefaultHeaders([
-            'x-appwrite-response-format' => '0.7.0',
+            'x-appwrite-response-format' => '0.8.0',
         ])
     ;
-    $sdk->generate(__DIR__ . '/examples/kotlin-android');
+    $sdk->generate(__DIR__ . '/examples/kotlin');
 }
 catch (Exception $exception) {
     echo 'Error: ' . $exception->getMessage() . ' on ' . $exception->getFile() . ':' . $exception->getLine() . "\n";