Funciones para crear objetos agregadas

Author: sierisimo

jobs-search-reporter/src/main/java/com/platzi/jobsearch/CommanderFunctions.java

@@ -0,0 +1,37 @@
+package com.platzi.jobsearch;
+
+import com.beust.jcommander.JCommander;
+
+import java.util.function.Supplier;
+
+public interface CommanderFunctions {
+    /**
+     * JCommander permite generar opciones de terminal de cualquier clase, por eso el primer parametro es
+     * de tipo Object.
+     *
+     * @param object Clase de la cual se generaran los argumentos de JCommander
+     * @return una instancia de JCommander. Idealmente con CLIArguments como objeto pasado.
+     */
+    static JCommander buildCommander(Object object) {
+        return JCommander
+                .newBuilder()
+                .addObject(object)
+                .build();
+    }
+
+    /**
+     * Con esta funcion, facilitamos crear una configuracion inicial de JCommander, pidiendo el nombre del
+     * programa y un Supplier de tipo T para los argumentos. Asi podemos usar alguna funcion que nos devuelva
+     * un objeto que funcione como argumentos de JCommander.
+     *
+     * @param name              nombre que se mostrara en el CLI
+     * @param argumentsSupplier una funcion que devuelva un objeto de argumentos de JCommander
+     * @param <T>               Tipo que se usara para los argumentos
+     * @return una instancia de {@link JCommander} ya configurada con el nombre y los argumentos.
+     */
+    static <T> JCommander buildCommanderWithName(String name, Supplier<T> argumentsSupplier) {
+        JCommander jCommander = buildCommander(argumentsSupplier.get());
+        jCommander.setProgramName(name);
+        return jCommander;
+    }
+}

jobs-search-reporter/src/main/java/com/platzi/jobsearch/JobSearch.java

@@ -1,7 +1,13 @@
 package com.platzi.jobsearch;
 
+import com.beust.jcommander.JCommander;
+import com.platzi.jobsearch.cli.CLIArguments;
+
+import static com.platzi.jobsearch.CommanderFunctions.buildCommanderWithName;
+
 public class JobSearch {
     public static void main(String[] args) {
-        System.out.println("Hello fellow student");
+        //Creacion de nuestro CLI con JCommander
+        JCommander jCommander = buildCommanderWithName("job-search", CLIArguments::newInstance);
     }
 }

jobs-search-reporter/src/main/java/com/platzi/jobsearch/api/APIFunctions.java

@@ -0,0 +1,22 @@
+package com.platzi.jobsearch.api;
+
+import feign.Feign;
+import feign.gson.GsonDecoder;
+
+public interface APIFunctions {
+    /**
+     * Para construir la llamada fon Feign, necesitamos generar un cliente de Feign,
+     * esconder que internamente este es el cliente que se usa, nos facilita hacer facil
+     * el reemplazo de la libreria para http en el futuro.
+     *
+     * @param api una Class de tipo T para construir nuestra api
+     * @param url la URL base donde estaremos haciendo los requests
+     * @param <T> el tipo de API que contruiremos
+     * @return una instancia de T para usar como cliente de API
+     */
+    static <T> T buildAPI(Class<T> api, String url) {
+        return Feign.builder()
+                .decoder(new GsonDecoder())
+                .target(api, url);
+    }
+}

jobs-search-reporter/src/main/java/com/platzi/jobsearch/cli/CLIArguments.java

