fc_enrich 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a1147796dccb881da70e654d2b12e5cef243b66eff4feff1724ec687239d5cb9
+  data.tar.gz: '09873689133407f5417ea027ef65bdff980fe94f55b12f1d9f627201146786a7'
+SHA512:
+  metadata.gz: b9a4a0d143d97658d104dec92a3530842657db225b6fecb7d44ec7af394cf7286a30d472b50cd78da90181e52ac138d7186ec1093b6e06b4287660c7d2859f90
+  data.tar.gz: 30390d4b4c729a78dd3a83a7cfb169593c083d88b250a1957f1cdbde2231d8be0b2dba9e51bbb8d9c279ef6ef8db115e0f5208f4ade334054b9bc23faff0c2fb

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/.rspec_status
+/gems.locked
+/vendor/bundle
+/.vscode

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - 'vendor/**/*'
+
+Style:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 25

data/.travis.yml

@@ -0,0 +1,15 @@
+---
+language: ruby
+gemfile: gems.rb
+cache: bundler
+rvm:
+  - 2.4
+  - 2.7
+before_install:
+  - yes | gem update --system --force
+  - gem install bundler
+
+script:
+  - bundle install
+  - bundle exec rake
+  - bin/rubocop

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## [0.1.1]
+* PersonEnrichRequest

data/README.md

@@ -0,0 +1,73 @@
+# Full Contact Api
+[![Build Status](https://travis-ci.org/NEXL-LTS/full_contact-ruby.svg?branch=main)](https://travis-ci.org/NEXL-LTS/full_contact-ruby)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fc_enrich'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install fc_enrich
+
+## Usage
+
+```ruby
+  # setup
+  FcEnrich.api_key = "[API_KEY]"
+```
+
+see https://platform.fullcontact.com/docs/apis/enrich/multi-field-request
+
+```ruby
+  person_request = FcEnrich::PersonEnrichRequest.new(email: "bart@fullcontact.com")
+  person = person_request.perform
+  puts person.full_name # "Bart Lorang"
+  puts person.age_range # "30-39"
+  puts person.gender # "Male"
+  puts person.location # "Denver, CO, United States"
+  puts person.title # "Co-Founder & Managing Director"
+  puts person.organization # "V1.vc"
+  puts person.twitter # "https://twitter.com/bartlorang"
+  puts person.linkedin # "https://www.linkedin.com/in/bartlorang"
+  puts person.bio # "CEO & Co-Founder of @FullContact, Managing Director @v1vc_. Tech Entrepreneur, Investor."
+  puts person.avatar # "https://d2ojpxxtu63wzl.cloudfront.net/static/a7e6a5aba590d4933e35eaadabd97fd2_44e00e968ac57725a15b32f9ca714827aff8e4818d290cb0c611f2e2585253b3"
+
+  # example with all options
+  person_request = FcEnrich::PersonEnrichRequest.new(
+    emails: ["bart@fullcontact.com", "bart.lorang@fullcontact.com"],
+    phones: ["+17202227799", "+13035551234"],
+    location: { "address_line1": "123 Main Street",
+                "address_line2": "Unit 2",
+                "city": "Denver",
+                "region": "Colorado",
+                "region_code": "CO",
+                "postal_code": "80203" },
+    name: { "full": "Bart Lorang",
+            "given": "Bart",
+            "family": "Lorang" },
+    profiles: [{ "service": "twitter", "username": "bartlorang" },
+               { "service": "twitter", "userid": "5998422" },
+               { "service": "linkedin", "url": "https://www.linkedin.com/in/bartlorang" },
+               { "service": "github", "url": "https://www.github.com/lorangb"}],
+    maids: ["ape2ch30-pifn-cbvi-30yy-nia-zex7aw5u"],
+    person_id: "eYxWc0B-dKRxerTw_uQpxCssM_GyPaLErj0Eu3y2FrU6py1J",
+    record_id: "customer123",
+    infer: true,
+    data_filter: ["social", "employment_history"])
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fc_enrich"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../gems.rb",
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../gems.rb",
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fc_enrich.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/fc_enrich/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fc_enrich"
+  spec.version       = FcEnrich::VERSION
+  spec.authors       = ["Grant Petersen-Speelman"]
+  spec.email         = ["grant@nexl.io"]
+  spec.license       = "MIT"
+
+  spec.summary       = %q{A ruby client to interact with Full contact API}
+  spec.description   = %q{A ruby client to interact with Full contact API}
+  spec.homepage      = "https://github.com/NEXL-LTS/full_contact-ruby"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/NEXL-LTS/full_contact-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/NEXL-LTS/full_contact-ruby/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.add_dependency 'activesupport', '>= 3.2', '< 7.0'
+  spec.add_dependency 'hashie', '>= 3.1.0', '< 5.0'
+  spec.add_dependency 'multi_json', '>= 1.0.0', '< 2.0'
+  spec.add_dependency 'rest-client', '>= 2.0.0', '< 3.0'
+end

data/gems.rb

@@ -0,0 +1,18 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in snov.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "rubocop"
+gem "rubocop-rspec"
+gem "simplecov"
+gem "webmock"
+
+if ENV['GEM_VERSIONS'] == 'min'
+  gem 'activesupport', '~> 3.2.0'
+  gem 'hashie', '~> 3.1.0'
+  gem 'multi_json', '~> 1.0.0'
+  gem 'rest-client', '~> 2.0.0'
+end

data/lib/fc_enrich.rb

@@ -0,0 +1,16 @@
+require "fc_enrich/version"
+
+module FcEnrich
+  class Error < StandardError; end
+  # Your code goes here...
+
+  def self.api_key=(val)
+    @key = val.to_str
+  end
+
+  def self.api_key
+    @key
+  end
+end
+
+require 'fc_enrich/person_enrich_request'

data/lib/fc_enrich/http_client.rb

@@ -0,0 +1,15 @@
+require 'rest-client'
+require 'multi_json'
+
+module FcEnrich
+  class HttpClient
+    def post(path, payload_hash)
+      response = RestClient.post("https://api.fullcontact.com#{path}",
+                                 MultiJson.encode(payload_hash),
+                                 authorization: "Bearer #{FcEnrich.api_key}")
+      MultiJson.decode(response.body)
+    rescue RestClient::NotFound
+      nil
+    end
+  end
+end

data/lib/fc_enrich/person_enrich_request.rb

@@ -0,0 +1,51 @@
+require 'hashie'
+require 'active_support/core_ext/string'
+
+require_relative 'http_client'
+
+module FcEnrich
+  class PersonEnrichRequest < Hashie::Trash
+    include Hashie::Extensions::IndifferentAccess
+
+    property :email
+    property :emails
+    property :phone
+    property :phones
+    property :location,
+             transform_with: ->(v) { v.transform_keys! { |key| key.to_s.camelize(:lower) } }
+    property :name
+    property :profiles
+    property :maids
+    property :personId, from: :person_id
+    property :recordId, from: :record_id
+    property :dataFilter, from: :data_filter
+    property :infer
+
+    def perform(http_client: HttpClient.new)
+      Response.new(
+        http_client.post("/v3/person.enrich", to_hash)
+      )
+    end
+
+    class Response < Hashie::Trash
+      include Hashie::Extensions::IndifferentAccess
+      include Hashie::Extensions::IgnoreUndeclared
+      include Hashie::Extensions::Coercion
+
+      property :full_name, from: :fullName
+      property :age_range, from: :ageRange
+      property :gender
+      property :location
+      property :title
+      property :organization
+      property :twitter
+      property :linkedin
+      property :facebook
+      property :bio
+      property :avatar
+      property :details
+
+      coerce_key :details, Hashie::Mash
+    end
+  end
+end

data/lib/fc_enrich/version.rb

@@ -0,0 +1,3 @@
+module FcEnrich
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: fc_enrich
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Grant Petersen-Speelman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A ruby client to interact with Full contact API
+email:
+- grant@nexl.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/rubocop
+- bin/setup
+- fc_enrich.gemspec
+- gems.rb
+- lib/fc_enrich.rb
+- lib/fc_enrich/http_client.rb
+- lib/fc_enrich/person_enrich_request.rb
+- lib/fc_enrich/version.rb
+homepage: https://github.com/NEXL-LTS/full_contact-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/NEXL-LTS/full_contact-ruby
+  source_code_uri: https://github.com/NEXL-LTS/full_contact-ruby
+  changelog_uri: https://github.com/NEXL-LTS/full_contact-ruby/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: A ruby client to interact with Full contact API
+test_files: []