quick_request 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bd80c5052cebb6f89a6bf393e5a63e6efe27d21cdd4fffe1b1f87c9933ed2493
+  data.tar.gz: 1c106336e0560bec4df96100b67e4c4721e36b0dacde5ba1be12e56ad82effe4
+SHA512:
+  metadata.gz: 74afdc960857b2c91c83d3b834954cf7f80ba3eb240b081033db75b532694ada2fdb822b341d46459902d1d8c620fd732fde00aa9e04f10c39f706d1f701e183
+  data.tar.gz: 837f2420959c7ceeb4242cf3ee516275e3c62f7d94eae26f804a609f8f0aea1f6f5e72239696489a457c3d612fa75270b147e7887638869a72a42554ad331138

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2024-08-29
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Chirana
+
+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

@@ -0,0 +1,95 @@
+# QuickRequest
+`QuickRequest` is a lightweight Ruby gem designed to simplify making HTTP and HTTPS requests. It abstracts the complexities of crafting requests by providing a simple, fluent API using the Builder pattern. You can create GET, POST, PUT, and DELETE requests, add query parameters, set headers, and send request bodies easily.
+
+## Installation
+
+To use the QuickRequest gem, add to your `Gemfile`:
+```ruby
+gem 'quick_request', '~> 1.0.0'
+```
+
+Or you can execute:
+```ruby
+gem install quick_request
+```
+
+Obs: Ruby 3 is required
+
+## Basic Usage
+
+Here's a step-by-step guide on how to use the QuickRequest gem.
+
+1. Creating a Request Builder
+
+First, you need to create a `Builder` object. This object allows you to configure your HTTP request.
+
+```ruby
+request = QuickRequest::Builder.new(method: :get, url: 'https://api.example.com/data', use_ssl: true)
+
+request = QuickRequest::Builder.new(url: 'http://localhost:3001')
+```
+
+* `method`: The HTTP method to use (`:get`, `:post`, `:put` or `:delete`). The default is `:get`
+* `url`: The URL to send the request to.
+* `use_ssl`: Whether to use SSL for the request (default: `false`).
+
+
+2. Adding Query Parameters
+
+You can add query parameters to the request using the `query_params` method. This method takes a hash of key-value pairs.
+
+```ruby
+request.query_params({ key1: 'value1', key2: 'value2' })
+```
+
+This will append the query parameters to the URL.
+
+3. Adding a Request Body
+
+For POST and PUT requests, you may want to send data in the request `body`. You can do this with the body method.
+
+```ruby
+request.body({ param1: 'value1', param2: 'value2' })
+```
+
+4. Setting Headers
+
+You can set custom headers for the request using the `headers method. This method takes a hash where the keys are header names, and the values are the corresponding header values.
+
+```ruby
+request.headers({ 'Content-Type' => 'application/json', 'Authorization' => 'Bearer token' })
+```
+
+5. Sending the Request
+
+Once you've configured the request, you can send it using the `send` method. This will return the response body.
+
+```ruby
+response_body = request.send
+```
+
+## Let's see an examples
+
+Here's a full example of making a POST request with headers, query parameters, and a body:
+
+```ruby
+require 'quick_request'
+
+request = QuickRequest::Builder.new(method: :post, url: 'https://api.example.com/submit', use_ssl: true)
+            .query_params({ search: 'ruby' })
+            .headers({ 'Content-Type' => 'application/json', 'Authorization' => 'Bearer token' })
+            .body({ name: 'John', age: 30 })
+
+response_body = request.send
+puts response_body
+
+# > "foo response from api..."
+```
+
+## Error Handling
+
+Currently, the gem raises a generic error if an unsupported HTTP method is used. More sophisticated error handling can be added by wrapping the `send` method call in a `begin-rescue` block.
+
+## Are you a Rubyst ?
+
+So, if you want to collaborate with this project, your help is alwals welcome. You can open issues and create a PR here. So, go ahead!

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/quick_request/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module QuickRequest
+  VERSION = "1.0.0"
+end

data/lib/quick_request.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
+
+require_relative "quick_request/version"
+
+module QuickRequest
+  class Error < StandardError; end
+  class Builder
+    def initialize(method: :get, url: nil, use_ssl: false)
+      @method = method
+      @url = URI.parse(url) unless url.nil?
+      @query_params = {}
+      @body = nil
+      @headers = {}
+      @use_ssl = use_ssl
+    end
+
+    def query_params(params)
+      @query_params = params
+      self
+    end
+
+    def body(content)
+      @body = content.is_a?(Hash) ? URI.encode_www_form(content) : content
+      self
+    end
+
+    def headers(headers)
+      @headers = headers
+      self
+    end
+
+    def send
+      apply_query_params
+      http = Net::HTTP.new(@url.host, @url.port)
+      http.use_ssl = @use_ssl
+
+      request = create_http_request
+      add_headers_to_request(request)
+      request.body = @body if @body
+
+      response = http.request(request)
+      response.body
+    end
+
+    private
+
+    def apply_query_params
+      if @query_params.any?
+        query = URI.encode_www_form(@query_params)
+        @url.query = [@url.query, query].compact.join('&')
+      end
+    end
+
+    def create_http_request
+      case @method
+      when :get
+        Net::HTTP::Get.new(@url)
+      when :post
+        Net::HTTP::Post.new(@url)
+      when :put
+        Net::HTTP::Put.new(@url)
+      when :delete
+        Net::HTTP::Delete.new(@url)
+      else
+        raise "Unsupported HTTP method: #{@method}"
+      end
+    end
+
+    def add_headers_to_request(request)
+      @headers.each do |key, value|
+        request[key] = value
+      end
+    end
+  end
+end

data/sig/quick_request.rbs

@@ -0,0 +1,4 @@
+module QuickRequest
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: quick_request
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- DevCurumin
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-30 00:00:00.000000000 Z
+dependencies: []
+description: It's a simple gem that helps you to send a request
+email:
+- thiago.chirana@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/quick_request.rb
+- lib/quick_request/version.rb
+- sig/quick_request.rbs
+homepage: https://github.com/thiagochirana/quick_request
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/thiagochirana/quick_request
+  source_code_uri: https://github.com/thiagochirana/quick_request
+  changelog_uri: https://github.com/thiagochirana/quick_request/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Quick Request to any API easily
+test_files: []