wrappix 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f997a7533767b633f14e75e8af8e148d44cd109bfe9f388afe311ab17fe67c21
+  data.tar.gz: e593de626494696212257302c423f8b5fb144d36ab1396f353e94c33774e802d
+SHA512:
+  metadata.gz: ebdedd2da469565ab2ce1a0d851188849f8bc18c582ba64dd00bf37291fbf4058939e410de7459037cf9f80242eeb28a2bc852b9f249f82043c030a7cf1d5036
+  data.tar.gz: cc2fec8bad1f78a50f5af11722d00cadbd475d2c797b62aad3c5020c8f3b6655b4433d109be84444f9b93cce272d665f25f2a12f1254a1b856c4ebe8ea11d8e2

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-03-20
+
+- 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) 2025 Bruno Costanzo
+
+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,216 @@
+# Wrappix
+
+Wrappix is a code generator that creates Ruby API client libraries from a YAML configuration file. It helps you build structured wrappers for REST APIs with minimal effort.
+
+## Features
+
+- **Complete code generation**: Creates all classes and methods needed to interact with a REST API
+- **Configurable**: Define resources, endpoints, and parameters in a simple YAML file
+- **Multiple authentication types**: Supports OAuth, Basic Authentication, and API Keys
+- **Automatic documentation**: Generates README with usage examples and detailed API reference
+- **Error handling**: Integrated HTTP error management with detailed error objects
+- **Smart object mapping**: Converts JSON responses into Ruby objects with nested attribute access
+- **Built-in caching**: Optional caching system for authentication tokens
+- **Elegant interface**: Fluent API inspired by Ruby best practices
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'wrappix'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install wrappix
+```
+
+## Usage
+
+Wrappix can be used in two primary ways:
+
+1. Generate a standalone API wrapper gem
+2. Create an API client within an existing project
+
+### Quick Start
+
+#### 1. Create a YAML configuration file
+
+```yaml
+# github_api.yml
+api_name: github-api
+base_url: https://api.github.com
+auth_type: oauth
+token_url: https://github.com/login/oauth/access_token
+
+resources:
+  users:
+    endpoints:
+      - name: get
+        method: get
+        path: users/{username}
+      - name: list
+        method: get
+        path: users
+        params: true
+
+  repos:
+    endpoints:
+      - name: list
+        method: get
+        path: repos
+        params: true
+      - name: get
+        method: get
+        path: repos/{owner}/{repo}
+      - name: create
+        method: post
+        path: user/repos
+```
+
+#### 2. Generate the API client
+
+```bash
+$ wrappix build github_api.yml
+```
+
+#### 3. Use your generated API client
+
+```ruby
+require 'github_api'  # Note: require with underscore!
+
+# Configure the client
+GithubApi.configure do |config|
+  config.client_id = "your_client_id"
+  config.client_secret = "your_client_secret"
+  config.access_token = "your_access_token"
+end
+
+# Initialize the client
+client = GithubApi.client
+
+# Get a user
+user = client.users.get("octocat")
+puts user.name
+puts user.location
+puts user.public_repos
+
+# List repositories with pagination
+repos = client.repos.list({page: 1, per_page: 10})
+repos.data.each do |repo|
+  puts "#{repo.name}: #{repo.description}"
+end
+
+# Check if there are more pages
+if repos.next_href
+  puts "More repositories available"
+end
+```
+
+## Configuration Reference
+
+The YAML configuration file supports the following options:
+
+### Global Options
+
+| Option | Description | Required | Default |
+|--------|-------------|----------|---------|
+| `api_name` | Name of the API wrapper (used for file/module naming) | Yes | |
+| `base_url` | Base URL of the API | Yes | |
+| `auth_type` | Authentication type: `oauth`, `basic`, or `api_key` | No | None |
+| `response_format` | Configuration for response mapping (see below) | No | Auto-detect |
+
+### Authentication Options
+
+#### OAuth
+
+```yaml
+auth_type: oauth
+token_url: https://example.com/oauth/token
+```
+
+#### Basic Authentication
+
+```yaml
+auth_type: basic
+```
+
+#### API Key
+
+```yaml
+auth_type: api_key
+api_key_header: X-API-Key  # Custom header name (optional)
+```
+
+### Resources and Endpoints
+
+Resources define the API endpoints that will be available in your client:
+
+```yaml
+resources:
+  users:  # Resource name
+    endpoints:
+      - name: get            # Method name in your code
+        method: get          # HTTP method (get, post, put, patch, delete)
+        path: users/{id}     # Path with parameters in braces
+        params: true         # Whether it accepts query parameters (optional)
+        collection: false    # Whether it returns a collection (optional)
+
+      - name: list
+        method: get
+        path: users
+        params: true
+        collection: true     # Processes response as a collection
+```
+
+### Response Format Configuration
+
+You can configure how responses are mapped to objects:
+
+```yaml
+response_format:
+  collection_root: "data"    # JSON key containing the collection items
+  item_root: "user"          # JSON key containing single items (optional)
+  pagination:
+    next_page_key: "next_href"   # JSON key with URL to next page
+    total_count_key: "total"     # JSON key with total count
+    limit_key: "limit"           # JSON key with page size
+```
+
+## Generated Client Architecture
+
+The generated client follows a clean architecture pattern:
+
+- `Client`: Main entry point to the API
+- `Resources`: Classes for each resource (users, repos, etc.)
+- `Request`: Handles HTTP communication
+- `Object`: Maps JSON responses to Ruby objects
+- `Collection`: Handles collections of objects with pagination
+- `Error`: Standardized error handling
+- `Configuration`: Global configuration
+
+## Customization
+
+After generating your API client, you can further customize it by editing the generated files.
+
+## Contributing
+
+Contributions are welcome:
+
+1. Fork the project
+2. Create your feature branch (`git checkout -b feature/amazing`)
+3. Commit your changes (`git commit -am 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing`)
+5. Open a Pull Request
+
+## 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 "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/wrappix

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "wrappix"
+require "wrappix/cli"
+
+Wrappix::CLI.start(ARGV)

data/lib/wrappix/builder.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "fileutils"
+require_relative "templates/configuration"
+require_relative "templates/client"
+require_relative "templates/request"
+require_relative "templates/error"
+require_relative "templates/resource"
+require_relative "templates/main"
+require_relative "templates/readme"
+require_relative "templates/cache"
+require_relative "templates/collection"
+require_relative "templates/object"
+require_relative "templates/documentation"
+require_relative "templates/tests"
+
+module Wrappix
+  class Builder
+    attr_reader :file_paths
+
+    def initialize(config_file)
+      raise Errno::ENOENT, "No such file or directory - #{config_file}" unless File.exist?(config_file)
+
+      @config = YAML.load_file(config_file)
+      @api_name = @config["api_name"] || File.basename(Dir.pwd)
+      @normalized_api_name = @api_name.tr("-", "_")
+      @module_name = @api_name.split("-").map(&:capitalize).join
+      @file_paths = {}
+    end
+
+    def build
+      process_response_format
+      create_version_file
+      create_base_files
+      create_resource_files
+      create_readme
+      create_documentation
+      create_test_files
+      create_gemspec
+      create_compatibility_file
+      true
+    rescue Psych::SyntaxError => e
+      puts "Error de sintaxis en el archivo YAML: #{e.message}"
+      false
+    rescue StandardError => e
+      puts "Error durante la construcción: #{e.message}"
+      puts e.backtrace
+      false
+    end
+
+    private
+
+    def create_version_file
+      create_file("lib/#{@normalized_api_name}/version.rb", <<~RUBY)
+        # frozen_string_literal: true
+
+        module #{@module_name}
+          VERSION = "0.1.0"
+        end
+      RUBY
+    end
+
+    def process_response_format
+      # Asegurarse de que existe una configuración global de formato de respuesta
+      @config["response_format"] ||= {
+        "collection_root" => "data",
+        "pagination" => {
+          "next_page_key" => "next_href",
+          "total_count_key" => "total",
+          "limit_key" => "limit"
+        }
+      }
+
+      # Para cada recurso, establecer valores predeterminados si no están definidos
+      resources = @config["resources"] || {}
+      resources.each_value do |resource_config|
+        resource_config["response_format"] ||= {}
+      end
+    end
+
+    def create_base_files
+      create_file("lib/#{@normalized_api_name}/configuration.rb",
+                  Templates::Configuration.render(@module_name, @config))
+      create_file("lib/#{@normalized_api_name}/client.rb", Templates::Client.render(@module_name, @config))
+      create_file("lib/#{@normalized_api_name}/request.rb", Templates::Request.render(@module_name, @config))
+      create_file("lib/#{@normalized_api_name}/error.rb", Templates::Error.render(@module_name, @config))
+      create_file("lib/#{@normalized_api_name}/cache.rb", Templates::Cache.render(@module_name, @config))
+      create_file("lib/#{@normalized_api_name}/object.rb", Templates::Object.render(@module_name, @config))
+      create_file("lib/#{@normalized_api_name}/collection.rb", Templates::Collection.render(@module_name, @config))
+      update_main_file
+    end
+
+    def create_test_files
+      FileUtils.mkdir_p("test")
+
+      # Crear un archivo test_helper.rb básico
+      create_file("test/test_helper.rb", <<~RUBY)
+        require "minitest/autorun"
+        require "faraday"
+        require "json"
+
+        $LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+        require "#{@normalized_api_name}"
+
+        # Configuración global para las pruebas
+        #{@module_name}.configure do |config|
+          config.base_url = "https://api.example.com"
+          # Otras configuraciones necesarias
+        end
+      RUBY
+
+      # Crear el archivo de tests principal con nombre normalizado
+      create_file(
+        "test/#{@normalized_api_name}_test.rb",
+        Templates::Tests.render(@api_name, @module_name, @config)
+      )
+    end
+
+    def create_gemspec
+      create_file("#{@api_name}.gemspec", <<~RUBY)
+        # frozen_string_literal: true
+
+        require_relative "lib/#{@normalized_api_name}/version"
+
+        Gem::Specification.new do |spec|
+          spec.name          = "#{@api_name}"
+          spec.version       = #{@module_name}::VERSION
+          spec.authors       = ["Generated by Wrappix"]
+          spec.email         = ["info@example.com"]
+
+          spec.summary       = "API wrapper for #{@api_name}"
+          spec.description   = "A Ruby client for the #{@api_name} API"
+          spec.homepage      = "https://github.com/example/#{@api_name}"
+          spec.license       = "MIT"
+          spec.required_ruby_version = ">= 2.6.0"
+
+          spec.metadata["homepage_uri"] = spec.homepage
+
+          # Specify which files should be added to the gem when it is released.
+          spec.files = Dir["lib/**/*", "LICENSE.txt", "README.md"]
+
+          spec.add_dependency "faraday", "~> 2.0"
+          spec.add_dependency "faraday_middleware", "~> 1.2"
+          spec.add_dependency "ostruct", "~> 0.5"
+
+          spec.add_development_dependency "minitest", "~> 5.0"
+          spec.add_development_dependency "rake", "~> 13.0"
+        end
+      RUBY
+    end
+
+    def create_resource_files
+      FileUtils.mkdir_p("lib/#{@normalized_api_name}/resources")
+
+      resources = @config["resources"] || {}
+      resources.each do |resource_name, resource_config|
+        create_file(
+          "lib/#{@normalized_api_name}/resources/#{resource_name}.rb",
+          Templates::Resource.render(@module_name, resource_name, resource_config)
+        )
+      end
+    end
+
+    def update_main_file
+      main_file = "lib/#{@normalized_api_name}.rb"
+      content = Templates::Main.render(@normalized_api_name, @module_name, @config)
+      create_file(main_file, content)
+    end
+
+    def create_compatibility_file
+      # Crear un archivo de compatibilidad con el nombre original (si es diferente)
+      return unless @api_name != @normalized_api_name
+
+      compat_file = "lib/#{@api_name}.rb"
+      content = <<~RUBY
+        # frozen_string_literal: true
+
+        # Archivo de compatibilidad - redirige al archivo normalizado
+        require_relative "#{@normalized_api_name}"
+      RUBY
+      create_file(compat_file, content)
+    end
+
+    def create_file(path, content)
+      FileUtils.mkdir_p(File.dirname(path))
+
+      File.open(path, "w") do |file|
+        file.write(content)
+      end
+
+      @file_paths[path] = true
+      puts "File created: #{path}"
+
+      true
+    end
+
+    def create_readme
+      create_file("README.md", Templates::Readme.render(@api_name, @module_name, @config))
+    end
+
+    def create_documentation
+      FileUtils.mkdir_p("docs")
+      create_file("docs/api.md", Templates::Documentation.render(@api_name, @module_name, @config))
+    end
+  end
+end

data/lib/wrappix/cli.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "../wrappix"
+require "thor"
+
+module Wrappix
+  class CLI < Thor
+    desc "build CONFIG_FILE", "Genera archivos del wrapper basados en CONFIG_FILE"
+    def build(config_file)
+      unless File.exist?(config_file)
+        say "Error: El archivo de configuración no existe", :red
+        exit(1)
+      end
+
+      if Wrappix.build(config_file)
+        say "Wrapper generado correctamente", :green
+        true
+      else
+        say "Error al generar el wrapper", :red
+        false
+      end
+    end
+  end
+end

data/lib/wrappix/client.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday_middleware"
+
+module Wrappix
+  class Client
+    def initialize(config = Wrappix.configuration)
+      @config = config
+      @connection = build_connection
+      setup_resources
+    end
+
+    private
+
+    def build_connection
+      Faraday.new(url: @config.base_url) do |conn|
+        conn.headers = @config.headers
+        conn.request :json
+        conn.response :json, content_type: /\bjson$/
+        conn.adapter Faraday.default_adapter
+      end
+    end
+
+    def setup_resources
+      @config.resources.each do |name, options|
+        define_resource_method(name, options)
+      end
+    end
+
+    def define_resource_method(name, options)
+      resource = Resource.new(self, name, options)
+
+      self.class.define_method(name) do
+        resource
+      end
+    end
+  end
+end