nymeria 1.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0da433cf7627b6ce7836303ebe5ce5e09f60c1557001f133bb0e63bb1c2e3519
-  data.tar.gz: c552fdc10fbb0435a3432aaf9449597af12993921100eee3fde8dbe89ba782c1
+  metadata.gz: e978077892e3db1fc5b2a5a85196e3c0b337fd77deeea3efbc7ade0d73caf581
+  data.tar.gz: 31074318571d12fca9c33c762d59bddbdc086350b4653074e4a076235fa823b1
 SHA512:
-  metadata.gz: a5dca76b156fea1b15cd8184ab9d50adcba5b1bc3bbce0185e40b49f5177a1a3d069b49bcf088b9cbc7b5de7326706991aa65e10eeec887c86f619af34e00d18
-  data.tar.gz: 0f389958290b388d7d9653d5ea95912b1f7ac1e8641bc4430cf6bff591b5f819eae7e9e48127154341d5a508c4d286499ab62f7c893edc6a0ffc48eb35854554
+  metadata.gz: 90dd2b0a279f240bbfc6c05519aa2f36a9f9f0ef5d84267577695e364d317ff67979c2e1f660ef25b40199bdfb190a72fc6899ca629c8f61a3409d6df4b3cb88
+  data.tar.gz: 3da7b5c6d3dcb507fd9f7d5f2f4309dc0abce3c6b9cf369799566ddaafa3b6a75cea06bc83987e1d87eed14537a2320dd51f3a46647cfcd99deba204169331a7

data/lib/nymeria.rb

@@ -4,7 +4,7 @@ require 'json'
 require 'net/http'
 
 BASE_URL = 'https://www.nymeria.io/api/v3'
-USER_AGENT = 'nymeria.rb/1.0'
+USER_AGENT = 'nymeria.rb/2.0'
 
 # Nymeria is our primary module namespace.
 module Nymeria
@@ -19,6 +19,10 @@ module Nymeria
     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))
@@ -29,7 +33,6 @@ module Nymeria
 
     response = JSON.parse(res.body)
 
-    # Use an open struct here?
     OpenStruct.new(
       success?: response['status'] == 'success',
       error: response['developer_message']
@@ -52,7 +55,6 @@ module Nymeria
 
     response = JSON.parse(res.body)
 
-    # Use an open struct here?
     OpenStruct.new(
       success?: response['status'] == 'success',
       usage: OpenStruct.new(response['usage']),
@@ -65,53 +67,144 @@ module Nymeria
     )
   end
 
-  def self.enrich(url, identifier = '')
-    uri = URI("#{BASE_URL}/enrich")
-    req = request(Net::HTTP::Post.new(uri))
-    req.body = JSON.dump({ url: url, identifier: identifier })
-
-    res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
-      http.request(req)
+  # 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
 
-    response = JSON.parse(res.body)
+    valid_keys = [:url, :identifier, :email, :custom]
 
-    # Use an open struct here?
-    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
+    valid_args = args.select do |arg|
+      arg.is_a?(Hash) && valid_keys.any? { |k| arg.keys.include?(k) }
+    end
 
-  def self.bulk_enrich(people)
-    people = [people] unless people.is_a?(Array)
+    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
 
-    uri = URI("#{BASE_URL}/bulk-enrich")
-    req = request(Net::HTTP::Post.new(uri))
-    req.body = JSON.dump({ people: people })
+    # 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
 
-    res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
-      http.request(req)
+    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
 
-    response = JSON.parse(res.body)
+  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
 
-    # Use an open struct here?
-    OpenStruct.new(
-      success?: response['status'] == 'success',
-      usage: OpenStruct.new(response['usage']),
-      data: response.fetch('data', []).map { |data| OpenStruct.new(data) }
-    )
-  rescue => e
-    OpenStruct.new(
-      success?: false,
-      error: "#{e}"
-    )
+  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

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: nymeria
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.2
 platform: ruby
 authors:
 - Nymeria, LLC
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-29 00:00:00.000000000 Z
+date: 1980-01-01 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
   interact with the API to find and verify people's contact information.
-email: rubygems@nymeria.io
+email: dev@nymeria.io
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -22,8 +22,9 @@ files:
 homepage: https://www.nymeria.io
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  source_code_uri: https://git.nymeria.io/nymeria.rb
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -38,8 +39,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.26
+signing_key:
 specification_version: 4
 summary: Easily interact with Nymeria's API to find and verify people's contact information.
 test_files: []