rails_cosmos 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0b2487f268d14411c8840336b894b2f8b4766783b9aab845363f9ed5199215d8
+  data.tar.gz: bdc8fb1c4828e1281ce99a8c4429186695252da238a72631d806c2e8e18b8a53
+SHA512:
+  metadata.gz: 0d7d0a4bfa5dcb3f88dd10d3ecb6e7b2e1b20a9d05c1aa85b0d4718b3404476f5d25d9d25b87e76b7ca7b2f7cb543ab0728e616c487a1a794f2ae5c4f2078576
+  data.tar.gz: d58d30397ba9cecb821c48ab41628a34a2896da1579aac03c69c81931d65a36a0f3821f14208cc08e9ef246e3d54fdb211695d46f65c965ce887c880d39970eb

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--order rand
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+  SuggestExtensions: false
+
+  Exclude:
+    - 'spec/**/*.rb'
+    - 'rails_cosmos.gemspec'
+    - 'vendor/**/*'
+    - 'bin/*'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/AbcSize:
+  Max: 20
+
+Layout/LineLength:
+  Max: 170
+
+Metrics/ParameterLists:
+  Max: 8

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-09-30
+
+- 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 Diogo de Lima
+
+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,156 @@
+# RailsCosmos
+
+![Gem Version](https://img.shields.io/gem/v/rails_cosmos.svg)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/diligasi/rails_cosmos/main.yml)
+![GitHub top language](https://img.shields.io/github/languages/top/diligasi/rails_cosmos)
+![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/diligasi/rails_cosmos)
+[![License](https://img.shields.io/github/license/diligasi/rails_cosmos.svg)](https://github.com/diligasi/rails_cosmos/blob/main/LICENSE)
+
+`rails_cosmos` is a Ruby on Rails gem designed to streamline and promote the use of the COSMOS architecture (Controller, Operation, Service, Model, and Serializer) in Rails projects. This gem provides a set of generators and utilities that assist in setting up and maintaining the architecture, making it easier to follow clean, maintainable, and scalable design patterns.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+    - [Generators](#generators)
+        - [Operation Generator](#operation-generator)
+    - [Testing Framework Support](#testing-framework-support)
+- [Architecture Overview](#architecture-overview)
+    - [COSMOS in Rails](#cosmos-in-rails)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+Add the gem to your `Gemfile`:
+
+```ruby
+gem 'rails_cosmos'
+```
+
+Then, run:
+
+```bash
+bundle install
+```
+
+After installing, you can run the install generator to set up base files for COSMOS:
+
+```bash
+rails generate rails_cosmos:install
+```
+
+This will generate the necessary base files, including the `ApplicationOperation` class, which serves as the foundation for your operations.
+
+## Usage
+
+### Generators
+
+The core functionality of `rails_cosmos` revolves around its generators. These generators help to quickly scaffold various parts of your COSMOS architecture.
+
+#### Operation Generator
+
+You can create a new operation by running:
+
+```bash
+rails generate rails_cosmos:operation OPERATION_NAME [NAMESPACE]
+```
+
+- **OPERATION_NAME**: The name of the operation you want to create.
+- **NAMESPACE** (optional): If you want the operation to be placed under a namespace (e.g., `User`, `Admin`), you can specify it here.
+
+For example, if you want to create a `CreateUser` operation under the `Admin` namespace:
+
+```bash
+rails generate rails_cosmos:operation create_user admin
+```
+
+This will generate:
+
+- `app/operations/admin/create_user.rb`
+- A corresponding test file (RSpec or MiniTest) based on the detected testing framework.
+
+##### Operation Template
+
+Each generated operation follows a simple template that inherits from `ApplicationOperation`:
+
+```ruby
+module Admin
+  class CreateUser < ApplicationOperation
+    def initialize(log_uuid: nil)
+      super(log_uuid:)
+    end
+
+    def call
+      # Add your business logic here
+      success
+    end
+  end
+end
+```
+
+### Testing Framework Support
+
+`rails_cosmos` detects the testing framework in use (RSpec or MiniTest) and automatically generates test files for your operations:
+
+- If **RSpec** is detected, test files will be generated under the `spec/operations` directory.
+- If **MiniTest** is detected, test files will be generated under the `test/operations` directory.
+- If neither is detected, test generation is skipped with a warning.
+
+## Architecture Overview
+
+### COSMOS in Rails
+
+The COSMOS architecture is a modular approach to organizing Rails applications. It separates concerns into five key components:
+
+1. **Controller**: Responsible for handling HTTP requests and routing them to the appropriate operation or service.
+2. **Operation**: Contains the core business logic. This is the entry point for any action that the system performs.
+3. **Service**: Used for interacting with external services or complex internal logic that doesn't belong in an operation.
+4. **Model**: Represents the database entities, typically the ActiveRecord models.
+5. **Serializer**: Transforms the model data into the desired JSON or XML format for API responses.
+
+By using this architecture, you can achieve a clean, maintainable, and scalable codebase. Each part of the system has a clear responsibility, promoting SOLID principles and testability.
+
+### ApplicationOperation
+
+At the core of the `rails_cosmos` gem is the `ApplicationOperation`, which serves as the base class for all operations. This class provides common functionality, such as logging, error handling, and success/failure result tracking.
+
+You can customize and extend `ApplicationOperation` to suit your project’s needs.
+
+## Contributing
+
+We welcome contributions to the `rails_cosmos` gem!
+
+To contribute:
+
+1. Fork the repository.
+2. Create a new feature branch.
+3. Make your changes and add tests where necessary.
+4. Ensure all tests pass.
+5. Submit a pull request with a detailed explanation of your changes.
+
+Make sure to follow our [contribution guidelines](CONTRIBUTING.md) (placeholder).
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/diligasi/rails_cosmos.
+
+### Running Tests
+
+To run the test suite:
+
+```bash
+bundle exec rspec
+```
+
+Or, if you're using MiniTest:
+
+```bash
+bundle exec rake test
+```
+
+## Code of Conduct
+
+Everyone interacting in the RailsCosmos project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/diligasi/rails_cosmos/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+`rails_cosmos` is open-source software licensed under 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/generators/rails_cosmos/install_generator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module RailsCosmos
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base # :nodoc:
+      source_root File.expand_path("../templates", __dir__)
+
+      def create_operation_base
+        operations_dir = "app/operations"
+
+        empty_directory(operations_dir) unless Dir.exist?(operations_dir)
+
+        template "application_operation.rb", "#{operations_dir}/application_operation.rb",
+                 force: file_exists_prompt("#{operations_dir}/application_operation.rb")
+      end
+
+      private
+
+      def file_exists_prompt(file)
+        return true unless File.exist?(file)
+
+        yes?("File #{file} already exists. Do you want to overwrite it?")
+      end
+    end
+  end
+end

data/lib/generators/rails_cosmos/operation_generator.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "rails/generators/named_base"
+
+module RailsCosmos
+  module Generators
+    # This generator creates a new operation class within the `app/operations` directory.
+    # Optionally, you can specify a namespace, and it will create a subdirectory based on that namespace.
+    #
+    # Example usage:
+    #
+    #   rails generate operation NAME NAMESPACE
+    #
+    # If a namespace is provided, the generated operation will be placed inside a folder corresponding to
+    # the namespace within `app/operations`. If no namespace is provided, the operation will be created
+    # directly within the `app/operations` directory.
+    #
+    # This generator also creates a test file for the operation. If RSpec is detected, the test will be
+    # placed under `spec/operations`, and if MiniTest is detected, it will be placed under `test/operations`.
+    # If neither test framework is detected, the test generation will be skipped with a warning.
+    #
+    # Arguments:
+    #   NAME        - The name of the operation (required).
+    #   NAMESPACE   - The namespace for the operation (optional).
+    #
+    # Example:
+    #
+    #   rails generate rails_cosmos:operation create_user admin
+    #
+    # This will generate:
+    #
+    #   app/operations/admin/create_user.rb
+    #   spec/operations/admin/create_user_spec.rb (if RSpec is used)
+    #   or
+    #   test/operations/admin/create_user_test.rb (if MiniTest is used)
+    #
+    class OperationGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __dir__)
+
+      argument :namespace, type: :string, optional: true, desc: "Optional namespace for the operation"
+
+      def create_operation_file
+        operation_directory = operation_directory_path
+        operation_file = "#{operation_directory}/#{file_name}.rb"
+
+        empty_directory operation_directory
+        template "operation_template.rb.tt", operation_file
+      end
+
+      def create_test_file
+        if rspec_installed?
+          create_rspec_test_file
+        elsif minitest_installed?
+          create_minitest_test_file
+        else
+          say_status("warning", "No supported test framework found. Skipping test file generation.", :yellow)
+        end
+      end
+
+      private
+
+      def file_name
+        name.underscore
+      end
+
+      def operation_directory_path
+        namespace ? File.join("app/operations", namespace.underscore) : "app/operations"
+      end
+
+      def test_directory_path
+        if namespace
+          namespace_dir = namespace.underscore
+          rspec_installed? ? File.join("spec/operations", namespace_dir) : File.join("test/operations", namespace_dir)
+        else
+          rspec_installed? ? "spec/operations" : "test/operations"
+        end
+      end
+
+      def rspec_installed?
+        File.exist?(File.join(destination_root, "spec/spec_helper.rb"))
+      end
+
+      def minitest_installed?
+        File.exist?(File.join(destination_root, "test/test_helper.rb"))
+      end
+
+      def create_rspec_test_file
+        empty_directory test_directory_path
+        template "rspec_operation_test.rb.tt", File.join(test_directory_path, "#{file_name}_spec.rb")
+      end
+
+      def create_minitest_test_file
+        empty_directory test_directory_path
+        template "minitest_operation_test.rb.tt", File.join(test_directory_path, "#{file_name}_test.rb")
+      end
+    end
+  end
+end

data/lib/generators/templates/application_operation.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+# Base class for operation objects that provides a standard interface and error handling.
+# Operation objects should inherit from this class and implement their own logic in the `call` method.
+#
+# Example usage:
+#   # Defining a successful operation
+#   class MySuccessOperation < ApplicationOperation
+#     def initialize(some_param, log_uuid: nil)
+#       super(log_uuid: log_uuid)
+#       @some_param = some_param
+#     end
+#
+#     def call
+#       # Custom operation logic that succeeds
+#       success('Operation successful!', additional_info: 'Processed correctly')
+#     end
+#   end
+#
+#   # Defining a failing operation
+#   class MyFailingOperation < ApplicationOperation
+#     def initialize(some_param, log_uuid: nil)
+#       super(log_uuid: log_uuid)
+#       @some_param = some_param
+#     end
+#
+#     def call
+#       # Custom operation logic that fails
+#       raise StandardError, 'Something went wrong!'
+#     end
+#   end
+#
+# Success example:
+#   result = MySuccessOperation.call(some_param)
+#   => [true, 'Operation successful!', additional_info: 'Processed correctly']
+#
+# Failure example:
+#   result = MyFailingOperation.call(some_param)
+#   => [false, #<StandardError: Something went wrong!>]
+#
+class ApplicationOperation
+  # Entry point for the operation object. Initializes the object and calls the `call_with_rescue` method.
+  #
+  # @param args [Array] Positional arguments to be passed to the initializer.
+  # @param kwargs [Hash] Keyword arguments to be passed to the initializer.
+  #
+  # @return [Array] A standardized result array where the first element is a boolean indicating success,
+  #                 the second element is either nil or the error object, and additional elements contain extra data.
+  def self.call(*args, **kwargs)
+    new(*args, **kwargs).call_with_rescue
+  end
+
+  # Initializes the operation object with an optional log_uuid.
+  # If no log_uuid is provided, a new UUID is generated automatically.
+  #
+  # @param log_uuid [String, nil] An optional UUID to associate with the operation.
+  # If not provided, a new UUID is generated.
+  def initialize(log_uuid: nil)
+    self.log_uuid = log_uuid || SecureRandom.uuid
+  end
+
+  # Standardized method to invoke the operation object with exception handling.
+  # Captures any unexpected errors and returns a standardized failure response.
+  #
+  # @return [Array] A standardized result array where the first element is a boolean indicating success,
+  #                 the second element is either nil or the error object, and additional elements contain extra data.
+  def call_with_rescue
+    log_start
+    result = call
+    log_success
+    result
+  rescue StandardError => e
+    log_failure(e)
+    handle_unexpected_error(e)
+  end
+
+  # The core logic of the operation object should be implemented in this method by the subclass.
+  # This method must be overridden in any subclass that inherits from ApplicationOperation.
+  #
+  # @raise [NotImplementedError] If the method is not overridden by a subclass.
+  def call
+    raise NotImplementedError, "Subclasses must implement the call method"
+  end
+
+  protected
+
+  # Returns a standardized success response.
+  # The first element of the response is `true`, followed by any additional data provided.
+  #
+  # @param additional_data [Array] Extra data to be included in the success response.
+  #
+  # @return [Array] An array with `true` as the first element and optional additional data.
+  def success(*additional_data)
+    [true, *additional_data]
+  end
+
+  # Returns a standardized failure response.
+  # The first element of the response is `false`, followed by the error and any additional data provided.
+  #
+  # @param error [Exception] The error object that caused the failure.
+  # @param additional_data [Array] Extra data to be included in the failure response.
+  #
+  # @return [Array] An array with `false` as the first element, the error object as the second element,
+  #                 and optional additional data.
+  def failure(error, *additional_data)
+    [false, error, *additional_data]
+  end
+
+  private
+
+  # Retrieves the log_uuid associated with the current thread.
+  # This ensures thread-safe access to the UUID used for logging.
+  #
+  # @return [String] The UUID associated with the current thread.
+  def log_uuid
+    Thread.current[:log_uuid]
+  end
+
+  # Sets the log_uuid for the current thread.
+  # This ensures that each thread has its own UUID for logging purposes, providing thread-safe storage.
+  #
+  # @param value [String] The UUID to be assigned to the current thread.
+  def log_uuid=(value)
+    Thread.current[:log_uuid] = value
+  end
+
+  # Returns the start time of the operation. If not already set, it initializes the start time to the current time.
+  # This is useful for tracking the duration of the operation.
+  #
+  # @return [DateTime] The start time of the operation.
+  def start_time
+    Thread.current[:start_time] ||= Time.zone.now
+  end
+
+  # Logs the start of the operation.
+  def log_start
+    Rails.logger.info "[#{self.class.name} - #{log_uuid}] Started at #{start_time.strftime("%Y-%m-%d %H:%M:%S")}"
+  end
+
+  # Logs the successful completion of the operation, including its duration.
+  def log_success
+    end_time = Time.zone.now
+    converted_time = end_time.strftime("%Y-%m-%d %H:%M:%S")
+    duration = end_time - start_time
+    Rails.logger.info "[#{self.class.name} - #{log_uuid}] Completed at #{converted_time}. Duration: #{duration} seconds"
+  end
+
+  # Logs a failure, including the error message and stack trace.
+  #
+  # @param error [StandardError] The error object that was raised.
+  def log_failure(error)
+    Rails.logger.error "[#{self.class.name} - #{log_uuid}] Failed with error: #{error.message}"
+  end
+
+  # Handles unexpected errors by returning a standardized failure response. This method is
+  # automatically called by `call_with_rescue` when an unexpected exception occurs.
+  #
+  # @param error [StandardError] The error object that was raised unexpectedly.
+  #
+  # @return [Array] A standardized failure response array with `false` as the first element,
+  #                 and the error object as the second element.
+  def handle_unexpected_error(error)
+    [false, error]
+  end
+end

data/lib/generators/templates/minitest_operation_test.rb.tt

@@ -0,0 +1,14 @@
+require "test_helper"
+
+<% if namespace -%>
+class <%= namespace.camelcase %>::<%= file_name.camelcase %>Test < ActiveSupport::TestCase
+  test "executes call successfully" do
+    result = <%= namespace.camelcase %>::<%= file_name.camelcase %>.call
+<% else -%>
+class <%= file_name.camelcase %>Test < ActiveSupport::TestCase
+  test "executes call successfully" do
+    result = <%= file_name.camelcase %>.call
+<% end -%>
+    assert result.first
+  end
+end

data/lib/generators/templates/operation_template.rb.tt

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+<% if namespace -%>
+module <%= namespace.camelcase %>
+  class <%= file_name.camelcase %> < ApplicationOperation
+    def initialize(log_uuid: nil)
+      super(log_uuid:)
+    end
+
+    def call
+      # Add your business logic here, if necessary
+      # adding additional methods, we encourage the
+      # use of private functions below
+
+      success(self)
+    end
+  end
+end
+<% else -%>
+class <%= file_name.camelcase %> < ApplicationOperation
+  def initialize(log_uuid: nil)
+    super(log_uuid:)
+  end
+
+  def call
+    # Add your business logic here, if necessary
+    # adding additional methods, we encourage the
+    # use of private functions below
+
+    success(self)
+  end
+end
+<% end -%>

data/lib/generators/templates/rspec_operation_test.rb.tt

@@ -0,0 +1,12 @@
+require "rails_helper"
+
+<% if namespace -%>
+RSpec.describe <%= namespace.camelcase %>::<%= file_name.camelcase %>, type: :operation do
+<% else -%>
+RSpec.describe <%= file_name.camelcase %>, type: :operation do
+<% end -%>
+  it "executes call successfully" do
+    result = described_class.call
+    expect(result.first).to be_truthy
+  end
+end

data/lib/rails_cosmos/http/client.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday_middleware"
+
+module RailsCosmos
+  module Http
+    # RailsCosmos::Http::Client
+    #
+    # A wrapper around Faraday for making HTTP requests with enhanced logging and
+    # error handling. This class provides a simple interface for sending requests
+    # to external APIs and logging request/response details for observability.
+    #
+    # @example Creating a client instance
+    #   client = RailsCosmos::Http::Client.new(
+    #     url: "https://api.example.com",
+    #     service: "ExampleService",
+    #     adapter: :typhoeus
+    #   )
+    #
+    # @example Making a GET request
+    #   response = client.get("/endpoint", headers: { "Authorization" => "Bearer token" })
+    #
+    # @example Making a POST request with a payload
+    #   response = client.post(
+    #     "/endpoint",
+    #     payload: { key: "value" },
+    #     headers: { "Content-Type" => "application/json" }
+    #   )
+    #
+    # @attr_reader [String] url The base URL for the HTTP client.
+    # @attr_reader [String] service The name of the service for logging purposes.
+    # @attr_reader [Symbol] adapter The Faraday adapter to use for making requests.
+    class Client
+      def initialize(url:, service:, adapter: :typhoeus)
+        @url = url
+        @service = service
+        @adapter = adapter
+        @conn = build_connection
+      end
+
+      def request(method, endpoint, payload: {}, headers: {})
+        start_at = Time.zone.now
+        response = @conn.send(method, endpoint) do |req|
+          req.headers = headers
+          req.body = payload.to_json if %i[post put patch delete].include?(method)
+          log_request(method: method, url: req.path, headers: headers, payload: payload)
+        end
+
+        response_time = Time.zone.now - start_at
+
+        log_response(
+          method: method, success: response.success?,
+          time: response_time, status: response.status, url: endpoint,
+          headers: response.headers, body: response.body
+        )
+
+        Response.new(response)
+      end
+
+      # Shorthand methods
+      %i[get post put patch delete].each do |http_method|
+        define_method(http_method) do |endpoint, payload: {}, headers: {}|
+          request(http_method, endpoint, payload: payload, headers: headers)
+        end
+      end
+
+      private
+
+      def build_connection
+        Faraday.new(url: @url) do |conn|
+          conn.request :json
+          conn.response :json, content_type: /\bjson$/
+          conn.use FaradayMiddleware::FollowRedirects, limit: 5
+          conn.adapter @adapter
+        end
+      end
+
+      def log_request(method:, url:, headers:, payload:)
+        Rails.logger.info "HTTP Request | #{@service} -- method=#{method} url=#{url} headers=#{headers} payload=#{filter_sensitive_data(payload)}"
+      end
+
+      def log_response(success:, time:, status:, method:, url:, headers:, body:)
+        Rails.logger.info "HTTP Response | #{@service} -- success=#{success} status=#{status} time=#{time} method=#{method} url=#{url} headers=#{headers} body=#{body}"
+      end
+
+      def filter_sensitive_data(payload)
+        return payload unless payload.is_a?(Hash)
+
+        payload.each_with_object({}) do |(key, value), result|
+          result[key] = if value.is_a?(Hash)
+                          filter_sensitive_data(value)
+                        elsif Rails.application.config.filter_parameters.include?(key)
+                          "[FILTERED]"
+                        else
+                          value
+                        end
+        end
+      end
+    end
+  end
+end

data/lib/rails_cosmos/http/response.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RailsCosmos
+  module Http
+    # RailsCosmos::Http::Response
+    #
+    # A wrapper around HTTP responses to provide a consistent interface for handling
+    # API responses. This class parses JSON responses and provides helper methods to
+    # check response success.
+    #
+    # @example Creating a response instance
+    #   response = RailsCosmos::Http::Response.new(faraday_response)
+    #
+    # @example Accessing response attributes
+    #   response.status # => 200
+    #   response.body   # => { "key" => "value" }
+    #   response.success? # => true
+    #
+    # @attr_reader [Hash] body The parsed response body as a Hash.
+    # @attr_reader [Integer] status The HTTP status code.
+    # @attr_reader [String, nil] raw_body The raw response body as a string, or nil if absent.
+    class Response
+      attr_reader :body, :status, :raw_body
+
+      def initialize(response)
+        @raw_body = response.body.present? ? response.body : {}
+        @body = response.body.present? ? JSON.parse(response.body) : {}
+        @status = response.status
+      end
+
+      def success?
+        (200..299).include?(status)
+      end
+    end
+  end
+end

data/lib/rails_cosmos/version.rb

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

data/lib/rails_cosmos.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "rails_cosmos/version"
+require_relative "rails_cosmos/http/client"
+require_relative "rails_cosmos/http/response"
+require_relative "generators/rails_cosmos/install_generator"
+require_relative "generators/rails_cosmos/operation_generator"
+
+module RailsCosmos
+  class Error < StandardError; end
+end
+
+Http = RailsCosmos::Http

data/sig/rails_cosmos/http/response.rbs

@@ -0,0 +1,12 @@
+module RailsCosmos
+  module Http
+    class Response
+      attr_reader body: Hash[untyped, untyped]
+      attr_reader status: Integer
+      attr_reader raw_body: untyped
+
+      def initialize: (response: untyped) -> void
+      def success?: () -> bool
+    end
+  end
+end

data/sig/rails_cosmos.rbs

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

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: rails_cosmos
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Diogo de Lima
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.4
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+description: COSMOS provides a clean and organized structure for API-driven applications,
+  implementing Controllers, Operations, Services, Models, and Serializers.
+email:
+- diligasi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/rails_cosmos/install_generator.rb
+- lib/generators/rails_cosmos/operation_generator.rb
+- lib/generators/templates/application_operation.rb
+- lib/generators/templates/minitest_operation_test.rb.tt
+- lib/generators/templates/operation_template.rb.tt
+- lib/generators/templates/rspec_operation_test.rb.tt
+- lib/rails_cosmos.rb
+- lib/rails_cosmos/http/client.rb
+- lib/rails_cosmos/http/response.rb
+- lib/rails_cosmos/version.rb
+- sig/rails_cosmos.rbs
+- sig/rails_cosmos/http/response.rbs
+homepage: https://rubygems.org/gems/rails_cosmos
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/rails_cosmos
+  source_code_uri: https://github.com/diligasi/rails_cosmos
+  changelog_uri: https://github.com/diligasi/rails_cosmos/blob/main/CHANGELOG.md
+post_install_message: "\n### Setting up RailsCosmos ###\n\nThank you for installing
+  RailsCosmos! \U0001F680\n\nTo start using the COSMOS architecture in your Rails
+  project, you'll need to run the setup generator. \nThis will create the base structure
+  for your operations and services, setting up everything you need to follow the COSMOS
+  pattern.\n\nRun `bin/rails g rails_cosmos:install` to initialize the COSMOS architecture
+  in your app.\n\nFor more details on how to use and customize RailsCosmos, please
+  refer to the documentation: https://github.com/diligasi/rails_cosmos\nYou can also
+  check out the CHANGELOG for recent updates: https://github.com/diligasi/rails_cosmos/blob/main/CHANGELOG.md\n\nHappy
+  coding with COSMOS! ✨\n\n"
+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.16
+signing_key: 
+specification_version: 4
+summary: A gem for the COSMOS architecture
+test_files: []