reynard 0.0.4 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73e8e17f725539aac5739311c093ac8ff851eab5c9bc3016cdd3839b29cdcc8b
-  data.tar.gz: a8fc3ba0731ad45a5f92324d819d84b7bf5fb418d8f4eb3751b5a7b2814b6a19
+  metadata.gz: fcfd5e665e0b3fcc8c593d81c15db9560e8abc0125e9a254aeb98d3f53b6fb8a
+  data.tar.gz: 61d7d812f5b5eacf55c9be3fb6463cf1adafeb5e7935d2d0fc0b20a33a4a27b3
 SHA512:
-  metadata.gz: e6b03cde95bd0bf69a03f860d3eaa57bf9d39f1deb6c9abfd719d4fdbaec728f1c8d5a2485493e5b403cdd0b57a80784c3dd48c02eef5d957eaf7638cacf91b0
-  data.tar.gz: f56a52f52d041ce58b69e1d799072510131a4f471560a908b24bb1e01630ef1e971d07e1b88845fae298e90e1d9f6f6dc1ad7990375c35d9c0ae357c69644a0c
+  metadata.gz: 05a42b85120cb3e519c4fcc3bad7c23a17e5c1a007072b22843421619b1460dabf378750fc83eea406a44a3ec0e08c80b309d53bdce2da0df09d6f3a67643685
+  data.tar.gz: d8e2ce1c77b097a4a3e4a64d8b3fd2d67bc0e8737307e9429452e4d794aedad7c34e7b44a76a1f4ac945f459a4f0497e67d354ebb37f2cb1fdece9e187981efd

data/README.md

@@ -57,6 +57,15 @@ employee = reynard.
   execute
 ```
 
+When an operation requires a body, you can add it as structured data.
+
+```ruby
+employee = reynard.
+  operation('createEmployee').
+  body(name: 'Sam Seven').
+  execute
+```
+
 ## Copyright and other legal
 
 See LICENCE.

data/lib/reynard/context.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'ostruct'
+
 class Reynard
   # Exposes a public interface to build a request context.
   class Context
@@ -24,8 +26,20 @@ class Reynard
       copy(params: @specification.build_grouped_params(@request_context.operation.node, params))
     end
 
+    def body(data)
+      return unless @request_context.operation
+
+      serialized_body = @specification.build_body(@request_context.operation.node, data)
+      return unless serialized_body
+
+      copy(
+        headers: @request_context.headers.merge(serialized_body.headers),
+        body: serialized_body.to_s
+      )
+    end
+
     def headers(headers)
-      copy(headers: headers)
+      copy(headers: @request_context.headers.merge(headers))
     end
 
     def execute
@@ -35,7 +49,7 @@ class Reynard
     private
 
     def build_request_context
-      RequestContext.new(base_url: @specification.default_base_url)
+      RequestContext.new(base_url: @specification.default_base_url, headers: {})
     end
 
     def copy(**properties)
@@ -55,11 +69,26 @@ class Reynard
         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),
         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/request.rb

@@ -26,6 +26,12 @@ class Reynard
           build_http_get
         when 'post'
           build_http_post
+        when 'put'
+          build_http_put
+        when 'patch'
+          build_http_patch
+        when 'delete'
+          build_http_delete
         end
       end
 
@@ -38,6 +44,22 @@ class Reynard
         post.body = @request_context.body
         post
       end
+
+      def build_http_put
+        put = Net::HTTP::Put.new(uri, @request_context.headers)
+        put.body = @request_context.body
+        put
+      end
+
+      def build_http_patch
+        patch = Net::HTTP::Patch.new(uri, @request_context.headers)
+        patch.body = @request_context.body
+        patch
+      end
+
+      def build_http_delete
+        Net::HTTP::Delete.new(uri, @request_context.headers)
+      end
     end
   end
 end

data/lib/reynard/request_context.rb

@@ -7,6 +7,7 @@ class Reynard
     :operation,
     :headers,
     :params,
+    :body,
     keyword_init: true
   ) do
     def verb

data/lib/reynard/serialized_body.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class Reynard
+  # Serializes a request body and returns headers appropriate for the request.
+  class SerializedBody
+    def initialize(content, data)
+      @content = content
+      @data = data
+    end
+
+    def content_type
+      'application/json'
+    end
+
+    def headers
+      { 'Content-Type' => content_type }
+    end
+
+    def to_s
+      MultiJson.dump(@data)
+    end
+  end
+end

data/lib/reynard/specification.rb

@@ -33,6 +33,12 @@ class Reynard
       GroupedParameters.new(dig(*operation_node, 'parameters'), params).to_h
     end
 
+    # Returns a serialized body instance to serialize a request body and figure out the request
+    # headers.
+    def build_body(operation_node, data)
+      SerializedBody.new(dig(*operation_node, 'requestBody', 'content'), data)
+    end
+
     def operation(operation_name)
       dig('paths').each do |path, operations|
         operations.each do |verb, operation|
@@ -44,7 +50,7 @@ class Reynard
 
     def media_type(operation_node, response_code, media_type)
       responses = dig(*operation_node, 'responses')
-      response_code = responses.key?(response_code) ? response_code : 'default'
+      response_code = 'default' unless responses.key?(response_code)
       response, media_type = media_type_response(responses, response_code, media_type)
       return unless response
 
@@ -55,7 +61,10 @@ class Reynard
     end
 
     def media_type_response(responses, response_code, media_type)
-      responses.dig(response_code, 'content').each do |expression, response|
+      defined_responses = responses.dig(response_code, 'content')
+      return unless defined_responses&.any?
+
+      defined_responses.each do |expression, response|
         return response, expression if self.class.media_type_matches?(media_type, expression)
       end
       nil
@@ -83,7 +92,7 @@ class Reynard
 
     def read
       File.open(@filename, encoding: 'UTF-8') do |file|
-        YAML.safe_load(file)
+        YAML.safe_load(file, aliases: true)
       end
     end
 

data/lib/reynard/version.rb

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

data/lib/reynard.rb

@@ -15,6 +15,7 @@ class Reynard
   def_delegators :@specification, :servers
 
   autoload :Context, 'reynard/context'
+  autoload :GroupedParameters, 'reynard/grouped_parameters'
   autoload :Http, 'reynard/http'
   autoload :MediaType, 'reynard/media_type'
   autoload :Model, 'reynard/model'
@@ -23,10 +24,10 @@ class Reynard
   autoload :Operation, 'reynard/operation'
   autoload :RequestContext, 'reynard/request_context'
   autoload :Schema, 'reynard/schema'
+  autoload :SerializedBody, 'reynard/serialized_body'
   autoload :Server, 'reynard/server'
   autoload :Specification, 'reynard/specification'
   autoload :Template, 'reynard/template'
-  autoload :GroupedParameters, 'reynard/grouped_parameters'
   autoload :VERSION, 'reynard/version'
 
   def initialize(filename:)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reynard
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.8
 platform: ruby
 authors:
 - Manfred Stienstra
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-06 00:00:00.000000000 Z
+date: 2021-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -131,6 +131,7 @@ files:
 - lib/reynard/operation.rb
 - lib/reynard/request_context.rb
 - lib/reynard/schema.rb
+- lib/reynard/serialized_body.rb
 - lib/reynard/server.rb
 - lib/reynard/specification.rb
 - lib/reynard/template.rb
@@ -139,7 +140,7 @@ homepage: https://github.com/Manfred/reynard
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -154,8 +155,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Minimal OpenAPI client.
 test_files: []