nymeria 2.0.2 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e978077892e3db1fc5b2a5a85196e3c0b337fd77deeea3efbc7ade0d73caf581
-  data.tar.gz: 31074318571d12fca9c33c762d59bddbdc086350b4653074e4a076235fa823b1
+  metadata.gz: fb08ca4233a844b53ada6e9cc0b445cd15fadc69988e1aa499f3a0a0aa46bca8
+  data.tar.gz: a681abd80ffa7867b891e428e98bb07132fd2abd488c6205d42fd3f3b9120048
 SHA512:
-  metadata.gz: 90dd2b0a279f240bbfc6c05519aa2f36a9f9f0ef5d84267577695e364d317ff67979c2e1f660ef25b40199bdfb190a72fc6899ca629c8f61a3409d6df4b3cb88
-  data.tar.gz: 3da7b5c6d3dcb507fd9f7d5f2f4309dc0abce3c6b9cf369799566ddaafa3b6a75cea06bc83987e1d87eed14537a2320dd51f3a46647cfcd99deba204169331a7
+  metadata.gz: 124ec16ae948425b7e95803be55dc535c17bbc5ceb4a246428fe6f765dc52b4f8f9e00830c1b33ca4322512ae2e26511881e2e356e2ed4156a50a8b13d453a8f
+  data.tar.gz: 59c37b315b8d86ff920832d2758560adc91c37b45410bee83bab1355fe68582618f2140e2598b7dc948680f3115cc70799bd7cadeebeb26a00285cf9bddf0204

data/lib/company.rb

@@ -0,0 +1,44 @@
+# Nymeria is our primary module namespace.
+module Nymeria
+  module Company
+    # args: { name: '', website: '', profile: '' }
+    def self.enrich(args={})
+      uri = URI("#{BASE_URL}/company/enrich")
+
+      uri.query = URI.encode_www_form(args)
+
+      req = Nymeria::request(Net::HTTP::Get.new(uri))
+
+      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        http.request(req)
+      end
+
+      return OpenStruct.new(JSON.parse(res.body))
+    rescue => e
+      OpenStruct.new(
+        success?: false,
+        error: "#{e}"
+      )
+    end
+
+    # args: { query: 'name:Nymeria', size: 10, from: 0 }
+    def self.search(args={})
+      uri = URI("#{BASE_URL}/company/search")
+
+      uri.query = URI.encode_www_form(args)
+
+      req = Nymeria::request(Net::HTTP::Get.new(uri))
+
+      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        http.request(req)
+      end
+
+      return OpenStruct.new(JSON.parse(res.body))
+    rescue => e
+      OpenStruct.new(
+        success?: false,
+        error: "#{e}"
+      )
+    end
+  end
+end

data/lib/email.rb

@@ -0,0 +1,41 @@
+# Nymeria is our primary module namespace.
+module Nymeria
+  module Email
+    def self.verify(email)
+      uri = URI("#{BASE_URL}/email/verify")
+
+      uri.query = URI.encode_www_form({ email: email.to_s.downcase.strip })
+
+      req = Nymeria::request(Net::HTTP::Get.new(uri))
+
+      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        http.request(req)
+      end
+
+      return OpenStruct.new(JSON.parse(res.body))
+    rescue => e
+      OpenStruct.new(
+        success?: false,
+        error: "#{e}"
+      )
+    end
+
+    def self.bulk_verify(*args)
+      uri = URI("#{BASE_URL}/email/verify/bulk")
+      req = Nymeria::request(Net::HTTP::Post.new(uri))
+      req['Content-Type'] = 'application/json'
+      req.body = JSON.dump({ requests: args })
+
+      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        http.request(req)
+      end
+
+      return JSON.parse(res.body)
+    rescue => e
+      OpenStruct.new(
+        success?: false,
+        error: "#{e}"
+      )
+    end
+  end
+end

data/lib/nymeria.rb

@@ -1,210 +1,23 @@
 # frozen_string_literal: true
 
+require_relative './company.rb'
+require_relative './email.rb'
+require_relative './person.rb'
+
 require 'json'
 require 'net/http'
 
-BASE_URL = 'https://www.nymeria.io/api/v3'
-USER_AGENT = 'nymeria.rb/2.0'
+API_KEY = ''
+BASE_URL = 'https://www.nymeria.io/api/v4'
+USER_AGENT = 'nymeria.rb/2.0.4'
 
 # Nymeria is our primary module namespace.
 module Nymeria
   class << self
-    attr_accessor :api_key
-
     def request(req)
-      req['Content-Type'] = 'application/json'
-      req['X-Api-Key'] = api_key
+      req['X-Api-Key'] = API_KEY
       req['User-Agent'] = USER_AGENT
       req
     end
   end
