RubyGems - snov - Versions diffs - 0.2.0 → 0.3.0 - Mend

snov 0.2.0 → 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 (21) hide show

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aec74bea1292e576ef497f2250c1833593742504c74834d05749bb8efdb88884
-  data.tar.gz: b85b04071c54d309c0dfa22c9b5c77e3a2273b4d370f0449e0b4952c2b295f6c
+  metadata.gz: 515392f915f68b6e2215b9d83b0669754972c869bf0760c2183801dba20ee97e
+  data.tar.gz: d070e267fe2bd7cfa737e06abce73affef3fd1a05b058ed4131a2c5b83025813
 SHA512:
-  metadata.gz: 0a509e0cdf66cb198c734a94fd81ef667506a4f96686b6d7c1e5720f4b26ba5389812894201bc11cc2b537bd45cc02d92ab4d1d9bf2f7856cc63c22077de6153
-  data.tar.gz: cc4f5022bca9c9f8e3a2fca2a04bc1b8435e4d6afbc3dd568fabce50168fdbca1dafa5397894dd63e899e564bbf66375fda450f64d6112505124435645342c2a
+  metadata.gz: a63119f42ed545a522e3a98783919a2b8b4aa24ff39ab660d7883f8064c8d09aa32bd6dd99add703a11c94341c4468e0169167fbd72b14480c3ed00ffbff6447
+  data.tar.gz: 65043cedd80d3cac9730b0251b391569770ec8c6700a2c434a35967dba3f3694793f8b7ff5fe279dd93584086f018b19d64d56f9d64fbb89ec64916e810e1593

data/.gitignore CHANGED

@@ -10,4 +10,5 @@
 /.rspec_status
 /gems.locked
 /vendor/bundle
-/.vscode
+/.vscode
+/spec/snov/moved

data/CHANGELOG.md CHANGED

@@ -1,3 +1,18 @@
+## [0.3.0]
+* add Faraday response into exception
+* fake client to only return success result for selected queries
+## [0.2.4]
+* Fix DomainSearch to_a
+## [0.2.3]
+* Fix DomainSearch doing post instead of get
+## [0.2.2]
+* DomainSearch Response class
+## [0.2.1]
+* DomainSearch fake example data
 ## [0.2.0]
 * DomainSearch

data/README.md CHANGED

@@ -26,7 +26,7 @@ see https://snov.io/api#DomainSearch2
 ```ruby
 results = Snov::DomainSearch.new(domain: "octagon.com", type: "personal", limit: 10)
-results.lastId
+results.last_id
 results.each do |result|
   puts result.email
   puts result.first_name

data/gems.rb CHANGED

@@ -3,6 +3,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in snov.gemspec
 gemspec
+gem "byebug"
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
 gem "rubocop"

data/lib/snov/client.rb CHANGED

@@ -7,19 +7,29 @@ module Snov
     class TimedOut < SnovError; end
-    class UnauthorizedError < SnovError; end
+    class AuthError < SnovError; end
-    class BadGatewayError < SnovError; end
+    class ResponseError < SnovError
+      attr_reader :response
-    class ForbiddenError < SnovError; end
+      def initialize(message, response: nil)
+        super(message)
+        @response = response
+      end
+    end
-    class GatewayTimeOut < SnovError; end
+    class UnauthorizedError < ResponseError; end
-    class BadRequest < SnovError; end
+    class BadGatewayError < ResponseError; end
-    class AuthError < SnovError; end
+    class ForbiddenError < ResponseError; end
+    class GatewayTimeOut < ResponseError; end
+    class BadRequest < ResponseError; end
+    class MethodNotAllowed < ResponseError; end
-    class MethodNotAllowed < SnovError; end
     ERROR_CLASSES = { 401 => UnauthorizedError, 502 => BadGatewayError, 403 => ForbiddenError,
                       504 => GatewayTimeOut, 400 => BadRequest, 405 => MethodNotAllowed }
@@ -56,8 +66,8 @@ module Snov
     def parse_response(resp, path, _params)
       unless resp.success?
-        raise ERROR_CLASSES.fetch(resp.status, SnovError),
-              "#{path} (#{resp.status})"
+        error_class = ERROR_CLASSES.fetch(resp.status, ResponseError)
+        raise error_class.new("#{path} (#{resp.status})", response: resp)
       end
       MultiJson.load(resp.body)
     end

data/lib/snov/domain_search.rb CHANGED

@@ -3,6 +3,10 @@ require 'camel_snake_struct'
 module Snov
   class DomainSearch
+    Response = Class.new(CamelSnakeStruct)
+    Dir["#{__dir__}/fake_client/get_v2_domain-emails-with-info/*.json"].each do |example_file|
+      Response.example(MultiJson.load(File.read(example_file)))
+    end
     include Enumerable
     attr_reader :client, :domain, :type, :limit
@@ -16,7 +20,7 @@ module Snov
     end
     def each(&block)
-      raw_result.emails.each(&block)
+      emails.each(&block)
     end
     def success
@@ -39,12 +43,20 @@ module Snov
       raw_result.company_name
     end
+    def emails
+      raw_result.emails
+    end
     def raw_result
-      CamelSnakeStruct.new(client.post("/v2/domain-emails-with-info",
-                                       'lastId' => @last_id,
-                                       'limit' => @limit,
-                                       'type' => type.to_s,
-                                       'domain' => domain.to_s))
+      @raw_result ||= Response.new(client.get("/v2/domain-emails-with-info",
+                                              'lastId' => @last_id,
+                                              'limit' => @limit,
+                                              'type' => type.to_s,
+                                              'domain' => domain.to_s))
+    end
+    def to_h
+      raw_result.to_h
     end
   end
 end

data/lib/snov/fake_client.rb CHANGED

@@ -1,14 +1,52 @@
 module Snov
   class FakeClient
-    def get(path)
-      data = File.read("#{__dir__}/fake_client/get#{path.tr("/", "_")}.json")
+    def self.folder=(val)
+      @folder = val
+      FileUtils.mkdir_p(@folder)
+      ["post_v1_get-profile-by-email", "get_v2_domain-emails-with-info",
+       "post_v1_get-prospects-by-email", "post_v1_prospect-list", "get_v1_get-user-lists"].each do |sub_folder|
+        FileUtils.cp_r "#{default_folder}/#{sub_folder}", @folder
+      end
+    end
+    def self.folder
+      @folder || default_folder
+    end
+    def self.reset_folder
+      @folder = nil
+    end
+    def self.default_folder
+      "#{__dir__}/fake_client"
+    end
+    def get(path, payload_hash = {})
+      data = File.read(filename("get", path, payload_hash))
+      MultiJson.load(data)
+    rescue Errno::ENOENT
+      data = File.read(filename("get", path, 'not_found' => 'true'))
       MultiJson.load(data)
     end
-    def post(path, params = {})
-      params.to_a.map(&:join).join("&")
-      data = File.read("#{__dir__}/fake_client/post#{path.tr("/", "_")}.json")
+    def post(path, payload_hash = {})
+      data = File.read(filename("post", path, payload_hash))
       MultiJson.load(data)
+    rescue Errno::ENOENT => e
+      file = filename("post", path, 'not_found' => 'true')
+      if File.exist?(file)
+        MultiJson.load(File.read(file))
+      else
+        raise Snov::Client::BadRequest, e.message
+      end
+    end
+    private
+    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"
     end
   end
 end

data/lib/snov/fake_client/{get_v1_get-user-lists.json → get_v1_get-user-lists/default.json} RENAMED

File without changes

data/lib/snov/fake_client/get_v2_domain-emails-with-info/domain=octagon_com.json ADDED

@@ -0,0 +1,21 @@
+{
+    "success": true,
+    "domain": "octagon.com",
+    "webmail": false,
+    "result": 84,
+    "lastId": 1823487525,
+    "limit": 100,
+    "companyName": "Octagon",
+    "emails": [
+        {
+        "email": "ben.gillespie@octagon.com",
+        "firstName": "Ben",
+        "lastName": "Gillespie",
+        "position": "Senior Account Executive",
+        "sourcePage": "https://www.linkedin.com/pub/ben-gillespie/7/73/809",
+        "companyName": "Octagon",
+        "type": "prospect",
+        "status": "verified"
+        }
+    ]
+}

data/lib/snov/fake_client/get_v2_domain-emails-with-info/not_found=true.json ADDED

	@@ -0,0 +1 @@
1	+ {"success":true,"domain":"","webmail":false,"result":0,"lastId":0,"limit":10,"companyName":"","emails":[]}

data/lib/snov/fake_client/post_v1_get-profile-by-email/email=lizi_hamer@octagon_com.json ADDED

@@ -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-profile-by-email/not_found=true.json ADDED

@@ -0,0 +1,4 @@
+{
+  "success": true,
+  "message": "We couldn't find profile with this email"
+}

data/lib/snov/fake_client/{post_v1_get-prospects-by-email.json → post_v1_get-prospects-by-email/email=gavin_vanrooyen@octagon_com.json} RENAMED

File without changes

data/lib/snov/fake_client/post_v1_get-prospects-by-email/not_found=true.json ADDED

	@@ -0,0 +1 @@
1	+ {"success":false,"errors":"Prospect with email 'no.one.home@octagon.com' not found"}

data/lib/snov/fake_client/{post_v1_prospect-list.json → post_v1_prospect-list/list_id=1479070&page=1&per_page=100.json} RENAMED

File without changes

data/lib/snov/fake_client/post_v1_prospect-list/list_id=1505383&page=1&per_page=100.json ADDED

@@ -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/fake_client/post_v1_prospect-list/list_id=1818597&page=1&per_page=100.json ADDED

@@ -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/version.rb CHANGED

@@ -1,3 +1,3 @@
 module Snov
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata CHANGED

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snov
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Grant Petersen-Speelman
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-11 00:00:00.000000000 Z
+date: 2021-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -134,10 +134,16 @@ files:
 - lib/snov/client.rb
 - lib/snov/domain_search.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/fake_client/get_v1_get-user-lists/default.json
+- lib/snov/fake_client/get_v2_domain-emails-with-info/domain=octagon_com.json
+- lib/snov/fake_client/get_v2_domain-emails-with-info/not_found=true.json
+- lib/snov/fake_client/post_v1_get-profile-by-email/email=lizi_hamer@octagon_com.json
+- lib/snov/fake_client/post_v1_get-profile-by-email/not_found=true.json
+- lib/snov/fake_client/post_v1_get-prospects-by-email/email=gavin_vanrooyen@octagon_com.json
+- lib/snov/fake_client/post_v1_get-prospects-by-email/not_found=true.json
+- lib/snov/fake_client/post_v1_prospect-list/list_id=1479070&page=1&per_page=100.json
+- lib/snov/fake_client/post_v1_prospect-list/list_id=1505383&page=1&per_page=100.json
+- lib/snov/fake_client/post_v1_prospect-list/list_id=1818597&page=1&per_page=100.json
 - lib/snov/get_all_prospects_from_list.rb
 - lib/snov/get_profile_by_email.rb
 - lib/snov/get_prospect_list.rb

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

@@ -1,103 +0,0 @@
-{
-    "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"
-    }