reynard 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d703f01c7c60de48b48ae223cd9c2e3a94a8639bb866eca234298331ad746d2a
-  data.tar.gz: 9e88b9e21dc1b1d00357fcf8bdf2b6952676c5237369d7d950e97b379727e731
+  metadata.gz: 95ca8eb7744c1550bfcf705a92d97331d9c558b08dec5f2369b166b285b38edc
+  data.tar.gz: a140a0dbe5f74c95f43d2aa785dd3c96a322eab2893b2d8a629abd3b9859724e
 SHA512:
-  metadata.gz: b1cccaf532a955569236a07c5c8861519cf58c0c2abe3cdf218a8a57619a41d650e9f7226ccdb1a6ef1fddfe412cd9780032dcf8f68ecf995cd2176bb8774642
-  data.tar.gz: 56acfbbabfea8a77e76cbee676bd0b397a608994f03f774022fd54d4e65fad06730de36aa9b122767edddb229f854eff9e8819d8a93d506ee5af66d799d18e82
+  metadata.gz: 77148ca6897e1e7b0479348cfe536ff94afc5c1741b6fe59afea7940b442d7c46a71914868f572f3588b7d85d95f38446bd8d28885a22a032c91a86e71e3da28
+  data.tar.gz: eab59f1738c99af0f2c8fba6a4fb09f15a5a26f31f86de91125d9f299d2d50844060bd3c13db33b260f267a82e269175e0c69d2cdeb4f32d397e99bca74e9694

data/README.md

@@ -51,7 +51,7 @@ reynard.base_url(base_url)
 Assuming there is an operation called `employeeByUuid` you can it as shown below.
 
 ```ruby
-employee = reynard.
+response = reynard.
   operation('employeeByUuid').
   params(uuid: uuid).
   execute
@@ -60,12 +60,27 @@ employee = reynard.
 When an operation requires a body, you can add it as structured data.
 
 ```ruby
-employee = reynard.
+response = reynard.
   operation('createEmployee').
   body(name: 'Sam Seven').
   execute
 ```
 
+In case the response matches a response in the specification it will attempt to build an object using the specified schema.
+
+```ruby
+response.object.name #=> 'Sam Seven'
+```
+
+The response object shared much of its interface with `Net::HTTP::Response`.
+
+```ruby
+response.code #=> '200'
+response.content_type #=> 'application/json'
+response['Content-Type'] #=> 'application/json'
+response.body #=> '{"name":"Sam Seven"}'
+```
+
 ## Mocking
 
 You can mock Reynard requests by changing the HTTP implementation. The class **must** implement a single `request` method that accepts an URI and net/http request object. It **must** return a net/http response object or an object with the exact same interface.

data/lib/reynard/context.rb

@@ -43,7 +43,7 @@ class Reynard
     end
 
     def execute
-      build_object(build_request.perform)
+      build_response(build_request.perform)
     end
 
     private
@@ -63,32 +63,12 @@ class Reynard
       Reynard::Http::Request.new(request_context: @request_context)
     end
 
-    def build_object(http_response)
-      media_type = @specification.media_type(
-        @request_context.operation.node,
-        http_response.code,
-        http_response.content_type
-      )
-      if media_type
-        build_object_with_media_type(http_response, media_type)
-      else
-        build_object_without_media_type(http_response)
-      end
-    end
-
-    def build_object_with_media_type(http_response, media_type)
-      ObjectBuilder.new(
-        media_type: media_type,
-        schema: @specification.schema(media_type.node),
+    def build_response(http_response)
+      Reynard::Http::Response.new(
+        specification: @specification,
+        request_context: @request_context,
         http_response: http_response
-      ).call
-    end
-
-    def build_object_without_media_type(http_response)
-      # Try to parse the response as JSON and give up otherwise.
-      OpenStruct.new(MultiJson.load(http_response.body))
-    rescue StandardError
-      http_response.body
+      )
     end
   end
 end

data/lib/reynard/http/response.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+class Reynard
+  class Http
+    # Wraps an HTTP response and returns an object when it can find a definition for the response
+    # in the specification.
+    class Response
+      extend Forwardable
+      def_delegators :@http_response, :code, :content_type, :[], :body
+
+      def initialize(specification:, request_context:, http_response:)
+        @specification = specification
+        @request_context = request_context
+        @http_response = http_response
+      end
+
+      # Instantiates an object based on the schema that fits the response.
+      def object
+        return @object if defined?(@object)
+
+        @object = build_object
+      end
+
+      private
+
+      def build_object
+        media_type = @specification.media_type(
+          @request_context.operation.node,
+          @http_response.code,
+          @http_response.content_type
+        )
+        if media_type
+          build_object_with_media_type(media_type)
+        else
+          build_object_without_media_type
+        end
+      end
+
+      def build_object_with_media_type(media_type)
+        ObjectBuilder.new(
+          media_type: media_type,
+          schema: @specification.schema(media_type.node),
+          http_response: @http_response
+        ).call
+      end
+
+      def build_object_without_media_type
+        # Try to parse the response as JSON and give up otherwise.
+        OpenStruct.new(MultiJson.load(@http_response.body))
+      rescue StandardError
+        @http_response.body
+      end
+    end
+  end
+end

data/lib/reynard/http.rb

@@ -3,5 +3,6 @@
 class Reynard
   class Http
     autoload :Request, 'reynard/http/request'
+    autoload :Response, 'reynard/http/response'
   end
 end

data/lib/reynard/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Reynard
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reynard
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Manfred Stienstra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-05 00:00:00.000000000 Z
+date: 2021-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -124,6 +124,7 @@ files:
 - lib/reynard/grouped_parameters.rb
 - lib/reynard/http.rb
 - lib/reynard/http/request.rb
+- lib/reynard/http/response.rb
 - lib/reynard/media_type.rb
 - lib/reynard/model.rb
 - lib/reynard/models.rb
@@ -139,7 +140,8 @@ files:
 homepage: https://github.com/Manfred/reynard
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths: