Releasing 2.2.0 version.

Author: Prominence

README.md

@@ -6,11 +6,11 @@ Free:
 * Current weather data
 * 5 day / 3-hour forecast
 * One Call API
+* Air pollution
 
 ### Will be implemented later:
 
 Free:
-* Air pollution
 * Geocoding API
 * Weather Stations
 * Weather Triggers
@@ -26,14 +26,14 @@ Paid:
 <dependency>
   <groupId>com.github.prominence</groupId>
   <artifactId>openweathermap-api</artifactId>
-  <version>2.1.1</version>
+  <version>2.2.0</version>
 </dependency>
 ```
 
 ### Gradle coordinates:
 
 ```groovy
-compile('com.github.prominence:openweathermap-api:2.1.1')
+compile('com.github.prominence:openweathermap-api:2.2.0')
 ```
 
 ### Documentation
@@ -44,6 +44,7 @@ compile('com.github.prominence:openweathermap-api:2.1.1')
 * [OpenWeatherMap Java API - 2.0.1](docs/Release_2.0.1.md)
 * [OpenWeatherMap Java API - 2.1.0](docs/Release_2.1.0.md)
 * [OpenWeatherMap Java API - 2.1.1](docs/Release_2.1.1.md)
+* [OpenWeatherMap Java API - 2.2.0](docs/Release_2.2.0.md)
 * [OpenWeatherMap Java API - SNAPSHOT](docs/SNAPSHOT.md)
 
 ### License

docs/Release_2.2.0.md

@@ -2,6 +2,7 @@
 * Current weather data
 * 5 day / 3-hour forecast
 * One Call API
+* Air Pollution
 
 ### Maven coordinates:
 
@@ -31,6 +32,7 @@ Currently, available APIs are:
 * `currentWeather()`
 * `forecast5Day3HourStep()`
 * `oneCall()`
+* `airPollution()`
 
 Default(more or less) customization points:
 ```java
@@ -420,6 +422,56 @@ You are able to set preferable options(via chain methods) and execute appropriat
 | `getRain()`                       | Returns `Rain` object. Available fields: `oneHourLevel` and `unit`.                               |
 | `getSnow()`                       | Returns `Snow` object. Available fields: `oneHourLevel` and `unit`.                               |
 
+#### Air Pollution API
+Examples:
+```java
+final AirPollutionDetails airPollutionDetails = openWeatherClient
+        .airPollution()
+        .current()
+        .byCoordinate(Coordinate.of(53.54, 27.34))
+        .retrieve()
+        .asJava();
+```
+
+```java
+final AirPollutionDetails airPollutionDetails = openWeatherClient
+        .airPollution()
+        .historical()
+        .byCoordinateAndPeriod(Coordinate.of(53.54, 27.34), 1606223802, 1606482999)
+        .retrieve()
+        .asJava();
+```
+
+`com.github.prominence.openweathermap.api.model.air.pollution.AirPollutionDetails`'s useful public methods(setters are not listed):
+
+| Method                        | Description                                                               |
+|-------------------------------|---------------------------------------------------------------------------|
+| `getCoordinate()`             | Returns `Coordinate` object. Available fields: `latitude`, `longitude`.   |
+| `getAirPollutionRecords()`    | Returns list of `AirPollutionRecord` objects.                             |
+
+`com.github.prominence.openweathermap.api.model.air.pollution.AirPollutionRecord`'s useful public methods(setters are not listed):
+
+| Method                        | Description                                                               |
+|-------------------------------|---------------------------------------------------------------------------|
+| `getForecastTime()`           | Returns `LocalDateTime` object with air pollution forecast time.          |
+| `getAirQualityIndex()`        | Returns `AirQualityIndex` object.                                         |
+| `getCO()`                     | Returns carbon monoxide concentration value in μg/m^3.s.                  |
+| `getCarbonMonoxide()`         | An alias for `getCO()` method.                                            |
+| `getNO()`                     | Returns nitrogen monoxide concentration value in μg/m^3.                  |
+| `getNitrogenMonoxide()`       | An alias for `getNO()` method.                                            |
+| `getNO2()`                    | Returns nitrogen dioxide concentration value in μg/m^3.                   |
+| `getNitrogenDioxide()`        | An alias for `getNO2()` method.                                           |
+| `getO3()`                     | Returns ozone concentration value in μg/m^3.                              |
+| `getOzone()`                  | An alias for `getO3()` method.                                            |
+| `getSO2()`                    | Returns sulphur dioxide concentration value in μg/m^3.                    |
+| `getSulphurDioxide()`         | An alias for `getSO2()` method.                                           |
+| `getPM2_5()`                  | Returns fine particles matter concentration value in μg/m^3.              |
+| `getFineParticlesMatter()`    | An alias for `getPM2_5()` method.                                         |
+| `getPM10()`                   | Returns coarse particulate matter concentration value in μg/m^3.          |
+| `getCoarseParticulateMatter()`| An alias for `getPM10()` method.                                          |
+| `getNH3()`                    | Returns ammonia concentration value in μg/m^3.                            |
+| `getAmmonia()`                | An alias for `getNH3()` method.                                           |
+
 ### Constants and options
 
 #### Language

docs/SNAPSHOT.md

@@ -6,7 +6,7 @@
 
     <groupId>com.github.prominence</groupId>
     <artifactId>openweathermap-api</artifactId>
-    <version>2.1.1</version>
+    <version>2.2.0</version>
     <packaging>jar</packaging>
 
     <name>Java OpenWeatherMap API</name>

pom.xml

