Merge pull request #1 from JacobDevelopment/development

Development

Author: jkingster

readme.md

@@ -1,5 +1,5 @@
 <h1>J-SWAPI</h1>
-<p>J(ava)-SWAPI, this is a helper library for <a href="https://swapi.dev/">SWAPI</a> written completely in java. It allows you to retrieve data from the Star Wars API for any applications in need of Star Wars data.</p>
+<p>J(ava)-SWAPI, this is an API for <a href="https://swapi.dev/">SWAPI</a> written completely in java. It allows you to retrieve data from the Star Wars API for any applications in need of Star Wars data.</p>
 
 <h1>Dependencies</h1>
 <ul>
@@ -11,9 +11,7 @@
 This API does not handle rate limiting, and according to the SWAPI website it allows 10,000 API requests <b>per day</b>.
 <a href="https://swapi.dev/documentation#rate">Source Here.</a>
 
-No authentication is required per the website as well. 
-    
-<b>As soon as the base is complete, it will be added to MavenCentral so it can be added as a dependency.</b>
+No authentication is required per the website as well.
 </p>
 
 
@@ -27,10 +25,12 @@ class Started {
 }
 ```
 
-From here, we can all specific resources that we want to retrieve. We retrieve the following resources from what SWAPI offers:
+From here, we can all specific resources that we want to retrieve. We retrieve the following resources from what SWAPI
+offers:
 <b>People, Films, Starships, Vehicles, Species, Planets.</b>
 
 For example, if we want to retrieve a specific person via <b>ID</b> we can call the following people action:
+
 ```java
 class Started {
     public static void main(String[] args) {
@@ -41,9 +41,11 @@ class Started {
 }
 ```
 
-This API does allow search querying, or retrieving all data for specific resources. All resource(s) have the following methods tied to them:
+This API does allow search querying, or retrieving all data for specific resources. All resource(s) have the following
+methods tied to them:
 <br/>
 <b>Resource#getById(Int)</b>
+
 ```java
 class Started {
     public static void main(String[] args) {
@@ -53,9 +55,11 @@ class Started {
     }
 }
 ```
+
 <br/>
 
 <b>List&lt;Resource&gt;#getBySearch(String)</b>
+
 ```java
 class Started {
     public static void main(String[] args) {
@@ -65,30 +69,34 @@ class Started {
     }
 }
 ```
+
 <br/>
 
 <b>List&lt;Resource&gt;#getAll()</b>
+
 ```java
 class Started {
     public static void main(String[] args) {
         API api = new API.Builder().build();
         var movies = api.films().getAll(); // The URL forming here is: https://swapi.dev/api/films/?format=json
         for (Films film : movies) {
             System.out.print(film.getEpisodeId() + " ");
-        } 
+        }
         // Prints 4 5 6 1 2 3  (Unordered for whatever reason!).
     }
 }
 ```
+
 <br/>
 
 <b>List&lt;Resource&gt;#getByFilter(Predicate&lt;Resource&gt;)</b>
+
 ```java
 class Started {
     public static void main(String[] args) {
         API api = new API.Builder().build();
-        var filtered  = api.films().getByFilter(
-          film -> film.getEpisodeId() <= 3   
+        var filtered = api.films().getByFilter(
+                film -> film.getEpisodeId() <= 3
         );
 //         Forms URL:  https://swapi.dev/api/films/?format=json
 //         It then just sorts utilizing streams filter methods.
@@ -100,9 +108,11 @@ class Started {
     }
 }
 ```
+
 <br/>
 
 <b>Optional&lt;Resource&gt;#getFirstBySearch(String)</b>.
+
 ```java
 class Started {
     public static void main(String[] args) {
@@ -113,11 +123,18 @@ class Started {
 }
 ```
 
-You can find more examples here: <a href="https://github.com/JacobDevelopment/j-swapi/tree/master/src/test/java/io/jking/jswapi">Examples</a>
+You can find more examples
+here: <a href="https://github.com/JacobDevelopment/j-swapi/tree/master/src/test/java/io/jking/jswapi">Examples</a>
 
 <h1>Todo</h1>
 
-| Item #1 | Description                  | Done? |
-|---------|------------------------------|-------|
-| #1      | Finish other resources.      | [ ]   |
-| #2      | Get rid of executor service. | [X]   |
+| Item #1 | Description                           | Done? |
+|---------|---------------------------------------|-------|
+| #1      | Finish other resources.               | [X]   |
+| #2      | Get rid of executor service.          | [X]   |
+| #3      | Duplicate code among request actions. | [X]   |
+| #4      | Fix readme discrepenacies. | [ ]   |
+| #5      | Handle 404 errors / page not found. | [X]   |
+| #6 | Add cache internally so we don't have to request all the time. | [ ]   |
+    
+  

src/main/java/io/jking/jswapi/action/RequestAction.java

@@ -1,43 +1,79 @@
 package io.jking.jswapi.action;
 
-import static io.jking.jswapi.utility.Binder.*;
-
-import com.fasterxml.jackson.databind.ObjectMapper;
+import io.jking.jswapi.internal.Resources;
 import io.jking.jswapi.resources.BaseResource;
 import io.jking.jswapi.resources.GeneralQuery;
 import io.jking.jswapi.utility.Binder;
 
 import java.io.IOException;
-import java.net.MalformedURLException;
+import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 import java.util.Optional;
 import java.util.function.Predicate;
 import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+public abstract class RequestAction<T extends BaseResource> {
+
+    private final Resources resource;
+    private final Class<T>  clazz;
+
+    public RequestAction(Resources resource, Class<T> clazz) {
+        this.resource = resource;
+        this.clazz = clazz;
+    }
+
+    public T getById(final int id) throws IOException {
+        final String route = resource.getRouteById(id);
+        return Binder.read(route, clazz);
+    }
 
-public interface RequestAction<T extends BaseResource> {
+    public List<T> getAll() throws IOException {
+        final String route = resource.getAllRoute();
+        final GeneralQuery<T> generalQuery = Binder.bind(route, clazz);
+        if (generalQuery.getResults().isEmpty())
+            return Collections.emptyList();
 
-    T getById(final int id) throws IOException;
+        if (generalQuery.getCount() > 9)
+            return getAllByPages(generalQuery);
 
-    List<T> getAll() throws IOException;
+        return generalQuery.getResults();
+    }
 
-    List<T> getBySearch(final String searchQuery) throws IOException;
+    public List<T> getBySearch(final String searchParameter) throws IOException {
+        final String route = resource.getRouteBySearch(searchParameter);
+        final GeneralQuery<T> generalQuery = Binder.bind(route, clazz);
+        if (generalQuery.getResults().isEmpty())
+            return Collections.emptyList();
 
-    default GeneralQuery<T> getGeneralQuery(final String route, Class<T> clazz) throws IOException {
-        return Binder.bind(route, clazz);
+        return generalQuery.getResults();
     }
 
+    public List<T> getByFilter(final Predicate<T> filter) throws IOException {
+        return getAll().stream().filter(filter).collect(Collectors.toList());
+    }
 
-    default List<T> getByFilter(final Predicate<T> filter) throws IOException {
-        return getAll()
-                .stream()
-                .filter(filter)
-                .collect(Collectors.toList());
+    public Optional<T> getFirstBySearch(final String searchParameter) throws IOException {
+        return getBySearch(searchParameter).stream().findFirst();
     }
 
-    default Optional<T> getFirstBySearch(final String searchQuery) throws IOException {
-        return getBySearch(searchQuery)
-                .stream()
-                .findFirst();
+    public Optional<T> getFirst() throws IOException {
+        return getAll().stream().findFirst();
     }
 
+    private List<T> getAllByPages(GeneralQuery<T> generalQuery) throws IOException {
+        final List<T> allOfResources = new ArrayList<>();
+        final int totalPages = (int) (Math.ceil(generalQuery.getCount() / 10.0));
+        for (int i = 1; i <= totalPages; i++) {
+            final String PAGE_ROUTE = resource.getPageRoute(i);
+            final GeneralQuery<T> newGeneralQuery = Binder.bind(PAGE_ROUTE, clazz);
+            if (newGeneralQuery.getResults().isEmpty())
+                break;
+
+            allOfResources.addAll(newGeneralQuery.getResults());
+        }
+
+        return allOfResources;
+    }
 }

src/main/java/io/jking/jswapi/action/impl/FilmsAction.java

@@ -2,40 +2,10 @@
 
 import io.jking.jswapi.action.RequestAction;
 import io.jking.jswapi.internal.Resources;
-import io.jking.jswapi.resources.GeneralQuery;
 import io.jking.jswapi.resources.impl.Films;
-import io.jking.jswapi.utility.Binder;
 
-import java.io.IOException;
-import java.util.Collections;
-import java.util.List;
-
-public class FilmsAction implements RequestAction<Films> {
-    @Override
-    public Films getById(int id) throws IOException {
-        final String ROUTE = Resources.FILMS.getRouteById(id);
-        return Binder.read(ROUTE, Films.class);
-    }
-
-    @Override
-    public List<Films> getAll() throws IOException {
-        final String ROUTE = Resources.FILMS.getAllRoute();
-        final GeneralQuery<Films> generalQuery = getGeneralQuery(ROUTE, Films.class);
-
-        if (generalQuery.getResults().isEmpty())
-            return Collections.emptyList();
-
-        return generalQuery.getResults();
-    }
-
-    @Override
-    public List<Films> getBySearch(String searchQuery) throws IOException {
-        final String ROUTE = Resources.FILMS.getRouteBySearch(searchQuery);
-        final GeneralQuery<Films> generalQuery = getGeneralQuery(ROUTE, Films.class);
-
-        if (generalQuery.getResults().isEmpty())
-            return Collections.emptyList();
-
-        return generalQuery.getResults();
+public class FilmsAction extends RequestAction<Films> {
+    public FilmsAction() {
+        super(Resources.FILMS, Films.class);
     }
 }

src/main/java/io/jking/jswapi/action/impl/PeopleAction.java

@@ -1,58 +1,11 @@
 package io.jking.jswapi.action.impl;
 
-import com.fasterxml.jackson.core.type.TypeReference;
-import com.fasterxml.jackson.databind.ObjectMapper;
 import io.jking.jswapi.action.RequestAction;
 import io.jking.jswapi.internal.Resources;
 import io.jking.jswapi.resources.impl.People;
-import io.jking.jswapi.resources.GeneralQuery;
-import io.jking.jswapi.utility.Binder;
 
-import java.io.IOException;
-import java.net.URL;
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.List;
-import java.util.stream.Collectors;
-
-public class PeopleAction implements RequestAction<People> {
-    @Override
-    public People getById(int id) throws IOException {
-        final String ROUTE = Resources.PEOPLE.getRouteById(id);
-        return Binder.read(ROUTE, People.class);
-    }
-
-    // Needs Optimization
-    @Override
-    public List<People> getAll() throws IOException {
-        final String ROUTE = Resources.PEOPLE.getAllRoute();
-        final GeneralQuery<People> generalQuery = getGeneralQuery(ROUTE, People.class);
-        if (generalQuery.getResults().isEmpty())
-            return Collections.emptyList();
-
-        final List<People> allPeople = new ArrayList<>();
-        final int totalPages = (int) (Math.round(generalQuery.getCount() / 10.0) + 1);
-        for (int i = 1; i <= totalPages; i++) {
-            final String PAGE_ROUTE = Resources.PEOPLE.getPageRoute(i);
-            final GeneralQuery<People> newQuery = getGeneralQuery(PAGE_ROUTE, People.class);
-            if (newQuery.getResults().isEmpty())
-                break;
-
-            allPeople.addAll(newQuery.getResults());
-        }
-
-        return allPeople;
+public class PeopleAction extends RequestAction<People> {
+    public PeopleAction() {
+        super(Resources.PEOPLE, People.class);
     }
-
-    @Override
-    public List<People> getBySearch(String searchQuery) throws IOException {
-        final String ROUTE = Resources.PEOPLE.getRouteBySearch(searchQuery);
-        final GeneralQuery<People> generalQuery = getGeneralQuery(ROUTE, People.class);
-
-        if (generalQuery.getResults().isEmpty())
-            return Collections.emptyList();
-
-        return generalQuery.getResults();
-    }
-
 }

src/main/java/io/jking/jswapi/action/impl/PlanetsAction.java

@@ -0,0 +1,11 @@
+package io.jking.jswapi.action.impl;
+
+import io.jking.jswapi.action.RequestAction;
+import io.jking.jswapi.internal.Resources;
+import io.jking.jswapi.resources.impl.Planets;
+
+public class PlanetsAction extends RequestAction<Planets> {
+    public PlanetsAction() {
+        super(Resources.PLANETS, Planets.class);
+    }
+}

src/main/java/io/jking/jswapi/action/impl/SpeciesAction.java

@@ -0,0 +1,11 @@
+package io.jking.jswapi.action.impl;
+
+import io.jking.jswapi.action.RequestAction;
+import io.jking.jswapi.internal.Resources;
+import io.jking.jswapi.resources.impl.Species;
+
+public class SpeciesAction extends RequestAction<Species> {
+    public SpeciesAction() {
+        super(Resources.SPECIES, Species.class);
+    }
+}

src/main/java/io/jking/jswapi/action/impl/StarshipsAction.java

@@ -0,0 +1,11 @@
+package io.jking.jswapi.action.impl;
+
+import io.jking.jswapi.action.RequestAction;
+import io.jking.jswapi.internal.Resources;
+import io.jking.jswapi.resources.impl.Starships;
+
+public class StarshipsAction extends RequestAction<Starships> {
+    public StarshipsAction() {
+        super(Resources.STARSHIPS, Starships.class);
+    }
+}

src/main/java/io/jking/jswapi/action/impl/VehiclesAction.java

@@ -0,0 +1,12 @@
+package io.jking.jswapi.action.impl;
+
+import io.jking.jswapi.action.RequestAction;
+import io.jking.jswapi.internal.Resources;
+import io.jking.jswapi.resources.impl.Vehicles;
+
+public class VehiclesAction extends RequestAction<Vehicles> {
+    public VehiclesAction() {
+        super(Resources.VEHICLES, Vehicles.class);
+
+    }
+}