service_client 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 346614efbcf2a797ae8cb217ab590cbeaa35b6d2c8b75c808b437411bec9cd5f
-  data.tar.gz: 9e8957a321ced64da1f0f8ceae671f2005b28eed236f74f2fcdfaf0e7c87dc35
+  metadata.gz: 6b08c3ae1cd289404a362c7a57e3caafa43b0c5cb59cb3af1baeb9391dc8c59b
+  data.tar.gz: 6b3a8b21aba11b9cf2213f88a8f16c8df35bac58611791dde035738195a26b72
 SHA512:
-  metadata.gz: edb896efd67024f3480f34cef5a589aaba511e05a08906c7def7f2c696bdf5fe7a4d6e323f49d1c4b634369b6a2cfe5b4eabb9f7515f684c11689f1a9845cc53
-  data.tar.gz: d4c7f8a8564fb4a7b36715732a88dd2ba7f73819d75692e94c7d3f68cc288d704e242e6e90e27c3a652dc8e2845a55ba8fc93319c6a4401f4b4cc8686a1daa22
+  metadata.gz: bc58261c84dd5f89c3f88ba70d92cd74ddd6223effbc3784d5a436f0303e5d17000fc038d224266561e0adde28eac729e7f53d4888b393b6fb70f52b4bf0aae9
+  data.tar.gz: 85006dfbf928d9b63e34fc456bfa33a3556e9706cd4d9fc932eed424e4216846936b32bcddcd37422d5405e6e75e59a398afc9ec11c62f6db4b6caa5996836a2

data/Gemfile

@@ -8,3 +8,4 @@ ruby "2.7.1"
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
 gem "httparty", "~> 0.18.0"
+gem "rack", "~> 2.2.3"

data/Gemfile.lock

@@ -7,6 +7,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    byebug (11.1.3)
     diff-lcs (1.5.0)
     httparty (0.18.1)
       mime-types (~> 3.0)
@@ -15,6 +16,7 @@ GEM
       mime-types-data (~> 3.2015)
     mime-types-data (3.2022.0105)
     multi_xml (0.6.0)
+    rack (2.2.6.2)
     rake (12.3.3)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -35,7 +37,9 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (= 2.1.4)
+  byebug
   httparty (~> 0.18.0)
+  rack (~> 2.2.3)
   rake (~> 12.0)
   rspec (~> 3.0)
   service_client!

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Alef ojeda de Oliveira
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -22,7 +22,142 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Basic usage example:
+
+```ruby
+class Request < ServiceClient::Call
+  def customer(id)
+    response = get("https://api.com/customers/#{id}")
+
+    response.data
+  rescue ServiceClient::Errors::NoDataFoundError => e
+    puts e.response.code # 404
+    puts e.response.headers
+    puts e.response.data 
+  rescue ServiceClient::Errors::InternalServerError => e
+    puts e.response.code # 500
+    puts e.response.headers
+    puts e.response.data
+  # All errors of HTTP status code
+  end
+
+  def customers
+    get(nil)
+  rescue ServiceClient::ParamsRequired => e
+    puts e.message
+  end
+end
+
+```
+
+# Methods of class
+
+```ruby
+# GET
+ServiceClient::Call.get(url, headers:)
+
+# POST
+ServiceClient::Call.post(url, headers:, body:)
+
+# PUT
+ServiceClient::Call.put(url, headers:, body:)
+
+# DELETE
+ServiceClient::Call.delete(url, headers:, body:)
+```
+
+# Classes of errors
+
+```ruby
+# 400 – Bad Request
+  ServiceClient::Errors::BadRequestError
+  # 401 – Unauthorized
+  ServiceClient::Errors::UnauthorizedError
+  # 402 – Payment Required
+  ServiceClient::Errors::PaymentRequiredError
+  # 403 – Forbidden
+  ServiceClient::Errors::ForbiddenError
+  # 404 – Not Found
+  ServiceClient::Errors::NotFoundError
+  # 405 – Method Not Allowed
+  ServiceClient::Errors::MethodNotAllowedError
+  # 406 – Not Acceptable
+  ServiceClient::Errors::NotAcceptableError
+  # 407 – Proxy Authentication Required
+  ServiceClient::Errors::ProxyAuthenticationRequiredError
+  # 408 – Request Timeout
+  ServiceClient::Errors::RequestTimeoutError
+  # 409 – Conflict
+  ServiceClient::Errors::ConflictError
+  # 410 – Gone
+  ServiceClient::Errors::GoneError
+  # 411 – Length Required
+  ServiceClient::Errors::LengthRequiredError
+  # 412 – Precondition Failed
+  ServiceClient::Errors::PreconditionFailedError
+  # 413 – Request Entity Too Large
+  ServiceClient::Errors::RequestEntityTooLargeError
+  # 414 – Request-URI Too Long
+  ServiceClient::Errors::RequestURITooLongError
+  # 415 – Unsupported Media Type
+  ServiceClient::Errors::UnsupportedMediaTypeError
+  # 416 – Requested Range Not Satisfiable
+  ServiceClient::Errors::RequestedRangeNotSatisfiableError
+  # 417 – Expectation Failed
+  ServiceClient::Errors::ExpectationFailedError
+  # 420 – Enhance Your Calm
+  ServiceClient::Errors::EnhanceYourCalmError
+  # 422 – Unprocessable Entity
+  ServiceClient::Errors::UnprocessableEntityError
+  # 423 – Locked
+  ServiceClient::Errors::LockedError
+  # 424 – Failed Dependency
+  ServiceClient::Errors::FailedDependencyError
+  # 426 – Upgrade Required
+  ServiceClient::Errors::UpgradeRequiredError
+  # 428 – Precondition Required
+  ServiceClient::Errors::PreconditionRequiredError
+  # 429 – Too Many Requests
+  ServiceClient::Errors::TooManyRequestsError
+  # 431 – Request Header Fields Too Large
+  ServiceClient::Errors::RequestHeaderFieldsTooLargeError
+  # 444 – No Response
+  ServiceClient::Errors::NoResponseError
+  # 449 – Retry With
+  ServiceClient::Errors::RetryWithError
+  # 450 – Bllocked by Windows Parental Controls
+  ServiceClient::Errors::BlockedByWindowsParentalControlsError
+  # 451 – Unavailable For Legal Reasons
+  ServiceClient::Errors::UnavailableForLegalReasonsError
+  # 499 – Client Closed Request
+  ServiceClient::Errors::ClientClosedRequestError
+  # 500 – Internal Server Error
+  ServiceClient::Errors::InternalServerError
+  # 501 – Not Implemented
+  ServiceClient::Errors::NotImplementedError
+  # 502 – Bad Gateway
+  ServiceClient::Errors::BadGatewayError
+  # 503 – Service Unavailable
+  ServiceClient::Errors::ServiceUnavailableError
+  # 504 – Gateway Timeout
+  ServiceClient::Errors::GatewayTimeoutError
+  # 505 – HTTP Version Not Supported
+  ServiceClient::Errors::HTTPVersionNotSupportedError
+  # 506 – Variant Also Negotiates
+  ServiceClient::Errors::VariantAlsoNegotiatesError
+  # 507 – Insufficient Storage
+  ServiceClient::Errors::InsufficientStorageError
+  # 508 – Loop Detected
+  ServiceClient::Errors::LoopDetectedError
+  # 510 – Not Extended
+  ServiceClient::Errors::NotExtendedError
+  # 511 – Network Authentication Required
+  ServiceClient::Errors::NetworkAuthenticationRequiredError
+  # 598 – Network Read Timeout Error
+  ServiceClient::Errors::NetworkReadTimeoutError
+  # 599 – Network Connect Timeout Error
+  ServiceClient::Errors::NetworkConnectTimeoutError
+```
 
 ## Development
 
@@ -34,7 +169,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/service_client.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/service_client/version.rb

@@ -1,3 +1,3 @@
 module ServiceClient
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/service_client.rb

@@ -3,6 +3,7 @@ require_relative 'service_client/version'
 require_relative 'service_client/response'
 require_relative 'service_client/errors'
 require 'httparty'
+require 'rack/utils'
 
 # Service Client
 module ServiceClient

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alef Ojeda de Oliveira
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-05 00:00:00.000000000 Z
+date: 2023-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -47,6 +47,7 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile