service_client 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 346614efbcf2a797ae8cb217ab590cbeaa35b6d2c8b75c808b437411bec9cd5f
-  data.tar.gz: 9e8957a321ced64da1f0f8ceae671f2005b28eed236f74f2fcdfaf0e7c87dc35
+  metadata.gz: 521a1eeca83e5e229c94fcd20c94e9173e30ef27036e961c1d5dcfc02294d7e1
+  data.tar.gz: 46b385eb2d4619a8eafe55af1379ec8753d3fd8e314cff577694e972ed5545ef
 SHA512:
-  metadata.gz: edb896efd67024f3480f34cef5a589aaba511e05a08906c7def7f2c696bdf5fe7a4d6e323f49d1c4b634369b6a2cfe5b4eabb9f7515f684c11689f1a9845cc53
-  data.tar.gz: d4c7f8a8564fb4a7b36715732a88dd2ba7f73819d75692e94c7d3f68cc288d704e242e6e90e27c3a652dc8e2845a55ba8fc93319c6a4401f4b4cc8686a1daa22
+  metadata.gz: 39065c89a4675a343e87bf748eb910bd2d9b132655653e72e3e9459e8e834fc129d716b0cf5837d0c6a1f8c154304c289e060b02c3ac689d388fdd1cd42b06fc
+  data.tar.gz: 1811584d2b959c7db852620e711ce1946bff3434960681695113e8779adf946e48c81ee037f28928c2b468a7fc86bb6a1ce47dcf34fad711e9bc43c27f5a4823

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

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    service_client (0.1.0)
+    service_client (0.1.2)
       httparty (~> 0.18.0)
 
 GEM
@@ -15,6 +15,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)
@@ -36,6 +37,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (= 2.1.4)
   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

@@ -2,8 +2,6 @@
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/service_client`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-TODO: Delete this and the text above, and describe your gem
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -14,15 +12,154 @@ gem 'service_client'
 
 And then execute:
 
-    $ bundle install
+```bash
+bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install service_client
+```bash
+gem install service_client
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+Basic usage example:
+
+```ruby
+class CustomerClient < ServiceClient::Base
+  def find(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 all
+    get(nil)
+  rescue ServiceClient::ParamsRequired => e
+    puts e.message
+  end
+end
+
+```
+
+## Methods of class
+
+```ruby
+# GET
+ServiceClient::Base.get(url, headers:)
+
+# POST
+ServiceClient::Base.post(url, headers:, body:)
+
+# PUT
+ServiceClient::Base.put(url, headers:, body:)
+
+# DELETE
+ServiceClient::Base.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
 
@@ -32,8 +169,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/service_client.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/nemuba/service_client.
 
 ## License
 

data/lib/service_client/base.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require_relative 'response'
+
+module ServiceClient
+  # Base class
+  class ParamsRequired < StandardError; end
+  
+  class Base
+    # ParamsRequired error
+
+    class << self
+      def post(url = nil, headers: nil, body: nil)
+        raise_params_required(url: url, headers: headers, body: body)
+
+        request = HTTParty.post(url, headers: headers, body: body)
+
+        make_response(request)
+      end
+
+      def get(url = nil, headers: nil)
+        raise_params_required(url: url)
+
+        request = HTTParty.get(url, headers: headers)
+
+        make_response(request)
+      end
+
+      def put(url = nil, headers: nil, body: nil)
+        raise_params_required(url: url, body: body)
+
+        request = HTTParty.put(url, headers: headers, body: body)
+
+        make_response(request)
+      end
+
+      def delete(url = nil, headers: nil)
+        raise_params_required(url: url)
+
+        request = HTTParty.delete(url, headers: headers)
+
+        make_response(request)
+      end
+
+      private
+
+      def make_response(response)
+        Response.call(response)
+      end
+
+      def raise_params_required(params)
+        raise ParamsRequired, "Params: #{nil_params(params)} are required" if params_nil?(params)
+      end
+
+      def nil_params(params)
+        params.select { |_, value| value.nil? }.keys
+      end
+
+      def params_nil?(params)
+        params.values.any?(&:nil?)
+      end
+    end
+  end
+end

data/lib/service_client/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ServiceClient
-  VERSION = "0.1.0"
+  VERSION = "0.1.2".freeze
 end

data/lib/service_client.rb

@@ -1,66 +1,7 @@
 # frozen_string_literal: true
+
+require 'httparty'
 require_relative 'service_client/version'
 require_relative 'service_client/response'
+require_relative 'service_client/base'
 require_relative 'service_client/errors'
-require 'httparty'
-
-# Service Client
-module ServiceClient
-  # ParamsRequired error
-  class ParamsRequired < StandardError; end
-
-  # Call class
-  class Call
-    def self.post(url = nil, headers: nil, body: nil)
-      raise_params_required(url: url, headers: headers, body: body)
-
-      request = HTTParty.post(url, headers: headers, body: body)
-
-      make_response(request)
-    end
-
-    def self.get(url = nil, headers: nil)
-      raise_params_required(url: url)
-
-      request = HTTParty.get(url, headers: headers)
-
-      make_response(request)
-    end
-
-    def self.put(url = nil, headers: nil, body: nil)
-      raise_params_required(url: url, body: body)
-
-      request = HTTParty.put(url, headers: headers, body: body)
-
-      make_response(request)
-    end
-
-    def self.delete(url = nil, headers: nil)
-      raise_params_required(url: url)
-
-      request = HTTParty.delete(url, headers: headers)
-
-      make_response(request)
-    end
-
-    class << self
-      private
-
-      def make_response(response)
-        Response.call(response)
-      end
-
-      def raise_params_required(params)
-        raise ParamsRequired, "Params: #{nil_params(params)} are required" if params_nil?(params)
-      end
-
-      def nil_params(params)
-        params.select { |_, value| value.nil? }.keys
-      end
-
-      def params_nil?(params)
-        params.values.any?(&:nil?)
-      end
-    end
-  end
-end

metadata

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