RubyGems - fc_enrich - Versions diffs - 0.2.1 → 0.3.0 - Mend

fc_enrich 0.2.1 → 0.3.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.

Files changed (8) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +3 -0
data/README.md +34 -2
data/lib/fc_enrich.rb +1 -0
data/lib/fc_enrich/company_enrich_request.rb +40 -0
data/lib/fc_enrich/fake_client/post_v3_company.enrich.json +160 -0
data/lib/fc_enrich/version.rb +1 -1
metadata +4 -2

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0f1c306c150ca198c4d1cb6ad1a27413e6ca9b5dba8876b79c81be28099275d
-  data.tar.gz: b4b21640388cabc83290967c2b10d13ecc3004d196e5826060070952618033c4
+  metadata.gz: f240ac261cc95ac2e06e3dfc699c269550a5a7c24fbebf65115f8d517ea46306
+  data.tar.gz: 489a78df78e4b6f246cf4a8ed9bd93b4b239b2e9a0b1dcf3bae99d4febf45d6c
 SHA512:
-  metadata.gz: 8f72860e2d9ddbcd518a3c3350d929fca97e9c6ee968774b991c5acfd6d0d5a27bcd6aa3c36ae5ade52da8346ce150a23dbef7bf61eef7acadf967add8d6ba37
-  data.tar.gz: 2a9bfd59a888586adc8dccfb0d027e1acf71ecdefc80f44d8bb89ece474b785cc25e620c957800d92a03149dab3303800c83da170995a324a653342d4bc38e9f
+  metadata.gz: 22b749b5fdf8e9f0f70ec20c0d94c191aa882658813a53c9942c9693f03655a806a79b8f5fa3014f47ee5392dcf1b3515203b907bc11b3503af6d584597b7b84
+  data.tar.gz: a647676169c8e010e3ae7b5e673545431318a08686c4cf2730c256f3eb1ba082c6abec5fc0041e97a1c5d9003d7fd530c46aec8cac4833cba6892f2c178dda40

data/CHANGELOG.md CHANGED

@@ -1,3 +1,6 @@
+## [0.3.0]
+* CompanyEnrichRequest
 ## [0.2.1]
 * add additional info to fake data

data/README.md CHANGED

@@ -24,6 +24,8 @@ Or install it yourself as:
   FcEnrich.api_key = "[API_KEY]"
 ```
+#### Person Enrich
 see https://platform.fullcontact.com/docs/apis/enrich/multi-field-request
 ```ruby
@@ -64,7 +66,29 @@ see https://platform.fullcontact.com/docs/apis/enrich/multi-field-request
     data_filter: ["social", "employment_history"])
 ```
-## Usage Testing
+#### Company Enrich
+see https://platform.fullcontact.com/docs/apis/enrich/company-enrichment
+```ruby
+  company_request = FcEnrich::CompanyEnrichRequest.new(domain: "fullcontact.com")
+  company = company_request.perform
+  puts company.name # "FullContact, Inc."
+  puts company.location # "1755 Blake Street, Suite 450, Denver, Colorado, United States"
+  puts company.twitter # "@fullcontact"
+  puts company.linkedin # "https://www.linkedin.com/company/fullcontact-inc-"
+  puts company.bio # "FullContact is the ... contacts and be awesome with people."
+  puts company.logo # "https://d2ojpxxtu63wzl.cloudfront.net/stati...8ea9e4d47f5af6c"
+  puts company.website # "https://www.fullcontact.com"
+  puts company.founded # 2010
+  puts company.employees # 350
+  puts company.locale # "en"
+  puts company.category # "Other"
+  puts company.details # ...
+```
+### Testing
 Inside your tests can enable fake mode which will always return the same sample json
@@ -74,11 +98,19 @@ Rspec.describe "Test" do
     allow(FcEnrich).to receive(:use_fake?).and_return(true)
   end
-  it 'returns sample client info' do
+  it 'returns sample person info' do
     person_request = FcEnrich::PersonEnrichRequest.new(email: "any@email.com")
     person = person_request.perform
     expect(person.full_name).to eq("Bart Lorang")
   end
+  it 'returns sample company info' do
+    allow(described_class).to receive(:use_fake?).and_return(true)
+    person_request = FcEnrich::CompanyEnrichRequest.new(domain: "email.com")
+    person = person_request.perform
+    expect(person.name).to eq("FullContact, Inc.")
+  end
 end
 ```

data/lib/fc_enrich.rb CHANGED

@@ -22,4 +22,5 @@ module FcEnrich
 end
 require 'fc_enrich/person_enrich_request'
+require 'fc_enrich/company_enrich_request'
 require 'fc_enrich/fake_client'

data/lib/fc_enrich/company_enrich_request.rb ADDED

@@ -0,0 +1,40 @@
+require 'hashie'
+require 'active_support/core_ext/string'
+require_relative 'http_client'
+module FcEnrich
+  class CompanyEnrichRequest < Hashie::Trash
+    include Hashie::Extensions::IndifferentAccess
+    property :domain
+    property :webhookUrl, from: :webhook_url
+    def perform(http_client: FcEnrich.http_client)
+      Response.new(
+        http_client.post("/v3/company.enrich", to_hash)
+      )
+    end
+    class Response < Hashie::Trash
+      include Hashie::Extensions::IndifferentAccess
+      include Hashie::Extensions::IgnoreUndeclared
+      include Hashie::Extensions::Coercion
+      property :name
+      property :location
+      property :twitter
+      property :linkedin
+      property :bio
+      property :logo
+      property :website
+      property :founded
+      property :employees
+      property :locale
+      property :category
+      property :details
+      coerce_key :details, Hashie::Mash
+    end
+  end
+end

data/lib/fc_enrich/fake_client/post_v3_company.enrich.json ADDED

@@ -0,0 +1,160 @@
+{
+  "name":      "FullContact, Inc.",
+  "location":  "1755 Blake Street, Suite 450, Denver, Colorado, United States",
+  "twitter":   "@fullcontact",
+  "linkedin":  "https://www.linkedin.com/company/fullcontact-inc-",
+  "bio":       "FullContact is the ... contacts and be awesome with people.",
+  "logo":      "https://d2ojpxxtu63wzl.cloudfront.net/static.png",
+  "website":   "https://www.fullcontact.com",
+  "founded":   2010,
+  "employees": 350,
+  "locale":    "en",
+  "category":  "Other",
+  "details":   {
+    "entity": {
+      "name":      "FullContact, Inc",
+      "founded":   2010,
+      "employees": 350
+    },
+    "locales": [{
+      "code": "en",
+      "name": "English"
+    }],
+    "categories": [{
+      "code": "OTHER",
+      "name": "Other"
+    }],
+    "industries": [{
+      "type": "SIC",
+      "name": "Computer Programming, Data Processing, and Other Computer Related Services",
+      "code": "737"
+    },
+    {
+      "type": "NAICS",
+      "name": "Data Processing, Hosting, and Related Services",
+      "code": "5182"
+    }],
+    "emails": [{
+      "value": "support@fullcontact.com",
+      "label": "other"
+    },
+    {
+      "value": "team@fullcontact.com",
+      "label": "sales"
+    },
+    {
+      "value": "sales@fullcontact.com",
+      "label": "work"
+    }],
+    "phones": [{
+      "value": "+1 (720) 475-1292",
+      "label": "other"
+    },
+    {
+      "value": "+1 (888) 330-6943",
+      "label": "other"
+    },
+    {
+      "value": "(303) 717-0414",
+      "label": "other"
+    }],
+    "profiles": {
+      "twitter": {
+        "username":  "fullcontact",
+        "url":       "https://twitter.com/fullcontact",
+        "service":   "twitter",
+        "followers": 2873,
+        "following": 120
+      },
+      "linkedin": {
+        "username": "fullcontact-inc-",
+        "url":      "https://www.linkedin.com/company/fullcontact-inc-",
+        "service":  "linkedin"
+      }
+    },
+    "locations": [{
+      "label":        "Headquarters",
+      "addressLine1": "1755 Blake Street",
+      "addressLine2": "Suite 450",
+      "city":         "Denver",
+      "region":       "Colorado",
+      "regionCode":   "CO",
+      "postalCode":   "80202",
+      "country":      "United States",
+      "countryCode":  "USA",
+      "formatted":    "1755 Blake Street Suite 450 Denver CO 80202"
+    }],
+    "images": [{
+      "url":   "https://d2ojpxxtu63wzl.cloudfront.net/...01842912b",
+      "label": "logo"
+    },
+    {
+      "url":   "https://d2ojpxxtu63wzl.cloudfro...33e489c3aa06c3ac7",
+      "label": "other"
+    }],
+    "urls": [{
+      "value": "https://www.fullcontact.com",
+      "label": "website"
+    },
+    {
+      "value": "https://www.fullcontact.com/feed",
+      "label": "rss"
+    },
+    {
+      "value": "https://www.youtube.com/watch?v=RnltbT0BKMo",
+      "label": "youtube"
+    }],
+    "keywords": [
+      "CRM",
+      "Contact Management",
+      "Developer APIs",
+      "Information Services",
+      "Social Media"
+    ],
+    "traffic": {
+      "countryRank": {
+        "global": {
+          "rank": 40093,
+          "name": "Global"
+        },
+        "us": {
+          "rank": 15545,
+          "name": "United States"
+        }
+      },
+      "localeRank": {
+        "in": {
+          "rank": 29313,
+          "name": "India"
+        },
+        "gb": {
+          "rank": 18772,
+          "name": "United Kingdom"
+        },
+        "us": {
+          "rank": 15545,
+          "name": "United States"
+        }
+      }
+    },
+    "keyPeople": [{
+      "fullName": "Bart Lorang",
+      "title":    "CEO",
+      "avatar":   "https://d2ojpxxtu63wzl.cl...bf84a60c5926701b4c5033"
+    },
+    {
+      "fullName": "Scott Brave",
+      "title":    "CTO",
+      "avatar":   "https://d2ojpxxtu63wzl.cloudf....49ec3bcbb401c47"
+    }]
+  },
+  "dataAddOns": [{
+    "id":          "keypeople",
+    "name":        "Key People",
+    "enabled":     true,
+    "applied":     true,
+    "description": "People of interest at this company",
+    "docLink":     "https://fullcontact../api-next-slate/#keypeople"
+  }],
+  "updated": "2017-11-01"
+}

data/lib/fc_enrich/version.rb CHANGED

@@ -1,3 +1,3 @@
 module FcEnrich
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata CHANGED

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fc_enrich
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Grant Petersen-Speelman
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-01 00:00:00.000000000 Z
+date: 2020-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -111,7 +111,9 @@ files:
 - fc_enrich.gemspec
 - gems.rb
 - lib/fc_enrich.rb
+- lib/fc_enrich/company_enrich_request.rb
 - lib/fc_enrich/fake_client.rb
+- lib/fc_enrich/fake_client/post_v3_company.enrich.json
 - lib/fc_enrich/fake_client/post_v3_person.enrich.json
 - lib/fc_enrich/http_client.rb
 - lib/fc_enrich/person_enrich_request.rb