apia 3.5.1 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 655dd00a146e4b25e600c926b0b57f160b8eb22d5908f0a7617c5c69d2781867
-  data.tar.gz: 57e7d53b19ed835966326bea22228b873218865505823ebf5cc13c3694274d30
+  metadata.gz: 3488b6d92d65ff71eff5ec22b944622042981311d6a7505fc09578093a9e4402
+  data.tar.gz: aff3ff29a9674a4eb622e91a89e74d380e11728e683407e3e9bc1546641ea483
 SHA512:
-  metadata.gz: 16961608a1f749b7dea60e91b26a475fe2079f1c80b0535216a2a4551d8d481298733b33c304d6c6e2dd2811f253011d991fc234e42186e945f778ff7f595738
-  data.tar.gz: b611dd81deba0c3114af55c1fd3a8605ae5a4eb746730ba1d19b27f7b95302857962abbc2e7e2c7f7c4b59f4b1cf7bfffc87a440db3f396c350be4b9eb8f3d0a
+  metadata.gz: 749d596efa11efc2965952a4ae2fc6af4c62fb9189e1839675ca3e00040fb4c4a99ab888d2e1589b546b002434e019735c1896398d494404d8cc7bd8a7e6f944
+  data.tar.gz: 682ff1cf40fe2399ae2754ef9e78388282cfe8c28b38b7153425565ab568084826d7d49fccdbaf5a539e80bd4b4cfa79e1b968258ebb5e23525f14b4d3051c58

data/lib/apia/definitions/endpoint.rb

@@ -14,6 +14,7 @@ module Apia
       attr_accessor :authenticator
       attr_accessor :action
       attr_accessor :http_status
+      attr_accessor :response_type
       attr_accessor :paginated_field
       attr_reader :fields
       attr_reader :scopes
@@ -21,6 +22,7 @@ module Apia
       def setup
         @fields = FieldSet.new
         @http_status = 200
+        @response_type = Apia::Response::JSON
         @scopes = []
       end
 

data/lib/apia/dsls/endpoint.rb

@@ -40,6 +40,10 @@ module Apia
         @definition.http_status = status
       end
 
+      def response_type(type)
+        @definition.response_type = type
+      end
+
       def field(name, *args, type: nil, **options, &block)
         if @definition.fields_overriden?
           raise Apia::StandardError, 'Cannot add fields to an endpoint that has a separate fieldset'

data/lib/apia/rack.rb

@@ -152,6 +152,16 @@ module Apia
 
     class << self
 
+      # Return a plain text triplet for the given body.
+      #
+      # @param body [String]
+      # @param status [Integer]
+      # @param headers [Hash]
+      # @return [Array]
+      def plain_triplet(body, status: 200, headers: {})
+        response_triplet(body, content_type: Apia::Response::PLAIN, status: status, headers: headers)
+      end
+
       # Return a JSON-ready triplet for the given body.
       #
       # @param body [Hash, Array]
@@ -159,11 +169,24 @@ module Apia
       # @param headers [Hash]
       # @return [Array]
       def json_triplet(body, status: 200, headers: {})
-        body_as_json = body.to_json
+        response_triplet(body.to_json, content_type: Apia::Response::JSON, status: status, headers: headers)
+      end
+
+      # Return a triplet for the given body.
+      #
+      # @param body [Hash, Array]
+      # @param content_type [String]
+      # @param status [Integer]
+      # @param headers [Hash]
+      # @return [Array]
+      def response_triplet(body, content_type:, status: 200, headers: {})
+        content_length = body.bytesize.to_s
+        body = [body] unless body.respond_to?(:each)
+
         [
           status,
-          headers.merge('content-type' => 'application/json', 'content-length' => body_as_json.bytesize.to_s),
-          [body_as_json]
+          headers.merge('content-type' => content_type, 'content-length' => content_length),
+          body
         ]
       end
 

data/lib/apia/response.rb

@@ -6,6 +6,11 @@ require 'apia/rack'
 module Apia
   class Response
 
+    TYPES = [
+      JSON = 'application/json',
+      PLAIN = 'text/plain'
+    ].freeze
+
     attr_accessor :status
     attr_reader :fields
     attr_reader :headers
@@ -16,10 +21,18 @@ module Apia
       @endpoint = endpoint
 
       @status = @endpoint.definition.http_status_code
+      @type = @endpoint.definition.response_type
       @fields = {}
       @headers = {}
     end
 
+    def plain_text_body(body)
+      warn '[DEPRECATION] `plain_text_body` is deprecated. Please set use `response_type` in the endpoint definition, and set the response `body` directly instead.'
+
+      @type = PLAIN
+      @body = body
+    end
+
     # Add a field value for this endpoint
     #
     # @param name [Symbol]
@@ -57,7 +70,12 @@ module Apia
     #
     # @return [Array]
     def rack_triplet
-      Rack.json_triplet(body, headers: @headers, status: @status)
+      case @type
+      when JSON
+        Rack.json_triplet(body, headers: headers, status: status)
+      when PLAIN
+        Rack.plain_triplet(body, headers: headers, status: status)
+      end
     end
 
   end

data/lib/apia/version.rb

@@ -2,6 +2,6 @@
 
 module Apia
 
-  VERSION = '3.5.1'
+  VERSION = '3.7.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apia
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 3.7.0
 platform: ruby
 authors:
 - Adam Cooke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-09 00:00:00.000000000 Z
+date: 2024-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -185,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: This gem provides a friendly DSL for constructing HTTP APIs.