weather_API_Assignment 1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/LICENSE +28 -0
- data/README.md +187 -0
- data/lib/weather_api_assignment.rb +46 -0
- data/lib/weather_api_assignment/api_helper.rb +275 -0
- data/lib/weather_api_assignment/configuration.rb +24 -0
- data/lib/weather_api_assignment/controllers/base_controller.rb +51 -0
- data/lib/weather_api_assignment/controllers/weather_ap_is_controller.rb +121 -0
- data/lib/weather_api_assignment/exceptions/api_exception.rb +20 -0
- data/lib/weather_api_assignment/http/auth/custom_query_auth.rb +16 -0
- data/lib/weather_api_assignment/http/faraday_client.rb +64 -0
- data/lib/weather_api_assignment/http/http_call_back.rb +24 -0
- data/lib/weather_api_assignment/http/http_client.rb +104 -0
- data/lib/weather_api_assignment/http/http_context.rb +20 -0
- data/lib/weather_api_assignment/http/http_method_enum.rb +13 -0
- data/lib/weather_api_assignment/http/http_request.rb +50 -0
- data/lib/weather_api_assignment/http/http_response.rb +23 -0
- data/lib/weather_api_assignment/models/base_model.rb +36 -0
- data/lib/weather_api_assignment/models/clouds.rb +35 -0
- data/lib/weather_api_assignment/models/coord.rb +44 -0
- data/lib/weather_api_assignment/models/lang_enum.rb +20 -0
- data/lib/weather_api_assignment/models/main.rb +98 -0
- data/lib/weather_api_assignment/models/mode_enum.rb +20 -0
- data/lib/weather_api_assignment/models/sys.rb +80 -0
- data/lib/weather_api_assignment/models/units_enum.rb +20 -0
- data/lib/weather_api_assignment/models/weather.rb +62 -0
- data/lib/weather_api_assignment/models/weather_api_response.rb +150 -0
- data/lib/weather_api_assignment/models/wind.rb +44 -0
- data/lib/weather_api_assignment/weather_api_assignment_client.rb +27 -0
- metadata +167 -0
@@ -0,0 +1,24 @@
|
|
1
|
+
# weather_api_assignment
|
2
|
+
#
|
3
|
+
# This file was automatically generated by APIMATIC
|
4
|
+
# v2.0 ( https://apimatic.io ).
|
5
|
+
|
6
|
+
# CohesityManagementSdk
|
7
|
+
module WeatherApiAssignment
|
8
|
+
# All configuration including auth info and base URI for the API access
|
9
|
+
# are configured in this class.
|
10
|
+
class Configuration
|
11
|
+
# The base Uri for API calls
|
12
|
+
@base_uri = 'https://api.openweathermap.org/data/2.5'
|
13
|
+
|
14
|
+
# App key for authentication
|
15
|
+
@appid = '178db63aed00f6e4daaa06009b04438b'
|
16
|
+
|
17
|
+
# The attribute accessors for public properties.
|
18
|
+
class << self
|
19
|
+
attr_accessor :array_serialization
|
20
|
+
attr_accessor :base_uri
|
21
|
+
attr_accessor :appid
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
@@ -0,0 +1,51 @@
|
|
1
|
+
# weather_api_assignment
|
2
|
+
#
|
3
|
+
# This file was automatically generated by APIMATIC
|
4
|
+
# v2.0 ( https://apimatic.io ).
|
5
|
+
|
6
|
+
module WeatherApiAssignment
|
7
|
+
# Base controller.
|
8
|
+
class BaseController
|
9
|
+
attr_accessor :http_client, :http_call_back
|
10
|
+
|
11
|
+
def initialize(http_client: nil, http_call_back: nil)
|
12
|
+
@http_client = http_client || FaradayClient.new
|
13
|
+
@http_call_back = http_call_back
|
14
|
+
|
15
|
+
@global_headers = {
|
16
|
+
'user-agent' => 'APIMATIC 2.0'
|
17
|
+
}
|
18
|
+
end
|
19
|
+
|
20
|
+
def validate_parameters(args)
|
21
|
+
args.each do |_name, value|
|
22
|
+
if value.nil?
|
23
|
+
raise ArgumentError, "Required parameter #{_name} cannot be nil."
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
27
|
+
|
28
|
+
def execute_request(request, binary: false)
|
29
|
+
@http_call_back.on_before_request(request) if @http_call_back
|
30
|
+
|
31
|
+
APIHelper.clean_hash(request.headers)
|
32
|
+
request.headers = @global_headers.clone.merge(request.headers)
|
33
|
+
|
34
|
+
response = if binary
|
35
|
+
@http_client.execute_as_binary(request)
|
36
|
+
else
|
37
|
+
@http_client.execute_as_string(request)
|
38
|
+
end
|
39
|
+
context = HttpContext.new(request, response)
|
40
|
+
|
41
|
+
@http_call_back.on_after_response(context) if @http_call_back
|
42
|
+
|
43
|
+
context
|
44
|
+
end
|
45
|
+
|
46
|
+
def validate_response(context)
|
47
|
+
raise APIException.new 'HTTP Response Not OK', context unless
|
48
|
+
context.response.status_code.between?(200, 208) # [200,208] = HTTP OK
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
@@ -0,0 +1,121 @@
|
|
1
|
+
# weather_api_assignment
|
2
|
+
#
|
3
|
+
# This file was automatically generated by APIMATIC
|
4
|
+
# v2.0 ( https://apimatic.io ).
|
5
|
+
|
6
|
+
module WeatherApiAssignment
|
7
|
+
# WeatherAPIsController
|
8
|
+
class WeatherAPIsController < BaseController
|
9
|
+
@instance = WeatherAPIsController.new
|
10
|
+
|
11
|
+
class << self
|
12
|
+
attr_accessor :instance
|
13
|
+
end
|
14
|
+
|
15
|
+
def instance
|
16
|
+
self.class.instance
|
17
|
+
end
|
18
|
+
|
19
|
+
# This is a weather API endpoint which returns the current weather of a
|
20
|
+
# location by city name.
|
21
|
+
# @param [String] q Required parameter: City name, state code and country
|
22
|
+
# code divided by comma, use ISO 3166 country codes.
|
23
|
+
# @param [MODEEnum] mode Optional parameter: Response format. Possible
|
24
|
+
# values are xml and html. If you don't use the mode parameter format is
|
25
|
+
# JSON by default.
|
26
|
+
# @param [UNITSEnum] units Optional parameter: Units of measurement.
|
27
|
+
# standard, metric and imperial units are available. If you do not use the
|
28
|
+
# units parameter, standard units will be applied by default.
|
29
|
+
# @param [LANGEnum] lang Optional parameter: You can use this parameter to
|
30
|
+
# get the output in your language.
|
31
|
+
# @return WeatherAPIResponse response from the API call
|
32
|
+
def get_weather_by_city_name(q,
|
33
|
+
mode = nil,
|
34
|
+
units = nil,
|
35
|
+
lang = nil)
|
36
|
+
# Prepare query url.
|
37
|
+
_path_url = '/weather'
|
38
|
+
_query_builder = Configuration.base_uri.dup
|
39
|
+
_query_builder << _path_url
|
40
|
+
_query_builder = APIHelper.append_url_with_query_parameters(
|
41
|
+
_query_builder,
|
42
|
+
{
|
43
|
+
'q' => q,
|
44
|
+
'mode' => mode,
|
45
|
+
'units' => units,
|
46
|
+
'lang' => lang
|
47
|
+
},
|
48
|
+
array_serialization: Configuration.array_serialization
|
49
|
+
)
|
50
|
+
_query_url = APIHelper.clean_url _query_builder
|
51
|
+
# Prepare headers.
|
52
|
+
_headers = {
|
53
|
+
'accept' => 'application/json'
|
54
|
+
}
|
55
|
+
# Prepare and execute HttpRequest.
|
56
|
+
_request = @http_client.get(
|
57
|
+
_query_url,
|
58
|
+
headers: _headers
|
59
|
+
)
|
60
|
+
CustomQueryAuth.apply(_request)
|
61
|
+
_context = execute_request(_request)
|
62
|
+
validate_response(_context)
|
63
|
+
# Return appropriate response type.
|
64
|
+
decoded = APIHelper.json_deserialize(_context.response.raw_body)
|
65
|
+
WeatherAPIResponse.from_hash(decoded)
|
66
|
+
end
|
67
|
+
|
68
|
+
# This is a weather API endpoint which returns the current weather of a
|
69
|
+
# location by latitude and longitude.
|
70
|
+
# @param [Float] lat Required parameter: This field will contain the
|
71
|
+
# latitude of city
|
72
|
+
# @param [Float] lon Required parameter: This field will contain the
|
73
|
+
# longitude of city
|
74
|
+
# @param [MODEEnum] mode Optional parameter: Response format. Possible
|
75
|
+
# values are xml and html. If you don't use the mode parameter format is
|
76
|
+
# JSON by default.
|
77
|
+
# @param [UNITSEnum] units Optional parameter: Units of measurement.
|
78
|
+
# standard, metric and imperial units are available. If you do not use the
|
79
|
+
# units parameter, standard units will be applied by default.
|
80
|
+
# @param [String] lang Optional parameter: You can use this parameter to get
|
81
|
+
# the output in your language.
|
82
|
+
# @return WeatherAPIResponse response from the API call
|
83
|
+
def get_weather_by_latitude_and_longitude(lat,
|
84
|
+
lon,
|
85
|
+
mode = nil,
|
86
|
+
units = nil,
|
87
|
+
lang = nil)
|
88
|
+
# Prepare query url.
|
89
|
+
_path_url = '/weather'
|
90
|
+
_query_builder = Configuration.base_uri.dup
|
91
|
+
_query_builder << _path_url
|
92
|
+
_query_builder = APIHelper.append_url_with_query_parameters(
|
93
|
+
_query_builder,
|
94
|
+
{
|
95
|
+
'lat' => lat,
|
96
|
+
'lon' => lon,
|
97
|
+
'mode' => mode,
|
98
|
+
'units' => units,
|
99
|
+
'lang' => lang
|
100
|
+
},
|
101
|
+
array_serialization: Configuration.array_serialization
|
102
|
+
)
|
103
|
+
_query_url = APIHelper.clean_url _query_builder
|
104
|
+
# Prepare headers.
|
105
|
+
_headers = {
|
106
|
+
'accept' => 'application/json'
|
107
|
+
}
|
108
|
+
# Prepare and execute HttpRequest.
|
109
|
+
_request = @http_client.get(
|
110
|
+
_query_url,
|
111
|
+
headers: _headers
|
112
|
+
)
|
113
|
+
CustomQueryAuth.apply(_request)
|
114
|
+
_context = execute_request(_request)
|
115
|
+
validate_response(_context)
|
116
|
+
# Return appropriate response type.
|
117
|
+
decoded = APIHelper.json_deserialize(_context.response.raw_body)
|
118
|
+
WeatherAPIResponse.from_hash(decoded)
|
119
|
+
end
|
120
|
+
end
|
121
|
+
end
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# weather_api_assignment
|
2
|
+
#
|
3
|
+
# This file was automatically generated by APIMATIC
|
4
|
+
# v2.0 ( https://apimatic.io ).
|
5
|
+
|
6
|
+
module WeatherApiAssignment
|
7
|
+
# Class for exceptions when there is a network error, status code error, etc.
|
8
|
+
class APIException < StandardError
|
9
|
+
attr_reader :context, :response_code
|
10
|
+
|
11
|
+
# The constructor.
|
12
|
+
# @param [String] The reason for raising an exception.
|
13
|
+
# @param [HttpContext] The HttpContext of the API call.
|
14
|
+
def initialize(reason, context)
|
15
|
+
super(reason)
|
16
|
+
@context = context
|
17
|
+
@response_code = context.response.status_code
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# weather_api_assignment
|
2
|
+
#
|
3
|
+
# This file was automatically generated by APIMATIC
|
4
|
+
# v2.0 ( https://apimatic.io ).
|
5
|
+
|
6
|
+
module WeatherApiAssignment
|
7
|
+
# Utility class for custom query_parameter authorization.
|
8
|
+
class CustomQueryAuth
|
9
|
+
# Add custom authentication to the request.
|
10
|
+
# @param [HttpRequest] The HttpRequest object to which authentication will
|
11
|
+
# be added.
|
12
|
+
def self.apply(http_request)
|
13
|
+
http_request.add_query_parameter('appid', Configuration.appid)
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
@@ -0,0 +1,64 @@
|
|
1
|
+
# weather_api_assignment
|
2
|
+
#
|
3
|
+
# This file was automatically generated by APIMATIC
|
4
|
+
# v2.0 ( https://apimatic.io ).
|
5
|
+
|
6
|
+
require 'faraday/http_cache'
|
7
|
+
require 'faraday_middleware'
|
8
|
+
|
9
|
+
module WeatherApiAssignment
|
10
|
+
# An implementation of HttpClient.
|
11
|
+
class FaradayClient < HttpClient
|
12
|
+
# The constructor.
|
13
|
+
def initialize(timeout: nil, cache: false,
|
14
|
+
max_retries: nil, retry_interval: nil)
|
15
|
+
@connection = Faraday.new do |faraday|
|
16
|
+
faraday.use Faraday::HttpCache, serializer: Marshal if cache
|
17
|
+
faraday.use FaradayMiddleware::FollowRedirects
|
18
|
+
faraday.request :multipart
|
19
|
+
faraday.request :url_encoded
|
20
|
+
faraday.ssl[:ca_file] = Certifi.where
|
21
|
+
faraday.request :retry, max: max_retries, interval: if max_retries &&
|
22
|
+
retry_interval
|
23
|
+
retry_interval
|
24
|
+
end
|
25
|
+
faraday.adapter Faraday.default_adapter
|
26
|
+
faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
|
27
|
+
faraday.options[:open_timeout] = timeout if timeout
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
31
|
+
# Method overridden from HttpClient.
|
32
|
+
def execute_as_string(http_request)
|
33
|
+
response = @connection.send(
|
34
|
+
http_request.http_method.downcase,
|
35
|
+
http_request.query_url
|
36
|
+
) do |request|
|
37
|
+
request.headers = http_request.headers
|
38
|
+
unless http_request.parameters.empty?
|
39
|
+
request.body = http_request.parameters
|
40
|
+
end
|
41
|
+
end
|
42
|
+
convert_response(response)
|
43
|
+
end
|
44
|
+
|
45
|
+
# Method overridden from HttpClient.
|
46
|
+
def execute_as_binary(http_request)
|
47
|
+
response = @connection.send(
|
48
|
+
http_request.http_method.downcase,
|
49
|
+
http_request.query_url
|
50
|
+
) do |request|
|
51
|
+
request.headers = http_request.headers
|
52
|
+
unless http_request.parameters.empty?
|
53
|
+
request.body = http_request.parameters
|
54
|
+
end
|
55
|
+
end
|
56
|
+
convert_response(response)
|
57
|
+
end
|
58
|
+
|
59
|
+
# Method overridden from HttpClient.
|
60
|
+
def convert_response(response)
|
61
|
+
HttpResponse.new(response.status, response.headers, response.body)
|
62
|
+
end
|
63
|
+
end
|
64
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# weather_api_assignment
|
2
|
+
#
|
3
|
+
# This file was automatically generated by APIMATIC
|
4
|
+
# v2.0 ( https://apimatic.io ).
|
5
|
+
|
6
|
+
module WeatherApiAssignment
|
7
|
+
# HttpCallBack allows defining callables for pre and post API calls.
|
8
|
+
class HttpCallBack
|
9
|
+
# A controller will call this method before making an HTTP Request.
|
10
|
+
# @param [HttpRequest] The HttpRequest object which the HttpClient
|
11
|
+
# will execute.
|
12
|
+
def on_before_request(_http_request)
|
13
|
+
raise NotImplementedError, 'This method needs
|
14
|
+
to be implemented in a child class.'
|
15
|
+
end
|
16
|
+
|
17
|
+
# A controller will call this method after making an HTTP Request.
|
18
|
+
# @param [HttpContext] The HttpContext of the API call.
|
19
|
+
def on_after_response(_http_context)
|
20
|
+
raise NotImplementedError, 'This method needs
|
21
|
+
to be implemented in a child class.'
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
@@ -0,0 +1,104 @@
|
|
1
|
+
# weather_api_assignment
|
2
|
+
#
|
3
|
+
# This file was automatically generated by APIMATIC
|
4
|
+
# v2.0 ( https://apimatic.io ).
|
5
|
+
|
6
|
+
module WeatherApiAssignment
|
7
|
+
# An interface for the methods that an HTTP Client must implement.
|
8
|
+
#
|
9
|
+
# This class should not be instantiated but should be used as a base class
|
10
|
+
# for HTTP Client classes.
|
11
|
+
class HttpClient
|
12
|
+
# Execute an HttpRequest when the response is expected to be a string.
|
13
|
+
# @param [HttpRequest] The HttpRequest to be executed.
|
14
|
+
def execute_as_string(_http_request)
|
15
|
+
raise NotImplementedError, 'This method needs
|
16
|
+
to be implemented in a child class.'
|
17
|
+
end
|
18
|
+
|
19
|
+
# Execute an HttpRequest when the response is expected to be binary.
|
20
|
+
# @param [HttpRequest] The HttpRequest to be executed.
|
21
|
+
def execute_as_binary(_http_request)
|
22
|
+
raise NotImplementedError, 'This method needs
|
23
|
+
to be implemented in a child class.'
|
24
|
+
end
|
25
|
+
|
26
|
+
# Converts the HTTP Response from the client to an HttpResponse object.
|
27
|
+
# @param [Dynamic] The response object received from the client.
|
28
|
+
def convert_response(_response)
|
29
|
+
raise NotImplementedError, 'This method needs
|
30
|
+
to be implemented in a child class.'
|
31
|
+
end
|
32
|
+
|
33
|
+
# Get a GET HttpRequest object.
|
34
|
+
# @param [String] The URL to send the request to.
|
35
|
+
# @param [Hash, Optional] The headers for the HTTP Request.
|
36
|
+
def get(query_url,
|
37
|
+
headers: {})
|
38
|
+
HttpRequest.new(HttpMethodEnum::GET,
|
39
|
+
query_url,
|
40
|
+
headers: headers)
|
41
|
+
end
|
42
|
+
|
43
|
+
# Get a HEAD HttpRequest object.
|
44
|
+
# @param [String] The URL to send the request to.
|
45
|
+
# @param [Hash, Optional] The headers for the HTTP Request.
|
46
|
+
def head(query_url,
|
47
|
+
headers: {})
|
48
|
+
HttpRequest.new(HttpMethodEnum::HEAD,
|
49
|
+
query_url,
|
50
|
+
headers: headers)
|
51
|
+
end
|
52
|
+
|
53
|
+
# Get a POST HttpRequest object.
|
54
|
+
# @param [String] The URL to send the request to.
|
55
|
+
# @param [Hash, Optional] The headers for the HTTP Request.
|
56
|
+
# @param [Hash, Optional] The parameters for the HTTP Request.
|
57
|
+
def post(query_url,
|
58
|
+
headers: {},
|
59
|
+
parameters: {})
|
60
|
+
HttpRequest.new(HttpMethodEnum::POST,
|
61
|
+
query_url,
|
62
|
+
headers: headers,
|
63
|
+
parameters: parameters)
|
64
|
+
end
|
65
|
+
|
66
|
+
# Get a PUT HttpRequest object.
|
67
|
+
# @param [String] The URL to send the request to.
|
68
|
+
# @param [Hash, Optional] The headers for the HTTP Request.
|
69
|
+
# @param [Hash, Optional] The parameters for the HTTP Request.
|
70
|
+
def put(query_url,
|
71
|
+
headers: {},
|
72
|
+
parameters: {})
|
73
|
+
HttpRequest.new(HttpMethodEnum::PUT,
|
74
|
+
query_url,
|
75
|
+
headers: headers,
|
76
|
+
parameters: parameters)
|
77
|
+
end
|
78
|
+
|
79
|
+
# Get a PATCH HttpRequest object.
|
80
|
+
# @param [String] The URL to send the request to.
|
81
|
+
# @param [Hash, Optional] The headers for the HTTP Request.
|
82
|
+
# @param [Hash, Optional] The parameters for the HTTP Request.
|
83
|
+
def patch(query_url,
|
84
|
+
headers: {},
|
85
|
+
parameters: {})
|
86
|
+
HttpRequest.new(HttpMethodEnum::PATCH,
|
87
|
+
query_url,
|
88
|
+
headers: headers,
|
89
|
+
parameters: parameters)
|
90
|
+
end
|
91
|
+
|
92
|
+
# Get a DELETE HttpRequest object.
|
93
|
+
# @param [String] The URL to send the request to.
|
94
|
+
# @param [Hash, Optional] The headers for the HTTP Request.
|
95
|
+
def delete(query_url,
|
96
|
+
headers: {},
|
97
|
+
parameters: {})
|
98
|
+
HttpRequest.new(HttpMethodEnum::DELETE,
|
99
|
+
query_url,
|
100
|
+
headers: headers,
|
101
|
+
parameters: parameters)
|
102
|
+
end
|
103
|
+
end
|
104
|
+
end
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# weather_api_assignment
|
2
|
+
#
|
3
|
+
# This file was automatically generated by APIMATIC
|
4
|
+
# v2.0 ( https://apimatic.io ).
|
5
|
+
|
6
|
+
module WeatherApiAssignment
|
7
|
+
# Represents an Http call in context.
|
8
|
+
class HttpContext
|
9
|
+
attr_accessor :request, :response
|
10
|
+
|
11
|
+
# The constructor.
|
12
|
+
# @param [HttpRequest] An HttpRequest object representing the HTTP request.
|
13
|
+
# @param [HttpResponse] An HttpResponse object representing the HTTP
|
14
|
+
# response.
|
15
|
+
def initialize(request, response)
|
16
|
+
@request = request
|
17
|
+
@response = response
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|