Nymeria

The official ruby gem to interact with Nymeria's service. You can use Nymeria to enrich data with contact information such as email addresses, phone numbers and social links. The ruby gem wraps Nymeria's public API so you don't have to.

Usage

Installation

gem install nymeria

Setting and Checking an API Key

require 'nymeria'

Nymeria::API_KEY = 'YOUR API KEY GOES HERE'

All actions that interact with the Nymeria service assume an API key has been set and will fail if a key hasn't been set. A key only needs to be set once and can be set at the start of your program.

Verifying an Email Address

require 'nymeria'

Nymeria::API_KEY = 'YOUR API KEY GOES HERE'

resp = Nymeria::Email.verify('dev@nymeria.io')

if resp.status == 200
  puts resp.data['result']
end

You can verify the deliverability of an email address using Nymeria's service. The response will contain a result and tags.

The result will either be "valid" or "invalid". The tags will give you additional details regarding the email address. For example, the tags will tell you if the mail server connection was successful, if the domain's DNS records are set up to send and receive email, etc.

Enriching Profiles

require 'nymeria'

Nymeria::API_KEY = 'YOUR API KEY GOES HERE'

# You can enrich a single record like this.
resp = Nymeria::Person.enrich({ profile: 'github.com/nymeriaio' })

puts "#{c.data['id']} #{c.data['first_name']} #{c.data['skills']}" if c.status == 200

# You can also pass multiple records as an array to do a bulk enrichment.
resp = Nymeria::Person.bulk_enrich({ params: { email: 'foo@bar.com'} }, { params: { profile: 'linkedin.com/in/wozniaksteve' }})

resp.each do |p|
  puts p.dig('data', 'emails')
end

You can enrich one or more profiles using the enrich function. The enrich function takes a hash, or an array of hashes. The most common hash parameters to use are url and email.

If you want to enrich an email address you can specify an email and the Nymeria service will locate the person and return all associated data for them. Likewise, you can specify a supported url via the url parameter if you prefer to enrich via a url.

At this time, Nymeria supports look ups for the following sites:

1. LinkedIn
2. Facebook
3. Twitter
4. GitHub

Please note, if using LinkedIn urls provide the public profile LinkedIn url.

Two other common parameters are filter and require. If you wish to filter out professional emails (only receive personal emails) you can do so by specifying "professional-emails" as the filter parameter.

The require parameter works by requiring certain kinds of data. For example, you can request an enrichment but only receive a result if the profile contains a phone number (or an email, personal email, professional email, etc). The following are all valid requirements:

1. "email"
2. "phone"
3. "professional-email"
4. "personal-email"

You can specify multiple requirements by using a comma between each requirement. For example you can require a phone and personal email with: "phone,personal-email" as the require parameter.

Searching for People

require 'nymeria'

Nymeria::API_KEY = 'YOUR API KEY GOES HERE'

people = Nymeria::Person.search({ query: 'skills:["Ruby on Rails"]' })

if people.status == 200
  people.each do |p|
    puts p.dig('data', 'emails')
  end
end

License

MIT License

Copyright (c) 2022, Nymeria LLC.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.