RubyGems - grape_openapi3 - Versions diffs - 0.1.0 → 0.1.1 - Mend

grape_openapi3 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (2769) hide show

data/example/rails_app/Gemfile.lock DELETED Viewed

@@ -1,310 +0,0 @@
-PATH
-  remote: ../../..
-  specs:
-    grape_openapi3 (0.1.0)
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actioncable (8.0.5)
-      actionpack (= 8.0.5)
-      activesupport (= 8.0.5)
-      nio4r (~> 2.0)
-      websocket-driver (>= 0.6.1)
-      zeitwerk (~> 2.6)
-    actionmailbox (8.0.5)
-      actionpack (= 8.0.5)
-      activejob (= 8.0.5)
-      activerecord (= 8.0.5)
-      activestorage (= 8.0.5)
-      activesupport (= 8.0.5)
-      mail (>= 2.8.0)
-    actionmailer (8.0.5)
-      actionpack (= 8.0.5)
-      actionview (= 8.0.5)
-      activejob (= 8.0.5)
-      activesupport (= 8.0.5)
-      mail (>= 2.8.0)
-      rails-dom-testing (~> 2.2)
-    actionpack (8.0.5)
-      actionview (= 8.0.5)
-      activesupport (= 8.0.5)
-      nokogiri (>= 1.8.5)
-      rack (>= 2.2.4)
-      rack-session (>= 1.0.1)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.2)
-      rails-html-sanitizer (~> 1.6)
-      useragent (~> 0.16)
-    actiontext (8.0.5)
-      actionpack (= 8.0.5)
-      activerecord (= 8.0.5)
-      activestorage (= 8.0.5)
-      activesupport (= 8.0.5)
-      globalid (>= 0.6.0)
-      nokogiri (>= 1.8.5)
-    actionview (8.0.5)
-      activesupport (= 8.0.5)
-      builder (~> 3.1)
-      erubi (~> 1.11)
-      rails-dom-testing (~> 2.2)
-      rails-html-sanitizer (~> 1.6)
-    activejob (8.0.5)
-      activesupport (= 8.0.5)
-      globalid (>= 0.3.6)
-    activemodel (8.0.5)
-      activesupport (= 8.0.5)
-    activerecord (8.0.5)
-      activemodel (= 8.0.5)
-      activesupport (= 8.0.5)
-      timeout (>= 0.4.0)
-    activestorage (8.0.5)
-      actionpack (= 8.0.5)
-      activejob (= 8.0.5)
-      activerecord (= 8.0.5)
-      activesupport (= 8.0.5)
-      marcel (~> 1.0)
-    activesupport (8.0.5)
-      base64
-      benchmark (>= 0.3)
-      bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.3.1)
-      connection_pool (>= 2.2.5)
-      drb
-      i18n (>= 1.6, < 2)
-      logger (>= 1.4.2)
-      minitest (>= 5.1)
-      securerandom (>= 0.3)
-      tzinfo (~> 2.0, >= 2.0.5)
-      uri (>= 0.13.1)
-    base64 (0.3.0)
-    benchmark (0.5.0)
-    bigdecimal (4.1.2)
-    bootsnap (1.24.6)
-      msgpack (~> 1.2)
-    brakeman (8.0.5)
-      racc
-    builder (3.3.0)
-    coderay (1.1.3)
-    concurrent-ruby (1.3.6)
-    connection_pool (3.0.2)
-    crass (1.0.6)
-    date (3.5.1)
-    debug (1.11.1)
-      irb (~> 1.10)
-      reline (>= 0.3.8)
-    drb (2.2.3)
-    dry-configurable (1.4.0)
-      dry-core (~> 1.0)
-      zeitwerk (~> 2.6)
-    dry-core (1.2.0)
-      concurrent-ruby (~> 1.0)
-      logger
-      zeitwerk (~> 2.6)
-    dry-inflector (1.3.1)
-    dry-logic (1.6.0)
-      bigdecimal
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 1.1)
-      zeitwerk (~> 2.6)
-    dry-types (1.9.1)
-      bigdecimal (>= 3.0)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 1.0)
-      dry-inflector (~> 1.0)
-      dry-logic (~> 1.4)
-      zeitwerk (~> 2.6)
-    erb (6.0.4)
-    erubi (1.13.1)
-    factory_bot (6.6.0)
-      activesupport (>= 6.1.0)
-    factory_bot_rails (6.5.1)
-      factory_bot (~> 6.5)
-      railties (>= 6.1.0)
-    faker (3.8.0)
-      i18n (>= 1.8.11, < 2)
-    globalid (1.3.0)
-      activesupport (>= 6.1)
-    grape (3.1.1)
-      activesupport (>= 7.1)
-      dry-configurable
-      dry-types (>= 1.1)
-      mustermann-grape (~> 1.1.0)
-      rack (>= 2)
-      zeitwerk
-    grape-entity (1.1.0)
-      activesupport (>= 3.0.0)
-    i18n (1.14.8)
-      concurrent-ruby (~> 1.0)
-    io-console (0.8.2)
-    irb (1.18.0)
-      pp (>= 0.6.0)
-      prism (>= 1.3.0)
-      rdoc (>= 4.0.0)
-      reline (>= 0.4.2)
-    logger (1.7.0)
-    loofah (2.25.1)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.12.0)
-    mail (2.9.0)
-      logger
-      mini_mime (>= 0.1.1)
-      net-imap
-      net-pop
-      net-smtp
-    marcel (1.2.1)
-    method_source (1.1.0)
-    mini_mime (1.1.5)
-    minitest (6.0.6)
-      drb (~> 2.0)
-      prism (~> 1.5)
-    msgpack (1.8.3)
-    mustermann (4.0.0)
-    mustermann-grape (1.1.0)
-      mustermann (>= 1.0.0)
-    net-imap (0.6.4.1)
-      date
-      net-protocol
-    net-pop (0.1.2)
-      net-protocol
-    net-protocol (0.2.2)
-      timeout
-    net-smtp (0.5.1)
-      net-protocol
-    nio4r (2.7.5)
-    nokogiri (1.19.3-aarch64-linux-gnu)
-      racc (~> 1.4)
-    nokogiri (1.19.3-aarch64-linux-musl)
-      racc (~> 1.4)
-    nokogiri (1.19.3-arm-linux-gnu)
-      racc (~> 1.4)
-    nokogiri (1.19.3-arm-linux-musl)
-      racc (~> 1.4)
-    nokogiri (1.19.3-arm64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.19.3-x86_64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.19.3-x86_64-linux-gnu)
-      racc (~> 1.4)
-    nokogiri (1.19.3-x86_64-linux-musl)
-      racc (~> 1.4)
-    pp (0.6.3)
-      prettyprint
-    prettyprint (0.2.0)
-    prism (1.9.0)
-    pry (0.16.0)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-      reline (>= 0.6.0)
-    pry-rails (0.3.11)
-      pry (>= 0.13.0)
-    psych (5.4.0)
-      date
-      stringio
-    puma (8.0.2)
-      nio4r (~> 2.0)
-    racc (1.8.1)
-    rack (3.2.6)
-    rack-cors (3.0.0)
-      logger
-      rack (>= 3.0.14)
-    rack-session (2.1.2)
-      base64 (>= 0.1.0)
-      rack (>= 3.0.0)
-    rack-test (2.2.0)
-      rack (>= 1.3)
-    rackup (2.3.1)
-      rack (>= 3)
-    rails (8.0.5)
-      actioncable (= 8.0.5)
-      actionmailbox (= 8.0.5)
-      actionmailer (= 8.0.5)
-      actionpack (= 8.0.5)
-      actiontext (= 8.0.5)
-      actionview (= 8.0.5)
-      activejob (= 8.0.5)
-      activemodel (= 8.0.5)
-      activerecord (= 8.0.5)
-      activestorage (= 8.0.5)
-      activesupport (= 8.0.5)
-      bundler (>= 1.15.0)
-      railties (= 8.0.5)
-    rails-dom-testing (2.3.0)
-      activesupport (>= 5.0.0)
-      minitest
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.7.0)
-      loofah (~> 2.25)
-      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
-    railties (8.0.5)
-      actionpack (= 8.0.5)
-      activesupport (= 8.0.5)
-      irb (~> 1.13)
-      rackup (>= 1.0.0)
-      rake (>= 12.2)
-      thor (~> 1.0, >= 1.2.2)
-      tsort (>= 0.2)
-      zeitwerk (~> 2.6)
-    rake (13.4.2)
-    rdoc (7.2.0)
-      erb
-      psych (>= 4.0.0)
-      tsort
-    reline (0.6.3)
-      io-console (~> 0.5)
-    securerandom (0.4.1)
-    sqlite3 (2.9.5-aarch64-linux-gnu)
-    sqlite3 (2.9.5-aarch64-linux-musl)
-    sqlite3 (2.9.5-arm-linux-gnu)
-    sqlite3 (2.9.5-arm-linux-musl)
-    sqlite3 (2.9.5-arm64-darwin)
-    sqlite3 (2.9.5-x86_64-darwin)
-    sqlite3 (2.9.5-x86_64-linux-gnu)
-    sqlite3 (2.9.5-x86_64-linux-musl)
-    stringio (3.2.0)
-    thor (1.5.0)
-    timeout (0.6.1)
-    tsort (0.2.0)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    uri (1.1.1)
-    useragent (0.16.11)
-    websocket-driver (0.8.1)
-      base64
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.5)
-    zeitwerk (2.8.2)
-PLATFORMS
-  aarch64-linux
-  aarch64-linux-gnu
-  aarch64-linux-musl
-  arm-linux-gnu
-  arm-linux-musl
-  arm64-darwin
-  x86_64-darwin
-  x86_64-linux
-  x86_64-linux-gnu
-  x86_64-linux-musl
-DEPENDENCIES
-  bootsnap
-  brakeman
-  debug
-  factory_bot_rails (~> 6.4)
-  faker
-  grape (~> 3.1.1)
-  grape-entity (~> 1.0)
-  grape_openapi3!
-  pry-rails
-  puma (>= 5.0)
-  rack-cors
-  rails (~> 8.0.3)
-  sqlite3 (>= 2.1)
-  tzinfo-data
-RUBY VERSION
-   ruby 3.3.0p0
-BUNDLED WITH
-   2.5.17

data/example/rails_app/README.md DELETED Viewed

@@ -1,24 +0,0 @@
-# README
-This README would normally document whatever steps are necessary to get the
-application up and running.
-Things you may want to cover:
-* Ruby version
-* System dependencies
-* Configuration
-* Database creation
-* Database initialization
-* How to run the test suite
-* Services (job queues, cache servers, search engines, etc.)
-* Deployment instructions
-* ...

data/example/rails_app/Rakefile DELETED Viewed

@@ -1,6 +0,0 @@
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-require_relative "config/application"
-Rails.application.load_tasks

data/example/rails_app/app/api/v1/base.rb DELETED Viewed

@@ -1,17 +0,0 @@
-module V1
-  class Base < Grape::API
-    prefix  :api
-    version :v1, using: :path
-    format  :json
-    rescue_from ActiveRecord::RecordNotFound do |e|
-      error!({ error: e.message }, 404)
-    end
-    rescue_from Grape::Exceptions::ValidationErrors do |e|
-      error!({ errors: e.full_messages }, 422)
-    end
-    mount V1::Products
-  end
-end

data/example/rails_app/app/api/v1/entities/product_entity.rb DELETED Viewed

@@ -1,15 +0,0 @@
-module V1
-  module Entities
-    class ProductEntity < Grape::Entity
-      expose :id,          documentation: { type: Integer, desc: "Product ID", required: true }
-      expose :name,        documentation: { type: String,  desc: "Product name", required: true }
-      expose :description, documentation: { type: String,  desc: "Full description", nullable: true }
-      expose :price,       documentation: { type: Float,   desc: "Price in USD", required: true }
-      expose :stock,       documentation: { type: Integer, desc: "Units in stock", required: true }
-      expose :category,    documentation: { type: String,  desc: "Product category", nullable: true }
-      expose :active,      documentation: { type: :boolean, desc: "Whether the product is active", required: true }
-      expose :created_at,  documentation: { type: DateTime, desc: "Creation timestamp" }
-      expose :updated_at,  documentation: { type: DateTime, desc: "Last update timestamp" }
-    end
-  end
-end

data/example/rails_app/app/api/v1/entities/product_list_entity.rb DELETED Viewed

@@ -1,11 +0,0 @@
-module V1
-  module Entities
-    class ProductListEntity < Grape::Entity
-      expose :data,  using: ProductEntity,
-             documentation: { type: ProductEntity, is_array: true, desc: "Products", required: true }
-      expose :total, documentation: { type: Integer, desc: "Total number of records", required: true }
-      expose :page,  documentation: { type: Integer, desc: "Current page", required: true }
-      expose :pages, documentation: { type: Integer, desc: "Total pages", required: true }
-    end
-  end
-end

data/example/rails_app/app/api/v1/products.rb DELETED Viewed

@@ -1,159 +0,0 @@
-module V1
-  class Products < Grape::API
-    PAGE_SIZE = 20
-    helpers do
-      def paginate(scope)
-        page  = [params[:page].to_i, 1].max
-        per   = [params[:per_page].to_i.positive? ? params[:per_page].to_i : PAGE_SIZE, 100].min
-        total = scope.count
-        [scope.offset((page - 1) * per).limit(per), total, page, (total.to_f / per).ceil]
-      end
-      def find_product!
-        Product.find(params[:id])
-      rescue ActiveRecord::RecordNotFound
-        error!({ error: "Product not found" }, 404)
-      end
-    end
-    resource :products do
-      desc "List all products", {
-        success: { code: 200, model: Entities::ProductListEntity, message: "List of products returned successfully." },
-        failure: [
-          { code: 401, message: "Unauthorized" },
-        ],
-        detail: "Returns a paginated list of products. Supports filtering by name, category, and active status.",
-        tags:   ["products"],
-        params: {
-          page:        { type: Integer, desc: "Page number (default: 1)" },
-          per_page:    { type: Integer, desc: "Items per page (max: 100)" },
-          search:      { type: String,  desc: "Filter by name or description" },
-          category:    { type: String,  desc: "Filter by category" },
-          active:      { type: Grape::API::Boolean, desc: "Filter by active status" },
-        }
-      }
-      params do
-        optional :page,     type: Integer
-        optional :per_page, type: Integer
-        optional :search,   type: String
-        optional :category, type: String
-        optional :active,   type: Grape::API::Boolean
-      end
-      get do
-        scope = Product.all
-        scope = scope.search(params[:search])
-        scope = scope.by_category(params[:category])
-        scope = scope.where(active: params[:active]) unless params[:active].nil?
-        records, total, page, pages = paginate(scope)
-        present(
-          { data: records, total: total, page: page, pages: pages },
-          with: Entities::ProductListEntity
-        )
-      end
-      desc "Get a product", {
-        success: { code: 200, model: Entities::ProductEntity, message: "Product returned successfully." },
-        failure: [
-          { code: 404, message: "Product not found" },
-        ],
-        detail: "Returns a single product by its ID.",
-        tags:   ["products"],
-      }
-      params do
-        requires :id, type: Integer, desc: "Product ID"
-      end
-      get ":id" do
-        present find_product!, with: Entities::ProductEntity
-      end
-      desc "Create a product", {
-        success: { code: 201, model: Entities::ProductEntity, message: "Product created successfully." },
-        failure: [
-          { code: 422, message: "Validation error" },
-        ],
-        detail: "Creates a new product. Name, price and stock are required.",
-        tags:   ["products"],
-        params: {
-          name:        { type: String,  required: true, desc: "Product name" },
-          price:       { type: Float,   required: true, desc: "Price in USD" },
-          stock:       { type: Integer, required: true, desc: "Initial stock quantity" },
-          description: { type: String,  desc: "Full description" },
-          category:    { type: String,  desc: "Category name" },
-          active:      { type: Grape::API::Boolean, desc: "Active status (default: true)" },
-        }
-      }
-      params do
-        requires :name,  type: String
-        requires :price, type: BigDecimal
-        requires :stock, type: Integer
-        optional :description, type: String
-        optional :category,    type: String
-        optional :active,      type: Grape::API::Boolean, default: true
-      end
-      post do
-        product = Product.new(params.slice(:name, :price, :stock, :description, :category, :active))
-        if product.save
-          present product, with: Entities::ProductEntity
-        else
-          error!({ errors: product.errors.full_messages }, 422)
-        end
-      end
-      desc "Update a product", {
-        success: { code: 200, model: Entities::ProductEntity, message: "Product updated successfully." },
-        failure: [
-          { code: 404, message: "Product not found" },
-          { code: 422, message: "Validation error" },
-        ],
-        detail: "Partially updates a product. Only the provided fields are changed.",
-        tags:   ["products"],
-        params: {
-          name:        { type: String,  desc: "Product name" },
-          price:       { type: Float,   desc: "Price in USD" },
-          stock:       { type: Integer, desc: "Stock quantity" },
-          description: { type: String,  desc: "Full description" },
-          category:    { type: String,  desc: "Category name" },
-          active:      { type: Grape::API::Boolean, desc: "Active status" },
-        }
-      }
-      params do
-        requires :id, type: Integer, desc: "Product ID",
-                 documentation: { param_type: "path" }
-        optional :name,        type: String
-        optional :price,       type: BigDecimal
-        optional :stock,       type: Integer
-        optional :description, type: String
-        optional :category,    type: String
-        optional :active,      type: Grape::API::Boolean
-      end
-      put ":id" do
-        product = find_product!
-        attrs   = params.slice(:name, :price, :stock, :description, :category, :active)
-                        .reject { |_, v| v.nil? }
-        if product.update(attrs)
-          present product, with: Entities::ProductEntity
-        else
-          error!({ errors: product.errors.full_messages }, 422)
-        end
-      end
-      desc "Delete a product", {
-        failure: [
-          { code: 404, message: "Product not found" },
-        ],
-        detail: "Permanently deletes a product. This action cannot be undone.",
-        tags:   ["products"],
-      }
-      params do
-        requires :id, type: Integer, desc: "Product ID"
-      end
-      delete ":id" do
-        find_product!.destroy!
-        status 204
-      end
-    end
-  end
-end

data/example/rails_app/app/controllers/application_controller.rb DELETED Viewed

	@@ -1,2 +0,0 @@
1	- class ApplicationController < ActionController::API
2	- end

data/example/rails_app/app/controllers/concerns/.keep DELETED Viewed

File without changes

data/example/rails_app/app/jobs/application_job.rb DELETED Viewed

@@ -1,7 +0,0 @@
-class ApplicationJob < ActiveJob::Base
-  # Automatically retry jobs that encountered a deadlock
-  # retry_on ActiveRecord::Deadlocked
-  # Most jobs are safe to ignore if the underlying records are no longer available
-  # discard_on ActiveJob::DeserializationError
-end

data/example/rails_app/app/models/application_record.rb DELETED Viewed

@@ -1,3 +0,0 @@
-class ApplicationRecord < ActiveRecord::Base
-  primary_abstract_class
-end

data/example/rails_app/app/models/concerns/.keep DELETED Viewed

File without changes

data/example/rails_app/app/models/product.rb DELETED Viewed

@@ -1,8 +0,0 @@
-class Product < ApplicationRecord
-  validates :name,  presence: true
-  validates :price, presence: true, numericality: { greater_than_or_equal_to: 0 }
-  validates :stock, numericality: { only_integer: true, greater_than_or_equal_to: 0 }
-  scope :by_category, ->(cat) { where(category: cat) if cat.present? }
-  scope :search,      ->(q)   { where("name LIKE ? OR description LIKE ?", "%#{q}%", "%#{q}%") if q.present? }
-end

