rspec-rails-api 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa6db3329e09e4356d205cf49f100e11132a3e8a8fcb681ef8ede5e22ba470dd
-  data.tar.gz: e25b15faecc41214f92bb089f8fc9e28702f9c5ad2072daf4014251d30f23291
+  metadata.gz: 4771b145e32ae7cbfd7f03d6252618d3a4cd8b557930a67a562e45046d4e302b
+  data.tar.gz: 6bc0e55b1c2e5d51ba5bdfc52ac532efbf5ad539e138557a99895ef637e0311a
 SHA512:
-  metadata.gz: 2c947cf296de131ece545c7a21ed093d79de1e1fd5f57af53c58985eab815c781ce4dcbba7f7269c679dbf8155d4eabf0ae5035caa70bbd88090650630ed8e11
-  data.tar.gz: b0c4d8bef1c715b0ea369b5f7a659e8fa69344735af2a7735a51a1cb755c3fc3b642597c47a133be9568c0361d8565725ed803d2b0dd530050d1e286795ee911
+  metadata.gz: cafa1ebfc333e41474f85dfb9389f976df1ffa8000de62c8a412c6436088db9182a7f15ec162dff46848265e6cf86564e5a79c93e0814afcc454a242ad77c8b6
+  data.tar.gz: a24717ab5c36a863eaa6939c4ee3f5df3b5fbf058f45b17923d50dd0656680becca60f325d2d9c11b13db84dfaf243a4f24dd77450c33b28911086b986f9cb9e

data/CHANGELOG.md

@@ -18,6 +18,14 @@ Maintenance, in case of rework, dependencies change
 
 ## [Unreleased]
 
+## [0.6.1] - 2024-01-17
+
+### Fixed
+
+- Renderer: handle arrays of object with inline attributes (not a reference)
+- Renderer: Remove the `name` attribute from `basic` authentication declaration
+- Renderer: Add missing `items` key on arrays of any type 
+
 ## [0.6.0] - 2023-07-17
 
 ### Added

data/Gemfile.lock

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

data/README.md

@@ -26,89 +26,56 @@ bundle
 
 Configuration should be made manually for now:
 
-**spec/acceptance_helper.rb**
+**spec/support/rspec_rails_api.rb**:
 
 ```ruby
-require 'rails_helper'
 require 'rspec_rails_api'
 
+# Associate spec/acceptance/* to acceptance tests
+RSpec::Rails::DIRECTORY_MAPPINGS[:acceptance] = %w[spec acceptance]
+
 RSpec.configure do |config|
   config.include RSpec::Rails::Api::DSL::Example
-end
-
-renderer = RSpec::Rails::Api::OpenApiRenderer.new
-# Options here should be customized
-renderer.api_title = 'YourProject API'
-renderer.api_version = '1'
-renderer.api_description = 'Manage data on YourProject'
-# Options below are optional
-renderer.api_servers = [{ url: 'https://example.com' }]
-renderer.api_tos = 'http://example.com/tos.html'
-renderer.api_contact = { name: 'Admin', email: 'admin@example.com', url: 'http://example.com/contact' } 
-renderer.api_license = { name: 'Apache', url: 'https://opensource.org/licenses/Apache-2.0' }
+  config.include RSpec::Rails::RequestExampleGroup, type: :acceptance
 
-RSpec.configuration.after(:context, type: :acceptance) do |context|
-  renderer.merge_context context.class.metadata[:rra].to_h
-end
+  # Define the renderer if you want to generate the OpenApi documentation
+  renderer = RSpec::Rails::Api::OpenApiRenderer.new
+  # Options here should be customized
+  renderer.api_title = 'YourProject API'
+  renderer.api_version = '1'
+  renderer.api_description = 'Manage data on YourProject'
+  # Options below are optional
+  renderer.api_servers = [{ url: 'https://example.com' }]
+  renderer.api_tos = 'http://example.com/tos.html'
+  renderer.api_contact = { name: 'Admin', email: 'admin@example.com', url: 'http://example.com/contact' } 
+  renderer.api_license = { name: 'Apache', url: 'https://opensource.org/licenses/Apache-2.0' }
+  # ... Check the "Configuration" section for all the options
+  
+  config.after(:context, type: :acceptance) do |context|
+    renderer.merge_context context.class.metadata[:rra].to_h
+  end
 
-RSpec.configuration.after(:suite) do
-  # Default path is 'tmp/rspec_rails_api_output.json/yaml'
-  renderer.write_files Rails.root.join('public', 'swagger_doc'), only: [:json]
+  config.after(:suite) do
+    # Default path is 'tmp/rspec_rails_api_output.json/yaml'
+    renderer.write_files Rails.root.join('public', 'swagger_doc'), only: [:json]
+  end
 end
 ```
 
-**spec/rails_helper.rb**
+**spec/rails_helper.rb**:
 
 ```ruby
-# ...
-
-RSpec::Rails::DIRECTORY_MAPPINGS[:acceptance] = %w[spec acceptance]
-
-RSpec.configure do |config|
-  # ...
-  config.include RSpec::Rails::RequestExampleGroup, type: :acceptance
-end
+#...
+require 'support/rspec_rails_api'
+#...
 ```
 
 ## Configuration
 
 **TODO: This section is incomplete and the gem has no generator yet.**
 
-Here is an example configuration:
-
-```rb
-# spec/rails_helper.rb
-require 'spec/support/rspec_rails_api'
-```
-
-```rb
-# spec/support/acceptance_entities.rb
-
-# This file contains common object definitions
-{
-  error: {
-    error: { type: :string, description: "Error message" }
-  },
-  form_error: {
-    title: { type: :array, required: false, description: "Title errors", of: :string }
-  },
-}.each do |name, attributes|
-  RSpec::Rails::Api::Metadata.add_entity name, attributes
-end
-```
 
 ```rb
-# spec/support/rspec_rails_api.rb
-require 'rspec_rails_api'
-require 'support/acceptance_entities'
-
-# Include DSL in RSpec
-RSpec.configure do |config|
-  config.include RSpec::Rails::Api::DSL::Example
-end
-
-# Initialize and configure the renderer
-renderer = RSpec::Rails::Api::OpenApiRenderer.new
 # Server URL for quick reference
 server_url = 'https://example.com'
 
@@ -229,10 +196,6 @@ end
 This solution comes from [this article](https://makandracards.com/makandra/37161-rspec-devise-how-to-sign-in-users-in-request-specs)
 by Arne Hartherz (MIT license).
 
-## Usage
-
-Write some spec files and run RSpec as you would usually do.
-
 ## Writing specs
 
 There is a [commented example](dummy/spec/acceptance/posts_spec.rb) available in
@@ -334,21 +297,23 @@ RSpec::Rails::Api::Metadata.add_entity :user,
 
 Organization of the global entities declaration is up to you.
 
+For small projects, we usually put them all in one file:
+
 ```rb
-# spec/acceptance/api/users_acceptance_spec.rb
-require 'rails_helper'
+# spec/support/acceptance_entities.rb
 
-RSpec.describe 'Users', type: :acceptance do
-  resource 'Users', 'Manage users'
+require 'rspec/rails/api/metadata'
 
-  on_get '/api/users/', 'Users list' do
-    # "user" will use the global user entity
-    for_code 200, 'Success response', expect_many: :user do |url|
-      test_response_of url
-    end
-  end
-  
-  #...
+# This file contains common object definitions
+{
+  error: {
+    error: { type: :string, description: "Error message" }
+  },
+  form_error: {
+    title: { type: :array, required: false, description: "Title errors", of: :string }
+  },
+}.each do |name, attributes|
+  RSpec::Rails::Api::Metadata.add_entity name, attributes
 end
 ```
 
@@ -746,6 +711,11 @@ MRs to improve this are welcome.
 
 There is no support for file fields yet.
 
+### Security
+
+`Security` mechanisms are only declared for the OpenApi documentation as a reference, and is
+not checked nor enforced in the tests.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.

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

@@ -53,7 +53,7 @@ module RSpec
         def define_attributes(attributes)
           @attributes = case attributes
                         when Hash
-                          @attributes = EntityConfig.new attributes
+                          EntityConfig.new attributes
                         when Symbol
                           attributes
                         end

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

@@ -43,7 +43,7 @@ module RSpec
         def add_security_scheme(reference, name, definition)
           raise "Security scheme #{reference} is already defined" if @api_security.key? reference
 
-          definition[:name] = name
+          definition[:name] = name unless reference == :basic
           @api_security[reference] = definition
         end
 
@@ -241,6 +241,8 @@ module RSpec
               property = { '$ref' => "#/components/schemas/#{field.attributes}" }
             elsif field.type == :array && field.attributes.is_a?(Symbol)
               property = { type: :array, items: { '$ref' => "#/components/schemas/#{field.attributes}" } }
+            elsif field.type == :array
+              property = { type: :array, items: process_entity(field.attributes) }
             end
 
             required.push name unless field.required == false
@@ -420,7 +422,7 @@ module RSpec
           response
         end
 
-        def response_schema(expectations) # rubocop:disable Metrics/MethodLength
+        def response_schema(expectations) # rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity
           if expectations[:many]
             items = if PRIMITIVES.include?(expectations[:many])
                       { type: expectations[:many] }
@@ -429,7 +431,11 @@ module RSpec
                     end
             { type: 'array', items: items }
           elsif expectations[:one]
-            if PRIMITIVES.include?(expectations[:one])
+            # Unspecified arrays
+            if expectations[:one] == :array
+              { type: :array, items: {} }
+            # Array of specified type
+            elsif PRIMITIVES.include?(expectations[:one])
               { type: expectations[:one] }
             else
               { '$ref' => "#/components/schemas/#{expectations[:one]}" }

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

@@ -3,7 +3,7 @@
 module RSpec
   module Rails
     module Api
-      VERSION = '0.6.0'
+      VERSION = '0.6.1'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rails-api
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Manuel Tancoigne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-17 00:00:00.000000000 Z
+date: 2024-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport