From 499866329880a34e68265624566ce253e5ea44e9 Mon Sep 17 00:00:00 2001 From: Alexey Zinchenko Date: Fri, 26 Mar 2021 23:36:06 +0300 Subject: [PATCH] Releasing 2.0.1 version. --- .github/workflows/codeql-analysis.yml | 4 +- README.md | 5 +- docs/Release_2.0.1.md | 253 ++++++++++++++++++++++++++ docs/SNAPSHOT.md | 4 +- pom.xml | 2 +- 5 files changed, 261 insertions(+), 7 deletions(-) create mode 100644 docs/Release_2.0.1.md diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index caceddf..7fb11b5 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -13,10 +13,10 @@ name: "CodeQL" on: push: - branches: [ dev ] + branches: [ master ] pull_request: # The branches below must be a subset of the branches above - branches: [ dev ] + branches: [ master ] schedule: - cron: '27 20 * * 1' diff --git a/README.md b/README.md index a7056ed..5002ff4 100644 --- a/README.md +++ b/README.md @@ -26,14 +26,14 @@ Paid: com.github.prominence openweathermap-api - 2.0.0-SNAPSHOT + 2.0.1 ``` ### Gradle coordinates: ```groovy -compile('com.github.prominence:openweathermap-api:2.0.0') +compile('com.github.prominence:openweathermap-api:2.0.1') ``` ### Documentation @@ -41,6 +41,7 @@ compile('com.github.prominence:openweathermap-api:2.0.0') * [OpenWeatherMap Java API - 1.1](docs/Release_1.1.md) * [OpenWeatherMap Java API - 1.2](docs/Release_1.2.md) * [OpenWeatherMap Java API - 2.0.0](docs/Release_2.0.0.md) +* [OpenWeatherMap Java API - 2.0.1](docs/Release_2.0.1.md) * [OpenWeatherMap Java API - SNAPSHOT](docs/SNAPSHOT.md) ### License diff --git a/docs/Release_2.0.1.md b/docs/Release_2.0.1.md new file mode 100644 index 0000000..fdf3c0b --- /dev/null +++ b/docs/Release_2.0.1.md @@ -0,0 +1,253 @@ +### Implemented features: +* Current weather data +* 5 day / 3-hour forecast + +### Maven coordinates: + +```xml + + com.github.prominence + openweathermap-api + 2.0.1 + +``` + +### Gradle coordinates: + +```groovy +compile('com.github.prominence:openweathermap-api:2.0.1') +``` + +### How to use: + +Firstly, you need to create the instance of `OpenWeatherMapClient` class: +```java +OpenWeatherMapClient openWeatherClient = new OpenWeatherMapClient(API_TOKEN); +``` +where `API_TOKEN` is your token([you can get it here](https://home.openweathermap.org/api_keys)) as `String`. + +Currently, available APIs are: +* `currentWeather()` +* `forecast5Day3HourStep()` + +Default(more or less) customization points: +```java +... +// response language +.language(Language.RUSSIAN) +... +// response units of measure +.unitSystem(UnitSystem.IMPERIAL) +... +``` + +Available output forms: +* `asJava()` +* `asJSON()` + +Additional output forms, available for several APIs: +* `asXML()` +* `asHTML()` + +_All response forms can be in **sync** and **async** variants._ + +#### Current weather data +Examples: +```java +final String weatherJson = openWeatherClient + .currentWeather() + .single() + .byCityName("Minsk") + .language(Language.RUSSIAN) + .unitSystem(UnitSystem.IMPERIAL) + .retrieve() + .asJSON(); +``` + +```java +final Weather weather = openWeatherClient + .currentWeather() + .single() + .byCityName("Minsk") + .language(Language.RUSSIAN) + .unitSystem(UnitSystem.METRIC) + .retrieve() + .asJava(); +``` + +```java +final List weatherList = openWeatherClient + .currentWeather() + .multiple() + .byCitiesInCycle(Coordinate.withValues(55.5, 37.5)) + .language(Language.GERMAN) + .unitSystem(UnitSystem.IMPERIAL) + .retrieve() + .asJava(); +``` + +```java +final CompletableFuture weatherXmlFuture = openWeatherClient + .currentWeather() + .single() + .byZipCodeAndCountry("220015", "by") + .language(Language.RUSSIAN) + .unitSystem(UnitSystem.METRIC) + .retrieveAsync() + .asXML(); +``` + +You are able to set preferable options(via chain methods) and execute appropriate request. + +`com.github.prominence.openweathermap.api.model.weather.Weather`'s useful public methods(setters are not listed): + +| Method | Description | +|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `getState()` | Returns short weather description. Example: `Clear`. | +| `getDescription()` | Returns weather description. Example: `clear sky`. | +| `getWeatherIconUrl()` | Returns a link to weather icon hosted on https://openweathermap.org website. | +| `getCalculatedOn()` | Returns `LocalDateTime` object with data calculation time. | +| `getTemperature()` | Returns `Temperature` instance that contains information about temperature. Available fields: `value`, `maxTemperature`, `minTemperature`, `feelsLike` and `unit`. | +| `getAtmosphericPressure()`| Returns `AtmosphericPressure` instance that contains information about atmospheric pressure. Available fields: `value`, `seaLevelValue`, `groundLevelValue` and `unit`. | +| `getHumidity()` | Returns `Humidity` instance that contains humidity percentage information. | +| `getWind()` | Returns `Wind` instance that contains wind information: `speed`, `degrees`, `gust` and `unit`. | +| `getRain()` | Returns `Rain` instance that contains information about rain volume for the last one hour and/or the last 3 hours. Can be absent in case of no data. | +| `getSnow()` | Returns `Snow` instance that contains information about snow volume for the last one hour and/or the last 3 hours. Can be absent in case of no data. | +| `getClouds()` | Returns `Clouds` instance that contains information about cloudiness percentage. | +| `getLocation()` | Returns `Location` object. Available fields: `id`, `name`, `countryCode`, `sunrise` and `sunset` time, `zoneOffset` and `coordinate`. | +| `toString()` | Returns informative string for the whole available weather information. | + +`toString()` output example: +``` +Location: Minsk(BY), Weather: clear sky, -4.22 ℃, 1020.0 hPa, Clouds: 0% +``` + +#### 5 day / 3-hour forecast +Examples: +```java +final Forecast forecast = openWeatherClient + .forecast5Day3HourStep() + .byCityName("Minsk") + .language(Language.ENGLISH) + .unitSystem(UnitSystem.METRIC) + .count(15) + .retrieve() + .asJava(); +``` + +```java +final String forecastJson = getClient() + .forecast5Day3HourStep() + .byCityName("New York", "NY", "US") + .language(Language.SPANISH) + .unitSystem(UnitSystem.IMPERIAL) + .count(15) + .retrieve() + .asJSON(); +``` + +```java +CompletableFuture forecastFuture = getClient() + .forecast5Day3HourStep() + .byCityId(350001514) + .language(Language.ENGLISH) + .unitSystem(UnitSystem.METRIC) + .count(15) + .retrieveAsync() + .asXML(); +``` + +```java +final String forecastXml = getClient() + .forecast5Day3HourStep() + .byZipCodeInUSA("10005") + .language(Language.ENGLISH) + .unitSystem(UnitSystem.METRIC) + .retrieve() + .asXML(); +``` + +You are able to set preferable options(via chain methods) and execute appropriate request. + +`com.github.prominence.openweathermap.api.request.forecast.free.Forecast`'s useful public methods(setters are not listed): + +| Method | Description | +|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------| +| `getLocation()` | Returns `Location` object. Available fields: `id`, `name`, `countryCode`, `sunrise` and `sunset` time, `zoneOffset`, `coordinate` and `population`. | +| `getWeatherForecasts()` | Returns list of `WeatherForecast` objects with forecast information. | +| `toString()` | Returns informative string for the whole available forecast information. | + +`toString()` output example: +``` +A forecast for Minsk with 15 timestamps. +``` + +`com.github.prominence.openweathermap.api.model.forecast.WeatherForecast`'s useful public methods(setters are not listed): + +| Method | Description | +|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `getState()` | Returns short weather description. Example: `Clear`. | +| `getDescription()` | Returns weather description. Example: `clear sky`. | +| `getWeatherIconUrl()` | Returns a link to weather icon hosted on https://openweathermap.org website. | +| `getForecastTime()` | Returns `LocalDateTime` object with weather forecast time. | +| `getTemperature()` | Returns `Temperature` instance that contains information about temperature. Available fields: `value`, `maxTemperature`, `minTemperature`, `feelsLike` and `unit`. | +| `getAtmosphericPressure()` | Returns `AtmosphericPressure` instance that contains information about atmospheric pressure. Available fields: `value`, `seaLevelValue`, `groundLevelValue` and `unit`. | +| `getHumidity()` | Returns `Humidity` instance that contains humidity percentage information. | +| `getWind()` | Returns `Wind` instance that contains wind information: `speed`, `degrees` and `unit`. | +| `getRain()` | Returns `Rain` instance that contains information about rain volume for the last 3 hours. Can be absent in case of no data. | +| `getSnow()` | Returns `Snow` instance that contains information about snow volume for the last 3 hours. Can be absent in case of no data. | +| `getClouds()` | Returns `Clouds` instance that contains information about cloudiness percentage. | +| `getForecastTimeISO()` | Returns String with time of data forecasted, ISO, UTC. | +| `getDayTime()` | Returns enumerations representing the part of day(day, night). | +| `toString()` | Returns informative string for the forecast of particular timestamp. | + +### Constants and options + +#### Language +| Constant | Description | +|-----------------------------------|-------------------------------| +| Language.ARABIC | Arabic language. | +| Language.BULGARIAN | Bulgarian language. | +| Language.CATALAN | Catalan language. | +| Language.CZECH | Czech language. | +| Language.GERMAN | German language. | +| Language.GREEK | Greek language. | +| Language.ENGLISH | English language. | +| Language.PERSIAN | Persian (Farsi) language. | +| Language.FINNISH | Finnish language. | +| Language.FRENCH | French language. | +| Language.GALICIAN | Galician language. | +| Language.CROATIAN | Croatian language. | +| Language.HUNGARIAN | Hungarian language. | +| Language.ITALIAN | Italian language. | +| Language.JAPANESE | Japanese language. | +| Language.KOREAN | Korean language. | +| Language.LATVIAN | Latvian language. | +| Language.LITHUANIAN | Lithuanian language. | +| Language.MACEDONIAN | Macedonian language. | +| Language.DUTCH | Dutch language. | +| Language.POLISH | Polish language. | +| Language.PORTUGUESE | Portuguese language. | +| Language.ROMANIAN | Romanian language. | +| Language.RUSSIAN | Russian language. | +| Language.SWEDISH | Swedish language. | +| Language.SLOVAK | Slovak language. | +| Language.SLOVENIAN | Slovenian language. | +| Language.SPANISH | Spanish language. | +| Language.TURKISH | Turkish language. | +| Language.UKRANIAN | Ukrainian language. | +| Language.VIETNAMESE | Vietnamese language. | +| Language.CHINESE_SIMPLIFIED | Chinese Simplified language. | +| Language.CHINESE_TRADITIONAL | Chinese Traditional language. | + +#### Unit +| Constant | Description | +|----------------------|------------------------------------------------| +| Unit.METRIC_SYSTEM | Celsius, meter/sec, hPa, mm(rain, snow). | +| Unit.IMPERIAL_SYSTEM | Fahrenheit, miles/hour, hPa, mm(rain, snow). | +| Unit.STANDARD_SYSTEM | Kelvin, meter/sec, hPa, mm(rain, snow). | + +### Dependencies +* com.fasterxml.jackson.core:jackson-databind:2.12.2 +* org.slf4j:slf4j-api:1.7.30 (*compile*) +* junit:junit:4.13.1 (*test*) \ No newline at end of file diff --git a/docs/SNAPSHOT.md b/docs/SNAPSHOT.md index 2d86235..a9fabea 100644 --- a/docs/SNAPSHOT.md +++ b/docs/SNAPSHOT.md @@ -8,14 +8,14 @@ com.github.prominence openweathermap-api - 2.0.0-SNAPSHOT + 2.0.1-SNAPSHOT ``` ### Gradle coordinates: ```groovy -compile('com.github.prominence:openweathermap-api:2.0.0-SNAPSHOT') +compile('com.github.prominence:openweathermap-api:2.0.1-SNAPSHOT') ``` ### How to use: diff --git a/pom.xml b/pom.xml index 6c2a7c2..7ed6f76 100644 --- a/pom.xml +++ b/pom.xml @@ -6,7 +6,7 @@ com.github.prominence openweathermap-api - 2.0.0-SNAPSHOT + 2.0.1 jar Java OpenWeatherMap API