zerobounce 0.0.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8ada25c0d24b88fdce7947569fc15212b44d07e9
-  data.tar.gz: 797bd934fc6cad5ac9e1c86272877086d06b490b
+SHA256:
+  metadata.gz: f4bfc224ce092b8c62648cec52d26f94a80b501f75dad50dd035b91e3a46cbab
+  data.tar.gz: d9d93f3ac83d697f45676abd22b4281971229e0756d3e287e3e9150a67d4b13e
 SHA512:
-  metadata.gz: 9a0b0757b6de2e2d1568f953d41483d9264427f42e624b080edd95faec250076fd7db344c451bc6a0cea76086f7ae5fed1487e214b931327a72e0184b598f094
-  data.tar.gz: 24c9e0940c90d06e41ebcc5a46af2948eeeca2919b6387733da473cf3d06990239487f050e32a46f9f08d792f0dffff9553cca703d0ed331c62b9c4f0482d879
+  metadata.gz: 70876ead4ecad57b9fa09812c04ebb6bf6dee39d32c699a84e8735bd519b611fc8dc8a3e3c94b1483ae8bf407f6e2f665022fb9014bdb7424c06345af813c8db
+  data.tar.gz: a2a0a495b3fa207556427caed2ee411a1af9ead813ea4b68d9ff4d390f8ca77629bbbe9a89602c495a02f81b57a2b519fe466e21310a9eac610b1e65672c154e

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/pull_request_template.md

@@ -0,0 +1,22 @@
+<!--- Provide a general summary of your changes in the Title above -->
+
+## Description
+<!--- Describe your changes in detail -->
+
+## Related Issue
+<!--- This project only accepts pull requests related to open issues -->
+<!--- If suggesting a new feature or change, please discuss it in an issue first -->
+<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
+<!--- Please link to the issue here: -->
+
+## Motivation and Context
+<!--- Why is this change required? What problem does it solve? -->
+
+## Checklist:
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+- [ ] My code follows the code style of this project.
+- [ ] My change requires a change to the documentation.
+- [ ] I have updated the documentation accordingly.
+- [ ] I have added tests to cover my changes.
+- [ ] All new and existing tests passed.

data/.github/workflows/gem-push.yml

@@ -0,0 +1,43 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/ruby.yml

@@ -0,0 +1,34 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.5', '2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -14,3 +14,4 @@ Gemfile.lock
 
 # rspec failure tracking
 .rspec_status
+.env

data/.rubocop.yml

@@ -1,7 +1,8 @@
 require: rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
+  NewCops: enable
 
   Exclude:
     - 'bin/*'
@@ -16,7 +17,7 @@ Style/Documentation:
 Metrics/AbcSize:
   Max: 18
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
   Exclude:
     - 'spec/**/*'
@@ -36,3 +37,6 @@ Style/SymbolArray:
 
 RSpec/NestedGroups:
   Max: 5
+
+Style/AccessorGrouping:
+  EnforcedStyle: separated

data/.ruby-version

@@ -1 +1 @@
-ruby-2.4.3
+ruby-2.7.3

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# 0.2.0
+
+* Update faraday and faraday_middleware dependency requirements.
+* Update rubocop dev dependencies and fixed failures.
+* Updated minimum ruby version to 2.5.
+
+# 0.1.2
+
+* Removed the double quote from the body check since it appears a space is added after the colon.
+* Added changelog file.
+
+# 0.1.1
+
+* Removed safe accessor usage to work with older versions of Ruby.
+
+# 0.1.0
+
+* Added support for V2 of Zerobounce API.

data/CONTRIBUTING.md

@@ -0,0 +1 @@
+TODO fill this out

data/README.md

