Class: WhoisFreaks::GeolocationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/whoisfreaks/api/geolocation_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GeolocationApi

Returns a new instance of GeolocationApi.



19
20
21
 
# File 'lib/whoisfreaks/api/geolocation_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/whoisfreaks/api/geolocation_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#bulk_geolocation(api_key, bulk_geolocation_request, opts = {}) ⇒ Array<GeolocationResponse>

Bulk IP Geolocation Up to 100 IPs.

Parameters:

  • api_key (String) —

    Your WHOISFreaks API key

  • bulk_geolocation_request (BulkGeolocationRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/whoisfreaks/api/geolocation_api.rb', line 28

def bulk_geolocation(api_key, bulk_geolocation_request, opts = {})
  data, _status_code, _headers = bulk_geolocation_with_http_info(api_key, bulk_geolocation_request, opts)
  data
end

#bulk_geolocation_with_http_info(api_key, bulk_geolocation_request, opts = {}) ⇒ Array<(Array<GeolocationResponse>, Integer, Hash)>

Bulk IP Geolocation Up to 100 IPs.

Parameters:

  • api_key (String) —

    Your WHOISFreaks API key

  • bulk_geolocation_request (BulkGeolocationRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<GeolocationResponse>, Integer, Hash)>) —

    Array data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/whoisfreaks/api/geolocation_api.rb', line 39

def bulk_geolocation_with_http_info(api_key, bulk_geolocation_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GeolocationApi.bulk_geolocation ...'
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling GeolocationApi.bulk_geolocation"
  end
  # verify the required parameter 'bulk_geolocation_request' is set
  if @api_client.config.client_side_validation && bulk_geolocation_request.nil?
    fail ArgumentError, "Missing the required parameter 'bulk_geolocation_request' when calling GeolocationApi.bulk_geolocation"
  end
  # resource path
  local_var_path = '/v1.0/geolocation'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'apiKey'] = api_key

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(bulk_geolocation_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Array<GeolocationResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"GeolocationApi.bulk_geolocation",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GeolocationApi#bulk_geolocation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#geolocation(api_key, ip, opts = {}) ⇒ GeolocationResponse

IP Geolocation Lookup Get location, ASN, currency for an IP. 1 credit.

Parameters:

  • api_key (String) —

    Your WHOISFreaks API key

  • ip (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



103
104
105
106
 
# File 'lib/whoisfreaks/api/geolocation_api.rb', line 103

def geolocation(api_key, ip, opts = {})
  data, _status_code, _headers = geolocation_with_http_info(api_key, ip, opts)
  data
end

#geolocation_with_http_info(api_key, ip, opts = {}) ⇒ Array<(GeolocationResponse, Integer, Hash)>

IP Geolocation Lookup Get location, ASN, currency for an IP. 1 credit.

Parameters:

  • api_key (String) —

    Your WHOISFreaks API key

  • ip (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GeolocationResponse, Integer, Hash)>) —

    GeolocationResponse data, response status code and response headers



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/whoisfreaks/api/geolocation_api.rb', line 114

def geolocation_with_http_info(api_key, ip, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GeolocationApi.geolocation ...'
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling GeolocationApi.geolocation"
  end
  # verify the required parameter 'ip' is set
  if @api_client.config.client_side_validation && ip.nil?
    fail ArgumentError, "Missing the required parameter 'ip' when calling GeolocationApi.geolocation"
  end
  # resource path
  local_var_path = '/v1.0/geolocation'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'apiKey'] = api_key
  query_params[:'ip'] = ip

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GeolocationResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"GeolocationApi.geolocation",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GeolocationApi#geolocation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end