adds getting of specified resource

Author: LeFnord

CHANGELOG.md

@@ -2,16 +2,17 @@
 
 #### Features
 
+* Your contribution here.
+* [#501](https://github.com/ruby-grape/grape-swagger/pull/501): Adds getting of a specified resource for Rake Tasks - [@LeFnord](https://github.com/LeFnord).
 * [#500](https://github.com/ruby-grape/grape-swagger/pull/500): Adds Rake tasks to get and validate OAPI/Swagger documentation - [@LeFnord](https://github.com/LeFnord).
 * [#493](https://github.com/ruby-grape/grape-swagger/pull/493): Swagger UI endpoint authorization. - [@texpert](https://github.com/texpert).
 * [#492](https://github.com/ruby-grape/grape/pull/492): Define security requirements on endpoint methods - [@tomregelink](https://github.com/tomregelink).
 * [#497](https://github.com/ruby-grape/grape-swagger/pull/497): Use ruby-grape-danger in Dangerfile - [@dblock](https://github.com/dblock).
-* Your contribution here.
 
 #### Fixes
 
-* [#494](https://github.com/ruby-grape/grape-swagger/pull/494): Header parametes are now included in documentation when body parameters have been defined - [@anakinj](https://github.com/anakinj).
 * Your contribution here.
+* [#494](https://github.com/ruby-grape/grape-swagger/pull/494): Header parametes are now included in documentation when body parameters have been defined - [@anakinj](https://github.com/anakinj).
 
 ### 0.23.0 (August 5, 2016)
 

README.md

@@ -803,10 +803,10 @@ end
 
 The Swagger UI on Grape could be secured from unauthorized access using any middleware, which provides certain methods:
 
-- a *before* method to be run in the Grape controller for authorization purpose; 
+- a *before* method to be run in the Grape controller for authorization purpose;
 - some guard method, which could receive as argument a string or an array of authorization scopes;
 - a method which processes and returns the access token received in the HTTP request headers (usually in the 'HTTP_AUTHORIZATION' header).
-  
+
 Below are some examples of securing the Swagger UI on Grape installed along with Ruby on Rails:
 
 - The WineBouncer and Doorkeeper gems are used in the examples;
@@ -828,9 +828,9 @@ This is how to configure the grape_swagger documentation:
 
 The guard method should inject the Security Requirement Object into the endpoint's route settings (see Grape::DSL::Settings.route_setting method).
 
-The 'oauth2 false' added to swagger_documentation is making the main Swagger endpoint protected with OAuth, i.e. it 
+The 'oauth2 false' added to swagger_documentation is making the main Swagger endpoint protected with OAuth, i.e. it
 is retreiving the access_token from the HTTP request, but the 'false' scope is for skipping authorization and showing
- the UI for everyone. If the scope would be set to something else, like 'oauth2 admin', for example, than the UI 
+ the UI for everyone. If the scope would be set to something else, like 'oauth2 admin', for example, than the UI
  wouldn't be displayed at all to unauthorized users.  
 
 Further on, the guard could be used, where necessary, for endpoint access protection. Put it prior to the endpoint's method:
@@ -841,20 +841,20 @@ Further on, the guard could be used, where necessary, for endpoint access protec
     get do
       render_users
     end
-    
+
     oauth2 'admin'
     post do
       User.create!...
     end
   end
 ```
 
-And, finally, if you want to not only restrict the access, but to completely hide the endpoint from unauthorized 
+And, finally, if you want to not only restrict the access, but to completely hide the endpoint from unauthorized
 users, you could pass a lambda to the :hidden key of a endpoint's description:
-   
+
 ```ruby
   not_admins = lambda { |token=nil| token.nil? || !User.find(token.resource_owner_id).admin? }
-  
+
   resource :users do
     desc 'Create user', hidden: not_admins
     oauth2 'admin'
@@ -864,8 +864,8 @@ users, you could pass a lambda to the :hidden key of a endpoint's description:
   end
 ```
 
-The lambda is checking whether the user is authenticated (if not, the token is nil by default), and has the admin 
-role - only admins can see this endpoint. 
+The lambda is checking whether the user is authenticated (if not, the token is nil by default), and has the admin
+role - only admins can see this endpoint.
 
 <a name="md_usage" />
 ## Markdown in Detail
@@ -1122,15 +1122,20 @@ GrapeSwagger::Rake::OapiTasks.new(::Api::Base)
 
 ```
 rake oapi:fetch
-rake oapi:fetch store=true # writes to swagger_doc.json
+params:
+- store={ true | file_name } – save as JSON (optional)
+- resource=resource_name     – get only for this one (optional)
 ```
 
 #### OpenApi/Swagger Validation
 
 **requires**: `npm` and `swagger-cli` to be installed
 
+
 ```
 rake oapi:validate
+params:
+- resource=resource_name – get only for this one (optional)
 ```
 
 

lib/grape-swagger/rake/oapi_tasks.rb

@@ -29,16 +29,22 @@ def define_tasks
       #
       # get swagger/OpenAPI documentation
       def fetch
-        desc 'generates OpenApi documentation (`store=true`, stores to FS)'
+        desc 'generates OpenApi documentation …
+          params (usage: key=value):
+          store    – save as JSON file, default: false            (optional)
+          resource - if given only for that it would be generated (optional)'
         task fetch: :environment do
           make_request
-          ENV['store'] ? File.write(file, @oapi) : print(@oapi)
+
+          save_to_file? ? File.write(file, @oapi) : print(@oapi)
         end
       end
 
       # validates swagger/OpenAPI documentation
       def validate
-        desc 'validates the generated OpenApi file'
+        desc 'validates the generated OpenApi file …
+          params (usage: key=value):
+          resource - if given only for that it would be generated (optional)'
         task validate: :environment do
           ENV['store'] = 'true'
           ::Rake::Task['oapi:fetch'].invoke
@@ -59,19 +65,24 @@ def make_request
           JSON.parse(
             last_response.body, symolize_names: true
           )
-        )
+        ) + "\n"
       end
 
       def url_for
         oapi_route = api_class.routes[-2]
-        url = '/swagger_doc'
-        url = "/#{oapi_route.version}#{url}" if oapi_route.version
-        url = "/#{oapi_route.prefix}#{url}" if oapi_route.prefix
-        url
+        path = oapi_route.pattern.origin
+        path.sub!(':version', oapi_route.version.to_s)
+
+        [path, ENV['resource']].join('/').chomp('/')
+      end
+
+      def save_to_file?
+        ENV['store'] && JSON.parse(@oapi).keys.first != 'error'
       end
 
       def file
-        File.join(Dir.getwd, 'swagger_doc.json')
+        name = ENV['store'] == 'true' || ENV['store'].blank? ? 'swagger_doc.json' : ENV['store']
+        File.join(Dir.getwd, name)
       end
 
       def app