apipie-rails 0.5.19 → 1.3.0

data/lib/apipie/validator.rb

@@ -1,9 +1,10 @@
 # -*- coding: utf-8 -*-
+
 module Apipie
 
   module Validator
 
-    # to create new validator, inherit from Apipie::Validator::Base
+    # to create new validator, inherit from Apipie::Validator::BaseValidator
     # and implement class method build and instance method validate
     class BaseValidator
 
@@ -37,6 +38,16 @@ module Apipie
         return nil
       end
 
+      def self.raise_if_missing_params
+        missing_params = []
+        yield missing_params
+        if missing_params.size > 1
+          raise ParamMultipleMissing.new(missing_params)
+        elsif missing_params.size == 1
+          raise ParamMissing.new(missing_params.first)
+        end
+      end
+
       # check if value is valid
       def valid?(value)
         if self.validate(value)
@@ -80,6 +91,10 @@ module Apipie
         'string'
       end
 
+      def ignore_allow_blank?
+        false
+      end
+
       def merge_with(other_validator)
         return self if self == other_validator
         raise NotImplementedError, "Don't know how to merge #{self.inspect} with #{other_validator.inspect}"
@@ -185,7 +200,7 @@ module Apipie
 
     # arguments value must be an array
     class ArrayValidator < Apipie::Validator::BaseValidator
-      def initialize(param_description, argument, options={})
+      def initialize(param_description, argument, options = {})
         super(param_description)
         @type = argument
         @items_type = options[:of]
@@ -333,29 +348,32 @@ module Apipie
         @params_ordered ||= _apipie_dsl_data[:params].map do |args|
           options = args.find { |arg| arg.is_a? Hash }
           options[:parent] = self.param_description
+          options[:param_group] = @param_group
           Apipie::ParamDescription.from_dsl_data(param_description.method_description, args)
         end
       end
 
       def validate(value)
         return false if !value.is_a? Hash
-        if @hash_params
-          @hash_params.each do |k, p|
+
+        BaseValidator.raise_if_missing_params do |missing|
+          @hash_params&.each do |k, p|
             if Apipie.configuration.validate_presence?
-              raise ParamMissing.new(p) if p.required && !value.has_key?(k)
+              missing << p if p.required && !value.key?(k)
             end
             if Apipie.configuration.validate_value?
-              p.validate(value[k]) if value.has_key?(k)
+              p.validate(value[k]) if value.key?(k)
             end
           end
         end
+
         return true
       end
 
       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
@@ -427,6 +445,10 @@ module Apipie
         "Must be a decimal number."
       end
 
+      def expected_type
+        'numeric'
+      end
+
       def self.validate(value)
         value.to_s =~ /\A^[-+]?[0-9]+([,.][0-9]+)?\Z$/
       end
@@ -464,26 +486,34 @@ module Apipie
       end
 
       def self.build(param_description, argument, options, block)
-        if argument == :bool || argument == :boolean
+        if argument == :bool || argument == :boolean || boolean_array?(argument)
           self.new(param_description)
         end
       end
 
-      def expected_type
-        'boolean'
+      private_class_method def self.boolean_array?(argument)
+        argument.is_a?(Array) && (argument - [true, false]) == []
       end
 
       def description
         string = %w(true false 1 0).map { |value| format_description_value(value) }.join(', ')
         "Must be one of: #{string}."
       end
+
+      def ignore_allow_blank?
+        true
+      end
+
+      def expected_type
+        'boolean'
+      end
     end
 
     class NestedValidator < BaseValidator
 
       def initialize(param_description, argument, param_group)
         super(param_description)
-        @validator = Apipie::Validator:: HashValidator.new(param_description, argument, param_group)
+        @validator = Apipie::Validator::HashValidator.new(param_description, argument, param_group)
         @type = argument
       end
 

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = "0.5.19"
+  VERSION = "1.3.0"
 end

data/lib/apipie-rails.rb

@@ -2,16 +2,20 @@ require 'i18n'
 require 'json'
 require 'active_support/hash_with_indifferent_access'
 
-require 'apipie/core_ext/route.rb'
+require 'apipie/core_ext/route'
 
 require "apipie/routing"
 require "apipie/markup"
 require "apipie/apipie_module"
 require "apipie/dsl_definition"
+require "apipie/generator/swagger/config"
 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"
 require "apipie/error_description"
 require "apipie/response_description"
@@ -23,7 +27,34 @@ require "apipie/railtie"
 require 'apipie/extractor'
 require "apipie/version"
 require "apipie/swagger_generator"
-
-if Rails.version.start_with?("3.0")
-  warn 'Warning: apipie-rails is not going to support Rails 3.0 anymore in future versions'
-end
+require "apipie/generator/generator"
+require "apipie/generator/config"
+require "apipie/generator/swagger/swagger"
+require "apipie/generator/swagger/schema"
+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/computed_interface_id"
+require "apipie/generator/swagger/path_decorator"
+require "apipie/generator/swagger/referenced_definitions"
+require "apipie/generator/swagger/resource_description_composite"
+require "apipie/generator/swagger/resource_description_collection"
+require "apipie/generator/swagger/method_description"
+require "apipie/generator/swagger/method_description/parameters_service"
+require "apipie/generator/swagger/method_description/response_service"
+require "apipie/generator/swagger/method_description/response_schema_service"
+require "apipie/generator/swagger/method_description/decorator"
+require "apipie/generator/swagger/method_description/api_decorator"
+require "apipie/generator/swagger/method_description/api_schema_service"
+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/path_params_composite"
+require "apipie/generator/swagger/param_description/referenced_composite"
+require "apipie/generator/swagger/param_description/type"

data/lib/generators/apipie/install/install_generator.rb

@@ -1,6 +1,6 @@
 module Apipie
   class InstallGenerator < ::Rails::Generators::Base
-    source_root File.expand_path("../templates", __FILE__)
+    source_root File.expand_path('templates', __dir__)
 
     class_option(:route,
                  :aliases => "-r",

data/lib/generators/apipie/views_generator.rb

@@ -1,6 +1,6 @@
 module Apipie
   class ViewsGenerator < ::Rails::Generators::Base
-    source_root File.expand_path("../../../../app/views", __FILE__)
+    source_root File.expand_path('../../../app/views', __dir__)
     desc 'Copy Apipie views to your application'
 
     def copy_views

data/lib/tasks/apipie.rake

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+
 require 'fileutils'
 
 namespace :apipie do
@@ -19,7 +20,7 @@ namespace :apipie do
   task :static, [:version] => :environment do |t, args|
     with_loaded_documentation do
       args.with_defaults(:version => Apipie.configuration.default_version)
-      out = ENV["OUT"] || File.join(::Rails.root, Apipie.configuration.doc_path, 'apidoc')
+      out = ENV["OUT"] || File.join(Rails.root, Apipie.configuration.doc_path, 'apidoc')
       subdir = File.basename(out)
       copy_jscss(out)
       Apipie.configuration.version_in_url = false
@@ -43,7 +44,7 @@ namespace :apipie do
   task :static_json, [:version] => :environment do |t, args|
     with_loaded_documentation do
       args.with_defaults(:version => Apipie.configuration.default_version)
-      out = ENV["OUT"] || File.join(::Rails.root, Apipie.configuration.doc_path, 'apidoc')
+      out = ENV["OUT"] || File.join(Rails.root, Apipie.configuration.doc_path, 'apidoc')
       ([nil] + Apipie.configuration.languages).each do |lang|
         doc = Apipie.to_json(args[:version], nil, nil, lang)
         generate_json_page(out, doc, lang)
@@ -54,7 +55,7 @@ namespace :apipie do
   desc "Generate static swagger json"
   task :static_swagger_json, [:version, :swagger_content_type_input, :filename_suffix] => :environment do |t, args|
     with_loaded_documentation do
-      out = ENV["OUT"] || File.join(::Rails.root, Apipie.configuration.doc_path, 'apidoc')
+      out = ENV["OUT"] || File.join(Rails.root, Apipie.configuration.doc_path, 'apidoc')
       generate_swagger_using_args(args, out)
     end
   end
@@ -67,7 +68,7 @@ namespace :apipie do
   desc "Did swagger output change since the last execution of this task?"
   task :did_swagger_change, [:version, :swagger_content_type_input, :filename_suffix] => :environment do |t, args|
     with_loaded_documentation do
-      out = ENV["OUT_REF"] || File.join(::Rails.root, Apipie.configuration.doc_path, 'apidoc_ref')
+      out = ENV["OUT_REF"] || File.join(Rails.root, Apipie.configuration.doc_path, 'apidoc_ref')
       paths = generate_swagger_using_args(args, out)
       paths.each {|path|
         existing_files_in_dir = Pathname(out).children(true)
@@ -85,7 +86,7 @@ namespace :apipie do
           counter = 1
           make_reference = true
         else
-          reference_files.sort_by! {|f| f.ctime }
+          reference_files.sort_by!(&:ctime)
           last_ref = reference_files[-1]
           print "Comparing [#{path}] to reference file: [#{last_ref.basename}]: "
           if !FileUtils.compare_file(path, last_ref)
@@ -108,7 +109,7 @@ namespace :apipie do
 
         num_refs_to_keep = 3
         if reference_files.length > num_refs_to_keep
-          (reference_files - reference_files[-num_refs_to_keep..-1]).each{|f| f.delete}
+          (reference_files - reference_files[-num_refs_to_keep..-1]).each(&:delete)
         end
       }
     end
@@ -122,17 +123,17 @@ namespace :apipie do
   # Default output dir ('public/apipie_cache') can be changed with OUT=/some/dir
   desc "Generate cache to avoid production dependencies on markup languages"
   task :cache => :environment do
-    puts "#{Time.now} | Started"
+    puts "#{Time.zone.now} | Started"
     cache_part = ENV['cache_part']
     generate_index = (cache_part == 'resources' ? false : true)
     generate_resources = (cache_part == 'index' ? false : true)
     with_loaded_documentation do
-      puts "#{Time.now} | Documents loaded..."
+      puts "#{Time.zone.now} | Documents loaded..."
       ([nil] + Apipie.configuration.languages).each do |lang|
         I18n.locale = lang || Apipie.configuration.default_locale
-        puts "#{Time.now} | Processing docs for #{lang}"
+        puts "#{Time.zone.now} | Processing docs for #{lang}"
         cache_dir = ENV["OUT"] || Apipie.configuration.cache_dir
-        subdir = Apipie.configuration.doc_base_url.sub(/\A\//,"")
+        subdir = Apipie.configuration.doc_base_url.sub(%r{\A/},"")
         subdir_levels = subdir.split('/').length
         subdir_traversal_prefix = '../' * subdir_levels
         file_base = File.join(cache_dir, Apipie.configuration.doc_base_url)
@@ -150,26 +151,25 @@ 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
-    puts "#{Time.now} | Finished"
+    puts "#{Time.zone.now} | Finished"
   end
 
   # Attempt to use the Rails application views, otherwise default to built in views
   def renderer
     return @apipie_renderer if @apipie_renderer
 
-    base_paths = [File.expand_path("../../../app/views/apipie/apipies", __FILE__)]
+    base_paths = [File.expand_path('../../app/views/apipie/apipies', __dir__)]
     base_paths.unshift("#{Rails.root}/app/views/apipie/apipies") if File.directory?("#{Rails.root}/app/views/apipie/apipies")
 
-    layouts_paths = [File.expand_path("../../../app/views/layouts", __FILE__)]
+    layouts_paths = [File.expand_path('../../app/views/layouts', __dir__)]
     layouts_paths.unshift("#{Rails.root}/app/views/layouts") if File.directory?("#{Rails.root}/app/views/layouts/apipie")
 
     if ActionView::Base.respond_to?(:with_empty_template_cache) && ActionView::Base.respond_to?(:with_view_paths)
@@ -186,19 +186,24 @@ namespace :apipie do
     av = renderer
     File.open(file_name, "w") do |f|
       variables.each do |var, val|
-        av.instance_variable_set("@#{var}", val)
+        av.instance_variable_set(:"@#{var}", val)
       end
       f.write av.render(
         :template => "#{template}",
-        :layout => (layout && "apipie/#{layout}"))
+        :layout => layout && "apipie/#{layout}")
     end
   end
 
   def generate_swagger_using_args(args, out)
-    args.with_defaults(:version => Apipie.configuration.default_version,
-                       :swagger_content_type_input => Apipie.configuration.swagger_content_type_input || :form_data,
-                       :filename_suffix => nil)
-    Apipie.configuration.swagger_content_type_input = args[:swagger_content_type_input].to_sym
+    args.with_defaults(
+      version: Apipie.configuration.default_version,
+      swagger_content_type_input: Apipie.configuration.generator.swagger.content_type_input,
+      filename_suffix: nil
+    )
+
+    Apipie.configuration.generator.swagger.content_type_input =
+      args[:swagger_content_type_input].to_sym
+
     count = 0
 
     sfx = args[:filename_suffix] || "_#{args[:swagger_content_type_input]}"
@@ -221,7 +226,7 @@ namespace :apipie do
     File.open("#{file_base}/#{filename}", 'w') { |file| file.write(JSON.pretty_generate(doc)) }
   end
 
-  def generate_swagger_json_page(file_base, doc, sfx="", lang = nil)
+  def generate_swagger_json_page(file_base, doc, sfx = "", lang = nil)
     FileUtils.mkdir_p(file_base) unless File.exist?(file_base)
 
     path = Pathname.new("#{file_base}/schema_swagger#{sfx}#{lang_ext(lang)}.json")
@@ -254,11 +259,11 @@ namespace :apipie do
   end
 
   def generate_resource_pages(version, file_base, doc, include_json = false, lang = nil)
-    doc[:docs][:resources].each do |resource_name, _|
-      resource_file_base = File.join(file_base, resource_name.to_s)
+    doc[:docs][:resources].each_key do |resource_id|
+      resource_file_base = File.join(file_base, resource_id.to_s)
       FileUtils.mkdir_p(File.dirname(resource_file_base)) unless File.exist?(File.dirname(resource_file_base))
 
-      doc = Apipie.to_json(version, resource_name, nil, lang)
+      doc = Apipie.to_json(version, resource_id, nil, lang)
       doc[:docs][:link_extension] = (lang ? ".#{lang}.html" : ".html")
       render_page("#{resource_file_base}#{lang_ext(lang)}.html", "resource", {:doc => doc[:docs],
         :resource => doc[:docs][:resources].first, :language => lang, :languages => Apipie.configuration.languages})
@@ -267,12 +272,12 @@ namespace :apipie do
   end
 
   def generate_method_pages(version, file_base, doc, include_json = false, lang = nil)
-    doc[:docs][:resources].each do |resource_name, resource_params|
+    doc[:docs][:resources].each do |resource_id, resource_params|
       resource_params[:methods].each do |method|
-        method_file_base = File.join(file_base, resource_name.to_s, method[:name].to_s)
+        method_file_base = File.join(file_base, resource_id.to_s, method[:name].to_s)
         FileUtils.mkdir_p(File.dirname(method_file_base)) unless File.exist?(File.dirname(method_file_base))
 
-        doc = Apipie.to_json(version, resource_name, method[:name], lang)
+        doc = Apipie.to_json(version, resource_id, method[:name], lang)
         doc[:docs][:link_extension] = (lang ? ".#{lang}.html" : ".html")
         render_page("#{method_file_base}#{lang_ext(lang)}.html", "method", {:doc => doc[:docs],
                                                            :resource => doc[:docs][:resources].first,

data/rel-eng/gem_release.ipynb

@@ -10,7 +10,8 @@
     "- push access to https://github.com/Apipie/apipie-rails\n",
     "- push access to rubygems.org for apipie-rails\n",
     "- sudo yum install python-slugify asciidoc\n",
-    "- ensure neither the `git push` or `gem push` don't require interractive auth. If you can't use api key or ssh key to auth skip these steps and run them form the shell manually \n",
+    "- ensure neither the `git push` or `gem push` don't require interractive auth. If you can't use api key or ssh key to auth skip these steps and run them form the shell manually\n",
+    "- ensure all checks have passed on the branch you're about to release\n",
     "\n",
     "### Release process\n",
     "- Follow the steps with `<Shift>+<Enter>` or `<Ctrl>+<Enter>,<Down>`\n",
@@ -19,6 +20,15 @@
     "### Release settings"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%autosave 0"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -41,10 +51,14 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "NEW_VERSION = '0.5.19'\n",
-    "LAST_VERSION = '0.5.18'\n",
+    "NEW_VERSION = '0.5.20'\n",
+    "LAST_VERSION = '0.5.19'\n",
     "GIT_REMOTE_UPSTREAM = 'origin'\n",
-    "WORK_BRANCH = 'master'\n"
+    "STABLE_RELEASE = False\n",
+    "WORK_BRANCH = 'stable' if STABLE_RELEASE else 'master'\n",
+    "# Array of strings, e.g. [\"21cbsc214g3\", \"21casc214g3\"]\n",
+    "CHERRY_PICKS = []\n",
+    "GEMFILE='Gemfile.rails61'"
    ]
   },
   {
@@ -85,7 +99,25 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Run tests localy"
+    "### Cherry picks for stable release"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "if STABLE_RELEASE:\n",
+    "    for cp in CHERRY_PICKS:\n",
+    "        ! git cherry-pick -x {cp}"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Run tests localy if your setup allows, otherwise ensure the HEAD is green"
    ]
   },
   {
@@ -94,7 +126,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "! bundle update"
+    "! BUNDLE_GEMFILE=gemfiles/{GEMFILE} bundle update"
    ]
   },
   {
@@ -105,7 +137,7 @@
    },
    "outputs": [],
    "source": [
-    "! bundle exec rake"
+    "! BUNDLE_GEMFILE=gemfiles/{GEMFILE} bundle exec rspec"
    ]
   },
   {
@@ -249,7 +281,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "! git tag v{NEW_VERSION}"
+    "! git tag {NEW_VERSION}"
    ]
   },
   {
@@ -265,7 +297,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "! rake build"
+    "! BUNDLE_GEMFILE=gemfiles/{GEMFILE} bundle exec rake build"
    ]
   },
   {

data/spec/controllers/api/v2/architectures_controller_spec.rb

@@ -1,12 +1,19 @@
 require 'spec_helper'
 
 describe Api::V2::ArchitecturesController do
+  let(:resource_description) { Apipie.get_resource_description(described_class, "2.0") }
+
   describe "resource description" do
-    subject { Apipie.get_resource_description(Api::V2::ArchitecturesController, "2.0") }
+    describe 'version' do
+      subject { resource_description._version }
 
-    it "should be version 2.0" do
-      expect(subject._version).to eq('2.0')
+      it { is_expected.to eq('2.0') }
     end
 
+    describe 'name' do
+      subject { resource_description.name }
+
+      it { is_expected.to eq('Architectures') }
+    end
   end
 end

data/spec/controllers/api/v2/empty_middle_controller_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Api::V2::EmptyMiddleController do
+  let(:resource_description) { Apipie.get_resource_description(described_class, '2.0') }
+
+  describe 'resource description' do
+    subject { resource_description }
+
+    context 'when namespaced resources are enabled' do
+      before { Apipie.configuration.namespaced_resources = true }
+      after { Apipie.configuration.namespaced_resources = false }
+
+      # we don't actually expect the resource description to be nil, but resource IDs
+      # are computed at file load time, and altering the value of namespaced_resources
+      # after the fact doesn't change the resource ID, so it can't be found
+      it { is_expected.to be_nil }
+    end
+
+    context 'when namespaced resources are disabled' do
+      it { is_expected.to be_nil }
+    end
+  end
+end

data/spec/controllers/api/v2/nested/resources_controller_spec.rb

@@ -1,8 +1,24 @@
 require 'spec_helper'
 
 describe Api::V2::Nested::ResourcesController do
-  describe "resource id" do
-    subject { Apipie.get_resource_name(Api::V2::Nested::ResourcesController) }
+  let(:resource_description) { Apipie.get_resource_description(described_class, "2.0") }
+
+  describe "resource description" do
+    describe 'version' do
+      subject { resource_description._version }
+
+      it { is_expected.to eq('2.0') }
+    end
+
+    describe 'name' do
+      subject { resource_description.name }
+
+      it { is_expected.to eq('Rsrcs') }
+    end
+  end
+
+  describe '.get_resource_id' do
+    subject { Apipie.get_resource_id(Api::V2::Nested::ResourcesController) }
 
     it "should have resource_id set" do
       expect(subject).to eq("resource")

data/spec/controllers/api/v2/sub/footguns_controller_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Api::V2::Sub::FootgunsController do
+  let(:resource_description) { Apipie.get_resource_description(described_class, '2.0') }
+
+  describe 'resource description' do
+    describe 'version' do
+      subject { resource_description._version }
+
+      it { is_expected.to eq('2.0') }
+    end
+
+    describe 'name' do
+      subject { resource_description.name }
+
+      it { is_expected.to eq('snugtooF') }
+    end
+  end
+end

data/spec/controllers/included_param_group_controller_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+
+describe IncludedParamGroupController do
+
+  let(:dsl_data) { ActionController::Base.send(:_apipie_dsl_data_init) }
+
+  it "should not error when there is a param_group that is deeply nested in response description" do
+    subject = Apipie.get_resource_description(IncludedParamGroupController, Apipie.configuration.default_version)
+    expect(subject._methods.keys).to include(:show)
+  end
+
+end