apipie-rails 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 551be0cd702443cd00ab6f07e8b5d5d34c7465f32550b55b6e4cd7198d41d274
-  data.tar.gz: be966a1768f9839e57c5347bc7c46b40b651cea1c4c5e590feb9c4f365f56ff4
+  metadata.gz: dc951bacc1fe43a5e6959b51f722e5a63d37eac5b3b264603d64e93f039d7e34
+  data.tar.gz: 57ab01c41ef9a23b25ccc40f8f4686aace3c2a4601c35bc1c4492b918561e96a
 SHA512:
-  metadata.gz: 1d2c1845c417378ceda213d9f452efbf33fa4c78926b689866d3559331c495940580dcc34c03840d294bcdb5327c1dd873182c9ea332b081da1b6c7fbf893707
-  data.tar.gz: 00f2a6787774e81bdab55b9e2de74cef25cceec92d908353db88ce6c384ec643cd3f3972c95b59232ad0bc03b707f7af12c5699aa1c8b2c0f696306af8100a4c
+  metadata.gz: be9da39bd717e0f74bfa1b603fcab4db662bc77139b9062c4f1397f7094c5d464c52462f4580017d8e16ffc13961383b0de8ec9d8841aa9606642ec9b633ceba
+  data.tar.gz: 3c72fb02a1bbed1103c98f3c9a906ee54e657a4bfd65d673c614c03525d43e66d4e8da0e06899c29c814f2a848612f2a342fc984a45b6492121f2fe4e2b27399

data/.gitignore

@@ -1,6 +1,7 @@
 .bundle/
 log/*.log
 pkg/
+coverage
 spec/dummy/db/*.sqlite3
 spec/dummy/log/*.log
 spec/dummy/tmp/

data/CHANGELOG.md

@@ -4,6 +4,16 @@
 Also deleted the `Gemfile` that was now a broken symlink.
 please use `export BUNDLE_GEMFILE='gemfiles/Gemfile.rails61'; bundle exec rspec` to run the test suite
 
+## [v0.8.2](https://github.com/Apipie/apipie-rails/tree/v0.8.2) (2022-09-03)
+[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.8.1...v0.8.2)
+* Allow custom validators to opt out of allow_blank behavior [#762](https://github.com/Apipie/apipie-rails/pull/762).  (Stephen Hanson)
+* Enforce test coverage, set current 89% as minimum [#764](https://github.com/Apipie/apipie-rails/pull/764). (Mathieu Jobin)
+* Add contributing instructions to readme [#763](https://github.com/Apipie/apipie-rails/pull/763).  (Stephen Hanson)
+* Fix readme formatting [#765](https://github.com/Apipie/apipie-rails/pull/765).  (Stephen Hanson)
+* Adds expected_type to IntegerValidator example [#769](https://github.com/Apipie/apipie-rails/pull/769).  (Jeremy Liberman)
+* Update readme with error handling example [#768](https://github.com/Apipie/apipie-rails/pull/768).  (Jesse Eisenberg)
+* Fix scope incorrectly set to nil when a param_group is used inside an array_of_hash and the param_group is in a different module / controller. [#693](https://github.com/Apipie/apipie-rails/pull/693) [#774](https://github.com/Apipie/apipie-rails/pull/774).  (Omkar Joshi / Oliver Iyer)
+
 ## [v0.8.1](https://github.com/Apipie/apipie-rails/tree/v0.8.1) (2022-05-26)
 [Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.8.0...v0.8.1)
 * Remove warning that came back as of [#752](https://github.com/Apipie/apipie-rails/pull/752). [#761](https://github.com/Apipie/apipie-rails/pull/761) (Jorge Santos / Mathieu Jobin)

data/README.rst

@@ -1156,6 +1156,21 @@ is raised and can be rescued and processed. It contains a description
 of the parameter value expectations. Validations can be turned off
 in the configuration file.
 
+Here is an example of how to rescue and process a +ParamMissing+ or
++ParamInvalid+ error from within the ApplicationController.
+
+.. code:: ruby
+  
+  class ApplicationController < ActionController::Base
+
+    # ParamError is superclass of ParamMissing, ParamInvalid
+    rescue_from Apipie::ParamError do |e|
+      render text: e.message, status: :unprocessable_entity
+    end
+
+    # ...
+  end
+
 Parameter validation normally happens after before_actions, just before
 your controller method is invoked. If you prefer to control when parameter
 validation occurs, set the configuration parameter ``validate`` to ``:explicitly``.
@@ -1368,6 +1383,10 @@ So we create apipie_validators.rb initializer with this content:
      def description
        "Must be #{@type}."
      end
+
+     def expected_type
+       'numeric'
+     end
    end
 
 Parameters of the build method:
@@ -1385,6 +1404,16 @@ options
 block
   Block converted into Proc, use it as you desire. In this example nil.
 
+If your validator includes valid values that respond true to `.blank?`, you
+should also define:
+
+.. code:: ruby
+
+   def ignore_allow_blank?
+     true
+   end
+
+so that the validation does not fail for valid values.
 
 ============
  Versioning
@@ -1872,6 +1901,20 @@ provided it uses Apipie as a backend.
 
 And if you write one on your own, don't hesitate to share it with us!
 
+====================
+ Contributing
+====================
+
+Since this gem does not have a Gemfile, you need to specify it in your shell with:
+
+.. code:: shell
+   BUNDLE_GEMFILE='gemfiles/Gemfile.rails61'
+
+Then, you can install dependencies and run the test suite:
+
+.. code:: shell
+   > bundle install
+   > bundle exec rspec
 
 ====================
  Disqus Integration

data/apipie-rails.gemspec

@@ -25,5 +25,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency "RedCloth"
   s.add_development_dependency "rake"
   s.add_development_dependency "rdoc"
+  s.add_development_dependency "simplecov"
   s.add_development_dependency "json-schema", "~> 2.8"
 end

data/lib/apipie/param_description.rb

@@ -125,7 +125,7 @@ module Apipie
     end
 
     def blank_forbidden?
-      !Apipie.configuration.ignore_allow_blank_false && !allow_blank && !validator.is_a?(Validator::BooleanValidator)
+      !Apipie.configuration.ignore_allow_blank_false && !allow_blank && !validator.ignore_allow_blank?
     end
 
     def process_value(value)

data/lib/apipie/validator.rb

@@ -80,6 +80,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}"
@@ -333,6 +337,7 @@ 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
@@ -477,6 +482,10 @@ module Apipie
         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
     end
 
     class NestedValidator < BaseValidator

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = "0.8.1"
+  VERSION = "0.8.2"
 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

data/spec/dummy/app/controllers/included_param_group_controller.rb

@@ -0,0 +1,19 @@
+class IncludedParamGroupController < ApplicationController
+  include RandomParamGroup
+
+  api :GET, '/included-param-group'
+  returns code:200 do
+    property :top_level, Array, of: Hash do
+      param_group :random_param_group
+    end
+    property :nested, Hash do
+      property :random_array, Array, of: Hash do
+        param_group :random_param_group
+      end
+    end
+  end
+  def show
+  end
+
+end
+

data/spec/dummy/app/helpers/random_param_group.rb

@@ -0,0 +1,8 @@
+module RandomParamGroup
+  def self.included(klazz)
+    klazz.def_param_group :random_param_group do
+      property :id, Integer
+      property :name, String
+    end
+  end
+end

data/spec/lib/param_description_spec.rb

@@ -157,11 +157,29 @@ describe Apipie::ParamDescription do
         expect { Apipie::ParamDescription.new(method_desc, :param, :boolean).validate(false) }.to_not raise_error
       end
 
+      it "should still not throw an exception when passed false with explicit allow_blank: false" do
+        expect { Apipie::ParamDescription.new(method_desc, :param, :boolean, allow_blank: false).validate(false) }.to_not raise_error
+      end
+
       it "should throw an exception when passed an empty value" do
         expect { Apipie::ParamDescription.new(method_desc, :param, :boolean).validate('') }.to raise_error(Apipie::ParamInvalid)
       end
     end
 
+    context "when the parameter is a custom type with ignore_allow_blank? returning true" do
+      it "should not throw an exception when passed a blank but valid value" do
+        expect { Apipie::ParamDescription.new(method_desc, :param, :custom_bool).validate(false) }.to_not raise_error
+      end
+
+      it "should still not throw an exception when passed false with explicit allow_blank: false" do
+        expect { Apipie::ParamDescription.new(method_desc, :param, :custom_bool, allow_blank: false).validate(false) }.to_not raise_error
+      end
+
+      it "should throw an exception when passed an invalid but blank value" do
+        expect { Apipie::ParamDescription.new(method_desc, :param, :custom_bool).validate("") }.to raise_error(Apipie::ParamInvalid)
+      end
+    end
+
     context 'when the parameter is a string' do
       context 'when allow_blank is specified as true' do
         it "should throw an exception when passed an empty value" do

data/spec/spec_helper.rb

@@ -1,6 +1,10 @@
 require 'rubygems'
 require 'bundler/setup'
 
+require 'simplecov'
+SimpleCov.minimum_coverage 89
+SimpleCov.start
+
 ENV["RAILS_ENV"] ||= 'test'
 APIPIE_ROOT = File.expand_path('../..', __FILE__)
 require File.expand_path("../dummy/config/environment", __FILE__)

data/spec/support/custom_bool_validator.rb

@@ -0,0 +1,17 @@
+class CustomBoolValidator < Apipie::Validator::BaseValidator
+  def validate(value)
+    value.in?([true, false])
+  end
+
+  def self.build(param_description, argument, options, block)
+    new(param_description) if argument == :custom_bool
+  end
+
+  def description
+    "Must be a boolean."
+  end
+
+  def ignore_allow_blank?
+    true
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-26 00:00:00.000000000 Z
+date: 2022-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -137,6 +137,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
@@ -264,6 +278,7 @@ files:
 - spec/controllers/apipies_controller_spec.rb
 - spec/controllers/concerns_controller_spec.rb
 - spec/controllers/extended_controller_spec.rb
+- spec/controllers/included_param_group_controller_spec.rb
 - spec/controllers/memes_controller_spec.rb
 - spec/controllers/users_controller_spec.rb
 - spec/dummy/Rakefile
@@ -279,6 +294,7 @@ files:
 - spec/dummy/app/controllers/extended_controller.rb
 - spec/dummy/app/controllers/extending_concern.rb
 - spec/dummy/app/controllers/files_controller.rb
+- spec/dummy/app/controllers/included_param_group_controller.rb
 - spec/dummy/app/controllers/overridden_concerns_controller.rb
 - spec/dummy/app/controllers/pets_controller.rb
 - spec/dummy/app/controllers/pets_using_auto_views_controller.rb
@@ -288,6 +304,7 @@ files:
 - spec/dummy/app/controllers/tagged_dogs_controller.rb
 - spec/dummy/app/controllers/twitter_example_controller.rb
 - spec/dummy/app/controllers/users_controller.rb
+- spec/dummy/app/helpers/random_param_group.rb
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/components/test_engine/Gemfile
 - spec/dummy/components/test_engine/app/controllers/test_engine/application_controller.rb
@@ -338,6 +355,7 @@ files:
 - spec/lib/validator_spec.rb
 - spec/lib/validators/array_validator_spec.rb
 - spec/spec_helper.rb
+- spec/support/custom_bool_validator.rb
 - spec/support/rake.rb
 homepage: http://github.com/Apipie/apipie-rails
 licenses: []
@@ -357,7 +375,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Rails REST API documentation tool