rspec-rails-swagger 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 30e7c45fb94e4b7f988d7d989276764e32963b33
-  data.tar.gz: 4b4f4491f8de4ce2bf4a531f004fc37122c318a7
+SHA256:
+  metadata.gz: de41f3d47e3469fc0fe09a379b42999cc53682686ff73c7dbe9c240166d33e93
+  data.tar.gz: 94d1a84a6177c62c39b2203612c1beb63a2fe8f2f7b8cda3372693d08e9238fc
 SHA512:
-  metadata.gz: 2c8267bd639942994777a10f7988f29fd2ffd291e52721998791f2c8567151addc095929907dae159abb57d30950304819036f674a4dc46a8d920e473bac8d78
-  data.tar.gz: 8f27c383b3d0b131986f3c5a2224b67cd479270433a52c3c96c56efc2ab77ebea9a67c8f14a73abdce3c768b6acd76cc38697e44fb28957b1c3e26b07d8bf9c8
+  metadata.gz: 6a0037db7e527b66aab7b738b9c43c5011ab18f941ac7a01a6d08cb8fd7f912f6d115709f18e2d4375d3ceff3490c27f599cd265468fdd6e0ef9a7d036ae0197
+  data.tar.gz: 6bc4fd57a755cacad9c7a5369cb5bb46330c80d88ffd5f2b56b5db495b45e2c7414683a782922a156f0e7c11c6a80ef3e86c7559ace706eefc3f8c1550a27e85

data/CONTRIBUTING.md

@@ -2,14 +2,14 @@
 
 ## Running tests
 
-The `make_site.sh` script will create a test site for a specific version of
-Rails and run the tests:
+The `scripts/make_site.sh` script will create a test site for a specific version of
+Rails:
 ```
-RAILS_VERSION=4.2.0
-./make_site.sh
+export RAILS_VERSION=4.2.0
+scripts/make_site.sh
 ```
 
-Once the test site is created you can just re-run the tests:
+Once the test site is created you can run the tests:
 ```
-bundle exec rspec
+scripts/run_tests.sh
 ```

data/README.md

@@ -37,7 +37,7 @@ rails generate rspec:swagger_install
 ## Documenting Your API
 
 Now you can edit `spec/swagger_helper.rb` and start filling in the top level
