Use functional options for optional arguments

In order to implement equivalent of optional arguments, functional optionals are used.

Author: Suven-p

src/SDK/Language/Go.php

@@ -115,14 +115,19 @@ public function getFiles(): array
             ],
             [
                 'scope'         => 'service',
-                'destination'   => '{{ spec.title | caseLower}}/{{service.name | caseDash}}.go',
+                'destination'   => '{{ service.name | caseLower}}/{{service.name | caseDash}}.go',
                 'template'      => 'go/services/service.go.twig',
             ],
             [
                 'scope'         => 'method',
                 'destination'   => 'docs/examples/{{service.name | caseLower}}/{{method.name | caseDash}}.md',
                 'template'      => 'go/docs/example.md.twig',
             ],
+            [
+                'scope'         => 'definition',
+                'destination'   => '{{ spec.title | caseLower}}models/{{ definition.name | caseLower }}.go',
+                'template'      => 'go/models/model.go.twig',
+            ],
         ];
     }
 
@@ -139,7 +144,7 @@ public function getTypeName(array $parameter): string
             case self::TYPE_NUMBER:
                 return 'float64';
             case self::TYPE_FILE:
-                return 'InputFile';
+                return 'appwrite.InputFile';
             case self::TYPE_STRING:
                 return 'string';
             case self::TYPE_BOOLEAN:
@@ -275,6 +280,41 @@ public function getFilters(): array
                 }
                 return implode("\n" . $indent, $value);
             }, ['is_safe' => ['html']]),
+            new TwigFilter('propertyType', function (array $property, array $spec, string $generic = 'interface{}') {
+                return $this->getPropertyType($property, $spec, $generic);
+            }),
+            new TwigFilter('returnType', function (array $method, array $spec, string $namespace, string $generic = 'T') {
+                return $this->getReturnType($method, $spec, $namespace, $generic);
+            }),
         ];
     }
+
+    protected function getPropertyType(array $property, array $spec, string $generic = 'interface{}'): string
+    {
+        $type = $this->getTypeName($property);
+        return $type;
+    }
+
+    protected function getReturnType(array $method, array $spec, string $namespace, string $generic = 'T'): string
+    {
+        if ($method['type'] === 'webAuth') {
+            return 'bool';
+        }
+        if ($method['type'] === 'location') {
+            return '[]byte';
+        }
+
+        if (
+            !\array_key_exists('responseModel', $method)
+            || empty($method['responseModel'])
+            || $method['responseModel'] === 'any'
+        ) {
+            return 'interface{}';
+        }
+
+        $ret = ucfirst($method['responseModel']);
+
+
+        return $namespace . 'Model.' . $ret;
+    }
 }

templates/go/base/params.twig

@@ -1,14 +1,19 @@
-	params := map[string]interface{}{
-{% for parameter in method.parameters.query %}
-		"{{ parameter.name }}": {{ parameter.name | caseUcfirst }},
-{% endfor %}
-{% for parameter in method.parameters.body %}
-		"{{ parameter.name }}": {{ parameter.name | caseUcfirst }},
-{% endfor %}
+{% if method.parameters.all|filter(v => not v.required)|length > 0 %}
+	options := &{{(method.name ~ "Options") | caseUcfirst}}{}
+	for _, opt := range optionalSetters {
+		opt(options)
 	}
-
+{% endif %}
+	params := map[string]interface{}{}
+{% for parameter in method.parameters.all %}
+{% if parameter.required %}
+	params["{{ parameter.name }}"] = {{ parameter.name | caseUcfirst }}
+{% else %}
+	params["{{ parameter.name }}"] = options.{{ parameter.name | caseUcfirst }}
+{% endif %}
+{% endfor %}
 	headers := map[string]interface{}{
 {% for key, header in method.headers %}
 		"{{ key }}": "{{ header }}",
 {% endfor %}
-	}
+	}

templates/go/base/requests/api.twig

@@ -1 +1,17 @@
-	return srv.client.Call("{{ method.method | caseUpper }}", path, headers, params)
+	resp, err := srv.client.Call("{{ method.method | caseUpper }}", path, headers, params)
+	if err != nil {
+		return nil, err
+	}
+	var parsed {{ method | returnType(spec, spec.title | caseLower) }}
+	if strings.HasPrefix(resp.Type, "application/json") {
+		err = json.Unmarshal([]byte(resp.Result.(string)), &parsed)
+		if err != nil {
+			return nil, err
+		}
+		return &parsed, nil
+	}
+	parsed, ok := resp.Result.({{ method | returnType(spec, spec.title | caseLower) }})
+	if !ok {
+		return nil, errors.New("unexpected response type")
+	}
+	return &parsed, nil

templates/go/base/requests/file.twig

@@ -12,4 +12,12 @@
 {% endif %}
 {% endfor %}
 
-    return srv.client.FileUpload(path, headers, params, paramName, uploadId)
+    resp, err := srv.client.FileUpload(path, headers, params, paramName, uploadId)
+    if err != nil {
+		return nil, err
+	}
+	parsed, ok := resp.Result.({{ method | returnType(spec, spec.title | caseLower) }})
+	if !ok {
+		return nil, errors.New("Unexpected response type")
+	}
+	return &parsed, nil

templates/go/client.go.twig

@@ -37,6 +37,7 @@ type ClientResponse struct {
 	StatusCode int
 	Header     http.Header
 	Result     interface{}
+	Type	   string
 }
 
 func (ce *{{ spec.title | caseUcfirst }}Error) Error() string {
@@ -347,11 +348,12 @@ func (clt *Client) Call(method string, path string, headers map[string]interface
 		return nil, err
 	}
 
-	var isJson = strings.HasPrefix(resp.Header.Get("content-type"), "application/json")
+	contentType := resp.Header.Get("content-type")
+	var isJson = strings.HasPrefix(contentType, "application/json")
 	if isJson {
-		var jsonResponse map[string]interface{}
-		json.Unmarshal(responseData, &jsonResponse)
 		if resp.StatusCode < 200 || resp.StatusCode > 399 {
+			var jsonResponse map[string]interface{}
+			json.Unmarshal(responseData, &jsonResponse)
 			message, ok := jsonResponse["message"].(string)
 			if !ok {
 				message = "N/A"
@@ -365,10 +367,11 @@ func (clt *Client) Call(method string, path string, headers map[string]interface
 			Status:     resp.Status,
 			StatusCode: resp.StatusCode,
 			Header:     resp.Header,
-			Result:     jsonResponse,
+			Result:     string(responseData),
+			Type:	   contentType,
 		}, nil
 	}
-	output, err := getOutput(params, fileNameKey, responseData, resp.Header.Get("content-type"))
+	output, err := getOutput(params, fileNameKey, responseData, contentType)
 	if err != nil {
 		return nil, err
 	}
@@ -383,6 +386,7 @@ func (clt *Client) Call(method string, path string, headers map[string]interface
 		StatusCode: resp.StatusCode,
 		Header:     resp.Header,
 		Result:     output,
+		Type:	   contentType,
 	}, nil
 }
 

templates/go/models/model.go.twig

@@ -0,0 +1,15 @@
+package {{ spec.title | caseLower }}Model
+
+
+{{ ((definition.description | caseUcfirst) ~ " Model") | godocComment }}
+type {{ definition.name | caseUcfirst }} struct {
+    {%~ for property in definition.properties %}
+    {{ property.description | godocComment(4) }}
+    {{ property.name | caseUcfirst  }} {{ property | propertyType(spec) }} `json:"{{ property.name | escapeKeyword }}"`
+    {%~ endfor %}
+
+    {%~ if definition.additionalProperties %}
+    // Additional properties
+    data interface{}
+    {%~ endif %}
+}

templates/go/services/service.go.twig

@@ -1,39 +1,79 @@
-{%- set requireStringsPkg = false -%}
+{%- set requireModelsPkg = false -%}
 {%- for method in service.methods -%}
-	{%- if method.parameters.path|length > 0 -%}
-		{%- set requireStringsPkg = true -%}
-	{%- endif -%}
+{%- if (method | returnType(spec, spec.title | caseLower)) starts with (spec.title | caseLower ~ "Model") -%}
+		{%- set requireModelsPkg = true -%}
+{%- endif -%}
 {%- endfor -%}
-package {{ spec.title | caseLower }}
+package {{ service.name | caseLower }}
 
 import (
-{% if requireStringsPkg %}
-	"strings"
+	"encoding/json"
+	"errors"
+{% if requireModelsPkg %}
+	"github.com/{{sdk.gitUserName}}/sdk-for-go/{{ spec.title | caseLower }}models"
 {% endif %}
+	"strings"
+	"github.com/{{sdk.gitUserName}}/sdk-for-go/{{ spec.title | caseLower }}"
 )
 
 {{ ((service.name | caseUcfirst) ~ " service") | godocComment }}
 type {{ service.name | caseUcfirst }} struct {
-	client Client
+	client {{ spec.title | caseLower }}.Client
 }
 
-func New{{ service.name | caseUcfirst }}(clt Client) *{{ service.name | caseUcfirst }} {
+func New{{ service.name | caseUcfirst }}(clt {{ spec.title | caseLower }}.Client) *{{ service.name | caseUcfirst }} {
 	return &{{ service.name | caseUcfirst }}{
 		client: clt,
 	}
 }
-{% for method in service.methods %}
 
+{% for method in service.methods %}
 {% if method.description %}{{ ((method.name | caseUcfirst) ~ ' ' ~ method.description | caseLcfirst) | godocComment }}{% else %}// {{ method.name | caseUcfirst }}{% endif %}
 
-func (srv *{{ service.name | caseUcfirst }}) {{ method.name | caseUcfirst }}({% if method.parameters.all|length > 0 %}{% for parameter in method.parameters.all %}{{ parameter.name | caseUcfirst }} {{ parameter | typeName }}{% if not loop.last %}, {% endif %}{% endfor %}{% endif %}) (*ClientResponse, error) {
+type {{ (method.name ~ "Options") | caseUcfirst }} struct {
+{% for parameter in method.parameters.all %}
+{% if not parameter.required %}
+	{{ parameter.name | caseUcfirst }} {{ (parameter | typeName) }}
+{% endif %}
+{% endfor %}
+}
+
+type {{ (method.name ~ "Option" ) | caseUcfirst }} func(*{{ (method.name ~ "Options") | caseUcfirst }})
+
+{% if method.parameters.all|filter(v => not v.required)|length > 0 %}
+{% for parameter in method.parameters.all|filter(v => not v.required) %}
+func With{{ method.name | caseUcfirst }}{{ parameter.name | caseUcfirst }}(v {{ (parameter | typeName) }}) {{ (method.name ~ "Option") | caseUcfirst }} {
+	return func(o *{{ (method.name ~ "Options") | caseUcfirst }}) {
+		o.{{ parameter.name | caseUcfirst }} = v
+	}
+}
+{% endfor %}
+{% endif %}
+
+{% set params="" %}
+{% if method.parameters.all|filter(v => v.required)|length > 0 %}
+{% for parameter in method.parameters.all|filter(v => v.required) %}
+	{% set params = params ~ (parameter.name | caseUcfirst) ~ " " ~ (parameter | typeName) %}
+{% if not loop.last %}
+	{% set params = params ~ ", " %}
+{% endif %}
+{% endfor %}
+{% if method.parameters.all|filter(v => not v.required)|length > 0 %}
+	{% set params = params ~ ", " %}
+{% endif %}
+{% endif %}
+{% if method.parameters.all|filter(v => not v.required)|length > 0 %}
+	{% set params = params ~ "optionalSetters ..." ~ ((method.name ~ "Option") | caseUcfirst) %}
+{% endif %}
+
+func (srv *{{ service.name | caseUcfirst }}) {{ method.name | caseUcfirst }}({{ params }})  (*{{ method | returnType(spec, spec.title | caseLower) }}, error) {
 {% if method.parameters.path|length > 0 %}
 	r := strings.NewReplacer({% for parameter in method.parameters.path %}"{{ '{' }}{{ parameter.name | caseCamel }}{{ '}' }}", {{ parameter.name | caseUcfirst }}{% if not loop.last %}, {% endif %}{% endfor %})
 	path := r.Replace("{{ method.path }}")
 
 {% else %}
 	path := "{{ method.path }}"
-	
+
 {% endif %}
 {{include('go/base/params.twig')}}
 {% if 'multipart/form-data' in method.consumes %}
@@ -42,4 +82,4 @@ func (srv *{{ service.name | caseUcfirst }}) {{ method.name | caseUcfirst }}({%
 {{ include('go/base/requests/api.twig') }}
 {% endif %}
 }
-{% endfor %}
+{% endfor %}