apipie-rails 0.5.10 → 0.5.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6bcdf76f920b92251c36c8c5d1ca0b3faf7094b1
-  data.tar.gz: afaa0c9b44801726cd6f20dfedf787c18098bb95
+  metadata.gz: e7d88dded075d493175af924c28b12d0a5f8bf1e
+  data.tar.gz: ecb35e91359fe60787a7364a9b427f0322260f30
 SHA512:
-  metadata.gz: fcc628dd565f89b38772f807c3ed5b08be2c372710fca2bb630d5a04be492277c9be5cc5fecaa7bb5ac59a7e808e3e5154ac8b7236e26d5c3ed536bab5e2907f
-  data.tar.gz: 581b097b15f2ba84e13cd1124899f10dafcbf10999ad4097ddefb27cd0dedb50d05c5bd3a910fbf52083a008dcc3ed08b0f2a53e9f1cfd2cdfb31f2e51e6aac9
+  metadata.gz: cdd586c211924d6c84830aa2d014355edef2e7c63fd7e3e90e2c02beba0ad440e756244fadaf96178b57d9a2fce45c3e0177ef95d941a6096ce876f8c318f68c
+  data.tar.gz: 17381631aa321f511da743d329b6c0cbfd08d4b12581ab83b2f15f9ba07ab0ef02fbc11fadacdc7bdcbd13797262278f1df71a460c75e90cf0a44721ead062c7

data/CHANGELOG.md

@@ -1,6 +1,13 @@
  Changelog
 ===========
 
+v0.5.11
+-------
+
+- Adds swagger tags in swagger output [\#634](https://github.com/Apipie/apipie-rails/pull/634) ([enrique-guillen](https://github.com/enrique-guillen))
+- Generate swagger with headers [\#630](https://github.com/Apipie/apipie-rails/pull/630) ([Uysim](https://github.com/Uysim))
+- Fix examples not being generated for Rails < 5.0.0 [\#633](https://github.com/Apipie/apipie-rails/pull/633) ([RomanKapitonov](https://github.com/RomanKapitonov))
+
 v0.5.10
 ------
 

data/Gemfile.rails50

@@ -2,6 +2,7 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '~> 5.0'
+gem 'rails', '~> 5.0.0'
 gem 'mime-types', '~> 2.99.3'
 gem 'rails-controller-testing'
+

data/README.rst

@@ -222,6 +222,12 @@ param
 returns
   Look at `Response description`_ section for details.
 
+tags
+  Adds tags for grouping operations together in Swagger outputs. See `swagger`_
+  for more details. You can also provide tags in the `Resource Description`_
+  block so that they are automatically prepended to all action tags in the
+  controller.
+
 formats
   Method level request / response formats.
 

data/lib/apipie-rails.rb

@@ -15,6 +15,7 @@ require "apipie/error_description"
 require "apipie/response_description"
 require "apipie/response_description_adapter"
 require "apipie/see_description"
+require "apipie/tag_list_description"
 require "apipie/validator"
 require "apipie/railtie"
 require 'apipie/extractor'

data/lib/apipie/dsl_definition.rb

@@ -32,10 +32,11 @@ module Apipie
          :api_args          => [],
          :api_from_routes   => nil,
          :errors            => [],
+         :tag_list          => [],
          :returns           => {},
          :params            => [],
          :headers           => [],
-         :resource_id        => nil,
+         :resource_id       => nil,
          :short_description => nil,
          :description       => nil,
          :examples          => [],
@@ -222,6 +223,13 @@ module Apipie
         _apipie_dsl_data[:errors] << [code_or_options, desc, options]
       end
 
+      # Add tags to resources and actions group operations together.
+      def tags(*args)
+        return unless Apipie.active_dsl?
+        tags = args.length == 1 ? args.first : args
+        _apipie_dsl_data[:tag_list] += tags
+      end
+
       def _apipie_define_validators(description)
 
         # [re]define method only if validation is turned on

data/lib/apipie/extractor.rb

@@ -16,7 +16,14 @@ class Apipie::Railtie
       end
     end
     app.middleware.use ::Apipie::Extractor::Recorder::Middleware
-    ActionController::TestCase.send(:prepend, Apipie::Extractor::Recorder::FunctionalTestRecording)
+
+    if Gem::Version.new(Rails.version) < Gem::Version.new('5.0.0')
+      ActionController::TestCase::Behavior.instance_eval do
+        prepend Apipie::Extractor::Recorder::FunctionalTestRecording
+      end
+    else
+      ActionController::TestCase.send(:prepend, Apipie::Extractor::Recorder::FunctionalTestRecording)
+    end
   end
 end
 

data/lib/apipie/method_description.rb

@@ -34,6 +34,8 @@ module Apipie
         Apipie::ErrorDescription.from_dsl_data(args)
       end
 
+      @tag_list = dsl_data[:tag_list]
+
       @returns = dsl_data[:returns].map do |code,args|
         Apipie::ResponseDescription.from_dsl_data(self, code, args)
       end
@@ -94,6 +96,15 @@ module Apipie
       @returns
     end
 
+    def tag_list
+      all_tag_list = []
+      parent = Apipie.get_resource_description(@resource.controller.superclass)
+
+      # get tags from parent resource description
+      parent_tags = [parent, @resource].flat_map { |resource| resource._tag_list_arg }
+      Apipie::TagListDescription.new((parent_tags + @tag_list).uniq.compact)
+    end
+
     def returns
       all_returns = []
       parent = Apipie.get_resource_description(@resource.controller.superclass)

data/lib/apipie/resource_description.rb

@@ -14,8 +14,8 @@ module Apipie
   class ResourceDescription
 
     attr_reader :controller, :_short_description, :_full_description, :_methods, :_id,
-      :_path, :_name, :_params_args, :_returns_args, :_errors_args, :_formats, :_parent, :_metadata,
-      :_headers, :_deprecated
+      :_path, :_name, :_params_args, :_returns_args, :_tag_list_arg, :_errors_args,
+      :_formats, :_parent, :_metadata, :_headers, :_deprecated
 
     def initialize(controller, resource_name, dsl_data = nil, version = nil, &block)
 
@@ -42,6 +42,7 @@ module Apipie
       @_errors_args = dsl_data[:errors]
       @_params_args = dsl_data[:params]
       @_returns_args = dsl_data[:returns]
+      @_tag_list_arg = dsl_data[:tag_list]
       @_metadata = dsl_data[:meta]
       @_api_base_url = dsl_data[:api_base_url]
       @_headers = dsl_data[:headers]

data/lib/apipie/swagger_generator.rb

@@ -224,7 +224,7 @@ module Apipie
         @current_http_method = method_key
 
         methods[method_key] = {
-            tags: [tag_name_for_resource(ruby_method.resource)] + warning_tags,
+            tags: [tag_name_for_resource(ruby_method.resource)] + warning_tags + ruby_method.tag_list.tags,
             consumes: params_in_body? ? ['application/json'] : ['application/x-www-form-urlencoded', 'multipart/form-data'],
             operationId: op_id,
             summary: Apipie.app.translate(api.short_description, @current_lang),
@@ -643,10 +643,27 @@ module Apipie
         add_params_from_hash(swagger_result, body_param_defs_hash)
       end
 
+      add_headers_from_hash(swagger_result, method.headers) if method.headers.present?
+
       swagger_result
     end
 
 
+    def add_headers_from_hash(swagger_params_array, headers)
+      swagger_headers = headers.map do |header|
+        {
+          name: header[:name],
+          in: 'header',
+          required: header[:options][:required],
+          description: header[:description],
+          type:  header[:options][:type] || 'string'
+        }
+
+      end
+      swagger_params_array.push(*swagger_headers)
+    end
+
+
     def add_params_from_hash(swagger_params_array, param_defs, prefix=nil, default_value_for_in=nil)
 
       if default_value_for_in
@@ -684,7 +701,7 @@ module Apipie
         end
       end
     end
-    
+
   end
 
 end

data/lib/apipie/tag_list_description.rb

@@ -0,0 +1,11 @@
+module Apipie
+
+  class TagListDescription
+
+    attr_reader :tags
+
+    def initialize(tags); @tags = tags; end
+
+  end
+
+end

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.5.10'
+  VERSION = '0.5.11'
 end

data/spec/controllers/apipies_controller_spec.rb

@@ -143,6 +143,7 @@ describe Apipie::ApipiesController do
       assert_response :success
       expect(response.body).to match(/"swagger":"2.0"/)
       # puts response.body
+
       expect(JSON::Validator.validate(swagger_schema, response.body)).to be_truthy
     end
 

data/spec/controllers/users_controller_spec.rb

@@ -482,7 +482,8 @@ describe UsersController do
             name: :OptionalHeaderName,
             description: 'Optional header description',
             options: {
-              required: false
+              required: false,
+              type: "string"
             }
           }
         end

data/spec/dummy/app/controllers/pets_controller.rb

@@ -395,6 +395,14 @@ class PetsController < ApplicationController
   end
 
 
+  #-----------------------------------------------------------
+  # A method with simple tags.
+  #-----------------------------------------------------------
+  api!
+  tags(%w[Dogs Cats LivingBeings])
+  def show_plain_response_with_tags
+    render :plain => "showing pet properties"
+  end
 
 end
 

data/spec/dummy/app/controllers/tagged_cats_controller.rb

@@ -0,0 +1,32 @@
+#
+# The TagsController defined here provides an example of a resource_description
+# defining a set of tags for the contained methods to include.
+#
+
+class TaggedCatsController < ApplicationController
+  resource_description do
+    description 'A controller to test "returns"'
+    short 'Pets'
+    path '/pets'
+
+    tags(%w[Dogs Pets])
+  end
+
+  #-----------------------------------------------------------
+  # simple 'returns' example: a method that returns a cat record
+  #-----------------------------------------------------------
+  api :GET, "/pets/:id/as_properties", "Get a cat record"
+  tags(%w[Animals])
+  def show_as_properties
+    render :plain => "showing pet properties"
+  end
+
+  #-----------------------------------------------------------
+  # simple 'returns' example: a method that returns another cat record
+  #-----------------------------------------------------------
+  api :GET, "/pets/:id/as_same_properties", "Get a cat record"
+  tags("Puma", "Animals")
+  def show_as_same_properties
+    render :plain => "showing pet properties"
+  end
+end

data/spec/dummy/app/controllers/twitter_example_controller.rb

@@ -299,4 +299,9 @@ class TwitterExampleController < ApplicationController
     render :text => 'twitter example'
   end
   
+  api :GET, '/twitter_example/{id}/followers', 'Find the followers for the given screen name'
+  tags %w[following index search]
+  def followers
+    render :text => 'followers'
+  end
 end

data/spec/dummy/app/controllers/users_controller.rb

@@ -291,7 +291,7 @@ class UsersController < ApplicationController
 
   api :GET, '/users/action_with_headers'
   header :RequredHeaderName, 'Required header description', required: true
-  header :OptionalHeaderName, 'Optional header description', required: false
+  header :OptionalHeaderName, 'Optional header description', required: false, type: 'string'
   def action_with_headers
   end
 end

data/spec/lib/swagger/openapi_2_0_schema.json

@@ -1604,4 +1604,4 @@
       }
     }
   }
-}
+}

data/spec/lib/swagger/rake_swagger_spec.rb

@@ -51,6 +51,10 @@ describe 'rake tasks' do
       expect(param[field]).to eq(value)
     end
 
+    def expect_tags_def(http_method, path, value)
+      params = apidoc_swagger["paths"][path][http_method]["tags"]
+      expect(params).to eq(value)
+    end
 
     def body_param_def(http_method, path, param_name)
       params = apidoc_swagger["paths"][path][http_method]["parameters"]
@@ -88,6 +92,8 @@ describe 'rake tasks' do
         expect_param_def("get", "/users/by_department", "department", "in", "query")
         expect_param_def("get", "/users/by_department", "department", "enum",
                          ["finance", "operations", "sales", "marketing", "HR"])
+
+        expect_tags_def("get", "/twitter_example/{id}/followers", %w[twitter_example following index search])
       end
 
       it "generates a valid swagger file" do
@@ -113,6 +119,8 @@ describe 'rake tasks' do
         expect_param_def("get", "/users/by_department", "department", "enum",
                          ["finance", "operations", "sales", "marketing", "HR"])
 
+        expect_tags_def("get", "/twitter_example/{id}/followers", %w[twitter_example following index search])
+
       end
 
       it "generates a valid swagger file" do

data/spec/lib/swagger/response_validation_spec.rb

@@ -101,4 +101,4 @@ RSpec.describe PetsController, :type => :controller do
 
 
 
-end
+end

data/spec/lib/swagger/swagger_dsl_spec.rb

@@ -166,6 +166,19 @@ describe "Swagger Responses" do
 
     end
 
+    describe "PetsController#show_plain_response_with_tags" do
+      subject do
+        desc._methods[:show_plain_response_with_tags]
+      end
+
+      it "should return tags with 'Dogs', 'Cats', and 'LivingBeings'" do
+        returns_obj = subject.tag_list
+        puts returns_obj.inspect
+
+        expect(returns_obj.tags).to eq(%w[Dogs Cats LivingBeings])
+      end
+    end
+
     describe "PetsController#show_as_properties" do
       subject do
         desc._methods[:show_as_properties]
@@ -435,6 +448,40 @@ describe "Swagger Responses" do
 
   end
 
+  #==============================================================================
+  # TaggedCatsController is a demonstration of how tags may be defined in the
+  # controller's resource description so that they may be automatically prefixed
+  # to a particular operation's tags.
+  #==============================================================================
+
+  describe TaggedCatsController do
+    describe "TaggedCatsController#show_as_properties" do
+      subject do
+        desc._methods[:show_as_properties]
+      end
+
+      it "should return tags with 'Dogs', 'Pets', and 'Animals'" do
+        returns_obj = subject.tag_list
+        puts returns_obj.inspect
+
+        expect(returns_obj.tags).to eq(%w[Dogs Pets Animals])
+      end
+    end
+
+    describe "TaggedCatsController#show_as_same_properties" do
+      subject do
+        desc._methods[:show_as_same_properties]
+      end
+
+      it "should return tags with 'Dogs', 'Pets', 'Puma', and 'Animals'" do
+        returns_obj = subject.tag_list
+        puts returns_obj.inspect
+
+        expect(returns_obj.tags).to eq(%w[Dogs Pets Puma Animals])
+      end
+    end
+  end
+
   #==============================================================================
   # PetsUsingSelfDescribingClassesController is a demonstration of how
   # responses can be described using manual generation of a property description
@@ -558,6 +605,7 @@ describe "Swagger Responses" do
 
         expect(returns_obj.code).to eq(200)
         expect(returns_obj.is_array?).to eq(false)
+
         expect(returns_obj).to match_field_structure([:pet_name, :animal_type, :age])
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.10
+  version: 0.5.11
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-24 00:00:00.000000000 Z
+date: 2018-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -229,6 +229,7 @@ files:
 - lib/apipie/see_description.rb
 - lib/apipie/static_dispatcher.rb
 - lib/apipie/swagger_generator.rb
+- lib/apipie/tag_list_description.rb
 - lib/apipie/validator.rb
 - lib/apipie/version.rb
 - lib/generators/apipie/install/README
@@ -264,6 +265,7 @@ files:
 - spec/dummy/app/controllers/pets_controller.rb
 - spec/dummy/app/controllers/pets_using_auto_views_controller.rb
 - spec/dummy/app/controllers/pets_using_self_describing_classes_controller.rb
+- spec/dummy/app/controllers/tagged_cats_controller.rb
 - spec/dummy/app/controllers/twitter_example_controller.rb
 - spec/dummy/app/controllers/users_controller.rb
 - spec/dummy/app/views/layouts/application.html.erb
@@ -358,6 +360,7 @@ test_files:
 - spec/dummy/app/controllers/pets_controller.rb
 - spec/dummy/app/controllers/pets_using_auto_views_controller.rb
 - spec/dummy/app/controllers/pets_using_self_describing_classes_controller.rb
+- spec/dummy/app/controllers/tagged_cats_controller.rb
 - spec/dummy/app/controllers/twitter_example_controller.rb
 - spec/dummy/app/controllers/users_controller.rb
 - spec/dummy/app/views/layouts/application.html.erb