eazypi 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2a211e5ff4416c5274418acab517f225adad1b68c5614552a96c3e777e6bbd8
-  data.tar.gz: c335c447e26f79f9f62eee7b26321373fbbf46018f11cf881ce395b6103dfa0f
+  metadata.gz: 7a8508af82fe900f0f85371820abba867d0ea81f4fd36319c5fd60619528958d
+  data.tar.gz: e812f649abdae98402335d021045d0c35f036ccb8bb3cb4a168fc5ad2b780416
 SHA512:
-  metadata.gz: 80894d15937e0ff986c9823c8d20984364996af146e5186cc6ff4a1d7d2231b89ba81d6539c65c087eed0272aaead44202ef755f6e7f3827425bf5f6a17756e4
-  data.tar.gz: c36119838e3401abef6d92a5d89226a8b550fc1da1b119ae96e6f3eb3c686079970ddeb39497760c52707908c8b3e8ec32eb4a9492a412ff5d2a910816411e66
+  metadata.gz: c3fc4dc419af5e8de60a93aea62bf34aada19c5a294babffbddd4907bfae270ad44c245da454121c817269bc51bc10b21f1d7f79d05d665659b455b7182b0e7e
+  data.tar.gz: '09e57f0718756728fa2ae72d896f5377a844a0838e2629691f2c4f40e62c8f97df22d24b8f92a0a5a2811a7d3505fdf7d6b75e62f31fad9a4381770aaae215bb'

data/lib/eazypi/api.rb

@@ -8,7 +8,8 @@ module Eazypi
     end
 
     # ClassMethods that can be used in your API definition
-    module ClassMethods
+    # Todo: Split this up
+    module ClassMethods # rubocop:todo Metrics/ModuleLength
       def info(&block)
         @info ||= Info.new
 
@@ -21,6 +22,28 @@ module Eazypi
         @paths ||= {}
       end
 
+      def tag(&block)
+        @tags ||= []
+
+        tag = Tag.new
+        tag.load(&block)
+
+        @tags.append(tag)
+      end
+
+      def security_scheme(name, &block)
+        scheme = SecurityScheme.new
+        scheme.load(&block)
+
+        components.add_security_scheme(name, scheme)
+      end
+
+      def security(name, scopes = [])
+        @security ||= []
+
+        @security.append(SecurityRequirement.new(name, scopes))
+      end
+
       def load_controller(controller_klass)
         controller_klass.operations.each do |operation|
           paths[operation.path] ||= PathItem.new
@@ -45,7 +68,7 @@ module Eazypi
         to_openapi_spec_with_servers(servers)
       end
 
-      def to_openapi_spec_with_servers(override_servers)
+      def to_openapi_spec_with_servers(override_servers) # rubocop:disable Metrics/MethodLength,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
         actual_servers = override_servers || servers
 
         {
@@ -55,8 +78,10 @@ module Eazypi
                        Operation.normalized_path(path)
                      end.transform_values(&:to_openapi_spec),
           "servers" => actual_servers.map(&:to_openapi_spec),
-          "components" => components.to_openapi_spec
-        }
+          "components" => components.to_openapi_spec,
+          "security" => @security&.map(&:to_openapi_spec),
+          "tags" => @tags&.map(&:to_openapi_spec)
+        }.compact
       end
 
       def mount(router) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength

data/lib/eazypi/components.rb

@@ -5,6 +5,11 @@ module Eazypi
   class Components
     def initialize
       @schemas = {}
+      @security_schemes = {}
+    end
+
+    def add_security_scheme(name, scheme)
+      @security_schemes[name] = scheme
     end
 
     def add_schema(name, schema)
@@ -16,7 +21,8 @@ module Eazypi
 
     def to_openapi_spec
       {
-        "schemas" => @schemas.empty? ? nil : @schemas.transform_values(&:to_openapi_spec)
+        "schemas" => @schemas.empty? ? nil : @schemas.transform_values(&:to_openapi_spec),
+        "securitySchemes" => @security_schemes.empty? ? nil : @security_schemes.transform_values(&:to_openapi_spec)
       }.compact
     end
   end

data/lib/eazypi/info.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "eazypi/license"
+
 module Eazypi
   # OpenAPI spec InfoObject
   class Info
@@ -10,7 +12,7 @@ module Eazypi
     spec_attribute :description
     spec_attribute :terms_of_service
     spec_attribute :contact
-    spec_attribute :license
+    spec_attribute :license, License
     spec_attribute :version
 
     def to_openapi_spec
@@ -20,7 +22,7 @@ module Eazypi
         "description" => description,
         "termsOfService" => terms_of_service,
         "contact" => contact,
-        "license" => license,
+        "license" => license&.to_openapi_spec,
         "version" => version
       }.compact
     end

data/lib/eazypi/license.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Eazypi
+  # OpenAPI spec InfoObject
+  class License
+    include SpecObject
+
+    spec_attribute :name
+    spec_attribute :identifier
+    spec_attribute :url
+
+    def to_openapi_spec
+      {
+        "name" => name,
+        "identifier" => identifier,
+        "url" => url
+      }.compact
+    end
+  end
+end

data/lib/eazypi/operation.rb

@@ -18,6 +18,8 @@ module Eazypi
       @path = path
       @method = method
       @parameters = []
+      @security = nil
+      @tags = nil
 
       super(&block)
     end
@@ -54,20 +56,37 @@ module Eazypi
       @renderer = block
     end
 
+    def security!
+      @security = []
+    end
+
+    def security(name, scopes = [])
+      @security ||= []
+
+      @security.append(SecurityRequirement.new(name, scopes))
+    end
+
     def call(controller)
       controller.instance_variable_set(:@current_operation, self)
       controller.instance_exec(&@renderer)
     end
 
-    def to_openapi_spec
+    def tag(tag_name)
+      @tags ||= []
+      @tags.append(tag_name)
+    end
+
+    def to_openapi_spec # rubocop:disable Metrics/CyclomaticComplexity,Metrics/MethodLength
       {
         "summary" => summary,
         "description" => description,
+        "tags" => @tags,
         "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
+        "responses" => @responses&.to_openapi_spec,
+        "security" => @security&.map(&:to_openapi_spec)
       }.compact
     end
 

data/lib/eazypi/security_requirement.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Eazypi
+  # Security Requirement OpenAPI object
+  class SecurityRequirement
+    def initialize(name, scopes = [])
+      @name = name
+      @scopes = scopes
+    end
+
+    def to_openapi_spec
+      {
+        @name => @scopes
+      }
+    end
+  end
+end

data/lib/eazypi/security_scheme.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Eazypi
+  # OpenAPI spec SecurityScheme
+  class SecurityScheme
+    include SpecObject
+
+    spec_attribute :type
+    spec_attribute :description
+
+    spec_attribute :name # Applies only to apiKey
+    spec_attribute :api_key_in # Applies only to apiKey
+
+    spec_attribute :schema # Applies only to http
+    spec_attribute :bearer_format # Applies only to http
+
+    # spec_attribute :flows # Not supported yet
+    # spec_attribute :open_id_connect_url # Not supported yet
+
+    def to_openapi_spec
+      {
+        "type" => type,
+        "description" => description,
+        "name" => name,
+        "in" => api_key_in,
+        "schema" => schema,
+        "bearerFormat" => bearer_format
+      }.compact
+    end
+  end
+end

data/lib/eazypi/serializer.rb

@@ -88,7 +88,7 @@ module Eazypi
       end
 
       def self.object_name
-        name.split("::").join
+        name.split("::").last
       end
     end
 

data/lib/eazypi/spec_object.rb

@@ -21,8 +21,13 @@ module Eazypi
 
     # ClassMethods for SpecObject
     module ClassMethods
-      def spec_attribute(attribute_name)
-        define_method(attribute_name) do |v = nil|
+      def spec_attribute(attribute_name, spec_type = nil)
+        define_method(attribute_name) do |v = nil, &block|
+          if spec_type && block
+            v = spec_type.new
+            v.load(&block)
+          end
+
           instance_variable_set(:"@#{attribute_name}", v) if v
 
           instance_variable_get(:"@#{attribute_name}")

data/lib/eazypi/tag.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Eazypi
+  # OpenAPI spec Tag
+  class Tag
+    include SpecObject
+
+    spec_attribute :name
+    spec_attribute :description
+
+    def to_openapi_spec
+      {
+        "name" => name,
+        "description" => description
+      }.compact
+    end
+  end
+end

data/lib/eazypi/version.rb

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

data/lib/eazypi.rb

@@ -22,5 +22,8 @@ require "eazypi/response"
 require "eazypi/responses"
 require "eazypi/schema"
 require "eazypi/serializer"
+require "eazypi/security_requirement"
+require "eazypi/security_scheme"
 require "eazypi/server"
+require "eazypi/tag"
 require "eazypi/version"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eazypi
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - Nathan Samson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-25 00:00:00.000000000 Z
+date: 2024-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -56,6 +56,7 @@ files:
 - lib/eazypi/api_controller.rb
 - lib/eazypi/components.rb
 - lib/eazypi/info.rb
+- lib/eazypi/license.rb
 - lib/eazypi/media_type.rb
 - lib/eazypi/operation.rb
 - lib/eazypi/parameter.rb
@@ -67,9 +68,12 @@ files:
 - lib/eazypi/schema/array.rb
 - lib/eazypi/schema/object.rb
 - lib/eazypi/schema/primitive.rb
+- lib/eazypi/security_requirement.rb
+- lib/eazypi/security_scheme.rb
 - lib/eazypi/serializer.rb
 - lib/eazypi/server.rb
 - lib/eazypi/spec_object.rb
+- lib/eazypi/tag.rb
 - lib/eazypi/version.rb
 homepage: https://gitlab.com/nathansamson/eazypi/-/blob/main/README.md
 licenses:
@@ -94,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: An opinionated framework to generate OpenAPI API's for Rails