@@ -0,0 +1,96 @@
+package com.platzi.jobsearch.cli;
+
+import com.beust.jcommander.Parameter;
+
+public final class CLIArguments {
+    /**
+     * Constructor default para permitir que solo clases en el paquete, puedan crear objetos
+     * de esta clase.
+     * De esta manera obligamos a que la construccion se haga mediante funciones publicas o
+     * builders.
+     * <p>
+     * Las instancias deberan crearse mediante: CLIArguments#newInstance
+     */
+    CLIArguments() {
+    }
+
+    @Parameter(
+            required = true,
+            descriptionKey = "KEYWORD",
+            description = "KEYWORD",
+            validateWith = CLIKeywordValidator.class)
+    private String keyword;
+
+    @Parameter(
+            names = {"--location", "-l"},
+            description = "Ciudad, codigo postal o algun otro termino para buscar una ubicacion")
+    private String location;
+
+    @Parameter(
+            names = {"--page", "-p"},
+            description = "Cada busqueda contiene 50 posiciones, puedes paginar mas resultados cambiando el numero, la paginacion empieza en 0")
+    private int page = 0;
+
+    @Parameter(
+            names = "--full-time",
+            description = "Agregar esta bandera si se desea unicamente listar trabajos de 'full time'"
+    )
+    private boolean isFullTime = false;
+
+    @Parameter(
+            names = "--markdown",
+            description = "Agregar esta bandera si se desea obtener los resultados en markdown"
+    )
+    private boolean isMarkdown = false;
+
+    @Parameter(
+            names = "--help",
+            help = true,
+            validateWith = CLIHelpValidator.class,
+            description = "Muestra esta ayuda")
+    private boolean help;
+
+    public String getKeyword() {
+        return keyword;
+    }
+
+    public String getLocation() {
+        return location;
+    }
+
+    public int getPage() {
+        return page;
+    }
+
+    public boolean isFullTime() {
+        return isFullTime;
+    }
+
+    public boolean isMarkdown() {
+        return isMarkdown;
+    }
+
+    public boolean isHelp() {
+        return help;
+    }
+
+    @Override
+    public String toString() {
+        return "CLIArguments{" +
+                "keyword='" + keyword + '\'' +
+                ", location='" + location + '\'' +
+                ", pages=" + page +
+                ", isFullTime=" + isFullTime +
+                ", help=" + help +
+                ", isMarkdown=" + isMarkdown +
+                '}';
+    }
+
+    /**
+     * Esta funcion es equivalente a CLIArguments::new, sin embargo, si en el futuro queremos agregar
+     * parametros adicionales, podemos limitar la manera de construir objetos mediante esta funcion.
+     */
+    public static CLIArguments newInstance() {
+        return new CLIArguments();
+    }
+}

jobs-search-reporter/src/main/java/com/platzi/jobsearch/cli/CLIHelpValidator.java

@@ -0,0 +1,20 @@
+package com.platzi.jobsearch.cli;
+
+import com.beust.jcommander.IParameterValidator;
+import com.beust.jcommander.ParameterException;
+
+/**
+ * Clase usada internamente por JCommande para validar ciertos argumentos.
+ * En nuestro caso la usamos para frenar el parseo de argumentos si encontramos que se solicito
+ * la opcion de ayuda.
+ */
+public class CLIHelpValidator implements IParameterValidator {
+
+    @Override
+    public void validate(String name, String value) throws ParameterException {
+        boolean actualValue = Boolean.parseBoolean(value);
+        if (actualValue) {
+            throw new ParameterException("Help passed");
+        }
+    }
+}

jobs-search-reporter/src/main/java/com/platzi/jobsearch/cli/CLIKeywordValidator.java

@@ -0,0 +1,19 @@
+package com.platzi.jobsearch.cli;
+
+import com.beust.jcommander.IParameterValidator;
+import com.beust.jcommander.ParameterException;
+
+/**
+ * Clase usada por JCommander para validar argumentos.
+ * <p>
+ * En nuestro caso la usamos para validar que el skill solicitiado (keyword) sea unicamente letras y numeros.
+ */
+public class CLIKeywordValidator implements IParameterValidator {
+    @Override
+    public void validate(String name, String value) throws ParameterException {
+        if (!value.matches("^[a-zA-Z]+[0-9]*$")) {
+            System.err.println("Keyword: " + value + " no es un Keyword valido, keywords deben ser alfanumericas.\n");
+            throw new ParameterException("Only alphanumerics are supported");
+        }
+    }
+}