rspec-rails-api 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca1fda3905c2dd0831009c51f1cf41aa75538aed6f635b87cb12828e5db69476
-  data.tar.gz: e965376d3c9c53a55537333f55b9c6165d23335f78b8ca4d030fa815dae0791b
+  metadata.gz: a0c5ddec517d805e43305c00f7b7baa19373acb3d8fe55bca724e521e57cc8e3
+  data.tar.gz: 9f1ed792f16c075e140610902f8d7671d13d03483115066e55ca48c43b42f8d7
 SHA512:
-  metadata.gz: 85a1a31174c7c674ccadcef0481dd249c7169f41e0aa8c3a52f1f542970948ca9e4a885900384871c2245e9b5c968d4f798e6d2d0b6e4284906c26bbd12c33ca
-  data.tar.gz: cb7d32f0db0d82961d2f43647c6b65d6000e4a6605e9439806d3534ad7dccd79122a9659c06c5f71bf737849260a2488afb978bde83f3675587dfb9ec0b0a131
+  metadata.gz: 501da0c03e7375b0097e95d951b1db831743564abd88dd4d28e719be5ee84701daaa9583160a0610dcd3cde35b143b8199b07e6bf684e0261fd26afca5b67d23
+  data.tar.gz: 5eaf88f5467cb5d5a12ca311e53778507534ff5090e85647581899bc5c4b7ab1f9914aea97f663bc7474faaede720fe66ff3d350ff0ba12982361b0772a00ae2

data/.gitignore

@@ -12,3 +12,5 @@
 
 # Ignore lockfile for Gemfile
 Gemfile.lock
+
+.byebug_history

data/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+## 0.1.5 - 2019-10-31
+
+### Fixed
+
+- Fixed issue with POST/PUT/DELETE requests with no `request_params`
+- Improved documentation (integration with Devise, typos and mistakes)
+
+## 0.1.4 - 2019-10-24
+
+### Added
+
+- Added support for arrays of objects in request parameters
+
+## 0.1.3 - 2019-10-23
+
+### Added
+
+- Added ability to document API descriptions, servers, etc... from the RSpec helper files
+  
+## 0.1.2 - 2019-10-22
+
+### Added
+
+- Added `item` property for arrays descriptions
+
+## 0.1.1 - 2019-10-22
+
+- Added support for custom headers in request examples (useful for `visit` method)
+
+## 0.1.0 - 2019-10-21
+
+Initial release

data/README.md

@@ -1,4 +1,4 @@
-# RspecRailsApiDoc
+# RSpecRailsApiDoc
 
 > An RSpec plugin to test Rails api responses and generate swagger
 > documentation
@@ -34,7 +34,7 @@ require 'rails_helper'
 require 'rspec_rails_api'
 
 RSpec.configure do |config|
-  config.include Rspec::Rails::Api::DSL::Example
+  config.include RSpec::Rails::Api::DSL::Example
 end
 
 renderer = RSpec::Rails::Api::OpenApiRenderer.new
@@ -52,7 +52,7 @@ 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
+  renderer.write_files Rails.root.join('public', 'swagger_doc'), only: [:json]
 end
 ```
 
@@ -71,7 +71,68 @@ end
 
 ## Configuration
 
-TODO
+**TODO: This section is incomplete and the gem has no generator yet**
+
+### Integration with Devise
+
+To use `sign_in` and `sign_out` from Devise in the acceptance tests, create a Devise support file:
+
+```rb
+# spec/support/devise.rb
+module DeviseAcceptanceSpecHelpers
+  include Warden::Test::Helpers
+
+  def sign_in(resource_or_scope, resource = nil)
+    resource ||= resource_or_scope
+    scope = Devise::Mapping.find_scope!(resource_or_scope)
+    login_as(resource, scope: scope)
+  end
+
+  def sign_out(resource_or_scope)
+    scope = Devise::Mapping.find_scope!(resource_or_scope)
+    logout(scope)
+  end
+end
+```
+
+Load this file in `rails_helper.rb`:
+
+```rb
+#...
+# Add additional requires below this line. Rails is not loaded until this point!
+require 'support/devise'
+#...
+```
+
+Include the helper for acceptance specs:
+
+```rb
+RSpec.configure do |config|
+  config.include DeviseAcceptanceSpecHelpers, type: :acceptance
+end
+```
+
+You can now use the methods as usual:
+
+```rb
+# In a before block
+before do
+  sign_in #...
+end
+
+# In examples
+#...
+  for_code 200, 'Success' do |example|
+    sing_in #...
+    visit example
+
+    #...
+  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
 
@@ -457,6 +518,6 @@ The gem is available as open source under the terms of the
 
 ## Code of Conduct
 
-Everyone interacting in the RspecRailsApiDoc project’s codebases, issue
+Everyone interacting in the RSpecRailsApiDoc project’s codebases, issue
 trackers, chat rooms and mailing lists is expected to follow the
 [code of conduct](https://gitlab.com/experimentslabs/rspec-rails-api/blob/master/CODE_OF_CONDUCT.md).

data/examples/commented.rb

@@ -18,7 +18,7 @@ RSpec.describe 'Categories', type: :acceptance do
          url:        { type: :string, description: 'URL to this category' }
 
   entity :error,
-         error: { type: :string, name: 'The error' }
+         error: { type: :string, description: 'The error' }
 
   entity :form_error,
          errors: {

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

@@ -74,7 +74,7 @@ module RSpec
           Utils.deep_set(@resources, "#{@current_resource}.paths.#{url}.actions.#{method}",
                          description: description,
                          statuses:    {},
-                         params:      [])
+                         params:      {})
 
           @current_url    = url
           @current_method = method

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

@@ -30,6 +30,8 @@ module RSpec
         def merge_context(context)
           @metadata[:resources].deep_merge! context[:resources]
           @metadata[:entities].deep_merge! context[:entities]
+          # Save context to make the fixture (will be saved in the reference project)
+          # File.write ::Rails.root.join('tmp', 'meta.yaml'), context.to_yaml
         end
 
         def write_files(path = nil, only: %i[yaml json])

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

@@ -3,7 +3,7 @@
 module RSpec
   module Rails
     module Api
-      VERSION = '0.1.4'
+      VERSION = '0.1.5'
     end
   end
 end

data/rspec-rails-api.gemspec

@@ -17,6 +17,11 @@ Gem::Specification.new do |spec|
   TXT
   spec.homepage = 'https://gitlab.com/experimentslabs/rspec-rails-api'
   spec.license  = 'MIT'
+  spec.metadata = {
+    'source_code_uri' => 'https://gitlab.com/experimentslabs/rspec-rails-api',
+    'bug_tracker_uri' => 'https://gitlab.com/experimentslabs/rspec-rails-api/issues',
+    'changelog_uri'   => 'https://gitlab.com/experimentslabs/rspec-rails-api/blob/master/CHANGELOG.md',
+  }
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -29,6 +34,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'activesupport', '>= 5.2'
   spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rails-api
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Manuel Tancoigne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-24 00:00:00.000000000 Z
+date: 2019-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +136,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -144,7 +159,10 @@ files:
 homepage: https://gitlab.com/experimentslabs/rspec-rails-api
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://gitlab.com/experimentslabs/rspec-rails-api
+  bug_tracker_uri: https://gitlab.com/experimentslabs/rspec-rails-api/issues
+  changelog_uri: https://gitlab.com/experimentslabs/rspec-rails-api/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: