apia 3.6.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d20a8612da20a33fb3df02632c88c71be48a6bb8741e599257526eb95b8fab8
-  data.tar.gz: 62b60c3afadb025f22d460bfed84c6fcbae83a9189a51c39d00d4eedde94c72a
+  metadata.gz: 3488b6d92d65ff71eff5ec22b944622042981311d6a7505fc09578093a9e4402
+  data.tar.gz: aff3ff29a9674a4eb622e91a89e74d380e11728e683407e3e9bc1546641ea483
 SHA512:
-  metadata.gz: 861c7382e3a4b0d2f14af9e20379b14338b7aa4acf93e3c0b3ebda438d8c010d371a1c9e088caa1cc321d22261e201d994acc6346a20948f14b10a6edef8fe18
-  data.tar.gz: 8c8b32ca974212bfaf1df295cd59b3154ef92f810385b772e57b75dced6b0de2cc31d9214382152c255ad06debe40652374c2d94d56d02c1fc5792c5fcd469f4
+  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

@@ -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,15 +66,11 @@ module Apia
       @body || hash
     end
 
-    def type
-      @type || JSON
-    end
-
     # Return the rack triplet for this response
     #
     # @return [Array]
     def rack_triplet
-      case type
+      case @type
       when JSON
         Rack.json_triplet(body, headers: headers, status: status)
       when PLAIN

data/lib/apia/version.rb

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

metadata

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