Skip to content

Commit 6ea1646

Browse files
rakibdevsrakibdevs
authored
Merge pull request #9 from rakibdevs/hotfix/version-compatibility
Added version compatibility for differnent services
2 parents 241f921 + 461ec6c commit 6ea1646

File tree

4 files changed

+152
-169
lines changed

4 files changed

+152
-169
lines changed

‎.php-cs-fixer.cache

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"php":"8.1.6","version":"3.8.0","indent":" ","lineEnding":"\n","rules":{"blank_line_after_namespace":true,"braces":true,"class_definition":true,"constant_case":true,"elseif":true,"function_declaration":true,"indentation_type":true,"line_ending":true,"lowercase_keywords":true,"method_argument_space":{"on_multiline":"ensure_fully_multiline","keep_multiple_spaces_after_comma":true},"no_break_comment":true,"no_closing_tag":true,"no_space_around_double_colon":true,"no_spaces_after_function_name":true,"no_spaces_inside_parenthesis":true,"no_trailing_whitespace":true,"no_trailing_whitespace_in_comment":true,"single_blank_line_at_eof":true,"single_class_element_per_statement":{"elements":["property"]},"single_import_per_statement":true,"single_line_after_imports":true,"switch_case_semicolon_to_colon":true,"switch_case_space":true,"visibility_required":{"elements":["method","property"]},"encoding":true,"full_opening_tag":true,"array_syntax":{"syntax":"short"},"ordered_imports":{"sort_algorithm":"alpha"},"no_unused_imports":true,"not_operator_with_successor_space":true,"trailing_comma_in_multiline":true,"phpdoc_scalar":true,"unary_operator_spaces":true,"binary_operator_spaces":true,"blank_line_before_statement":{"statements":["break","continue","declare","return","throw","try"]},"phpdoc_single_line_var_spacing":true,"phpdoc_var_without_name":true,"single_trait_insert_per_statement":true},"hashes":{"src\/Weather.php":3396563655,"src\/WeatherFormat.php":1780416015,"src\/WeatherClient.php":2559958320,"src\/WeatherServiceProvider.php":1976251433,"src\/Exceptions\/WeatherException.php":1149541561,"src\/Exceptions\/InvalidConfiguration.php":798640689,"src\/config\/openweather.php":75228949}}
1+
{"php":"8.1.10","version":"3.11.0","indent":" ","lineEnding":"\n","rules":{"blank_line_after_namespace":true,"braces":true,"class_definition":true,"constant_case":true,"elseif":true,"function_declaration":true,"indentation_type":true,"line_ending":true,"lowercase_keywords":true,"method_argument_space":{"on_multiline":"ensure_fully_multiline","keep_multiple_spaces_after_comma":true},"no_break_comment":true,"no_closing_tag":true,"no_space_around_double_colon":true,"no_spaces_after_function_name":true,"no_spaces_inside_parenthesis":true,"no_trailing_whitespace":true,"no_trailing_whitespace_in_comment":true,"single_blank_line_at_eof":true,"single_class_element_per_statement":{"elements":["property"]},"single_import_per_statement":true,"single_line_after_imports":true,"switch_case_semicolon_to_colon":true,"switch_case_space":true,"visibility_required":{"elements":["method","property"]},"encoding":true,"full_opening_tag":true,"array_syntax":{"syntax":"short"},"ordered_imports":{"sort_algorithm":"alpha"},"no_unused_imports":true,"not_operator_with_successor_space":true,"trailing_comma_in_multiline":true,"phpdoc_scalar":true,"unary_operator_spaces":true,"binary_operator_spaces":true,"blank_line_before_statement":{"statements":["break","continue","declare","return","throw","try"]},"phpdoc_single_line_var_spacing":true,"phpdoc_var_without_name":true,"single_trait_insert_per_statement":true},"hashes":{"src\/WeatherClient.php":3990504894,"src\/config\/openweather.php":2159394859,"src\/Weather.php":575039304,"src\/WeatherFormat.php":1780416015,"src\/Exceptions\/InvalidConfiguration.php":798640689,"src\/Exceptions\/WeatherException.php":1149541561,"src\/WeatherServiceProvider.php":1976251433}}

‎src/Weather.php

+102-146
Original file line numberDiff line numberDiff line change
@@ -7,157 +7,11 @@
77
*
88
* @package openweather-laravel-api
99
* @author Md. Rakibul Islam <[email protected]>
10-
* @version 1.6
1110
* @since 2021-01-09
1211
*/
1312

