peopledatalabs 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8fb77aedefcc1a398eda2c13ba723c6c621644b69149946599f33fea1c776f90
+  data.tar.gz: 237971300ff900343783aed2a61d420afbaa066ec455db221309e68109cee4e8
+SHA512:
+  metadata.gz: b2dd9f3206c667e2b707838b9110325602bf872aa54db0acaa06c5914c0a0ceefe3d76892b41d3ee1b2a24e0c6d2a18492381b0c8f4690cbe3249735ae666b88
+  data.tar.gz: 43ebb2f98b0b9416d24e43c043e87175894f4c4bc233865d02943845ce89d2abff8b22d5939ee20a871bb17e375360a1e40c925cd1941cb79c5e58f20f6180eb

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,26 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+ - peopledatalabs Library Version
+ - Node Version
+ - NPM Version
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/pull_request_template.md

@@ -0,0 +1,10 @@
+## Description of the change
+
+> Description here
+
+## Type of change
+
+- [ ] Bug fix (non-breaking change that fixes an issue)
+- [ ] Chore (cleanup or minor QOL tweak that has little to no impact on functionality)
+- [ ] New feature (non-breaking change that adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

data/.github/workflows/publish.yaml

@@ -0,0 +1,33 @@
+name: Publish Ruby Gem
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem install bundler
+        bundle install
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBY_TOKEN}}"

data/.github/workflows/test.yaml

@@ -0,0 +1,28 @@
+name: Test Package
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6.x
+
+      - name: Build and run test
+        env:
+          PDL_API_KEY: ${{secrets.PDL_API_KEY}}
+        run: |
+          gem install bundler
+          bundle install
+          gem build peopledatalabs.gemspec
+          gem install ./peopledatalabs-1.0.0.gem
+          rake spec

data/.gitignore

@@ -0,0 +1,67 @@
+*.gem
+/.bundle/
+*.rbc
+/.yardoc
+/.config
+/_yardoc/
+/coverage/
+/InstalledFiles
+/doc/
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/.idea
+
+
+# Used by dotenv library to load environment variables.
+# rspec failure tracking
+# .env
+.rspec_status
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+
+
+

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.8
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in peopledatalabs.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 People Data Labs
+
+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.

data/README.md

