rspec-rails-api 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac74e8f8e66d510a436cd3b1736dfa47aee2824e4d862987cca9c9f6a2c63fba
-  data.tar.gz: 8c73eae6f88c3888d82c9f44de5283741791efbe9e4f109c1c55c675ea918b1c
+  metadata.gz: 063a556e42014a4511564abe16c657d4957ae13e51a884b9813ba1c168a3ba57
+  data.tar.gz: 35917b290d4121f22208ca686f13408cea7889f5c349d39e018a606710efb0f9
 SHA512:
-  metadata.gz: efccea1dd2ab627e4e6097f07657ecbd60f119495ccd447f5bb8ccc109d513580749e744b78de0d8af7045ac75dbbcc70ea0217e29a4b0ea538531625a05fbc8
-  data.tar.gz: cdaaea4e65313a040713981cf0cfea6e72d847773b39b0b87b0d78cf2e0a685e9f1e331003cea5bf219d29fec2ca145e60628e0076eee7f43494c8c7801dca41
+  metadata.gz: ffb97e91dde2e69050a7b38399511e902a0b9c62807af391269fd66e84379752c2883897639c8c36633ba6f85ffbb00abfa5cc89c050653943ce4cbab2a7cbf4
+  data.tar.gz: 92f2182d34c8b83f8201975eb6d0551ec96cf1ca563668a2acd073eec549403c047c3ab73f9d11b6fe974529ce5a9c2cec02eecacecddcbf0cd7831c7ea13cfa

data/CHANGELOG.md

@@ -18,6 +18,31 @@ Maintenance, in case of rework, dependencies change
 
 ## [Unreleased]
 
+## [0.7.0] - 2024-01-24
+
+### Fixed
+
+- [BREAKING] Don't add `name` property in security schemes that should not have one. 
+  Only `type: :apiKey` should have one, so the `name` argument of `add_security_scheme` has been removed. Specify it
+  when it is required/accepted only.
+  ```rb
+  # Change:
+  #                            ref       name                      schema 
+  renderer.add_security_scheme :basic,   "Basic authentication",   { type: "http", scheme: "basic" }
+  renderer.add_security_scheme :api_key, "API key authentication", { type: "apiKey", in: "header" }
+  # To:
+  #                            ref       schema
+  renderer.add_security_scheme :basic,   type: "http", scheme: "basic"
+  renderer.add_security_scheme :api_key, name: "API key authentication", type: "apiKey", in: "header"
+  ```
+
+## [0.6.3] - 2024-01-24
+
+### Fixed
+
+- `required` fields/parameters now can be false
+- Querystring parameters are better handled and documented: no more need to specify the whole querystring in URL
+
 ## [0.6.2] - 2024-01-17
 
 ### Fixed
@@ -76,7 +101,7 @@ Maintenance, in case of rework, dependencies change
   prefix
 
 ### Fixed
-- 
+
 - Fixed an error when an object is defined with an attribute named `type`.
 
 ## [0.4.0] - 2021-12-19

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-rails-api (0.6.2)
+    rspec-rails-api (0.7.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -451,13 +451,31 @@ These methods are available:
 
 Defines the path parameters that are used in the URL.
 
+Any field that is not referenced in the URL will end in querystring parameters.
+
 ```ruby
-on_get '/api/users/:id/posts/:post_slug?full=:full_post' do
+on_get '/api/users/:id/posts/:post_slug' do
   path_params fields: {
+                # "path" parameters 
                 id:        { type: :integer, description: 'The user ID' },
                 post_slug: { type: :string, description: 'The post slug' },
-                full_post: { type: :boolean, required: false, description: 'Returns the full post if `true`, or only an excerpt' } }
+                # "query" parameters 
+                full_post: { type: :boolean, required: false, description: 'Returns the full post if `true`, or only an excerpt' },
+              }
+  # ...
+end
+```
 
+If the querystring parameters are visible in the URL for some reason, they will still be treated as `query` parameters:
+
+```ruby
+on_get '/api/users/:id?full_bio=:full_bio_flag' do
+  path_params fields: {
+                # "path" parameters 
+                id:        { type: :integer, description: 'The user ID' },
+                # "query" parameters 
+                full_bio_flag: { type: :boolean, required: false, description: 'Returns the full biography' },
+              }
   # ...
 end
 ```
@@ -465,7 +483,7 @@ end
 - `type` is the field type (check _entity definition_ for a list).
 - `description` should be some valid
   [CommonMark](https://commonmark.org/)
-- `required` is optional an defaults to `true`.
+- `required` is optional and defaults to `true`.
 
 Alternative with defined parameters:
 

data/lib/rspec/rails/api/dsl/example.rb

@@ -128,15 +128,20 @@ module RSpec
           end
 
           ##
-          # Replace path params by values
+          # Replace path params by values and completes querystring
           #
           # @param url            [String] Url definition
           # @param request_params [Hash]   Request parameters
           #
           # @return [String] Actual path to visit
-          def prepare_request_url(url, request_params)
-            url.gsub(/(?::(\w*))/) do |e|
+          def prepare_request_url(url, request_params) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+            used_path_params = []
+
+            # Replace any ":xyz" in url
+            url = url.gsub(/(?::(\w*))/) do |e|
               symbol = e.sub(':', '').to_sym
+              used_path_params << symbol
+
               if request_params.key?(symbol)
                 request_params[symbol]
               elsif respond_to?(symbol)
@@ -145,6 +150,13 @@ module RSpec
                 puts "! Define #{symbol} (let(:#{symbol}){ value }) or pass it to 'visit'"
               end
             end
+
+            # Use everything else in query string
+            uri = URI.parse(url)
+            query_params = request_params.select { |k| used_path_params.exclude? k }
+            uri.query = URI.encode_www_form(query_params) unless query_params.blank?
+
+            uri.to_s
           end
 
           ##

data/lib/rspec/rails/api/metadata.rb

@@ -72,7 +72,7 @@ module RSpec
           raise "Parameter #{name} is already defined" if @parameters[name]
 
           fields.each_value do |field|
-            field[:required] = true unless field[:required] == false
+            field[:required] = field[:required] != false
             field[:schema] = { type: field[:of] } if field[:type] == :array && PRIMITIVES.include?(field[:of])
           end
           @parameters[name] = fields
@@ -97,7 +97,7 @@ module RSpec
             Utils.deep_set(@resources, [@current_resource, 'paths', @current_url, 'path_params', name],
                            description: field[:description] || nil,
                            type:        field[:type] || nil,
-                           required:    field[:required] || true,
+                           required:    field[:required] != false,
                            scope:       scope)
           end
         end
@@ -282,10 +282,8 @@ module RSpec
         def path_param_scope(url_chunks, name)
           if /:#{name}/.match?(url_chunks[0])
             :path
-          elsif url_chunks[1] && /:#{name}/ =~ url_chunks[1]
-            :query
           else
-            raise "#{name} not found in URL #{@current_url}"
+            :query
           end
         end
 

data/lib/rspec/rails/api/open_api_renderer.rb

@@ -38,12 +38,10 @@ module RSpec
         # Adds a security scheme definition to the API documentation
         #
         # @param reference  [Symbol] Reference to use in the tests
-        # @param name       [String] Human friendly name
         # @param definition [Hash]   Security scheme definition as per https://swagger.io/specification/#security-scheme-object
-        def add_security_scheme(reference, name, definition)
+        def add_security_scheme(reference, definition)
           raise "Security scheme #{reference} is already defined" if @api_security.key? reference
 
-          definition[:name] = name unless reference == :basic
           @api_security[reference] = definition
         end
 
@@ -267,7 +265,7 @@ module RSpec
           parameter = {
             name:        name.to_s,
             description: param[:description].presence&.strip || '',
-            required:    param[:required] || true,
+            required:    param[:required] != false,
             in:          param[:scope].to_s,
             schema:      {
               type: PARAM_TYPES[param[:type]][:type],

data/lib/rspec/rails/api/version.rb

@@ -3,7 +3,7 @@
 module RSpec
   module Rails
     module Api
-      VERSION = '0.6.2'
+      VERSION = '0.7.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rails-api
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Manuel Tancoigne
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-17 00:00:00.000000000 Z
+date: 2024-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -222,7 +222,7 @@ metadata:
   bug_tracker_uri: https://gitlab.com/experimentslabs/rspec-rails-api/issues
   changelog_uri: https://gitlab.com/experimentslabs/rspec-rails-api/blob/master/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -238,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.1
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Tests standard Rails API responses and generate doc
 test_files: []