Merge pull request #353 from phaus/go-templates-update

Author: lohanidamodar

.gitignore

@@ -8,13 +8,19 @@
 .env
 .envrc
 .hatch
+
 # exclude everything
 examples/*
+tests/tmp
+.phpunit.result.cache
 
 # exception to the rule
-!examples/.gitkeep
+!examples/.gitkeep 
+
 **/.DS_Store
 templates/swift/example/.build
 templates/swift/example/Example.xcodeproj/project.xcworkspace/xcuserdata
 templates/swift/example/Example.xcodeproj/xcuserdata
 **/xcuserdata
+# exclude go checksum files
+go.sum

.travis.yml

@@ -25,6 +25,8 @@ env:
   - SDK=DartStable
   - SDK=Deno1171
   - SDK=FlutterStable
+  - SDK=Go112
+  - SDK=Go118
   - SDK=FlutterBeta
   - SDK=KotlinJava8
   - SDK=KotlinJava11

README.md

@@ -100,7 +100,7 @@ $sdk->generate(__DIR__ . '/examples/php'); // Generate source code
 | Ruby       | 2.4+                | [Ruby Style Guide]     | GEM                | [@eldadfux] [@abnegate] |
 | Python     | 3.5+                | [PEP8]                 | PIP                | [@eldadfux] [@abnegate] |
 | Dart       | 2.7+                | [Effective Dart]       | pub                | [@lohanidamodar] |
