apipie-rails 0.5.12 → 0.5.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ff91284d6576af7f50913921c4b677f67a1e163
-  data.tar.gz: 0cd61c342c534f728d0d210b47d28d1ccb903663
+  metadata.gz: 7a003368791253c56f130f6ff692225f71d51736
+  data.tar.gz: b0d9ea7bba052e5afbb460c6c2c2650609afdad3
 SHA512:
-  metadata.gz: 373f9ba52ccbec5af1691a8d8d58e9d5631903a0a356020c0ee5265dce36e7d9240a21ded67407ad2d8ded8642ef36a99b334919c738b0d441ab0cbb486c9411
-  data.tar.gz: c2fcf805fc6eb9a27826e1057780f53b06a20c05db585a4abd89f2fba9372c0a987cd3e54cdaf64b91ee19fa4c951e29a0a57b1db4bf374360d10e71ae752ab9
+  metadata.gz: 003c59006f91cab87c478740a851d06926fc4ee029420d054ede2d619245929f13af84ed53704a1708263b4e825ac37eb8e429f8927e7ca6e30ea05397ab6846
+  data.tar.gz: 8d3648f85b07e59313ae749397ed4ce965aed7dadd9d801f55dc1cefc296cb641e1740ba7be0141321b8347a844ea385655b58e1f75766605b536609b0c690d1

data/CHANGELOG.md

@@ -1,6 +1,10 @@
  Changelog
 ===========
 
+v0.5.13
+-------
+-  Fix swagger generation if a controller's parent doesn't define a resource_description [\#637](https://github.com/Apipie/apipie-rails/pull/637) ([enrique-guillen](https://github.com/enrique-guillen))
+
 v0.5.12
 -------
 - Fix returns displaying [\#635](https://github.com/Apipie/apipie-rails/pull/635) ([X1ting](https://github.com/X1ting))

data/README.rst

@@ -283,6 +283,8 @@ Example:
         property :enum1, ['v1', 'v2'], :desc => "One of 2 possible string values"
       end
    end
+   tags %w[profiles logins]
+   tags 'more', 'related', 'resources'
    description "method description"
    formats ['json', 'jsonp', 'xml']
    meta :message => "Some very important info"
@@ -1154,7 +1156,7 @@ You must then call the ``apipie_validations`` method yourself, e.g.:
 
 .. code:: ruby
 
-   before_action: :apipie_validations
+   before_action :apipie_validations
 
 This is useful if you have before_actions which use parameter values: just add them
 after the ``apipie_validations`` before_action.

data/lib/apipie/method_description.rb

@@ -101,7 +101,7 @@ module Apipie
       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 }
+      parent_tags = [parent, @resource].compact.flat_map { |resource| resource._tag_list_arg }
       Apipie::TagListDescription.new((parent_tags + @tag_list).uniq.compact)
     end
 

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.5.12'
+  VERSION = '0.5.13'
 end

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

@@ -3,7 +3,7 @@
 # defining a set of tags for the contained methods to include.
 #
 
-class TaggedCatsController < ApplicationController
+class TaggedCatsController < ActionController::Base
   resource_description do
     description 'A controller to test "returns"'
     short 'Pets'

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

@@ -0,0 +1,15 @@
+#
+# The TagsController defined here provides an example of a
+# tags call without a resource description.
+#
+
+class TaggedDogsController < ActionController::Base
+  #-----------------------------------------------------------
+  # simple 'returns' example: a method that returns a cat record
+  #-----------------------------------------------------------
+  api :GET, "/pets/:id/as_properties", "Get a dog record"
+  tags(%w[Dogs Wolves])
+  def show_as_properties
+    render :plain => "showing pet properties"
+  end
+end

data/spec/lib/swagger/swagger_dsl_spec.rb

@@ -448,6 +448,27 @@ describe "Swagger Responses" do
 
   end
 
+  #==============================================================================
+  # TaggedDogsController is a demonstration of how tags may be defined in a simple
+  # controller class without defining either the controller resource-description
+  # block or the controller's superclass's resource-description block.
+  #==============================================================================
+
+  describe TaggedDogsController do
+    describe "TaggedDogsController#show_as_properties" do
+      subject do
+        desc._methods[:show_as_properties]
+      end
+
+      it "should return tags with 'Dogs', and 'Wolves'" do
+        returns_obj = subject.tag_list
+        puts returns_obj.inspect
+
+        expect(returns_obj.tags).to eq(%w[Dogs Wolves])
+      end
+    end
+  end
+
   #==============================================================================
   # TaggedCatsController is a demonstration of how tags may be defined in the
   # controller's resource description so that they may be automatically prefixed

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.12
+  version: 0.5.13
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-17 00:00:00.000000000 Z
+date: 2018-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -266,6 +266,7 @@ files:
 - 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/tagged_dogs_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
@@ -361,6 +362,7 @@ test_files:
 - 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/tagged_dogs_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