snov 0.3.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17642a68bd97a1fdcf12658564b5a7fd306e99dd2b5ef34ed9da2794eb0edc38
-  data.tar.gz: 302f6d0d344423f0d5f4b7b6ba7eb4cf946f9c40b593405beb0dc97d73cf6cd1
+  metadata.gz: 83ba4d0a62cbaa8174ff7b35a0ec270fa9d1b5381743aedc80dd0d6d834f021e
+  data.tar.gz: d3d598766a17f72df681ab1cccdc951f7582647dfadc45642d9679953d501636
 SHA512:
-  metadata.gz: fc185aec2d68428785fe87458635a076ac9d25a693dad25da35aed5d300509bddcecbe423e767470b594aed9cdf196f47b24eb3527378afcc621eeec1af8e5ab
-  data.tar.gz: 15a52efe1afd9aa1dceaff04ba54d9523b9b87e5794c98118891f738fb08bf1371b2b129b3c3a711a32738ff29f4269c0cc3dfc6ddc3e97a9b4a6dcde6e4c984
+  metadata.gz: a9a3b218b1d8689904f37e579e71349bb5ef29caf3f9360ed854fd346c0cad55255a989cbf877e561dce09bf0225bc3cdd4302a6004faa73602b59409b68a4e9
+  data.tar.gz: 1d713a008faccc5cbb2487c324c0451d5181e23752b5571f6338af584c99795c5cdb0ace999986db278df2dae1e17b3ae0420f9cfb4118b7732f6a435571aa72

data/.byebug_history

@@ -0,0 +1,5 @@
+continue
+subject
+exit
+val["emails"]
+val

data/.rubocop.yml

@@ -2,6 +2,7 @@ require:
   - rubocop-rspec
 
 AllCops:
+  TargetRubyVersion: 2.5
   SuggestExtensions: false
   NewCops: enable
   Exclude:

data/.travis.yml

@@ -3,7 +3,7 @@ language: ruby
 gemfile: gems.rb
 cache: bundler
 rvm:
-  - 2.4
+  - 2.5
   - 2.7
 before_install:
   - yes | gem update --system --force

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+* add OutOfCreditsError
+
+## [0.5.0]
+* support for https://snov.io/api#EmailFinder (GetEmailsFromName)
+
+## [0.4.1]
+* allow forward slash for test response files while using fake client
+
+## [0.4.0]
+* search prospect emails with /v1/get-emails-from-url
+
+## [0.3.2]
+* increase snov timeout to 90 seconds
 ## [0.3.1]
 * fix fake result for /v1/prospect-list
 

data/README.md

@@ -148,6 +148,68 @@ see https://snov.io/api#ViewProspectsInList
   end
 ```
 
+### GetEmailsBySocialUrl
+
+convenience wrapper for `GetEmailsFromUrl` to get a prospect with social url e.g. linkedin profile url
+
+see https://snov.io/api#GetEmailsFromUrl
+
+```ruby
+  prospect = Snov::GetEmailsBySocialUrl.new(url: "https://www.linkedin.com/in/john-doe-123456/").prospect
+  
+  prospect.data.emails.each do |value|
+    puts value.email
+    puts value.status
+  end
+
+  prospect.data.previous_jobs.each do |value|
+    puts value.company_name
+    puts value.company_type
+    puts value.position
+    puts value.country
+    puts value.start_date
+    puts value.industry
+    puts value.size
+  end
+
+  prospect.data.current_jobs.each do |value|
+    puts value.company_name
+    puts value.company_type
+    puts value.position
+    puts value.country
+    puts value.start_date
+    puts value.industry
+    puts value.size
+  end
+```
+
+### GetEmailsFromName
+
+convenience wrapper for `GetEmailsFromName` to get a prospect with name
+
+see https://snov.io/api#EmailFinder
+
+```ruby
+  prospect = Snov::GetEmailsFromName.new(first_name: "gavin", last_name: "vanrooyen", domain: "octagon.com").prospect
+  
+  prospect.data.emails.each do |value|
+    puts value.email
+    puts value.email_status
+  end
+```
+
+### AddNamesToFindEmails
+
+convenience wrapper for `AddNamesToFindEmails` to add a prospect with name
+
+see https://snov.io/api#AddNamestoFindEmails
+
+```ruby
+  added_name = Snov::AddNamesToFindEmails.new(first_name: "gavin", last_name: "vanrooyen", domain: "octagon.com").add
+
+  puts added_name.sent # true added to snov queue for searching
+  puts added_name.success
+```
 
 ## Development
 

data/lib/snov.rb

@@ -24,4 +24,7 @@ require 'snov/get_all_prospects_from_list'
 require 'snov/get_prospects_by_email'
 require 'snov/get_prospect_list'
 require 'snov/get_user_lists'
+require 'snov/get_emails_by_social_url'
+require 'snov/get_emails_from_name'
+require 'snov/add_names_to_find_emails'
 require 'snov/domain_search'

data/lib/snov/add_names_to_find_emails.rb

@@ -0,0 +1,30 @@
+module Snov
+  class AddNamesToFindEmails
+    attr_reader :client
+
+    def initialize(client: Snov.client, first_name:, last_name:, domain:)
+      @client = client
+      @first_name = first_name
+      @last_name = last_name
+      @domain = domain
+    end
+
+    def add
+      @add ||= ProspectResult.new(raw_result)
+    end
+
+    def raw_result
+      @raw_result ||= client.post("/v1/add-names-to-find-emails",
+                                  "firstName" => @first_name,
+                                  "lastName" => @last_name,
+                                  "domain" => @domain)
+                            .deep_transform_keys! { |key| key.underscore }
+    end
+
+    class ProspectResult
+      include ActiveModel::Model
+
+      attr_accessor :success, :first_name, :last_name, :domain, :user_id, :sent
+    end
+  end
+end

data/lib/snov/client.rb

@@ -22,6 +22,8 @@ module Snov
 
     class BadGatewayError < ResponseError; end
 
+    class OutOfCreditsError < BadGatewayError; end
+
     class ForbiddenError < ResponseError; end
 
     class GatewayTimeOut < ResponseError; end
@@ -33,7 +35,15 @@ module Snov
     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)
+    def self.select_error_class(resp, fallback: ResponseError)
+      if resp&.body.to_s.include?('you ran out of credits')
+        OutOfCreditsError
+      else
+        ERROR_CLASSES.fetch(resp.status, fallback)
+      end
+    end
+
+    def initialize(client_id:, client_secret:, access_token: nil, timeout_seconds: 90)
       self.client_id = client_id.to_str
       self.client_secret = client_secret.to_str
       @access_token = access_token
@@ -66,8 +76,8 @@ module Snov
 
     def parse_response(resp, path, _params)
       unless resp.success?
-        error_class = ERROR_CLASSES.fetch(resp.status, ResponseError)
-        raise error_class.new("#{path} (#{resp.status})", response: resp)
+        error_class = Client.select_error_class(resp, fallback: ResponseError)
+        raise error_class.new("#{path} (#{resp.status})", response: resp&.body)
       end
       MultiJson.load(resp.body)
     end

data/lib/snov/fake_client.rb

@@ -46,7 +46,7 @@ module Snov
     def filename(method, path, payload_hash)
       add = payload_hash.to_a.map { |v| v.join("=") }.join("&").tr(".", "_")
       add = "default" if add == ""
-      "#{self.class.folder}/#{method}#{path.tr("/", "_")}/#{add}.json"
+      "#{self.class.folder}/#{method}#{path.tr("/", "_")}/#{add.gsub('/', '-')}.json"
     end
   end
 end

data/lib/snov/get_emails_by_social_url.rb

@@ -0,0 +1,77 @@
+module Snov
+  class GetEmailsBySocialUrl
+    attr_reader :client
+
+    def initialize(client: Snov.client, url:)
+      @client = client
+      @url = url
+    end
+
+    def prospect
+      @prospect ||= ProspectResult.new(raw_result)
+    end
+
+    def raw_result
+      @raw_result ||= client.post("/v1/get-emails-from-url", "url" => @url)
+                            .deep_transform_keys! { |key| key.underscore }
+    end
+
+    class ProspectJob
+      include ActiveModel::Model
+
+      attr_accessor :company_name, :company_type, :position, :social_link, :site, :locality, :state,
+                    :city, :street, :street2, :country, :start_date, :end_date, :postal, :founded, :size,
+                    :industry
+    end
+
+    class ProspectJobList
+      include ActiveModel::Model
+      include Enumerable
+
+      attr_accessor :jobs
+
+      def each(&block)
+        jobs.each(&block)
+      end
+    end
+
+    class ProspectEmail
+      include ActiveModel::Model
+
+      attr_accessor :email, :status
+    end
+
+    class ProspectData
+      include ActiveModel::Model
+
+      attr_reader :emails, :previous_jobs, :current_jobs
+      attr_accessor :id, :name, :first_name, :last_name, :source_page, :source, :industry,
+                    :country, :locality, :last_update_date, :social, :skills, :links
+
+      def emails=(val)
+        @emails = Array.wrap(val).map do |rel|
+          ProspectEmail.new(rel)
+        end
+      end
+
+      def previous_job=(val)
+        @previous_jobs = ProspectJobList.new(jobs: Array.wrap(val).map { |job| ProspectJob.new(job) })
+      end
+
+      def current_job=(val)
+        @current_jobs = ProspectJobList.new(jobs: Array.wrap(val).map { |job| ProspectJob.new(job) })
+      end
+    end
+
+    class ProspectResult
+      include ActiveModel::Model
+
+      attr_accessor :success, :message
+      attr_reader :data
+
+      def data=(val)
+        @data = ProspectData.new(val)
+      end
+    end
+  end
+end

data/lib/snov/get_emails_from_name.rb

@@ -0,0 +1,68 @@
+module Snov
+  class GetEmailsFromName
+    attr_reader :client
+
+    def initialize(client: Snov.client, first_name:, last_name:, domain:)
+      @client = client
+      @first_name = first_name
+      @last_name = last_name
+      @domain = domain
+    end
+
+    def prospect
+      @prospect ||= ProspectResult.new(raw_result)
+    end
+
+    def raw_result
+      @raw_result ||= client.post("/v1/get-emails-from-names",
+                                  "firstName" => @first_name,
+                                  "lastName" => @last_name,
+                                  "domain" => @domain)
+                            .deep_transform_keys! { |key| key.underscore }
+    end
+
+    class ProspectData
+      include ActiveModel::Model
+
+      attr_accessor :first_name, :last_name
+      attr_reader :emails
+
+      def emails=(val)
+        @emails = Array.wrap(val).map do |rel|
+          ProspectEmail.new(rel)
+        end
+      end
+    end
+
+    class ProspectEmail
+      include ActiveModel::Model
+
+      attr_accessor :email, :email_status
+    end
+
+    class ProspectStatus
+      include ActiveModel::Model
+
+      attr_accessor :identifier, :description
+
+      def completed?
+        identifier == 'complete'
+      end
+    end
+
+    class ProspectResult
+      include ActiveModel::Model
+
+      attr_accessor :success, :message, :params
+      attr_reader :data, :status
+
+      def data=(val)
+        @data = ProspectData.new(val)
+      end
+
+      def status=(val)
+        @status = ProspectStatus.new(val)
+      end
+    end
+  end
+end

data/lib/snov/version.rb

@@ -1,3 +1,3 @@
 module Snov
-  VERSION = "0.3.1"
+  VERSION = "0.6.0"
 end

data/snov.gemspec

@@ -3,18 +3,18 @@ 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.authors       = ["Grant Petersen-Speelman", "Bapu Sethi"]
+  spec.email         = ["grantspeelman@gmail.com", "bapu.sethi.03@gmail.com"]
   spec.license       = "MIT"
 
   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.required_ruby_version = Gem::Requirement.new(">= 2.5.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"
+  spec.metadata["changelog_uri"] = "https://github.com/NEXL-LTS/snov-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.

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: snov
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Grant Petersen-Speelman
-autorequire: 
+- Bapu Sethi
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-12 00:00:00.000000000 Z
+date: 2021-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -113,10 +114,12 @@ dependencies:
 description: Snov client to interact with snov api
 email:
 - grantspeelman@gmail.com
+- bapu.sethi.03@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".byebug_history"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -131,6 +134,7 @@ files:
 - bin/setup
 - gems.rb
 - lib/snov.rb
+- lib/snov/add_names_to_find_emails.rb
 - lib/snov/client.rb
 - lib/snov/domain_search.rb
 - lib/snov/fake_client.rb
@@ -145,6 +149,8 @@ files:
 - lib/snov/fake_client/post_v1_prospect-list/listId=1505383&page=1&perPage=100.json
 - lib/snov/fake_client/post_v1_prospect-list/listId=1818597&page=1&perPage=100.json
 - lib/snov/get_all_prospects_from_list.rb
+- lib/snov/get_emails_by_social_url.rb
+- lib/snov/get_emails_from_name.rb
 - lib/snov/get_profile_by_email.rb
 - lib/snov/get_prospect_list.rb
 - lib/snov/get_prospects_by_email.rb
@@ -158,8 +164,8 @@ 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: 
+  changelog_uri: https://github.com/NEXL-LTS/snov-ruby/blob/main/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -167,15 +173,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Snov client to interact with snov api
 test_files: []