weak_swagger_parameters 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 589aa60bdf2a8aa4440760767a381550ad571bc8
-  data.tar.gz: 51ba734c3937cd9f7638f1227c7fb52dc358c582
+  metadata.gz: 85e46ed943f82522b4affcca0fbe25da225527c8
+  data.tar.gz: e8f515e3aa857121ec296d75c7783cdb0758334c
 SHA512:
-  metadata.gz: ff490d4fab86590a2d39655a3919c07c2f6034daf83fdc06d631147ebecc34bdeaa90123ac394fbde2cd070d39143e5a62ba66b5d1ffe76c14fc8a8ac11dbc6d
-  data.tar.gz: 93f1d65d0aa7c5315498a7c7585aa9ca904cc75ee37d2abbfeb43d45abb1f208bd95130d802b8f9dfe846bd1a8edcfc699b783921f124713de7bebec103b604d
+  metadata.gz: db40e7a3e5b89864cc151dc2f516d0769a1134bed82a3d6308506de488b720f1eae1052286a058546695f78dcaaa64c3d0ba10409b32e5b46b5de1a79043524c
+  data.tar.gz: 5e261df19f41b3c7a99e0c381d21b695df5997ae306390b25fa3913918399effd8fc0c9d9b88a9746fb41fbe2786df500fbc15e081ce8f1b672874d35f5d21e4

data/README.md

@@ -4,9 +4,7 @@
 
 # WeakSwaggerParameters
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/weak_swagger_parameters`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is an integration gem between `weak_parameters` and `swagger-blocks` to allow creating interactive swagger documentation and input parameter validation without duplicating the definitions using both DSLs.
 
 ## Installation
 
@@ -18,25 +16,103 @@ gem 'weak_swagger_parameters'
 
 And then execute:
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install weak_swagger_parameters
+    $ bundle install
 
 ## Usage
 
-TODO: Write usage instructions here
+(1) Add route to a docs controller to serve Swagger v2.0 json
+````ruby
+# routes.rb
+
+namespace :v1 do
+  resources :docs, only: [:index]
+end
+````
+
+(2) Create a controller for serving the Swagger v2.0 json
+````ruby
+module V1
+  class DocsController < ActionController::Base
+    include WeakSwaggerParameters::Controller
+ 
+    add_to_doc_section('V1')
+ 
+    swagger_root swagger: '2.0' do
+      info version: '1.0', title: 'The best api', description: 'Api that does everything'
+      key :host, 'example.com'
+      key :consumes, ['application/json']
+      key :produces, ['application/json']
+    end
+    def index
+      render_docs('V1')
+    end
+  end
+end
+````
+
+(3) Add metadata to existing controllers for them to show up in the documentation
+
+````ruby
+  class ItemsController < ActionController::Base
+    include WeakSwaggerParameters::Controller
+
+    add_to_doc_section('V1')
+
+    api :create, '/tests', 'Create test' do
+      params do
+        path do
+          string :short_name, 'Short test name'
+          integer :count, 'Count of tests'
+        end
+        query do
+          string :token, 'The token'
+        end
+        body do
+          string :subject, 'The unit under test'
+          string :context, 'The context of the test'
+          integer :runs, 'Run times'
+          boolean :passed, 'Passed'
+          boolean :boolean_required, 'Boolean required', required: true
+          string :string_required, 'String required', required: true
+          integer :integer_required, 'Integer required', required: true
+          string :string_enum, 'String enum', enum: %w(a b c)
+          string :string_default, 'String default', default: 'origin'
+        end
+      end
+      response 201, 'Created the test'
+      response 400, 'Bad Request'
+    end
+    def create
+      # ...
+    end
+  end
+````
+
+For complete examples, see the specs.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Install dependencies
+  
+```
+  bundle install
+```
+
+Run Specs
+  
+```
+  bundle exec rake rspec
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Run Rubocop
+  
+```
+  bundle exec rake rubocop
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/weak_swagger_parameters. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/AgileFreaks/weak_swagger_parameters. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/weak_swagger_parameters/controller.rb

@@ -13,8 +13,30 @@ module WeakSwaggerParameters
         (@doc_sections || []).include?(doc_section)
       end
 
-      def api(method, path, description, &block)
-        api_docs = WeakSwaggerParameters::Definitions::Api.new(method, path, description, &block)
+      def get(action, path, description, &block)
+        api(:get, action, path, description, &block)
+      end
+
+      def post(action, path, description, &block)
+        api(:post, action, path, description, &block)
+      end
+
+      def put(action, path, description, &block)
+        api(:put, action, path, description, &block)
+      end
+
+      def patch(action, path, description, &block)
+        api(:patch, action, path, description, &block)
+      end
+
+      def delete(action, path, description, &block)
+        api(:delete, action, path, description, &block)
+      end
+
+      private
+
+      def api(http_method, action, path, description, &block)
+        api_docs = WeakSwaggerParameters::Definitions::Api.new(http_method, action, path, description, &block)
         api_docs.apply_validations(self)
         api_docs.apply_docs(self)
       end

data/lib/weak_swagger_parameters/definitions/api.rb

@@ -2,25 +2,18 @@
 module WeakSwaggerParameters
   module Definitions
     class Api
-      KNOWN_METHODS = {
-        create: :post,
-        index: :get,
-        show: :get,
-        destroy: :delete,
-        update: :put
-      }.freeze
-
       attr_reader :path
 
-      def initialize(method, path, summary, &block)
-        @method = method
+      def initialize(http_method, action, path, summary, &block)
+        @http_method = http_method
+        @action = action
         @path = path
         @summary = summary
         @param_definition = nil
         @response_definitions = []
         @description = nil
 
-        instance_eval(&block)
+        instance_eval(&block) if block.present?
       end
 
       def description(description)
@@ -31,16 +24,16 @@ module WeakSwaggerParameters
         @param_definition = WeakSwaggerParameters::Definitions::Params.new(&block)
       end
 
-      def response(status_code, description)
+      def response(status_code, description = '')
         @response_definitions << WeakSwaggerParameters::Definitions::Response.new(status_code, description)
       end
 
       def apply_validations(controller_class)
         child_definitions = validation_definitions
-        method = @method
+        action = @action
 
         controller_class.instance_eval do
-          validates method do
+          validates action do
             child_definitions.each { |definition| definition.apply_validations(self) }
           end
         end
@@ -48,11 +41,12 @@ module WeakSwaggerParameters
 
       def apply_docs(controller_class)
         this = self
+        http_method = @http_method
         operation_params = operation_params(http_method, controller_class)
 
         controller_class.instance_eval do
           swagger_path this.path do
-            operation this.http_method, operation_params do
+            operation http_method, operation_params do
               this.child_definitions.each { |definition| definition.apply_docs(self) }
             end
           end
@@ -60,24 +54,20 @@ module WeakSwaggerParameters
       end
 
       def child_definitions
-        validation_definitions + @response_definitions
-      end
-
-      def http_method
-        KNOWN_METHODS[@method]
+        (validation_definitions + @response_definitions).compact
       end
 
       private
 
       def validation_definitions
-        [@param_definition]
+        [@param_definition].compact
       end
 
       def operation_params(method, controller_class)
         name = resource_name(controller_class)
         {
           summary: @summary,
-          operationId: operation_id(method, name),
+          operationId: operation_id(method, controller_class),
           tags: [name]
         }.tap do |h|
           h[:description] = @description unless @description.blank?
@@ -88,8 +78,8 @@ module WeakSwaggerParameters
         controller_class.controller_name.humanize
       end
 
-      def operation_id(method, name)
-        "#{method}#{name}"
+      def operation_id(method, controller_class)
+        "#{method}_#{controller_class.controller_name}".camelize(:lower)
       end
     end
   end

data/lib/weak_swagger_parameters/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module WeakSwaggerParameters
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/weak_swagger_parameters.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rails', '>= 4', '< 5'
+  spec.add_dependency 'rails', '>= 4'
   spec.add_dependency 'weak_parameters', '~> 0.4'
   spec.add_dependency 'swagger-blocks', '~> 1.3'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weak_swagger_parameters
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - AgileFreaks
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-28 00:00:00.000000000 Z
+date: 2016-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
 - !ruby/object:Gem::Dependency
   name: weak_parameters
   requirement: !ruby/object:Gem::Requirement
@@ -209,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Generate docs and Validate request parameters