snov 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 66024313d2ed01c16ffeeaec3f536f93b00957250903c5d18e3d30458ba4e413
+  data.tar.gz: e915c4231981bd3fad2d4fd6a7eb18dfcdcc2005058d97202a7374cc76df25a0
+SHA512:
+  metadata.gz: ba368d2617e6b8ca49cb9bcde3c75ed8b43348dd187f7a1f60a459b596f9e1999b282eb940114dae99354330583cc33dcc90e95c8c0a1b13d2fe482daf713058
+  data.tar.gz: eef471ba1b9bdcf927fa489addafaf3283f083a6067d7a7b3bba8b414dcbccbf31edc2769ad405fb4abc59cb3129753dee699ab86080faced65e1855435ee4d5

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,5 @@
+## [0.1.0]
+* GetUserLists
+* GetProspectList
+* GetAllProspectsFromList
+* GetProspectsByEmail

data/README.md

@@ -0,0 +1,143 @@
+[![Build Status](https://travis-ci.org/NEXL-LTS/snov-ruby.svg?branch=main)](https://travis-ci.org/NEXL-LTS/snov-ruby)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'snov'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install snov
+
+## Usage
+
+set `SNOV_USER_ID` and `SNOV_SECRET` environment variables
+
+
+### GetProfileByEmail
+
+see https://snov.io/api#GetProfileByEmail
+
+```ruby
+  prospect = Snov::GetProfileByEmail.new(email: "gavin.vanrooyen@octagon.com")
+
+  puts prospect.success
+  puts prospect.id
+  puts prospect.name
+  puts prospect.first_name
+  puts prospect.last_name
+  puts prospect.industry
+  puts prospect.country
+  puts prospect.locality
+  prospect.social.each do |social_info|
+    puts social.link
+    puts social.type
+  end
+  prospect.current_jobs.each do |social_info|
+    puts social.company_name
+    puts social.position
+    # etc
+  end
+  # etc
+```
+
+### GetProspectList
+
+see https://snov.io/api#FindProspectbyEmail
+
+```ruby
+  prospects = Snov::GetProspectsByEmail.new(email: "gavin.vanrooyen@octagon.com")
+  prospects.each do |prospect|
+    puts prospect.id
+    puts prospect.name
+    puts prospect.first_name
+    puts prospect.last_name
+    puts prospect.industry
+    puts prospect.country
+    puts prospect.locality
+    prospect.social.each do |social_info|
+      puts social.link
+      puts social.type
+    end
+    # etc
+  end
+```
+
+### GetUserLists
+
+see https://snov.io/api#UserLists 
+
+```ruby
+  lists = Snov::GetUserLists.new
+  lists.each do |list|
+    puts list.id
+    puts list.name
+    puts list.is_deleted
+    puts list.contacts
+    puts list.creation_date.date
+    puts list.deletion_date.date
+  end
+```
+
+### GetProspectList
+
+see https://snov.io/api#ViewProspectsInList
+
+```ruby
+  prospects = Snov::GetProspectList.new(list_id: 1, page: 1, per_page: 100)
+  prospects.each do |prospect|
+    puts prospect.id
+    puts prospect.name
+    puts prospect.first_name
+    puts prospect.last_name
+    puts prospect.source
+    prospect.emails.each do |email_info|
+      puts email_info.email
+      puts email_info.is_verified
+      puts email_info.job_status
+      # etc
+    end
+  end
+```
+
+### GetAllProspectsFromList
+
+convenience wrapper for `GetProspectList` to get all the prospects on all the pages
+
+see https://snov.io/api#ViewProspectsInList
+
+```ruby
+  prospects = Snov::GetAllProspectsFromList.new(list_id: 1)
+  prospects.each do |prospect|
+    puts prospect.id
+    puts prospect.name
+    puts prospect.first_name
+    puts prospect.last_name
+    puts prospect.source
+    prospect.emails.each do |email_info|
+      puts email_info.email
+      puts email_info.is_verified
+      puts email_info.job_status
+      # etc
+    end
+  end
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rspec` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/snov.
+

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 "snov"
+
+# 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/gems.rb

@@ -0,0 +1,11 @@
+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"

data/lib/snov.rb

@@ -0,0 +1,26 @@
+require "snov/version"
+
+module Snov
+  class Error < StandardError; end
+
+  def self.client
+    if !use_fake?
+      Client.new(client_id: ENV['SNOV_USER_ID'], client_secret: ENV['SNOV_SECRET'])
+    else
+      FakeClient.new
+    end
+  end
+
+  def self.use_fake?
+    ENV['SNOV_USE_FAKE'].present? || (!ENV.key?('SNOV_USER_ID') && !ENV.key?('SNOV_SECRET'))
+  end
+end
+
+require 'active_model'
+require 'snov/client'
+require 'snov/fake_client'
+require 'snov/get_profile_by_email'
+require 'snov/get_all_prospects_from_list'
+require 'snov/get_prospects_by_email'
+require 'snov/get_prospect_list'
+require 'snov/get_user_lists'

data/lib/snov/client.rb

@@ -0,0 +1,104 @@
+require 'faraday'
+require 'multi_json'
+
+module Snov
+  class Client
+    class SnovError < ::Snov::Error; end
+
+    class TimedOut < SnovError; end
+
+    class UnauthorizedError < SnovError; end
+
+    class BadGatewayError < SnovError; end
+
+    class ForbiddenError < SnovError; end
+
+    class GatewayTimeOut < SnovError; end
+
+    class BadRequest < SnovError; end
+
+    class AuthError < SnovError; end
+
+    class MethodNotAllowed < SnovError; end
+    ERROR_CLASSES = { 401 => UnauthorizedError, 502 => BadGatewayError, 403 => ForbiddenError,
+                      504 => GatewayTimeOut, 400 => BadRequest, 405 => MethodNotAllowed }
+
+    def initialize(client_id:, client_secret:, access_token: nil, timeout_seconds: 60)
+      self.client_id = client_id.to_str
+      self.client_secret = client_secret.to_str
+      @access_token = access_token
+      @timeout_seconds = timeout_seconds.to_int
+    end
+
+    def get(path, params = {})
+      resp = conn.get(path) do |req|
+        req.body = MultiJson.dump(params.merge('access_token' => access_token))
+        req.options.timeout = timeout_seconds # open/read timeout in seconds
+        req.options.open_timeout = timeout_seconds # connection open timeout in seconds
+      end
+      parse_response(resp, path, params)
+    rescue Faraday::TimeoutError, Timeout::Error => e
+      raise TimedOut, e.message
+    end
+
+    def post(path, params = {})
+      resp = conn.post(path) do |req|
+        req.body = MultiJson.dump(params.merge('access_token' => access_token))
+        req.options.timeout = timeout_seconds # open/read timeout in seconds
+        req.options.open_timeout = timeout_seconds # connection open timeout in seconds
+      end
+      parse_response(resp, path, params)
+    rescue Faraday::TimeoutError, Timeout::Error => e
+      raise TimedOut, e.message
+    end
+
+    private
+
+    def parse_response(resp, path, _params)
+      unless resp.success?
+        raise ERROR_CLASSES.fetch(resp.status, SnovError),
+              "#{path} (#{resp.status})"
+      end
+      MultiJson.load(resp.body)
+    end
+
+    attr_accessor :client_id, :client_secret, :timeout_seconds
+
+    def access_token
+      return @access_token if @access_token
+
+      @access_token = generate_access_token
+    end
+
+    def access_token_params
+      { 'grant_type' => 'client_credentials', 'client_id' => client_id, 'client_secret' => client_secret }
+    end
+
+    def generate_access_token
+      resp = conn.post('/v1/oauth/access_token') do |req|
+        req.body = MultiJson.dump(access_token_params)
+        req.options.timeout = timeout_seconds # open/read timeout in seconds
+        req.options.open_timeout = timeout_seconds # connection open timeout in seconds
+      end
+      handle_error(resp, "POST /v1/oauth/access_token")
+      raise AuthError, 'Snov auth failed' if resp.body.blank?
+
+      MultiJson.load(resp.body).fetch("access_token")
+    rescue Timeout::Error => e
+      raise TimedOut, e.message
+    end
+
+    def handle_error(resp, prefix)
+      return if resp.success?
+
+      raise ERROR_CLASSES.fetch(resp.status, SnovError), "#{prefix} (#{resp.status})"
+    end
+
+    def conn
+      @conn ||= Faraday.new(
+        url: 'https://api.snov.io',
+        headers: { 'Content-Type' => 'application/json' }
+      )
+    end
+  end
+end

data/lib/snov/fake_client.rb

@@ -0,0 +1,14 @@
+module Snov
+  class FakeClient
+    def get(path)
+      data = File.read("#{__dir__}/fake_client/get#{path.tr("/", "_")}.json")
+      MultiJson.load(data)
+    end
+
+    def post(path, params = {})
+      params.to_a.map(&:join).join("&")
+      data = File.read("#{__dir__}/fake_client/post#{path.tr("/", "_")}.json")
+      MultiJson.load(data)
+    end
+  end
+end

data/lib/snov/fake_client/get_v1_get-user-lists.json

@@ -0,0 +1,46 @@
+[
+    {
+        "id": 1818597,
+        "name": "FirstSend",
+        "contacts": 1,
+        "isDeleted": false,
+        "creationDate": {
+            "date": "2020-04-07 08:25:44.000000",
+            "timezone_type": 3,
+            "timezone": "UTC"
+        },
+        "deletionDate": null
+    },
+    {
+        "id": 1505383,
+        "name": "All prospects",
+        "contacts": 10,
+        "isDeleted": true,
+        "creationDate": {
+            "date": "2019-12-17 15:07:30.000000",
+            "timezone_type": 3,
+            "timezone": "UTC"
+        },
+        "deletionDate": {
+            "date": "2020-02-17 14:05:44.000000",
+            "timezone_type": 3,
+            "timezone": "UTC"
+        }
+    },
+    {
+        "id": 1479070,
+        "name": "EMAIL",
+        "contacts": 13,
+        "isDeleted": true,
+        "creationDate": {
+            "date": "2019-12-06 10:51:01.000000",
+            "timezone_type": 3,
+            "timezone": "UTC"
+        },
+        "deletionDate": {
+            "date": "2020-02-17 14:05:48.000000",
+            "timezone_type": 3,
+            "timezone": "UTC"
+        }
+    }
+]

data/lib/snov/fake_client/post_v1_get-profile-by-email.json

@@ -0,0 +1,103 @@
+{
+    "success": true,
+    "id": 301592,
+    "source": "linkedIn",
+    "name": "Lizi Hamer",
+    "firstName": "Lizi",
+    "lastName": "Hamer",
+    "logo": "https://app.snov.io/img/peoples/010fcf23c70dfa68d880545ec89a9215.jpg",
+    "industry": null,
+    "country": "Singapore",
+    "locality": "Singapore",
+    "social": [
+        {
+            "link": "https://www.linkedin.com/in/lizihamer/",
+            "type": "linkedIn"
+        },
+        {
+            "link": "https://twitter.com/LiziHamer",
+            "type": "twitter"
+        }
+    ],
+    "currentJobs": [
+        {
+            "companyName": "Octagon",
+            "position": "Regional Creative Director",
+            "socialLink": "https://www.linkedin.com/company/165282",
+            "site": "www.octagon.com",
+            "locality": "Greater New York City Area",
+            "state": "Connecticut",
+            "city": "Stamford",
+            "street": "290 Harbor Dr",
+            "street2": "2nd Floor",
+            "postal": "06902",
+            "founded": "1983",
+            "startDate": "2016-01-31",
+            "endDate": null,
+            "size": "1-10",
+            "industry": "Marketing and Advertising",
+            "companyType": "Public Company",
+            "country": "United States"
+        },
+        {
+            "companyName": "SisuGirls",
+            "position": "Co Founder",
+            "socialLink": "https://www.linkedin.com/company/3841118",
+            "site": "http://www.sisugirls.org",
+            "locality": null,
+            "state": "SG",
+            "city": "Singapore",
+            "street": "33-03 Hong Leong Building",
+            "street2": null,
+            "postal": null,
+            "founded": "2014",
+            "startDate": "2015-07-31",
+            "endDate": null,
+            "size": "1-10",
+            "industry": "Health, Wellness and Fitness",
+            "companyType": null,
+            "country": "Singapore"
+        }
+    ],
+    "previousJobs": [
+        {
+            "companyName": "Fusion Co-innovation Labs",
+            "position": "Creative Entrepreneur",
+            "socialLink": null,
+            "site": null,
+            "locality": null,
+            "state": null,
+            "city": null,
+            "street": null,
+            "street2": null,
+            "postal": null,
+            "founded": null,
+            "startDate": "2013-05-31",
+            "endDate": "2013-10-31",
+            "size": null,
+            "industry": null,
+            "companyType": null,
+            "country": null
+        },
+        {
+            "companyName": "Russell Commission",
+            "position": "Youth Advisory Board Member",
+            "socialLink": null,
+            "site": null,
+            "locality": null,
+            "state": null,
+            "city": null,
+            "street": null,
+            "street2": null,
+            "postal": null,
+            "founded": null,
+            "startDate": "2004-06-30",
+            "endDate": "2006-06-30",
+            "size": null,
+            "industry": null,
+            "companyType": null,
+            "country": null
+        }
+    ],
+    "lastUpdateDate": "2018-02-07 10:12:28"
+    }

data/lib/snov/fake_client/post_v1_get-prospects-by-email.json

@@ -0,0 +1,75 @@
+{
+    "success": true,
+    "data": [
+      {
+        "id": "xusD3-T_K5IktGoaa8Jc8A==",
+        "name": "Gavin Vanrooyen",
+        "firstName": "Gavin",
+        "lastName": "Vanrooyen",
+        "industry": "Entertainment",
+        "country": "United States",
+        "locality": "Greater Atlanta Area",
+        "social": [
+          {
+            "link": "https:\/\/www.linkedin.com\/in\/gavin-vanrooyen-809073755\/",
+            "type": "linkedIn"
+          }
+        ],
+        "lastUpdateDate": {
+          "date": "2019-09-11 12:37:58.000000",
+          "timezone_type": 3,
+          "timezone": "UTC"
+        },
+        "currentJob": [
+          {
+            "companyName": "Octagon",
+            "position": "Senior Brand Director",
+            "socialLink": "https:\/\/www.linkedin.com\/company\/659333",
+            "site": "http:\/\/octagon.com",
+            "locality": "United States",
+            "state": null,
+            "city": null,
+            "street": null,
+            "street2": null,
+            "postal": null,
+            "founded": null,
+            "startDate": "2018-07-31",
+            "endDate": null,
+            "size": "1-10",
+            "industry": "Entertainment",
+            "companyType": "Public Company",
+            "country": "United States"
+          }
+        ],
+        "previousJob": [
+          {
+            "companyName": "UPS",
+            "position": "Manager, Sponsorships and Events",
+            "socialLink": "https:\/\/www.linkedin.com\/company\/1523574",
+            "site": "http:\/\/www.ups.com\/",
+            "locality": "United States",
+            "state": "GA",
+            "city": "Atlanta",
+            "street": "55 Glenlake Parkway, NE",
+            "street2": null,
+            "postal": "30328",
+            "founded": "1907",
+            "startDate": null,
+            "endDate": null,
+            "size": "10001+",
+            "industry": "Logistics and Supply Chain",
+            "companyType": "Public Company",
+            "country": "United States"
+          }
+        ],
+        "lists": [
+          {
+            "id": 1250344,
+            "name": "People List"
+          }
+        ],
+        "campaigns": []
+      }
+    ]
+  }
+  

data/lib/snov/fake_client/post_v1_prospect-list.json

@@ -0,0 +1,55 @@
+{
+    "success": true,
+    "list": {
+        "name": "Lead LIST",
+        "contacts": 3,
+        "creationDate": {
+            "date": "2020-05-19 17:34:39.000000",
+            "timezone_type": 3,
+            "timezone": "UTC"
+        },
+        "emailsCount": []
+    },
+    "prospects": [
+        {
+            "id": "226db935fc93422496fda5d5209e8cbf77cc77ec685891706028009b86608f7ce5877a3faf",
+            "name": "Andrew Garfiled",
+            "firstName": "Andrew",
+            "lastName": "Garfiled",
+            "emails": [
+                {
+                    "email": "andrewexp@exp.com",
+                    "probability": 99,
+                    "isVerified": null,
+                    "jobStatus": "any",
+                    "domainType": "linkedin_email",
+                    "isValidFormat": null,
+                    "isDisposable": null,
+                    "isWebmail": null,
+                    "isGibberish": null,
+                    "smtpStatus": null
+                }
+            ]
+        },
+        {
+            "id": "f20d30219b039d1408d837a748a1e2ab843c97e65080f6cf8fa7d948477d9093d87413f05f",
+            "name": "John Doe",
+            "firstName": "John",
+            "lastName": "Doe",
+            "emails": [
+                {
+                    "email": "johndoe@gmail.com",
+                    "probability": 99,
+                    "isVerified": null,
+                    "jobStatus": "any",
+                    "domainType": "linkedin_email",
+                    "isValidFormat": true,
+                    "isDisposable": false,
+                    "isWebmail": true,
+                    "isGibberish": false,
+                    "smtpStatus": 3
+                }
+            ]
+        }
+    ]
+}

data/lib/snov/get_all_prospects_from_list.rb

@@ -0,0 +1,26 @@
+module Snov
+  class GetAllProspectsFromList
+    include Enumerable
+
+    attr_reader :client, :list_id, :max, :per_page
+
+    def initialize(list_id:, max: 9999, per_page: 100, client: Snov.client)
+      @client = client
+      @list_id = list_id
+      @max = max.to_int
+      @per_page = per_page
+    end
+
+    def each(&block)
+      (1..max).each do |page|
+        list = GetProspectList.new(list_id: list_id, page: page, per_page: per_page,
+                                   client: client)
+        prospects = list.prospects
+
+        prospects.each(&block)
+
+        break if prospects.size < per_page
+      end
+    end
+  end
+end

data/lib/snov/get_profile_by_email.rb

@@ -0,0 +1,84 @@
+require 'active_support/core_ext/array'
+
+module Snov
+  class GetProfileByEmail
+    attr_reader :client, :email
+
+    def initialize(email:, client: Snov.client)
+      @client = client
+      @email = email.to_str
+    end
+
+    def each(&block)
+      prospects.each(&block)
+    end
+
+    def prospect
+      @prospect ||= ProspectResult.new(raw_result)
+    end
+
+    def method_missing(method_name, *arguments, &block)
+      if prospect.respond_to?(method_name)
+        prospect.public_send(method_name, *arguments, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      prospect.respond_to?(method_name) || super
+    end
+
+    def raw_result
+      @raw_result ||= client.post("/v1/get-profile-by-email",
+                                  'email' => email)
+                            .deep_transform_keys! { |key| key.underscore }
+    end
+
+    class Job
+      include ActiveModel::Model
+
+      attr_accessor :company_name, :position, :social_link, :site, :locality, :state, :city
+      attr_accessor :street, :street2, :postal, :founded, :start_date, :end_date, :size
+      attr_accessor :industry, :company_type, :country
+    end
+
+    class Social
+      include ActiveModel::Model
+
+      attr_accessor :link, :type
+    end
+
+    class List
+      include ActiveModel::Model
+
+      attr_accessor :id, :name
+    end
+
+    class ProspectResult
+      include ActiveModel::Model
+
+      attr_accessor :id, :name, :first_name, :last_name, :industry, :country, :locality, :success, :source
+      attr_accessor :logo, :last_update_date, :message
+      attr_reader :social, :current_jobs, :previous_jobs
+
+      def social=(val)
+        @social = Array.wrap(val).map do |rel|
+          Social.new(rel)
+        end
+      end
+
+      def current_jobs=(val)
+        @current_jobs = Array.wrap(val).map do |rel|
+          Job.new(rel)
+        end
+      end
+
+      def previous_jobs=(val)
+        @previous_jobs = Array.wrap(val).map do |rel|
+          Job.new(rel)
+        end
+      end
+    end
+  end
+end

data/lib/snov/get_prospect_list.rb

@@ -0,0 +1,59 @@
+require 'active_support/core_ext/array'
+
+module Snov
+  class GetProspectList
+    include Enumerable
+
+    attr_reader :client, :list_id, :page, :per_page
+
+    def initialize(list_id:, page:, per_page: 100, client: Snov.client)
+      @client = client
+      @list_id = list_id
+      @page = page
+      @per_page = per_page
+    end
+
+    def each(&block)
+      prospects.each(&block)
+    end
+
+    def prospects
+      @prospects ||= raw_result.fetch('prospects').map do |result|
+        ProspectResult.new(result)
+      end
+    end
+
+    def raw_result
+      @raw_result ||= client.post("/v1/prospect-list",
+                                  'listId' => list_id.to_s,
+                                  'page' => page.to_s,
+                                  'perPage' => per_page.to_s)
+                            .deep_transform_keys! { |key| key.underscore }
+    end
+
+    class ProspectEmail
+      include ActiveModel::Model
+
+      attr_accessor :email, :is_verified, :job_status, :domain_type, :is_valid_format
+      attr_accessor :is_disposable, :is_webmail, :is_gibberish, :smtp_status, :probability
+      attr_accessor :status_type_text, :status_verify_text, :email_verify_text
+    end
+
+    class ProspectResult
+      include ActiveModel::Model
+
+      attr_accessor :id, :name, :first_name, :last_name, :source
+      attr_reader :emails
+
+      def emails=(val)
+        @emails = Array.wrap(val).map do |rel|
+          ProspectEmail.new(rel)
+        end
+      end
+
+      def email
+        emails.first&.email
+      end
+    end
+  end
+end

data/lib/snov/get_prospects_by_email.rb

@@ -0,0 +1,92 @@
+require 'active_support/core_ext/array'
+require_relative 'types/date_details'
+
+module Snov
+  class GetProspectsByEmail
+    include Enumerable
+
+    attr_reader :client, :email
+
+    def initialize(email:, client: Snov.client)
+      @client = client
+      @email = email.to_str
+    end
+
+    def each(&block)
+      prospects.each(&block)
+    end
+
+    def prospects
+      @prospects ||= raw_result.fetch('data', []).map do |result|
+        ProspectResult.new(result)
+      end
+    end
+
+    def raw_result
+      @raw_result ||= client.post("/v1/get-prospects-by-email",
+                                  'email' => email)
+                            .deep_transform_keys! { |key| key.underscore }
+    end
+
+    class Job
+      include ActiveModel::Model
+
+      attr_accessor :company_name, :position, :social_link, :site, :locality, :state, :city
+      attr_accessor :street, :street2, :postal, :founded, :start_date, :end_date, :size
+      attr_accessor :industry, :company_type, :country
+    end
+
+    class Social
+      include ActiveModel::Model
+
+      attr_accessor :link, :type
+    end
+
+    class List
+      include ActiveModel::Model
+
+      attr_accessor :id, :name
+    end
+
+    class ProspectResult
+      include ActiveModel::Model
+
+      attr_accessor :id, :name, :first_name, :last_name, :industry, :country, :locality
+      attr_reader :social, :current_job, :previous_job, :lists, :campaigns, :last_update_date
+
+      def social=(val)
+        @social = Array.wrap(val).map do |rel|
+          Social.new(rel)
+        end
+      end
+
+      def current_job=(val)
+        @current_job = Array.wrap(val).map do |rel|
+          Job.new(rel)
+        end
+      end
+
+      def previous_job=(val)
+        @previous_job = Array.wrap(val).map do |rel|
+          Job.new(rel)
+        end
+      end
+
+      def lists=(val)
+        @lists = Array.wrap(val).map do |rel|
+          List.new(rel)
+        end
+      end
+
+      def campaigns=(val)
+        @campaigns = Array.wrap(val).map do |rel|
+          OpenStruct.new(rel)
+        end
+      end
+
+      def last_update_date=(val)
+        @last_update_date = Types::DateDetails.new(val.to_hash)
+      end
+    end
+  end
+end

data/lib/snov/get_user_lists.rb

@@ -0,0 +1,47 @@
+require_relative 'types/date_details'
+
+module Snov
+  class GetUserLists
+    include Enumerable
+
+    attr_reader :client
+
+    def initialize(client: Snov.client)
+      @client = client
+    end
+
+    def each(&block)
+      all.each(&block)
+    end
+
+    def all
+      @all ||= raw_result.map { |result| UserList.new(result) }
+    end
+
+    def raw_result
+      @raw_result ||= client.get("/v1/get-user-lists").map do |val|
+        val.deep_transform_keys! { |key| key.underscore }
+      end
+    end
+
+    class UserList
+      include ActiveModel::Model
+
+      attr_accessor :id, :name, :is_deleted, :contacts
+      attr_reader :creation_date, :deletion_date
+
+      def creation_date=(val)
+        @creation_date = Types::DateDetails.new(val.to_hash)
+      end
+
+      def deletion_date=(val)
+        @deletion_date = val
+        @deletion_date = Types::DateDetails.new(val.to_hash) if val
+      end
+
+      def to_h
+        { id: id, is_deleted: is_deleted, name: name, contacts: contacts }
+      end
+    end
+  end
+end

data/lib/snov/types/date_details.rb

@@ -0,0 +1,9 @@
+module Snov
+  module Types
+    class DateDetails
+      include ActiveModel::Model
+
+      attr_accessor :date, :timezone_type, :timezone
+    end
+  end
+end

data/lib/snov/version.rb

@@ -0,0 +1,3 @@
+module Snov
+  VERSION = "0.1.0"
+end

data/snov.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/snov/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "snov"
+  spec.version       = Snov::VERSION
+  spec.authors       = ["Grant Petersen-Speelman"]
+  spec.email         = ["grantspeelman@gmail.com"]
+
+  spec.summary       = %q{Snov client to interact with snov api}
+  spec.description   = %q{Snov client to interact with snov api}
+  spec.homepage      = "https://github.com/NEXL-LTS/snov-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/snov-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/NEXL-LTS/snov-ruby/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.require_paths = ["lib"]
+  spec.add_dependency 'activemodel'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'multi_json'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: snov
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Grant Petersen-Speelman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Snov client to interact with snov api
+email:
+- grantspeelman@gmail.com
+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
+- gems.rb
+- lib/snov.rb
+- lib/snov/client.rb
+- lib/snov/fake_client.rb
+- lib/snov/fake_client/get_v1_get-user-lists.json
+- lib/snov/fake_client/post_v1_get-profile-by-email.json
+- lib/snov/fake_client/post_v1_get-prospects-by-email.json
+- lib/snov/fake_client/post_v1_prospect-list.json
+- lib/snov/get_all_prospects_from_list.rb
+- lib/snov/get_profile_by_email.rb
+- lib/snov/get_prospect_list.rb
+- lib/snov/get_prospects_by_email.rb
+- lib/snov/get_user_lists.rb
+- lib/snov/types/date_details.rb
+- lib/snov/version.rb
+- snov.gemspec
+homepage: https://github.com/NEXL-LTS/snov-ruby
+licenses: []
+metadata:
+  homepage_uri: https://github.com/NEXL-LTS/snov-ruby
+  source_code_uri: https://github.com/NEXL-LTS/snov-ruby
+  changelog_uri: https://github.com/NEXL-LTS/snov-ruby/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: Snov client to interact with snov api
+test_files: []