@@ -0,0 +1,153 @@
+<p align="center">
+<img src="https://i.imgur.com/S7DkZtr.png" width="250" alt="People Data Labs Logo">
+</p>
+<h1 align="center">People Data Labs Ruby Library</h1>
+<p align="center">Official Ruby client for the People Data Labs API.</p>
+
+<p align="center">
+  <a href="">
+    <img src="https://img.shields.io/badge/repo%20status-Active-limegreen" alt="Repo Status">
+  </a>&nbsp;
+  <a href="https://rubygems.org/gems/peopledatalabs">
+    <img src="https://img.shields.io/gem/v/twilio-ruby.svg" alt="People Data Labs on RubyGems" />
+  </a>&nbsp;
+  <a href="">
+    <img src="https://github.com/peopledatalabs/peopledatalabs-ruby/actions/workflows/test.yaml/badge.svg" alt="Tests Status" />
+  </a>
+</p>
+
+#
+This is a simple Ruby client library to access the various API endpoints provided by [People Data Labs](https://www.peopledatalabs.com/).
+
+This library bundles up PDL API requests into simple function calls, making it easy to integrate into your projects. You can use the various [API endpoints](#endpoints) to access up-to-date, real-world data from our massive [Person](https://docs.peopledatalabs.com/docs/stats) and [Company](https://docs.peopledatalabs.com/docs/company-stats) Datasets.
+
+## Table of Contents
+- [🔧 Installation](#installation)
+- [🚀 Usage](#usage)
+- [🌐 Endpoints](#endpoints)
+- [📘 Documentation](#documentation)
+
+## Installation <a name="installation"></a>
+
+1. Add this line to your application's Gemfile:
+
+```ruby
+gem 'peopledatalabs'
+```
+
+2. And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install peopledatalabs
+```
+
+3. Sign up for a [free PDL API key](https://www.peopledatalabs.com/signup)
+
+## 🚀 Usage <a name="usage"></a>
+
+First, add your API Key:
+```ruby
+Peopledatalabs.api_key = 'api_key'
+```
+
+Then, send requests to any PDL API Endpoint:
+
+**Getting Person Data**
+```ruby
+# By Enrichment
+Peopledatalabs::Enrichment.person(params: { phone: '4155688415' })
+
+# By Bulk Enrichment
+Peopledatalabs::Bulk.people(params: {requests: [{params: {profile: ['linkedin.com/in/seanthorne']}}, {params: {profile: ['linkedin.com/in/randrewn']}}]})
+
+# By Search (SQL)
+Peopledatalabs::Search.people(searchType: 'sql', query: "SELECT * FROM person WHERE job_company_name='people data labs'")
+
+# By Search (Elasticsearch)
+Peopledatalabs::Search.people(searchType: 'elastic', query: {"query": {"term": {"job_company_name": "people data labs"}}})
+
+# By PDL_ID
+Peopledatalabs::Retrieve.person(person_id: 'qEnOZ5Oh0poWnQ1luFBfVw_0000')
+
+# By Fuzzy Enrichment
+Peopledatalabs::Identify.person(params: { name: 'sean thorne' })
+```
+
+**Getting Company Data**
+```ruby
+# By Enrichment
+Peopledatalabs::Enrichment.company(params: { website: 'peopledatalabs.com' })
+
+# By Search (SQL)
+Peopledatalabs::Search.company(searchType: 'sql', query: "SELECT * FROM company WHERE tags='big data' AND industry='financial services' AND location.country='united states'")
+
+# By Search (Elasticsearch)
+Peopledatalabs::Search.company(searchType: 'elastic', query: {"query": "must": [{"term": {"tags": "big data"}}, {"term": {"industry": "financial services"}}, {"term": {"location_country": "united states"}}]})
+```
+
+**Using Supporting APIs**
+```ruby
+# Get Autocomplete Suggestions
+Peopledatalabs::Autocomplete.retrieve(field: 'title', text: 'full', size: 10)
+
+# Clean Raw Company Strings
+Peopledatalabs::Cleaner.company(kind: 'name', value: 'peOple DaTa LabS')
+
+# Clean Raw Location Strings
+Peopledatalabs::Cleaner.location(value: '455 Market Street, San Francisco, California 94105, US')
+
+# Clean Raw School Strings
+Peopledatalabs::Cleaner.school(kind: 'name', value: 'university of oregon')
+```
+
+## 🌐 Endpoints <a name="endpoints"></a>
+
+**Person Endpoints**
+| API Endpoint | peopledatalabs Function |
+|-|-|
+| [Person Enrichment API](https://docs.peopledatalabs.com/docs/enrichment-api) | `Peopledatalabs::Enrichment.person(...params)` |
+| [Person Bulk Person Enrichment API](https://docs.peopledatalabs.com/docs/bulk-enrichment-api) | `Peopledatalabs::Bulk.people(...records)` |
+| [Person Search API](https://docs.peopledatalabs.com/docs/search-api) | `Peopledatalabs::Search.person(...params)` |
+| [Person Retrieve API](https://docs.peopledatalabs.com/docs/person-retrieve-api) | `Peopledatalabs::Autocomplete.retrieve(...params)` |
+| [Person Identify API](https://docs.peopledatalabs.com/docs/identify-api) | `Peopledatalabs::Identify.person(...params)` |
+
+**Company Endpoints**
+| API Endpoint | peopledatalabs Function |
+|-|-|
+| [Company Enrichment API](https://docs.peopledatalabs.com/docs/company-enrichment-api) | `Peopledatalabs::Enrichment.company(...params)` |
+| [Company Search API](https://docs.peopledatalabs.com/docs/company-search-api) | `Peopledatalabs::Search.company(...params)` |
+
+**Supporting Endpoints**
+| API Endpoint | peopledatalabs Function |
+|-|-|
+| [Autocomplete API](https://docs.peopledatalabs.com/docs/autocomplete-api) | `Peopledatalabs::Autocomplete.retrieve(...params)` |
+| [Company Cleaner API](https://docs.peopledatalabs.com/docs/cleaner-apis#companyclean) | `Peopledatalabs::Cleaner.company(...params)` |
+| [Location Cleaner API](https://docs.peopledatalabs.com/docs/cleaner-apis#locationclean) | `Peopledatalabs::Cleaner.location(...params)` |
+| [School Cleaner API](https://docs.peopledatalabs.com/docs/cleaner-apis#schoolclean) | `Peopledatalabs::Cleaner.school(...params)` |
+
+
+## 📘 Documentation <a name="documentation"></a>
+
+All of our API endpoints are documented at: https://docs.peopledatalabs.com/
+
+These docs describe the supported input parameters, output responses and also provide additional technical context.
+
+As illustrated in the [Endpoints](#endpoints) section above, each of our API endpoints is mapped to a specific method in the peopledatalabs class.  For each of these class methods, **all function inputs are mapped as input parameters to the respective API endpoint**, meaning that you can use the API documentation linked above to determine the input parameters for each endpoint.
+
+As an example:
+
+The following is **valid** because `name` is a [supported input parameter to the Person Identify API](https://docs.peopledatalabs.com/docs/identify-api-reference#input-parameters):
+```ruby
+Peopledatalabs::Identify.person(params: { name: 'sean thorne' })
+```
+
+Conversely, this would be **invalid** because `fake_parameter` is not an input parameter to the Person Identify API:
+```ruby
+Peopledatalabs::Identify.person(params: { fake_parameter: 'anything' })
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "peopledatalabs"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/peopledatalabs/api_resource.rb

@@ -0,0 +1,119 @@
+module Peopledatalabs
+  class APIResource
+
+    protected
+
+    VALID_AUTOCOMPLETE_FIELDS = ['company', 'country', 'industry', 'location', 'major', 'region', 'role', 'school', 'sub_role', 'skill', 'title'].freeze
+
+    def self.get(path:, headers: {}, params: {})
+      request = check(params: params, path: path)
+      return request unless request['status'] == 200
+
+      response = HTTP
+        .timeout(Peopledatalabs.read_timeout)
+        .headers(headers)
+        .get(url(path), params: query_authentication(params))
+      handle_response(response)
+    end
+
+    def self.post(path:, headers: {}, body: {})
+      request = check(params: body, path: path)
+      return request unless request['status'] == 200
+
+      response = HTTP
+        .timeout(Peopledatalabs.read_timeout)
+        .headers(header_authentication(headers))
+        .post(url(path), json: body)
+      handle_response(response)
+    end
+
+    def self.url(path)
+      "#{Peopledatalabs.api_base}#{path}"
+    end
+
+    def self.query_authentication(params)
+      params.merge({ :api_key => Peopledatalabs.api_key })
+    end
+
+    def self.header_authentication(headers)
+      headers.merge({ 'X-Api-Key' => Peopledatalabs.api_key })
+    end
+
+    def self.to_number(number)
+      return number if number.nil?
+
+      Float(number)
+      i, f = number.to_i, number.to_f
+      i == f ? i : f
+    rescue ArgumentError
+      nil
+    end
+
+    def self.check(params:, path:)
+      result = { 'status' => 200 }
+
+      if !Peopledatalabs.api_key
+        result = {
+          'status' => 401,
+          'message' => 'Invalid API Key'
+        }
+      elsif !Peopledatalabs.api_base
+        result = {
+          'status' => 400,
+          'message' => 'Missing API Base Path'
+        }
+      elsif params.empty?
+        result = {
+          'status' => 400,
+          'message' => "Missing Params"
+        }
+      elsif path.include? '/search'
+        query = params['sql'] || params['query']
+        result = { 'status' => 400, 'message' => 'Missing searchQuery' } unless query
+      elsif path.include?'/retrieve'
+        result = { 'status' => 400, 'message' => 'Missing id' } unless path.match(/\/retrieve\/.+$/)
+      elsif path.include? '/autocomplete'
+        field = params['field']
+        if (!field)
+          result = { 'status' => 400, 'message' => 'Missing field' }
+        elsif (!VALID_AUTOCOMPLETE_FIELDS.include?(field))
+          result = { 'status' => 400, 'message' => "Field should be one of: #{VALID_AUTOCOMPLETE_FIELDS.join(', ')}" }
+        end
+      end
+      result
+    end
+
+    def self.handle_response(response)
+      # Would prefer to keep consistent and always put it in data but right now matching the js lib response
+      # {
+      #   'retry_after' => to_number(response.headers['Retry-After']),
+      #   'rate_limit' => to_number(response.headers['X-RateLimit-Limit']),
+      #   'rateLimit_reset' => to_number(response.headers['X-RateLimit-Reset']),
+      #   'total_limit' => to_number(response.headers['X-TotalLimit-Limit']),
+      #   'total_limit_remaining' => to_number(response.headers['X-RateLimit-Remaining']),
+      #   'search_limit_remaining' => to_number(response.headers['X-SearchLimit-Remaining']),
+      #   'enrich_company_limit_remaining' => to_number(response.headers['X-EnrichCompanyLimit-Remaining']),
+      #   'person_identify_limit_remaining' => to_number(response.headers['X-PersonIdentifyLimit-Remaining'])
+      #   'data' => response.parse
+      # }
+
+      rate_limit = {
+        'retry_after' => to_number(response.headers['Retry-After']),
+        'rate_limit' => to_number(response.headers['X-RateLimit-Limit']),
+        'rateLimit_reset' => to_number(response.headers['X-RateLimit-Reset']),
+        'total_limit' => to_number(response.headers['X-TotalLimit-Limit']),
+        'total_limit_remaining' => to_number(response.headers['X-RateLimit-Remaining']),
+        'search_limit_remaining' => to_number(response.headers['X-SearchLimit-Remaining']),
+        'enrich_company_limit_remaining' => to_number(response.headers['X-EnrichCompanyLimit-Remaining']),
+        'person_identify_limit_remaining' => to_number(response.headers['X-PersonIdentifyLimit-Remaining'])
+      }
+
+      parsed_response = response.parse
+      if response.parse.is_a? Array
+        rate_limit.merge('items' => parsed_response)
+      else
+        rate_limit.merge(parsed_response)
+      end
+    end
+  end
+end

data/lib/peopledatalabs/configuration.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Peopledatalabs
+  class Configuration
+    attr_accessor :api_key
+    attr_accessor :api_base
+    attr_accessor :read_timeout
+
+    def self.setup
+      new.tap do |instance|
+        yield(instance) if block_given?
+      end
+    end
+
+    def initialize
+      @api_base = "https://api.peopledatalabs.com"
+      @read_timeout = 10
+      @api_key ||= ENV['PDL_API_KEY']
+    end
+
+  end
+end

data/lib/peopledatalabs/resources/autocomplete.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Peopledatalabs
+  class Autocomplete < APIResource
+    def self.retrieve(field:, text: '', size: 10, pretty: false)
+
+      params = {
+        'field' => field,
+        'text' => text,
+        'size' => size,
+        'pretty' => pretty,
+      };
+
+      # headers = { 'Accept-Encoding' => 'gzip' }
+      get(path: '/v5/autocomplete', params: params)
+    end
+  end
+end

data/lib/peopledatalabs/resources/bulk.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Peopledatalabs
+  class Bulk < APIResource
+    def self.people(params:)
+      # TODO: possibly add gzip encoding
+      # headers = { 'Accept-Encoding' => 'gzip' }
+      post(path: '/v5/person/bulk', body: params)
+    end
+  end
+end

data/lib/peopledatalabs/resources/cleaner.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Peopledatalabs
+  class Cleaner < APIResource
+    def self.company(kind:, value:)
+      # TODO: possibly add gzip encoding
+      # headers = { 'Accept-Encoding' => 'gzip' }
+      get(path: '/v5/company/clean', params: { kind => value })
+    end
+
+    def self.school(kind:, value:)
+      # TODO: possibly add gzip encoding
+      # headers = { 'Accept-Encoding' => 'gzip' }
+      get(path: '/v5/school/clean', params: { kind => value })
+    end
+
+    def self.location(value:)
+      # TODO: possibly add gzip encoding
+      # headers = { 'Accept-Encoding' => 'gzip' }
+      get(path: '/v5/location/clean', params: { 'location' => value })
+    end
+
+
+  end
+end

data/lib/peopledatalabs/resources/enrichment.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Peopledatalabs
+  class Enrichment < APIResource
+    def self.person(params:)
+      # TODO: possibly add gzip encoding
+      # headers = { 'Accept-Encoding' => 'gzip' }
+      get(path: '/v5/person/enrich', params: params)
+    end
+
+    def self.company(params:)
+      # TODO: possibly add gzip encoding
+      # headers = { 'Accept-Encoding' => 'gzip' }
+      get(path: '/v5/company/enrich', params: params)
+    end
+
+  end
+end

data/lib/peopledatalabs/resources/identify.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Peopledatalabs
+  class Identify < APIResource
+    def self.person(params:)
+      # TODO: possibly add gzip encoding
+      # headers = { 'Accept-Encoding' => 'gzip' }
+      get(path: '/v5/person/identify', params: params)
+    end
+  end
+end

data/lib/peopledatalabs/resources/retrieve.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Peopledatalabs
+  class Retrieve < APIResource
+    def self.person(person_id:, pretty: false)
+      # TODO: possibly add gzip encoding
+      # headers = { 'Accept-Encoding' => 'gzip' }
+      get(path: "/v5/person/retrieve/#{person_id}", params: { 'pretty' => pretty })
+    end
+  end
+end

data/lib/peopledatalabs/resources/search.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Peopledatalabs
+  class Search < APIResource
+    def self.people(searchType:, query: , titlecase: false, dataset: 'all', size: 10, pretty: false, scroll_token: nil)
+      search(searchType: searchType,
+             query: query,
+             titlecase: titlecase,
+             dataset: dataset, size: size,
+             pretty: pretty,
+             scroll_token: scroll_token,
+             kind: 'person')
+    end
+
+    def self.company(searchType:, query: , titlecase: false, dataset: 'all', size: 10, pretty: false, scroll_token: nil)
+      search(searchType: searchType,
+             query: query,
+             titlecase: titlecase,
+             dataset: dataset, size: size,
+             pretty: pretty,
+             scroll_token: scroll_token,
+             kind: 'company')
+    end
+
+    def self.search(searchType:, query:, kind:, titlecase: false, dataset: 'all', size: 10, pretty: false, scroll_token: nil)
+
+      body = {
+        searchType === 'sql' ? 'sql' : 'query' => query,
+        dataset => dataset,
+        size => size,
+        pretty => pretty,
+        titlecase => titlecase,
+        scroll_token => scroll_token
+      }
+
+      # TODO: possibly add gzip encoding
+      # headers = { 'Accept-Encoding' => 'gzip' }
+      post(path: "/v5/#{kind}/search", body: body)
+    end
+  end
+end

data/lib/peopledatalabs/version.rb

@@ -0,0 +1,3 @@
+module Peopledatalabs
+  VERSION = "1.0.0"
+end

data/lib/peopledatalabs.rb

@@ -0,0 +1,56 @@
+require "forwardable"
+require "http"
+require "peopledatalabs/version"
+require 'peopledatalabs/configuration'
+require 'peopledatalabs/api_resource'
+require 'peopledatalabs/resources/cleaner'
+require 'peopledatalabs/resources/search'
+require 'peopledatalabs/resources/autocomplete'
+require 'peopledatalabs/resources/enrichment'
+require 'peopledatalabs/resources/identify'
+require 'peopledatalabs/resources/retrieve'
+require 'peopledatalabs/resources/bulk'
+
+
+# gem build peopledatalabs.gemspec
+# gem install ./peopledatalabs-1.0.0.gem
+# irb
+# require 'peopledatalabs'
+
+# Usage
+# First set api key
+# Peopledatalabs.api_key = 'api_key'
+# Examples Calls:
+# Peopledatalabs::Cleaner.company(kind: 'website', value: 'peopledatalabs.com')
+# Peopledatalabs::Cleaner.school(kind: 'profile', value: 'linkedin.com/school/ucla')
+# Peopledatalabs::Cleaner.location(value: '239 NW 13th Ave, Portland, Oregon 97209, US')
+# Peopledatalabs::Search.people(searchType: 'elastic', query: {"query": {"term": {"job_company_name": "people data labs"}}})
+# Peopledatalabs::Search.people(searchType: 'sql', query: "SELECT * FROM person WHERE job_company_name='people data labs'")
+# Peopledatalabs::Autocomplete.retrieve(field: 'school', text: 'university of michigan')
+# Peopledatalabs::Enrichment.person(params: { name: 'Jennifer C. Jackson', locality: 'Boise' })
+# Peopledatalabs::Bulk.people(params: {requests: [{params: {profile: ['linkedin.com/in/seanthorne']}}, {params: {profile: ['linkedin.com/in/randrewn']}}]})
+# Peopledatalabs::Enrichment.company(params: { name: 'Google, Inc.', ticker: 'GOOGL'})
+# Peopledatalabs::Identify.person(params: { name: 'Jennifer C. Jackson', location: 'Medford, OR USA' })
+# Peopledatalabs::Retrieve.person(person_id: 'qEnOZ5Oh0poWnQ1luFBfVw_0000')
+# Peopledatalabs::Search.company(searchType: 'sql', size: 10, query: "SELECT * FROM company WHERE tags='big data' AND industry='financial services' AND location.country='united states';")
+# Peopledatalabs::Search.company(searchType: 'elastic', size: 10, query: { query: { bool: { must: [{term: {location_country: 'mexico'}}, {term: {job_title_role: 'health'}}, {exists: {field: 'phone_numbers'}}]}}})
+
+module Peopledatalabs
+  class Error < StandardError; end
+
+  @config = Peopledatalabs::Configuration.setup
+
+  class << self
+    extend Forwardable
+
+    attr_reader :config
+
+    def_delegators :@config, :api_key, :api_key=
+    def_delegators :@config, :api_base, :api_base=
+    def_delegators :@config, :read_timeout, :read_timeout=
+  end
+end
+
+
+
+

data/peopledatalabs.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "peopledatalabs/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "peopledatalabs"
+  spec.version       = Peopledatalabs::VERSION
+  spec.authors       = ["People Data Labs"]
+  spec.email         = ["hello@peopledatalabs.com"]
+
+  spec.summary       = "Official Ruby client for the People Data Labs API."
+  spec.description   = "People Data Labs builds people data. Use our dataset of 1.5 Billion unique person profiles to build products, enrich person profiles, power predictive modeling/ai, analysis, and more."
+  spec.homepage      = "https://www.peopledatalabs.com"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/peopledatalabs/peopledatalabs-ruby"
+    spec.metadata["github_repo"] = "https://github.com/peopledatalabs/peopledatalabs-ruby"
+    spec.metadata["documentation_uri"] = "https://docs.peopledatalabs.com"
+    spec.metadata["bug_tracker_uri"] = "https://github.com/peopledatalabs/peopledatalabs-ruby/issues"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.3"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "http", "~> 5.0"
+  spec.add_runtime_dependency "forwardable", "~> 1.3"
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: peopledatalabs
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- People Data Labs
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: forwardable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: People Data Labs builds people data. Use our dataset of 1.5 Billion unique
+  person profiles to build products, enrich person profiles, power predictive modeling/ai,
+  analysis, and more.
+email:
+- hello@peopledatalabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/pull_request_template.md"
+- ".github/workflows/publish.yaml"
+- ".github/workflows/test.yaml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/peopledatalabs.rb
+- lib/peopledatalabs/api_resource.rb
+- lib/peopledatalabs/configuration.rb
+- lib/peopledatalabs/resources/autocomplete.rb
+- lib/peopledatalabs/resources/bulk.rb
+- lib/peopledatalabs/resources/cleaner.rb
+- lib/peopledatalabs/resources/enrichment.rb
+- lib/peopledatalabs/resources/identify.rb
+- lib/peopledatalabs/resources/retrieve.rb
+- lib/peopledatalabs/resources/search.rb
+- lib/peopledatalabs/version.rb
+- peopledatalabs.gemspec
+homepage: https://www.peopledatalabs.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.peopledatalabs.com
+  source_code_uri: https://github.com/peopledatalabs/peopledatalabs-ruby
+  github_repo: https://github.com/peopledatalabs/peopledatalabs-ruby
+  documentation_uri: https://docs.peopledatalabs.com
+  bug_tracker_uri: https://github.com/peopledatalabs/peopledatalabs-ruby/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Official Ruby client for the People Data Labs API.
+test_files: []