-| Go         |                     | [Effective Go]         | go get             | [@panz3r]      |
+| Go         |                     | [Effective Go]         | go get             | [@panz3r] [@phaus]      |
 | .NET       | .NET core 3.1       | [C# Coding Conventions]| NuGet              | [@komemi] [@TorstenDittmann]     |
 | D          |                     |                        | ?                  | [You?](https://github.com/appwrite/sdk-generator/issues/20) |
 | Kotlin     | 1.4.31+             | [Kotlin style guide]   | Gradle, Maven      | [@abnegate]    |

example.php

@@ -299,8 +299,9 @@ function getSSLPage($url) {
         ->setDescription('Repo description goes here')
         ->setShortDescription('Repo short description goes here')
         ->setURL('https://example.com')
+        ->setVersion('0.0.1')
         ->setGitUserName('appwrite')
-        ->setGitRepoName('go-sdk')
+        ->setGitRepoName('sdk-for-go')
         ->setLogo('https://appwrite.io/v1/images/console.png')
         ->setLicenseContent('test test test')
         ->setWarning('**WORK IN PROGRESS - NOT READY FOR USAGE**')

src/SDK/Language/Go.php

@@ -59,7 +59,13 @@ public function getFiles()
         return [
             [
                 'scope'         => 'default',
-                'destination'   => 'main.go',
+                'destination'   => 'go.mod',
+                'template'      => 'go/go.mod.twig',
+                'minify'        => false,
+            ],
+            [
+                'scope'         => 'default',
+                'destination'   => 'example/main.go',
                 'template'      => 'go/main.go.twig',
                 'minify'        => false,
             ],
@@ -83,19 +89,13 @@ public function getFiles()
             ],
             [
                 'scope'         => 'default',
-                'destination'   => 'client.go',
+                'destination'   => '{{ spec.title | caseLower}}/client.go',
                 'template'      => 'go/client.go.twig',
                 'minify'        => false,
             ],
-            [
-                'scope'         => 'default',
-                'destination'   => 'utils.go',
-                'template'      => 'go/utils.go.twig',
-                'minify'        => false,
-            ],
             [
                 'scope'         => 'service',
-                'destination'   => '{{service.name | caseDash}}.go',
+                'destination'   => '{{ spec.title | caseLower}}/{{service.name | caseDash}}.go',
                 'template'      => 'go/services/service.go.twig',
                 'minify'        => false,
             ],
@@ -117,19 +117,18 @@ public function getTypeName($type)
         switch ($type) {
             case self::TYPE_INTEGER:
                 return 'int';
-            break;
+            case self::TYPE_NUMBER:
+                return 'float64';
             case self::TYPE_STRING:
                 return 'string';
-            break;
             case self::TYPE_FILE:
                 return 'string'; // '*os.File';
-            break;
             case self::TYPE_BOOLEAN:
                 return 'bool';
-            break;
+            case self::TYPE_OBJECT:
+                return 'interface{}';
             case self::TYPE_ARRAY:
-                 return '[]interface{}';
-            break;
+                return '[]interface{}';
         }
 
         return $type;
@@ -161,6 +160,9 @@ public function getParamDefault(array $param)
                 case self::TYPE_STRING:
                     $output .= '""';
                     break;
+                case self::TYPE_OBJECT:
+                    $output .= 'nil';
+                    break;
                 case self::TYPE_ARRAY:
                     $output .= '[]';
                     break;
@@ -173,11 +175,14 @@ public function getParamDefault(array $param)
                 case self::TYPE_ARRAY:
                     $output .= $default;
                     break;
+                case self::TYPE_OBJECT:
+                    $output .= "\"$default\"";
+                    break;
                 case self::TYPE_BOOLEAN:
                     $output .= ($default) ? 'true' : 'false';
                     break;
                 case self::TYPE_STRING:
-                    $output .= "\"{$default}\"";
+                    $output .= "nil";
                     break;
             }
         }
@@ -206,6 +211,9 @@ public function getParamExample(array $param)
                 case self::TYPE_STRING:
                     $output .= '""';
                     break;
+                case self::TYPE_OBJECT:
+                    $output .= 'nil';
+                    break;
                 case self::TYPE_ARRAY:
                     $output .= '[]';
                     break;
@@ -221,6 +229,9 @@ public function getParamExample(array $param)
                 case self::TYPE_ARRAY:
                     $output .= $example;
                     break;
+                case self::TYPE_OBJECT:
+                    $output .= 'nil';
+                    break;
                 case self::TYPE_BOOLEAN:
                     $output .= ($example) ? 'true' : 'false';
                     break;

templates/go/CHANGELOG.md.twig

@@ -1 +1,4 @@
-{{sdk.changelog}}
+# {{sdk.changelog}}
+
+## {{sdk.version}}
+  

templates/go/README.md.twig

@@ -2,7 +2,7 @@
 
 ![License](https://img.shields.io/github/license/{{ sdk.gitUserName|url_encode }}/{{ sdk.gitRepoName|url_encode }}.svg?style=flat-square)
 ![Version](https://img.shields.io/badge/api%20version-{{ spec.version|url_encode }}-blue.svg?style=flat-square)
-[![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
+[![Build Status](https://img.shields.io/travis/com/{{ sdk.gitUserName|url_encode }}/sdk-generator?style=flat-square)](https://travis-ci.com/{{ sdk.gitUserName|url_encode }}/sdk-generator)
 {% if sdk.twitterHandle %}
 [![Twitter Account](https://img.shields.io/twitter/follow/{{ sdk.twitterHandle }}?color=00acee&label=twitter&style=flat-square)](https://twitter.com/{{ sdk.twitterHandle }})
 {% endif %}
@@ -25,18 +25,77 @@
 To install using `go get`:
 
 ```bash
-go get github.com/{{ sdk.gitUserName|url_encode }}/{{ sdk.gitRepoName|url_encode }}
+go get github.com/{{ sdk.gitUserName }}/{{ sdk.gitRepoName }}
 ```
 
+## Testing the SDK
+
+* clone this repo.
+* create a project and within this project a collection.
+* configure the documents in the collection to have a _key_ = __hello__.
+* Then inject these environment variables:
+
+  ```bash
+  export YOUR_ENDPOINT=https://{{ sdk.gitUserName|url_encode }}.io/v1  
+  export YOUR_PROJECT_ID=6…8  
+  export YOUR_KEY="7055781…cd95"  
+  export COLLECTION_ID=616a095b20180  
+  ```
+
+Create `main.go` file with:
+
+```go
+package main
+
+import (
+	"log"
+	"os"
+	"time"
+
+	"github.com/{{sdk.gitUserName}}/sdk-for-go/{{ sdk.gitRepoName|url_encode }}"
+)
+
+func main() {
+	client := {{ sdk.gitRepoName|url_encode }}.NewClient(10 * time.Second)
+	client.SetEndpoint(os.Getenv("YOUR_ENDPOINT"))
+	client.SetProject(os.Getenv("YOUR_PROJECT_ID"))
+	client.SetKey(os.Getenv("YOUR_KEY"))
+
+	db := {{ sdk.gitRepoName|url_encode }}.NewDatabase(client)
+	data := map[string]string{
+		"hello": "world",
+	}
+	var EmptyArray = []interface{}{}
+	doc, err := db.CreateDocument(
+		os.Getenv("COLLECTION_ID"),
+		data,
+		EmptyArray,
+		EmptyArray,
+		"",
+		"",
+		"",
+	)
+	if err != nil {
+		log.Printf("Error creating document: %v", err)
+	}
+	log.Printf("Created document: %v", doc)
+}
+```
+
+* After that, run the following
+
+  > % go run main.go  
+  > 2021/10/16 03:41:17 Created document: map[$collection:616a095b20180 $id:616a2dbd4df16 $permissions:map[read:[] write:[]] hello:world]  
+
 {% if sdk.gettingStarted %}
 
 {{ sdk.gettingStarted|raw }}
 {% endif %}
 
 ## Contribution
 
-This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.
+This library is auto-generated by {{ spec.title }} custom [SDK Generator](https://github.com/{{ sdk.gitUserName|url_encode }}/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/{{ sdk.gitUserName|url_encode }}/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.
 
 ## License
 
-Please see the [{{spec.licenseName}} license]({{spec.licenseURL}}) file for more information.
+Please see the [{{spec.licenseName}} license]({{spec.licenseURL}}) file for more information.