93 lines
3.5 KiB
Ruby
93 lines
3.5 KiB
Ruby
# The Enterprise::ClearbitLookupService class is responsible for interacting with the Clearbit API.
|
|
# It provides methods to lookup a person's information using their email.
|
|
# Clearbit API documentation: {https://dashboard.clearbit.com/docs?ruby#api-reference}
|
|
# We use the combined API which returns both the person and comapnies together
|
|
# Combined API: {https://dashboard.clearbit.com/docs?ruby=#enrichment-api-combined-api}
|
|
# Persons API: {https://dashboard.clearbit.com/docs?ruby=#enrichment-api-person-api}
|
|
# Companies API: {https://dashboard.clearbit.com/docs?ruby=#enrichment-api-company-api}
|
|
#
|
|
# Note: The Clearbit gem is not used in this service, since it is not longer maintained
|
|
# GitHub: {https://github.com/clearbit/clearbit-ruby}
|
|
#
|
|
# @example
|
|
# Enterprise::ClearbitLookupService.lookup('test@example.com')
|
|
class Enterprise::ClearbitLookupService
|
|
# Clearbit API endpoint for combined lookup
|
|
CLEARBIT_ENDPOINT = 'https://person.clearbit.com/v2/combined/find'.freeze
|
|
|
|
# Performs a lookup on the Clearbit API using the provided email.
|
|
#
|
|
# @param email [String] The email address to lookup.
|
|
# @return [Hash, nil] A hash containing the person's full name, company name, and company timezone, or nil if an error occurs.
|
|
def self.lookup(email)
|
|
return nil unless clearbit_enabled?
|
|
|
|
response = perform_request(email)
|
|
process_response(response)
|
|
rescue StandardError => e
|
|
Rails.logger.error "[ClearbitLookup] #{e.message}"
|
|
nil
|
|
end
|
|
|
|
# Performs a request to the Clearbit API using the provided email.
|
|
#
|
|
# @param email [String] The email address to lookup.
|
|
# @return [HTTParty::Response] The response from the Clearbit API.
|
|
def self.perform_request(email)
|
|
options = {
|
|
headers: { 'Authorization' => "Bearer #{clearbit_token}" },
|
|
query: { email: email }
|
|
}
|
|
|
|
HTTParty.get(CLEARBIT_ENDPOINT, options)
|
|
end
|
|
|
|
# Handles an error response from the Clearbit API.
|
|
#
|
|
# @param response [HTTParty::Response] The response from the Clearbit API.
|
|
# @return [nil] Always returns nil.
|
|
def self.handle_error(response)
|
|
Rails.logger.error "[ClearbitLookup] API Error: #{response.message} (Status: #{response.code})"
|
|
nil
|
|
end
|
|
|
|
# Checks if Clearbit is enabled by checking for the presence of the CLEARBIT_API_KEY environment variable.
|
|
#
|
|
# @return [Boolean] True if Clearbit is enabled, false otherwise.
|
|
def self.clearbit_enabled?
|
|
clearbit_token.present?
|
|
end
|
|
|
|
def self.clearbit_token
|
|
GlobalConfigService.load('CLEARBIT_API_KEY', '')
|
|
end
|
|
|
|
# Processes the response from the Clearbit API.
|
|
#
|
|
# @param response [HTTParty::Response] The response from the Clearbit API.
|
|
# @return [Hash, nil] A hash containing the person's full name, company name, and company timezone, or nil if an error occurs.
|
|
def self.process_response(response)
|
|
return handle_error(response) unless response.success?
|
|
|
|
format_response(response)
|
|
end
|
|
|
|
# Formats the response data from the Clearbit API.
|
|
#
|
|
# @param data [Hash] The raw data from the Clearbit API.
|
|
# @return [Hash] A hash containing the person's full name, company name, and company timezone.
|
|
def self.format_response(response)
|
|
data = response.parsed_response
|
|
|
|
{
|
|
name: data.dig('person', 'name', 'fullName'),
|
|
avatar: data.dig('person', 'avatar'),
|
|
company_name: data.dig('company', 'name'),
|
|
timezone: data.dig('company', 'timeZone'),
|
|
logo: data.dig('company', 'logo'),
|
|
industry: data.dig('company', 'category', 'industry'),
|
|
company_size: data.dig('company', 'metrics', 'employees')
|
|
}
|
|
end
|
|
end
|