active_jobject 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 25a4e56c18e49c5151fef9020b24fa6ff7e9c5f753e7bc31035cfd906fb27c41
+  data.tar.gz: f39f850277672136d0d87ef6685088f480c09218a7a27879e4d79ad1665016b6
+SHA512:
+  metadata.gz: c64b52c489aeb0e289fa348ae08583a5ba8f523a2cfec7222f1bbf265ca28e557d76f0fe6bd0a24e711c64321f6c0366503b87c185358caf31ea58f3ac94aab4
+  data.tar.gz: a906370c3219908a1b1ca5dbd9c3b5270b05a9b9326eaf72398bfdc4b856135332202546ccb38877a3b393e0e8254ed5bfb86f5f9e6ecd71e3fff16e4d3e5f33

data/.solargraph.yml

@@ -0,0 +1,22 @@
+---
+include:
+  - "**/*.rb"
+  - "**/*.erb"
+exclude:
+  - spec/**/*
+  - test/**/*
+  - vendor/**/*
+  - ".bundle/**/*"
+require: []
+domains: []
+reporters:
+  - rubocop
+  - require_not_found
+formatter:
+  rubocop:
+    cops: safe
+    except: []
+    only: []
+    extra_args: []
+require_paths: []
+max_files: 5000

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Guilherme Theodoro
+
+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,38 @@
+# ActiveJobject
+
+Yes ActiveJobject, as in Active JSON Object (clever I know). This gem is built as a wraper for handling external connections with parsers and authentication built-in. It also supports 
+several HTTP request / gem so you can use your own `engine` or gem that better suits your needs. It also comes packaged with it's own error handling, allowing for more consistent and standard error handling cross-project.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/active_jobject.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/active_jobject/base.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ActiveJobject
+  class Base
+    include ActiveJobject::Request
+
+    class << self
+      attr_accessor :_site
+
+      def site
+        _site
+      end
+
+      def site=(site)
+        self._site = site
+      end
+    end
+
+    def uri
+      self.class._site.is_a?(URI) ? self.class._site : URI(self.class._site)
+    end
+  end
+end

data/lib/active_jobject/collection.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ActiveJobject
+  class Collection < Array
+  end
+end

data/lib/active_jobject/parser.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module ActiveJobject
+  module Parser
+    class InvalidInstance < ActiveJobject::Error; end
+
+    def parse(klass, **attributes)
+      raise InvalidInstance, "Class #{klass&.name || klass} is not an instance." if klass.is_a?(Class)
+
+      attributes.each do |attribute, value|
+        return_value = if value.is_a?(Array)
+          parse_array(klass, attribute, value)
+        elsif value.is_a?(Hash)
+          parse_hash(klass, attribute, value)
+        else
+          value
+        end
+
+        define_singleton_methods(klass, attribute, return_value)
+      end
+
+      klass
+    end
+
+    private
+
+    def parse_array(klass, attribute, value)
+      subklass = define_const(klass.class, attribute.split('_').map(&:capitalize).join.to_sym, Class.new(klass.class))
+
+      ActiveJobject::Collection.new(
+        value.map do |arr_value|
+          if arr_value.is_a?(Hash)
+            subklass_instance = subklass.new
+            parse(subklass_instance, **arr_value)
+          else
+            arr_value
+          end
+        end
+      )
+    end
+
+    def parse_hash(klass, attribute, value)
+      subklass = define_const(klass.class, attribute.split('_').map(&:capitalize).join.to_sym, Class.new(klass.class))
+      subklass_instance = subklass.new
+
+      parse(subklass_instance, **value)
+    end
+
+    def define_singleton_methods(klass, attribute, return_value)
+      klass.instance_variable_set(:"@#{attribute}", return_value)
+
+      klass.singleton_class.send(:define_method, attribute.to_sym) do
+        klass.instance_variable_get(:"@#{attribute}")
+      end
+
+      klass.singleton_class.send(:define_method, "#{attribute.to_sym}=") do |new_value|
+        instance_variable_set(:"@#{attribute}", new_value)
+      end
+    end
+
+    def define_const(base_klass, name, klass)
+      if base_klass.const_defined?(name, false)
+        base_klass.const_get(name, false)
+      else
+        base_klass.const_set(name, klass)
+      end
+    end
+  end
+end

data/lib/active_jobject/request/engine/base.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module ActiveJobject
+  module Request
+    module Engine
+      class Base
+        class << self
+          def get
+            raise NotImplementedError
+          end
+
+          def post
+            raise NotImplementedError
+          end
+
+          def put
+            raise NotImplementedError
+          end
+
+          def patch
+            raise NotImplementedError
+          end
+
+          def delete
+            raise NotImplementedError
+          end
+
+          def error_class(status)
+            case status
+            when 401
+              ActiveJobject::Request::Unauthorized
+            when 403
+              ActiveJobject::Request::Forbidden
+            when 404
+              ActiveJobject::Request::NotFound
+            when 500
+              ActiveJobject::Request::ServerError
+            else
+              ActiveJobject::Request::Error
+            end
+          end
+
+          def authorization_strategy
+            @authorization_strategy ||= ->(site:) { raise NotImplementedError, 'Set `authorization_strategy` prior to running requests.' } # rubocop:disable Lint/UnusedBlockArgument
+          end
+          attr_writer :authorization_strategy
+
+          def before_request; end
+
+          def after_request; end
+        end
+      end
+    end
+  end
+end

data/lib/active_jobject/request/engine/net_http.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module ActiveJobject
+  module Request
+    module Engine
+      class NetHttp < ActiveJobject::Request::Engine::Base
+        class << self
+          # Make a HTTP GET request.
+          #
+          # @raise [ActiveJobject::Request::Error] error class related with the request.
+          #
+          # @return [Net::HTTPResponse]
+          def get(site:, headers: {}, params: {})
+            site.query = URI.encode_www_form(params)
+            req = Net::HTTP::Get.new(site)
+
+            headers.each do |key, value|
+              req[key] = value
+            end
+
+            response = Net::HTTP.start(site.hostname, site.port) do |http|
+              http.request(req)
+            end
+
+            raise error_class(response.code.to_i).new(response:, status: response.code.to_i) unless response.class < Net::HTTPSuccess
+
+            response
+          end
+
+          # Make a HTTP POST request.
+          #
+          # @raise [ActiveJobject::Request::Error] error class related with the request.
+          #
+          # @return [Net::HTTPResponse]
+          def post(site:, headers: {}, params: {}, body: nil)
+            site.query = URI.encode_www_form(params)
+            req = Net::HTTP::Post.new(site)
+
+            headers.each do |key, value|
+              req[key] = value
+            end
+
+            req.body = body.is_a?(Hash) ? JSON.generate(body) : body
+
+            response = Net::HTTP.start(site.hostname, site.port) do |http|
+              http.request(req)
+            end
+
+            raise error_class(response.code.to_i).new(response:, status: response.code.to_i) unless response.class < Net::HTTPSuccess
+
+            response
+          end
+
+          # Make a HTTP PUT request.
+          #
+          # @raise [ActiveJobject::Request::Error] error class related with the request.
+          #
+          # @return [Net::HTTPResponse]
+          def put(site:, headers: {}, params: {}, body: nil)
+            site.query = URI.encode_www_form(params)
+            req = Net::HTTP::Put.new(site)
+
+            headers.each do |key, value|
+              req[key] = value
+            end
+
+            req.body = body.is_a?(Hash) ? JSON.generate(body) : body
+
+            response = Net::HTTP.start(site.hostname, site.port) do |http|
+              http.request(req)
+            end
+
+            raise error_class(response.code.to_i).new(response:, status: response.code.to_i) unless response.class < Net::HTTPSuccess
+
+            response
+          end
+
+          # Make a HTTP PATCH request.
+          #
+          # @raise [ActiveJobject::Request::Error] error class related with the request.
+          #
+          # @return [Net::HTTPResponse]
+          def patch(site:, headers: {}, params: {}, body: nil)
+            site.query = URI.encode_www_form(params)
+            req = Net::HTTP::Patch.new(site)
+
+            headers.each do |key, value|
+              req[key] = value
+            end
+
+            req.body = body.is_a?(Hash) ? JSON.generate(body) : body
+
+            response = Net::HTTP.start(site.hostname, site.port) do |http|
+              http.request(req)
+            end
+
+            raise error_class(response.code.to_i).new(response:, status: response.code.to_i) unless response.class < Net::HTTPSuccess
+
+            response
+          end
+
+          # Make a HTTP DELETE request.
+          #
+          # @raise [ActiveJobject::Request::Error] error class related with the request.
+          #
+          # @return [Net::HTTPResponse]
+          def delete(site:, headers: {}, params: {})
+            site.query = URI.encode_www_form(params)
+            req = Net::HTTP::Delete.new(site)
+
+            headers.each do |key, value|
+              req[key] = value
+            end
+
+            response = Net::HTTP.start(site.hostname, site.port) do |http|
+              http.request(req)
+            end
+
+            raise error_class(response.code.to_i).new(response:, status: response.code.to_i) unless response.class < Net::HTTPSuccess
+
+            response
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_jobject/request/engine/oauth2.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+# Optional Dependency since the default engine is Net/HTTP
+require 'oauth2' if Gem::Specification.find_all_by_name('oauth2').any?
+
+module ActiveJobject
+  module Request
+    module Engine
+      class OAuth2 < ActiveJobject::Request::Engine::Base
+        class << self
+          # Make a HTTP GET request.
+          #
+          # @raise [ActiveJobject::Request::Error] error class related with the request.
+          #
+          # @return [OAuth2::Response] the response from the request
+          #
+          # @see OAuth2::Client#request
+          def get(site:, headers: {}, params: {})
+            host, path = deconstruct_uri(site)
+
+            authorization_strategy.call(site: host).get(path, params:, headers:)
+          rescue ::OAuth2::Error => e
+            raise handle_error(e, caller)
+          end
+
+          # Make a HTTP POST request.
+          #
+          # @raise [ActiveJobject::Request::Error] error class related with the request.
+          #
+          # @return [OAuth2::Response] the response from the request
+          #
+          # @see OAuth2::Client#request
+          def post(site:, headers: {}, params: {}, body: nil)
+            host, path = deconstruct_uri(site)
+
+            authorization_strategy.call(site: host).post(path, params:, headers:, body:)
+          rescue ::OAuth2::Error => e
+            raise handle_error(e, caller)
+          end
+
+          # Make a HTTP PUT request.
+          #
+          # @raise [ActiveJobject::Request::Error] error class related with the request.
+          #
+          # @return [OAuth2::Response] the response from the request
+          #
+          # @see OAuth2::Client#request
+          def put(site:, headers: {}, params: {}, body: nil)
+            host, path = deconstruct_uri(site)
+
+            authorization_strategy.call(site: host).put(path, params:, headers:, body:)
+          rescue ::OAuth2::Error => e
+            raise handle_error(e, caller)
+          end
+
+          # Make a HTTP PATCH request.
+          #
+          # @raise [ActiveJobject::Request::Error] error class related with the request.
+          #
+          # @return [OAuth2::Response] the response from the request
+          #
+          # @see OAuth2::Client#request
+          def patch(site:, headers: {}, params: {}, body: nil)
+            host, path = deconstruct_uri(site)
+
+            authorization_strategy.call(site: host).patch(path, params:, headers:, body:)
+          rescue ::OAuth2::Error => e
+            raise handle_error(e, caller)
+          end
+
+          # Make a HTTP DELETE request.
+          #
+          # @raise [ActiveJobject::Request::Error] error class related with the request.
+          #
+          # @return [OAuth2::Response] the response from the request
+          #
+          # @see OAuth2::Client#request
+          def delete(site:, headers: {}, params: {})
+            host, path = deconstruct_uri(site)
+
+            authorization_strategy.call(site: host).delete(path, params:, headers:)
+          rescue ::OAuth2::Error => e
+            raise handle_error(e, caller)
+          end
+
+          private
+
+          def handle_error(error, original_caller)
+            raise error if error.class != ::OAuth2::Error
+
+            response_status = error.response&.status
+            http_error_class = error_class(response_status).new(response: error.response, status: response_status)
+
+            http_error_class.set_backtrace(original_caller)
+            raise http_error_class
+          end
+
+          def deconstruct_uri(uri)
+            host_with_scheme = [80, 443].include?(uri.port) ? "#{uri.scheme}://#{uri.host}/" : "#{uri.scheme}://#{uri.host}:#{uri.port}/"
+            path = uri.path
+
+            [host_with_scheme, path]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_jobject/request/error.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ActiveJobject
+  module Request
+    class Error < ActiveJobject::Error
+      def initialize(response:, status:)
+        @response = response
+        @status = status
+
+        super("Request Failed: Status #{status}.")
+      end
+
+      def to_h
+        { message:, status: @status, backtrace: backtrace }
+      end
+    end
+
+    # Errors related to HTTP Status 401
+    class Unauthorized < Error; end
+
+    # Errors related to HTTP Status 403
+    class Forbidden < Error; end
+
+    # Errors related to HTTP Status 404
+    class NotFound < Error; end
+
+    # Errors related to HTTP Status 500
+    class ServerError < Error; end
+  end
+end

data/lib/active_jobject/request.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module ActiveJobject
+  module Request
+    include ActiveJobject::Parser
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def engine=(engine)
+        @engine = engine
+      end
+
+      def engine
+        @engine ||= ActiveJobject::Request::Engine::NetHttp
+      end
+
+      def default_headers=(headers)
+        @default_headers = headers
+      end
+
+      def default_headers
+        @default_headers ||= {}
+      end
+    end
+
+    def get(headers: {}, params: {})
+      merged_headers = self.class.default_headers.merge(headers)
+      response = self.class.engine.get(site: uri, headers: merged_headers, params:)
+
+      parse(self, **JSON.parse(response.body))
+    end
+
+    def post(headers: {}, params: {}, body: nil)
+      merged_headers = self.class.default_headers.merge(headers)
+      response = self.class.engine.post(site: uri, headers: merged_headers, params:, body:)
+
+      parse(self, **JSON.parse(response.body))
+    end
+
+    def put; end
+
+    def delete; end
+
+    private
+
+    def error_class(status)
+      case status
+      when 404
+        ActiveJobject::Request::NotFound
+      when 500
+        ActiveJobject::Request::ServerError
+      else
+        ActiveJobject::Request::Error
+      end
+    end
+  end
+end

data/lib/active_jobject/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveJobject
+  VERSION = '0.1.1'
+end

