reynard 0.0.3 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1655a999a92e83993f4fdba62a9eedc870b18ada0339278d1c899e24f087b3bc
-  data.tar.gz: 926420c57d99767386d9aea1ef50b5bda317ea437a11dc3646bf3a5cc8a902be
+  metadata.gz: 464bcfde66e61c85b7dd949995fc3acd2db91048b80828bb4c8161c1bd5170d8
+  data.tar.gz: e219398e59d21c45e42ece44f1cadcbdb6c0ef4b5a5927cb627bafa249138b6a
 SHA512:
-  metadata.gz: 6c9834fae550aae2557a6833e4491eed9d426c9fdb5b6c2cf31ff5c9fe80569a00070affdfb76e9c90611400f959df5a7e377dfe906a813655e6b28bc3ced4ac
-  data.tar.gz: a22f676bb82b37d6bceb87028aeae10a78f2fd394cdef990eea7661842d1b0a2644ac20e5188f29730c62d54ab36498b1fe7112ebc1ffe872b3f3b6dfa848aff
+  metadata.gz: b3fb63f88b99b653541e92e948ba5e8cadb6edbbdb45bf6d939452d98663b7d40bf9782f5cb816665d847a0c807777e3604fef279430e30025e0228600c280e9
+  data.tar.gz: 616c0ad91e77e8d69fa66d48000079cfc530563f276e85c4bdca96a83f17e9a273a8f88ff5d8d2b5bef60160d1241263f30a83fb3be2ff065ef87974d997fadd

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)
@@ -53,13 +67,28 @@ class Reynard
       media_type = @specification.media_type(
         @request_context.operation.node,
         http_response.code,
-        http_response['Content-Type'].split(';').first
+        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

@@ -15,7 +15,7 @@ class Reynard
       end
 
       def perform
-        build_http.request(build_request)
+        Reynard.http.request(uri, build_request)
       end
 
       private
@@ -29,12 +29,6 @@ class Reynard
         end
       end
 
-      def build_http
-        http = Net::HTTP.new(uri.hostname, uri.port)
-        http.set_debug_output($stderr) if ENV['DEBUG']
-        http
-      end
-
       def build_http_get
         Net::HTTP::Get.new(uri, @request_context.headers)
       end

data/lib/reynard/model.rb

@@ -16,10 +16,14 @@ class Reynard
     # Until we can set accessors based on the schema
     def method_missing(attribute_name, *)
       instance_variable_get("@#{attribute_name}")
+    rescue NameError
+      raise NoMethodError, "undefined method `#{attribute_name}' for #{inspect}"
     end
 
     def respond_to_missing?(attribute_name, *)
-      !!instance_variable_get("@#{attribute_name}")
+      !instance_variable_get("@#{attribute_name}").nil?
+    rescue NameError
+      false
     end
   end
 end

data/lib/reynard/object_builder.rb

@@ -11,28 +11,52 @@ class Reynard
       @http_response = http_response
     end
 
-    # Object.const_set(@media_type.schema_name, Class.new(Reynard::Model))
     def object_class
       if @media_type.schema_name
-        self.class.model_class(@media_type.schema_name)
+        self.class.model_class(@media_type.schema_name, @schema.object_type)
+      else
+        OpenStruct
+      end
+    end
+
+    def item_object_class
+      if @schema.item_schema_name
+        self.class.model_class(@schema.item_schema_name, 'object')
       else
         OpenStruct
       end
     end
 
     def call
-      case @media_type.media_type
-      when 'application/json'
-        object_class.new(MultiJson.load(@http_response.body))
+      if @schema.object_type == 'array'
+        array = object_class.new
+        data.each { |attributes| array << item_object_class.new(attributes) }
+        array
       else
-        FailedRequest.new
+        object_class.new(data)
       end
     end
 
-    def self.model_class(name)
+    def data
+      @data ||= MultiJson.load(@http_response.body)
+    end
+
+    def self.model_class(name, object_type)
+      model_class_get(name) || model_class_set(name, object_type)
+    end
+
+    def self.model_class_get(name)
       Reynard::Models.const_get(name)
     rescue NameError
-      Reynard::Models.const_set(name, Class.new(Reynard::Model))
+      nil
+    end
+
+    def self.model_class_set(name, object_type)
+      if object_type == 'array'
+        Reynard::Models.const_set(name, Class.new(Array))
+      else
+        Reynard::Models.const_set(name, Class.new(Reynard::Model))
+      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/schema.rb

@@ -3,11 +3,12 @@
 class Reynard
   # Holds reference and object type for a schema in the API specification.
   class Schema
-    attr_reader :node, :object_type
+    attr_reader :node, :object_type, :item_schema_name
 
-    def initialize(node:, object_type:)
+    def initialize(node:, object_type:, item_schema_name:)
       @node = node
       @object_type = object_type
+      @item_schema_name = item_schema_name
     end
   end
 end

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,8 +50,8 @@ 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 = responses.dig(response_code, 'content', media_type)
+      response_code = 'default' unless responses.key?(response_code)
+      response, media_type = media_type_response(responses, response_code, media_type)
       return unless response
 
       MediaType.new(
@@ -54,11 +60,32 @@ class Reynard
       )
     end
 
+    def media_type_response(responses, response_code, media_type)
+      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
+    end
+
     def schema(media_type_node)
       schema = dig(*media_type_node, 'schema')
       return unless schema
 
-      Schema.new(node: [*media_type_node, 'schema'], object_type: schema['type'])
+      Schema.new(
+        node: [*media_type_node, 'schema'],
+        object_type: schema['type'],
+        item_schema_name: item_schema_name(schema)
+      )
+    end
+
+    def self.media_type_matches?(media_type, expression)
+      return true unless media_type
+      return true if expression == media_type
+
+      false
     end
 
     private
@@ -89,6 +116,11 @@ class Reynard
       ref&.split('/')&.last
     end
 
+    def item_schema_name(schema)
+      ref = schema.dig('items', '$ref')
+      ref&.split('/')&.last
+    end
+
     def object_name(_schema)
       'Book'
     end

data/lib/reynard/version.rb

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

data/lib/reynard.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'net/http/persistent'
 require 'forwardable'
 require 'multi_json'
 require 'rack'
@@ -14,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'
@@ -22,16 +24,24 @@ 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:)
     @specification = Specification.new(filename: filename)
   end
 
+  def self.http
+    @http ||= begin
+      http = Net::HTTP::Persistent.new(name: 'Reynard')
+      http.debug_output = $stderr if ENV['DEBUG']
+      http
+    end
+  end
+
   private
 
   def build_context

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reynard
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.7
 platform: ruby
 authors:
 - Manfred Stienstra
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-05 00:00:00.000000000 Z
+date: 2021-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |2
     Reynard is an OpenAPI client for Ruby. It operates directly on the OpenAPI specification without
     the need to generate any source code.
@@ -103,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
@@ -111,7 +140,7 @@ homepage: https://github.com/Manfred/reynard
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -126,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: []