zerobounce 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5073bd0edd03b300161b3b85ea16ef52af8695e
-  data.tar.gz: 1527033d9b898a7355fb3427a2de216159f51711
+  metadata.gz: 9c89aae3611e01d420af253c1e3b60a09a5e2903
+  data.tar.gz: 6082f7d46074773f1c8b98cf79c0c1a65a9ba8ee
 SHA512:
-  metadata.gz: 78ce4fbae3708ad80bb1688f892143a7580f36a67d97ff77f21853aa1c3d2bc3cc4aa49434a99cadbf9b728ec1eaa63cb91a45b04588a709bfb7e73d76be5b21
-  data.tar.gz: 0661ffd922bb6d9e17491d92066c4b865cb6c3855dc427716d683cfe325a10aaf11406684082bd69f61c5dc7df39c8e8a81dfa407469f135cc22a6d279bdaadc
+  metadata.gz: 0733544edd82e48f24bab8ecb1880039d8289d7c62a939250c2e5e571a2c906921ac17bbf3b3df2d5e1c4190598c29bb4b78f808aeeed6847a85d18e8da2a713
+  data.tar.gz: d091198164aef11b24ee69f3efa4daf1795e78c769b50352cad5d94cef7947a91847b6d433635f8ef3e94ae2c6610360019954199a3319e64c4cb6100684f000

data/.circleci/config.yml

@@ -0,0 +1,136 @@
+version: 2
+
+workspace_root: &workspace_root
+  ~/zerobounce
+
+defaults: &defaults
+  working_directory: *workspace_root
+  docker:
+    - image: circleci/ruby:2.4
+
+attach_workspace: &attach_workspace
+  attach_workspace:
+    at: *workspace_root
+
+restore_repo: &restore_repo
+  restore_cache:
+    name: Restore repository
+    keys:
+      - v1-repo-{{ .Branch }}-{{ .Revision }}
+
+restore_gems: &restore_gems
+  restore_cache:
+    name: Restore gems
+    keys:
+      - v1-zerobounce-{{ checksum "Gemfile.lock" }}
+
+jobs:
+  checkout-code:
+    <<: *defaults
+    steps:
+      - checkout
+      - save_cache:
+          key: v1-repo-{{ .Branch }}-{{ .Revision }}
+          paths:
+            - *workspace_root
+
+  bundle-dependencies:
+    <<: *defaults
+    steps:
+      - *restore_repo
+      - *restore_gems
+      - run:
+          name: Install Bundler dependencies
+          command: |
+            bin/bundle install --path=vendor/bundle \
+                               --jobs=4 \
+                               --retry=3
+      - run:
+          name: Setup Code Climate test-reporter
+          command: |
+            mkdir -p tmp/
+            curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./tmp/cc-test-reporter
+            chmod +x ./tmp/cc-test-reporter
+      - save_cache:
+          key: v1-zerobounce-{{ checksum "Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+      - persist_to_workspace:
+          root: *workspace_root
+          paths:
+            - vendor/bundle
+            - tmp/cc-test-reporter
+
+  run-specs:
+    <<: *defaults
+    parallelism: 2
+    steps:
+      - *restore_repo
+      - *attach_workspace
+      - run:
+          name: Set bundler path
+          command: bin/bundle --path vendor/bundle
+      - run:
+          name: Run tests
+          command: |
+            bin/bundle exec rspec --profile 10 \
+                                  --format RspecJunitFormatter \
+                                  --out test_results/rspec.xml \
+                                  --format progress \
+                                  $(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)
+            ./tmp/cc-test-reporter format-coverage \
+                                   -t simplecov \
+                                   -o tmp/codeclimate.${CIRCLE_NODE_INDEX}.json \
+                                   ${CIRCLE_ARTIFACTS}/coverage/.resultset.json
+      - persist_to_workspace:
+          root: *workspace_root
+          paths:
+            - tmp
+      - store_test_results:
+          path: test_results
+      - store_artifacts:
+          path: test_results
+          destination: test-results
+      - store_artifacts:
+          path: coverage
+          destination: test-coverage
+
+  upload-coverage:
+    <<: *defaults
+    steps:
+      - *attach_workspace
+      - run:
+          name: Upload coverage results to Code Climate
+          command: |
+            ./tmp/cc-test-reporter sum-coverage tmp/codeclimate.*.json -p 2 -o tmp/codeclimate.total.json
+            ./tmp/cc-test-reporter upload-coverage -i tmp/codeclimate.total.json
+
+  run-rubocop:
+    <<: *defaults
+    steps:
+      - *restore_repo
+      - *attach_workspace
+      - run:
+          name: Set bundler path
+          command: bin/bundle --path vendor/bundle
+      - run:
+          name: Run rubocop
+          command: bin/bundle exec rubocop
+
+workflows:
+  version: 2
+  build-test:
+    jobs:
+      - checkout-code
+      - bundle-dependencies:
+          requires:
+            - checkout-code
+      - run-rubocop:
+          requires:
+            - bundle-dependencies
+      - run-specs:
+          requires:
+            - bundle-dependencies
+      - upload-coverage:
+          requires:
+            - run-specs

data/README.md

@@ -1,4 +1,8 @@
 # Zerobounce
+[![Maintainability](https://api.codeclimate.com/v1/badges/35879ed0fe903e15175e/maintainability)](https://codeclimate.com/github/afrase/zerobounce/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/35879ed0fe903e15175e/test_coverage)](https://codeclimate.com/github/afrase/zerobounce/test_coverage)
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fafrase%2Fzerobounce.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fafrase%2Fzerobounce?ref=badge_shield)
+[![Gem Version](https://badge.fury.io/rb/zerobounce.svg)](https://badge.fury.io/rb/zerobounce)
 
 A ruby client for Zerobounce.net API.
 
@@ -54,6 +58,8 @@ to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 The gem is available as open source under the terms of the
 [MIT License](https://opensource.org/licenses/MIT).
 
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fafrase%2Fzerobounce.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fafrase%2Fzerobounce?ref=badge_large)
+
 ## Code of Conduct
 
 Everyone interacting in the Zerobounce project’s codebases, issue trackers,

data/lib/zerobounce.rb

@@ -8,6 +8,7 @@ require 'zerobounce/configuration'
 
 # Validate an email address with Zerobounce.net
 module Zerobounce
+  # @author Aaron Frase
   class << self
     attr_writer :configuration
 

data/lib/zerobounce/configuration.rb

@@ -6,6 +6,26 @@ require 'zerobounce/middleware/raise_error'
 
 module Zerobounce
   # Configuration object for Zerobounce.
+  #
+  # @author Aaron Frase
+  #
+  # @attr [String] host
+  #   The Zerobounce API host.
+  #
+  # @attr [Hash] headers
+  #   Headers to use in all requests.
+  #
+  # @attr [String] api_key
+  #   A Zerobounce API key.
+  #
+  # @attr [Proc] middleware
+  #   The middleware used by Faraday for each request.
+  #
+  #   @note If you modify the default make sure to add middleware to parse
+  #     the response as json and symbolize the keys.
+  #
+  # @attr [Array<Symbol>] valid_statues
+  #   The statuses that are considered valid by {Response#valid?}.
   class Configuration
     attr_accessor :host
     attr_accessor :headers

data/lib/zerobounce/error.rb

@@ -4,17 +4,23 @@ require 'json'
 
 module Zerobounce
   # The base Zerobounce error.
+  #
+  # @author Aaron Frase
   class Error < StandardError
-    def initialize(env=nil)
+    def initialize(env={})
       @env = env
     end
 
     # Message for the error.
+    #
+    # @return [String]
     def message
       @env[:body]
     end
 
     class << self
+      # Parse the response for errors.
+      #
       # @param [Hash] env
       # @return [Error]
       def from_response(env)
@@ -28,31 +34,41 @@ module Zerobounce
 
       private
 
+      # @param [Hash] env
+      # @return [Error]
       def parse_500(env)
-        if env[:body].start_with?('Missing parameter')
+        if env[:body]&.start_with?('Missing parameter')
           MissingParameter.new(env)
         else
           InternalServerError.new(env)
         end
       end
 
+      # @param [Hash] env
+      # @return [Error, nil]
       def parse_200(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]&.start_with?('{"error":"')
       end
     end
   end
 
   # Server returned a 500 error.
+  #
+  # @author Aaron Frase
   class InternalServerError < Error
   end
 
   # A parameter was missing, usually the apiKey.
+  #
+  # @author Aaron Frase
   class MissingParameter < Error
   end
 
   # General API error, the response code was 200 but an error still occurred.
+  #
+  # @author Aaron Frase
   class ApiError < Error
     # @see #message
     def message

data/lib/zerobounce/middleware/raise_error.rb

@@ -6,8 +6,13 @@ module Zerobounce
   # Faraday middleware.
   module Middleware
     # Raises an error if the response wasn't successful.
+    #
+    # @author Aaron Frase
     class RaiseError < Faraday::Response::Middleware
       # Check for errors after the response has finished.
+      #
+      # @param [Hash] env
+      # @raise [Error]
       def on_complete(env)
         if (error = Zerobounce::Error.from_response(env)) # rubocop:disable GuardClause
           raise error

data/lib/zerobounce/request.rb

@@ -7,11 +7,23 @@ 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.
-  # @attr_reader [Hash] headers The headers used for the request.
-  # @attr_reader [Proc] middleware Faraday middleware used for the request.
+  # @attr_reader [String] url
+  #   The path of the request.
+  #
+  # @attr_reader [String] host
+  #   The host to send the request to.
+  #
+  # @attr_reader [Hash] headers
+  #   The headers used for the request.
+  #
+  # @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'
+
     attr_reader :url
     attr_reader :host
     attr_reader :headers
@@ -21,11 +33,11 @@ module Zerobounce
     # @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}
-    def initialize(params)
+    def initialize(params={})
       @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) ? '/v1/validatewithip' : '/v1/validate'
+      @url = params.key?(:ipaddress) || params.key?(:ip_address) ? VALIDATE_WITH_IP_PATH : VALIDATE_PATH
     end
 
     # Sends a GET request.
@@ -40,7 +52,7 @@ module Zerobounce
 
     # @return [Faraday::Connection]
     def conn
-      @conn ||= Faraday.new(server, headers: headers, &middleware)
+      @conn ||= Faraday.new(host, headers: headers, &middleware)
     end
 
     # @param [Hash] params

data/lib/zerobounce/response.rb

@@ -5,8 +5,13 @@ require 'time'
 module Zerobounce
   # A Zerobounce response
   #
+  # @author Aaron Frase
+  #
   # @attr_reader [Zerobounce::Request] request
+  #   The request instance.
+  #
   # @attr_reader [Faraday::Response] response
+  #   The original {https://www.rubydoc.info/gems/faraday/0.15.2/Faraday/Response Faraday::Response}
   class Response
     attr_reader :response
     attr_reader :request
@@ -30,17 +35,36 @@ module Zerobounce
     #   :abuse
     #   :do_not_mail
     #
-    # @return [Symbol]
+    # @return [Symbol] The status as a +Symbol+.
     def status
       @status ||= underscore(@body[:status])&.to_sym
     end
 
-    # antispam_system | greylisted | mail_server_temporary_error | forcible_disconnect | mail_server_did_not_respond |
-    # timeout_exceeded | failed_smtp_connection | mailbox_quota_exceeded | exception_occurred | possible_traps |
-    # role_based | global_suppression | mailbox_not_found | no_dns_entries | failed_syntax_check | possible_typo |
-    # unroutable_ip_address | leading_period_removed | does_not_accept_mail | alias_address
+    # A more detailed status
     #
-    # @return [Symbol]
+    # Possible values:
+    #   :antispam_system
+    #   :greylisted
+    #   :mail_server_temporary_error
+    #   :forcible_disconnect
+    #   :mail_server_did_not_respond
+    #   :timeout_exceeded
+    #   :failed_smtp_connection
+    #   :mailbox_quota_exceeded
+    #   :exception_occurred
+    #   :possible_traps
+    #   :role_based
+    #   :global_suppression
+    #   :mailbox_not_found
+    #   :no_dns_entries
+    #   :failed_syntax_check
+    #   :possible_typo
+    #   :unroutable_ip_address
+    #   :leading_period_removed
+    #   :does_not_accept_mail
+    #   :alias_address
+    #
+    # @return [Symbol] The sub_status as a +Symbol+.
     def sub_status
       @sub_status ||= underscore(@body[:sub_status])&.to_sym
     end
@@ -124,12 +148,14 @@ module Zerobounce
 
     # Is this email considered valid?
     #
+    # @note Uses the values from {Zerobounce::Configuration#valid_statuses}
+    #
     # @return [Boolean]
     def valid?
       @valid ||= Zerobounce.config.valid_statuses.include?(status)
     end
 
-    # The opposite of #valid?
+    # The opposite of {#valid?}
     #
     # @return [Boolean]
     def invalid?
@@ -141,7 +167,7 @@ module Zerobounce
     # These are temporary emails created for the sole purpose to sign up to websites without giving their real
     # email address. These emails are short lived from 15 minutes to around 6 months.
     #
-    # @note If you have valid emails with this flag set to `true`, you shouldn't email them.
+    # @note If you have valid emails with this flag set to +true+, you shouldn't email them.
     #
     # @return [Boolean]
     def disposable?
@@ -171,16 +197,21 @@ module Zerobounce
       @creation_date ||= @body[:creationdate] && Time.parse(@body[:creationdate])
     end
 
+    # Returns a string containing a human-readable representation.
+    #
+    # @note Overriding inspect to hide the {#request}/{#response} instance variables
+    #
     # @return [String]
     def inspect
-      # Overriding inspect to hide the @request/@response instance variables
       "#<#{self.class.name}:#{object_id}>"
     end
 
+    # Convert to a hash.
+    #
     # @return [Hash]
     def to_h
       public_methods(false).each_with_object({}) do |meth, memo|
-        next if %i[request response inspect to_json to_h].include?(meth)
+        next if %i[request response inspect to_h].include?(meth)
         memo[meth] = send(meth)
       end
     end
@@ -191,9 +222,7 @@ module Zerobounce
     # @return [String, nil]
     def underscore(word)
       return if word.nil? || word.empty?
-      word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2') # for words like HTTPResponse => HTTP_Response
-      word.gsub!(/([a-z\d])([A-Z])/, '\1_\2') # for words like ResponseCode Response_Code
-      word.downcase.tr('-', '_')
+      word.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase.tr('-', '_')
     end
   end
 end

data/lib/zerobounce/version.rb

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

data/zerobounce.gemspec

@@ -4,7 +4,7 @@ lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'zerobounce/version'
 
-Gem::Specification.new do |spec|
+Gem::Specification.new do |spec| # rubocop:disable BlockLength
   spec.name          = 'zerobounce'
   spec.version       = Zerobounce::VERSION
   spec.authors       = ['Aaron Frase']
@@ -22,6 +22,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.metadata['yard.run'] = 'yri' # use "yard" to build full HTML docs.
+
   spec.add_dependency 'faraday', '~> 0.14'
   spec.add_dependency 'faraday_middleware', '~> 0.12'
 
@@ -29,7 +31,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry', '~> 0.11.3'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.3.0'
   spec.add_development_dependency 'rubocop', '~> 0.52'
   spec.add_development_dependency 'rubocop-rspec', '~> 1.22', '>= 1.22.2'
+  spec.add_development_dependency 'simplecov', '~> 0.16.1'
   spec.add_development_dependency 'yard', '~> 0.9.12'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zerobounce
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Aaron Frase
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-23 00:00:00.000000000 Z
+date: 2018-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +142,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.22.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -149,6 +177,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".editorconfig"
 - ".gitignore"
 - ".rspec"
@@ -174,7 +203,8 @@ files:
 homepage: https://github.com/afrase/zerobounce
 licenses:
 - MIT
-metadata: {}
+metadata:
+  yard.run: yri
 post_install_message: 
 rdoc_options: []
 require_paths: