eazypi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b60b4097cbd524ad683d3bf4c25158620e491a0638649397da289fc4d63d21e1
+  data.tar.gz: a18fa4781d32592d1dc933d1923dfc389237d04ae02a067420c364cd35c8772c
+SHA512:
+  metadata.gz: a96a3e253fea3076ba0953c166b9d31e295160c8c9ab34fbb0e72393ed1bfc647c39d7b9f2e98457c3f7c66b3ddc240cfb27aea0ca0fd25468cb51f41db8e5f7
+  data.tar.gz: '0832c28ce9c3120b63d3d40d3b59e5aea7701dc6b050ffe89c49ce54dbfdb5f74ce05091a0e587c5c2407df95b5a0e4b082cf23441400ce9505f1d6f6692a61a'

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,304 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.0
+  Exclude:
+    - petstore-example/**/*
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+## All new checls
+
+Gemspec/DeprecatedAttributeAssignment: # new in 1.30
+  Enabled: true
+Gemspec/DevelopmentDependencies: # new in 1.44
+  Enabled: true
+Gemspec/RequireMFA: # new in 1.23
+  Enabled: true
+Layout/LineContinuationLeadingSpace: # new in 1.31
+  Enabled: true
+Layout/LineContinuationSpacing: # new in 1.31
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation: # new in 1.18
+  Enabled: true
+Layout/SpaceBeforeBrackets: # new in 1.7
+  Enabled: true
+Lint/AmbiguousAssignment: # new in 1.7
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence: # new in 1.21
+  Enabled: true
+Lint/AmbiguousRange: # new in 1.19
+  Enabled: true
+Lint/ConstantOverwrittenInRescue: # new in 1.31
+  Enabled: true
+Lint/DeprecatedConstants: # new in 1.8
+  Enabled: true
+Lint/DuplicateBranch: # new in 1.3
+  Enabled: true
+Lint/DuplicateMagicComment: # new in 1.37
+  Enabled: true
+Lint/DuplicateMatchPattern: # new in 1.50
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # new in 1.1
+  Enabled: true
+Lint/EmptyBlock: # new in 1.1
+  Enabled: true
+Lint/EmptyClass: # new in 1.3
+  Enabled: true
+Lint/EmptyInPattern: # new in 1.16
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
+Lint/ItWithoutArgumentsInBlock: # new in 1.59
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # new in 1.8
+  Enabled: true
+Lint/LiteralAssignmentInCondition: # new in 1.58
+  Enabled: true
+Lint/MixedCaseRange: # new in 1.53
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # new in 1.2
+  Enabled: true
+Lint/NonAtomicFileOperation: # new in 1.31
+  Enabled: true
+Lint/NumberedParameterAssignment: # new in 1.9
+  Enabled: true
+Lint/OrAssignmentToConstant: # new in 1.9
+  Enabled: true
+Lint/RedundantDirGlobSort: # new in 1.8
+  Enabled: true
+Lint/RedundantRegexpQuantifiers: # new in 1.53
+  Enabled: true
+Lint/RefinementImportMethods: # new in 1.27
+  Enabled: true
+Lint/RequireRangeParentheses: # new in 1.32
+  Enabled: true
+Lint/RequireRelativeSelfPath: # new in 1.22
+  Enabled: true
+Lint/SymbolConversion: # new in 1.9
+  Enabled: true
+Lint/ToEnumArguments: # new in 1.1
+  Enabled: true
+Lint/TripleQuotes: # new in 1.9
+  Enabled: true
+Lint/UnexpectedBlockArity: # new in 1.5
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # new in 1.1
+  Enabled: true
+Lint/UselessRescue: # new in 1.43
+  Enabled: true
+Lint/UselessRuby2Keywords: # new in 1.23
+  Enabled: true
+Metrics/CollectionLiteralLength: # new in 1.47
+  Enabled: true
+Naming/BlockForwarding: # new in 1.24
+  Enabled: true
+Security/CompoundHash: # new in 1.28
+  Enabled: true
+Security/IoMethods: # new in 1.22
+  Enabled: true
+Style/ArgumentsForwarding: # new in 1.1
+  Enabled: true
+Style/ArrayIntersect: # new in 1.40
+  Enabled: true
+Style/CollectionCompact: # new in 1.2
+  Enabled: true
+Style/ComparableClamp: # new in 1.44
+  Enabled: true
+Style/ConcatArrayLiterals: # new in 1.41
+  Enabled: true
+Style/DataInheritance: # new in 1.49
+  Enabled: true
+Style/DirEmpty: # new in 1.48
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # new in 1.1
+  Enabled: true
+Style/EmptyHeredoc: # new in 1.32
+  Enabled: true
+Style/EndlessMethod: # new in 1.8
+  Enabled: true
+Style/EnvHome: # new in 1.29
+  Enabled: true
+Style/ExactRegexpMatch: # new in 1.51
+  Enabled: true
+Style/FetchEnvVar: # new in 1.28
+  Enabled: true
+Style/FileEmpty: # new in 1.48
+  Enabled: true
+Style/FileRead: # new in 1.24
+  Enabled: true
+Style/FileWrite: # new in 1.24
+  Enabled: true
+Style/HashConversion: # new in 1.10
+  Enabled: true
+Style/HashExcept: # new in 1.7
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # new in 1.9
+  Enabled: true
+Style/InPatternThen: # new in 1.16
+  Enabled: true
+Style/MagicCommentFormat: # new in 1.35
+  Enabled: true
+Style/MapCompactWithConditionalBlock: # new in 1.30
+  Enabled: true
+Style/MapToHash: # new in 1.24
+  Enabled: true
+Style/MapToSet: # new in 1.42
+  Enabled: true
+Style/MinMaxComparison: # new in 1.42
+  Enabled: true
+Style/MultilineInPatternThen: # new in 1.16
+  Enabled: true
+Style/NegatedIfElseCondition: # new in 1.2
+  Enabled: true
+Style/NestedFileDirname: # new in 1.26
+  Enabled: true
+Style/NilLambda: # new in 1.3
+  Enabled: true
+Style/NumberedParameters: # new in 1.22
+  Enabled: true
+Style/NumberedParametersLimit: # new in 1.22
+  Enabled: true
+Style/ObjectThen: # new in 1.28
+  Enabled: true
+Style/OpenStructUse: # new in 1.23
+  Enabled: true
+Style/OperatorMethodCall: # new in 1.37
+  Enabled: true
+Style/QuotedSymbols: # new in 1.16
+  Enabled: true
+Style/RedundantArgument: # new in 1.4
+  Enabled: true
+Style/RedundantArrayConstructor: # new in 1.52
+  Enabled: true
+Style/RedundantConstantBase: # new in 1.40
+  Enabled: true
+Style/RedundantCurrentDirectoryInPath: # new in 1.53
+  Enabled: true
+Style/RedundantDoubleSplatHashBraces: # new in 1.41
+  Enabled: true
+Style/RedundantEach: # new in 1.38
+  Enabled: true
+Style/RedundantFilterChain: # new in 1.52
+  Enabled: true
+Style/RedundantHeredocDelimiterQuotes: # new in 1.45
+  Enabled: true
+Style/RedundantInitialize: # new in 1.27
+  Enabled: true
+Style/RedundantLineContinuation: # new in 1.49
+  Enabled: true
+Style/RedundantRegexpArgument: # new in 1.53
+  Enabled: true
+Style/RedundantRegexpConstructor: # new in 1.52
+  Enabled: true
+Style/RedundantSelfAssignmentBranch: # new in 1.19
+  Enabled: true
+Style/RedundantStringEscape: # new in 1.37
+  Enabled: true
+Style/ReturnNilInPredicateMethodDefinition: # new in 1.53
+  Enabled: true
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
+Style/SingleLineDoEndBlock: # new in 1.57
+  Enabled: true
+Style/StringChars: # new in 1.12
+  Enabled: true
+Style/SuperWithArgsParentheses: # new in 1.58
+  Enabled: true
+Style/SwapValues: # new in 1.1
+  Enabled: true
+Style/YAMLFileRead: # new in 1.53
+  Enabled: true
+
+Capybara/MatchStyle: # new in 2.17
+  Enabled: true
+Capybara/NegationMatcher: # new in 2.14
+  Enabled: true
+Capybara/SpecificActions: # new in 2.14
+  Enabled: true
+Capybara/SpecificFinders: # new in 2.13
+  Enabled: true
+Capybara/SpecificMatcher: # new in 2.12
+  Enabled: true
+FactoryBot/AssociationStyle: # new in 2.23
+  Enabled: true
+FactoryBot/ConsistentParenthesesStyle: # new in 2.14
+  Enabled: true
+FactoryBot/FactoryAssociationWithStrategy: # new in 2.23
+  Enabled: true
+FactoryBot/FactoryNameStyle: # new in 2.16
+  Enabled: true
+FactoryBot/IdSequence: # new in <<next>>
+  Enabled: true
+FactoryBot/RedundantFactoryOption: # new in 2.23
+  Enabled: true
+FactoryBot/SyntaxMethods: # new in 2.7
+  Enabled: true
+RSpec/BeEmpty: # new in 2.20
+  Enabled: true
+RSpec/BeEq: # new in 2.9.0
+  Enabled: true
+RSpec/BeNil: # new in 2.9.0
+  Enabled: true
+RSpec/ChangeByZero: # new in 2.11
+  Enabled: true
+RSpec/ContainExactly: # new in 2.19
+  Enabled: true
+RSpec/DuplicatedMetadata: # new in 2.16
+  Enabled: true
+RSpec/ExcessiveDocstringSpacing: # new in 2.5
+  Enabled: true
+RSpec/IdenticalEqualityAssertion: # new in 2.4
+  Enabled: true
+RSpec/IndexedLet: # new in 2.20
+  Enabled: true
+RSpec/MatchArray: # new in 2.19
+  Enabled: true
+RSpec/NoExpectationExample: # new in 2.13
+  Enabled: true
+RSpec/PendingWithoutReason: # new in 2.16
+  Enabled: true
+RSpec/RedundantAround: # new in 2.19
+  Enabled: true
+RSpec/SkipBlockInsideExample: # new in 2.19
+  Enabled: true
+RSpec/SortMetadata: # new in 2.14
+  Enabled: true
+RSpec/SubjectDeclaration: # new in 2.5
+  Enabled: true
+RSpec/VerifiedDoubleReference: # new in 2.10.0
+  Enabled: true
+RSpec/Rails/AvoidSetupHook: # new in 2.4
+  Enabled: true
+RSpec/Rails/HaveHttpStatus: # new in 2.12
+  Enabled: true
+RSpec/Rails/InferredSpecType: # new in 2.14
+  Enabled: true
+RSpec/Rails/MinitestAssertions: # new in 2.17
+  Enabled: true
+RSpec/Rails/TravelAround: # new in 2.19
+  Enabled: true

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [Unreleased]
+
+- Initial release

