emailhunter 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e61a72900856fb1673b6f9c638e698cc46da893d
-  data.tar.gz: 827e67f09bd849839da89e74346ada5fe11e8190
+  metadata.gz: 418afd79eb8611762f1188045655c3e49502c699
+  data.tar.gz: 129521b1fe42d462ad1c5611c935ac8d58a7976e
 SHA512:
-  metadata.gz: 4116e6ff396c087629474b15a460c8a486712904f3e39c584564651bb9091fd59fe20ac5239f76dabaeba8880e12e6757c180f1751360c00888681bc08c78c0d
-  data.tar.gz: af88f3486570bf89003bf19aca7920ed45f537ef4032dfa8e7129c01f7d24430c52855c64847b5ee53c6cdaba00a5c9295ee34ab7e1a10e613690a883a942d71
+  metadata.gz: 5b3180c68060abf4267c2937943a4a337229ffd0d3141b2e41d6d09e98b1aa0f450a81914be4488b9078ef96f4e37cb5aa57de1d2199ac062d89056df64e46be
+  data.tar.gz: 63e31331d83896e3014c3c5be5d093533774df7b291af26035af596422449e9c33461397b00f4923c1b0ac7ad4ee62a65d57985fd66433a615accd5f6911618f

data/README.md

@@ -1,6 +1,7 @@
 # Emailhunter
 
-A tiny ruby wrapper around Email Hunter API 
+A tiny ruby wrapper around Email Hunter API. Direct access to all the web's email addresses.
+
 
 ## Installation
 
@@ -28,7 +29,7 @@ email_hunter = EmailHunter.new('Your secret API key')
 Your secret API key. You can generate it in your dashboard from https://emailhunter.co
 
 ## Domain search API
-Get the list of all the emails from a given domain name. Each email is returned with our source(s), its type (generic or personnal) and the date it was extracted on
+Returns all the email addresses found using one given domain name, with our sources.
 ```ruby
 result = email_hunter.search('stripe.com')
 ```
@@ -37,12 +38,14 @@ result = email_hunter.search('stripe.com')
 ```ruby
 result.status
 result.results
+result.webmail
 result.emails
+result.offset
 ```
 
 
 ## Email check API
-Find if a given email exist. If it does, we'll return where it was found.
+Checks if a given email address has been found in our base and returns the sources.
 ```ruby
 email_hunter.exist('bonjour@firmapi.com')
 ```
@@ -55,8 +58,21 @@ result.exist
 result.sources
 ```
 
+## Generate  API
+Guesses the most likely email of a person from his first name, his last name and a domain name.
+```ruby
+email_hunter.generate('gmail.com', 'Davide', 'Santangelo')
+```
+
+## Accessing email check response
+```ruby
+result.status
+result.email
+result.score
+```
+
 ## License
-The restcountry GEM is released under the MIT License.
+The emailhunter GEM is released under the MIT License.
 
 
 ## Contributing

data/lib/email_hunter.rb

@@ -7,4 +7,4 @@ module EmailHunter
   def new(key)
     Api.new(key)
   end
-end
+end

data/lib/email_hunter/api.rb

@@ -2,11 +2,12 @@ require 'uri'
 
 require File.expand_path(File.join(File.dirname(__FILE__), 'search'))
 require File.expand_path(File.join(File.dirname(__FILE__), 'exist'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'generate'))
 
 module EmailHunter
   class Api
     attr_reader :key
-    
+
   	def initialize(key)
   		@key = key
   	end
@@ -20,5 +21,10 @@ module EmailHunter
   	def exist(email)
   		EmailHunter::Exist.new(email, self.key).hunt
   	end
+
+    # Email Generate API
+  	def generate(domain, first_name, last_name)
+  		EmailHunter::Generate.new(domain, first_name, last_name, self.key).hunt
+  	end
   end
-end
+end

data/lib/email_hunter/exist.rb

@@ -7,7 +7,7 @@ module EmailHunter
   class Exist
     attr_reader :status, :email, :exist, :sources
 
-  	def initialize(email, key)
+    def initialize(email, key)
       @email = email
       @key = key
     end
@@ -20,9 +20,9 @@ module EmailHunter
     private
 
     def apiresponse
-      url = "#{API_EXISTS_URL}email=#{@email}&api_key=#{@key}"
-      response = (Faraday.new URI.parse(URI.encode(url)), :ssl => {:verify => false}).get
+      url = URI.parse(URI.encode("#{API_EXISTS_URL}email=#{@email}&api_key=#{@key}"))
+      response = Faraday.new(url).get
       response.success? ? JSON.parse(response.body, {symbolize_names: true}) : []
     end
   end
-end
+end

data/lib/email_hunter/generate.rb

@@ -0,0 +1,30 @@
+require 'faraday'
+require 'json'
+
+API_GENERATE_URL = 'https://api.emailhunter.co/v1/generate?'
+
+module EmailHunter
+  class Generate
+    attr_reader :status, :email, :score
+
+    def initialize(domain, first_name, last_name, key)
+      @first_name = first_name
+      @last_name = last_name
+      @domain = domain
+      @key = key
+    end
+
+    def hunt
+      response = apiresponse
+      Struct.new(*response.keys).new(*response.values) unless response.empty?
+    end
+
+    private
+
+    def apiresponse
+      url = URI.parse(URI.encode("#{API_GENERATE_URL}domain=#{@domain}&first_name=#{@first_name}&last_name=#{@last_name}&api_key=#{@key}"))
+      response = Faraday.new(url).get
+      response.success? ? JSON.parse(response.body, {symbolize_names: true}) : []
+    end
+  end
+end

data/lib/email_hunter/search.rb

@@ -20,9 +20,9 @@ module EmailHunter
     private
 
     def apiresponse
-      url = "#{API_SEARCH_URL}domain=#{@domain}&api_key=#{@key}"
-      response = (Faraday.new URI.parse(URI.encode(url)), :ssl => {:verify => false}).get
+      url = URI.parse(URI.encode("#{API_SEARCH_URL}domain=#{@domain}&api_key=#{@key}"))
+      response = Faraday.new(url).get
       response.success? ? JSON.parse(response.body, {symbolize_names: true}) : []
     end
   end
-end
+end

data/lib/email_hunter/version.rb

@@ -1,3 +1,3 @@
 module EmailHunter
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: emailhunter
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Davide Santangelo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-01 00:00:00.000000000 Z
+date: 2015-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,6 +129,7 @@ files:
 - lib/email_hunter.rb
 - lib/email_hunter/api.rb
 - lib/email_hunter/exist.rb
+- lib/email_hunter/generate.rb
 - lib/email_hunter/search.rb
 - lib/email_hunter/version.rb
 - lib/emailhunter.rb