eezee 1.0.7 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '091f04a358ff0034437fb934f267c82e74ee10109c3f9f9a89625e3cbcb464bf'
-  data.tar.gz: 413ad4f550a63cfebd4e688181369264a423f26bfa8fc2b3e1496b3c5552978c
+  metadata.gz: d15fad54814782889522712e0b2fce58d831d0a3781ce63959aebd149cbda6e9
+  data.tar.gz: d708469dd5d96a66433391f79f7f0908aa36c251cafa02b6a490ae81888790e7
 SHA512:
-  metadata.gz: cb1b44f8219ba5bca6b40703c066f3c3da4ff681ac5cd005599866389d9a30bccdc7b52a2e708da8fd99d8adb0846280f3d71c07a30387671a9db2b98738e331
-  data.tar.gz: 89eef48f82b9a9cd284e2332cdfc2de54a187624c961ae7f8600bbed90e6b68f8f439f6930856e30d19298ed575969531987cb70fa1df513a65cd4e335e8c111
+  metadata.gz: 6e08b1abe503f6ea1bd7321682bde827061334f221dd77285c3a66496da59c6eaecf8c92408ffe73b04887ebcce0421cc4386c7ad4c67656802108ccccd2856f
+  data.tar.gz: 1735d4f1dcfdc4955ba6a1b664b6141b806b0e0e37ee7da6ec404ef6f1fae2d68f0f318e4c81b611b9a43f2cfd43aa62dcfe58fe00400fefd7a6c104d54767c8

data/README.md

@@ -1,11 +1,13 @@
 # [Eezee][gem_page]
 
+*Eezee or ee-zee sounds like "Easy"*
+
 [![Gem Version][gem_version_image]][gem_version_page]
 [![Build Status][travis_status_image]][travis_page]
 [![Maintainability][code_climate_maintainability_image]][code_climate_maintainability_page]
 [![Test Coverage][code_climate_test_coverage_image]][code_climate_test_coverage_page]
 
-The easiest HTTP client for Ruby
+The easiest HTTP client for Ruby!
 
 With Eezee you can do these things:
   * Define external services in an initializer file and use them through a simple method
@@ -17,7 +19,7 @@ With Eezee you can do these things:
   * Raise errors in failed requests
   * Spend more time coding your API integrations instead defining and testing HTTP settings and clients
 
-This gem is supported for Ruby 2.6+ applications
+This gem is supported for Ruby 2.6+ applications.
 
 ## Table of Contents
 - [Getting started](#getting-started)
@@ -28,7 +30,7 @@ This gem is supported for Ruby 2.6+ applications
     - [Available Request options](#available-request-options)
   - [Services](#services)
     - [How a service works](#how-a-service-works)
-  - [Request](#response)
+  - [Request](#request)
   - [Response](#response)
   - [Errors](#errors)
   - [Examples](#examples)
@@ -216,21 +218,64 @@ end
 
 #### How a service works
 
-When Ruby loads a class/module and it has the method `eezee_service` declared with a service's name, by default, Eezee will try load the service and create a request base for the class/module, so, when the class/module takes a request, Eezee will create the final request instance based on request base to take the HTTP request. You can turn it lazy setting the option `lazy: true`, therefore, the final request will be created just in the HTTP request. If the service doesn't exist when Eezee search about it, it will be raised the error `Eezee::Client::UnknownService`.
+When Ruby loads a class/module and it has the method `eezee_service` declared with a service's name, by default, Eezee will try load the service and create a request base for the class/module, so, when the class/module takes a request, Eezee will create the final request instance based on request base to take the HTTP request. You can turn it lazy setting the option `lazy: true`, therefore, the final request will be created just in the HTTP request. If the service doesn't exist when Eezee search about it, it will be raised the error `Eezee::Client::UnknownServiceError`.
 
 About the method `add_service`, you can pass all of [Available Request options](#available-request-options). The meaning of this part is to organize in one way the external services integrations.
 
 ### Request
 
-Coming soon...
+In [Hooks](#hooks), you always receive the param request and it is an instance of `Eezee::Request`. [Available Request options](#available-request-options) are the accessors of `Eezee::Request`, just call for the name, like:
+
+```ruby
+request.protocol
+# => :https
+
+request.url
+# => "rickandmortyapi.com/api"
+```
 
 ### Response
 
-Coming soon...
+In [Hooks](#hooks) and the return of the request you have an instance of `Eezee::Response`. This class can be used for successful and failed requests. Here are all methods you can call from a response:
+
+| Name | Type | What is it? |
+|------|------|-------------|
+| `original` | `Faraday::Response`, `Faraday::Error`, `Faraday::TimeoutError`, `Faraday::ConnectionFailed` or `Net::ReadTimeout` | The instance that made the `Eezee::Response`. |
+| `body` | `Hash` | The body response. It always is an instance of Hash (symbolized). If the response doesn't have a body response, the value will be `{}`. |
+| `success?` | Boolean (`TrueClass` or `FalseClass`) | If the request had a timeout error or response has the code 400+ the value will be `false`, else, the value will be `true`. |
+| `code` | `Integer` or `NilClass` | If the request had a timeout error the value will be `nil`, else, the value will be an integer. |
+| `timeout?` | Boolean (`TrueClass` or `FalseClass`) | If the request had a timeout error. |
 
 ### Errors
 
-Coming soon...
+Eezee can raise errors in some situations:
+  - When the specified service is unknown
+  - When the request got a timeout
+  - When the request got a failure response
+
+#### When the specified service is unknown
+  - `Eezee::Client::UnknownServiceError`
+
+#### When the request got a timeout
+  - `Eezee::TimeoutError`
+
+**Important**: This case happens just if the request option `raise_error` is `true`.
+
+#### When the request got a failure response
+  - `Eezee::RequestError` for all errors (ancestor of all below)
+  - `Eezee::BadRequestError` for code equals 400
+  - `Eezee::UnauthorizedError` for code equals 401
+  - `Eezee::ForbiddenError` for code equals 403
+  - `Eezee::ResourceNotFoundError` for code equals 404
+  - `Eezee::UnprocessableEntityError` for code equals 422
+  - `Eezee::ClientError` for code between 400 and 499
+  - `Eezee::InternalServerError` for code equals 500
+  - `Eezee::ServiceUnavailableError` for code equals 503
+  - `Eezee::ServerError` for code between 500 and 599
+
+All of `Eezee::RequestError` has the accessor `@response` with an instace of `Eezee::Response`.
+
+**Important**: This case happens just if the request option `raise_error` is `true`.
 
 ### Examples
 
@@ -254,7 +299,15 @@ Coming soon...
 
 ## Why use Eezee instead Faraday
 
-Coming soon...
+So, it's an important part of this README. This gem uses [Faraday](#https://github.com/lostisland/faraday) as the HTTP client and Faraday is an excellent HTTP client, but it brings many difficult, or, in other words, many things could be easier, like:
+
+- If you work with microservices, you'll create a Faraday Connection setting per ms, or, it's so common to see many Faraday Connection setting in the same project.
+- To raise errors with Faraday you know to set an adapter (it could be easier)
+- When we have a successful response or an error, the way to catch the params (code, body) is completely different
+- Faraday doesn't have any way to set the external services in an initializer, you'll have to create yours
+- At least, it's common in projects the people create files to instantiate Faraday Connection but these people don't test these files
+
+All of these things and others are contemplated by **Eezee**!
 
 ## Contributing
 
@@ -274,9 +327,9 @@ The gem is available as open source under the terms of the [MIT License][mit_lic
 [contributor_convenant_page]: http://contributor-covenant.org
 [travis_status_image]: https://travis-ci.org/linqueta/eezee.svg?branch=master
 [travis_page]: https://travis-ci.org/linqueta/eezee
-[code_climate_maintainability_image]: https://api.codeclimate.com/v1/badges/b3ae18295c290b6a92a9/maintainability
+[code_climate_maintainability_image]: https://api.codeclimate.com/v1/badges/b5ec73de9875a4675b5a/maintainability
 [code_climate_maintainability_page]: https://codeclimate.com/github/linqueta/eezee/maintainability
-[code_climate_test_coverage_image]: https://api.codeclimate.com/v1/badges/b3ae18295c290b6a92a9/test_coverage
+[code_climate_test_coverage_image]: https://api.codeclimate.com/v1/badges/b5ec73de9875a4675b5a/test_coverage
 [code_climate_test_coverage_page]: https://codeclimate.com/github/linqueta/eezee/test_coverage
 [gem_version_image]: https://badge.fury.io/rb/eezee.svg
 [gem_version_page]: https://rubygems.org/gems/eezee

data/lib/eezee/client/builder.rb

@@ -2,7 +2,7 @@
 
 module Eezee
   module Client
-    class UnknownService < StandardError; end
+    class UnknownServiceError < StandardError; end
 
     module Builder
       def self.extended(base)
@@ -51,7 +51,7 @@ module Eezee
 
       def handle_unknown_service!(service, force)
         return unless take_request?(force)
-        raise UnknownService if !service && eezee_options[:service_name]
+        raise UnknownServiceError if !service && eezee_options[:service_name]
 
         service
       end

data/lib/eezee/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Eezee
-  VERSION = '1.0.7'
+  VERSION = '1.0.8'
 end

data/lib/generators/{katinguele → eezee}/install_generator.rb

@@ -7,7 +7,7 @@ module Eezee
     def create_initializer_file
       create_file(
         'config/initializers/eezee.rb',
-        <<~KATINGUELE_INITIALIZER_TEXT
+        <<~EEZEE_INITIALIZER_TEXT
           # frozen_string_literal: true
 
           Eezee.configure do |config|
@@ -25,7 +25,7 @@ module Eezee
 
             # All available options is on README
           end
-        KATINGUELE_INITIALIZER_TEXT
+        EEZEE_INITIALIZER_TEXT
       )
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eezee
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
 platform: ruby
 authors:
 - linqueta
@@ -256,7 +256,7 @@ files:
 - lib/eezee/request_error_factory.rb
 - lib/eezee/response.rb
 - lib/eezee/version.rb
-- lib/generators/katinguele/install_generator.rb
+- lib/generators/eezee/install_generator.rb
 homepage: https://github.com/linqueta/eezee
 licenses:
 - MIT