data/README.md

@@ -0,0 +1,122 @@
+# Eazypi
+
+bundle exec rake release
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add eazypi
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install eazypi
+
+## TODO
+
+Currently this is in pre-alpha phase, and lot is left to do.
+
+* Use components automatically
+* Enforce input
+  * Fix array for query parameters
+* Variants of serializers
+* Enforce output
+* Examples into schema
+* Output headers
+* Security
+* Tags
+* Basic conformance
+
+## Usage
+
+### Create an API definition
+
+Create a new API class and include `Eazypi::Api`. Then use the DSL helper methods to define the API.
+Per OpenAPI spec it is required to include the info
+
+~~~
+class Api::V1::Example
+  include Eazypi::Api
+
+  info do
+    title "Example API"
+
+    version "0.0.1"
+  end
+end
+~~~
+
+### Create a controller Class
+
+Create a normal rails controller and use the DSL to define operations.
+
+~~~
+class Api::V1::ExampleController
+  operation :get, '/examples' do
+    response 200, [String]
+
+    render do
+      render json: { examples: ['A', 'B'] }
+    end
+  end
+end
+~~~
+
+Also for every new controller you need to define it in your Api Definition from before
+
+~~~
+class Api::V1::Example
+  ...
+  
+  load_controller_class Api::V1::ExampleController
+end
+~~~
+
+### Mount routes
+
+In `config/routes` mount your API definition
+
+~~~
+Rails.application.routes.draw do
+  scope '/api/v1' do
+    Api::V1::Example.mount(self)
+  end
+end
+~~~
+
+### See openapi file
+
+Run your rails server
+Go to `localhost:3000/api/v1/openapi.json` or `localhost:3000/api/v1/openapi.yaml`
+
+## Goals
+
+The goal is to create an easy to use DSL to create nice OpenAPI defined API's.
+
+The idea is that the code & documentation live together, but also that it is not possible to accidently change
+the API but not update the documentation (especially regarding input & output parameters).
+
+
+## Limitations
+
+Feel free to prepare pull requests if you want to improve on these limitations
+
+* Only application/json supported (not XML)
+* Only supports OpenAPI 3.0.3
+
+
+## Out of scope
+
+* No UI to render the documentation. It is recommended to do this outside your rails application. For development you can use rswag-ui or similar
+* Not guaranteed to deliver valid/conformant OpenAPI spec. It is recommended to run an OpenAPI validator.
+  We might add errors or warnings for common mistakes, but creating a spec file without errors is not guaranteed.
+
+## 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]/eazypi.

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/eazypi/api.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Eazypi
+  # Main API endpoint. Include this module to start defining your own API's.
+  module Api
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    # ClassMethods that can be used in your API definition
+    module ClassMethods
+      def info(&block)
+        @info ||= Info.new
+
+        @info.load(&block) if block_given?
+
+        @info
+      end
+
+      def paths
+        @paths ||= {}
+      end
+
+      def load_controller(controller_klass)
+        controller_klass.operations.each do |operation|
+          paths[operation.path] ||= PathItem.new
+
+          paths[operation.path].send(operation.method, operation)
+        end
+      end
+
+      def components
+        @components ||= Components.new
+      end
+
+      def servers
+        []
+      end
+
+      def to_openapi_spec
+        {
+          "openapi" => "3.0.3", # Future improvement allow different version
+          "info" => info.to_openapi_spec,
+          "paths" => paths.transform_keys do |path|
+                       Operation.normalized_path(path)
+                     end.transform_values(&:to_openapi_spec),
+          "servers" => servers.map(&:to_openapi_spec),
+          "components" => components.to_openapi_spec
+        }
+      end
+
+      def mount(router) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
+        prepare_controller_class
+
+        router.get "openapi.:format", to: "#{ancestors[0].name.underscore}/eazypi#show"
+
+        paths.each do |path_name, path_item|
+          %i[get post patch put delete].each do |http_method|
+            operation = path_item.send(http_method)
+            next unless operation
+
+            controller_router_name = operation.controller_klass.name[...-"Controller".length]
+            router.send(
+              http_method,
+              path_name,
+              to: "#{controller_router_name.underscore}##{operation.controller_method}"
+            )
+          end
+        end
+      end
+
+      private
+
+      def prepare_controller_class
+        ancestors[0].const_set("EazypiController", controller_class)
+      end
+
+      def controller_class # rubocop:todo Metrics/MethodLength
+        @controller_class ||= begin
+          api_instance = self
+
+          klass = Class.new(ActionController::Base)
+          klass.define_method(:show) do
+            puts "HERER AI MA "
+
+            if params[:format] == "json"
+              render json: api_instance.to_openapi_spec
+            elsif params[:format] == "yaml"
+              render plain: api_instance.to_openapi_spec.to_yaml, content_type: "text/yaml"
+            else
+              raise "#{params[:format]} not supported"
+            end
+          end
+
+          klass
+        end
+      end
+    end
+  end
+end

data/lib/eazypi/api_controller.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Eazypi
+  # Include this module in your Rails controller to define operations
+  module ApiController
+    def self.included(base)
+      base.instance_variable_set(:@operations, [])
+      base.extend(ClassMethods)
+    end
+
+    # Class methods to be used in your own API controller
+    module ClassMethods
+      def operation(method, path_string, &block)
+        method_name = determine_method_name(method, path_string)
+
+        op = Operation.new(self, method_name, path_string, method)
+        op.load(&block)
+
+        define_method(method_name) do
+          op.call(self)
+        end
+
+        @operations << op
+
+        op
+      end
+
+      def operations
+        @operations
+      end
+
+      def determine_method_name(http_method, _path_string) # rubocop:todo Metrics/MethodLength
+        controller_base_name = case http_method
+                               when :get
+                                 :show
+                               when :post
+                                 :create
+                               when :patch, :put
+                                 :update
+                               when :delete
+                                 :destroy
+                               else
+                                 raise "Could not generate method name"
+                               end
+        controller_method_name = controller_base_name
+
+        counter = 1
+        while method_defined?(controller_method_name)
+          controller_method_name = "#{controller_base_name}#{counter}"
+          counter += 1
+        end
+
+        controller_method_name
+      end
+    end
+  end
+end

data/lib/eazypi/components.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Eazypi
+  # OpenAPI spec ComponentsObject
+  class Components
+    def to_openapi_spec
+      {}
+    end
+  end
+end

data/lib/eazypi/info.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Eazypi
+  # OpenAPI spec InfoObject
+  class Info
+    include SpecObject
+
+    spec_attribute :title
+    spec_attribute :summary
+    spec_attribute :description
+    spec_attribute :terms_of_service
+    spec_attribute :contact
+    spec_attribute :license
+    spec_attribute :version
+
+    def to_openapi_spec
+      {
+        "title" => title,
+        "summary" => summary,
+        "description" => description,
+        "termsOfService" => terms_of_service,
+        "contact" => contact,
+        "license" => license,
+        "version" => version
+      }.compact
+    end
+  end
+end

data/lib/eazypi/media_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Eazypi
+  # OpenaAPI spec MediaTypeObject
+  class MediaType
+    include SpecObject
+
+    spec_attribute :schema
+
+    def to_openapi_spec
+      {
+        "schema" => schema.to_openapi_spec
+      }
+    end
+  end
+end

data/lib/eazypi/operation.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Eazypi
+  # OpenAPI spec OperationObject
+  class Operation
+    include Eazypi::SpecObject
+
+    spec_attribute :summary
+    spec_attribute :description
+    spec_attribute :operation_id
+    spec_attribute :depcrecated
+
+    attr_reader :controller_klass, :controller_method, :path, :method, :parameters
+
+    def initialize(controller_klass, controller_method, path, method, &block)
+      @controller_klass = controller_klass
+      @controller_method = controller_method
+      @path = path
+      @method = method
+      @parameters = []
+
+      super(&block)
+    end
+
+    def openapi_templated_path
+      self.class.normalized_path(@path)
+    end
+
+    def parameter(name, location: nil, &block)
+      if location.nil?
+        location = path_parameters.include?(name.to_s) ? "path" : "query"
+      end
+
+      @parameters << Parameter.new(name: name, location: location, &block)
+    end
+
+    def request_body(&block)
+      @request_body ||= RequestBody.new(&block)
+    end
+
+    def response(status_code, &block)
+      @responses ||= Responses.new
+
+      @responses.add_response(status_code, &block)
+    end
+
+    def render(&block)
+      @renderer = block
+    end
+
+    def call(controller)
+      controller.instance_exec(&@renderer)
+    end
+
+    def to_openapi_spec
+      {
+        "summary" => summary,
+        "description" => description,
+        "operationId" => operation_id,
+        "depcrecated" => depcrecated,
+        "parameters" => @parameters.empty? ? nil : @parameters&.map(&:to_openapi_spec),
+        "requestBody" => @request_body&.to_openapi_spec,
+        "responses" => @responses&.to_openapi_spec
+      }.compact
+    end
+
+    def self.normalized_path(path)
+      normalized_path = path.dup
+
+      path.scan(PATH_REGEX).each do |match|
+        normalized_path.gsub!(match[1..], "{#{match[2..]}}")
+      end
+
+      normalized_path
+    end
+
+    private
+
+    PATH_REGEX = %r{/:[a-zA-Z0-9_-]+}
+
+    def path_parameters
+      @path_parameters ||= path.scan(PATH_REGEX).map do |match|
+        match[2..]
+      end
+    end
+  end
+end

data/lib/eazypi/parameter.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Eazypi
+  # OpenAPI spec ParameterObject
+  class Parameter
+    include Eazypi::SpecObject
+
+    spec_attribute :name
+    spec_attribute :location
+    spec_attribute :description
+    spec_attribute :required
+    spec_attribute :depcrecated
+    spec_attribute :allow_empty_value
+
+    spec_attribute :explode
+    spec_attribute :schema
+
+    def initialize(name:, location:, &block)
+      @name = name
+      @location = location
+
+      super(&block)
+    end
+
+    def to_openapi_spec
+      {
+        "name" => name.to_s,
+        "in" => location, # using location as in is a ruby keywork
+        "description" => description,
+        "required" => location == "path" ? true : required,
+        "deprecated" => depcrecated,
+        "allowEmptyValue" => allow_empty_value,
+        "schema" => schema ? Schema.from_object(schema).to_openapi_spec : nil
+      }.compact
+    end
+  end
+end

data/lib/eazypi/path_item.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Eazypi
+  # OpenAPI spec PathItemObject
+  class PathItem
+    include SpecObject
+
+    spec_attribute :summary
+    spec_attribute :description
+
+    spec_attribute :get
+    spec_attribute :put
+    spec_attribute :post
+    spec_attribute :delete
+    spec_attribute :options
+    spec_attribute :head
+    spec_attribute :patch
+    spec_attribute :trace
+
+    def to_openapi_spec # rubocop:disable Metrics/PerceivedComplexity, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/AbcSize
+      {
+        "summary" => summary,
+        "description" => description,
+        "get" => get&.to_openapi_spec,
+        "put" => put&.to_openapi_spec,
+        "post" => post&.to_openapi_spec,
+        "delete" => delete&.to_openapi_spec,
+        "options" => options&.to_openapi_spec,
+        "head" => head&.to_openapi_spec,
+        "patch" => patch&.to_openapi_spec,
+        "trace" => trace&.to_openapi_spec
+      }.compact
+    end
+  end
+end

data/lib/eazypi/request_body.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Eazypi
+  # OpenAPI spec RequestBodyObject
+  class RequestBody
+    include SpecObject
+
+    spec_attribute :description
+    spec_attribute :required
+
+    def initialize(&block)
+      @content = {}
+
+      super
+    end
+
+    def content(body_schema, content_type: "application/json")
+      @content[content_type] = MediaType.new do
+        schema Eazypi::Schema.from_object(body_schema)
+      end
+    end
+
+    def to_openapi_spec
+      {
+        "description" => description,
+        "content" => @content.transform_values(&:to_openapi_spec),
+        "required" => required
+      }.compact
+    end
+  end
+end

data/lib/eazypi/response.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Eazypi
+  # OpenAPI spec ResponseObject
+  class Response
+    include SpecObject
+
+    spec_attribute :description
+
+    def initialize
+      @content = {}
+
+      super
+    end
+
+    def content(schema, content_type = "application/json")
+      media_type = MediaType.new
+
+      media_type.load do
+        schema Schema.from_object(schema)
+      end
+
+      @content[content_type] = media_type
+    end
+
+    def to_openapi_spec
+      {
+        "description" => description,
+        "content" => @content.transform_values(&:to_openapi_spec)
+      }.compact
+    end
+  end
+end

data/lib/eazypi/responses.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Eazypi
+  # OpenAPI spec ResponsesObject
+  class Responses
+    def initialize
+      @responses = {}
+    end
+
+    def add_response(status_code, &block)
+      response = Response.new
+      response.load(&block)
+
+      @responses[status_code.to_s] = response
+    end
+
+    def to_openapi_spec
+      @responses.transform_values(&:to_openapi_spec)
+    end
+  end
+end

data/lib/eazypi/schema/array.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Eazypi
+  module Schema
+    # Array schema for JSON
+    class Array
+      attr_reader :item_schema
+
+      def initialize(item_schema)
+        @item_schema = item_schema
+      end
+
+      def to_openapi_spec
+        {
+          "type" => "array",
+          "items" => item_schema.to_openapi_spec
+        }
+      end
+
+      def ==(other)
+        return false unless other.is_a?(Array)
+
+        other.instance_variable_get(:@item_schema) == @item_schema
+      end
+    end
+  end
+end

data/lib/eazypi/schema/object.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Eazypi
+  module Schema
+    # Object schema for Json
+    class Object
+      def initialize
+        @properties = {}
+        @required = []
+      end
+
+      def property(name, schema, required: false)
+        @properties[name] = schema
+        @required << name if required
+      end
+
+      def to_openapi_spec
+        {
+          "type" => "object",
+          "required" => @required.empty? ? nil : @required,
+          "properties" => @properties.transform_values(&:to_openapi_spec)
+        }.compact
+      end
+
+      def ==(other)
+        return false unless other.is_a?(Object)
+
+        other.instance_variable_get(:@properties) == @properties &&
+          other.instance_variable_get(:@required) == @required
+      end
+    end
+  end
+end

data/lib/eazypi/schema/primitive.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Eazypi
+  module Schema
+    # Primitive schema definition
+    class Primitive
+      include SpecObject
+
+      attr_reader :type, :format
+
+      def initialize(type: nil, format: nil)
+        @type = type
+        @format = format
+      end
+
+      def to_openapi_spec
+        {
+          "type" => type,
+          "format" => format
+        }.compact
+      end
+
+      def ==(other)
+        return false unless other.is_a?(Primitive)
+
+        type == other.type &&
+          format == other.format
+      end
+    end
+  end
+end

data/lib/eazypi/schema.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Eazypi
+  # JSON schema
+  module Schema
+    def self.from_object(object) # rubocop:todo Metrics/MethodLength
+      if object.is_a?(::Array)
+        raise "Array needs to have one element" if object.length != 1
+
+        Schema::Array.new(Schema.from_object(object[0]))
+      elsif object == String
+        Schema::Primitive.new(type: "string")
+      elsif object == Integer
+        Schema::Primitive.new(type: "integer")
+      elsif object == Float
+        Schema::Primitive.new(type: "number")
+      elsif object.respond_to?(:to_schema)
+        object.to_schema
+      else
+        raise "Can not convert #{object} to a schema"
+      end
+    end
+  end
+end
+
+require "eazypi/schema/array"
+require "eazypi/schema/object"
+require "eazypi/schema/primitive"

data/lib/eazypi/serializer.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Eazypi
+  # A serializer you can use to define your own Object types easily
+  module Serializer
+    extend ActiveSupport::Concern
+
+    # Defines an Attribute on a serializer
+    class Attribute
+      attr_reader :name, :type, :required
+
+      def initialize(name, type:, method_name:, required:)
+        @name = name
+        @type = type
+        @method_name = method_name
+        @required = required
+      end
+    end
+
+    def initialize(object)
+      @object = object
+    end
+
+    def to_json(*_args)
+      self.class.attributes.to_h do |attribute|
+        [attribute.name, @object.send(attribute.name)]
+      end
+    end
+
+    included do
+      @attributes = []
+
+      def self.attribute(attribute_name, type:, method_name: nil, required: false)
+        @attributes << Attribute.new(
+          attribute_name,
+          type: type,
+          method_name: method_name,
+          required: required
+        )
+      end
+
+      def self.attributes
+        @attributes
+      end
+
+      def self.to_schema
+        schema = Schema::Object.new
+
+        @attributes.each do |attribute|
+          schema.property attribute.name.to_s, Schema.from_object(attribute.type), required: attribute.required
+        end
+
+        schema
+      end
+    end
+  end
+end

data/lib/eazypi/spec_object.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Eazypi
+  # Base module for OpenAPI spec Objects
+  module SpecObject
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def initialize(&block)
+      self.load(&block) if block_given?
+    end
+
+    def load(&block)
+      instance_exec(&block)
+    end
+
+    def to_openapi_spec
+      raise "Not implemented"
+    end
+
+    # ClassMethods for SpecObject
+    module ClassMethods
+      def spec_attribute(attribute_name)
+        define_method(attribute_name) do |v = nil|
+          instance_variable_set(:"@#{attribute_name}", v) if v
+
+          instance_variable_get(:"@#{attribute_name}")
+        end
+      end
+    end
+  end
+end

data/lib/eazypi/version.rb

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

data/lib/eazypi.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Main Eazypi module. Check README.md for details how to start
+module Eazypi
+end
+
+require "active_support"
+require "action_controller"
+
+require "eazypi/spec_object"
+
+require "eazypi/api_controller"
+require "eazypi/api"
+require "eazypi/components"
+require "eazypi/info"
+require "eazypi/media_type"
+require "eazypi/operation"
+require "eazypi/parameter"
+require "eazypi/path_item"
+require "eazypi/request_body"
+require "eazypi/response"
+require "eazypi/responses"
+require "eazypi/schema"
+require "eazypi/serializer"
+require "eazypi/version"

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: eazypi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nathan Samson
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  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: activesupport
+  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'
+description:
+email:
+- nathan@nathansamson.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- lib/eazypi.rb
+- lib/eazypi/api.rb
+- lib/eazypi/api_controller.rb
+- lib/eazypi/components.rb
+- lib/eazypi/info.rb
+- lib/eazypi/media_type.rb
+- lib/eazypi/operation.rb
+- lib/eazypi/parameter.rb
+- lib/eazypi/path_item.rb
+- lib/eazypi/request_body.rb
+- lib/eazypi/response.rb
+- lib/eazypi/responses.rb
+- lib/eazypi/schema.rb
+- lib/eazypi/schema/array.rb
+- lib/eazypi/schema/object.rb
+- lib/eazypi/schema/primitive.rb
+- lib/eazypi/serializer.rb
+- lib/eazypi/spec_object.rb
+- lib/eazypi/version.rb
+homepage: https://gitlab.com/nathansamson/eazypi/-/blob/main/README.md
+licenses: []
+metadata:
+  homepage_uri: https://gitlab.com/nathansamson/eazypi/-/blob/main/README.md
+  source_code_uri: https://gitlab.com/nathansamson/eazypi
+  changelog_uri: https://gitlab.com/nathansamson/eazypi/-/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+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.4.10
+signing_key:
+specification_version: 4
+summary: An opinionated framework to generate OpenAPI API's for Rails
+test_files: []