zerobounce 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c26d8ef84543260f1c12b728f44ab9c25f9ddd12
-  data.tar.gz: 23e8dd446e127532d5da39d7394b48cfb342d663
+  metadata.gz: 8ada25c0d24b88fdce7947569fc15212b44d07e9
+  data.tar.gz: 797bd934fc6cad5ac9e1c86272877086d06b490b
 SHA512:
-  metadata.gz: 6141f44171fbe3a7589a1a02ef6c60df3b0d4dd9fe20e9b574d702670c7a445079081691c66b03938f40a3a4915e7af610b2745e9460804e19e6cfa8b88143d7
-  data.tar.gz: a473b7a08f5eb680f07d71e33f5f3d5898593a8f001df15166c7dcdcadb02c1c133d40242a9ce5092ad5557e3e5de7a9f5033a0f69107859cf1e2ec5d410d73b
+  metadata.gz: 9a0b0757b6de2e2d1568f953d41483d9264427f42e624b080edd95faec250076fd7db344c451bc6a0cea76086f7ae5fed1487e214b931327a72e0184b598f094
+  data.tar.gz: 24c9e0940c90d06e41ebcc5a46af2948eeeca2919b6387733da473cf3d06990239487f050e32a46f9f08d792f0dffff9553cca703d0ed331c62b9c4f0482d879

data/README.md

@@ -25,13 +25,22 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
+# Configure the client
 Zerobounce.configure do |config|
   config.api_key = 'key'
+  config.valid_statuses = [:valid, :catch_all, :unknown]
 end
 
-Zerobounce.validate(email: 'example@example.com')
-resp = Zerobounce.validate(email: 'example@example.com', ip_address: '127.0.0.1')
+resp = Zerobounce.validate(email: 'valid@example.com')
 resp.valid? # => true
+
+# Change what is considered a valid status
+Zerobounce.valid?('invalid@example.com') # => false
+Zerobounce.config.valid_statuses = [:invalid]
+Zerobounce.valid?('invalid@example.com') # => true
+
+# Use a different API key for one request
+Zerobounce.validate(email: 'valid@example.com', apikey: 'different-api-key')
 ```
 
 ## Development

data/lib/zerobounce.rb

@@ -32,20 +32,52 @@ module Zerobounce
       yield configuration
     end
 
-    # Validate an email address and/or IP address.
+    # Validates the email address and gets geoip information for an IP if provided.
     #
     # @param [Hash] params
+    # @option params [String] :email The email address to validate.
+    # @option params [String] :ip_address An IP address, :ipaddress also works.
+    # @option params [String] :apikey Use a different API key for this request.
+    # @option params [String] :host Use a different host for this request.
+    # @option params [String] :headers Use different headers for this request.
+    # @option params [Proc] :middleware Use different middleware for this request.
     # @return [Zerobounce::Response]
     def validate(params)
-      Request.new(params).get(params)
+      if params.key?(:ipaddress) || params.key?(:ip_address)
+        Request.new(params).validate_with_ip(params)
+      else
+        Request.new(params).validate(params)
+      end
+    end
+
+    # Get the number of remaining credits on the account.
+    #
+    # @param [Hash] params
+    # @option params [String] :apikey Use a different API key for this request.
+    # @option params [String] :host Use a different host for this request.
+    # @option params [String] :headers Use different headers for this request.
+    # @option params [Proc] :middleware Use different middleware for this request.
+    # @return [Integer]
+    def credits(params={})
+      Request.new(params).credits(params)
     end
 
     # Convenience method for checking if an email address is valid.
     #
     # @param [String] email
+    # @param [Hash] params
+    # @return [Boolean]
+    def valid?(email, params={})
+      validate(params.merge(email: email)).valid?
+    end
+
+    # Convenience method for checking if an email address is invalid.
+    #
+    # @param [String] email
+    # @param [Hash] params
     # @return [Boolean]
-    def valid?(email)
-      validate(email: email).valid?
+    def invalid?(email, params={})
+      validate(params.merge(email: email)).invalid?
     end
   end
 end

data/lib/zerobounce/request.rb

@@ -7,9 +7,6 @@ module Zerobounce
   #
   # @author Aaron Frase
   #
-  # @attr_reader [String] url
-  #   The path of the request.
-  #
   # @attr_reader [String] host
   #   The host to send the request to.
   #
@@ -23,8 +20,9 @@ module Zerobounce
     VALIDATE_PATH = '/v1/validate'
     # The validation endpoint for email and IP validation.
     VALIDATE_WITH_IP_PATH = '/v1/validatewithip'
+    # The path to get number number of credits remaining on the account.
+    GET_CREDITS_PATH = '/v1/getcredits'
 
-    attr_reader :url
     attr_reader :host
     attr_reader :headers
     attr_reader :middleware
@@ -37,19 +35,49 @@ module Zerobounce
       @middleware = params[:middleware] || Zerobounce.config.middleware
       @headers = params[:headers] || Zerobounce.config.headers
       @host = params[:host] || Zerobounce.config.host
-      @url = params.key?(:ipaddress) || params.key?(:ip_address) ? VALIDATE_WITH_IP_PATH : VALIDATE_PATH
     end
 
-    # Sends a GET request.
+    # Validate the email address.
     #
     # @param [Hash] params
+    # @option params [String] :email
+    # @option params [String] :apikey
     # @return [Zerobounce::Response]
-    def get(params={})
-      Response.new(conn.get(url, get_params(params)), self)
+    def validate(params)
+      Response.new(get(VALIDATE_PATH, params), self)
+    end
+
+    # Validate the email address and get geoip info for the IP.
+    #
+    # @param [Hash] params
+    # @option params [String] :email
+    # @option params [String] :ip_address
+    # @option params [String] :apikey
+    # @return [Zerobounce::Response]
+    def validate_with_ip(params)
+      Response.new(get(VALIDATE_WITH_IP_PATH, params), self)
+    end
+
+    # Get the number of remaining credits on the account.
+    #
+    # @param [Hash] params
+    # @option params [String] :apikey
+    # @return [Integer] A value of -1 can mean the API is invalid.
+    def credits(params={})
+      get(GET_CREDITS_PATH, params).body[:Credits]&.to_i
     end
 
     private
 
+    # Sends a GET request.
+    #
+    # @param [Hash] params
+    # @param [String] path
+    # @return [Zerobounce::Response]
+    def get(path, params)
+      conn.get(path, get_params(params))
+    end
+
     # @return [Faraday::Connection]
     def conn
       @conn ||= Faraday.new(host, headers: headers, &middleware)

data/lib/zerobounce/version.rb

@@ -2,5 +2,5 @@
 
 module Zerobounce
   # The version of the gem.
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zerobounce
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Aaron Frase