apia 3.6.0 → 3.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d20a8612da20a33fb3df02632c88c71be48a6bb8741e599257526eb95b8fab8
-  data.tar.gz: 62b60c3afadb025f22d460bfed84c6fcbae83a9189a51c39d00d4eedde94c72a
+  metadata.gz: 3ca83d2cf83582c065e6af3a0ee926956ef3be223c0855103ee3df4a1bb5cd06
+  data.tar.gz: b6c384351af2236c7755c64e4b6c138594967079d6cb67587420f7773d64666f
 SHA512:
-  metadata.gz: 861c7382e3a4b0d2f14af9e20379b14338b7aa4acf93e3c0b3ebda438d8c010d371a1c9e088caa1cc321d22261e201d994acc6346a20948f14b10a6edef8fe18
-  data.tar.gz: 8c8b32ca974212bfaf1df295cd59b3154ef92f810385b772e57b75dced6b0de2cc31d9214382152c255ad06debe40652374c2d94d56d02c1fc5792c5fcd469f4
+  metadata.gz: 6ec614a5e14c0b146f1deb03e9193b3aad0a9f3e093f8b4fef298bc4e258308396c7d7ace3a3518b71b299b69ca202518ccd4edc957ab0014628643d46fc2740
+  data.tar.gz: 994a2a935d9c78da37e88f983b4e2e2466f229fba9801615a07f87a52ea3196fe49405311a56e481810c812efee6f342e7d92d133c6a9c292843af6a674f34f9

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/definitions/error.rb

@@ -37,7 +37,7 @@ module Apia
       # API.
       #
       # @param errors [Apia::ManifestErrors]
-      # @reeturn [void]
+      # @return [void]
       def validate(errors)
         unless code.is_a?(Symbol)
           errors.add self, 'InvalidCode', 'Code must be a symbol'

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

@@ -159,7 +159,7 @@ module Apia
       # @param headers [Hash]
       # @return [Array]
       def plain_triplet(body, status: 200, headers: {})
-        response_triplet(body, content_type: 'text/plain', status: status, headers: headers)
+        response_triplet(body, content_type: Apia::Response::PLAIN, status: status, headers: headers)
       end
 
       # Return a JSON-ready triplet for the given body.
@@ -169,7 +169,7 @@ module Apia
       # @param headers [Hash]
       # @return [Array]
       def json_triplet(body, status: 200, headers: {})
-        response_triplet(body.to_json, content_type: 'application/json', status: status, headers: headers)
+        response_triplet(body.to_json, content_type: Apia::Response::JSON, status: status, headers: headers)
       end
 
       # Return a triplet for the given body.

data/lib/apia/response.rb

@@ -7,8 +7,8 @@ module Apia
   class Response
 
     TYPES = [
-      JSON = :json,
-      PLAIN = :plain
+      JSON = 'application/json',
+      PLAIN = 'text/plain'
     ].freeze
 
     attr_accessor :status
@@ -21,11 +21,14 @@ 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
@@ -63,19 +66,18 @@ module Apia
       @body || hash
     end
 
-    def type
-      @type || JSON
-    end
-
     # Return the rack triplet for this response
     #
     # @return [Array]
     def rack_triplet
-      case type
-      when JSON
-        Rack.json_triplet(body, headers: headers, status: status)
-      when PLAIN
+      # Errors will always be sent as a hash intended for JSON encoding,
+      # even if the endpoint specifies a plain text response, so only
+      # send a pain response if the type is plaintext _and_ the body is
+      # a string
+      if @type == PLAIN && body.is_a?(String)
         Rack.plain_triplet(body, headers: headers, status: status)
+      else
+        Rack.json_triplet(body, headers: headers, status: status)
       end
     end
 

data/lib/apia/version.rb

@@ -2,6 +2,6 @@
 
 module Apia
 
-  VERSION = '3.6.0'
+  VERSION = '3.7.1'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apia
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 3.7.1
 platform: ruby
 authors:
 - Adam Cooke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-17 00:00:00.000000000 Z
+date: 2024-05-21 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.