aga-request 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a00fbef7308e4a5cd61fd3227a06467cbbe82a01f48c69fedc24f9e846490642
-  data.tar.gz: e8a7ef87bb251566b9eb87b483211265e90cfeacae28a8d829f9e327e31ddae9
+  metadata.gz: c6e6796f389f50f10fc0f901b1d656cf8d552849ea9a97ae0de64b9230c03cf4
+  data.tar.gz: 99f2fe222281866fd0c1d2d5d96fa3df67055d9386e1872d6954c7a3e01c5f39
 SHA512:
-  metadata.gz: b809408a7a31881aaaa11315498b39312d98d23fbeed05f5b62ea747604913c549dedac85667c26938f48d2f0d2b55ab02c941ce282a430335f974d620a1e93d
-  data.tar.gz: 211dc87b4885f67207fd37299c7f7f9d79f236ffe0fec630bbc08c0007d87f994ccaef7b4b6e44322426781a54f400c241007b866196cac9c2e711c071a67125
+  metadata.gz: 7d40c5dd68cf777893fb81067568a77154ae5581169801c4ca5122f149cf8b3e3be617c2208d53eb951c11d06f8bad87c4b73eca6989d31af80e0e7207e04864
+  data.tar.gz: bdba30dbec6dd437e9c56693a86bf6bf41ff20c219dc5c428a9ce6e4a7e47230cab83b55e4c4a50a117275b7d1b79a4945a4f1fa0dab0e8448088821ef5ad3dc

data/README.md

@@ -1,8 +1,13 @@
-# Aga request
+# Aga-request
 
-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/request`. To experiment with that code, run `bin/console` for an interactive prompt.
+Aga request is a Ruby gem that provides a convenient way to make HTTP requests, including passing parameters, headers, and more. It simplifies the process of interacting with APIs and web services and handles the complexities of handling HTTP requests and responses.
 
-TODO: Delete this and the text above, and describe your gem
+## Features
+
+- Make GET, POST, PUT, DELETE, and other HTTP requests easily.
+- Pass parameters and headers with the requests.
+- Handle response parsing automatically, returning OpenStruct responses.
+- Get access to the response status, headers, and body.
 
 ## Installation
 
@@ -16,14 +21,68 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+To use Aga-request in your application, require the gem and start making requests. Here's a basic example:
+
+```
+require 'request'
+require 'ostruct'
+
+options = OpenStruct.new(
+    http_method: 'get', // get, post, put, patch, delete
+    url: 'https://api.example.com/resource',
+    headers: {}, // All headers you want, without authentication headers
+    data: {}, // Body params
+    params: nil, // Hash if you want to pass any query params 
+    auth: (*),
+    proxy: nil,
+    options: {}
+)
+
+response = Request::Client.request(options)
+
+puts response  # Output: #<Request::Response:0x00007fdac286dd38 @status=200, @body=#`<OpenStruct>`>
+puts response.status # Output: 200
 
-## Development
+puts response.body # Output: #<OpenStruct userId=1, id=1, title="sunt aut facere repellat provident occaecati excepturi optio reprehenderit", body="quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto">
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+OpenStruct of auth possible (*):
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Basic: OpenStruct.new(type::basic, user:'username', pass:'password')
+Bearer: OpenStruct.new(type::bearer, token:'token_value')
+Token: OpenStruct.new(type::token, token:'token_value')
+
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/aga-request.
+Contributions to Aga-request are welcome! If you encounter any issues or have suggestions for improvements, please submit an issue on the repository. Pull requests are also encouraged.
+
+## Private License
+
+Version 0.0.2, 01/06/2023
+
+By obtaining a copy of this software and associated documentation files (the "Software"), you agree that the Software is proprietary to AIGreenAnt and is protected under intellectual property laws. This license grants you limited rights to use the Software solely for internal purposes within your organization.
+
+1. License Grant
+
+   1.1 You are granted a non-exclusive, non-transferable license to use the Software for internal purposes only.
+
+   1.2 You may not distribute, sublicense, sell, or transfer the Software to any third party without prior written permission from AIGreenAnt.
+2. Intellectual Property
+
+   2.1 The Software and any associated intellectual property rights, including but not limited to copyrights, patents, trademarks, trade secrets, and any other proprietary rights, are and shall remain the exclusive property of AIGreenAnt.
+
+   2.2 You may not remove, alter, or obscure any proprietary notices or labels on the Software.
+3. Limitation of Liability
+
+   3.1 In no event shall AIGreenAnt be liable for any direct, indirect, incidental, special, or consequential damages arising out of the use or inability to use the Software, even if AIGreenAnt has been advised of the possibility of such damages.
+4. Termination
+
+   4.1 This license is effective until terminated. AIGreenAnt may terminate this license at any time if you fail to comply with the terms and conditions of this agreement.
+
+   4.2 Upon termination, you must immediately cease all use of the Software and destroy all copies in your possession or control.
+5. Governing Law
+
+   5.1 This license shall be governed by and construed in accordance with the laws of Italy, without regard to its conflict of laws principles.
+
+By using the Software, you acknowledge that you have read and understood this license agreement and agree to be bound by its terms and conditions.

data/lib/request/base.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 require 'faraday'
-require 'active_support'
-require 'active_support/cache'
 
 module Request
   class Base

data/lib/request/resources/auth.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Request
+  module Auth
+    class Authentication
+      AUTH_CLASSES = {
+        basic: 'Basic',
+        bearer: 'Bearer',
+        token: 'Token'
+      }.freeze
+
+      def self.apply(headers, *args)
+        auth_class = AUTH_CLASSES[args.first.type]
+        raise ArgumentError, "Type of authentication: #{args.first.type} doesn't support" unless auth_class
+
+        auth_instance = Object.const_get("Request::Auth::#{auth_class}").new(headers, *args)
+        auth_instance.apply
+      end
+    end
+
+    class BaseAuth
+      def initialize(headers, args)
+        @headers = headers
+        @token = args.token
+      end
+    end
+
+    class Basic
+      def initialize(headers, args)
+        @headers = headers
+        @user = args.user
+        @pass = args.password
+      end
+
+      def apply
+        @headers['Authorization'] = 'Basic ' + ["#{@user}:#{@pass}"].pack('m0')
+      end
+    end
+
+    class Bearer < BaseAuth
+      def apply
+        @headers['Authorization'] = "Bearer #{@token}"
+      end
+    end
+
+    class Token < BaseAuth
+      def apply
+        @headers['Authorization'] = "Token #{@token}"
+      end
+    end
+  end
+end

data/lib/request/resources/client.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Request
+  class Client < Base
+    class << self
+      def request(args)
+        new.request(args)
+      end
+    end
+
+    def request(args) # rubocop: disable Metrics/AbcSize, Style/CommentedKeyword
+      uri = URI.parse(args.url)
+      uri.query = encode_www_form(args.params) if args.params
+
+      body = process_params(headers: args.headers, data: args.data) if args.data
+      Request::Auth::Authentication.apply(args.headers, args.auth) if args.auth
+
+      response = send_request(uri, args, body)
+      response.is_a?(Net::HTTPSuccess) ? build_response(response) : raise_error(response)
+    end
+
+    private
+
+    def build_response(response)
+      Response.new(response.code, response.body)
+    end
+
+    def encode_www_form(params)
+      URI.encode_www_form(params)
+    end
+
+    def opts(uri, options)
+      return unless uri.scheme == 'https'
+
+      {
+        use_ssl: true,
+        verify_mode: OpenSSL::SSL::VERIFY_PEER,
+        read_timeout: options[:read_timeout],
+        open_timeout: options[:open_timeout]
+      }
+    end
+
+    def process_params(headers: nil, data: nil)
+      if !data.is_a?(Enumerable)
+        data
+      else
+        headers['content-type'] = 'application/x-www-form-urlencoded'
+        encode_www_form(data)
+      end
+    end
+
+    def proxy(args)
+      proxy = args.proxy.to_h
+      [proxy[:host], proxy[:port], proxy[:user], proxy[:password]]
+    end
+
+    def raise_error(response)
+      raise Error, response
+    end
+
+    def send_request(uri, args, body)
+      Net::HTTP.start(uri.host, uri.port, *proxy(args), opts(uri, args.options)) do |http|
+        http.send_request(args.http_method.to_s.upcase, uri, body, args.headers)
+      end
+    end
+  end
+end

data/lib/request/resources/error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Request
+  class Error < StandardError
+    attr_reader :response
+
+    def initialize(response)
+      super(response.message)
+
+      @response = response
+    end
+  end
+end

data/lib/request/resources/response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Request
+  class Response
+    attr_reader :status, :body
+
+    def initialize(status, body)
+      @status = Integer(status)
+      @body = body
+      @body = struct(json) unless @body.nil? || @body.empty?
+    end
+
+    def json
+      JSON.parse(@body)
+    end
+
+    def struct(value = json)
+      if value.is_a?(Hash)
+        OpenStruct.new(value.transform_values { |v| struct(v) })
+      elsif value.is_a?(Array)
+        value.map { |v| struct(v) }
+      else
+        value
+      end
+    end
+  end
+end

data/lib/request/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Request
-  VERSION = '0.0.1'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aga-request
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Stefano Baldazzi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-21 00:00:00.000000000 Z
+date: 2023-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -176,7 +176,10 @@ files:
 - lib/request.rb
 - lib/request/autoloader.rb
 - lib/request/base.rb
-- lib/request/resources/http.rb
+- lib/request/resources/auth.rb
+- lib/request/resources/client.rb
+- lib/request/resources/error.rb
+- lib/request/resources/response.rb
 - lib/request/version.rb
 homepage: https://github.com/Baldaz02/aga-request-ruby
 licenses:
@@ -200,5 +203,5 @@ requirements: []
 rubygems_version: 3.3.24
 signing_key: 
 specification_version: 4
-summary: request0.0.1
+summary: request0.0.3
 test_files: []

data/lib/request/resources/http.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-module Request
-  class Http < Base
-    def initialize(api_key: nil, api_secret: nil, cache_options: {})
-      super()
-      @api_key = api_key
-      @api_secret = api_secret
-      @cache = ActiveSupport::Cache.lookup_store(:memory_store, cache_options || default_cache)
-    end
-
-    def get(endpoint, params = {}, headers = {})
-      response = cached_request(:get, endpoint, params, headers)
-      JSON.parse(response.body)
-    end
-
-    def post(endpoint, body = {}, headers = {})
-      response = cached_request(:post, endpoint, body, headers)
-      JSON.parse(response.body)
-    end
-
-    def put(endpoint, body = {}, headers = {})
-      response = cached_request(:put, endpoint, body, headers)
-      JSON.parse(response.body)
-    end
-
-    def delete(endpoint, params = {}, headers = {})
-      response = cached_request(:delete, endpoint, params, headers)
-      JSON.parse(response.body)
-    end
-
-    private
-
-    def cached_request(method, endpoint, payload = {}, headers = {})
-      cache_key = [method, endpoint, payload, headers]
-      if @cache.exist?(cache_key)
-        @cache.read(cache_key)
-      else
-        response = make_request(method, endpoint, payload, headers)
-        @cache.write(cache_key, response)
-        response
-      end
-    end
-
-    def make_request(method, endpoint, payload, headers)
-      connection = Faraday.new(endpoint) do |conn|
-        conn.request :url_encoded
-        conn.adapter Faraday.default_adapter
-      end
-
-      connection.public_send(method) do |request|
-        request.headers.merge!(headers)
-        request.url(endpoint)
-        request.body = payload.to_json if %i[post put].include?(method)
-      end
-    end
-
-    def default_cache
-      { size: 64.megabytes, expires_in: 1.minutes }
-    end
-  end
-end