nymeria 2.0.3 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 839c67bea33a0df68637eb52dac24fc62c344ffd02584a40bf431b2dc5471080
-  data.tar.gz: 2d4884cb22c403f3d8cb9ea5148e6917f7dee20875415ad5318a041252afa23c
+  metadata.gz: d19907d591e3f47da8e55eb490a088c78dec0b8a6413c6927fe97a43993b32b0
+  data.tar.gz: 07b999cb5b665ae45ce7e7d311451a694dae7f4f38c6eabe0ee99d11697786b3
 SHA512:
-  metadata.gz: 7e637f6532093b7d2c4cfb4925a4901e0ecfe954667f0bfc7a2813db34b7d868c4b64e57922bbfdd51fa6711f981cdeb43ef2e1e14037154e98fd79b4a6cfa64
-  data.tar.gz: bc39a6e9c23d040c652e15187429cc1a906e5910aacac1317ce49542bf7ae5ee45638666e296fb9d23b1471624d248382a8b4fa56dd7c17fce0c7b59e2aa54b5
+  metadata.gz: facf71b95bf14f4547896ce2bb9659309219ef0c8c8b310591fca70469a439901d6df554861b72ac62d46bab03b67473a2646781c77c7e8be52f7d54be1eacd4
+  data.tar.gz: 6f2f70443a5841bd2b08bd0d46564bbcbd230b44b65c3a0385638b3d5545157f7e6fd3191a359b1810d876e06f91d84e3fbe6ed6c3cd11ef9e9fd35c2dccd212

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 'nymeria/company.rb'
+require 'nymeria/email.rb'
+require 'nymeria/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, :filter, :require]
-
-    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.3
+  version: 2.0.5
 platform: ruby
 authors:
 - Nymeria, LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-21 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,7 +18,10 @@ 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
@@ -39,7 +42,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
+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.