-
-  def self.authenticated?
-    self.check_authentication.success?
-  end
-
-  def self.check_authentication
-    uri = URI("#{BASE_URL}/check-authentication")
-    req = request(Net::HTTP::Post.new(uri))
-
-    res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
-      http.request(req)
-    end
-
-    response = JSON.parse(res.body)
-
-    OpenStruct.new(
-      success?: response['status'] == 'success',
-      error: response['developer_message']
-    )
-  rescue => e
-    OpenStruct.new(
-      success?: false,
-      error: "#{e}"
-    )
-  end
-
-  def self.verify(email)
-    uri = URI("#{BASE_URL}/verify")
-    req = request(Net::HTTP::Post.new(uri))
-    req.body = JSON.dump({ email: email })
-
-    res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
-      http.request(req)
-    end
-
-    response = JSON.parse(res.body)
-
-    OpenStruct.new(
-      success?: response['status'] == 'success',
-      usage: OpenStruct.new(response['usage']),
-      data: OpenStruct.new(response['data'])
-    )
-  rescue => e
-    OpenStruct.new(
-      success?: false,
-      error: "#{e}"
-    )
-  end
-
-  # Accepts one or more hashes with any of the following: { url: '', identifier: '', email: '', custom: { ... } }
-  def self.enrich(*args)
-    if args.nil? || !args.is_a?(Array)
-      return OpenStruct.new(
-        success?: false,
-        error: "Invalid parameter detected. Requires one or more hashes with any of the following keys; :url, ;identifier or :email."
-      )
-    end
-
-    valid_keys = [:url, :identifier, :email, :custom]
-
-    valid_args = args.select do |arg|
-      arg.is_a?(Hash) && valid_keys.any? { |k| arg.keys.include?(k) }
-    end
-
-    if valid_args.length == 0
-      return OpenStruct.new(
-        success?: false,
-        error: "Invalid parameter detected. Requires one or more hashes with any of the following keys; :url, ;identifier or :email."
-      )
-    end
-
-    # Clean the args; remove any unsupported keys.
-    valid_args.each do |arg|
-      arg.keys.each do |key|
-        arg.delete(key) unless valid_keys.include?(key)
-      end
-    end
-
-    if valid_args.length == 1
-      #
-      # Single Enrichment
-      #
-      begin
-        arg = valid_args.first
-
-        uri = URI("#{BASE_URL}/enrich")
-        req = request(Net::HTTP::Post.new(uri))
-        req.body = JSON.dump(arg)
-
-        res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
-          http.request(req)
-        end
-
-        response = JSON.parse(res.body)
-
-        return OpenStruct.new(
-          success?: response['status'] == 'success',
-          error: response['error'],
-          usage: OpenStruct.new(response['usage']),
-          data: OpenStruct.new(response['data'])
-        )
-      rescue => e
-        return OpenStruct.new(
-          success?: false,
-          error: "#{e}"
-        )
-      end
-    else
-      #
-      # Bulk Enrichment
-      #
-      begin
-        uri = URI("#{BASE_URL}/bulk-enrich")
-        req = request(Net::HTTP::Post.new(uri))
-        req.body = JSON.dump({ people: args })
-
-        res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
-          http.request(req)
-        end
-
-        response = JSON.parse(res.body)
-
-        OpenStruct.new(
-          success?: response['status'] == 'success',
-          error: response['error'],
-          usage: OpenStruct.new(response['usage']),
-          data: response.fetch('data', []).map { |data| OpenStruct.new(data) }
-        )
-      rescue => e
-        OpenStruct.new(
-          success?: false,
-          error: "#{e}"
-        )
-      end
-    end
-  end
-
-  def self.people(query)
-    begin
-      uri = URI("#{BASE_URL}/people")
-      uri.query = URI.encode_www_form(query)
-
-      req = request(Net::HTTP::Get.new(uri))
-
-      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
-        http.request(req)
-      end
-
-      response = JSON.parse(res.body)
-
-      OpenStruct.new(
-        success?: response['status'] == 'success',
-        error: response['error'],
-        usage: OpenStruct.new(response['usage']),
-        data: response.fetch('data', []).map { |data| OpenStruct.new(data) }
-      )
-    rescue => e
-      OpenStruct.new(
-        success?: false,
-        error: "#{e}"
-      )
-    end
-  end
-
-  def self.reveal(uuids)
-    begin
-      uri = URI("#{BASE_URL}/people")
-      req = request(Net::HTTP::Post.new(uri))
-      req.body = JSON.dump({ uuids: uuids })
-
-      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
-        http.request(req)
-      end
-
-      response = JSON.parse(res.body)
-
-      OpenStruct.new(
-        success?: response['status'] == 'success',
-        error: response['error'],
-        usage: OpenStruct.new(response['usage']),
-        data: response.fetch('data', []).map { |data| OpenStruct.new(data) }
-      )
-    rescue => e
-      OpenStruct.new(
-        success?: false,
-        error: "#{e}"
-      )
-    end
-  end
 end

