apipie-rails 0.9.1 → 0.9.3

data/lib/apipie/response_description_adapter.rb

@@ -107,9 +107,10 @@ module Apipie
 
       def add_sub_property(prop_desc)
         raise "Only properties with expected_type 'object' can have sub-properties" unless @expected_type == 'object'
-        if prop_desc.is_a? PropDesc
+        case prop_desc
+        when PropDesc
           @sub_properties << prop_desc
-        elsif prop_desc.is_a? Modifier
+        when Modifier
           prop_desc.apply(self)
         else
           raise "Unrecognized prop_desc type (#{prop_desc.class})"
@@ -130,7 +131,7 @@ module Apipie
       attr_reader :name, :required, :expected_type, :options, :description
       attr_accessor :additional_properties
 
-      alias_method :desc, :description
+      alias desc description
 
       def is_array?
         @is_array
@@ -170,9 +171,10 @@ module Apipie
     end
 
     def add(prop_desc)
-      if prop_desc.is_a? PropDesc
+      case prop_desc
+      when PropDesc
         @property_descs << prop_desc
-      elsif prop_desc.is_a? Modifier
+      when Modifier
         prop_desc.apply(self)
       else
         raise "Unrecognized prop_desc type (#{prop_desc.class})"

data/lib/apipie/swagger_generator.rb

@@ -36,7 +36,6 @@ module Apipie
     def generate_from_resources(version, resources, method_name, lang, clear_warnings=false)
       init_swagger_vars(version, lang, clear_warnings)
 
-      @lang = lang
       @only_method = method_name
       add_resources(resources)
 
@@ -143,13 +142,6 @@ module Apipie
       warn(Apipie::Generator::Swagger::Warning::NO_RETURN_CODES_SPECIFIED_CODE)
     end
 
-    def warn_hash_without_internal_typespec(param_name)
-      warn(
-        Apipie::Generator::Swagger::Warning::HASH_WITHOUT_INTERNAL_TYPESPEC_CODE,
-        { parameter: param_name }
-      )
-    end
-
     def warn_optional_param_in_path(param_name)
       warn(
         Apipie::Generator::Swagger::Warning::OPTIONAL_PARAM_IN_PATH_CODE,
@@ -261,7 +253,7 @@ module Apipie
           warning_tags = []
         end
 
-        op_id = swagger_op_id_for_path(api.http_method, api.path)
+        op_id = Apipie::Generator::Swagger::OperationId.from(api).to_s
 
         include_op_id_in_computed_interface_id(op_id)
 
@@ -275,7 +267,7 @@ module Apipie
             summary: Apipie.app.translate(api.short_description, @current_lang),
             parameters: swagger_params_array_for_method(ruby_method, api.path),
             responses: responses,
-            description: ruby_method.full_description
+            description: Apipie.app.translate(ruby_method.full_description, @current_lang)
         }
 
         if methods[method_key][:summary].nil?
@@ -283,6 +275,7 @@ module Apipie
           warn_missing_method_summary
         end
       end
+
     end
 
     #--------------------------------------------------------------------------
@@ -308,16 +301,6 @@ module Apipie
       remove_colons method.resource.controller.name + "::" + method.method
     end
 
-    def swagger_id_for_typename(typename)
-      typename
-    end
-
-    def swagger_op_id_for_path(http_method, path)
-      # using lowercase http method, because the 'swagger-codegen' tool outputs
-      # strange method names if the http method is in uppercase
-      http_method.downcase + path.gsub(/\//,'_').gsub(/:(\w+)/, '\1').gsub(/_$/,'')
-    end
-
     def swagger_param_type(param_desc)
       if param_desc.blank?
         raise ArgumentError, 'param_desc is required'
@@ -343,11 +326,10 @@ module Apipie
     def json_schema_for_method_response(method, return_code, allow_nulls)
       @definitions = {}
       for response in method.returns
-        if response.code.to_s == return_code.to_s
-          schema = response_schema(response, allow_nulls) if response.code.to_s == return_code.to_s
-          schema[:definitions] = @definitions if @definitions != {}
-          return schema
-        end
+        next unless response.code.to_s == return_code.to_s
+        schema = response_schema(response, allow_nulls)
+        schema[:definitions] = @definitions if @definitions != {}
+        return schema
       end
       nil
     end
@@ -364,9 +346,22 @@ module Apipie
         @disable_default_value_warning = true
 
         if responses_use_reference? && response.typename
-          schema = {"$ref" => gen_referenced_block_from_params_array(swagger_id_for_typename(response.typename), response.params_ordered, allow_nulls)}
+          schema = {
+            "$ref" => gen_referenced_block_from_params_array(
+              response.typename,
+              response.params_ordered,
+              allow_nulls
+            )
+          }
         else
-          schema = json_schema_obj_from_params_array(response.params_ordered, allow_nulls)
+          schema = Apipie::Generator::Swagger::ParamDescription::Composite.new(
+            response.params_ordered,
+            Apipie::Generator::Swagger::Context.new(
+              allow_null: allow_nulls,
+              http_method: @current_http_method,
+              controller_method: @current_method
+            )
+          ).to_swagger
         end
 
       ensure
@@ -397,7 +392,7 @@ module Apipie
 
       for response in method.returns
         swagger_response_block = {
-            description: response.description
+            description: Apipie.app.translate(response.description, @current_lang)
         }
 
         schema = response_schema(response)
@@ -434,105 +429,14 @@ module Apipie
 
       missing.each do |name|
         warn_path_parameter_not_described(name, path)
-        result[name.to_sym] = OpenStruct.new({
-                                                 required: true,
-                                                 _gen_added_from_path: true,
-                                                 name: name,
-                                                 validator: Apipie::Validator::NumberValidator.new(nil),
-                                                 options: {
-                                                     in: "path"
-                                                 }
-                                             })
-      end
-
-      result
-    end
-
-    #--------------------------------------------------------------------------
-    # The core routine for creating a swagger parameter definition block.
-    # The output is slightly different when the parameter is inside a schema block.
-    #--------------------------------------------------------------------------
-    def swagger_atomic_param(param_desc, in_schema, name, allow_nulls)
-      def save_field(entry, openapi_key, v, apipie_key=openapi_key, translate=false)
-        if v.key?(apipie_key)
-          if translate
-            entry[openapi_key] = Apipie.app.translate(v[apipie_key], @current_lang)
-          else
-            entry[openapi_key] = v[apipie_key]
-          end
-        end
-      end
-
-      swagger_def = {}
-      swagger_def[:name] = name if !name.nil?
-
-      swg_param_type = swagger_param_type(param_desc)
-      swagger_def[:type] = swg_param_type.to_s
-      if (swg_param_type.is_a? Apipie::Generator::Swagger::Type) && !swg_param_type.str_format.nil?
-        swagger_def[:format] = swg_param_type.str_format
-      end
-
-      if swagger_def[:type] == "array"
-        array_of_validator_opts = param_desc.validator.param_description.options
-        items_type = array_of_validator_opts[:of].to_s || array_of_validator_opts[:array_of].to_s
-        if items_type == "Hash"
-          ref_name = "#{swagger_op_id_for_path(param_desc.method_description.apis.first.http_method, param_desc.method_description.apis.first.path)}_param_#{param_desc.name}"
-          swagger_def[:items] = {"$ref" => gen_referenced_block_from_params_array(ref_name, param_desc.validator.param_description.validator.params_ordered, allow_nulls)}
-        else
-          swagger_def[:items] = {type: "string"}
-        end
-
-        enum = param_desc.options.fetch(:in, [])
-        swagger_def[:items][:enum] = enum if enum.any?
-      end
-
-      if swagger_def[:type] == "enum"
-        swagger_def[:type] = "string"
-        swagger_def[:enum] = param_desc.validator.values
-      end
 
-      if swagger_def[:type] == "object"  # we only get here if there is no specification of properties for this object
-        swagger_def[:additionalProperties] = true
-        warn_hash_without_internal_typespec(param_desc.name)
+        result[name.to_sym] = Apipie::Generator::Swagger::ParamDescription.
+          create_for_missing_param(method, name)
       end
 
-      if param_desc.is_array?
-        new_swagger_def = {
-            items: swagger_def,
-            type: 'array'
-        }
-        swagger_def = new_swagger_def
-        if allow_nulls
-          swagger_def[:type] = [swagger_def[:type], "null"]
-        end
-      end
-
-      if allow_nulls
-        swagger_def[:type] = [swagger_def[:type], "null"]
-      end
-
-      if !in_schema
-        # the "name" and "in" keys can only be set on root parameters (non-nested)
-        swagger_def[:in] = @default_value_for_param_in if name.present?
-        swagger_def[:required] = param_desc.required if param_desc.required
-      end
-
-      save_field(swagger_def, :description, param_desc.options, :desc, true) unless param_desc.options[:desc].nil?
-      save_field(swagger_def, :default, param_desc.options, :default_value)
-
-      if param_desc.respond_to?(:_gen_added_from_path) && !param_desc.required
-        warn_optional_param_in_path(param_desc.name)
-        swagger_def[:required] = true
-      end
-
-      if !swagger_def[:required] && !swagger_def.key?(:default)
-        warn_optional_without_default_value(param_desc.name) unless @disable_default_value_warning
-      end
-
-      swagger_def
+      result
     end
 
-
     #--------------------------------------------------------------------------
     # JSON schema and referenced-object generation
     #--------------------------------------------------------------------------
@@ -541,79 +445,24 @@ module Apipie
       "#/definitions/#{name}"
     end
 
-
-    def json_schema_obj_from_params_array(params_array, allow_nulls = false)
-      (param_defs, required_params) = json_schema_param_defs_from_params_array(params_array, allow_nulls)
-
-      result = {type: "object"}
-      result[:properties] = param_defs
-      result[:additionalProperties] = false unless Apipie.configuration.swagger_allow_additional_properties_in_response
-      result[:required] = required_params if required_params.length > 0
-
-      param_defs.length > 0 ? result : nil
-    end
-
     def gen_referenced_block_from_params_array(name, params_array, allow_nulls=false)
       return ref_to(:name) if @definitions.key(:name)
 
-      schema_obj = json_schema_obj_from_params_array(params_array, allow_nulls)
+      schema_obj = Apipie::Generator::Swagger::ParamDescription::Composite.new(
+        params_array,
+        Apipie::Generator::Swagger::Context.new(
+          allow_null: allow_nulls,
+          http_method: @current_http_method,
+          controller_method: @current_method
+        )
+      ).to_swagger
+
       return nil if schema_obj.nil?
 
       @definitions[name.to_sym] = schema_obj
       ref_to(name.to_sym)
     end
 
-    def json_schema_param_defs_from_params_array(params_array, allow_nulls = false)
-      param_defs = {}
-      required_params = []
-
-      params_array ||= []
-
-
-      for param_desc in params_array
-        if !param_desc.respond_to?(:required)
-          # pp param_desc
-          raise ("unexpected param_desc format")
-        end
-
-        required_params.push(param_desc.name.to_sym) if param_desc.required
-
-        param_type = swagger_param_type(param_desc)
-
-        if param_type == "object" && param_desc.validator.params_ordered
-          schema = json_schema_obj_from_params_array(param_desc.validator.params_ordered, allow_nulls)
-          if param_desc.additional_properties
-            schema[:additionalProperties] = true
-          end
-
-          if param_desc.is_array?
-            new_schema = {
-                type: 'array',
-                items: schema
-            }
-            schema = new_schema
-          end
-
-          if allow_nulls
-            # ideally we would write schema[:type] = ["object", "null"]
-            # but due to a bug in the json-schema gem, we need to use anyOf
-            # see https://github.com/ruby-json-schema/json-schema/issues/404
-            new_schema = {
-                anyOf: [schema, {type: "null"}]
-            }
-            schema = new_schema
-          end
-          param_defs[param_desc.name.to_sym] = schema if !schema.nil?
-        else
-          param_defs[param_desc.name.to_sym] = swagger_atomic_param(param_desc, true, nil, allow_nulls)
-        end
-      end
-
-      [param_defs, required_params]
-    end
-
-
-
     #--------------------------------------------------------------------------
     # swagger "Params" block generation
     #--------------------------------------------------------------------------
@@ -638,7 +487,15 @@ module Apipie
         if params_in_body_use_reference?
           swagger_schema_for_body = {"$ref" => gen_referenced_block_from_params_array("#{swagger_op_id_for_method(method)}_input", body_param_defs_array)}
         else
-          swagger_schema_for_body = json_schema_obj_from_params_array(body_param_defs_array)
+          swagger_schema_for_body =
+            Apipie::Generator::Swagger::ParamDescription::Composite.new(
+              body_param_defs_array,
+              Apipie::Generator::Swagger::Context.new(
+                allow_null: false,
+                http_method: @current_http_method,
+                controller_method: @current_method
+              )
+            ).to_swagger
         end
 
         swagger_body_param = {
@@ -675,20 +532,7 @@ module Apipie
 
 
     def add_params_from_hash(swagger_params_array, param_defs, prefix=nil, default_value_for_in=nil)
-
-      if default_value_for_in
-        @default_value_for_param_in = default_value_for_in
-      else
-        if body_allowed_for_current_method
-          @default_value_for_param_in = "formData"
-        else
-          @default_value_for_param_in = "query"
-        end
-      end
-
-
       param_defs.each do |name, desc|
-
         if !prefix.nil?
           name = "#{prefix}[#{name}]"
         end
@@ -701,13 +545,21 @@ module Apipie
             warn_param_ignored_in_form_data(desc.name)
           end
         else
-          param_entry = swagger_atomic_param(desc, false, name, false)
+          param_entry = Apipie::Generator::Swagger::ParamDescription::Builder.
+            new(desc, in_schema: false, controller_method: @current_method).
+            with_description(language: @current_lang).
+            with_name(prefix: prefix).
+            with_type(with_null: @allow_null).
+            with_in(
+              http_method: @current_http_method,
+              default_in_value: default_value_for_in
+            ).to_swagger
+
           if param_entry[:required]
             swagger_params_array.unshift(param_entry)
           else
             swagger_params_array.push(param_entry)
           end
-
         end
       end
     end

data/lib/apipie/validator.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+
 module Apipie
 
   module Validator
@@ -344,14 +345,12 @@ module Apipie
 
       def validate(value)
         return false if !value.is_a? Hash
-        if @hash_params
-          @hash_params.each do |k, p|
-            if Apipie.configuration.validate_presence?
-              raise ParamMissing.new(p) if p.required && !value.has_key?(k)
-            end
-            if Apipie.configuration.validate_value?
-              p.validate(value[k]) if value.has_key?(k)
-            end
+        @hash_params&.each do |k, p|
+          if Apipie.configuration.validate_presence?
+            raise ParamMissing.new(p) if p.required && !value.key?(k)
+          end
+          if Apipie.configuration.validate_value?
+            p.validate(value[k]) if value.key?(k)
           end
         end
         return true
@@ -360,7 +359,7 @@ module Apipie
       def process_value(value)
         if @hash_params && value
           return @hash_params.each_with_object({}) do |(key, param), api_params|
-            if value.has_key?(key)
+            if value.key?(key)
               api_params[param.as] = param.process_value(value[key])
             end
           end

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = "0.9.1"
+  VERSION = "0.9.3"
 end

data/lib/apipie-rails.rb

@@ -12,6 +12,7 @@ require "apipie/configuration"
 require "apipie/method_description"
 require "apipie/resource_description"
 require "apipie/param_description"
+require "apipie/param_description/deprecation"
 require "apipie/method_description/api"
 require "apipie/method_description/apis_service"
 require "apipie/errors"
@@ -27,7 +28,16 @@ require "apipie/version"
 require "apipie/swagger_generator"
 require "apipie/generator/generator"
 require "apipie/generator/swagger/swagger"
+require "apipie/generator/swagger/operation_id"
 require "apipie/generator/swagger/warning"
 require "apipie/generator/swagger/warning_writer"
 require "apipie/generator/swagger/type"
 require "apipie/generator/swagger/type_extractor"
+require "apipie/generator/swagger/context"
+require "apipie/generator/swagger/param_description"
+require "apipie/generator/swagger/param_description/builder"
+require "apipie/generator/swagger/param_description/composite"
+require "apipie/generator/swagger/param_description/description"
+require "apipie/generator/swagger/param_description/in"
+require "apipie/generator/swagger/param_description/name"
+require "apipie/generator/swagger/param_description/type"

data/lib/tasks/apipie.rake

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+
 require 'fileutils'
 
 namespace :apipie do
@@ -150,12 +151,11 @@ namespace :apipie do
           doc[:docs][:link_extension] = (lang ? ".#{lang}.html" : ".html")
 
           generate_index_page(file_base_version, doc, true, true, lang) if generate_index
-          if generate_resources
-            Apipie.url_prefix = "../#{subdir_traversal_prefix}#{subdir}"
-            generate_resource_pages(version, file_base_version, doc, true, lang)
-            Apipie.url_prefix = "../../#{subdir_traversal_prefix}#{subdir}"
-            generate_method_pages(version, file_base_version, doc, true, lang)
-          end
+          next unless generate_resources
+          Apipie.url_prefix = "../#{subdir_traversal_prefix}#{subdir}"
+          generate_resource_pages(version, file_base_version, doc, true, lang)
+          Apipie.url_prefix = "../../#{subdir_traversal_prefix}#{subdir}"
+          generate_method_pages(version, file_base_version, doc, true, lang)
         end
       end
     end

data/spec/controllers/users_controller_spec.rb

@@ -5,9 +5,10 @@ def compare_hashes(h1, h2)
     expect(h1).to eq(h2)
   else
     h1.each do |key, val|
-      if val.is_a? Hash
+      case val
+      when Hash
         compare_hashes val, h2[key]
-      elsif val.is_a? Array
+      when Array
         val.each_with_index do |v, i|
           compare_hashes val[i], h2[key][i]
         end
@@ -268,6 +269,7 @@ describe UsersController do
                                   :allow_blank => false,
                                   :metadata => nil,
                                   :show => true,
+                                  :deprecated => false,
                                   :expected_type => "hash",
                                   :validations => [])
           end
@@ -584,6 +586,7 @@ describe UsersController do
                      :description=>"\n<p>Authorization</p>\n",
                      :name=>"oauth",
                      :show=>true,
+                     :deprecated=>false,
                      :expected_type=>"string"},
                     {:validator=>"Must be a Hash",
                      :description=>"\n<p>Deprecated parameter not documented</p>\n",
@@ -594,15 +597,17 @@ describe UsersController do
                      :required=>false,
                      :full_name=>"legacy_param",
                      :show=>false,
+                     :deprecated=>false,
                      :params=>
                       [{:validator=>"Must be a Hash",
                         :description=>"\n<p>Param description for all methods</p>\n",
                         :expected_type=>"hash",
                         :allow_nil=>false,
-                       :allow_blank => false,
+                        :allow_blank => false,
                         :name=>"resource_param",
                         :required=>false,
                         :full_name=>"resource_param",
+                        :deprecated=>false,
                         :show=>true,
                         :params=>
                         [{:required=>true,
@@ -612,6 +617,7 @@ describe UsersController do
                           :description=>"\n<p>Username for login</p>\n",
                           :name=>"ausername", :full_name=>"resource_param[ausername]",
                           :show=>true,
+                          :deprecated=>false,
                           :expected_type=>"string"},
                          {:required=>true,
                           :allow_nil => false,
@@ -620,6 +626,7 @@ describe UsersController do
                           :description=>"\n<p>Password for login</p>\n",
                           :name=>"apassword", :full_name=>"resource_param[apassword]",
                           :show=>true,
+                          :deprecated=>false,
                           :expected_type=>"string"}
                         ]}
                       ]
@@ -630,6 +637,7 @@ describe UsersController do
                      :description=>"\n<p>Company ID</p>\n",
                      :name=>"id", :full_name=>"id",
                      :show=>true,
+                     :deprecated=>false,
                      :expected_type=>"numeric"},
        ],
         :name => 'two_urls',

data/spec/{controllers → lib/apipie}/apipies_controller_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 require 'fileutils'
 require "json-schema"
 
-describe Apipie::ApipiesController do
+describe Apipie::ApipiesController, type: :controller do
 
   describe "GET index" do
 
@@ -159,7 +159,7 @@ describe Apipie::ApipiesController do
   describe "GET index as swagger" do
 
     let(:swagger_schema) do
-      File.read(File.join(File.dirname(__FILE__),"../lib/swagger/openapi_2_0_schema.json"))
+      File.read("#{Rails.root.parent}/lib/swagger/openapi_2_0_schema.json")
     end
 
     it "outputs swagger when format is json and type is swagger" do

data/spec/lib/{application_spec.rb → apipie/application_spec.rb}

@@ -3,7 +3,10 @@ require "spec_helper"
 describe Apipie::Application do
 
   describe "api_controllers_paths" do
-    before { Apipie.configuration.api_controllers_matcher = [File.join(Rails.root, "app", "controllers", "**","*.rb"), File.join(Rails.root, "lib", "**","*.rb")] }
+    before do
+      Apipie.configuration.api_controllers_matcher = [File.join(Rails.root, "app", "controllers", "**","*.rb"),
+                                                      File.join(Rails.root, "lib", "**","*.rb")]
+    end
 
     it "should support receiving array as parameter" do
       expect { Apipie.api_controllers_paths}.
@@ -19,11 +22,11 @@ describe Apipie::Application do
     context "with namespaced_resources enabled" do
       before { Apipie.configuration.namespaced_resources = true }
       context "with a defined base url" do
-        
+
         it "should not overwrite the parent resource" do
           is_expected.not_to eq(Apipie.get_resource_name(Api::V2::ArchitecturesController))
         end
-        
+
       end
 
       context "with an undefined base url" do

data/spec/lib/apipie/configuration_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'Apipie::Configuration' do
+  let(:configuration) { Apipie::Configuration.new }
+
+  describe '#api_action_matcher=' do
+    subject(:setter) { configuration.api_action_matcher = matcher }
+
+    let(:matcher) { proc { |_| :some_action } }
+
+    it { is_expected.to eq(matcher) }
+
+    context 'when matcher does not implement .call method' do
+      let(:matcher) { 'I do not implement .call' }
+
+      it 'raises and exception' do
+        expect { setter }.to raise_error('Must implement .call method')
+      end
+    end
+  end
+end

data/spec/lib/apipie/extractor/recorder_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'Apipie::Extractor::Recorder' do
+  let(:recorder) { Apipie::Extractor::Recorder.new }
+
+  describe '#analyse_controller' do
+    subject do
+      recorder.analyse_controller(controller)
+      recorder.record[:action]
+    end
+
+    let(:action) { :show }
+
+    let(:request) do
+      request = ActionDispatch::Request.new({})
+      request.request_parameters = { action: action }
+      request
+    end
+
+    let(:controller) do
+      controller = ActionController::Metal.new
+      controller.set_request!(request)
+      controller
+    end
+
+    it { is_expected.to eq(action) }
+
+    context 'when a api_action_matcher is configured' do
+      let(:matcher_action) { "#{action}_from_new_matcher" }
+
+      before do
+        Apipie.configuration.api_action_matcher = proc { |_| matcher_action }
+      end
+
+      it { is_expected.to eq(matcher_action) }
+    end
+  end
+end