eazypi 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfe47c3c3c7c8c3ac25c0d67311957fb2672599ea81f48e6247f82b9fae6710b
-  data.tar.gz: 436ec6c096a12482add4ac1a0245b4c555e254fd3be329ba9549e6b1422a1154
+  metadata.gz: 38e9def08b7d5d8f9a3221b7fa25472cca0833efe5ae0cda8ae96ae0332009e8
+  data.tar.gz: df904e67baef641dbc1cc88f3f11cbf9f7474c2c291059fdfcaaa73feb3f7d14
 SHA512:
-  metadata.gz: f849fdc4f64b2471955dcf1b8517e6bd445d2285b646384c6081b6aa9ffb87d78e9be72a093c4731436ea6fd4340561a2b1aa89886cdb3e53f0c8007bfd704d6
-  data.tar.gz: 62e8ba592f52624d36bedba28e96f463956c6ae3cb16e1aa2d89acfc060459bc897d2034bdfa8e7423b7222104f0f4bca0acdbe4729358d821abc9d3cf5a91ce
+  metadata.gz: 5b6de60965569128c00d205656afd44b45caf9556e1cc0314ac86524d91f7173dfacb08462eb908d77a57a0fa16b474ecd04d2033afe59264ae3583b29feaa95
+  data.tar.gz: d0627af90001cd495935603a04a0f249f7bc98842cdd395139f1ae0f898071bd1104d74157d227b654bb869b7d5e1dd39487160932c58f652b862a9f98bbdcbe

data/README.md

@@ -46,17 +46,95 @@ class Api::V1::Example
 end
 ~~~
 
+## Define API Objects
+
+Define API objects, they can be used with parameter objects and/or content objects in a controller
+
+~~~
+class Api::V1::Example
+  include Eazypi::Serializer
+
+  attribute :id, type: String, required: true
+  attribute :name, type: String, required: true
+end
+~~~
+
+More advanced attribute types are also possible
+
+~~~
+class Api::V1::Child
+  include Eazypi::Serializer
+
+  attribute :id, type: String, required: true
+  attribute :name, type: String, required: true
+
+  attribute :alternative_names, type: [String], required: false
+end
+
+class Api::V1::ExampleWithChildren
+  include Eazypi::Serializer
+
+  attribute :id, type: String, required: true
+  attribute :name, type: String, required: true
+
+  attribute :children, type: [Child], required: false
+end
+~~~
+
 ### Create a controller Class
 
 Create a normal rails controller and use the DSL to define operations.
 
 ~~~
 class Api::V1::ExampleController
+  include include Eazypi::ApiController
+
   operation :get, '/examples' do
-    response 200, [String]
+    parameter :filter do # By default a query parameter if it doesn't match a path parameter
+      description "Filter examples
+
+      schema FilterExample
+    end
+
+    response 200 do
+      description "Example"
+
+      content [API::V1::Example] # Example is defined as API Object (see above for example)
+    end
 
     render do
-      render json: { examples: ['A', 'B'] }
+      examples = ... # Examples is array of class Example NOT API::V1::Example
+      respond_with examples
+    end
+  end
+
+  operation :get, '/example/:id' do
+    parameter :id do # Example of path parameter
+      description "Id of the pet you want to find"
+
+      schema String # Only primitive types (String, Integer, Float) are allowed in path parameters
+    end
+
+    response 200 do
+      description "Example"
+
+      content API::V1::Example # Example is defined as API Object (see above for example)
+    end
+
+    response 404 do
+      description "Not found"
+
+      content API::V1::Error
+    end
+
+    render do
+      example = Example.find_by(params[:id]) # Note Example here is ActiveRecord Object, not the API view of it
+
+      if example
+        respond_with example # Will serialize example object
+      else
+        respond_with Error.new(message: "Not found"), status: :not_found # Will automatically serialize Error object
+      end
     end
   end
 end

data/lib/eazypi/api_controller.rb

@@ -62,11 +62,7 @@ module Eazypi
 
         response_object_type = response_type.object_type_for_content_type
 
-        if response_object_type.nil?
-          render json: nil, status: status
-        else
-          render json: response_type.object_type_for_content_type.new(object).to_json, status: status
-        end
+        render json: Serializer.serialize_object(response_object_type, object), status: status
       end
     end
   end

