hunterio 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 806b817c321ad7967e4bbd248762f9e5dead3d6a
+  data.tar.gz: 572cfd50d60f456a7eff58ff8b91b9c6bbc05c78
+SHA512:
+  metadata.gz: fe8cf91973baee24ec1b0cc233ba2237824393c386addd927b5042c94e8c3eaaf55a8d0764416f650e83c1ac049316108e09227d397ace6bb854674d9ecb5ec1
+  data.tar.gz: c4ae3099bf9e1917729dbc4b7b81ede8a613bb679746b3f30d7fc172069ffda911be206fbb8d3278a752b6e66a7358289169c8cd70886501c409f8b4b4184deb

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hunter.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Prospect.io
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,108 @@
+# Hunter
+
+A ruby wrapper around Hunter.io API. Direct access to all the web's email addresses.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hunterio'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hunterio
+
+## Usage
+
+```ruby
+require 'hunterio'
+hunter = Hunter.new('Your secret API key')
+
+```
+Your secret API key. You can generate it here (https://hunter.io/api_keys)
+
+## Domain Search API
+Returns all the email addresses found using one given domain name, with our sources.
+```ruby
+response = hunter.domain_search('stripe.com')
+```
+
+## Accessing response
+```ruby
+response.status
+response.webmail
+response.emails
+response.pattern
+```
+
+
+## Email Verifier API
+Allows you to verify the deliverability of an email address.
+```ruby
+response = hunter.email_verifier('vincenzo@prospect.io')
+```
+
+## Accessing response
+```ruby
+response.status
+response.result
+response.score
+response.regexp
+response.gibberish
+response.disposable
+response.webmail
+response.mx_records
+response.smtp_server
+response.smtp_check
+response.accept_all
+response.sources
+```
+
+## Email Finder API
+Guesses the most likely email of a person from his first name, his last name and a domain name.
+```ruby
+response = hunter.email_finder('Vincenzo', 'Ruggiero', {domain: 'prospect.io', company: 'Prospect.io'})
+```
+
+## Accessing response
+```ruby
+response.status
+response.email
+response.score
+response.domain
+```
+
+## Email Count API
+Returns the number of email addresses found for a domain. This is a FREE API call.
+```ruby
+response = hunter.email_count('prospect.io')
+```
+
+## Accessing count response
+```ruby
+response.status
+response.total
+response.personal_emails
+response.generic_emails
+```
+
+## License
+The Hunter GEM is released under the MIT License.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/hunter/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Credits
+This gem is inspired by the [emailhunter gem](https://github.com/davidesantangelo/emailhunter) made by Davide Santangelo

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hunter"
+
+# 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

data/bin/setup

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

data/hunter.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require File.expand_path('../lib/hunter/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "hunterio"
+  spec.version       = Hunter::VERSION
+  spec.authors       = ["Vincenzo Ruggiero"]
+  spec.email         = ["vincenzo@prospect.io"]
+  spec.homepage      = 'https://github.com/prospectio/hunterio'
+
+  spec.summary       = %q{A Ruby wrapper around Hunter.io API V2}
+  spec.description   = %q{A ruby wrapper around Hunter.io API. Direct access to all the web's email addresses.}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "typhoeus"
+
+  spec.required_ruby_version = ">= 1.9.3"
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "json"
+
+end

data/lib/hunter.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'hunter/api'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'hunter/version'))
+
+module Hunter
+  extend self
+
+  def new(key)
+    Api.new(key)
+  end
+end

data/lib/hunter/api.rb

@@ -0,0 +1,35 @@
+require 'uri'
+
+API_URL = 'https://api.hunter.io/v2/'
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'domain_search'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'email_count'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'email_finder'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'email_verifier'))
+
+module Hunter
+  class Api
+    attr_reader :key
+
+  	def initialize(key)
+  		@key = key
+  	end
+
+    def domain_search(domain, options = nil)
+      Hunter::DomainSearch.new(domain, self.key).perform(options)
+    end
+
+    def email_count(domain)
+      Hunter::EmailCount.new(domain).perform
+    end
+
+    def email_finder(first_name, last_name, options)
+      Hunter::EmailFinder.new(first_name, last_name, self.key).perform(options.reject {| key, value | value.nil? })
+    end
+
+    def email_verifier(email)
+      Hunter::EmailVerifier.new(email, self.key).perform
+    end
+
+  end
+end

data/lib/hunter/domain_search.rb

@@ -0,0 +1,35 @@
+require 'faraday'
+require 'json'
+
+API_SEARCH_URL = "#{API_URL}domain-search?"
+
+module Hunter
+  class DomainSearch
+
+    def initialize(domain, key)
+      @domain = domain
+      @key = key
+    end
+
+    def perform(options)
+      response = call_api(options)
+      Struct.new(*response.keys).new(*response.values)
+    end
+
+    private
+    def call_api(options)
+      url_params = ''
+      url_params = options.reject {| key, value | value.nil? }.to_a.map{ |pair| pair.join('=') }.join('&') unless options.nil?
+      url =
+        URI.parse(URI.encode(
+          "#{API_SEARCH_URL}#{url_params}&domain=#{@domain}&api_key=#{@key}")
+        )
+      response = Faraday.new(url).get
+      if response.success?
+        JSON.parse(response.body, {symbolize_names: true})[:data].merge!(status: "success")
+      else
+        {status: 'error'}
+      end
+    end
+  end
+end

data/lib/hunter/email_count.rb

@@ -0,0 +1,30 @@
+require 'faraday'
+require 'json'
+
+API_COUNT_URL = "#{API_URL}email-count?"
+
+module Hunter
+  class EmailCount
+
+    def initialize(domain)
+      @domain = domain
+    end
+
+    def perform
+      response = call_api
+      Struct.new(*response.keys).new(*response.values) unless response.empty?
+    end
+
+    private
+
+    def call_api
+      url = URI.parse(URI.encode("#{API_COUNT_URL}domain=#{@domain}"))
+      response = Faraday.new(url).get
+      if response.success?
+        JSON.parse(response.body, {symbolize_names: true})[:data].merge!(status: "success")
+      else
+        {status: 'error'}
+      end
+    end
+  end
+end

data/lib/hunter/email_finder.rb

@@ -0,0 +1,33 @@
+require 'faraday'
+require 'json'
+
+API_GENERATE_URL = "#{API_URL}email-finder?"
+
+module Hunter
+  class EmailFinder
+
+    def initialize(first_name, last_name, key)
+      @first_name = first_name
+      @last_name = last_name
+      @key = key
+    end
+
+    def perform(options)
+      response = call_api(options)
+      Struct.new(*response.keys).new(*response.values) unless response.empty?
+    end
+
+    private
+
+    def call_api(options)
+      url_params = options.to_a.map{ |pair| pair.join('=') }.join('&')
+      url = URI.parse(URI.encode("#{API_GENERATE_URL}#{url_params}&first_name=#{@first_name}&last_name=#{@last_name}&api_key=#{@key}"))
+      response = Faraday.new(url).get
+      if response.success?
+        JSON.parse(response.body, {symbolize_names: true})[:data].merge!(status: "success")
+      else
+        {status: 'error'}
+      end
+    end
+  end
+end

data/lib/hunter/email_verifier.rb

@@ -0,0 +1,31 @@
+require 'faraday'
+require 'json'
+
+API_VERIFY_URL = "#{API_URL}email-verifier?"
+
+module Hunter
+  class EmailVerifier
+
+    def initialize(email, key)
+      @email = email
+      @key = key
+    end
+
+    def perform
+      response = call_api
+      Struct.new(*response.keys).new(*response.values) unless response.empty?
+    end
+
+    private
+
+    def call_api
+      url = URI.parse(URI.encode("#{API_VERIFY_URL}email=#{@email}&api_key=#{@key}"))
+      response = Faraday.new(url).get
+      if response.success?
+        JSON.parse(response.body, {symbolize_names: true})[:data].merge!(status: "success")
+      else
+        {status: 'error'}
+      end
+    end
+  end
+end

data/lib/hunter/version.rb

@@ -0,0 +1,3 @@
+module Hunter
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: hunterio
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Vincenzo Ruggiero
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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: 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: A ruby wrapper around Hunter.io API. Direct access to all the web's email
+  addresses.
+email:
+- vincenzo@prospect.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hunter.gemspec
+- lib/hunter.rb
+- lib/hunter/api.rb
+- lib/hunter/domain_search.rb
+- lib/hunter/email_count.rb
+- lib/hunter/email_finder.rb
+- lib/hunter/email_verifier.rb
+- lib/hunter/version.rb
+homepage: https://github.com/prospectio/hunterio
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper around Hunter.io API V2
+test_files: []