Class: UseragentApi::Client

Inherits:

Object

• Object
• UseragentApi::Client

Defined in:

lib/useragent_api/client.rb

Overview

A class which wraps calls to UseragentAPI

Instance Attribute Summary

• #api_key ⇒ String readonly

  Returns the api key.

Instance Method Summary

• #initialize(api_key) ⇒ Client constructor

  A new instance of Client.

• #parse(useragent) ⇒ Hash

  Parse an useragent using UseragenAPI.

Constructor Details

#initialize(api_key) ⇒ Client

Returns a new instance of Client.

Parameters:

• api_key (String) —

  UseragentAPI API key

Raises:

• (ArgumentError) —

  when api_key is invalid

See Also:

• https://useragentapi.com/docs/v4

# File 'lib/useragent_api/client.rb', line 13

def initialize(api_key)
  raise ArgumentError, 'invalid API key' if api_key.empty?
  @api_key = api_key.freeze
  freeze
end

Instance Attribute Details

#api_key ⇒ String (readonly)

Returns the api key

Returns:

• (String) —

  Returns the api key

# File 'lib/useragent_api/client.rb', line 20

def api_key
  @api_key
end

Instance Method Details

#parse(useragent) ⇒ Hash

Parse an useragent using UseragenAPI

Parameters:

• useragent (String) —

  an useragent

Returns:

• (Hash) —

  a Hash generated by parsing the JSON returned from the API call, just ‘{}` on parsing failure

# File 'lib/useragent_api/client.rb', line 27

def parse(useragent)
  response = request(useragent)
  parse_as_json(response.body)
end