1413
class Weather
1514
{
16-
/**
17-
* current weather api endpoint : https://api.openweathermap.org/data/2.5/weather.
18-
* See documentation : https://openweathermap.org/current.
19-
*
20-
* @var string
21-
*/
22-
23-
protected $current = 'weather?';
24-
25-
/**
26-
* onecall api endpoint : https://api.openweathermap.org/data/2.5/onecall.
27-
* See documentation : https://openweathermap.org/api/one-call-api
28-
*
29-
* @var string
30-
*/
31-
32-
protected $one_call = 'onecall?';
33-
34-
/**
35-
* hourly forecast 5 Days 3 hour api endpoint : https://api.openweathermap.org/data/2.5/forecast.
36-
* See documentation : https://openweathermap.org/forecast5.
37-
*
38-
* @var string
39-
*/
40-
41-
protected $forecast = 'forecast?';
42-
43-
/**
44-
* last 5 Days history api endpoint : https://api.openweathermap.org/data/2.5/onecall/timemachine.
45-
* See documentation : https://openweathermap.org/api/one-call-api#history
46-
*
47-
* @var string
48-
*/
49-
50-
protected $historical = 'onecall/timemachine?';
51-
52-
/**
53-
* air pollution api endpoint : https://api.openweathermap.org/data/2.5/air_pollution.
54-
* See documentation : https://openweathermap.org/api/air-pollution.
55-
*
56-
* @var string
57-
*/
58-
59-
protected $air_pollution = 'air_pollution?';
60-
/**
61-
* temp_format available strings are c, f, k.
62-
*
63-
* @var string
64-
*/
65-
66-
67-
/**
68-
* Access current weather data for any location on Earth including over 200,000 cities! Open Weathe Map API collect and process weather data from different sources such as global and local weather models, satellites, radars and vast network of weather stations.
69-
* documentation : https://openweathermap.org/current.
70-
*
71-
* @param array $query
72-
*
73-
*/
74-
75-
76-
private function getCurrent(array $query)
77-
{
78-
$data = (new WeatherClient)->client()->fetch($this->current, $query);
79-
80-
return (new WeatherFormat())->formatCurrent($data);
81-
}
82-
83-
/**
84-
* Make just one API call and get all your essential weather data for a specific location with OpenWeather One Call API.
85-
* documentation : https://openweathermap.org/api/one-call-api.
86-
*
87-
* @param array $query
88-
*
89-
*/
90-
91-
private function getOneCall(array $query)
92-
{
93-
$data = (new WeatherClient)->client()->fetch($this->one_call, $query);
94-
95-
return (new WeatherFormat())->formatOneCall($data);
96-
}
97-
98-
/**
99-
* 5 day forecast is available at any location or city. It includes weather forecast data with 3-hour step.
100-
* documentation : https://openweathermap.org/forecast5.
101-
*
102-
* @param array $query
103-
*
104-
*/
105-
106-
private function get3Hourly(array $query)
107-
{
108-
$data = (new WeatherClient)->client()->fetch($this->forecast, $query);
109-
110-
return (new WeatherFormat())->format3Hourly($data);
111-
}
112-
113-
/**
114-
* Historical weather data for the previous 5 days
115-
* documentation : https://openweathermap.org/api/one-call-api#history.
116-
*
117-
* @param array $query
118-
*
119-
*/
120-
121-
private function getHistorical(array $query)
122-
{
123-
$data = (new WeatherClient)->client()->fetch($this->historical, $query);
124-
125-
return (new WeatherFormat())->formatHistorical($data);
126-
}
127-
128-
/**
129-
* Air Pollution API concept
130-
* Air Pollution API provides current, forecast and historical air pollution data for any coordinates on the globe
131-
* Besides basic Air Quality Index, the API returns data about polluting gases, such as Carbon monoxide (CO), Nitrogen monoxide (NO),
132-
* Nitrogen dioxide (NO2), Ozone (O3),Sulphur dioxide (SO2), Ammonia (NH3), and particulates (PM2.5 and PM10).
133-
* Air pollution forecast is available for 5 days with hourly granularity.
134-
* documentation : https://openweathermap.org/api/air-pollution.
135-
*
136-
* @param array $query
137-
*
138-
*/
139-
140-
private function getAirPollution(array $query)
141-
{
142-
$data = (new WeatherClient)->client()->fetch($this->air_pollution, $query);
143-
144-
return (new WeatherFormat())->formatAirPollution($data);
145-
}
146-
147-
148-
/**
149-
* Geocoding API is a simple tool that we have developed to ease the search for locations while working with geographic names and coordinates.
150-
* documentation : https://openweathermap.org/api/geocoding-api.
151-
*
152-
* @param array $query
153-
*
154-
*/
155-
156-
private function getGeo(string $type, array $query)
157-
{
158-
return (new WeatherClient)->client('geo')->fetch($type, $query);
159-
}
160-
16115
public function getCurrentByCity(string $city)
16216
{
16317
if (! is_numeric($city)) {
@@ -272,4 +126,106 @@ public function getGeoByCord(string $lat, string $lon, string $limit = null)
272126

273127
return $this->getGeo('reverse?', $params);
274128
}
129+
130+
/**
131+
* Access current weather data for any location on Earth including over 200,000 cities!
132+
* Open Weathe Map API collect and process weather data from different sources such as global
133+
* and local weather models, satellites, radars and vast network of weather stations.
134+
*
135+
* Documentation : https://openweathermap.org/current.
136+
*
137+
* @param array $query
138+
*
139+
*/
140+
private function getCurrent(array $query)
141+
{
142+
$ep = 'data/' . config('openweather.weather_api_version', '2.5') . '/weather?';
143+
144+
$data = (new WeatherClient)->client()->fetch($ep, $query);
145+
146+
return (new WeatherFormat())->formatCurrent($data);
147+
}
148+
149+
/**
150+
* Make just one API call and get all your essential weather data for a specific location with OpenWeather One Call API.
151+
* documentation : https://openweathermap.org/api/one-call-api.
152+
*
153+
* @param array $query
154+
*
155+
*/
156+
private function getOneCall(array $query)
157+
{
158+
$ep = 'data/' . config('openweather.onecall_api_version', '2.5') . '/onecall?';
159+
$data = (new WeatherClient)->client()->fetch($ep, $query);
160+
161+
return (new WeatherFormat())->formatOneCall($data);
162+
}
163+
164+
/**
165+
* 5 day forecast is available at any location or city. It includes weather forecast data with 3-hour step.
166+
* documentation : https://openweathermap.org/forecast5.
167+
*
168+
* @param array $query
169+
*
170+
*/
171+
private function get3Hourly(array $query)
172+
{
173+
$ep = 'data/' . config('openweather.forecast_api_version', '2.5') . '/forecast?';
174+
$data = (new WeatherClient)->client()->fetch($ep, $query);
175+
176+
return (new WeatherFormat())->format3Hourly($data);
177+
}
178+
179+
/**
180+
* Historical weather data for the previous 5 days
181+
* documentation : https://openweathermap.org/api/one-call-api#history.
182+
*
183+
* @param array $query
184+
*
185+
*/
186+
private function getHistorical(array $query)
187+
{
188+
$ep = 'data/' . config('openweather.historical_api_version', '2.5') . '/onecall/timemachine?';
189+
$data = (new WeatherClient)->client()->fetch($ep, $query);
190+
191+
return (new WeatherFormat())->formatHistorical($data);
192+
}
193+
194+
/**
195+
* Air Pollution API concept
196+
* Air Pollution API provides current, forecast and historical air pollution data for any coordinates on the globe
197+
* Besides basic Air Quality Index, the API returns data about polluting gases, such as Carbon monoxide (CO), Nitrogen monoxide (NO),
198+
* Nitrogen dioxide (NO2), Ozone (O3),Sulphur dioxide (SO2), Ammonia (NH3), and particulates (PM2.5 and PM10).
199+
* Air pollution forecast is available for 5 days with hourly granularity.
200+
*
201+
* Documentation : https://openweathermap.org/api/air-pollution.
202+
*
203+
* @param array $query
204+
*
205+
*/
206+
private function getAirPollution(array $query)
207+
{
208+
$ep = 'data/' . config('openweather.pollution_api_version', '2.5') . '/air_pollution?';
209+
$data = (new WeatherClient)->client()->fetch($ep, $query);
210+
211+
return (new WeatherFormat())->formatAirPollution($data);
212+
}
213+
214+
215+
/**
216+
* Geocoding API is a simple tool that we have developed to ease the search for locations
217+
* while working with geographic names and coordinates.
218+
*
219+
* Documentation : https://openweathermap.org/api/geocoding-api.
220+
*
221+
* @param string $type
222+
* @param array $query
223+
*
224+
*/
225+
private function getGeo(string $type, array $query)
226+
{
227+
$ep = 'geo/' . config('openweather.geo_api_version', '1.0') . '/' . $type;
228+
229+
return (new WeatherClient)->client()->fetch($ep, $query);
230+
}
275231
}

‎src/WeatherClient.php

+4-16
Original file line numberDiff line numberDiff line change
@@ -27,26 +27,15 @@ class WeatherClient
2727
* @var string
2828
*/
2929

30-
protected $url = 'https://api.openweathermap.org/data/2.5/';
31-
32-
/**
33-
* Geocoding API endpoint : http://api.openweathermap.org/geo/1.0/.
34-
* See documentation : https://openweathermap.org/api/geocoding-api.
35-
*
36-
* @var string
37-
*/
38-
39-
protected $geo_api_url = 'http://api.openweathermap.org/geo/1.0/';
40-
30+
protected $url = 'https://api.openweathermap.org/';
4131

4232
protected $service;
4333

4434
/**
4535
* Units: available units are c, f, k.
4636
*
4737
* For temperature in Fahrenheit (f) and wind speed in miles/hour, use units=imperial
48-
* For temperature in Celsius (c) and wind speed in meter/sec, use units=metric
49-
* Temperature in Kelvin (k) and wind speed in meter/sec is used by default, so there is no need to use the units parameter in the API call if you want this
38+
* For temperature in Celsius (c) and wind speed in meter/sec, use units=metric\
5039
*
5140
* @var array
5241
*/
@@ -96,11 +85,10 @@ private function buildQueryString(array $params)
9685
}
9786

9887

99-
public function client($type = null)
88+
public function client()
10089
{
101-
$url = $type == 'geo' ? $this->geo_api_url : $this->url;
10290
$this->service = new Client([
103-
'base_uri' => $url,
91+
'base_uri' => $this->url,
10492
'timeout' => 10.0,
10593
]);
10694

‎src/config/openweather.php

+45-6
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,64 @@
33
return [
44

55
/**
6-
* Get a free Open Weather Map API key : https://openweathermap.org/price.
6+
* Get a free Open Weather Map API key
7+
* https://openweathermap.org/price.
78
*
89
*/
910

10-
'api_key' => '', // get an API key
11+
'api_key' => env('OPENWAETHER_API_KEY', ""),
1112

1213
/**
13-
* Library https://openweathermap.org/current#multi
14-
*
14+
* Current weather API endpoint : https://api.openweathermap.org/data/2.5/weather.
15+
* See documentation to get the correct version: https://openweathermap.org/current.
16+
*/
17+
'weather_api_version' => '2.5',
18+
19+
/**
20+
* Onecall API endpoint : https://api.openweathermap.org/data/2.5/onecall. Version 3.0 is available now.
21+
* See documentation : https://openweathermap.org/api/one-call-api
22+
*/
23+
'onecall_api_version' => '2.5',
24+
25+
/**
26+
* last 5 Days history API endpoint : https://api.openweathermap.org/data/2.5/onecall/timemachine.
27+
* See documentation : https://openweathermap.org/api/one-call-api#history
28+
*/
29+
'historical_api_version' => '2.5',
30+
31+
/**
32+
* Hourly forecast API endpoint https://api.openweathermap.org/data/2.5/forecast.
33+
* See documentation : https://openweathermap.org/forecast5.
1534
*/
35+
'forecast_api_version' => '2.5',
1636

17-
'lang' => 'en',
37+
/**
38+
* Air pollution api endpoint : https://api.openweathermap.org/data/2.5/air_pollution.
39+
* See documentation : https://openweathermap.org/api/air-pollution.
40+
*/
41+
'polution_api_version' => '2.5',
42+
43+
/**
44+
* Geocoding API: https://openweathermap.org/api/geocoding-api
45+
*/
46+
'geo_api_version' => '1.0',
47+
48+
/**
49+
* Library Configuration
50+
*
51+
* https://openweathermap.org/current#multi
52+
*
53+
*/
1854

55+
'lang' => env('OPENWAETHER_API_LANG', 'en'),
1956
'date_format' => 'm/d/Y',
2057
'time_format' => 'h:i A',
2158
'day_format' => 'l',
2259

2360
/**
24-
* Units: available units are c, f, k. (k is default)
61+
* Unit Configuration
62+
* --------------------------------------
63+
* Available units are c, f, k. (k is default)
2564
*
2665
* For temperature in Fahrenheit (f) and wind speed in miles/hour, use units=imperial
2766
* For temperature in Celsius (c) and wind speed in meter/sec, use units=metric

0 commit comments

Comments
 (0)