asana 1.0.2 → 2.0.0

package/codegen/swagger/README.md

@@ -0,0 +1,74 @@
+# Swagger Codegen for the AsanaPythonClientCodegen library
+
+## Overview
+This is a boiler-plate project to generate your own client library with Swagger.  Its goal is
+to get you started with the basic plumbing so you can put in your own logic.  It won't work without
+your changes applied.
+
+## What's Swagger?
+The goal of Swagger™ is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined via Swagger, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interfaces have done for lower-level programming, Swagger removes the guesswork in calling the service.
+
+
+Check out [OpenAPI-Spec](https://github.com/OAI/OpenAPI-Specification) for additional information about the Swagger project, including additional libraries with support for other languages and more. 
+
+## How do I use this?
+At this point, you've likely generated a client setup.  It will include something along these lines:
+
+```
+.
+|- README.md    // this file
+|- pom.xml      // build script
+|-- src
+|--- main
+|---- java
+|----- com.asana.codegen.AsanaPythonClientCodegenGenerator.java // generator file
+|---- resources
+|----- AsanaPythonClientCodegen // template files
+|----- META-INF
+|------ services
+|------- io.swagger.codegen.CodegenConfig
+```
+
+You _will_ need to make changes in at least the following:
+
+`AsanaPythonClientCodegenGenerator.java`
+
+Templates in this folder:
+
+`src/main/resources/AsanaPythonClientCodegen`
+
+Once modified, you can run this:
+
+```
+mvn package
+```
+
+In your generator project.  A single jar file will be produced in `target`.  You can now use that with codegen:
+
+```
+java -cp /path/to/swagger-codegen-cli.jar:/path/to/your.jar io.swagger.codegen.v3.cli.SwaggerCodegen -l AsanaPythonClientCodegen -i /path/to/swagger.yaml -o ./test
+```
+
+Now your templates are available to the client generator and you can write output values
+
+## But how do I modify this?
+The `ReadMe.java` has comments in it--lots of comments.  There is no good substitute
+for reading the code more, though.  See how the `ReadMe` implements `CodegenConfig`.
+That class has the signature of all values that can be overridden.
+
+For the templates themselves, you have a number of values available to you for generation.
+You can execute the `java` command from above while passing different debug flags to show
+the object you have available during client generation:
+
+```
+# The following additional debug options are available for all codegen targets:
+# -DdebugSwagger prints the OpenAPI Specification as interpreted by the codegen
+# -DdebugModels prints models passed to the template engine
+# -DdebugOperations prints operations passed to the template engine
+# -DdebugSupportingFiles prints additional data passed to the template engine
+
+java -DdebugOperations -cp /path/to/swagger-codegen-cli.jar:/path/to/your.jar io.swagger.codegen.Codegen -l AsanaPythonClientCodegen -i /path/to/swagger.yaml -o ./test
+```
+
+Will, for example, output the debug info for operations.  You can use this info
+in the `api.mustache` file.

package/codegen/swagger/pom.xml

@@ -0,0 +1,129 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>io.swagger</groupId>
+    <artifactId>AsanaClientCodegen-swagger-codegen</artifactId>
+    <packaging>jar</packaging>
+    <name>AsanaClientCodegen-swagger-codegen</name>
+    <version>1.0.0</version>
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-enforcer-plugin</artifactId>
+                <version>3.0.0-M1</version>
+                <executions>
+                    <execution>
+                        <id>enforce-maven</id>
+                        <goals>
+                            <goal>enforce</goal>
+                        </goals>
+                        <configuration>
+                            <rules>
+                                <requireMavenVersion>
+                                    <version>2.2.0</version>
+                                </requireMavenVersion>
+                            </rules>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>2.12</version>
+                <configuration>
+                    <systemProperties>
+                        <property>
+                            <name>loggerPath</name>
+                            <value>conf/log4j.properties</value>
+                        </property>
+                    </systemProperties>
+                    <argLine>-Xms512m -Xmx1500m</argLine>
+                    <parallel>methods</parallel>
+                    <forkMode>pertest</forkMode>
+                </configuration>
+            </plugin>
+
+            <!-- attach test jar -->
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-jar-plugin</artifactId>
+                <version>2.2</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>jar</goal>
+                            <goal>test-jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+                <configuration>
+                </configuration>
+            </plugin>
+
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>build-helper-maven-plugin</artifactId>
+                <version>${build-helper-maven-plugin}</version>
+                <executions>
+                    <execution>
+                        <id>add_sources</id>
+                        <phase>generate-sources</phase>
+                        <goals>
+                            <goal>add-source</goal>
+                        </goals>
+                        <configuration>
+                            <sources>
+                                <source>src/main/java</source>
+                            </sources>
+                        </configuration>
+                    </execution>
+                    <execution>
+                        <id>add_test_sources</id>
+                        <phase>generate-test-sources</phase>
+                        <goals>
+                            <goal>add-test-source</goal>
+                        </goals>
+                        <configuration>
+                            <sources>
+                                <source>src/test/java</source>
+                            </sources>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.6.1</version>
+                <configuration>
+                    <source>1.8</source>
+                    <target>1.8</target>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+    <dependencies>
+        <dependency>
+            <groupId>io.swagger.codegen.v3</groupId>
+            <artifactId>swagger-codegen</artifactId>
+            <version>${swagger-codegen-version}</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.swagger.codegen.v3</groupId>
+            <artifactId>swagger-codegen-generators</artifactId>
+            <version>${swagger-codegen-generators-version}</version>
+            <scope>provided</scope>
+        </dependency>
+    </dependencies>
+    <properties>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <swagger-codegen-version>3.0.44</swagger-codegen-version>
+        <swagger-codegen-generators-version>1.0.41</swagger-codegen-generators-version>
+        <maven-plugin-version>1.0.0</maven-plugin-version>
+        <junit-version>4.13.1</junit-version>
+        <build-helper-maven-plugin>3.0.0</build-helper-maven-plugin>
+    </properties>
+</project>

package/codegen/swagger/src/main/java/com/asana/codegen/ExampleUtility.java

@@ -0,0 +1,27 @@
+package com.asana.codegen;
+
+import org.json.*;
+import io.swagger.codegen.v3.*;
+
+class ExampleUtility {
+  public static void tryToSetExample(CodegenParameter p) {
+    JSONObject obj = new JSONObject(p.jsonSchema);
+
+    if (obj.has("example")) {
+      p.example = obj.get("example").toString();
+      return;
+    }
+
+    if (!obj.has("schema")) {
+      return;
+    }
+
+    JSONObject schema = obj.getJSONObject("schema");
+
+    if (!schema.has("example")) {
+      return;
+    }
+
+    p.example = schema.get("example").toString();
+  }
+}

package/codegen/swagger/src/main/java/com/asana/codegen/JavascriptClientCodegenGenerator.java

@@ -0,0 +1,79 @@
+package com.asana.codegen;
+
+import java.util.Map;
+
+import org.json.*;
+import io.swagger.codegen.v3.*;
+import io.swagger.codegen.v3.generators.javascript.*;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.Operation;
+import io.swagger.v3.oas.models.media.Schema;
+
+public class JavascriptClientCodegenGenerator extends JavaScriptClientCodegen {
+  public JavascriptClientCodegenGenerator() {
+    super();
+    apiDocTemplateFiles.put("code_samples.mustache", ".yaml");
+  }
+
+  @Override
+  public void processOpts() {
+    // custom generators do not set the CodegenConstants
+    // Super must be called BEFORE our modification, otherwise the package name
+    // somehow ends up wrong
+    super.processOpts();
+    setProjectName("asana");
+  }
+
+  @Override
+  public String getModelPropertyNaming() {
+    // Javascript tries to use camelCase by default:
+    // https://github.com/swagger-api/swagger-codegen-generators/blob/66dcca9d545892e18f982b2cde60621ec6f72bfe/src/main/java/io/swagger/codegen/v3/generators/javascript/JavaScriptClientCodegen.java#L112
+    //
+    // but we want it to use the OAS schema
+    return CodegenConstants.MODEL_PROPERTY_NAMING_TYPE.original.toString();
+  }
+
+  @Override
+  public void setParameterExampleValue(CodegenParameter p) {
+    // Our example correction code must execute before super, to ensure that
+    // super does its special magic of determining the example type:
+    // https://github.com/swagger-api/swagger-codegen-generators/blob/master/src/main/java/io/swagger/codegen/v3/generators/javascript/JavaScriptClientCodegen.java#L714
+    ExampleUtility.tryToSetExample(p);
+
+    // "CSV" is used to declare that a query param string is joined by commas.
+    // If that's the case, we can use the raw JSON representation as a valid
+    // python list as the syntax is the same
+    if ("csv".equalsIgnoreCase(p.collectionFormat)) {
+      return;
+    }
+
+    super.setParameterExampleValue(p);
+
+    // Wrap file request body param example in fs.createReadStream
+    if (p.paramName.equalsIgnoreCase("file")) {
+      p.example = "fs.createReadStream(" + p.example + ")";
+    }
+
+    String type = p.baseType;
+    if (type == null) {
+        type = p.dataType;
+    }
+
+    // Update example for requests that require body
+    if (!languageSpecificPrimitives.contains(type)) {
+      // type is a model class, e.g. User
+      p.example = "new " + moduleName + "." + type + ".constructFromObject({data: {param1: \"value1\", param2: \"value2\",}})";
+    }
+  }
+
+  @Override
+  public CodegenOperation fromOperation(String path, String httpMethod, Operation operation, Map<String, Schema> schemas, OpenAPI openAPI) {
+    CodegenOperation op = super.fromOperation(path, httpMethod, operation, schemas, openAPI);
+    // Set vendor-extension to be used in template:
+    //     x-codegen-isCreateAttachmentForObject
+    if(op.operationId.equalsIgnoreCase("createAttachmentForObject")) {
+      op.vendorExtensions.put("x-codegen-isCreateAttachmentForObject", true);
+    }
+    return op;
+  }
+}

package/codegen/swagger/src/main/java/com/asana/codegen/ReadMe.java

@@ -0,0 +1,164 @@
+package com.asana.codegen;
+
+import io.swagger.codegen.v3.*;
+import io.swagger.codegen.v3.generators.DefaultCodegenConfig;
+
+import java.util.*;
+import java.io.File;
+
+public class ReadMe extends DefaultCodegenConfig {
+
+  // source folder where to write the files
+  protected String sourceFolder = "src";
+  protected String apiVersion = "1.0.0";
+
+  /**
+   * Configures the type of generator.
+   * 
+   * @return  the CodegenType for this generator
+   * @see     io.swagger.codegen.CodegenType
+   */
+  public CodegenType getTag() {
+    return CodegenType.CLIENT;
+  }
+
+  /**
+   * Configures a friendly name for the generator.  This will be used by the generator
+   * to select the library with the -l flag.
+   * 
+   * @return the friendly name for the generator
+   */
+  public String getName() {
+    return "AsanaPythonClientCodegen";
+  }
+
+  /**
+   * Returns human-friendly help for the generator.  Provide the consumer with help
+   * tips, parameters here
+   * 
+   * @return A string value for the help message
+   */
+  public String getHelp() {
+    return "Generates a AsanaPythonClientCodegen client library.";
+  }
+
+  public ReadMe() {
+    super();
+
+    // set the output folder here
+    outputFolder = "generated-code/AsanaPythonClientCodegen";
+
+    /**
+     * Models.  You can write model files using the modelTemplateFiles map.
+     * if you want to create one template for file, you can do so here.
+     * for multiple files for model, just put another entry in the `modelTemplateFiles` with
+     * a different extension
+     */
+    modelTemplateFiles.put(
+      "model.mustache", // the template to use
+      ".sample");       // the extension for each file to write
+
+    /**
+     * Api classes.  You can write classes for each Api file with the apiTemplateFiles map.
+     * as with models, add multiple entries with different extensions for multiple files per
+     * class
+     */
+    apiTemplateFiles.put(
+      "api.mustache",   // the template to use
+      ".sample");       // the extension for each file to write
+
+    /**
+     * Template Location.  This is the location which templates will be read from.  The generator
+     * will use the resource stream to attempt to read the templates.
+     */
+    templateDir = "AsanaPythonClientCodegen";
+
+    /**
+     * Api Package.  Optional, if needed, this can be used in templates
+     */
+    apiPackage = "io.swagger.client.api";
+
+    /**
+     * Model Package.  Optional, if needed, this can be used in templates
+     */
+    modelPackage = "io.swagger.client.model";
+
+    /**
+     * Reserved words.  Override this with reserved words specific to your language
+     */
+    reservedWords = new HashSet<String> (
+      Arrays.asList(
+        "sample1",  // replace with static values
+        "sample2")
+    );
+
+    /**
+     * Additional Properties.  These values can be passed to the templates and
+     * are available in models, apis, and supporting files
+     */
+    additionalProperties.put("apiVersion", apiVersion);
+
+    /**
+     * Supporting Files.  You can write single files for the generator with the
+     * entire object tree available.  If the input file has a suffix of `.mustache
+     * it will be processed by the template engine.  Otherwise, it will be copied
+     */
+    supportingFiles.add(new SupportingFile("myFile.mustache",   // the input template or file
+      "",                                                       // the destination folder, relative `outputFolder`
+      "myFile.sample")                                          // the output file
+    );
+
+    /**
+     * Language Specific Primitives.  These types will not trigger imports by
+     * the client generator
+     */
+    languageSpecificPrimitives = new HashSet<String>(
+      Arrays.asList(
+        "Type1",      // replace these with your types
+        "Type2")
+    );
+  }
+
+  /**
+   * Escapes a reserved word as defined in the `reservedWords` array. Handle escaping
+   * those terms here.  This logic is only called if a variable matches the reserved words
+   * 
+   * @return the escaped term
+   */
+  @Override
+  public String escapeReservedWord(String name) {
+    return "_" + name;  // add an underscore to the name
+  }
+
+  /**
+   * Location to write model files.  You can use the modelPackage() as defined when the class is
+   * instantiated
+   */
+  public String modelFileFolder() {
+    return outputFolder + "/" + sourceFolder + "/" + modelPackage().replace('.', File.separatorChar);
+  }
+
+  /**
+   * Location to write api files.  You can use the apiPackage() as defined when the class is
+   * instantiated
+   */
+  @Override
+  public String apiFileFolder() {
+    return outputFolder + "/" + sourceFolder + "/" + apiPackage().replace('.', File.separatorChar);
+  }
+
+  @Override
+  public String getArgumentsLocation() {
+    return null;
+  }
+
+  @Override
+  protected String getTemplateDir() {
+    return templateDir;
+  }
+
+  @Override
+  public String getDefaultTemplateDir() {
+    return templateDir;
+  }
+}

package/codegen/swagger/src/main/resources/META-INF/services/io.swagger.codegen.v3.CodegenConfig

@@ -0,0 +1 @@
+com.asana.codegen.JavascriptClientCodegenGenerator