data/lib/eazypi/components.rb

@@ -8,7 +8,8 @@ module Eazypi
     end
 
     def add_schema(name, schema)
-      @schemas[name] = schema.dup # Make sure it never gets a reference
+      # Make sure it never gets a changed copy + never gets overwritten
+      @schemas[name] = schema.dup unless @schemas.key?(name)
 
       "#/components/schemas/#{name}"
     end

data/lib/eazypi/schema/array.rb

@@ -10,8 +10,10 @@ module Eazypi
         @item_schema = item_schema
       end
 
-      def collect_components(schemas: nil, **_kwargs)
+      def collect_components(schemas: nil, **kwargs)
         schemas&.call(@item_schema)
+
+        @item_schema.collect_components(schemas: schemas, **kwargs)
       end
 
       def to_openapi_spec

data/lib/eazypi/schema/object.rb

@@ -15,6 +15,7 @@ module Eazypi
 
       def reference!(reference)
         @reference = reference
+        self
       end
 
       def property(name, schema, required: false)

data/lib/eazypi/schema.rb

@@ -3,21 +3,29 @@
 module Eazypi
   # JSON schema
   module Schema
-    def self.from_object(object) # rubocop:todo Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize
+    def self.from_object(object, parent = nil) # rubocop:todo Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize
       if object == :boolean
         Schema::Primitive.new(type: "boolean")
       elsif object.is_a?(::Array)
         raise "Array needs to have one element" if object.length != 1
 
-        Schema::Array.new(Schema.from_object(object[0]))
+        Schema::Array.new(Schema.from_object(object[0], parent))
       elsif object == String
         Schema::Primitive.new(type: "string")
+      elsif object == Date
+        Schema::Primitive.new(type: "string", format: "date")
+      elsif object == Time
+        Schema::Primitive.new(type: "string", format: "date-time")
       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
+        if object == parent
+          object.to_schema_reference
+        else
+          object.to_schema
+        end
       else
         raise "Can not convert #{object} to a schema"
       end

data/lib/eazypi/serializer.rb

@@ -18,6 +18,22 @@ module Eazypi
       end
 
       def serialize(object)
+        the_value = value(object)
+
+        Serializer.serialize_object(type, the_value)
+      end
+
+      private
+
+      def serialize_array(the_value)
+        return the_value if self.class.primitive_type?(type[0])
+
+        the_value.map do |element_value|
+          type[0].new(element_value).to_json
+        end
+      end
+
+      def value(object)
         if @method
           @method.call(object)
         elsif @method_name
@@ -33,12 +49,14 @@ module Eazypi
     end
 
     def to_json(*_args)
+      return nil if @object.nil?
+
       self.class.attributes.to_h do |attribute|
         [attribute.name, attribute.serialize(@object)]
       end
     end
 
-    included do
+    included do # rubocop:disable Metrics/BlockLength
       @attributes = []
 
       def self.attribute(attribute_name, type:, method: nil, method_name: nil, required: false)
@@ -56,14 +74,38 @@ module Eazypi
       end
 
       def self.to_schema
-        schema = Schema::Object.new(name.split("::").last)
+        schema = Schema::Object.new(object_name)
 
         @attributes.each do |attribute|
-          schema.property attribute.name.to_s, Schema.from_object(attribute.type), required: attribute.required
+          schema.property attribute.name.to_s, Schema.from_object(attribute.type, self), required: attribute.required
         end
 
         schema
       end
+
+      def self.to_schema_reference
+        Schema::Object.new(object_name).reference!("#/components/schemas/#{object_name}")
+      end
+
+      def self.object_name
+        name.split("::").last
+      end
+    end
+
+    def self.serialize_object(type_object, object) # rubocop:disable Metrics/MethodLength
+      if type_object.nil?
+        nil
+      elsif type_object.is_a?(Array)
+        object&.map do |value|
+          serialize_object(type_object[0], value)
+        end
+      elsif [Date, Time].include?(type_object)
+        object&.iso8601
+      elsif [String, Integer, Float].include?(type_object)
+        object
+      else
+        type_object.new(object).to_json
+      end
     end
   end
 end

data/lib/eazypi/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eazypi
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Nathan Samson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-06 00:00:00.000000000 Z
+date: 2024-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack