apia 3.5.1 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 655dd00a146e4b25e600c926b0b57f160b8eb22d5908f0a7617c5c69d2781867
-  data.tar.gz: 57e7d53b19ed835966326bea22228b873218865505823ebf5cc13c3694274d30
+  metadata.gz: 3d20a8612da20a33fb3df02632c88c71be48a6bb8741e599257526eb95b8fab8
+  data.tar.gz: 62b60c3afadb025f22d460bfed84c6fcbae83a9189a51c39d00d4eedde94c72a
 SHA512:
-  metadata.gz: 16961608a1f749b7dea60e91b26a475fe2079f1c80b0535216a2a4551d8d481298733b33c304d6c6e2dd2811f253011d991fc234e42186e945f778ff7f595738
-  data.tar.gz: b611dd81deba0c3114af55c1fd3a8605ae5a4eb746730ba1d19b27f7b95302857962abbc2e7e2c7f7c4b59f4b1cf7bfffc87a440db3f396c350be4b9eb8f3d0a
+  metadata.gz: 861c7382e3a4b0d2f14af9e20379b14338b7aa4acf93e3c0b3ebda438d8c010d371a1c9e088caa1cc321d22261e201d994acc6346a20948f14b10a6edef8fe18
+  data.tar.gz: 8c8b32ca974212bfaf1df295cd59b3154ef92f810385b772e57b75dced6b0de2cc31d9214382152c255ad06debe40652374c2d94d56d02c1fc5792c5fcd469f4

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: 'text/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: 'application/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 = :json,
+      PLAIN = :plain
+    ].freeze
+
     attr_accessor :status
     attr_reader :fields
     attr_reader :headers
@@ -20,6 +25,11 @@ module Apia
       @headers = {}
     end
 
+    def plain_text_body(body)
+      @type = PLAIN
+      @body = body
+    end
+
     # Add a field value for this endpoint
     #
     # @param name [Symbol]
@@ -53,11 +63,20 @@ module Apia
       @body || hash
     end
 
+    def type
+      @type || JSON
+    end
+
     # Return the rack triplet for this response
     #
     # @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.6.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apia
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 3.6.0
 platform: ruby
 authors:
 - Adam Cooke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-09 00:00:00.000000000 Z
+date: 2024-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json