-Swagger documention, e.g. basePath, [definitions](http://swagger.io/specification/#definitionsObject),
+Swagger documentation, e.g. basePath, [definitions](http://swagger.io/specification/#definitionsObject),
 [parameters](http://swagger.io/specification/#parametersDefinitionsObject),
 [tags](http://swagger.io/specification/#tagObject), etc.
 
@@ -66,7 +66,7 @@ works pretty well and supports multiple documents.
 
 ## RSpec DSL
 
-The DSL follows the hierachy of the Swagger Schema:
+The DSL follows the hierarchy of the Swagger Schema:
 
 - [Paths Object](http://swagger.io/specification/#paths-object-29)
   - [Path Item Object](http://swagger.io/specification/#path-item-object-32)
@@ -98,7 +98,7 @@ RSpec.describe "Posts Controller", type: :request do
   # Path Object
   path '/posts/{post_id}' do
     # Parameter Object
-    parameter "post_id", {in: :path, type: :integer}
+    parameter "post_id", { in: :path, type: :integer }
     let(:post_id) { 1 }
 
     # Operation Object
@@ -107,6 +107,48 @@ RSpec.describe "Posts Controller", type: :request do
       response 200, description: "success"
     end
   end
+
+  # Path Post Object
+  path '/posts/' do
+    # Parameter Object for content type could be defined like:
+    consumes 'application/json'
+    # or:
+    parameter 'Content-Type', { in: :header, type: :string }
+    let(:'Content-Type') { 'application/json' }
+    # one of them would be considered
+
+    # authorization token in the header:
+    parameter 'Authorization', { in: :header, type: :string }
+    let(:'Authorization') { 'Bearer <token-here>' }
+
+    # Parameter Object
+    parameter "post_id", { in: :path, type: :integer }
+    let(:post_id) { 1 }
+
+    # Parameter Object for Body
+    parameter "body", { in: :body, required: true, schema: {
+      type: :object,
+        properties: {
+          title: { type: :string },
+          author_email: { type: :email }
+        }
+    }
+    let (:body) {
+      { post:
+        { title: 'my example',
+          author_email: 'me@example.com' }
+        }
+      }
+    }
+	# checkout http://swagger.io/specification/#parameter-object-44 for more information, options and details
+
+    # Operation Object
+    post summary: "update an item" do
+      # Response Object
+      response 200, description: "success"
+    end
+    # ...
+end
 ```
 
 
@@ -116,12 +158,44 @@ These methods are available inside of an RSpec contexts with the `type: :request
 #### `path(template, attributes = {}, &block)`
 Defines a new Path Item.
 
+The `attributes` parameter accepts:
+- `swagger_doc` a key in `RSpec.configuration.swagger_docs` that determines
+  which file the path belongs in.
+- `tags` with an array of tags that will be applied to the child Operations.
+
+You can also provide a default file and tags by setting them on a parent RSpec
+context block:
+```rb
+RSpec.describe "Sample Requests", type: :request do
+  # The swagger_doc will be used as a default for the paths defined within the
+  # context block. Similarly, the tags will be merged with those set on paths
+  # defined within them.
+  context "setting defaults", swagger_doc: 'default_document.json', tags: [:context_tag] do
+    path '/posts', swagger_doc: 'overridden_document.yaml' tags: ['path_tag'] do
+      operation "GET", summary: "fetch list" do
+        produces 'application/json'
+        tags 'operation_tag'
+
+        response(200, { description: "successful" })
+      end
+    end
+  end
+end
+```
+The `GET /posts` operation in this example will be saved in the `'overridden_document.yaml'`
+file and tagged with `["context_tag", "path_tag", "operation_tag"]`.
+
+
 ### Path Item Object
 These methods are available inside of blocks passed to the `path` method.
 
 #### `operation(method, attributes = {}, &block)`
 Defines a new Operation Object. The `method` is case insensitive.
 
+The `attributes` parameter accepts:
+- `tags` with an array of tags. These will be merged with tags passed to the
+  Path Item or `tags` method inside the Operation's block.
+
 #### `delete(attributes = {}, &block)`
 Alias for `operation(:delete, attributes, block)`.
 
@@ -161,7 +235,7 @@ parameter ref: "#/parameters/site_id"
 Values for the parameters are set using `let`:
 ```rb
 post summary: "create" do
-  parameter "body", in: :body, schema: { foo: :bar}
+  parameter "body", in: :body, schema: { foo: :bar }
   let(:body) { { post: { title: 'asdf', body: "blah" } } }
   # ...
 end
@@ -203,7 +277,7 @@ RSpec.describe "Sample Requests", type: :request, tags: [:context_tag] do
       produces 'application/json'
       tags 'operation_tag'
 
-      response(200, {description: "successful"})
+      response(200, { description: "successful" })
     end
   end
 end

data/lib/rspec/rails/swagger/formatter.rb

@@ -37,7 +37,7 @@ module RSpec
           return unless metadata[:swagger_object] == :response
 
           # Then add everything to the document
-          document  = document_for(metadata[:swagger_document])
+          document  = document_for(metadata[:swagger_doc])
           path_item = path_item_for(document, metadata[:swagger_path_item])
           operation = operation_for(path_item, metadata[:swagger_operation])
           response  = response_for(operation, metadata[:swagger_response])
@@ -73,7 +73,7 @@ module RSpec
         def write_file(name, document)
           output =
             if %w(.yaml .yml).include? File.extname(name)
-              YAML.dump(deep_stringify_keys(document))
+              YAML.dump(deep_stringify(document))
             else
               JSON.pretty_generate(document) + "\n"
             end
@@ -85,15 +85,19 @@ module RSpec
           target.write(output)
         end
 
-        # Lifted from ActiveSupport's Hash _deep_transform_keys_in_object
-        def deep_stringify_keys(object)
+        # Converts hash keys and symbolic values into strings.
+        #
+        # Based on ActiveSupport's Hash _deep_transform_keys_in_object
+        def deep_stringify(object)
           case object
           when Hash
             object.each_with_object({}) do |(key, value), result|
-              result[key.to_s] = deep_stringify_keys(value)
+              result[key.to_s] = deep_stringify(value)
             end
           when Array
-            object.map { |e| deep_stringify_keys(e) }
+            object.map { |e| deep_stringify(e) }
+          when Symbol
+            object.to_s
           else
             object
           end

data/lib/rspec/rails/swagger/helpers.rb

@@ -45,7 +45,7 @@ module RSpec
             #TODO template might be a $ref
             meta = {
               swagger_object: :path_item,
-              swagger_document: attributes[:swagger_document] || RSpec.configuration.swagger_docs.keys.first,
+              swagger_doc: attributes[:swagger_doc] || default_document,
               swagger_path_item: {path: template},
             }
             # Merge tags passed into the path with those from parent contexts.
@@ -54,6 +54,12 @@ module RSpec
             end
             describe(template, meta, &block)
           end
+
+          private
+
+          def default_document
+            metadata.try(:[], :swagger_doc) || RSpec.configuration.swagger_docs.keys.first
+          end
         end
 
         module PathItem
@@ -122,7 +128,7 @@ module RSpec
           def resolve_document metadata
             # TODO: It's really inefficient to keep recreating this. It'd be nice
             # if we could cache them some place.
-            name = metadata[:swagger_document]
+            name = metadata[:swagger_doc]
             Document.new(RSpec.configuration.swagger_docs[name])
           end
 

data/lib/rspec/rails/swagger/request_builder.rb

@@ -17,8 +17,7 @@ module RSpec
         # and parameter references can be resolved.
         def document
           @document ||= begin
-            name = metadata[:swagger_document]
-            Document.new(RSpec.configuration.swagger_docs[name])
+            Document.new(RSpec.configuration.swagger_docs[metadata[:swagger_doc]])
           end
         end
 

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

@@ -3,7 +3,7 @@ module RSpec
     # Version information for RSpec Swagger.
     module Swagger
       module Version
-        STRING = '0.1.5'
+        STRING = '0.2.0'
       end
     end
   end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rails-swagger
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - andrew morton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-06 00:00:00.000000000 Z
+date: 2019-08-28 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -82,8 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Generate Swagger docs from RSpec integration tests