eazypi 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 344baf3f0f1dacd826dae2caf2aeda6172c78dcd72c4b5a3a8e05f691ccf1a4e
-  data.tar.gz: 5ac7965a5e48ad5962dfbce582a61c54d72c19f5ac0740d2c5cea4e8020f905f
+  metadata.gz: 3039b06d210f7a865957a6eb86b1946e0a7ae2ea63091ada95eed28ad47e8a7b
+  data.tar.gz: c5b7ad7943c65cb84eb94b27c6c0b63978bc03f42b14b140df9b52f0caebe24d
 SHA512:
-  metadata.gz: 2bf75cf26c5890e8749311e3a65b32d2bd6d8834bbc54e8da77b828b8bbeb32d0e49aa33deda42cb31b733472d4def0044f3a4ef6f69aafa9fae0584952efd39
-  data.tar.gz: a41d5f22d742e653409a362d58cdf82684b1ded4b671400adf7f184b768eec3acb44f2ec4d9d7f2049c918d9806d8eab355012907576fc4ea470f56c4d62b90a
+  metadata.gz: 184707f28d37b10fea94dd4c245dc5143e484b22b089061b3d9efe8cea7b2e48edf38f238dc07dd9fdda728520e482689d505571998c3e52b20913fa828254f6
+  data.tar.gz: 00011c9d53005e80ada9eabf45fc4ce98fde60160fb418048a5dd46852ed8db8ee0d4d2c97455605229651d98ed1ce680a70f8a1979382733e66c1853337ad15

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

@@ -5,6 +5,7 @@ module Eazypi
   module ApiController
     def self.included(base)
       base.instance_variable_set(:@operations, [])
+      base.include(InstanceMethods)
       base.extend(ClassMethods)
     end
 
@@ -53,5 +54,16 @@ module Eazypi
         controller_method_name
       end
     end
+
+    # Instance methods to be used in your own API controller
+    module InstanceMethods
+      def respond_with(object, status: :ok)
+        response_type = @current_operation.response_for_response_code(status)
+
+        response_object_type = response_type.object_type_for_content_type
+
+        render json: Serializer.serialize_object(response_object_type, object), status: status
+      end
+    end
   end
 end

data/lib/eazypi/operation.rb

@@ -44,11 +44,18 @@ module Eazypi
       @responses.add_response(status_code, &block)
     end
 
+    def response_for_response_code(response_code)
+      response_code = Rack::Utils::SYMBOL_TO_STATUS_CODE[response_code] if response_code.is_a?(Symbol)
+
+      @responses.response_for_response_code(response_code)
+    end
+
     def render(&block)
       @renderer = block
     end
 
     def call(controller)
+      controller.instance_variable_set(:@current_operation, self)
       controller.instance_exec(&@renderer)
     end
 

data/lib/eazypi/response.rb

@@ -9,6 +9,7 @@ module Eazypi
 
     def initialize
       @content = {}
+      @object_type = {}
 
       super
     end
@@ -23,6 +24,11 @@ module Eazypi
       end
 
       @content[content_type] = media_type
+      @object_type[content_type] = schema
+    end
+
+    def object_type_for_content_type(content_type = "application/json")
+      @object_type[content_type]
     end
 
     def collect_components(**kwargs)

data/lib/eazypi/responses.rb

@@ -14,6 +14,11 @@ module Eazypi
       @responses[status_code.to_s] = response
     end
 
+    def response_for_response_code(response_code)
+      # Future improvement could be partial match
+      @responses[response_code.to_s]
+    end
+
     def collect_components(**kwargs)
       @responses.each_value do |response|
         response.collect_components(**kwargs)

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,6 +49,8 @@ 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
@@ -65,5 +83,19 @@ module Eazypi
         schema
       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 [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.2"
+  VERSION = "0.0.4"
 end

metadata

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