rspec-rails-api 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d84f33b2eb3f005afce4a2712e2fd3523687f5ba098573d93e386439aa97639
-  data.tar.gz: e013cc905ed66797cd78c6d6c833c87ba30e939a0c12b950cb1209639789a3fd
+  metadata.gz: ae80a5b196a345ad25674bfae11ae466c979f216cca68912d205eb856c7096b9
+  data.tar.gz: 5201f1632652b2a46a2b436272497d7f0dc345b5710a8f218cfc0f80ac51241c
 SHA512:
-  metadata.gz: 32a8012f525f7319555e5aada0b1019e37939461034522193e939a2a028a3fb5897a133e0fb5fdd93a4ef8b77d3a62d2092884bae9c6e3194e50da8b5bd3572d
-  data.tar.gz: 5703b53a8d61d35c4e8124e615056da5c909bbe47e96fe9aeeb5362479a80db8d5c6999094ebb06d8502d1937f3520908d6554a66e3360ffb43d747c962d1021
+  metadata.gz: 52e87c17a14f52fbec2b85e5c37d0b3c20b6059a0d5592bf10d11bc092be10cb4cb183446328bd1fd1f6b766cd145516a1ce83965d3e6915e530d4dfc01e86c0
+  data.tar.gz: 8ce1bd90eb8c0c99ca561fa2410b41eb0d9492414283e926e9c60143b970a9a23b5e1abdb82e99d5f0be6b9647a0444502a5778560abb12a83f82aad205ba3a4

data/README.md

@@ -310,7 +310,7 @@ Once again, you have to pass an argument to the block if you use
 
 Example methods are available in `for_code` blocks
 
-##### `visit(example, path_params: {}, payload: {})`
+##### `visit(example, path_params: {}, payload: {}, headers: {})`
 
 Visits the described URL and:
 
@@ -323,6 +323,7 @@ Visits the described URL and:
   value is needed)
 - `payload`: a hash of values to send. Ignored for GET and DELETE
   requests
+- `headers`: a hash of custom headers.
 
 ```rb
 for_code 200, 'Success' do |example|
@@ -342,8 +343,8 @@ It should be compared against a hash or a `response` object:
 ```rb
 #...
 entity user:
-       id:   { type: :integer, desc: 'The id',
-       name: { type: :string, desc: 'The name'
+       id:   { type: :integer, desc: 'The id' },
+       name: { type: :string, desc: 'The name' }
 
 #...
 
@@ -365,8 +366,8 @@ It should be compared against an array or a `response` object:
 ```rb
 #...
 entity user:
-       id:   { type: :integer, desc: 'The id',
-       name: { type: :string, desc: 'The name'
+       id:   { type: :integer, desc: 'The id' },
+       name: { type: :string, desc: 'The name }'
 
 #...
 
@@ -416,11 +417,6 @@ attributes of an `has_many` relation)
 
 MRs to improve this are welcome.
 
-### Headers
-
-There is no way to have custom headers yet. This means, no token-based
-auth.
-
 ### Files
 
 There is no support for file fields yet.

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

@@ -6,11 +6,11 @@ module RSpec
       module DSL
         # These methods will be available in examples (i.e.: 'for_code')
         module Example
-          def visit(example, path_params: {}, payload: {}) # rubocop:disable Metrics/AbcSize
+          def visit(example, path_params: {}, payload: {}, headers: {}) # rubocop:disable Metrics/AbcSize
             raise 'Missing context. Call visit with for_code context.' unless example
 
             status_code    = prepare_status_code example.class.description
-            request_params = prepare_request_params example.class.parent.description, path_params, payload
+            request_params = prepare_request_params example.class.parent.description, path_params, payload, headers
 
             send(request_params[:action],
                  request_params[:url],
@@ -50,7 +50,7 @@ module RSpec
                                               params:      request_params[:params])
           end
 
-          def prepare_request_params(description, request_params = {}, payload = {})
+          def prepare_request_params(description, request_params = {}, payload = {}, request_headers = {})
             example_params = description.split ' '
 
             {
@@ -58,7 +58,7 @@ module RSpec
               url:         prepare_request_url(example_params[1], request_params),
               example_url: example_params[1],
               params:      payload,
-              headers:     prepare_request_headers,
+              headers:     prepare_request_headers(request_headers),
             }
           end
 
@@ -76,11 +76,11 @@ module RSpec
             end
           end
 
-          def prepare_request_headers
+          def prepare_request_headers(headers = {})
             {
               'Accept'       => 'application/json',
               'Content-Type' => 'application/json',
-            }
+            }.merge headers
           end
 
           def prepare_status_code(description)

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

@@ -166,10 +166,13 @@ module RSpec
           if field[:type] && field[:type] == :object
             organize_params field[:properties] if field[:properties]
           else
-            {
+            properties = {
               type:        field[:type].to_s,
               description: field[:description] || nil,
             }
+
+            properties[:items] = {} if field[:type] == :array
+            properties
           end
         end
       end

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

@@ -3,7 +3,7 @@
 module RSpec
   module Rails
     module Api
-      VERSION = '0.1.0'
+      VERSION = '0.1.2'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rails-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Manuel Tancoigne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-21 00:00:00.000000000 Z
+date: 2019-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport