snov 0.4.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f589444e92f1101b625086d9e1d440952b52e1de3c9996183bc3908f7ec43c2
-  data.tar.gz: cd4df386dd42c6c4f8c226526c0f42145b24b2bcdafb59019c12c6a01c417afe
+  metadata.gz: d7545d8e5ad029e0dcfe3c6070d81ecd37074a7b341dbffd7a49d1fb57de5b15
+  data.tar.gz: 0d78ebcc861f2daa89b8bcb684f2eed5357b388ae8d69a1546fa36946b19f4e4
 SHA512:
-  metadata.gz: 4e53b2ea16a6ca434adaee244620863510b245c2dd48fd379f806bbe4ccb82e1e424b8992a351b34789da00410889312205486ec8917c509165f16f3e7751a21
-  data.tar.gz: 338af6443df4e833f662934940a87e8dcb9ac43ffe7b9be6710c3a1c237e4ef2ce68196ff066d287e8f4cc508ee7207119746f4b0767d9477506d4fbbb28f21a
+  metadata.gz: aaa1ea3abffa6e35551c0a10532f080735660eb153f79ccc62aa379c42d28da8cebc914805276a17d451d4423e6344133ece32cf6a01933cc23f0670a7b573c0
+  data.tar.gz: a1cba7a4909499108923a8b2c9ec55ad741f64a6e561a35c95f2c169d4caa416788ef4b464fc662c55ce586c459b8fcb136205acd515d08115131746d8b32316

data/.byebug_history

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

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+* 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
 

data/README.md

@@ -183,6 +183,34 @@ see https://snov.io/api#GetEmailsFromUrl
   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
 
 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.

data/lib/snov.rb

@@ -25,4 +25,6 @@ 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, :access_token
+    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,6 +35,14 @@ module Snov
     ERROR_CLASSES = { 401 => UnauthorizedError, 502 => BadGatewayError, 403 => ForbiddenError,
                       504 => GatewayTimeOut, 400 => BadRequest, 405 => MethodNotAllowed }
 
+    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
@@ -66,7 +76,7 @@ module Snov
 
     def parse_response(resp, path, _params)
       unless resp.success?
-        error_class = ERROR_CLASSES.fetch(resp.status, ResponseError)
+        error_class = Client.select_error_class(resp, fallback: ResponseError)
         raise error_class.new("#{path} (#{resp.status})", response: resp&.body)
       end
       MultiJson.load(resp.body)

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_from_name.rb

@@ -0,0 +1,76 @@
+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, :domain
+      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
+
+      def in_progress?
+        identifier == 'in_progress'
+      end
+
+      def not_found?
+        identifier == 'not_found'
+      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.4.0"
+  VERSION = "0.6.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snov
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.2
 platform: ruby
 authors:
 - Grant Petersen-Speelman
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-11 00:00:00.000000000 Z
+date: 2021-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -119,6 +119,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".byebug_history"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -133,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
@@ -148,6 +150,7 @@ files:
 - 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
@@ -177,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Snov client to interact with snov api