@@ -23,6 +23,8 @@
 package com.github.prominence.openweathermap.api;
 
 import com.github.prominence.openweathermap.api.annotation.SubscriptionAvailability;
+import com.github.prominence.openweathermap.api.request.air.pollution.AirPollutionRequester;
+import com.github.prominence.openweathermap.api.request.air.pollution.AirPollutionRequesterImpl;
 import com.github.prominence.openweathermap.api.request.forecast.free.FiveDayThreeHourStepForecastRequester;
 import com.github.prominence.openweathermap.api.request.forecast.free.FiveDayThreeHourStepForecastRequesterImpl;
 import com.github.prominence.openweathermap.api.request.onecall.OneCallWeatherRequester;
@@ -74,4 +76,14 @@ public FiveDayThreeHourStepForecastRequester forecast5Day3HourStep() {
     public OneCallWeatherRequester oneCall() {
         return new OneCallWeatherRequesterImpl(apiKey);
     }
+
+    /**
+     * Air Pollution <a href="https://openweathermap.org/api/air-pollution">API</a>.
+     * Air Pollution API provides current, forecast and historical air pollution data for any coordinates on the globe.
+     * @return requester for air pollution information retrieval.
+     */
+    @SubscriptionAvailability(plans = ALL)
+    public AirPollutionRequester airPollution() {
+        return new AirPollutionRequesterImpl(apiKey);
+    }
 }

src/main/java/com/github/prominence/openweathermap/api/OpenWeatherMapClient.java

@@ -0,0 +1,80 @@
+/*
+ *
+ *  * Copyright (c) 2021 Alexey Zinchenko
+ *  *
+ *  * Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  * of this software and associated documentation files (the "Software"), to deal
+ *  * in the Software without restriction, including without limitation the rights
+ *  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  * copies of the Software, and to permit persons to whom the Software is
+ *  * furnished to do so, subject to the following conditions:
+ *  *
+ *  * The above copyright notice and this permission notice shall be included in all
+ *  * copies or substantial portions of the Software.
+ *  *
+ *  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  * SOFTWARE.
+ *
+ */
+
+package com.github.prominence.openweathermap.api.enums;
+
+import java.util.Arrays;
+import java.util.Optional;
+
+/**
+ * The enum Air quality index.
+ */
+public enum AirQualityIndex {
+    /**
+     * Good air quality index.
+     */
+    GOOD(1),
+    /**
+     * Fair air quality index.
+     */
+    FAIR(2),
+    /**
+     * Moderate air quality index.
+     */
+    MODERATE(3),
+    /**
+     * Poor air quality index.
+     */
+    POOR(4),
+    /**
+     * Very poor air quality index.
+     */
+    VERY_POOR(5);
+
+    private final int value;
+
+    AirQualityIndex(int index) {
+        this.value = index;
+    }
+
+    /**
+     * Gets value.
+     *
+     * @return the value
+     */
+    public int getValue() {
+        return value;
+    }
+
+    /**
+     * Gets by index.
+     *
+     * @param index the index
+     * @return the by index
+     */
+    public static AirQualityIndex getByIndex(int index) {
+        final Optional<AirQualityIndex> optionalAirQualityIndex = Arrays.stream(values()).filter(airQualityIndex -> airQualityIndex.getValue() == index).findFirst();
+        return optionalAirQualityIndex.orElse(null);
+    }
+}

src/main/java/com/github/prominence/openweathermap/api/enums/AirQualityIndex.java

@@ -0,0 +1,87 @@
+/*
+ *
+ *  * Copyright (c) 2021 Alexey Zinchenko
+ *  *
+ *  * Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  * of this software and associated documentation files (the "Software"), to deal
+ *  * in the Software without restriction, including without limitation the rights
+ *  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  * copies of the Software, and to permit persons to whom the Software is
+ *  * furnished to do so, subject to the following conditions:
+ *  *
+ *  * The above copyright notice and this permission notice shall be included in all
+ *  * copies or substantial portions of the Software.
+ *  *
+ *  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  * SOFTWARE.
+ *
+ */
+
+package com.github.prominence.openweathermap.api.model.air.pollution;
+
+import com.github.prominence.openweathermap.api.model.Coordinate;
+
+import java.util.List;
+import java.util.Objects;
+
+/**
+ * The type Air pollution.
+ */
+public class AirPollutionDetails {
+    private Coordinate coordinate;
+    private List<AirPollutionRecord> airPollutionRecords;
+
+    /**
+     * Gets coordinate.
+     *
+     * @return the coordinate
+     */
+    public Coordinate getCoordinate() {
+        return coordinate;
+    }
+
+    /**
+     * Sets coordinate.
+     *
+     * @param coordinate the coordinate
+     */
+    public void setCoordinate(Coordinate coordinate) {
+        this.coordinate = coordinate;
+    }
+
+    /**
+     * Gets air pollution details.
+     *
+     * @return the air pollution details
+     */
+    public List<AirPollutionRecord> getAirPollutionRecords() {
+        return airPollutionRecords;
+    }
+
+    /**
+     * Sets air pollution details.
+     *
+     * @param airPollutionRecords the air pollution details
+     */
+    public void setAirPollutionRecords(List<AirPollutionRecord> airPollutionRecords) {
+        this.airPollutionRecords = airPollutionRecords;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        AirPollutionDetails that = (AirPollutionDetails) o;
+        return Objects.equals(coordinate, that.coordinate) && Objects.equals(airPollutionRecords, that.airPollutionRecords);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(coordinate, airPollutionRecords);
+    }
+}