data/lib/active_jobject.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/http'
+
+module ActiveJobject
+  class Error < StandardError; end
+end
+
+require_relative 'active_jobject/version'
+
+require_relative 'active_jobject/collection'
+require_relative 'active_jobject/parser'
+
+require_relative 'active_jobject/request'
+require_relative 'active_jobject/request/engine/base'
+require_relative 'active_jobject/request/engine/net_http'
+require_relative 'active_jobject/request/engine/oauth2'
+require_relative 'active_jobject/request/error'
+
+require_relative 'active_jobject/base'

data/sig/active_jobject.rbs

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

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: active_jobject
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Guilherme Theodoro
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: This gem encapsulates and allows for multi-engine or multi-gem HTTP requests
+  that requests and respond in JSON.
+email:
+- gtheodoro@rescocompany.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".solargraph.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/active_jobject.rb
+- lib/active_jobject/base.rb
+- lib/active_jobject/collection.rb
+- lib/active_jobject/parser.rb
+- lib/active_jobject/request.rb
+- lib/active_jobject/request/engine/base.rb
+- lib/active_jobject/request/engine/net_http.rb
+- lib/active_jobject/request/engine/oauth2.rb
+- lib/active_jobject/request/error.rb
+- lib/active_jobject/version.rb
+- sig/active_jobject.rbs
+homepage: https://rescocompany.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://rescocompany.com
+  source_code_uri: https://github.com/RESCO-Company/active_jobject
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: HTTP Engine Object Wrapper
+test_files: []