swaggard 0.0.4

data/lib/swaggard/parsers/routes.rb

@@ -0,0 +1,54 @@
+module Swaggard
+  module Parsers
+    class Routes
+
+      def run(routes)
+        return {} unless routes
+
+        parsed_routes = {}
+
+        routes.each do |route|
+          controller = route_controller(route)
+          action = route_action(route)
+
+          parsed_routes[controller] ||= {}
+          parsed_routes[controller][action] = {
+            verb:         route_verb(route),
+            path:         route_path(route),
+            path_params:  route_path_params(route)
+          }
+        end
+
+        parsed_routes
+      end
+
+      private
+
+      def route_controller(route)
+        route.requirements[:controller]
+      end
+
+      def route_action(route)
+        route.requirements[:action]
+      end
+
+      def route_verb(route)
+        route.verb.source.gsub(/[$^]/, '')
+      end
+
+      def route_path(route)
+        path = route.path.spec.to_s
+
+        path.gsub!('(.:format)', '')
+        route.required_parts.each { |part| path.gsub!(":#{part}", "{#{part}}") }
+
+        path
+      end
+
+      def route_path_params(route)
+        route.required_parts
+      end
+
+    end
+  end
+end

data/lib/swaggard/swagger/definition.rb

@@ -0,0 +1,24 @@
+module Swaggard
+  module Swagger
+    class Definition
+
+      attr_reader :id
+
+      def initialize(id)
+        @id = id
+        @properties = []
+      end
+
+      def add_property(property)
+        @properties << property
+      end
+
+      def to_doc
+        {
+          'properties' => Hash[@properties.map { |property| [property.id, property.to_doc] }]
+        }
+      end
+
+    end
+  end
+end

data/lib/swaggard/swagger/operation.rb

@@ -0,0 +1,98 @@
+require_relative 'parameters/body'
+require_relative 'parameters/form'
+require_relative 'parameters/list'
+require_relative 'parameters/path'
+require_relative 'parameters/query'
+
+require_relative 'response'
+
+module Swaggard
+  module Swagger
+    class Operation
+
+      attr_reader :nickname
+      attr_accessor :path, :parameters, :description, :http_method, :summary, :notes,
+                    :error_responses, :tag
+
+      def initialize(yard_object, tag, routes)
+        @name = yard_object.name
+        @tag = tag
+        @summary = yard_object.docstring.lines.first || ''
+        @parameters  = []
+        @responses = []
+        @description = (yard_object.docstring.lines[1..-1] || []).join("\n")
+        @formats = Swaggard.configuration.api_formats
+
+        yard_object.tags.each do |yard_tag|
+          value = yard_tag.text
+
+          case yard_tag.tag_name
+          when 'query_parameter'
+            @parameters << Parameters::Query.new(value)
+          when 'form_parameter'
+            @parameters << Parameters::Form.new(value)
+          when 'body_parameter'
+            body_parameter.add_property(value)
+          when 'parameter_list'
+            @parameters << Parameters::List.new(value)
+          when 'response_class'
+            @responses << Response.new(200, value)
+          end
+        end
+
+        build_path_parameters(routes)
+
+        @parameters.sort_by { |parameter| parameter.name }
+      end
+
+      def valid?
+        @path.present?
+      end
+
+      def to_doc
+        produces = @formats.map { |format| "application/#{format}" }
+        consumes = @formats.map { |format| "application/#{format}" }
+
+        {
+          'tags'           => [@tag.name],
+          'summary'        => @summary,
+          'description'    => @description,
+          'operationId'    => @name,
+          'consumes'       => consumes,
+          'produces'       => produces,
+          'parameters'     => @parameters.map(&:to_doc),
+          'responses'      => Hash[@responses.map { |response| [response.status_code, response.to_doc] }]
+        }
+      end
+
+      def definitions
+        @body_parameter ? [@body_parameter.definition] : []
+      end
+
+      private
+
+      def body_parameter
+        return @body_parameter if @body_parameter
+
+        @body_parameter = Parameters::Body.new("#{@tag.controller_class.to_s}.#{@name}")
+        @parameters << @body_parameter
+
+        @body_parameter
+      end
+
+      def build_path_parameters(routes)
+        return unless @tag.controller_class
+
+        route = (routes[@tag.controller_class.controller_path] || {})[@name.to_s]
+
+        return unless route
+
+        @http_method = route[:verb]
+        @path = route[:path]
+
+        route[:path_params].each { |path_param| @parameters << Parameters::Path.new(path_param) }
+      end
+
+    end
+  end
+end

data/lib/swaggard/swagger/parameters/base.rb

@@ -0,0 +1,21 @@
+module Swaggard
+  module Swagger
+    module Parameters
+      class Base
+
+        attr_reader :name
+
+        def to_doc
+          {
+            'in'            => @in,
+            'name'          => @name,
+            'description'   => @description,
+            'required'      => @is_required,
+            'type'          => @data_type
+          }
+        end
+
+      end
+    end
+  end
+end

data/lib/swaggard/swagger/parameters/body.rb

@@ -0,0 +1,67 @@
+require_relative 'base'
+require_relative '../type'
+
+module Swaggard
+  module Swagger
+    module Parameters
+      class Body < Base
+
+        attr_reader :definition
+
+        def initialize(operation_name)
+          @in           = 'body'
+          @name         = 'body'
+          @description  = ''
+          @definition   = Definition.new("#{operation_name}_body")
+        end
+
+        def add_property(string)
+          property = Property.new(string)
+          @definition.add_property(property)
+        end
+
+        def to_doc
+          doc = super
+
+          doc.delete('type')
+
+          doc['required'] = false
+          doc['schema'] = { '$ref' => "#/definitions/#{@definition.id}" }
+
+          doc
+        end
+
+        private
+
+
+        class Property
+
+          attr_reader :id
+
+          def initialize(string)
+            parse(string)
+          end
+
+          def to_doc
+            result = @type.to_doc
+            result['description'] = @description if @description
+            result
+          end
+
+          # Example: [Array]     status            Filter by status. (e.g. status[]=1&status[]=2&status[]=3)
+          # Example: [Array]     status(required)  Filter by status. (e.g. status[]=1&status[]=2&status[]=3)
+          # Example: [Integer]   media[media_type_id]                          ID of the desired media type.
+          def parse(string)
+            data_type, name, required, description = string.match(/\A\[(\w*)\]\s*([\w\[\]]*)(\(required\))?\s*(.*)\Z/).captures
+
+            @id = name
+            @description = description
+            @type = Type.new([data_type.downcase])
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/swaggard/swagger/parameters/form.rb

@@ -0,0 +1,32 @@
+require_relative 'base'
+
+module Swaggard
+  module Swagger
+    module Parameters
+      class Form < Base
+
+        def initialize(string)
+          @in = 'formData'
+          parse(string)
+        end
+
+        private
+
+        # Example: [Array]     status            Filter by status. (e.g. status[]=1&status[]=2&status[]=3)
+        # Example: [Array]     status(required)  Filter by status. (e.g. status[]=1&status[]=2&status[]=3)
+        # Example: [Integer]   media[media_type_id]                          ID of the desired media type.
+        def parse(string)
+          data_type, name, required, description = string.match(/\A\[(\w*)\]\s*([\w\[\]]*)(\(required\))?\s*(.*)\Z/).captures
+          allow_multiple = name.gsub!('[]', '')
+
+          @name = name
+          @description = description
+          @data_type = data_type.downcase
+          @is_required = required.present?
+          @allow_multiple = allow_multiple.present?
+        end
+
+      end
+    end
+  end
+end

data/lib/swaggard/swagger/parameters/list.rb

@@ -0,0 +1,46 @@
+require_relative 'base'
+
+module Swaggard
+  module Swagger
+    module Parameters
+      class List < Base
+
+        def initialize(string)
+          @in = 'query'
+          parse(string)
+        end
+
+        def to_doc
+          doc = super
+
+          doc.merge(
+            {
+              'type'            => 'array',
+              'items'           => { 'type' => @data_type },
+              'enum'            => @list_values
+            }
+          )
+        end
+
+        private
+
+        # Example: [String]    sort_order  Orders ownerships by fields. (e.g. sort_order=created_at)
+        #          [List]      id
+        #          [List]      begin_at
+        #          [List]      end_at
+        #          [List]      created_at
+        def parse(string)
+          data_type, name, required, description, set_string = string.match(/\A\[(\w*)\]\s*(\w*)(\(required\))?\s*(.*)\n([.\s\S]*)\Z/).captures
+
+          @list_values = set_string.split('[List]').map(&:strip).reject { |string| string.empty? }
+
+          @name = name
+          @description = description
+          @data_type = data_type.downcase
+          @is_required = required.present?
+        end
+
+      end
+    end
+  end
+end

data/lib/swaggard/swagger/parameters/path.rb

@@ -0,0 +1,21 @@
+require_relative 'base'
+
+module Swaggard
+  module Swagger
+    module Parameters
+      class Path < Base
+
+        attr_reader :name
+
+        def initialize(param_name)
+          @in = 'path'
+          @name = param_name.to_s
+          @data_type = 'string'
+          @is_required = true
+          @description = "Scope response to #{@name}"
+        end
+
+      end
+    end
+  end
+end

data/lib/swaggard/swagger/parameters/query.rb

@@ -0,0 +1,32 @@
+require_relative 'base'
+
+module Swaggard
+  module Swagger
+    module Parameters
+      class Query < Base
+
+        def initialize(string)
+          @in = 'query'
+          parse(string)
+        end
+
+        private
+
+        # Example: [Array]     status            Filter by status. (e.g. status[]=1&status[]=2&status[]=3)
+        # Example: [Array]     status(required)  Filter by status. (e.g. status[]=1&status[]=2&status[]=3)
+        # Example: [Integer]   media[media_type_id]                          ID of the desired media type.
+        def parse(string)
+          data_type, name, required, description = string.match(/\A\[(\w*)\]\s*([\w\[\]]*)(\(required\))?\s*(.*)\Z/).captures
+          allow_multiple = name.gsub!('[]', '')
+
+          @name = name
+          @description = description
+          @data_type = data_type.downcase
+          @is_required = required.present?
+          @allow_multiple = allow_multiple.present?
+        end
+
+      end
+    end
+  end
+end

data/lib/swaggard/swagger/path.rb

@@ -0,0 +1,24 @@
+require_relative 'operation'
+
+module Swaggard
+  module Swagger
+    class Path
+
+      attr_reader :path
+
+      def initialize(path)
+        @path = path
+        @operations = {}
+      end
+
+      def add_operation(operation)
+        @operations[operation.http_method.downcase] = operation
+      end
+
+      def to_doc
+        Hash[@operations.map { |http_method, operation| [http_method, operation.to_doc] }]
+      end
+
+    end
+  end
+end

data/lib/swaggard/swagger/property.rb

@@ -0,0 +1,23 @@
+require_relative 'type'
+
+module Swaggard
+  module Swagger
+    class Property
+
+      attr_reader :id, :type, :description
+
+      def initialize(yard_object)
+        @id = yard_object.name
+        @type = Type.new(yard_object.types)
+        @description = yard_object.text
+      end
+
+      def to_doc
+        result = @type.to_doc
+        result['description'] = @description if @description
+        result
+      end
+
+    end
+  end
+end