enrich-api 1.2.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +8 -8
- data/enrich-api.gemspec +2 -2
- data/lib/enrich-api.rb +2 -2
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: dfd40ac2f422a18cf059f59be7dbc298a6c934d7
|
4
|
+
data.tar.gz: d616b0a4ef2dd87f37b4e30fa19f7f5d2d595864
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 95f847b83331a4356e4bb085d24513e8fcc5998487ccf758c608012dd9fc1bca0c965955f9d1797c30f9f44ea3fffd57a0699584a24887ff2c4661250ae5d582
|
7
|
+
data.tar.gz: bc365dd88f3532d5636c133fba59c1d997f38b022b88672bb7a132b62a1ce05277f780bdc7420c1df7e7c71904d215e102967c1931af6a8f4907921763ef7120
|
data/README.md
CHANGED
@@ -4,7 +4,7 @@ The Enrich API Ruby wrapper. Enrich, Search and Verify data from your Ruby servi
|
|
4
4
|
|
5
5
|
Copyright 2017 Enrich. See LICENSE for copying information.
|
6
6
|
|
7
|
-
* **📝 Implements**: [Enrich REST API ~ v1](https://docs.
|
7
|
+
* **📝 Implements**: [Enrich REST API ~ v1](https://docs.enrich.email/api/v1/) at reference revision: 07/24/2017
|
8
8
|
* **😘 Maintainer**: [@valeriansaliou](https://github.com/valeriansaliou)
|
9
9
|
|
10
10
|
## Usage
|
@@ -21,7 +21,7 @@ Then, import it:
|
|
21
21
|
require 'enrich-api'
|
22
22
|
```
|
23
23
|
|
24
|
-
Construct a new authenticated Enrich client with your `user_id` and `secret_key` tokens (you can generate those from your Enrich Dashboard, [see the docs](https://docs.
|
24
|
+
Construct a new authenticated Enrich client with your `user_id` and `secret_key` tokens (you can generate those from your Enrich Dashboard, [see the docs](https://docs.enrich.email/api/v1/)).
|
25
25
|
|
26
26
|
```ruby
|
27
27
|
client = Enrich::Client.new
|
@@ -39,7 +39,7 @@ data = client.enrich.person({
|
|
39
39
|
|
40
40
|
## Authentication
|
41
41
|
|
42
|
-
To authenticate against the API, generate your tokens (`user_id` and `secret_key`) **once** from your [Enrich Dashboard](https://dashboard.
|
42
|
+
To authenticate against the API, generate your tokens (`user_id` and `secret_key`) **once** from your [Enrich Dashboard](https://dashboard.enrich.email/).
|
43
43
|
|
44
44
|
Then, pass those tokens **once** when you instanciate the Enrich client as following:
|
45
45
|
|
@@ -60,14 +60,14 @@ If a requested data point is already known by the Enrich API, it will be immedia
|
|
60
60
|
|
61
61
|
## Resource Methods
|
62
62
|
|
63
|
-
This library implements all methods the Enrich API provides. See the [API docs](https://docs.
|
63
|
+
This library implements all methods the Enrich API provides. See the [API docs](https://docs.enrich.email/api/v1/) for a reference of available methods, as well as how returned data is formatted.
|
64
64
|
|
65
65
|
### Verify API
|
66
66
|
|
67
67
|
#### Validate an Email
|
68
68
|
|
69
69
|
* **Method:** `client.verify.validate_email(query)`
|
70
|
-
* **Docs:** [https://docs.
|
70
|
+
* **Docs:** [https://docs.enrich.email/api/v1/#validate-an-email](https://docs.enrich.email/api/v1/#validate-an-email)
|
71
71
|
|
72
72
|
```ruby
|
73
73
|
data = client.verify.validate_email({
|
@@ -80,7 +80,7 @@ data = client.verify.validate_email({
|
|
80
80
|
#### Enrich a Person
|
81
81
|
|
82
82
|
* **Method:** `client.enrich.person(query)`
|
83
|
-
* **Docs:** [https://docs.
|
83
|
+
* **Docs:** [https://docs.enrich.email/api/v1/#enrich-a-person](https://docs.enrich.email/api/v1/#enrich-a-person)
|
84
84
|
|
85
85
|
```ruby
|
86
86
|
data = client.enrich.person({
|
@@ -91,7 +91,7 @@ data = client.enrich.person({
|
|
91
91
|
#### Enrich a Company
|
92
92
|
|
93
93
|
* **Method:** `client.enrich.company(query)`
|
94
|
-
* **Docs:** [https://docs.
|
94
|
+
* **Docs:** [https://docs.enrich.email/api/v1/#enrich-a-company](https://docs.enrich.email/api/v1/#enrich-a-company)
|
95
95
|
|
96
96
|
```ruby
|
97
97
|
data = client.enrich.company({
|
@@ -102,7 +102,7 @@ data = client.enrich.company({
|
|
102
102
|
#### Enrich a Network
|
103
103
|
|
104
104
|
* **Method:** `client.enrich.network(query)`
|
105
|
-
* **Docs:** [https://docs.
|
105
|
+
* **Docs:** [https://docs.enrich.email/api/v1/#enrich-a-network](https://docs.enrich.email/api/v1/#enrich-a-network)
|
106
106
|
|
107
107
|
```ruby
|
108
108
|
data = client.enrich.network({
|
data/enrich-api.gemspec
CHANGED
@@ -2,14 +2,14 @@ require File.expand_path("../lib/enrich-api", __FILE__)
|
|
2
2
|
|
3
3
|
Gem::Specification.new do |s|
|
4
4
|
s.name = 'enrich-api'
|
5
|
-
s.version = '
|
5
|
+
s.version = '2.0.0'
|
6
6
|
s.date = Date.today
|
7
7
|
s.summary = "Enrich API Ruby"
|
8
8
|
s.description = "Enrich API Ruby"
|
9
9
|
s.authors = ["Valerian Saliou"]
|
10
10
|
s.email = 'valerian@valeriansaliou.name'
|
11
11
|
s.files = `git ls-files`.split($/)
|
12
|
-
s.homepage = 'https://
|
12
|
+
s.homepage = 'https://enrich.email'
|
13
13
|
s.license = 'MIT'
|
14
14
|
s.require_paths = ['lib']
|
15
15
|
|
data/lib/enrich-api.rb
CHANGED
@@ -34,7 +34,7 @@ module Enrich
|
|
34
34
|
end
|
35
35
|
|
36
36
|
def rest_host
|
37
|
-
@rest_host || "https://api.
|
37
|
+
@rest_host || "https://api.enrich.email"
|
38
38
|
end
|
39
39
|
|
40
40
|
def rest_base_path
|
@@ -61,7 +61,7 @@ module Enrich
|
|
61
61
|
:password => @auth["secret_key"],
|
62
62
|
|
63
63
|
:headers => {
|
64
|
-
:user_agent => "enrich-api-ruby/
|
64
|
+
:user_agent => "enrich-api-ruby/2.0.0",
|
65
65
|
:accept => :json,
|
66
66
|
:content_type => :json,
|
67
67
|
:params => query
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: enrich-api
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version:
|
4
|
+
version: 2.0.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Valerian Saliou
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2018-
|
11
|
+
date: 2018-09-27 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: rest-client
|
@@ -42,7 +42,7 @@ files:
|
|
42
42
|
- lib/enrich-api.rb
|
43
43
|
- lib/resources/enrich.rb
|
44
44
|
- lib/resources/verify.rb
|
45
|
-
homepage: https://
|
45
|
+
homepage: https://enrich.email
|
46
46
|
licenses:
|
47
47
|
- MIT
|
48
48
|
metadata: {}
|