reynard 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0d45ac57b8de184f9386bde8d78ccd4cea04f430f809f19c5af6f64ef77ec63
-  data.tar.gz: 6da06eac247b2fdc1f88ad8bfa76f11cf85d2c6852bec1d26ed73cb82dfb1edf
+  metadata.gz: d703f01c7c60de48b48ae223cd9c2e3a94a8639bb866eca234298331ad746d2a
+  data.tar.gz: 9e88b9e21dc1b1d00357fcf8bdf2b6952676c5237369d7d950e97b379727e731
 SHA512:
-  metadata.gz: e9813aac2ddb3316fc4048bf8f058365f5549fb096b8241488092a1124915810e15cd9e49a713f7a3a979f2c2bf88e11ce34fea41e3cf24046bd44143cd1d665
-  data.tar.gz: 77f1d12245ef452b312196e00918a60cfcca452fdb5d5658832406e370c5628e660813faf756b3404e0705dfe9e6b90f59248a1b35273d8b4dcafbe79ba66640
+  metadata.gz: b1cccaf532a955569236a07c5c8861519cf58c0c2abe3cdf218a8a57619a41d650e9f7226ccdb1a6ef1fddfe412cd9780032dcf8f68ecf995cd2176bb8774642
+  data.tar.gz: 56acfbbabfea8a77e76cbee676bd0b397a608994f03f774022fd54d4e65fad06730de36aa9b122767edddb229f854eff9e8819d8a93d506ee5af66d799d18e82

data/README.md

@@ -40,7 +40,7 @@ reynard.base_url('http://test.example.com/v1')
 You also have access to all servers in the specification so you can automatically select one however you want.
 
 ```ruby
-base_url = @reynard.servers.map(&:url).find do |url|
+base_url = reynard.servers.map(&:url).find do |url|
   /staging/.match(url)
 end
 reynard.base_url(base_url)
@@ -66,6 +66,20 @@ employee = reynard.
   execute
 ```
 
+## 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.
+
+```ruby
+Reynard.http = MyMock.new
+
+class MyMock
+  def request(uri, net_http_request)
+    Net::HTTPResponse::CODE_TO_OBJ['404'].new('HTTP/1.1', '200', 'OK')
+  end
+end
+```
+
 ## 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
@@ -67,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/specification.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'rack'
+
 class Reynard
   # Wraps the YAML representation of an OpenAPI specification.
   class Specification
@@ -61,7 +63,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
@@ -85,11 +90,20 @@ class Reynard
       false
     end
 
+    def self.normalize_model_name(name)
+      # 1. Unescape encoded characters to create an UTF-8 string
+      # 2. Replace all non-alphabetic characters with a space (not allowed in Ruby constant)
+      # 3. Camelcase
+      Rack::Utils.unescape_path(name)
+                 .gsub(/[^[:alpha:]]/, ' ')
+                 .gsub(/(\s+)([[:alpha:]])/) { Regexp.last_match(2).upcase }
+    end
+
     private
 
     def read
       File.open(@filename, encoding: 'UTF-8') do |file|
-        YAML.safe_load(file)
+        YAML.safe_load(file, aliases: true)
       end
     end
 
@@ -102,7 +116,7 @@ class Reynard
         next unless cursor.respond_to?(:key?) && cursor&.key?('$ref')
 
         # We currenly only supply references inside the document starting with #/.
-        path = cursor['$ref'][2..].split('/') + path
+        path = Rack::Utils.unescape_path(cursor['$ref'][2..]).split('/') + path
         cursor = data
       end
       cursor
@@ -110,16 +124,16 @@ class Reynard
 
     def schema_name(response)
       ref = response.dig('schema', '$ref')
-      ref&.split('/')&.last
+      return unless ref
+
+      self.class.normalize_model_name(ref&.split('/')&.last)
     end
 
     def item_schema_name(schema)
       ref = schema.dig('items', '$ref')
-      ref&.split('/')&.last
-    end
+      return unless ref
 
-    def object_name(_schema)
-      'Book'
+      self.class.normalize_model_name(ref&.split('/')&.last)
     end
   end
 end

data/lib/reynard/version.rb

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

data/lib/reynard.rb

@@ -34,6 +34,14 @@ class Reynard
     @specification = Specification.new(filename: filename)
   end
 
+  # Assign an object that follows Reynard's internal request interface to mock requests or use a
+  # different HTTP client.
+  class << self
+    attr_writer :http
+  end
+
+  # Returns Reynard's global request interface. This is a global object to allow persistent
+  # connections, caching, and other features that need a persistent object in the process.
   def self.http
     @http ||= begin
       http = Net::HTTP::Persistent.new(name: 'Reynard')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reynard
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Manfred Stienstra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-17 00:00:00.000000000 Z
+date: 2021-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json