@@ -27,7 +27,7 @@ Or install it yourself as:
 ```ruby
 # Configure the client
 Zerobounce.configure do |config|
-  config.api_key = 'key'
+  config.apikey = 'key'
   config.valid_statuses = [:valid, :catch_all, :unknown]
 end
 

data/bin/console

@@ -2,9 +2,6 @@
 
 require 'bundler/setup'
 require 'zerobounce'
-
-# 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.
-
 require 'pry'
+
 Pry.start

data/bin/setup

@@ -4,5 +4,3 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
-
-# Do any other automated setup that you need to do here

data/lib/zerobounce.rb

@@ -24,7 +24,7 @@ module Zerobounce
     #
     # @example
     #   Zerobounce.configure do |config|
-    #     config.api_key = 'api-key'
+    #     config.apikey = 'api-key'
     #   end
     #
     # @yieldparam [Zerobounce::Configuration] config
@@ -43,11 +43,7 @@ module Zerobounce
     # @option params [Proc] :middleware Use different middleware for this request.
     # @return [Zerobounce::Response]
     def validate(params)
-      if params.key?(:ipaddress) || params.key?(:ip_address)
-        Request.new(params).validate_with_ip(params)
-      else
-        Request.new(params).validate(params)
-      end
+      Request.new(params).validate(params)
     end
 
     # Get the number of remaining credits on the account.

data/lib/zerobounce/configuration.rb

@@ -15,7 +15,7 @@ module Zerobounce
   # @attr [Hash] headers
   #   Headers to use in all requests.
   #
-  # @attr [String] api_key
+  # @attr [String] apikey
   #   A Zerobounce API key.
   #
   # @attr [Proc] middleware
@@ -24,23 +24,29 @@ module Zerobounce
   #   @note If you modify the default make sure to add middleware to parse
   #     the response as json and symbolize the keys.
   #
+  # @attr [String] api_version
+  #   The version of the API to use.
+  #
   # @attr [Array<Symbol>] valid_statues
   #   The statuses that are considered valid by {Response#valid?}.
   class Configuration
     attr_accessor :host
     attr_accessor :headers
-    attr_accessor :api_key
+    attr_accessor :apikey
     attr_accessor :middleware
+    attr_accessor :api_version
     attr_accessor :valid_statuses
 
     def initialize
       self.host = 'https://api.zerobounce.net'
-      self.api_key = ENV['ZEROBOUNCE_API_KEY']
+      self.apikey = ENV['ZEROBOUNCE_API_KEY']
+      self.api_version = 'v2'
       self.valid_statuses = %i[valid catch_all]
       self.headers = { user_agent: "ZerobounceRubyGem/#{Zerobounce::VERSION}" }
 
       self.middleware = proc do |builder|
         builder.response(:json, content_type: /\bjson$/, parser_options: { symbolize_names: true })
+        builder.response(:logger) { |l| l.filter(/(api_?key=)(\w+)/, '\1[REMOVED]') } if ENV['ZEROBOUNCE_API_DEBUG']
         builder.use(Zerobounce::Middleware::RaiseError)
         builder.adapter(Faraday.default_adapter)
       end

data/lib/zerobounce/error.rb

@@ -7,28 +7,26 @@ module Zerobounce
   #
   # @author Aaron Frase
   class Error < StandardError
+    attr_reader :env
+
     def initialize(env={})
       @env = env
-    end
-
-    # Message for the error.
-    #
-    # @return [String]
-    def message
-      @env[:body]
+      super(env[:body])
     end
 
     class << self
       # Parse the response for errors.
       #
       # @param [Hash] env
-      # @return [Error]
+      # @return [Error, nil]
       def from_response(env)
         case env[:status]
         when 500
-          parse_500(env)
+          parse500(env)
         when 200
-          parse_200(env)
+          parse200(env)
+        else
+          UnknownError.new(env)
         end
       end
 
@@ -36,8 +34,8 @@ module Zerobounce
 
       # @param [Hash] env
       # @return [Error]
-      def parse_500(env)
-        if env[:body]&.start_with?('Missing parameter')
+      def parse500(env)
+        if env[:body].to_s.start_with?('Missing parameter')
           MissingParameter.new(env)
         else
           InternalServerError.new(env)
@@ -46,10 +44,10 @@ module Zerobounce
 
       # @param [Hash] env
       # @return [Error, nil]
-      def parse_200(env)
+      def parse200(env)
         # The body hasn't been parsed yet and to avoid potentially parsing the body twice
         # we just use String#start_with?
-        ApiError.new(env) if env[:body]&.start_with?('{"error":"')
+        ApiError.new(env) if env[:body].to_s.start_with?('{"error":')
       end
     end
   end
@@ -66,6 +64,12 @@ module Zerobounce
   class MissingParameter < Error
   end
 
+  # When the status code isn't in the defined codes to parse.
+  #
+  # @author Aaron Frase
+  class UnknownError < Error
+  end
+
   # General API error, the response code was 200 but an error still occurred.
   #
   # @author Aaron Frase

data/lib/zerobounce/middleware/raise_error.rb

@@ -14,7 +14,7 @@ module Zerobounce
       # @param [Hash] env
       # @raise [Error]
       def on_complete(env)
-        if (error = Zerobounce::Error.from_response(env)) # rubocop:disable GuardClause
+        if (error = Zerobounce::Error.from_response(env)) # rubocop:disable Style/GuardClause
           raise error
         end
       end

data/lib/zerobounce/request.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'faraday'
+require 'zerobounce/request/v1_request'
+require 'zerobounce/request/v2_request'
 
 module Zerobounce
   # Sends the HTTP request.
@@ -16,46 +18,30 @@ module Zerobounce
   # @attr_reader [Proc] middleware
   #   Faraday middleware used for the request.
   class Request
-    # The normal email validation endpoint.
-    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 :host
     attr_reader :headers
     attr_reader :middleware
+    attr_reader :api_version
 
+    # Set instance variables and extends the correct Zerobounce::Request
+    #
     # @param [Hash] params
     # @option params [String] :middleware default: {Configuration#middleware} {include:#middleware}
     # @option params [String] :headers default: {Configuration#headers} {include:#headers}
     # @option params [String] :host default: {Configuration#host} {include:#host}
+    # @option params [String] :api_version default: {Configuration#api_version} {include:#api_version}
     def initialize(params={})
       @middleware = params[:middleware] || Zerobounce.config.middleware
       @headers = params[:headers] || Zerobounce.config.headers
       @host = params[:host] || Zerobounce.config.host
-    end
-
-    # Validate the email address.
-    #
-    # @param [Hash] params
-    # @option params [String] :email
-    # @option params [String] :apikey
-    # @return [Zerobounce::Response]
-    def validate(params)
-      Response.new(get(VALIDATE_PATH, params), self)
-    end
+      @api_version = params[:api_version] || Zerobounce.config.api_version
 
-    # 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)
+      case api_version
+      when 'v2'
+        extend(V2Request)
+      else
+        extend(V1Request)
+      end
     end
 
     # Get the number of remaining credits on the account.
@@ -64,7 +50,7 @@ module Zerobounce
     # @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
+      get('getcredits', params).body[:Credits].to_i
     end
 
     private
@@ -80,15 +66,7 @@ module Zerobounce
 
     # @return [Faraday::Connection]
     def conn
-      @conn ||= Faraday.new(host, headers: headers, &middleware)
-    end
-
-    # @param [Hash] params
-    # @return [Hash]
-    def get_params(params)
-      valid_params = %i[apikey ipaddress email]
-      params[:ipaddress] = params.delete(:ip_address) if params.key?(:ip_address) # normalize ipaddress key
-      { apikey: Zerobounce.config.api_key }.merge(params.select { |k, _| valid_params.include?(k) })
+      @conn ||= Faraday.new("#{host}/#{api_version}", headers: headers, &middleware)
     end
   end
 end