data/lib/person.rb

@@ -0,0 +1,139 @@
+# Nymeria is our primary module namespace.
+module Nymeria
+  module Person
+    # args: { profile: '', email: '', lid: '' }
+    def self.enrich(args={})
+      uri = URI("#{BASE_URL}/person/enrich")
+
+      uri.query = URI.encode_www_form(args)
+
+      req = Nymeria::request(Net::HTTP::Get.new(uri))
+
+      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        http.request(req)
+      end
+
+      return OpenStruct.new(JSON.parse(res.body))
+    rescue => e
+      OpenStruct.new(
+        success?: false,
+        error: "#{e}"
+      )
+    end
+
+    def self.bulk_enrich(*args)
+      uri = URI("#{BASE_URL}/person/enrich/bulk")
+
+      req = Nymeria::request(Net::HTTP::Post.new(uri))
+      req['Content-Type'] = 'application/json'
+      req.body = JSON.dump({ requests: args })
+
+      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        http.request(req)
+      end
+
+      return JSON.parse(res.body)
+    rescue => e
+      OpenStruct.new(
+        success?: false,
+        error: "#{e}"
+      )
+    end
+
+    # args: { profile: '', email: '', lid: '' }
+    def self.preview(args={})
+      uri = URI("#{BASE_URL}/person/enrich/preview")
+
+      uri.query = URI.encode_www_form(args)
+
+      req = Nymeria::request(Net::HTTP::Get.new(uri))
+
+      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        http.request(req)
+      end
+
+      return OpenStruct.new(JSON.parse(res.body))
+    rescue => e
+      OpenStruct.new(
+        success?: false,
+        error: "#{e}"
+      )
+    end
+
+    # args: { name: '', location: '', country: '' }
+    def self.identify(args={})
+      uri = URI("#{BASE_URL}/person/identify")
+
+      uri.query = URI.encode_www_form(args)
+
+      req = Nymeria::request(Net::HTTP::Get.new(uri))
+
+      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        http.request(req)
+      end
+
+      return JSON.parse(res.body)
+    rescue => e
+      OpenStruct.new(
+        success?: false,
+        error: "#{e}"
+      )
+    end
+
+    # args: { query: 'first_name:john & last_name:danner', size: 10, from: 0 }
+    def self.search(args={})
+      uri = URI("#{BASE_URL}/person/search")
+
+      uri.query = URI.encode_www_form(args)
+
+      req = Nymeria::request(Net::HTTP::Get.new(uri))
+
+      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        http.request(req)
+      end
+
+      return OpenStruct.new(JSON.parse(res.body))
+    rescue => e
+      OpenStruct.new(
+        success?: false,
+        error: "#{e}"
+      )
+    end
+
+    def self.retrieve(id)
+      uri = URI("#{BASE_URL}/person/retrieve/#{id}")
+
+      req = Nymeria::request(Net::HTTP::Get.new(uri))
+
+      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        http.request(req)
+      end
+
+      return OpenStruct.new(JSON.parse(res.body))
+    rescue => e
+      OpenStruct.new(
+        success?: false,
+        error: "#{e}"
+      )
+    end
+
+    def self.bulk_retrieve(*args)
+      uri = URI("#{BASE_URL}/person/retrieve/bulk")
+
+      req = Nymeria::request(Net::HTTP::Post.new(uri))
+      req['Content-Type'] = 'application/json'
+      req.body = JSON.dump({ requests: args })
+
+      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        http.request(req)
+      end
+
+      return JSON.parse(res.body)
+    rescue => e
+      OpenStruct.new(
+        success?: false,
+        error: "#{e}"
+      )
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nymeria
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.4
 platform: ruby
 authors:
 - Nymeria, LLC
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 1980-01-01 00:00:00.000000000 Z
+date: 2022-11-03 00:00:00.000000000 Z
 dependencies: []
 description: Nymeria enables people to easily discover and connect with people. This
   gem is a light weight wrapper around Nymeria's API. With this gem you can easily
@@ -18,13 +18,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/company.rb
+- lib/email.rb
 - lib/nymeria.rb
+- lib/person.rb
 homepage: https://www.nymeria.io
 licenses:
 - MIT
 metadata:
   source_code_uri: https://git.nymeria.io/nymeria.rb
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -39,8 +42,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.26
-signing_key:
+rubygems_version: 3.3.5
+signing_key: 
 specification_version: 4
 summary: Easily interact with Nymeria's API to find and verify people's contact information.
 test_files: []