data/example/rails_app/bin/brakeman DELETED Viewed

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-require "rubygems"
-require "bundler/setup"
-ARGV.unshift("--ensure-latest")
-load Gem.bin_path("brakeman", "brakeman")

data/example/rails_app/bin/bundle DELETED Viewed

@@ -1,109 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-#
-# This file was generated by Bundler.
-#
-# The application 'bundle' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-require "rubygems"
-m = Module.new do
-  module_function
-  def invoked_as_script?
-    File.expand_path($0) == File.expand_path(__FILE__)
-  end
-  def env_var_version
-    ENV["BUNDLER_VERSION"]
-  end
-  def cli_arg_version
-    return unless invoked_as_script? # don't want to hijack other binstubs
-    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
-    bundler_version = nil
-    update_index = nil
-    ARGV.each_with_index do |a, i|
-      if update_index && update_index.succ == i && a.match?(Gem::Version::ANCHORED_VERSION_PATTERN)
-        bundler_version = a
-      end
-      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
-      bundler_version = $1
-      update_index = i
-    end
-    bundler_version
-  end
-  def gemfile
-    gemfile = ENV["BUNDLE_GEMFILE"]
-    return gemfile if gemfile && !gemfile.empty?
-    File.expand_path("../Gemfile", __dir__)
-  end
-  def lockfile
-    lockfile =
-      case File.basename(gemfile)
-      when "gems.rb" then gemfile.sub(/\.rb$/, ".locked")
-      else "#{gemfile}.lock"
-      end
-    File.expand_path(lockfile)
-  end
-  def lockfile_version
-    return unless File.file?(lockfile)
-    lockfile_contents = File.read(lockfile)
-    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
-    Regexp.last_match(1)
-  end
-  def bundler_requirement
-    @bundler_requirement ||=
-      env_var_version ||
-      cli_arg_version ||
-      bundler_requirement_for(lockfile_version)
-  end
-  def bundler_requirement_for(version)
-    return "#{Gem::Requirement.default}.a" unless version
-    bundler_gem_version = Gem::Version.new(version)
-    bundler_gem_version.approximate_recommendation
-  end
-  def load_bundler!
-    ENV["BUNDLE_GEMFILE"] ||= gemfile
-    activate_bundler
-  end
-  def activate_bundler
-    gem_error = activation_error_handling do
-      gem "bundler", bundler_requirement
-    end
-    return if gem_error.nil?
-    require_error = activation_error_handling do
-      require "bundler/version"
-    end
-    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
-    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
-    exit 42
-  end
-  def activation_error_handling
-    yield
-    nil
-  rescue StandardError, LoadError => e
-    e
-  end
-end
-m.load_bundler!
-if m.invoked_as_script?
-  load Gem.bin_path("bundler", "bundle")
-end

data/example/rails_app/bin/dev DELETED Viewed

	@@ -1,2 +0,0 @@
1	- #!/usr/bin/env ruby
2	- exec "./bin/rails", "server", *ARGV