apicraft-rails 0.5.1.beta1 → 0.5.2.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03c78edc81f87417dfdd7411be50609da4d39bb0827775ea16b609cce641a7bd
-  data.tar.gz: 652eb5761da35bc28f8a779015c74ef0b971d94231250aa02edcd3c3ff1cc7b3
+  metadata.gz: 5411b6d7fec8f1e73a0827f8809c53212ff39f0c97d94bd5ed54825e84a81882
+  data.tar.gz: b4d2b5001f2aca8c32b5ac510e9b67a749e2eb5fc199ed89eaaaa42135b598df
 SHA512:
-  metadata.gz: fe96cef636e07bc57e26ff11401e315ab457783cf254f33de98ec233a8f2c4b72be7c4b4f593f023deb615b17ce5166f8309fabc6a298139913d58e478363489
-  data.tar.gz: f23638693ebe922a7de1b98bfef20f7cad9777704c21603489ffe6677afc33ec9020173a2cfdb76dd59c52e7246a42dbb55fcd2443f9ff7fa4946a6764c84dd6
+  metadata.gz: 46cf0e60bd1d0f7551c80f118af6d8c421c8d6485252dc92a2b58d75c02f052c6c3216ac976ecb46f636fee72946c8f9662ed3af7b243575a5d716bcf5c6d40a
+  data.tar.gz: 5e77011472cb349e45f84131e9ef15e17b22a13576b2cb3b5f40b2311d191bede0c36bcec654932527e4e7e1c7006b3a12cd7967b8a42c9cd47865efedbbfb18

data/README.md

@@ -1,6 +1,6 @@
-# APICraft Rails (Beta)
+# APICraft Rails
 [![Build](https://github.com/apicraft-dev/apicraft-rails/actions/workflows/build.yml/badge.svg)](https://github.com/apicraft-dev/apicraft-rails/actions/workflows/build.yml)
-[![Gem Version](https://badge.fury.io/rb/apicraft-rails.svg)](https://badge.fury.io/rb/apicraft-rails)
+[![Gem Version](https://badge.fury.io/rb/apicraft-rails.svg?v=0.5.2.beta1)](https://badge.fury.io/rb/apicraft-rails)
 
 🚀 Accelerates your development by 2-3x with an API Design First approach. Seamlessly integrates with your Rails application server — no fancy tooling or expenses required.
 
@@ -72,7 +72,7 @@ By adopting an API Design First approach with APICraft Rails, you can accelerate
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'apicraft-rails', '~> 0.5.1.beta1'
+gem 'apicraft-rails', '~> 0.5.2.beta1'
 ```
 
 And then execute:
@@ -143,12 +143,14 @@ headers: {
 
 ### 🎮 API Mocking (Behaviours)
 The above is an example of a 200 response. If you have more responses documented you can force that behaviour using `Apicraft-Response-Code` header in the mock request.
+You can find a list of all the supported headers in the [configuration section](#-configuration) that would allow you to manipulate the API Behaviour.
 
 `https://yoursite.com/api/orders`
 ```
 headers: {
   Apicraft-Response-Code: 400
   Apicraft-Mock: true
+  Apicraft-Delay: 5
 }
 ```
 ```json
@@ -223,6 +225,9 @@ module App
   end
 end
 ```
+RapiDoc                    |  SwaggerDoc
+:-------------------------:|:-------------------------:
+![](assets/rapidoc.png)  |  ![](assets/swaggerdoc.png)
 
 ## 🔧 Configuration
 
@@ -249,6 +254,10 @@ Apicraft.configure do |config|
   # Defaults to true
   config.strict_reference_validation = true
 
+  # When simulating delay using the mocks, the max
+  # delay in seconds that can be simulated
+  config.max_allowed_delay = 30
+
   config.headers = {
     # The name of the header used to control
     # the response code of the mock
@@ -257,11 +266,14 @@ Apicraft.configure do |config|
 
     # The name of the header to introspect the API.
     # Defaults to Apicraft-Introspect
-    introspect: "Apicraft-Introspect"
+    introspect: "Apicraft-Introspect",
 
     # The name of the header to mock the API.
     # Defaults to Apicraft-Mock
-    mock: "Apicraft-Mock"
+    mock: "Apicraft-Mock",
+
+    # Delay simulation header name
+    delay: "Apicraft-Delay"
   }
 end
 

data/lib/apicraft/config.rb

@@ -13,12 +13,14 @@ module Apicraft
         response_code: "Apicraft-Response-Code",
         introspect: "Apicraft-Introspect",
         mock: "Apicraft-Mock",
+        delay: "Apicraft-Delay",
         content_type: "Content-Type"
       },
       mocks: true,
       introspection: true,
       strict_reference_validation: true,
-      request_validations: true
+      request_validations: true,
+      max_allowed_delay: 30
     }.with_indifferent_access
 
     def initialize(opts = {})
@@ -47,6 +49,10 @@ module Apicraft
       @opts[:introspection]
     end
 
+    def max_allowed_delay
+      @opts[:max_allowed_delay]
+    end
+
     def contracts_path=(contracts_path)
       @opts[:contracts_path] = contracts_path
     end
@@ -67,6 +73,10 @@ module Apicraft
       @opts[:request_validations] = enabled
     end
 
+    def max_allowed_delay=(enabled)
+      @opts[:max_allowed_delay] = enabled
+    end
+
     def headers=(headers)
       @opts[:headers] = @opts[:headers].merge(
         headers.with_indifferent_access

data/lib/apicraft/errors.rb

@@ -7,5 +7,6 @@ module Apicraft
     class InvalidContract < StandardError; end
     class InvalidOperation < StandardError; end
     class InvalidResponse < StandardError; end
+    class DelayTooHigh < StandardError; end
   end
 end

data/lib/apicraft/middlewares/mocker.rb

@@ -15,15 +15,9 @@ module Apicraft
         request = ActionDispatch::Request.new(env)
         return @app.call(env) unless mock?(request)
 
-        contract = Apicraft::Openapi::Contract.find_by_operation(
-          request.method, request.path_info
-        )
-        raise Errors::InvalidContract if contract.blank?
-
-        operation = contract.operation(
-          request.method, request.path_info
-        )
-        raise Errors::InvalidOperation if operation.blank?
+        use_delay!(request)
+        contract = find_contract!(request)
+        operation = find_operation!(contract, request)
 
         code = request.headers[config.headers[:response_code]] || "200"
         response = operation.response_for(code.to_s)
@@ -64,6 +58,35 @@ module Apicraft
       def mock?(request)
         request.headers[config.headers[:mock]].present?
       end
+
+      def find_contract!(request)
+        contract = Apicraft::Openapi::Contract.find_by_operation(
+          request.method, request.path_info
+        )
+        raise Errors::InvalidContract if contract.blank?
+
+        contract
+      end
+
+      def find_operation!(contract, request)
+        operation = contract.operation(
+          request.method, request.path_info
+        )
+        raise Errors::InvalidOperation if operation.blank?
+
+        operation
+      end
+
+      def use_delay!(request)
+        request_delay = delay(request)
+        raise Errors::DelayTooHigh if request_delay > config.max_allowed_delay
+
+        sleep(request_delay)
+      end
+
+      def delay(request)
+        request.headers[config.headers[:delay]].to_i
+      end
     end
   end
 end

data/lib/apicraft/version.rb

@@ -2,5 +2,5 @@
 
 # Current version of Apicraft.
 module Apicraft
-  VERSION = "0.5.1.beta1"
+  VERSION = "0.5.2.beta1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apicraft-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.1.beta1
+  version: 0.5.2.beta1
 platform: ruby
 authors:
 - Abhishek Sarkar
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-10 00:00:00.000000000 Z
+date: 2024-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport