rest_api_builder 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d4b9b80449e04e159ccee0755d38f257bea23151ab22f75bfff6898d4f654f2
-  data.tar.gz: ca2ccdfc23f2b711c4111db218e50286c60d11b0d58e1a89eb24b1fbc02dcebf
+  metadata.gz: a164d75c362c383c5fb6c093f936cae3859143a5bffd3e59d833adcf686a7875
+  data.tar.gz: 3a7cb13ef985522132219e0d753c2a04867792325ac38927c48d737198e9360d
 SHA512:
-  metadata.gz: b7c67011fc8bb6aca7e9929df9d68efc163e037ec009baa7b306cde638ae7f1d524132886885f70b57e938f2f8444a011f05d5311a645bbec11b68fa6f491d85
-  data.tar.gz: f475fee5f2ccf4f23b601858663abe3d770fc9a1af0a1cc7e8098f0f1082e8b4e57dd0c58b47d340db322adaa7407a67af8f6cc9929aca4bf64d876d8b279a14
+  metadata.gz: e708b1b6b6635db0840387320699b0ada62547e0f408d68ac484249da8cf4c92766f3dd6dac372f041db6e3bcc5ca658f822dbf6caa4f4bf7416da56f773d4c6
+  data.tar.gz: 5641d558c45f78b10422b253e49f7b0737d840f0d7dbb28c5386a49c6435d2e5fa08d6f0ae22463f6df872f9e42cb2164bd502613c4e1713635619ec3fa34403

data/README.md

@@ -133,6 +133,7 @@ Does not throw on non-200 responses like RestClient does, but will throw on any
 * **query**: Query hash to be appended to the resulting url. Optional.
 * **logger**: A `Logger` instance to be passed to RestClient in `log` option. Will also log response details as RestClient does not do this by default. Optional
 * **parse_json**: Boolean. If `true`, will attempt to parse the response body as JSON. Will return the response body unchanged if it does not contain valid JSON. `false` by default.
+* **raw_response**: Boolean. If `true`, the response returned by RestClient will not be parsed into {:status, :body, :headers}, but instead returned as {:raw_response}. `false` by default.
 * **rest_client_options**: Any additional options to be passed to `RestClient::Request.execute` unchanged. **Any option set here will completely overwrite all custom options**. For example, if you call `RestAPIBuilder::Request.execute(method: :post, rest_client_options: {method: :get})`, the resulting request will be sent as GET. Optional.
 
 ### RestAPIBuilder::Request.json_execute(options)

data/lib/rest_api_builder/request.rb

@@ -21,13 +21,18 @@ module RestAPIBuilder
       path: nil,
       logger: nil,
       parse_json: false,
+      raw_response: false,
       rest_client_options: {}
     )
       if method == :get && body
         raise ArgumentError, 'GET requests do not support body'
       end
 
-      response_parser = RestAPIBuilder::RestClientResponseParser.new(logger: logger, parse_json: parse_json)
+      response_parser = RestAPIBuilder::RestClientResponseParser.new(
+        logger: logger,
+        parse_json: parse_json,
+        raw_response: raw_response
+      )
       headers = headers.merge(params: query) if query
 
       begin

data/lib/rest_api_builder/rest_client_response_parser.rb

@@ -2,13 +2,17 @@ require 'json'
 
 module RestAPIBuilder
   class RestClientResponseParser
-    def initialize(logger:, parse_json:)
+    def initialize(logger:, parse_json:, raw_response:)
       @logger = logger
       @parse_json = parse_json
+      @raw_response = raw_response
     end
 
     def parse_response(response, success:)
+      return { success: success, raw_response: response } if @raw_response
+
       body = @parse_json ? parse_json(response.body) : response.body
+
       result = {
         success: success,
         status: response.code,

data/rest_api_builder.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'rest_api_builder'
-  s.version     = '0.0.3'
+  s.version     = '0.0.4'
   s.summary     = "A simple wrapper for rest-client"
   s.description = "A simple wrapper for rest-client aiming to make creation and testing of API clients easier."
   s.authors     = ["Alexey D"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_api_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Alexey D
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-23 00:00:00.000000000 Z
+date: 2020-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop